The Ms reference point is used to request signing of an Identity header field or request verification of a signed assertion in an Identity header field.
HTTP POST method is used for the verification request.
HTTP 200 (OK) is used when the AS for verification has successfully processed the verification request.
HTTP POST method is used for the signing request.
HTTP 200 (OK) is used when the AS for signing has successfully processed the signing request.
HTTP POST method is used for the diversion signing request.
HTTP 200 (OK) is used when the AS for signing has successfully processed the diversion signing request.
HTTP POST method is used for the Resource-Priority header field signing request.
HTTP 200 (OK) is used when the AS for signing has successfully processed the Resource-Priority header field signing request.
HTTP POST method is used for the Resource-Priority and Priority header fields signing request.
HTTP 200 (OK) is used when the AS for signing has successfully processed the Resource-Priority and Priority header field signing request.
API resources are defined with respect to a "server root". The server root is a URI:
-
{hostname}:{port}/{RoutingPath},
The resource URI structure is:
To get an asserted identity signed the client sends an HTTP POST request towards the AS for signing containing a PASSporT SHAKEN object, specified in
RFC 8588; a PASSporT rph object, specified in
RFC 8443; a PASSporT sph object, specified in
RFC 9027; or a PASSporT div object, specified in
RFC 8946. The received signingResponse contains for successful requests the signed Identity header field value in a JSON object. Unsuccessful requests are responded with an HTTP 4xx or 5xx response.
Table V.2.5.2-1 specifies the data types included in the signing request. The signing request contains the claims included in:
-
a PASSporT SHAKEN JSON Web Token, specified in RFC 8588;
-
a PASSporT div JSON Web Token specified in RFC 8946]; or
-
a PASSporT rph JSON Web Token specified in RFC 8443] and optionally a PASSporT sph JSON Web Token specified in RFC 9027.
Parameter |
Type; Value |
Presence |
Description |
attest |
string; "A", "B" or "C"
| O |
Identifying the relation between the service provider attesting the identity and the subscriber. Specified in RFC 8588 [261]. |
dest | array of identity claim JSON objects representing destination identities; tn or uri | M | Identifying the called user taken from the To header field for a PASSporT SHAKEN Token, and from the Request-URI for a PASSporT div Token. Specified in RFC 8225 [262]. |
div | identity claim JSON object, tn or uri. A hi element should be included. | O | Identifying the diverting user, taken from the corresponding Identity header field as pecified in RFC 8946 [265]. |
iat | integer; time and date of issuance of the PASSporT token | M | Time since 1 January 1970 in Numeric Date format as specified in RFC 7519 [235]. |
orig | identity claim JSON object; tn or uri | M | Identifying the calling user. Specified in RFC 8225 [262]. |
origid | String; UUID | O | Specified in RFC 8588 [261] |
rph | array of strings that correspond to the r-values indicated in the SIP Resource-Priority header field | O | Contains assertion of the priority level of the user to be used for a given communication session as specified in RFC 8443 [279]. |
sph |
string "psap-callback"
| O |
Contains header field value "psap-callback" of the SIP Priority header field as specified in RFC 9027 [278].
|
Table V.2.5.2-2 further specifies the data types contained in the signing request parameters.
Parameter |
Type; Value |
Presence |
Description |
hi |
string. An "index" header field parameter as specified in RFC 7044 [66]
| O |
The "index" header field parameter is included in the entry identifying the diverting user in the History-Info header field.
|
tn | string; allowed characters as for local-number-digits and global-number-digits defined in RFC 3966 [22] | M | The number needs to be canonicalized by the AS for signing following the procedure in RFC 8224 section 8.3. |
uri | string; A SIP URI as specified in RFC 3261 [26] following the generic guidelines in RFC [3986]. | O |
Used if the "orig" or "dest" is given in a SIP URI.
|
Table V.2.5.2-3 specifies the data types included in the signing response.
Parameter |
Type; Value |
Presence |
Description |
identityHeader |
string; Identity header field value as specified in RFC 8224 [252] | M | This string cannot be NULL |
To get a received identity claim verified, the client sends an HTTP POST request towards the AS for verification containing a PASSporT object, including one or more claims with the contents of the received Identity header field(s) signing:
-
the originating identity and optionally all the Identity header fields signing diverting identities; and/or
-
the Resource-Priority header field and optionally the header field value "psap-callback" of the Priority header field.
The verificationResponse contains the outcome of the verification in a verstat claim with values as specified for the verstat tel URI parameter in
subclause 7.2A.20 and in a verstatPriority claim with values as specified for the Priority-Verstat header field in
subclause 7.2.21. Unsuccessful requests are responded with an HTTP 4xx or 5xx response.
Table V.2.6.2-1 specifies the data types included in the verification request.
Parameter |
Type; Value |
Presence |
Description |
identityHeader | string; Identity header field value for the originating identity as specified in RFC 8224 [252]. | M | This string cannot be NULL |
IdentityHeaders | array of string; Identity header field values as specified in RFC 8224 [252]. One identityHeader claim per received Identity header field is sent. | O | Identity headers containing the div, rph or sph claims to be verified. |
to | String; identity claim JSON object; tn or uri | M | The destination identity taken from the To header field. Used when no div claim is included. |
dest | string; identity claim JSON object; tn or uri | O | The destination identity taken from the R-URI in the incoming request. Used when div claim is included. |
time | integer; Numeric date format defined in RFC 7519 [235] | M | Time based on the Date header field in the incoming request. |
from | string; identity claim JSON object; tn or uri | M | The asserted identity, taken from the P-Asserted-Identity or the From header field of the incoming request |
Table V.2.6.2-2 specifies the data types included in the verification response.
Parameter |
Type; Value |
Presence |
Description |
divResult | array of one or more [div, verstatValue] tuples | O | Parameter informing of the result of the verification of diverting identities. For each verified identity the verstat parameter is added to the verified identity. |
verstatValue |
string; set to a value defined in Table 7.2A.20.3-1
| O | Parameter informing of the result of the verification of originating identity. To be used in the verstat parameter added to the verified identity. The parameter is mandatory if the request contained a PASSporT SHAKEN JSON Web Token. |
verstatPriority |
string; set to a value defined in Table 7.2.21-1
| O |
Parameter informing of the result of the verification of the Resource-Priority header field and optionally the header field value "psap-callback" of the Priority header field.
|