STIR/SHAKEN module for Asterisk
This configuration documentation is for functionality provided by res_stir_shaken.
stir_shaken.conf
general
STIR/SHAKEN general options
Configuration Option Reference
Option Name |
Type |
Default Value |
Regular Expression |
Description |
|---|---|---|---|---|
|
|
|
|
Must be of type 'general'. |
|
|
|
|
File path to the certificate authority certificate |
|
|
|
|
File path to a chain of trust |
|
|
|
|
Maximum size to use for caching public keys |
|
|
|
|
Maximum time to wait to CURL certificates |
|
|
|
|
Amount of time a signature is valid for |
store
STIR/SHAKEN certificate store options
Configuration Option Reference
Option Name |
Type |
Default Value |
Regular Expression |
Description |
|---|---|---|---|---|
|
|
|
|
Must be of type 'store'. |
|
|
|
|
Path to a directory containing certificates |
|
|
|
URL to the public certificate(s) |
Configuration Option Descriptions
public_cert_url
Must be a valid http, or https, URL. The URL must also contain the ${CERTIFICATE} variable, which is used for public key name substitution. For example: http://mycompany.com/$\{CERTIFICATE}.pub
certificate
STIR/SHAKEN certificate options
Configuration Option Reference
Option Name |
Type |
Default Value |
Regular Expression |
Description |
|---|---|---|---|---|
|
|
|
|
Must be of type 'certificate'. |
|
|
|
|
File path to a certificate |
|
|
|
URL to the public certificate |
|
|
|
|
|
Attestation level |
|
|
|
|
The caller ID number to match on. |
Configuration Option Descriptions
public_cert_url
Must be a valid http, or https, URL.
profile
STIR/SHAKEN profile configuration options
Configuration Option Reference
Option Name |
Type |
Default Value |
Regular Expression |
Description |
|---|---|---|---|---|
|
|
|
|
Must be of type 'profile'. |
|
|
|
STIR/SHAKEN configuration settings |
|
|
|
|
|
An existing ACL from acl.conf to use |
|
|
|
|
An IP or subnet to permit |
|
|
|
|
An IP or subnet to deny |
Configuration Option Descriptions
stir_shaken
Attest, verify, or do both STIR/SHAKEN operations. On incoming INVITEs, the Identity header will be checked for validity. On outgoing INVITEs, an Identity header will be added.
Import Version
This documentation was imported from Asterisk Version GIT-18-801317a