[FAQ] How to use STIR/SHAKEN with compatible Phones

[SteffenBaierUK]

A customer requested to be able to use the Calling Party Identification Verification STIR (Secure Telephony Identity Revisited) and SHAKEN (Signature-based Handling of Asserted information using toKENs)protocol suit [RFC8225] functionality with compatible phones

https://en.wikipedia.org/wiki/STIR/SHAKEN

UC Software 6.4.0 added this for the VVX phones supporting this software. The verification of Calling Party ID’s is classified as:

                “Trusted” – the source of the call is trustworthy
                “Unknown” – no information available to verify the ID or not
                “Spam” – the source of the call does not match the number provided

Call logs will show the level of classification of the recorded incoming calling party ID

Parameters:

reg.X.SIP.stirshakenCallerVerification.enabled

                0 (default) - Disabled.
                1 - Enable Caller-ID Verification based on STIR/SHAKEN.
 

reg.X.SIP.stirshaken.attestationName

                String - PAI header parameter name to be parsed for CallerID verification.
                verstat (default)
 

reg.X.SIP.stirshaken.attestationValue

                String - All possible sets of CallerID verification levels that can be sent by the service provider.Multiple entries possible. Separated by comma.

                TN-VALIDATION-PASSED                               TN-VALIDATION-NOT-PRESENT
                TN-VALIDATION-PASSED-A                          TN-VALIDATION-FAILED (default)
                TN-VALIDATION-PASSED-B
                TN-VALIDATION-PASSED-C
 

reg.X.SIP.stirshaken.verstatPassed

                String - All possible sets of CallerID verification levels that can be sent by the service provider.      TN-VALIDATION-PASSED
                TN-VALIDATION-PASSED-A
                TN-VALIDATION-PASSED-B (default)
 

reg.X.SIP.stirshaken.verstatNotAvailable

                String - Subset of reg.x.SIP.stirshaken.attestationValue that doesn't need validation.
                TN-VALIDATION-NOT-PRESENT (default)
 

reg.X.SIP.stirshaken.verstatFailed

                String - Subset of reg.x.SIP.stirshaken.attestationValue that needs to be evaluated as failed.
                TN-VALIDATION-PASSED-C
                TN-VALIDATION-FAILED (default)

Example SIP PAI headers:

P-Asserted-Identity: "Cullen Jennings" <sip:555555555;verstat=TN-Validation-Passed@example.com>
P-Asserted-Identity: "The CRA" <sip:555555555@example.com>;verstat=No-TN-Validation
P-Asserted-Identity: <sip:555555555@example.com>;verstat= TN-Validation-Failed
P-Asserted-Identity: <sip:555555555@example.com>;verstat=No-TN-Validation;verstat-message="Caller Cannot Be Verified"
P-Asserted-Identity: "Suspected Spam" <sip:555555555@example.com>;verstat=TN-Validation-Failed
P-Asserted-Identity: tel:+14085264000;verstat=TN-Validation-Passed;verstat-message="ATT Adguard Verified"

Phone UI