jambonz/sbc-registrar

sbc-registrar

镜像概述和主要用途

sbc-registrar是jambonz SBC（会话边界控制器）功能的组成部分，专门处理来自客户端（包括SIP软电话和WebRTC客户端应用）的入站REGISTER请求。认证过程通过配置在jambonz数据库中的Web回调委托给客户侧逻辑，活跃注册信息则存储在Redis数据库中。

核心功能和特性

• 接收并处理SIP软电话与WebRTC客户端的REGISTER请求
• 通过Web回调机制将用户认证逻辑委托给客户侧系统
• 在Redis中存储活跃注册信息，包括：
  • 地址记录（aor，如***）
  • 联系SIP URI（contact，如sip:daveh@3.44.3.12:5060）
  • 发送REGISTER请求的源地址和端口
  • 联系用户的传输协议（udp、tcp、wss等）
  • 接收请求的drachtio服务器SIP地址
  • 注册过期时间（秒）
  • 呼叫发起时的应用回调URL（call_hook）
  • 呼叫事件的应用状态回调URL（call_status_hook）
• 对防火墙后的SIP客户端自动缩短授予的过期时间至30秒（Redis中仍使用原始请求的较长过期值），强制客户端频繁重新注册

注册数据库（Redis）

活跃注册信息以哈希结构存储在Redis中，键为aor，值包含注册相关属性，过期时间等于注册授予的秒数：

aor => {contact, source, protocol, sbcAddress, call_hook, call_status_hook}, expiry = 注册过期值

配置说明

配置通过https://www.npmjs.com/package/config%E5%8C%85%E7%AE%A1%E7%90%86%EF%BC%8C%E5%8C%85%E5%90%AB%E4%BB%A5%E4%B8%8B%E6%A0%B8%E5%BF%83%E9%83%A8%E5%88%86%EF%BC%9A

drachtio服务器配置

json
{
  "drachtio": {
    "port": 3001,
    "secret": "cymru"
  }
}

• port：监听来自drachtio服务器的TCP连接端口
• secret：用于drachtio服务器认证的共享密钥

注意：jambonz中的所有drachtio应用均使用出站连接，便于应用逻辑的集中化和集群部署。

Redis服务器配置

json
{
  "redis": {
    "port": 6379,
    "host": "127.0.0.1"
  }
}

• host：Redis服务器地址（必填）
• port：Redis服务器端口（必填）
• 支持https://www.npmjs.com/package/redis#rediscreateclient%E5%AE%9A%E4%B9%89%E7%9A%84%E6%89%80%E6%9C%89%E9%85%8D%E7%BD%AE%E9%80%89%E9%A1%B9

注意：在多SBC扩展环境中，需使用集中式Redis数据库（或集群）存储所有SBC的注册信息。

日志级别配置

json
{
  "logging": {
    "level": "info"
  }
}

• level：日志输出级别（如info、debug、warn等）

HTTP认证回调

用户认证由客户侧系统通过HTTP回调实现。系统会向配置的回调URL（对应REGISTER请求中SIP域的accounts.registration_hook字段）发送POST请求，请求体为JSON格式：

json
{
  "method": "REGISTER",
  "expires": 3600,
  "scheme": "digest",
  "username": "john",
  "realm": "jambonz.org",
  "nonce": "157590482938000",
  "uri": "sip:172.37.0.10:5060",
  "response": "be641cf7951ff23ab04c57907d59f37d",
  "qop": "auth",
  "nc": "00000001",
  "cnonce": "6b8b4567",
  "algorithm": "MD5"
}

客户侧认证逻辑

客户侧系统需：

1. 检索用户名对应的密码
2. 按照https://tools.ietf.org/html/rfc2617#section-3.2.2%E7%AE%97%E6%B3%95%E8%AE%A1%E7%AE%97%E5%93%8D%E5%BA%94%E5%93%88%E5%B8%8C
3. 与请求体中的response字段比较验证

回调响应格式

客户服务器必须返回200 OK响应，响应体为JSON：

• 认证成功：

json
{"status": "ok"}

可包含可选字段：

• expires：注册授予时间（秒，需≤请求的expires值）

• call_hook：呼叫发起回调URL

• call_status_hook：呼叫事件状态回调URL

• 认证失败：

json
{"status": "fail", "msg": "invalid username"}

• msg：可选，失败原因描述

运行测试套件

测试需依赖MySQL服务器，设置环境变量后执行：

bash
MYSQL_ROOT_PASSWORD=foobar npm test

测试套件会创建jambones_test数据库并在测试完成后自动删除。