Browse Source

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

Daniel-Constantin Mierla 2 months ago
parent
commit
64635de552
1 changed files with 7 additions and 7 deletions
  1. 7 7
      src/modules/secsipid/doc/secsipid_admin.xml

+ 7 - 7
src/modules/secsipid/doc/secsipid_admin.xml

@@ -203,9 +203,9 @@ modparam("secsipid", "libopt", "CacheExpires=0")
 		<function moreinfo="none">secsipid_check_identity(keyPath)</function>
 		<function moreinfo="none">secsipid_check_identity(keyPath)</function>
 		</title>
 		</title>
 		<para>
 		<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,
 			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 of the Identity header, using the value of "timeout"
 			parameter to limit the download time. The validity of the JWT
 			parameter to limit the download time. The validity of the JWT
 			body in the Identity header is also checked against the "expire"
 			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>
 		<function moreinfo="none">secsipid_check(sIdentity, keyPath)</function>
 		</title>
 		</title>
 		<para>
 		<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,
 			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 of the sIdentity, using the value of "timeout"
 			parameter to limit the download time. The validity of the JWT
 			parameter to limit the download time. The validity of the JWT
 			in the sIdentity value is also checked against the "expire"
 			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>
 		<function moreinfo="none">secsipid_add_identity(origTN, destTN, attest, origID, x5u, keyPath)</function>
 		</title>
 		</title>
 		<para>
 		<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
 			If origID is empty, a UUID string is generated to fill the field. The origTN
 			represents the origination telephone number; destTN represents the destination
 			represents the origination telephone number; destTN represents the destination
 			telephone number; x5u is the HTTP URL referencing to the public key that
 			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>
 		<function moreinfo="none">secsipid_build_identity(origTN, destTN, attest, origID, x5u, keyPath)</function>
 		</title>
 		</title>
 		<para>
 		<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
 			If origID is empty, a UUID string is generated to fill the field. The origTN
 			represents the origination telephone number; destTN represents the destination
 			represents the origination telephone number; destTN represents the destination
 			telephone number; x5u is the HTTP URL referencing to the public key that
 			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>
 		<function moreinfo="none">secsipid_sign(sheaders, spaypload, keyPath)</function>
 		</title>
 		</title>
 		<para>
 		<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
 			The sheaders and spayload have to be string representation of JSON
 			headers and payload to be signed. On success, the Indentity value is
 			headers and payload to be signed. On success, the Indentity value is
 			stored in variable $secsipid(val). It also sets $secsipid(ret) to
 			stored in variable $secsipid(val). It also sets $secsipid(ret) to