From 1ef25e2c7fe5cb99be9fbc93d5c8b5ed0d083201 Mon Sep 17 00:00:00 2001
From: Sam Machin <sam@sammachin.com>
Date: Wed, 11 Jun 2025 16:08:58 +0100
Subject: [PATCH] add user-agent to regbot (#106)

* add user-agent to regbot

* lint

* remove regbot from string
---
 lib/config.js | 4 +++-
 lib/regbot.js | 8 ++++++--
 2 files changed, 9 insertions(+), 3 deletions(-)

diff --git a/lib/config.js b/lib/config.js
index d0baee7..b9a9c3e 100644
--- a/lib/config.js
+++ b/lib/config.js
@@ -34,6 +34,7 @@ const JAMBONES_REGBOT_BATCH_SLEEP_MS = process.env.JAMBONES_REGBOT_BATCH_SLEEP_M
 const JAMBONES_REGBOT_BATCH_SIZE = process.env.JAMBONES_REGBOT_BATCH_SIZE || 10;
 const OPTIONS_RESPONSE_REMOVE = process.env.OPTIONS_RESPONSE_REMOVE?.split(',').map(Number) || [];
 const REGISTER_RESPONSE_REMOVE = process.env.REGISTER_RESPONSE_REMOVE?.split(',').map(Number) || [];
+const JAMBONES_REGBOT_USER_AGENT = process.env.JAMBONES_REGBOT_USER_AGENT ;
 
 module.exports = {
   JAMBONES_MYSQL_HOST,
@@ -63,5 +64,6 @@ module.exports = {
   JAMBONES_REGBOT_BATCH_SLEEP_MS,
   JAMBONES_REGBOT_BATCH_SIZE,
   OPTIONS_RESPONSE_REMOVE,
-  REGISTER_RESPONSE_REMOVE
+  REGISTER_RESPONSE_REMOVE,
+  JAMBONES_REGBOT_USER_AGENT
 };
diff --git a/lib/regbot.js b/lib/regbot.js
index bfa768d..f5f6f27 100644
--- a/lib/regbot.js
+++ b/lib/regbot.js
@@ -2,13 +2,16 @@ const {
   JAMBONES_REGBOT_DEFAULT_EXPIRES_INTERVAL,
   JAMBONES_REGBOT_MIN_EXPIRES_INTERVAL,
   JAMBONES_REGBOT_CONTACT_USE_IP,
-  REGISTER_RESPONSE_REMOVE
+  REGISTER_RESPONSE_REMOVE,
+  JAMBONES_REGBOT_USER_AGENT
 } = require('./config');
 const debug = require('debug')('jambonz:sbc-registrar');
 const {isValidDomainOrIP} = require('./utils');
 const DEFAULT_EXPIRES = (parseInt(JAMBONES_REGBOT_DEFAULT_EXPIRES_INTERVAL) || 3600);
 const MIN_EXPIRES = (parseInt(JAMBONES_REGBOT_MIN_EXPIRES_INTERVAL) || 30);
 const assert = require('assert');
+const version = require('../package.json').version;
+const useragent = JAMBONES_REGBOT_USER_AGENT || `Jambonz ${version}`;
 
 class Regbot {
   constructor(logger, opts) {
@@ -108,7 +111,8 @@ class Regbot {
           'From': this.from,
           'To': this.from,
           'Contact': `<${scheme}:${contactAddress};transport=${transport}>;expires=${DEFAULT_EXPIRES}`,
-          'Expires': DEFAULT_EXPIRES
+          'Expires': DEFAULT_EXPIRES,
+          'User-Agent': useragent
         },
         auth: {
           username: this.username,