Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated to GIT-16-5ace782

...

Only used when auth_type is md5. As an alternative to specifying a plain text password, you can hash the username, realm and password together one time and place the hash value here. The input to the hash function must be in the following format:

<username>:<realm>:<password>

For incoming authentication (asterisk is the server), the realm must match either the realm set in this object or the default_realm set in in the global object.

For outgoing authentication (asterisk is the client), the realm must match what the server will be sending in their WWW-Authenticate header. It can't be blank unless you expect the server to be sending a blank realm in the header. You can generate the hash with the following shell command:

$ echo -n "myname:myrealm:mypassword" | md5sum

Note the '-n'. You don't want a newline to be part of the hash.

Anchor
auth_password
auth_password

...

Anchor
auth_realm
auth_realm

realm

The treatment of this value depends upon how the authentication object is used.

When used as an inbound authentication object, the realm is sent as part of the challenge so the peer can know which key to use when responding. An empty value will use the global sectionFor incoming authentication (asterisk is the server), this is the realm to be sent on WWW-Authenticate headers. If not specified, the global object's default_realm value when issuing a challenge.When used as an outbound authentication object, the realm is matched with the received challenge realm to determine which authentication object to use when responding to the challenge. An empty value matches any challenging realm when determining which authentication object matches a received challenge will be used.

For outgoing authentication (asterisk is the client), this must either be the realm the server is expected to send, or blank to automatically use the realm sent by the server. If you have multiple auth object for an endpoint, the realm is also used to match the auth object to the realm the server sent.

Info
titleNote

Using the same auth section for inbound and outbound authentication is not recommended. There is a difference in meaning for an empty realm setting between inbound and outbound authentication uses.

...

Option Name

Type

Default Value

Regular Expression

Description

max_forwards

Unsigned Integer

70

false

Value used in Max-Forwards header for SIP requests.

keep_alive_interval

Unsigned Integer

90

false

The interval (in seconds) to send keepalives to active connection-oriented transports.

contact_expiration_check_interval

Unsigned Integer

30

false

The interval (in seconds) to check for expired contacts.

disable_multi_domain

Boolean

no

false

Disable Multi Domain support

max_initial_qualify_time

Unsigned Integer

0

false

The maximum amount of time from startup that qualifies should be attempted on all contacts. If greater than the qualify_frequency for an aor, qualify_frequency will be used instead.

unidentified_request_period

Unsigned Integer

5

false

The number of seconds over which to accumulate unidentified requests.

unidentified_request_count

Unsigned Integer

5

false

The number of unidentified requests from a single IP to allow.

unidentified_request_prune_interval

Unsigned Integer

30

false

The interval at which unidentified requests are older than twice the unidentified_request_period are pruned.

type

None

 

false

Must be of type 'global' UNLESS the object name is 'global'.

user_agent

String

Asterisk PBX GIT-16-a4a63db5ace782

false

Value used in User-Agent header for SIP requests and Server header for SIP responses.

regcontext

String

 

false

When set, Asterisk will dynamically create and destroy a NoOp priority 1 extension for a given peer who registers or unregisters with us.

default_outbound_endpoint

String

default_outbound_endpoint

false

Endpoint to use when sending an outbound request to a URI without a specified endpoint.

default_voicemail_extension

String

 

false

The voicemail extension to send in the NOTIFY Message-Account header if not specified on endpoint or aor

debug

String

no

false

Enable/Disable SIP debug logging. Valid options include yes, no, or a host address

endpoint_identifier_order

String

ip,username,anonymous

false

The order by which endpoint identifiers are processed and checked. Identifier names are usually derived from and can be found in the endpoint identifier module itself (res_pjsip_endpoint_identifier_*). You can use the CLI command "pjsip show identifiers" to see the identifiers currently available.

default_from_user

String

asterisk

false

When Asterisk generates an outgoing SIP request, the From header username will be set to this value if there is no better option (such as CallerID) to be used.

default_realm

String

asterisk

false

When Asterisk generates a challenge, the digest realm will be set to this value if there is no better option (such as auth/realm) to be used.

mwi_tps_queue_high

Unsigned Integer

500

false

MWI taskprocessor high water alert trigger level.

mwi_tps_queue_low

Integer

-1

false

MWI taskprocessor low water clear alert level.

mwi_disable_initial_unsolicited

Boolean

no

false

Enable/Disable sending unsolicited MWI to all endpoints on startup.

ignore_uri_user_options

Boolean

no

false

Enable/Disable ignoring SIP URI user field options.

use_callerid_contact

Boolean

no

false

Place caller-id information into Contact header

send_contact_status_on_update_registration

Boolean

no

false

Enable sending AMI ContactStatus event when a device refreshes its registration.

taskprocessor_overload_trigger

Custom

global

false

Trigger scope for taskprocessor overloads

norefersub

Boolean

yes

false

Advertise support for RFC4488 REFER subscription suppression

...

This documentation was imported from Asterisk Version GIT-16-a4a63db5ace782