Module: kamailio Branch: master Commit: 64635de552896fbf354e52656ec4ee93f1d87e6f URL: https://github.com/kamailio/kamailio/commit/64635de552896fbf354e52656ec4ee93...

Author: Daniel-Constantin Mierla miconda@gmail.com Committer: Daniel-Constantin Mierla miconda@gmail.com Date: 2025-06-30T08:33:35+02:00

secsipid: docs update to reflect better the use of private/public key

---

Modified: src/modules/secsipid/doc/secsipid_admin.xml

---

Diff: https://github.com/kamailio/kamailio/commit/64635de552896fbf354e52656ec4ee93... Patch: https://github.com/kamailio/kamailio/commit/64635de552896fbf354e52656ec4ee93...

---

diff --git a/src/modules/secsipid/doc/secsipid_admin.xml b/src/modules/secsipid/doc/secsipid_admin.xml index 4009f745149..ed70d1d2ea1 100644 --- a/src/modules/secsipid/doc/secsipid_admin.xml +++ b/src/modules/secsipid/doc/secsipid_admin.xml @@ -203,9 +203,9 @@ modparam("secsipid", "libopt", "CacheExpires=0") <function moreinfo="none">secsipid_check_identity(keyPath)</function> </title> <para> - Check the validity of the Identity header using the keys stored + Check the validity of the Identity header using the public keys stored in the file specified by "keyPath". If the parameter is empty, - the function is downloading the key using the URL from "info" + the function is downloading the public key using the URL from "info" parameter of the Identity header, using the value of "timeout" parameter to limit the download time. The validity of the JWT body in the Identity header is also checked against the "expire" @@ -271,9 +271,9 @@ request_route { <function moreinfo="none">secsipid_check(sIdentity, keyPath)</function> </title> <para> - Check the validity of the "sIdentity" parameter using the keys stored + Check the validity of the "sIdentity" parameter using the public keys stored in the file specified by "keyPath". If the keyPath parameter is empty, - the function is downloading the key using the URL from "info" + the function is downloading the public key using the URL from "info" parameter of the sIdentity, using the value of "timeout" parameter to limit the download time. The validity of the JWT in the sIdentity value is also checked against the "expire" @@ -384,7 +384,7 @@ request_route { <function moreinfo="none">secsipid_add_identity(origTN, destTN, attest, origID, x5u, keyPath)</function> </title> <para> - Add Identity header using the key specified by "keyPath" to sign the JWT body. + Add Identity header using the private key specified by "keyPath" to sign the JWT body. If origID is empty, a UUID string is generated to fill the field. The origTN represents the origination telephone number; destTN represents the destination telephone number; x5u is the HTTP URL referencing to the public key that @@ -416,7 +416,7 @@ request_route { <function moreinfo="none">secsipid_build_identity(origTN, destTN, attest, origID, x5u, keyPath)</function> </title> <para> - Build Identity value using the key specified by "keyPath" to sign the JWT body. + Build Identity value using the key specified by private "keyPath" to sign the JWT body. If origID is empty, a UUID string is generated to fill the field. The origTN represents the origination telephone number; destTN represents the destination telephone number; x5u is the HTTP URL referencing to the public key that @@ -482,7 +482,7 @@ request_route { <function moreinfo="none">secsipid_sign(sheaders, spaypload, keyPath)</function> </title> <para> - Build Identity value using the key specified by "keyPath" to sign the JWT body. + Build Identity value using the private key specified by "keyPath" to sign the JWT body. The sheaders and spayload have to be string representation of JSON headers and payload to be signed. On success, the Indentity value is stored in variable $secsipid(val). It also sets $secsipid(ret) to