feat: Add SIP Request Ping and Registration Options Feature by robertcoroianu · Pull Request #7073 · louislam/uptime-kuma

robertcoroianu · 2026-03-01T16:14:15Z

Summary

This is a PR based on a previous one: #5382

Changes

Rebase
Replace old-style migration SQL with Knex Add SIP Request Ping and Registration Options Feature #5382 (comment)
Move the new Sip monitor to its own file Add SIP Request Ping and Registration Options Feature #5382 (comment)
Removed for the moment Sip notification provider Add SIP Request Ping and Registration Options Feature #5382 (comment) . Maybe it will be added soon
Fix hardcoded SIP port Add SIP Request Ping and Registration Options Feature #5382 (comment)
Improve Registration flow by adding Digest authentication: RFC 2617/3261 compliant, supports MD5 (default) and SHA-256, qop=auth with nc/cnonce. This makes it compatible with most SIP servers, I've tested with Flexisip
[x ] Improve cleanup after rejection Add SIP Request Ping and Registration Options Feature #5382 (comment)

Relates to 5382

Please follow this checklist to avoid unnecessary back and forth (click to expand)

⚠️ If there are Breaking change (a fix or feature that alters existing functionality in a way that could cause issues) I have called them out
🧠 I have disclosed any use of LLMs/AI in this contribution and reviewed all generated content.
I understand that I am responsible for and able to explain every line of code I submit.
🔍 Any UI changes adhere to visual style of this project.
🛠️ I have self-reviewed and self-tested my code to ensure it works as expected.
📝 I have commented my code, especially in hard-to-understand areas (e.g., using JSDoc for methods).
🤖 I added or updated automated tests where appropriate.
📄 Documentation updates are included (if applicable).
🧰 Dependency updates are listed and explained.
⚠️ CI passes and is green.

Screenshots for Visual Changes

UI Modifications: Highlight any changes made to the user interface.
There are no visual modifications other then the previous PR Add SIP Request Ping and Registration Options Feature #5382

Remove SIP Notification provider Replace console.log method with log.

Copilot

Pull request overview

Adds a new SIP monitor type with UI/configuration fields and server-side SIP OPTIONS/REGISTER logic (including digest auth nc/cnonce handling).

Changes:

Adds sip as a selectable monitor type and introduces SIP-specific configuration fields in the edit UI.
Implements SIP OPTIONS/REGISTER requests (including digest auth) in the server utilities and adds a new SIP monitor-type handler.
Persists SIP monitor settings via new DB columns and adds required dependencies.

Reviewed changes

Copilot reviewed 10 out of 11 changed files in this pull request and generated 13 comments.

Show a summary per file

File	Description
src/pages/EditMonitor.vue	Adds SIP monitor option and SIP-specific form sections/defaults.
src/lang/en.json	Introduces new i18n strings for SIP UI.
server/util-server.js	Adds SIP request helpers and digest auth construction (nc/cnonce).
server/uptime-kuma-server.js	Registers the new SIP monitor type key and import.
server/server.js	Persists SIP fields from incoming monitor config.
server/monitor-types/sip.js	New monitor type implementation for SIP checks and status handling.
server/model/monitor.js	Exposes SIP fields in monitor JSON + helper boolean parsing.
package.json	Adds `sip` and `uuid` dependencies.
db/knex_migrations/2026-03-01-0000-add-sip-fields.js	Adds SIP-related monitor columns.
db/knex_migrations/2026-03-01-0001-sip-auth.js	Adds SIP basic-auth credential columns.

Copilot · 2026-03-01T16:19:11Z

+            sipUrl: this.sipUrl,
+            sipPort: this.sipPort,
+            sipProtocol: this.sipProtocol,
+            sipMethod: this.sipMethod,
+            sipMaintainence: this.isSipMaintainence(),
+            sipAuthMethod: this.sipAuthMethod,


The model is exposing SIP fields from this.sipUrl/sipPort/sipProtocol/..., but the migration defines sip_url/sip_port/sip_protocol/.... If the underlying BeanModel stores DB fields under their column names, these will likely be undefined on reads. Update these getters to reference the actual stored fields (or rename columns to match).

Suggested change

sipUrl: this.sipUrl,

sipPort: this.sipPort,

sipProtocol: this.sipProtocol,

sipMethod: this.sipMethod,

sipMaintainence: this.isSipMaintainence(),

sipAuthMethod: this.sipAuthMethod,

sipUrl: this.sip_url,

sipPort: this.sip_port,

sipProtocol: this.sip_protocol,

sipMethod: this.sip_method,

sipMaintainence: this.isSipMaintainence(),

sipAuthMethod: this.sip_auth_method,

CommanderStorm

I have a few code comments below and copilot also has some.
Also, CI is not green 😉

CommanderStorm · 2026-03-01T16:53:25Z

+        table.text("sip_basic_auth_user").defaultTo(null);
+        table.text("sip_basic_auth_pass").defaultTo(null);


I think we already have a username and password collum. Please reuse those

Fix package-lock

Replace hostname and port fields with defaults Move sip methods from util-server Remove commented code Remove process-503-as-maintenance

…ewPromise

CommanderStorm · 2026-03-02T12:20:04Z

I think you forgot to push some changes since you resolved #7073 (comment) but I don't think it is.

robertcoroianu · 2026-03-02T17:16:27Z

I think you forgot to push some changes since you resolved #7073 (comment) but I don't think it is.

Hi, sorry I forgot to delete the migration. Other have exam me I have kids 😅. I will fix it tonight

louislam · 2026-03-02T17:44:20Z

I think ./server/sip.js could be merged to ./server/monitor-types/sip.js

Both files called sip.js which could be a bit confusing in the future.

+    // Determine hash function based on server's algorithm
+    let hashFn;
+    if (algorithm.toLowerCase() === "sha-256" || algorithm.toLowerCase() === "sha256") {
+        hashFn = (data) => crypto.createHash("sha256").update(data).digest("hex");


+        hashFn = (data) => crypto.createHash("sha256").update(data).digest("hex");
+    } else {
+        // Default to MD5 (standard SIP digest auth per RFC 2617/3261)
+        hashFn = (data) => crypto.createHash("md5").update(data).digest("hex");


+        hashFn = (data) => crypto.createHash("sha256").update(data).digest("hex");
+    } else {
+        // Default to MD5 (standard SIP digest auth per RFC 2617/3261)
+        hashFn = (data) => crypto.createHash("md5").update(data).digest("hex");


robertcoroianu · 2026-03-02T19:43:26Z

is

Can you review again? Thank you

robertcoroianu · 2026-03-02T19:43:59Z

I think ./server/sip.js could be merged to ./server/monitor-types/sip.js

Both files called sip.js which could be a bit confusing in the future.

I've made the change, and I refactored a bit

CommanderStorm · 2026-03-03T05:19:54Z

Why are there sip options and a sip monitor?
What are their differences?

louislam · 2026-03-03T05:26:47Z

I think ./server/sip.js could be merged to ./server/monitor-types/sip.js
Both files called sip.js which could be a bit confusing in the future.

I've made the change, and I refactored a bit

I guess you forget to remove ./server/sip.js after merged.

robertcoroianu · 2026-03-03T07:17:47Z

Why are there sip options and a sip monitor? What are their differences?

Hi,

The SIP Options feature is a separate implementation that periodically sends PING (OPTIONS) requests to the server to verify its availability.

As mentioned in the description:

"In order to use the SIP Options Ping monitor, you need to install Uptime Kuma without Docker and also install the Sipsak client on your server."

Additionally, this implementation can also use the REGISTER method. This allows you to verify that a user can successfully authenticate with the SIP server using a username and password, not just confirm that the server is responding.

I know it's a bit confusing, but "REGISTER" in SIP is a bit simillar with "Authentication" process. https://pgkrishna.medium.com/sip-understanding-register-method-and-authentication-process-a008f884ff18

robertcoroianu · 2026-03-03T07:18:17Z

I think ./server/sip.js could be merged to ./server/monitor-types/sip.js
Both files called sip.js which could be a bit confusing in the future.

I've made the change, and I refactored a bit

I guess you forget to remove ./server/sip.js after merged.

Yes, I will try to pay more attention to my commits

CommanderStorm · 2026-03-03T07:40:31Z

Additionally, this implementation can also

So can we migrate the existing sip-options users into this system if this is a pure superset?

robertcoroianu · 2026-03-03T07:43:06Z

Additionally, this implementation can also

So can we migrate the existing sip-options users into this system if this is a pure superset?

I think for a period of time, at least, to go with both because maybe some people use it

CommanderStorm · 2026-03-03T12:41:17Z

If this is a superset, please migrate the existing monitor.
I don't want to have two monitors doing the same thing, that is too messy.

robertcoroianu · 2026-03-04T08:50:41Z

If this is a superset, please migrate the existing monitor. I don't want to have two monitors doing the same thing, that is too messy.

Understood, I will take a look at how to do it, but this week I'm quite busy. I will return when it is ready.

Thank you

maryamsaleem and others added 13 commits March 1, 2026 17:11

Sip Options and register ping

554de92

Sip module code added

050c851

lint issues resolved

f7bce04

use if sha256 instead md5

3176e09

hashed password

b4b7b4b

password fix

22471d7

use hasehd user passwords

8be5c4c

use hasehd user passwords with undefined

cfc9a02

use hasehd user passwords with hash

00375db

use hasehd user passwords with hash passowrd

e8bb263

Replace old migration with knex

9872d46

Move sip monitor to his own file

27d8013

Added nc and cnonce for SIP registration

cd47cdf

Remove SIP Notification provider Replace console.log method with log.

Copilot AI review requested due to automatic review settings March 1, 2026 16:14

Copilot started reviewing on behalf of robertcoroianu March 1, 2026 16:14 View session

github-advanced-security AI found potential problems Mar 1, 2026

View reviewed changes

Comment thread server/util-server.js Fixed

Comment thread server/util-server.js Fixed

Comment thread server/util-server.js Fixed

robertcoroianu changed the title ~~Added nc and cnonce for SIP registration~~ New - Add SIP Request Ping and Registration Options Feature Mar 1, 2026

Copilot AI reviewed Mar 1, 2026

View reviewed changes

Removed unnecessarily imports

0f9e7cc

robertcoroianu changed the title ~~New - Add SIP Request Ping and Registration Options Feature~~ feat: Add SIP Request Ping and Registration Options Feature Mar 1, 2026

Added missing translations keys

230c919

robertcoroianu force-pushed the feature-sip-integration-requested-mod branch from 409f04b to 230c919 Compare March 1, 2026 16:58

CommanderStorm requested changes Mar 1, 2026

View reviewed changes

Replace Dependency sip and uuid ^ with ~

fb94ce6

robertcoroianu force-pushed the feature-sip-integration-requested-mod branch from 0d3f783 to fb94ce6 Compare March 1, 2026 17:07

robertcoroianu marked this pull request as draft March 1, 2026 17:09

robertcoroianu marked this pull request as ready for review March 1, 2026 17:09

github-actions Bot added the pr:needs review this PR needs a review by maintainers or other community members label Mar 1, 2026

Robert Coroianu added 2 commits March 1, 2026 19:12

Update uuid library

a83118b

Fix package-lock

Replace auth fields with default

5b635d9

Replace hostname and port fields with defaults Move sip methods from util-server Remove commented code Remove process-503-as-maintenance

Refactor methods sipRegisterRequest and SipOptionRequest to not use n…

a2d772e

…ewPromise

robertcoroianu force-pushed the feature-sip-integration-requested-mod branch from c7b0920 to a2d772e Compare March 1, 2026 18:30

github-advanced-security AI found potential problems Mar 1, 2026

View reviewed changes

Comment thread server/sip.js Fixed

Comment thread server/sip.js Fixed

Comment thread server/sip.js Fixed

robertcoroianu requested a review from CommanderStorm March 1, 2026 18:38

Removed old sip auth fields migration

d520e70

robertcoroianu force-pushed the feature-sip-integration-requested-mod branch from 769f727 to d520e70 Compare March 2, 2026 19:16

Mege server/sip.js into sip monitor types

f3ab240

robertcoroianu force-pushed the feature-sip-integration-requested-mod branch from 7a29427 to f3ab240 Compare March 2, 2026 19:23

github-advanced-security AI found potential problems Mar 2, 2026

View reviewed changes

Refactor functions to avoid duplicates

8622006

robertcoroianu force-pushed the feature-sip-integration-requested-mod branch from 53b9bb6 to 8622006 Compare March 2, 2026 19:34

Delete server sip.js

81c469f

robertcoroianu force-pushed the feature-sip-integration-requested-mod branch from 6c5f532 to 81c469f Compare March 3, 2026 07:11

[autofix.ci] apply automated fixes

97c108a

CommanderStorm marked this pull request as draft March 4, 2026 14:09

github-actions Bot added the needs:resolve-merge-conflict label Mar 6, 2026

		table.text("sip_basic_auth_user").defaultTo(null);
		table.text("sip_basic_auth_pass").defaultTo(null);

Uh oh!

Conversation

robertcoroianu commented Mar 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changes

Screenshots for Visual Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI Mar 1, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

CommanderStorm left a comment

Choose a reason for hiding this comment

Uh oh!

CommanderStorm Mar 1, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

CommanderStorm commented Mar 2, 2026

Uh oh!

robertcoroianu commented Mar 2, 2026

Uh oh!

louislam commented Mar 2, 2026

Uh oh!

Check failure

Uh oh!

Uh oh!

Uh oh!

Check failure

Uh oh!

Uh oh!

Uh oh!

Check failure

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

robertcoroianu commented Mar 2, 2026

Uh oh!

robertcoroianu commented Mar 2, 2026

Uh oh!

CommanderStorm commented Mar 3, 2026

Uh oh!

louislam commented Mar 3, 2026

Uh oh!

robertcoroianu commented Mar 3, 2026

Uh oh!

robertcoroianu commented Mar 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

CommanderStorm commented Mar 3, 2026

Uh oh!

robertcoroianu commented Mar 1, 2026 •

edited

Loading

robertcoroianu commented Mar 3, 2026 •

edited

Loading