Stir Shaken Adapter

Last Updated : Oct 19, 2023 |

Session Manager Release 10.2 and later support the StirShakenAdapter adaptation module. The StirShakenAdapter operates on inbound and outbound call (INVITE) requests and can modify the STIR/SHAKEN information present in the SIP messaging. The STIR/SHAKEN information consists of the verification status and attestation level.

  • verification statusThe verification status (verstat) parameter when normalized is inserted in the P-Asserted-Identity header as a username parameter. The valid values for verification status are TN-Validation-Passed, TN-Validation-Failed, and No-TN-Validation.

    If there is no P-Asserted-Identity header in the message then the verification status is inserted in the From header.

  • attestation levelThe attestation level when normalized is inserted as the Attestation-Info header. The valid values for attestation level are A, B, and C.

The inbound verification status and attestation level information might appear combined within the verstat parameter (for example, TN-Validation-Passed-A) before normalization. The verstat parameter might appear as a username parameter, URI parameter, or header parameter before normalization. The attestation level might appear in Attestation-Info, X-Attestation-Info, or P-Attestation-Info headers before normalization.

Note:

The value set in Stir/Shaken Ingress Normalization on the Elements > Session Manager > Global Settings page governs the function of StirShakenAdapter for message normalization of the inbound messages. However, the operation of the StirShakenAdapter can be overridden using the module parameters. Following are the optional module parameters:

  • ingressOverrideStirShakenAdapt (can be abbreviated as iossa)

  • egressOverrideStirShakenAdapt (can be abbreviated as eossa)

Following are the values that you can provide for the ingressOverrideStirShakenAdapt and egressOverrideStirShakenAdapt module parameters:

  • normalize (can be abbreviated as norm)Directs Session Manager to normalize verstat and attestation-level information on ingress or egress.

  • transparent (can be abbreviated as trans)Directs Session Manager to retain any existing verstat and attestation-level information on ingress or egress.

  • remove (can be abbreviated as rem)Directs Session Manager to remove any existing verstat and attestation-level information on ingress or egress.

The ingressOverrideStirShaken, egressOverrideStirShaken, iossa, and eossa module parameters and their values are case sensitive. You must enter the value in lower case.

  • Any string beginning with norm is recognized as normalize.

  • Any string beginning with rem is recognized as remove.

  • Any string beginning with trans is recognized as transparent.

The StirShakenAdapter can also function as a DigitConversionAdapter. You can apply the DigitConversionAdaptation settings to the StirShakenAdapter. The StirShakenAdapter performs DigitConversionAdaptations in addition to the STIR/SHAKEN specific adaptations. The StirShakenAdapter performs the DigitConversionAdaptations and then the STIR/SHAKEN specific adaptations.