settings: the SIP port, with a check against other listeners

apps/api/src/routes/settings.ts

@@ -115,6 +115,20 @@ export async function settingsRoutes(app: FastifyInstance) {
     }
     await checkRefs(db, values);
     const before = await getAllSettings(db);
+    // SIP ports may not land on another listener (Asterisk would fail to start the transport).
+    const c = app.config;
+    const [sip, tls] = [
+      (values['sip.udpPort'] ?? before['sip.udpPort']) as number,
+      (values['sip.tlsPort'] ?? before['sip.tlsPort']) as number,
+    ];
+    for (const port of [sip, tls])
+      if ([80, 443, 8088, c.AMI_PORT, c.API_PORT].includes(port))
+        throw badRequest(`Port ${port} is already used by SelfPhoneNG`);
+      else if (port >= c.RTP_PORT_START && port <= c.RTP_PORT_END)
+        throw badRequest(
+          `Port ${port} is in the call audio range (${c.RTP_PORT_START}–${c.RTP_PORT_END})`,
+        );
+    if (sip === tls) throw badRequest('The SIP port and the TLS port must differ');
     if (values['sip.tlsEnabled'] === true && !before['sip.tlsEnabled']) {
       const cert = await readTlsCert(app.config.TLS_DIR);
       if (!cert.ok) throw badRequest(`Can't turn on TLS. ${cert.error}`);

apps/api/test/sip-port.test.ts

@@ -0,0 +1,45 @@
+// SPDX-License-Identifier: AGPL-3.0-or-later
+// The SIP port (Settings → Security), for routers or ISPs that keep UDP 5060 for themselves.
+import type { LightMyRequestResponse } from 'fastify';
+import { afterAll, beforeAll, describe, expect, it } from 'vitest';
+import { hasTestDb } from './db.ts';
+import { ADMIN, H, createTestApp } from './app.ts';
+
+describe.skipIf(!hasTestDb)('SIP port setting', () => {
+  let t: Awaited<ReturnType<typeof createTestApp>>;
+  let req: (method: string, url: string, payload?: unknown) => Promise<LightMyRequestResponse>;
+
+  beforeAll(async () => {
+    t = await createTestApp();
+    await t.clearMustChange(ADMIN.email);
+    const cookie = await t.login(ADMIN.email, ADMIN.password);
+    req = (method, url, payload) =>
+      t.app.inject({
+        method: method as 'GET',
+        url,
+        payload: payload as object,
+        headers: { ...H, cookie },
+      });
+  });
+  afterAll(() => t?.close());
+
+  it('refuses ports something else listens on', async () => {
+    for (const [port, msg] of [
+      [8080, /already used/],
+      [5038, /already used/],
+      [15000, /call audio range/],
+      [5061, /must differ/],
+    ] as const) {
+      const r = await req('PATCH', '/api/settings', { 'sip.udpPort': port });
+      expect(r.statusCode, String(port)).toBe(400);
+      expect(r.json().error.message).toMatch(msg);
+    }
+  });
+
+  it('5080 is saved, and phones are told', async () => {
+    const r = await req('PATCH', '/api/settings', { 'sip.udpPort': 5080 });
+    expect(r.statusCode).toBe(200);
+    expect(r.json()['sip.udpPort']).toBe(5080);
+    expect((await req('GET', '/api/system/status')).json().ports.sip).toBe(5080);
+  });
+});

apps/web/src/pages/admin/SettingsPage.tsx

@@ -549,10 +549,11 @@ function NetworkTab({ s }: { s: SettingsDto }) {
   );
 }
 
-/** Phone ACL (08 §2.2), outside calls at once (08 §1), provisioning access (07 §2), SIP over TCP, SIP over TLS (M11-T2). */
+/** Phone ACL (08 §2.2), outside calls at once (08 §1), provisioning access (07 §2), SIP port and TCP, SIP over TLS (M11-T2). */
 function SecurityTab({ s }: { s: SettingsDto }) {
   const save = useSave();
   const cert = useQuery({ queryKey: ['tls'], queryFn: systemApi.tls });
+  const [sipPort, setSipPort] = useState(String(s['sip.udpPort']));
   const [tcpOn, setTcpOn] = useState(s['sip.tcpEnabled']);
   const [tlsOn, setTlsOn] = useState(s['sip.tlsEnabled']);
   const [tlsPort, setTlsPort] = useState(String(s['sip.tlsPort']));
@@ -580,6 +581,7 @@ function SecurityTab({ s }: { s: SettingsDto }) {
           'provisioning.enabled': provOn,
           'calls.maxPerExtension': Number(perExt),
           'calls.maxTotal': Number(total),
+          'sip.udpPort': Number(sipPort),
           'sip.tcpEnabled': tcpOn,
           'sip.tlsEnabled': tlsOn,
           'sip.tlsPort': Number(tlsPort),
@@ -641,11 +643,24 @@ function SecurityTab({ s }: { s: SettingsDto }) {
       <h2 className="font-medium">Phone setup files</h2>
       {box(provOn, setProvOn, 'Serve setup files to phones (Phones page)')}
       {box(lanOnly, setLanOnly, 'Only to phones on the local networks')}
-      <h2 className="font-medium">SIP over TCP</h2>
-      {box(tcpOn, setTcpOn, `Accept SIP over TCP (port ${s['sip.udpPort']})`)}
+      <h2 className="font-medium">SIP port</h2>
+      <Field
+        label="SIP port (UDP, and TCP below)"
+        hint="5060 unless your router or ISP keeps UDP 5060 for itself: then for example 5080, forwarded on the router. Phones need setting up again (Phones page or the Linphone QR); trunks don't mind. Needs a telephony restart."
+      >
+        {(p) => (
+          <input
+            {...p}
+            className={`${inputClass} max-w-32`}
+            inputMode="numeric"
+            value={sipPort}
+            onChange={(e) => setSipPort(e.target.value)}
+          />
+        )}
+      </Field>
+      {box(tcpOn, setTcpOn, 'Accept SIP over TCP')}
       <p className="-mt-2 text-xs text-zinc-500">
-        For phones and trunks set to TCP. Phones set up by this server use UDP. Changing it needs a
-        telephony restart.
+        For phones and trunks set to TCP. Phones set up by this server use UDP.
       </p>
       <h2 className="font-medium">Encrypted SIP (TLS)</h2>
       <p className="text-sm" aria-label="TLS certificate">