kamailio-osp模块

该文档详细讲解了如何在Kamailio中配置和使用OSP模块（Open Settlement Protocol Module），以实现基于ETSI标准的安全多边对等互联（Secure Multi-Lateral Peering）。以下是核心内容的总结：

---

1. 模块功能

OSP模块允许Kamailio实现以下关键功能：

• 发送对等授权请求：向对等服务器（Peering Server）请求路由授权。
• 验证授权令牌：校验SIP消息（如INVITE）中的数字签名令牌（OSP-Auth-Token），确保合法性。
• 报告计费信息：在通话结束时（BYE消息），向对等服务器发送使用时长等计费数据。

---

2. 依赖项

• 必需模块：sl（无状态应答）、tm（事务管理）、rr（路由记录）、textops（文本操作）等。
• OSP Toolkit：需预先安装此工具包（下载地址），用于处理加密、令牌生成等底层操作。

---

3. 核心配置参数

3.1 对等服务器配置

• sp1_uri, sp2_uri…sp16_uri
  定义对等服务器的URL，支持HTTP/HTTPS。例如：

  modparam("osp", "sp1_uri", "https://[1.2.3.4]:1443/osp")
  

• sp1_weight, sp2_weight…
  负载均衡权重，数值越高流量分配越多。例如：

  modparam("osp", "sp1_weight", 2000)  # 主服务器
  modparam("osp", "sp2_weight", 1000)  # 备用服务器
  

3.2 设备标识

• device_ip：Kamailio的IP地址（需用方括号包裹，如[192.168.1.1]）。
• device_port：SIP监听端口（默认5060）。

3.3 安全配置

• private_key, local_certificate, ca_certificates
  指定SSL/TLS证书文件路径，用于加密通信和令牌签名验证。
• token_format：令牌验证模式（0=仅签名令牌，1=仅无签名令牌，2=两者皆可）。

3.4 连接与重试

• retry_limit：连接失败后的最大重试次数（默认2次）。
• retry_delay：重试间隔（秒，默认1秒）。
• timeout：等待对等服务器响应的超时时间（毫秒，默认10秒）。

3.5 路由与号码处理

• max_destinations：从对等服务器获取的最大路由目标数（默认5个）。
• use_rpid_for_calling_number：是否优先使用Remote-Party-ID中的主叫号码（默认1=是）。

---

4. 关键函数

4.1 请求处理

• checkospheader()
  检查SIP消息中是否存在OSP-Auth-Token头部。
• validateospheader()
  验证令牌的有效性（如签名、有效期），返回成功（1）或失败（-1）。

4.2 路由决策

• requestosprouting()
  向对等服务器请求路由信息，并重写SIP URI为目标地址。
  示例：

  if (requestosprouting()) {xlog("路由成功，准备转发");
  } else {sl_send_reply("403 Forbidden");
  }
  

4.3 路由准备与号码转换

• prepareosproute()
  在分支路由（BRANCH_ROUTE）中准备具体路由信息。
• checkcallingtranslation()
  检查主叫号码是否被转换，并更新Remote-Party-ID。

4.4 计费报告

• reportospusage(reason)
  在BYE消息中报告通话时长，参数reason标识释放方（0=主叫端，1=被叫端）。

---

5. 典型配置流程

1. 配置对等服务器：指定至少一个对等服务器地址（sp1_uri）。
2. 设置证书和密钥：确保SSL/TLS文件路径正确。
3. 定义路由逻辑：在Kamailio脚本中调用requestosprouting()获取路由。
4. 验证令牌：在接收INVITE时使用validateospheader()校验合法性。
5. 处理计费：在BYE消息中触发reportospusage()上报数据。

---

6. 常见问题

• Q1：如何实现多对等服务器的负载均衡？
  通过sp1_weight和sp2_weight设置权重，流量按比例分配。

• Q2：令牌验证失败的可能原因？
  证书配置错误、令牌过期、或对等服务器未授权。

• Q3：如何调试OSP模块？
  启用Kamailio日志（xlog），观察与对等服务器的交互及错误码。

---

总结

该文档为Kamailio管理员提供了完整的OSP模块配置指南，涵盖服务器连接、安全认证、路由决策及计费上报的全流程。正确配置后，Kamailio可通过标准化的OSP协议实现安全、高效的多边对等互联。

在Ubuntu上安装和配置OSP Toolkit是使用Kamailio OSP模块的前提条件。以下是详细的安装流程：

---

1. 环境准备

确保系统已安装以下依赖项：

• GCC编译器：用于编译源代码。
• OpenSSL开发库：提供加密支持。
• Git：用于从代码仓库获取OSP Toolkit。

安装命令：

sudo apt update
sudo apt install build-essential libssl-dev git

---

2. 下载OSP Toolkit

从SourceForge获取OSP Toolkit的源代码：

git clone https://git.code.sf.net/p/osp-toolkit/code osp-toolkit
cd osp-toolkit

---

3. 编译OSP Toolkit

进入源代码目录并执行以下步骤：

3.1 配置编译选项

运行configure脚本，生成Makefile：

./configure

如果需要指定安装路径（如/usr/local/osp），可以使用--prefix参数：

./configure --prefix=/usr/local/osp

3.2 编译代码

使用make命令编译源代码：

make

3.3 安装

将编译生成的文件安装到系统目录：

sudo make install

---

4. 配置环境变量

为了在系统中使用OSP Toolkit，需要将其路径添加到环境变量中。

4.1 编辑环境变量文件

打开~/.bashrc文件：

nano ~/.bashrc

4.2 添加OSP路径

在文件末尾添加以下内容（假设安装路径为/usr/local/osp）：

export PATH=$PATH:/usr/local/osp/bin
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/local/osp/lib

4.3 使配置生效

保存文件并执行以下命令：

source ~/.bashrc

---

5. 验证安装

运行以下命令，检查OSP Toolkit是否安装成功：

osp-toolkit-version

如果显示版本信息，说明安装成功。

---

6. 生成证书文件

OSP模块需要以下证书文件：

• 私钥文件（pkey.pem）
• 本地证书（localcert.pem）
• CA证书（cacert.pem）

6.1 使用OpenSSL生成证书

运行以下命令生成证书：

openssl genpkey -algorithm RSA -out pkey.pem
openssl req -new -key pkey.pem -out localcert.csr
openssl x509 -req -days 365 -in localcert.csr -signkey pkey.pem -out localcert.pem
openssl req -new -x509 -days 365 -key pkey.pem -out cacert.pem

6.2 将证书文件复制到Kamailio配置目录

假设Kamailio配置目录为/usr/local/etc/kamailio：

sudo cp pkey.pem localcert.pem cacert.pem /usr/local/etc/kamailio/

---

7. 配置Kamailio使用OSP Toolkit

在Kamailio配置文件中（如kamailio.cfg），添加以下参数：

modparam("osp", "private_key", "/usr/local/etc/kamailio/pkey.pem")
modparam("osp", "local_certificate", "/usr/local/etc/kamailio/localcert.pem")
modparam("osp", "ca_certificates", "/usr/local/etc/kamailio/cacert.pem")

---

8. 测试

启动Kamailio并测试OSP模块功能：

sudo kamailio -DD -E -e

检查日志文件，确保OSP模块加载正常且无错误。

---

总结

通过以上步骤，您可以在Ubuntu上成功安装和配置OSP Toolkit，并使其与Kamailio协同工作。如果在安装过程中遇到问题，请检查依赖项是否齐全，并确保证书文件路径正确。

根据错误信息，git clone 命令无法找到指定的 OSP Toolkit 仓库。这可能是因为仓库地址发生了变化，或者 SourceForge 的 Git 服务不再支持该仓库。以下是解决该问题的步骤：

---

1. 检查仓库地址

访问 OSP Toolkit 的 SourceForge 页面 确认仓库地址是否更新。如果页面提供了新的 Git 地址，请使用新地址。

---

2. 使用替代下载方式

如果 Git 仓库不可用，可以尝试以下方法获取 OSP Toolkit：

2.1 下载压缩包

在 SourceForge 页面上，查找并下载 OSP Toolkit 的压缩包（如 .tar.gz 或 .zip 文件）。
下载链接示例：
https://sourceforge.net/projects/osp-toolkit/files/

2.2 解压压缩包

下载完成后，解压文件：

tar -xvzf osp-toolkit-<version>.tar.gz
cd osp-toolkit-<version>

---

3. 手动编译和安装

如果下载的是源代码压缩包，可以按照以下步骤编译和安装：

3.1 安装依赖项

确保系统已安装编译工具和 OpenSSL 开发库：

sudo apt update
sudo apt install build-essential libssl-dev

3.2 配置和编译

进入解压后的目录，运行以下命令：

./configure --prefix=/usr/local/osp
make
sudo make install

3.3 配置环境变量

将 OSP Toolkit 的路径添加到环境变量中：

echo 'export PATH=$PATH:/usr/local/osp/bin' >> ~/.bashrc
echo 'export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/local/osp/lib' >> ~/.bashrc
source ~/.bashrc

---

4. 验证安装

运行以下命令，检查 OSP Toolkit 是否安装成功：

osp-toolkit-version

如果显示版本信息，说明安装成功。

---

5. 使用替代仓库（如果存在）

如果 OSP Toolkit 的代码已迁移到其他平台（如 GitHub），可以尝试从新仓库克隆代码。例如：

git clone https://github.com/<new-repo>/osp-toolkit.git

---

总结

如果 Git 仓库不可用，可以通过下载压缩包或查找替代仓库的方式获取 OSP Toolkit 的源代码。安装完成后，确保正确配置环境变量并验证安装结果。如果问题仍然存在，请检查 SourceForge 页面或联系项目维护者获取最新信息。

根据你提供的文件结构，这似乎是 OSP Toolkit 的源代码解压后的目录。以下是目录内容的分析及安装步骤：

---

1. 文件结构解析

目录/文件	说明
bin	可能存放编译生成的可执行文件（如enroll工具）。
crypto	加密相关代码或库（如与OpenSSL集成的部分）。
enroll	证书生成工具源代码，用于生成OSP所需的私钥和证书。
include	头文件（.h），供其他模块引用。
lib	编译生成的库文件（如.so或.a）。
src	OSP Toolkit 核心源代码。
test	测试代码或单元测试。
LICENSE.txt	项目许可证信息。
README.txt	项目基本说明和快速使用指南。
RELNOTES.txt	版本更新日志和兼容性说明。

---

2. 安装步骤

2.1 安装依赖项

确保系统已安装编译工具和 OpenSSL 开发库：

sudo apt update
sudo apt install build-essential libssl-dev

2.2 编译源代码

进入解压后的目录，执行以下命令：

# 生成配置脚本（如果目录中没有configure文件）
autoreconf -i# 配置编译选项（指定安装路径）
./configure --prefix=/usr/local/osp# 编译代码
make# 安装到系统目录
sudo make install

2.3 生成证书文件

使用 enroll 工具生成 OSP 所需的私钥和证书：

cd enroll
make          # 编译enroll工具
./enroll      # 生成证书文件（pkey.pem, localcert.pem, cacert.pem）

将生成的证书文件复制到 Kamailio 的配置目录：

sudo cp pkey.pem localcert.pem cacert.pem /usr/local/etc/kamailio/

2.4 配置环境变量

将 OSP Toolkit 的路径添加到系统环境变量：

echo 'export PATH=$PATH:/usr/local/osp/bin' >> ~/.bashrc
echo 'export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/local/osp/lib' >> ~/.bashrc
source ~/.bashrc

2.5 验证安装

运行以下命令检查是否成功：

osp-toolkit-version   # 显示版本信息

---

3. Kamailio 集成

在 Kamailio 配置文件（kamailio.cfg）中添加以下参数：

modparam("osp", "private_key", "/usr/local/etc/kamailio/pkey.pem")
modparam("osp", "local_certificate", "/usr/local/etc/kamailio/localcert.pem")
modparam("osp", "ca_certificates", "/usr/local/etc/kamailio/cacert.pem")

---

4. 常见问题解决

Q1: 编译时报错缺少头文件或库

• 原因：未安装 OpenSSL 开发库。
• 解决：重新安装依赖项：

  sudo apt install libssl-dev
  

Q2: enroll 工具无法生成证书

• 原因：权限不足或依赖库未正确链接。
• 解决：以 root 权限运行或检查 LD_LIBRARY_PATH：

  sudo ./enroll
  

Q3: Kamailio 无法加载 OSP 模块

• 原因：证书路径错误或权限问题。
• 解决：检查证书文件路径并确保 Kamailio 有读取权限：

  sudo chmod 644 /usr/local/etc/kamailio/*.pem
  

---

总结

通过以上步骤，你可以手动编译并安装 OSP Toolkit，然后将其集成到 Kamailio 中。如果在编译或运行过程中遇到问题，请参考 README.txt 或 RELNOTES.txt 中的说明，或检查日志文件以定位具体错误。