res_pjsip.h File Reference

#include <pjsip.h>
#include <pjsip_simple.h>
#include <pjsip/sip_transaction.h>
#include <pj/timer.h>
#include <pjlib.h>
#include "asterisk/stringfields.h"
#include "asterisk/netsock2.h"
#include "asterisk/linkedlists.h"
#include "asterisk/channel.h"
#include "asterisk/sorcery.h"
#include "asterisk/dnsmgr.h"
#include "asterisk/endpoints.h"
#include "asterisk/udptl.h"
#include "asterisk/rtp_engine.h"
#include "asterisk/vector.h"
#include "asterisk/stasis_channels.h"
#include "asterisk/stasis_endpoints.h"
#include "asterisk/stream.h"

Include dependency graph for res_pjsip.h:

Go to the source code of this file.

Data Structures
struct	ast_sip_ami
	AMI variable container. More...
struct	ast_sip_aor
	A SIP address of record. More...
struct	ast_sip_auth
struct	ast_sip_auth_objects_vector
struct	ast_sip_auth_password_digest
struct	ast_sip_auth_vector
struct	ast_sip_authenticator
	An interchangeable way of handling digest authentication for SIP. More...
struct	ast_sip_body
	SIP body description. More...
struct	ast_sip_contact
	Contact associated with an address of record. More...
struct	ast_sip_contact_status
	A contact's status. More...
struct	ast_sip_contact_wrapper
	A wrapper for contact that adds the aor_id and a consistent contact id. Used by ast_sip_for_each_contact. More...
struct	ast_sip_direct_media_configuration
	Direct media options for SIP endpoints. More...
struct	ast_sip_domain_alias
struct	ast_sip_endpoint
	An entity with which Asterisk communicates. More...
struct	ast_sip_endpoint_extensions
	Endpoint configuration for SIP extensions. More...
struct	ast_sip_endpoint_formatter
	An entity responsible formatting endpoint information. More...
struct	ast_sip_endpoint_id_configuration
	Party identification options for endpoints. More...
struct	ast_sip_endpoint_identifier
	An entity responsible for identifying the source of a SIP message. More...
struct	ast_sip_endpoint_info_configuration
	Endpoint configuration options for INFO packages. More...
struct	ast_sip_endpoint_media_configuration
	Media configuration for SIP endpoints. More...
struct	ast_sip_endpoint_nat_configuration
	NAT configuration options for endpoints. More...
struct	ast_sip_endpoint_pickup_configuration
	Call pickup configuration options for endpoints. More...
struct	ast_sip_endpoint_subscription_configuration
	Endpoint subscription configuration. More...
struct	ast_sip_identify_by_vector
struct	ast_sip_info_recording_configuration
	Configuration for one-touch INFO recording. More...
struct	ast_sip_media_rtp_configuration
	RTP configuration for SIP endpoints. More...
struct	ast_sip_mwi_configuration
	Endpoint configuration for unsolicited MWI. More...
struct	ast_sip_nat_hook
	Structure for SIP nat hook information. More...
struct	ast_sip_outbound_authenticator
	an interchangeable way of responding to authentication challenges More...
struct	ast_sip_request_transport_details
	Structure which contains information about a transport. More...
struct	ast_sip_security_mechanism
	Structure representing a security mechanism as defined in RFC 3329. More...
struct	ast_sip_security_mechanism_vector
struct	ast_sip_service_route_vector
struct	ast_sip_supplement
	A supplement to SIP message processing. More...
struct	ast_sip_t38_configuration
struct	ast_sip_timer_options
	Session timers options. More...
struct	ast_sip_tpmgr_state_callback
struct	ast_sip_transport
	Transport to bind to. More...
struct	ast_sip_transport_state
	Structure for SIP transport information. More...
struct	pjsip_auth_algorithm
struct	pjsip_auth_algorithm_type_vector

Macros
#define	AST_SIP_AUTH_MAX_REALM_LENGTH   255 /* From the auth/realm realtime column size */
#define	AST_SIP_AUTH_MAX_SUPPORTED_ALGORITHMS_LENGTH   (255) /* From the supported algorithms realtime column size */
#define	ast_sip_call_codec_pref_test(__param, __codec_pref)   (!!(ast_test_flag( &__param, AST_SIP_CALL_CODEC_PREF_ ## __codec_pref )))
	Returns true if the preference is set in the parameter.
#define	ast_sip_cleanup_auth_objects_vector(auth_objects)   AST_VECTOR_RESET(auth_objects, ao2_cleanup)
	Clean up retrieved auth objects in vector.
#define	AST_SIP_MAKE_REMOTE_IPADDR_PORT_STR(_transport, _dest)    pj_sockaddr_print(&_transport->key.rem_addr, _dest, sizeof(_dest), 1);
	Fill a buffer with a pjsip transport's remote ip address and port.
#define	ast_sip_mod_data_get(mod_data, id, key)    ast_sip_dict_get(mod_data[id], key)
	Using the dictionary stored in mod_data array at a given id, retrieve the value associated with the given key.
#define	ast_sip_mod_data_set(pool, mod_data, id, key, val)    mod_data[id] = ast_sip_dict_set(pool, mod_data[id], key, val)
	Utilizing a mod_data array for a given id, set the value associated with the given key.
#define	ast_sip_transport_is_local(transport_state, addr)    (transport_state->localnet && ast_apply_ha(transport_state->localnet, addr) != AST_SENSE_ALLOW)
#define	ast_sip_transport_is_nonlocal(transport_state, addr)    (!transport_state->localnet || ast_apply_ha(transport_state->localnet, addr) == AST_SENSE_ALLOW)
#define	AST_SIP_USER_OPTIONS_TRUNCATE_CHECK(str)
	Truncate the URI user field options string if enabled.
#define	AST_SIP_X_AST_TXP   "x-ast-txp"
#define	AST_SIP_X_AST_TXP_LEN   9
#define	COLON_PORT_STRLEN   6
#define	IP6ADDR_COLON_PORT_BUFLEN   (PJ_INET6_ADDRSTRLEN + COLON_PORT_STRLEN)
#define	MAX_RX_CHALLENGES   10
#define	PJSIP_EXPIRES_NOT_SPECIFIED   ((pj_uint32_t)-1)
#define	PJSIP_MINVERSION(m, n, p)   (((m << 24) | (n << 16) | (p << 8)) >= PJ_VERSION_NUM)
#define	PJSTR_PRINTF_SPEC   "%.*s"
#define	PJSTR_PRINTF_VAR(_v)   ((int)(_v).slen), ((_v).ptr)
#define	SIP_SORCERY_AUTH_TYPE   "auth"
#define	SIP_SORCERY_DOMAIN_ALIAS_TYPE   "domain_alias"
#define	SIP_TLS_MAX_CIPHERS   64
	Maximum number of ciphers supported for a TLS transport.

Typedefs
typedef int(*	ast_sip_dialog_outbound_auth_cb) (pjsip_dialog *dlg, pjsip_tx_data *tdata, void *user_data)
	Callback called when an outbound request with authentication credentials is to be sent in dialog.
typedef int(*	ast_sip_task) (void *user_data)
typedef int(*	ast_transport_monitor_data_matcher) (void *a, void *b)
	Transport shutdown monitor data matcher.
typedef void(*	ast_transport_monitor_shutdown_cb) (void *data)
	Transport shutdown monitor callback.
typedef struct pjsip_auth_algorithm	pjsip_auth_algorithm
typedef enum pjsip_auth_algorithm_type	pjsip_auth_algorithm_type

Enumerations
enum	ast_sip_100rel_mode { AST_SIP_100REL_UNSUPPORTED = 0 , AST_SIP_100REL_SUPPORTED , AST_SIP_100REL_PEER_SUPPORTED , AST_SIP_100REL_REQUIRED }
	100rel modes for SIP endpoints More...
enum	ast_sip_auth_cred_usage { AST_SIP_AUTH_CRED_USAGE_UAC , AST_SIP_AUTH_CRED_USAGE_UAS }
enum	ast_sip_auth_type {   AST_SIP_AUTH_TYPE_NONE = -1 , AST_SIP_AUTH_TYPE_USER_PASS = 0 , AST_SIP_AUTH_TYPE_MD5 , AST_SIP_AUTH_TYPE_GOOGLE_OAUTH ,   AST_SIP_AUTH_TYPE_ARTIFICIAL , AST_SIP_AUTH_TYPE_DIGEST }
	Authentication methods. More...
enum	ast_sip_call_codec_pref {   AST_SIP_CALL_CODEC_PREF_INTERSECT = 1 << 0 , AST_SIP_CALL_CODEC_PREF_UNION = 1 << 1 , AST_SIP_CALL_CODEC_PREF_ALL = 1 << 2 , AST_SIP_CALL_CODEC_PREF_FIRST = 1 << 3 ,   AST_SIP_CALL_CODEC_PREF_LOCAL = 1 << 4 , AST_SIP_CALL_CODEC_PREF_REMOTE = 1 << 5 }
	Incoming/Outgoing call offer/answer joint codec preference. More...
enum	ast_sip_check_auth_result { AST_SIP_AUTHENTICATION_CHALLENGE , AST_SIP_AUTHENTICATION_SUCCESS , AST_SIP_AUTHENTICATION_FAILED , AST_SIP_AUTHENTICATION_ERROR }
	Possible returns from ast_sip_check_authentication. More...
enum	ast_sip_contact_filter { AST_SIP_CONTACT_FILTER_DEFAULT = 0 , AST_SIP_CONTACT_FILTER_REACHABLE = (1 << 0) }
	Contact retrieval filtering flags. More...
enum	ast_sip_contact_status_type {   UNAVAILABLE , AVAILABLE , UNKNOWN , CREATED ,   REMOVED }
	Status type for a contact. More...
enum	ast_sip_direct_media_glare_mitigation { AST_SIP_DIRECT_MEDIA_GLARE_MITIGATION_NONE , AST_SIP_DIRECT_MEDIA_GLARE_MITIGATION_OUTGOING , AST_SIP_DIRECT_MEDIA_GLARE_MITIGATION_INCOMING }
enum	ast_sip_dtmf_mode {   AST_SIP_DTMF_NONE , AST_SIP_DTMF_RFC_4733 , AST_SIP_DTMF_INBAND , AST_SIP_DTMF_INFO ,   AST_SIP_DTMF_AUTO , AST_SIP_DTMF_AUTO_INFO }
	DTMF modes for SIP endpoints. More...
enum	ast_sip_endpoint_identifier_type {   AST_SIP_ENDPOINT_IDENTIFY_BY_USERNAME = (1 << 0) , AST_SIP_ENDPOINT_IDENTIFY_BY_AUTH_USERNAME = (1 << 1) , AST_SIP_ENDPOINT_IDENTIFY_BY_IP = (1 << 2) , AST_SIP_ENDPOINT_IDENTIFY_BY_HEADER = (1 << 3) ,   AST_SIP_ENDPOINT_IDENTIFY_BY_REQUEST_URI = (1 << 4) }
	Different methods by which incoming requests can be matched to endpoints. More...
enum	ast_sip_scheduler_task_flags {   AST_SIP_SCHED_TASK_DEFAULTS = (0 << 0) , AST_SIP_SCHED_TASK_FIXED = (0 << 0) , AST_SIP_SCHED_TASK_VARIABLE = (1 << 0) , AST_SIP_SCHED_TASK_ONESHOT = (1 << 6) ,   AST_SIP_SCHED_TASK_DATA_NOT_AO2 = (0 << 1) , AST_SIP_SCHED_TASK_DATA_AO2 = (1 << 1) , AST_SIP_SCHED_TASK_DATA_NO_CLEANUP = (0 << 3) , AST_SIP_SCHED_TASK_DATA_FREE = ( 1 << 3 ) ,   AST_SIP_SCHED_TASK_PERIODIC = (0 << 4) , AST_SIP_SCHED_TASK_DELAY = (1 << 4) , AST_SIP_SCHED_TASK_TRACK = (1 << 5) }
	Task flags for the res_pjsip scheduler. More...
enum	ast_sip_security_mechanism_type { AST_SIP_SECURITY_MECH_NONE = 0 , AST_SIP_SECURITY_MECH_MSRP_TLS , AST_SIP_SECURITY_MECH_SDES_SRTP , AST_SIP_SECURITY_MECH_DTLS_SRTP }
	The security mechanism type. More...
enum	ast_sip_security_negotiation { AST_SIP_SECURITY_NEG_NONE = 0 , AST_SIP_SECURITY_NEG_MEDIASEC }
	The kind of security negotiation. More...
enum	ast_sip_session_media_encryption { AST_SIP_MEDIA_TRANSPORT_INVALID = 0 , AST_SIP_MEDIA_ENCRYPT_NONE , AST_SIP_MEDIA_ENCRYPT_SDES , AST_SIP_MEDIA_ENCRYPT_DTLS }
enum	ast_sip_session_redirect { AST_SIP_REDIRECT_USER = 0 , AST_SIP_REDIRECT_URI_CORE , AST_SIP_REDIRECT_URI_PJSIP }
enum	ast_sip_session_refresh_method { AST_SIP_SESSION_REFRESH_METHOD_INVITE , AST_SIP_SESSION_REFRESH_METHOD_UPDATE }
enum	ast_sip_supplement_priority { AST_SIP_SUPPLEMENT_PRIORITY_FIRST = 0 , AST_SIP_SUPPLEMENT_PRIORITY_CHANNEL = 1000000 , AST_SIP_SUPPLEMENT_PRIORITY_LAST = INT_MAX }
enum	ast_transport_monitor_reg { AST_TRANSPORT_MONITOR_REG_SUCCESS , AST_TRANSPORT_MONITOR_REG_REPLACED , AST_TRANSPORT_MONITOR_REG_NOT_FOUND , AST_TRANSPORT_MONITOR_REG_FAILED }
enum	pjsip_auth_algorithm_type {   PJSIP_AUTH_ALGORITHM_NOT_SET = 0 , PJSIP_AUTH_ALGORITHM_MD5 , PJSIP_AUTH_ALGORITHM_SHA256 , PJSIP_AUTH_ALGORITHM_SHA512_256 ,   PJSIP_AUTH_ALGORITHM_AKAV1_MD5 , PJSIP_AUTH_ALGORITHM_COUNT }

Functions
void	ast_copy_pj_str (char *dest, const pj_str_t *src, size_t size)
	Copy a pj_str_t into a standard character buffer.
int	ast_copy_pj_str2 (char **dest, const pj_str_t *src)
	Create and copy a pj_str_t into a standard character buffer.
struct ast_sip_endpoint *	ast_pjsip_rdata_get_endpoint (pjsip_rx_data *rdata)
	Get the looked-up endpoint on an out-of dialog request or response.
int	ast_sip_add_body (pjsip_tx_data *tdata, const struct ast_sip_body *body)
	Add a body to an outbound SIP message.
int	ast_sip_add_body_multipart (pjsip_tx_data *tdata, const struct ast_sip_body *bodies[], int num_bodies)
	Add a multipart body to an outbound SIP message.
void	ast_sip_add_date_header (pjsip_tx_data *tdata)
	Adds a Date header to the tdata, formatted like: Date: Wed, 01 Jan 2021 14:53:01 GMT.
int	ast_sip_add_global_request_header (const char *name, const char *value, int replace)
int	ast_sip_add_global_response_header (const char *name, const char *value, int replace)
int	ast_sip_add_header (pjsip_tx_data *tdata, const char *name, const char *value)
	Add a header to an outbound SIP message.
pjsip_generic_string_hdr *	ast_sip_add_header2 (pjsip_tx_data *tdata, const char *name, const char *value)
	Add a header to an outbound SIP message, returning a pointer to the header.
int	ast_sip_add_security_headers (struct ast_sip_security_mechanism_vector *security_mechanisms, const char *header_name, int add_qval, pjsip_tx_data *tdata)
	Add security headers to transmission data.
void	ast_sip_add_usereqphone (const struct ast_sip_endpoint *endpoint, pj_pool_t *pool, pjsip_uri *uri)
	Add 'user=phone' parameter to URI if enabled and user is a phone number.
int	ast_sip_append_body (pjsip_tx_data *tdata, const char *body_text)
	Append body data to a SIP message.
int	ast_sip_are_media_types_equal (pjsip_media_type *a, pjsip_media_type *b)
	Compare pjsip media types.
int	ast_sip_auth_digest_algorithms_vector_init (const char *id, struct pjsip_auth_algorithm_type_vector *algorithms, const char *agent_type, const char *value)
	Populate a vector of algorithm types from a string.
int	ast_sip_auth_digest_algorithms_vector_to_str (const struct pjsip_auth_algorithm_type_vector *algorithms, char **buf)
	Dump a vector of algorithm types to a string.
const pjsip_auth_algorithm *	ast_sip_auth_get_algorithm_by_iana_name (const pj_str_t *iana_name)
	Get algorithm by IANA name.
const pjsip_auth_algorithm *	ast_sip_auth_get_algorithm_by_type (pjsip_auth_algorithm_type algorithm_type)
	Get algorithm by algorithm type.
const char *	ast_sip_auth_get_creds (const struct ast_sip_auth *auth, const pjsip_auth_algorithm_type algorithm_type, int *cred_type)
	Get the plain text or digest password from an auth object.
int	ast_sip_auth_is_algorithm_available (const struct ast_sip_auth *auth, const struct pjsip_auth_algorithm_type_vector *algorithms, pjsip_auth_algorithm_type algorithm_type)
	Checks an pjsip_auth_algorithm_type_vector to see if it contains an algorithm.
pj_bool_t	ast_sip_auth_is_algorithm_supported (pjsip_auth_algorithm_type algorithm_type)
	Is algorithm supported by OpenSSL and pjproject?
const char *	ast_sip_auth_type_to_str (enum ast_sip_auth_type type)
	Converts the given auth type to a string.
void	ast_sip_auth_vector_destroy (struct ast_sip_auth_vector *vector)
	Free contents of an auth vector.
int	ast_sip_auth_vector_init (struct ast_sip_auth_vector *vector, const char *auth_names)
	Initialize an auth vector with the configured values.
int	ast_sip_auths_to_str (const struct ast_sip_auth_vector *auths, char **buf)
	Converts an auths array to a string of comma separated values.
const char *	ast_sip_call_codec_pref_to_str (struct ast_flags pref)
	Convert the call codec preference flags to a string.
int	ast_sip_call_codec_str_to_pref (struct ast_flags *pref, const char *pref_str, int is_outgoing)
	Convert a call codec preference string to preference flags.
enum ast_sip_check_auth_result	ast_sip_check_authentication (struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata, pjsip_tx_data *tdata)
	Method to determine authentication status of an incoming request.
void	ast_sip_cleanup_auths (struct ast_sip_auth *auths[], size_t num_auths)
	Clean up retrieved auth structures from memory.
int	ast_sip_contact_to_str (void *object, void *arg, int flags)
	Handler used to convert a contact to a string.
struct ast_str *	ast_sip_create_ami_event (const char *event, struct ast_sip_ami *ami)
	Creates a string to store AMI event data in.
pjsip_dialog *	ast_sip_create_dialog_uac (const struct ast_sip_endpoint *endpoint, const char *aor_name, const char *request_user)
	General purpose method for creating a UAC dialog with an endpoint.
pjsip_dialog *	ast_sip_create_dialog_uas (const struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata, pj_status_t *status)
	General purpose method for creating a UAS dialog with an endpoint.
pjsip_dialog *	ast_sip_create_dialog_uas_locked (const struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata, pj_status_t *status)
	General purpose method for creating a UAS dialog with an endpoint.
int	ast_sip_create_rdata (pjsip_rx_data *rdata, char *packet, const char *src_name, int src_port, char *transport_type, const char *local_name, int local_port)
	General purpose method for creating an rdata structure using specific information.
int	ast_sip_create_rdata_with_contact (pjsip_rx_data *rdata, char *packet, const char *src_name, int src_port, char *transport_type, const char *local_name, int local_port, const char *contact_uri)
	General purpose method for creating an rdata structure using specific information.
int	ast_sip_create_request (const char *method, struct pjsip_dialog *dlg, struct ast_sip_endpoint *endpoint, const char *uri, struct ast_sip_contact *contact, pjsip_tx_data **tdata)
	General purpose method for creating a SIP request.
int	ast_sip_create_request_with_auth (const struct ast_sip_auth_vector *auths, pjsip_rx_data *challenge, pjsip_tx_data *tdata, pjsip_tx_data **new_request)
	Create a response to an authentication challenge.
int	ast_sip_create_response (const pjsip_rx_data *rdata, int st_code, struct ast_sip_contact *contact, pjsip_tx_data **p_tdata)
	General purpose method for creating a SIP response.
struct ast_taskprocessor *	ast_sip_create_serializer (const char *name)
	Create a new serializer for SIP tasks.
struct ast_taskprocessor *	ast_sip_create_serializer_group (const char *name, struct ast_serializer_shutdown_group *shutdown_group)
	Create a new serializer for SIP tasks.
struct ast_sip_endpoint *	ast_sip_default_outbound_endpoint (void)
	Retrieve the default outbound endpoint.
struct ast_sip_endpoint *	ast_sip_dialog_get_endpoint (pjsip_dialog *dlg)
	Get the endpoint associated with this dialog.
void	ast_sip_dialog_set_endpoint (pjsip_dialog *dlg, struct ast_sip_endpoint *endpoint)
	Set an endpoint on a SIP dialog so in-dialog requests do not undergo endpoint lookup.
void	ast_sip_dialog_set_serializer (pjsip_dialog *dlg, struct ast_taskprocessor *serializer)
	Set a serializer on a SIP dialog so requests and responses are automatically serialized.
int	ast_sip_dialog_setup_outbound_authentication (pjsip_dialog *dlg, const struct ast_sip_endpoint *endpoint, ast_sip_dialog_outbound_auth_cb cb, void *user_data)
	Set up outbound authentication on a SIP dialog.
void *	ast_sip_dict_get (void *ht, const char *key)
	Retrieves the value associated with the given key.
void *	ast_sip_dict_set (pj_pool_t *pool, void *ht, const char *key, void *val)
	Set the value for the given key.
int	ast_sip_dlg_set_transport (const struct ast_sip_endpoint *endpoint, pjsip_dialog *dlg, pjsip_tpselector *selector)
	Set the transport on a dialog.
int	ast_sip_dtmf_to_str (const enum ast_sip_dtmf_mode dtmf, char *buf, size_t buf_len)
	Convert the DTMF mode enum value into a string.
void *	ast_sip_endpoint_alloc (const char *name)
	Allocate a new SIP endpoint.
int	ast_sip_failover_request (pjsip_tx_data *tdata)
	Set a request to use the next value in the list of resolved addresses.
struct ast_sip_transport_state *	ast_sip_find_transport_state_in_use (struct ast_sip_request_transport_details *details)
	Returns the transport state currently in use based on request transport details.
int	ast_sip_for_each_aor (const char *aors, ao2_callback_fn on_aor, void *arg)
	For every aor in the comma separated aors string call the given 'on_aor' handler.
int	ast_sip_for_each_auth (const struct ast_sip_auth_vector *array, ao2_callback_fn on_auth, void *arg)
	For every auth in the array call the given 'on_auth' handler.
int	ast_sip_for_each_channel (const struct ast_sip_endpoint *endpoint, ao2_callback_fn on_channel_snapshot, void *arg)
	For every channel snapshot on an endpoint all the given 'on_channel_snapshot' handler.
int	ast_sip_for_each_channel_snapshot (const struct ast_endpoint_snapshot *endpoint_snapshot, ao2_callback_fn on_channel_snapshot, void *arg)
	For every channel snapshot on an endpoint snapshot call the given 'on_channel_snapshot' handler.
int	ast_sip_for_each_contact (const struct ast_sip_aor *aor, ao2_callback_fn on_contact, void *arg)
	For every contact on an AOR call the given 'on_contact' handler.
int	ast_sip_format_auths_ami (const struct ast_sip_auth_vector *auths, struct ast_sip_ami *ami)
	Format auth details for AMI.
int	ast_sip_format_contact_ami (void *obj, void *arg, int flags)
	Formats the contact and sends over AMI.
int	ast_sip_format_endpoint_ami (struct ast_sip_endpoint *endpoint, struct ast_sip_ami *ami, int *count)
	Formats the endpoint and sends over AMI.
unsigned int	ast_sip_get_all_codecs_on_empty_reinvite (void)
	Retrieve the system setting 'all_codecs_on_empty_reinvite'.
unsigned int	ast_sip_get_allow_sending_180_after_183 (void)
	Retrieve the global setting 'allow_sending_180_after_183'.
struct ast_sip_auth *	ast_sip_get_artificial_auth (void)
	Retrieves a reference to the artificial auth.
struct ast_sip_endpoint *	ast_sip_get_artificial_endpoint (void)
	Retrieves a reference to the artificial endpoint.
unsigned int	ast_sip_get_contact_expiration_check_interval (void)
	Retrieve the system contact expiration check interval setting.
const char *	ast_sip_get_contact_short_status_label (const enum ast_sip_contact_status_type status)
pjsip_sip_uri *	ast_sip_get_contact_sip_uri (pjsip_tx_data *tdata)
	Return the SIP URI of the Contact header.
struct ast_sip_contact_status *	ast_sip_get_contact_status (const struct ast_sip_contact *contact)
	Retrieve the current status for a contact.
const char *	ast_sip_get_contact_status_label (const enum ast_sip_contact_status_type status)
	translate ast_sip_contact_status_type to character string.
char *	ast_sip_get_debug (void)
	Retrieve the system debug setting (yes|no|host).
void	ast_sip_get_default_auth_algorithms_uac (char *default_auth_algorithms_uac, size_t size)
	Retrieve the global auth algorithms for UAC.
void	ast_sip_get_default_auth_algorithms_uas (char *default_auth_algorithms_uas, size_t size)
	Retrieve the global auth algorithms for UAS.
void	ast_sip_get_default_from_user (char *from_user, size_t size)
	Retrieve the global default from user.
void	ast_sip_get_default_realm (char *realm, size_t size)
	Retrieve the global default realm.
char *	ast_sip_get_default_voicemail_extension (void)
	Retrieve the default voicemail extension.
const char *	ast_sip_get_device_state (const struct ast_sip_endpoint *endpoint)
	Retrieve the device state for an endpoint.
unsigned int	ast_sip_get_disable_multi_domain (void)
	Retrieve the system setting 'disable multi domain'.
struct ast_taskprocessor *	ast_sip_get_distributor_serializer (pjsip_rx_data *rdata)
	Determine the distributor serializer for the SIP message.
struct ast_sip_endpoint *	ast_sip_get_endpoint (const char *to, int get_default_outbound, char **uri)
	Retrieves an endpoint and URI from the "to" string.
char *	ast_sip_get_endpoint_identifier_order (void)
	Retrieve the global endpoint_identifier_order setting.
struct ast_endpoint_snapshot *	ast_sip_get_endpoint_snapshot (const struct ast_sip_endpoint *endpoint)
	Retrieve the endpoint snapshot for an endpoint.
struct ao2_container *	ast_sip_get_endpoints (void)
	Retrieve any endpoints available to sorcery.
int	ast_sip_get_host_ip (int af, pj_sockaddr *addr)
	Retrieve the local host address in IP form.
const char *	ast_sip_get_host_ip_string (int af)
	Retrieve the local host address in string form.
unsigned int	ast_sip_get_ignore_uri_user_options (void)
	Retrieve the global setting 'ignore_uri_user_options'.
unsigned int	ast_sip_get_keep_alive_interval (void)
	Retrieve the system keep alive interval setting.
unsigned int	ast_sip_get_max_initial_qualify_time (void)
	Retrieve the system max initial qualify time.
unsigned int	ast_sip_get_mwi_disable_initial_unsolicited (void)
	Retrieve the global setting 'disable sending unsolicited mwi on startup'.
unsigned int	ast_sip_get_mwi_tps_queue_high (void)
	Retrieve the global MWI taskprocessor high water alert trigger level.
int	ast_sip_get_mwi_tps_queue_low (void)
	Retrieve the global MWI taskprocessor low water clear alert level.
unsigned int	ast_sip_get_norefersub (void)
	Retrieve the global setting 'norefersub'.
pjsip_endpoint *	ast_sip_get_pjsip_endpoint (void)
	Get a pointer to the PJSIP endpoint.
char *	ast_sip_get_regcontext (void)
	Retrieve the global regcontext setting.
unsigned int	ast_sip_get_send_contact_status_on_update_registration (void)
	Retrieve the global setting 'send_contact_status_on_update_registration'.
struct ast_sorcery *	ast_sip_get_sorcery (void)
	Get a pointer to the SIP sorcery structure.
int	ast_sip_get_transport_name (const struct ast_sip_endpoint *endpoint, pjsip_sip_uri *sip_uri, char *buf, size_t buf_len)
	Get the transport name from an endpoint or request uri.
struct ast_sip_transport_state *	ast_sip_get_transport_state (const char *transport_id)
	Retrieve transport state.
struct ao2_container *	ast_sip_get_transport_states (void)
	Retrieves all transport states.
void	ast_sip_get_unidentified_request_thresholds (unsigned int *count, unsigned int *period, unsigned int *prune_interval)
	Retrieve the unidentified request security event thresholds.
unsigned int	ast_sip_get_use_callerid_contact (void)
	Retrieve the global setting 'use_callerid_contact'.
const int	ast_sip_hangup_sip2cause (int cause)
	Convert SIP hangup causes to Asterisk hangup causes.
void	ast_sip_header_to_security_mechanism (const pjsip_generic_string_hdr *hdr, struct ast_sip_security_mechanism_vector *security_mechanisms)
	Append to security mechanism vector from SIP header.
struct ast_sip_endpoint *	ast_sip_identify_endpoint (pjsip_rx_data *rdata)
	Determine the endpoint that has sent a SIP message.
int	ast_sip_is_allowed_uri (pjsip_uri *uri)
	Check whether a pjsip_uri is allowed or not.
int	ast_sip_is_content_type (pjsip_media_type *content_type, char *type, char *subtype)
	Checks if the given content type matches type/subtype.
int	ast_sip_is_media_type_in (pjsip_media_type *a,...) attribute_sentinel
	Check if a media type is in a list of others.
int	ast_sip_is_uri_sip_sips (pjsip_uri *uri)
	Check whether a pjsip_uri is SIP/SIPS or not.
int	ast_sip_location_add_contact (struct ast_sip_aor *aor, const char *uri, struct timeval expiration_time, const char *path_info, const char *user_agent, const char *via_addr, int via_port, const char *call_id, struct ast_sip_endpoint *endpoint)
	Add a new contact to an AOR.
int	ast_sip_location_add_contact_nolock (struct ast_sip_aor *aor, const char *uri, struct timeval expiration_time, const char *path_info, const char *user_agent, const char *via_addr, int via_port, const char *call_id, struct ast_sip_endpoint *endpoint)
	Add a new contact to an AOR without locking the AOR.
struct ast_sip_contact *	ast_sip_location_create_contact (struct ast_sip_aor *aor, const char *uri, struct timeval expiration_time, const char *path_info, const char *user_agent, const char *via_addr, int via_port, const char *call_id, int prune_on_boot, struct ast_sip_endpoint *endpoint)
	Create a new contact for an AOR without locking the AOR.
int	ast_sip_location_delete_contact (struct ast_sip_contact *contact)
	Delete a contact.
void	ast_sip_location_prune_boot_contacts (void)
	Prune the prune_on_boot contacts.
struct ast_sip_aor *	ast_sip_location_retrieve_aor (const char *aor_name)
	Retrieve a named AOR.
struct ao2_container *	ast_sip_location_retrieve_aor_contacts (const struct ast_sip_aor *aor)
	Retrieve all contacts currently available for an AOR.
struct ao2_container *	ast_sip_location_retrieve_aor_contacts_filtered (const struct ast_sip_aor *aor, unsigned int flags)
	Retrieve all contacts currently available for an AOR and filter based on flags.
struct ao2_container *	ast_sip_location_retrieve_aor_contacts_nolock (const struct ast_sip_aor *aor)
	Retrieve all contacts currently available for an AOR without locking the AOR.
struct ao2_container *	ast_sip_location_retrieve_aor_contacts_nolock_filtered (const struct ast_sip_aor *aor, unsigned int flags)
	Retrieve all contacts currently available for an AOR without locking the AOR and filter based on flags.
struct ast_sip_contact *	ast_sip_location_retrieve_contact (const char *contact_name)
	Retrieve a named contact.
void	ast_sip_location_retrieve_contact_and_aor_from_list (const char *aor_list, struct ast_sip_aor **aor, struct ast_sip_contact **contact)
	Retrieve the first bound contact AND the AOR chosen from a list of AORs.
void	ast_sip_location_retrieve_contact_and_aor_from_list_filtered (const char *aor_list, unsigned int flags, struct ast_sip_aor **aor, struct ast_sip_contact **contact)
	Retrieve the first bound contact AND the AOR chosen from a list of AORs and filter based on flags.
struct ast_sip_contact *	ast_sip_location_retrieve_contact_from_aor_list (const char *aor_list)
	Retrieve the first bound contact from a list of AORs.
struct ao2_container *	ast_sip_location_retrieve_contacts_from_aor_list (const char *aor_list)
	Retrieve all contacts from a list of AORs.
struct ast_sip_contact *	ast_sip_location_retrieve_first_aor_contact (const struct ast_sip_aor *aor)
	Retrieve the first bound contact for an AOR.
struct ast_sip_contact *	ast_sip_location_retrieve_first_aor_contact_filtered (const struct ast_sip_aor *aor, unsigned int flags)
	Retrieve the first bound contact for an AOR and filter based on flags.
int	ast_sip_location_update_contact (struct ast_sip_contact *contact)
	Update a contact.
void	ast_sip_message_apply_transport (const char *transport_name, pjsip_tx_data *tdata)
	Apply the configuration for a transport to an outgoing message.
void	ast_sip_modify_id_header (pj_pool_t *pool, pjsip_fromto_hdr *id_hdr, const struct ast_party_id *id)
	Set name and number information on an identity header.
void	ast_sip_persistent_endpoint_publish_contact_state (const char *endpoint_name, const struct ast_sip_contact_status *contact_status)
	Publish the change of state for a contact.
int	ast_sip_persistent_endpoint_update_state (const char *endpoint_name, enum ast_endpoint_state state)
	Change state of a persistent endpoint.
const pj_str_t *	ast_sip_pjsip_uri_get_hostname (pjsip_uri *uri)
	Get the host portion of the pjsip_uri.
struct pjsip_param *	ast_sip_pjsip_uri_get_other_param (pjsip_uri *uri, const pj_str_t *param_str)
	Find an 'other' SIP/SIPS URI parameter by name.
const pj_str_t *	ast_sip_pjsip_uri_get_username (pjsip_uri *uri)
	Get the user portion of the pjsip_uri.
int	ast_sip_push_task (struct ast_taskprocessor *serializer, int(*sip_task)(void *), void *task_data)
	Pushes a task to SIP servants.
int	ast_sip_push_task_synchronous (struct ast_taskprocessor *serializer, int(*sip_task)(void *), void *task_data)
	Push a task to SIP servants and wait for it to complete.
int	ast_sip_push_task_wait_serializer (struct ast_taskprocessor *serializer, int(*sip_task)(void *), void *task_data)
	Push a task to the serializer and wait for it to complete.
int	ast_sip_push_task_wait_servant (struct ast_taskprocessor *serializer, int(*sip_task)(void *), void *task_data)
	Push a task to SIP servants and wait for it to complete.
char *	ast_sip_rdata_get_header_value (pjsip_rx_data *rdata, const pj_str_t str)
	Get a specific header value from rdata.
int	ast_sip_register_authenticator (struct ast_sip_authenticator *auth)
	Register a SIP authenticator.
void	ast_sip_register_endpoint_formatter (struct ast_sip_endpoint_formatter *obj)
	Register an endpoint formatter.
int	ast_sip_register_endpoint_identifier (struct ast_sip_endpoint_identifier *identifier)
	Register a SIP endpoint identifier.
int	ast_sip_register_endpoint_identifier_with_name (struct ast_sip_endpoint_identifier *identifier, const char *name)
	Register a SIP endpoint identifier with a name.
int	ast_sip_register_outbound_authenticator (struct ast_sip_outbound_authenticator *outbound_auth)
	Register an outbound SIP authenticator.
int	ast_sip_register_service (pjsip_module *module)
	Register a SIP service in Asterisk.
void	ast_sip_register_supplement (struct ast_sip_supplement *supplement)
	Register a supplement to SIP out of dialog processing.
void	ast_sip_remove_headers_by_name_and_value (pjsip_msg *msg, const pj_str_t *hdr_name, const char *value)
	Removes all headers of a specific name and value from a pjsip_msg.
void	ast_sip_report_auth_challenge_sent (struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata, pjsip_tx_data *tdata)
	Send a security event notification for when an authentication challenge is sent.
void	ast_sip_report_auth_failed_challenge_response (struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata)
	Send a security event notification for when a challenge response has failed.
void	ast_sip_report_auth_success (struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata)
	Send a security event notification for when authentication succeeds.
void	ast_sip_report_failed_acl (struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata, const char *name)
	Send a security event notification for when an ACL check fails.
void	ast_sip_report_invalid_endpoint (const char *name, pjsip_rx_data *rdata)
	Send a security event notification for when an invalid endpoint is requested.
void	ast_sip_report_mem_limit (struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata)
	Send a security event notification for when a memory limit is hit.
void	ast_sip_report_req_no_support (struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata, const char *req_type)
	Send a security event notification for when a request is not supported.
int	ast_sip_requires_authentication (struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata)
	Determine if an incoming request requires authentication.
int	ast_sip_retrieve_auths (const struct ast_sip_auth_vector *auths, struct ast_sip_auth **out)
	Retrieve relevant SIP auth structures from sorcery.
int	ast_sip_retrieve_auths_vector (const struct ast_sip_auth_vector *auth_ids, struct ast_sip_auth_objects_vector *auth_objects)
	Retrieve relevant SIP auth structures from sorcery as a vector.
int	ast_sip_rewrite_uri_to_local (pjsip_sip_uri *uri, pjsip_tx_data *tdata)
	Replace domain and port of SIP URI to point to (external) signaling address of this Asterisk instance.
int	ast_sip_sched_is_task_running (struct ast_sip_sched_task *schtd)
	Checks if the task is currently running.
int	ast_sip_sched_is_task_running_by_name (const char *name)
	Checks if the task is currently running.
int	ast_sip_sched_task_cancel (struct ast_sip_sched_task *schtd)
	Cancels the next invocation of a task.
int	ast_sip_sched_task_cancel_by_name (const char *name)
	Cancels the next invocation of a task by name.
int	ast_sip_sched_task_get_name (struct ast_sip_sched_task *schtd, char *name, size_t maxlen)
	Gets the task name.
int	ast_sip_sched_task_get_next_run (struct ast_sip_sched_task *schtd)
	Gets the number of milliseconds until the next invocation.
int	ast_sip_sched_task_get_next_run_by_name (const char *name)
	Gets the number of milliseconds until the next invocation.
int	ast_sip_sched_task_get_times (struct ast_sip_sched_task *schtd, struct timeval *when_queued, struct timeval *last_start, struct timeval *last_end)
	Gets the last start and end times of the task.
int	ast_sip_sched_task_get_times2 (struct ast_sip_sched_task *schtd, struct timeval *when_queued, struct timeval *last_start, struct timeval *last_end, int *interval, int *time_left, struct timeval *next_start)
	Gets the queued, last start, last_end, time left, interval, next run.
int	ast_sip_sched_task_get_times_by_name (const char *name, struct timeval *when_queued, struct timeval *last_start, struct timeval *last_end)
	Gets the last start and end times of the task by name.
int	ast_sip_sched_task_get_times_by_name2 (const char *name, struct timeval *when_queued, struct timeval *last_start, struct timeval *last_end, int *interval, int *time_left, struct timeval *next_start)
	Gets the queued, last start, last_end, time left, interval, next run by task name.
struct ast_sip_sched_task *	ast_sip_schedule_task (struct ast_taskprocessor *serializer, int interval, ast_sip_task sip_task, const char *name, void *task_data, enum ast_sip_scheduler_task_flags flags)
	Schedule a task to run in the res_pjsip thread pool.
int	ast_sip_security_mechanism_vector_init (struct ast_sip_security_mechanism_vector *security_mechanism, const char *value)
	Initialize security mechanism vector from string of security mechanisms.
int	ast_sip_security_mechanisms_to_str (const struct ast_sip_security_mechanism_vector *security_mechanisms, int add_qvalue, char **buf)
	Writes the security mechanisms of an endpoint into a buffer as a string and returns the buffer.
void	ast_sip_security_mechanisms_vector_copy (struct ast_sip_security_mechanism_vector *dst, const struct ast_sip_security_mechanism_vector *src)
	Duplicate a security mechanism.
void	ast_sip_security_mechanisms_vector_destroy (struct ast_sip_security_mechanism_vector *security_mechanisms)
	Free contents of a security mechanism vector.
int	ast_sip_send_out_of_dialog_request (pjsip_tx_data *tdata, struct ast_sip_endpoint *endpoint, int timeout, void *token, void(*callback)(void *token, pjsip_event *e))
	General purpose method for sending an Out-Of-Dialog SIP request.
int	ast_sip_send_request (pjsip_tx_data *tdata, struct pjsip_dialog *dlg, struct ast_sip_endpoint *endpoint, void *token, void(*callback)(void *token, pjsip_event *e))
	General purpose method for sending a SIP request.
int	ast_sip_send_response (pjsip_response_addr *res_addr, pjsip_tx_data *tdata, struct ast_sip_endpoint *sip_endpoint)
	Send a response to an out of dialog request.
int	ast_sip_send_stateful_response (pjsip_rx_data *rdata, pjsip_tx_data *tdata, struct ast_sip_endpoint *sip_endpoint)
	Send a stateful response to an out of dialog request.
struct ast_sip_service_route_vector *	ast_sip_service_route_vector_alloc (void)
	Allocate a vector of service routes.
void	ast_sip_service_route_vector_destroy (struct ast_sip_service_route_vector *service_routes)
	Destroy a vector of service routes.
int	ast_sip_set_id_connected_line (struct pjsip_rx_data *rdata, struct ast_party_id *id)
	Set the ID for a connected line update.
int	ast_sip_set_id_from_invite (struct pjsip_rx_data *rdata, struct ast_party_id *id, struct ast_party_id *default_id, int trust_inbound)
	Set the ID from an INVITE.
int	ast_sip_set_outbound_proxy (pjsip_tx_data *tdata, const char *proxy)
	Set the outbound proxy for an outbound SIP message.
int	ast_sip_set_request_transport_details (struct ast_sip_request_transport_details *details, pjsip_tx_data *tdata, int use_ipv6)
	Sets request transport details based on tdata.
int	ast_sip_set_security_negotiation (enum ast_sip_security_negotiation *security_negotiation, const char *val)
	Set the security negotiation based on a given string.
int	ast_sip_set_tpselector_from_ep_or_uri (const struct ast_sip_endpoint *endpoint, pjsip_sip_uri *sip_uri, pjsip_tpselector *selector)
	Sets pjsip_tpselector from an endpoint or uri.
int	ast_sip_set_tpselector_from_transport (const struct ast_sip_transport *transport, pjsip_tpselector *selector)
	Sets pjsip_tpselector from ast_sip_transport.
int	ast_sip_set_tpselector_from_transport_name (const char *transport_name, pjsip_tpselector *selector)
	Sets pjsip_tpselector from ast_sip_transport.
int	ast_sip_sorcery_object_to_ami (const void *obj, struct ast_str **buf)
	Converts a sorcery object to a string of object properties.
int	ast_sip_str2rc (const char *name)
	Convert name to SIP response code.
int	ast_sip_str_to_dtmf (const char *dtmf_mode)
	Convert the DTMF mode name into an enum.
int	ast_sip_str_to_security_mechanism (struct ast_sip_security_mechanism **security_mechanism, const char *value)
	Allocate a security mechanism from a string.
int	ast_sip_thread_is_servant (void)
	Determine if the current thread is a SIP servant thread.
struct ast_threadpool *	ast_sip_threadpool (void)
	Retrieve the SIP threadpool object.
long	ast_sip_threadpool_queue_size (void)
	Return the size of the SIP threadpool's task queue.
void	ast_sip_tpselector_unref (pjsip_tpselector *selector)
	Unreference a pjsip_tpselector.
enum ast_transport_monitor_reg	ast_sip_transport_monitor_register (pjsip_transport *transport, ast_transport_monitor_shutdown_cb cb, void *ao2_data)
	Register a reliable transport shutdown monitor callback.
enum ast_transport_monitor_reg	ast_sip_transport_monitor_register_key (const char *transport_key, ast_transport_monitor_shutdown_cb cb, void *ao2_data)
	Register a reliable transport shutdown monitor callback.
enum ast_transport_monitor_reg	ast_sip_transport_monitor_register_replace (pjsip_transport *transport, ast_transport_monitor_shutdown_cb cb, void *ao2_data, ast_transport_monitor_data_matcher matches)
	Register a reliable transport shutdown monitor callback replacing any duplicate.
enum ast_transport_monitor_reg	ast_sip_transport_monitor_register_replace_key (const char *transport_key, ast_transport_monitor_shutdown_cb cb, void *ao2_data, ast_transport_monitor_data_matcher matches)
	Register a reliable transport shutdown monitor callback replacing any duplicate.
void	ast_sip_transport_monitor_unregister (pjsip_transport *transport, ast_transport_monitor_shutdown_cb cb, void *data, ast_transport_monitor_data_matcher matches)
	Unregister a reliable transport shutdown monitor.
void	ast_sip_transport_monitor_unregister_all (ast_transport_monitor_shutdown_cb cb, void *data, ast_transport_monitor_data_matcher matches)
	Unregister a transport shutdown monitor from all reliable transports.
void	ast_sip_transport_monitor_unregister_key (const char *transport_key, ast_transport_monitor_shutdown_cb cb, void *data, ast_transport_monitor_data_matcher matches)
	Unregister a reliable transport shutdown monitor.
void	ast_sip_transport_state_register (struct ast_sip_tpmgr_state_callback *element)
	Register a transport state notification callback element.
int	ast_sip_transport_state_set_preferred_identity (const char *transport_name, const char *identity)
	Sets the P-Preferred-Identity on a child transport.
int	ast_sip_transport_state_set_service_routes (const char *transport_name, struct ast_sip_service_route_vector *service_routes)
	Sets the service routes on a child transport.
int	ast_sip_transport_state_set_transport (const char *transport_name, pjsip_transport *transport)
	Sets the PJSIP transport on a child transport.
void	ast_sip_transport_state_unregister (struct ast_sip_tpmgr_state_callback *element)
	Unregister a transport state notification callback element.
void	ast_sip_unregister_authenticator (struct ast_sip_authenticator *auth)
	Unregister a SIP authenticator.
void	ast_sip_unregister_endpoint_formatter (struct ast_sip_endpoint_formatter *obj)
	Unregister an endpoint formatter.
void	ast_sip_unregister_endpoint_identifier (struct ast_sip_endpoint_identifier *identifier)
	Unregister a SIP endpoint identifier.
void	ast_sip_unregister_outbound_authenticator (struct ast_sip_outbound_authenticator *auth)
	Unregister an outbound SIP authenticator.
void	ast_sip_unregister_service (pjsip_module *module)
void	ast_sip_unregister_supplement (struct ast_sip_supplement *supplement)
	Unregister a an supplement to SIP out of dialog processing.
int	ast_sip_update_from (pjsip_tx_data *tdata, char *from)
	Overwrite fields in the outbound 'From' header.
int	ast_sip_update_to_uri (pjsip_tx_data *tdata, const char *to)
	Replace the To URI in the tdata with the supplied one.

Variables
static const pj_str_t	AST_PJ_STR_EMPTY = { "", 0 }
pjsip_media_type	pjsip_media_type_application_cpim_xpidf_xml
pjsip_media_type	pjsip_media_type_application_json
pjsip_media_type	pjsip_media_type_application_media_control_xml
pjsip_media_type	pjsip_media_type_application_pidf_xml
pjsip_media_type	pjsip_media_type_application_rlmi_xml
pjsip_media_type	pjsip_media_type_application_sdp
pjsip_media_type	pjsip_media_type_application_simple_message_summary
pjsip_media_type	pjsip_media_type_application_xpidf_xml
pjsip_media_type	pjsip_media_type_multipart_alternative
pjsip_media_type	pjsip_media_type_multipart_mixed
pjsip_media_type	pjsip_media_type_multipart_related
pjsip_media_type	pjsip_media_type_text_plain

Macro Definition Documentation

AST_SIP_AUTH_MAX_REALM_LENGTH

#define AST_SIP_AUTH_MAX_REALM_LENGTH   255 /* From the auth/realm realtime column size */

Definition at line 74 of file res_pjsip.h.

AST_SIP_AUTH_MAX_SUPPORTED_ALGORITHMS_LENGTH

#define AST_SIP_AUTH_MAX_SUPPORTED_ALGORITHMS_LENGTH   (255) /* From the supported algorithms realtime column size */

Definition at line 75 of file res_pjsip.h.

ast_sip_call_codec_pref_test

#define ast_sip_call_codec_pref_test	(		__param,
			__codec_pref
	)		(!!(ast_test_flag( &__param, AST_SIP_CALL_CODEC_PREF_ ## __codec_pref )))

Returns true if the preference is set in the parameter.

Since

18.0.0

Parameters

__param	A ast_flags struct with one or more of enum ast_sip_call_codec_pref set
__codec_pref	The last component of one of the enum values

Return values

1	if the enum value is set
0	if not

Definition at line 787 of file res_pjsip.h.

ast_sip_cleanup_auth_objects_vector

#define ast_sip_cleanup_auth_objects_vector

(

auth_objects

)

AST_VECTOR_RESET(auth_objects, ao2_cleanup)

Clean up retrieved auth objects in vector.

Call this function once you have completed operating on auths retrieved from ast_sip_retrieve_auths_vector. All auth objects will have their reference counts decremented and the vector size will be reset to 0. You must still call AST_VECTOR_FREE() on the vector itself.

Parameters

auth_objects

A vector of auth structures to clean up

Definition at line 2967 of file res_pjsip.h.

AST_SIP_MAKE_REMOTE_IPADDR_PORT_STR

#define AST_SIP_MAKE_REMOTE_IPADDR_PORT_STR	(		_transport,
			_dest
	)		pj_sockaddr_print(&_transport->key.rem_addr, _dest, sizeof(_dest), 1);

Fill a buffer with a pjsip transport's remote ip address and port.

Parameters

_transport	The pjsip_transport to use
_dest	The destination buffer of at least IP6ADDR_COLON_PORT_BUFLEN bytes

Definition at line 91 of file res_pjsip.h.

                                         { "", 0 };
 
/*!
 * \brief Structure for SIP transport information
 */
struct ast_sip_transport_state {
    /*! \brief Transport itself */
    struct pjsip_transport *transport;
    /*! \brief Transport factory */
    struct pjsip_tpfactory *factory;
    /*!
     * Transport id
     * \since 13.8.0
     */
    char *id;
    /*!
     * Transport type
     * \since 13.8.0
     */
    enum ast_transport type;
    /*!
     * Address and port to bind to
     * \since 13.8.0
     */
    pj_sockaddr host;
    /*!
     * TLS settings
     * \since 13.8.0
     */
    pjsip_tls_setting tls;
    /*!
     * Configured TLS ciphers
     * \since 13.8.0
     */
    pj_ssl_cipher ciphers[SIP_TLS_MAX_CIPHERS];
    /*!
     * Optional local network information, used for NAT purposes.
     * "deny" (set) means that it's in the local network. Use the
     * ast_sip_transport_is_nonlocal and ast_sip_transport_is_local
     * macro's.
     * \since 13.8.0
     */
    struct ast_ha *localnet;
    /*!
     * DNS manager for refreshing the external signaling address
     * \since 13.8.0
     */
    struct ast_dnsmgr_entry *external_signaling_address_refresher;
    /*!
     * Optional external signaling address information
     * \since 13.8.0
     */
    struct ast_sockaddr external_signaling_address;
    /*!
     * DNS manager for refreshing the external media address
     * \since 13.18.0
     */
    struct ast_dnsmgr_entry *external_media_address_refresher;
    /*!
     * Optional external signaling address information
     * \since 13.18.0
     */
    struct ast_sockaddr external_media_address;
    /*!
     * Set when this transport is a flow of signaling to a target
     * \since 17.0.0
     */
    int flow;
    /*!
     * The P-Preferred-Identity to use on traffic using this transport
     * \since 17.0.0
     */
    char *preferred_identity;
    /*!
     * The Service Routes to use on traffic using this transport
     * \since 17.0.0
     */
    struct ast_sip_service_route_vector *service_routes;
    /*!
     * Disregard RFC5922 7.2, and allow wildcard certs (TLS only)
     */
    int allow_wildcard_certs;
    /*!
     * If true, fail if server certificate cannot verify (TLS only)
     */
    int verify_server;
#ifdef HAVE_PJSIP_TLS_TRANSPORT_RESTART
    /*!
     * The stats information for the certificate file, if configured
     */
    struct stat cert_file_stat;
    /*!
     * The stats information for the private key file, if configured
     */
    struct stat privkey_file_stat;
#endif
};
 
#define ast_sip_transport_is_nonlocal(transport_state, addr) \
    (!transport_state->localnet || ast_apply_ha(transport_state->localnet, addr) == AST_SENSE_ALLOW)
 
#define ast_sip_transport_is_local(transport_state, addr) \
    (transport_state->localnet && ast_apply_ha(transport_state->localnet, addr) != AST_SENSE_ALLOW)
 
/*!
 * \brief Transport to bind to
 */
struct ast_sip_transport {
    /*! Sorcery object details */
    SORCERY_OBJECT(details);
    AST_DECLARE_STRING_FIELDS(
        /*! Certificate of authority list file */
        AST_STRING_FIELD(ca_list_file);
        /*! Certificate of authority list path */
        AST_STRING_FIELD(ca_list_path);
        /*! Public certificate file */
        AST_STRING_FIELD(cert_file);
        /*! Optional private key of the certificate file */
        AST_STRING_FIELD(privkey_file);
        /*! Password to open the private key */
        AST_STRING_FIELD(password);
        /*! External signaling address */
        AST_STRING_FIELD(external_signaling_address);
        /*! External media address */
        AST_STRING_FIELD(external_media_address);
        /*! Optional domain to use for messages if provided could not be found */
        AST_STRING_FIELD(domain);
        );
    /*! Type of transport */
    enum ast_transport type;
    /*!
     * \deprecated Moved to ast_sip_transport_state
     * \version 13.8.0 deprecated
     * Address and port to bind to
     */
    pj_sockaddr host;
    /*! Number of simultaneous asynchronous operations */
    unsigned int async_operations;
    /*! Optional external port for signaling */
    unsigned int external_signaling_port;
    /*!
     * \deprecated Moved to ast_sip_transport_state
     * \version 13.7.1 deprecated
     * TLS settings
     */
    pjsip_tls_setting tls;
    /*!
     * \deprecated Moved to ast_sip_transport_state
     * \version 13.7.1 deprecated
     * Configured TLS ciphers
     */
    pj_ssl_cipher ciphers[SIP_TLS_MAX_CIPHERS];
    /*!
     * \deprecated Moved to ast_sip_transport_state
     * \version 13.7.1 deprecated
     * Optional local network information, used for NAT purposes
     */
    struct ast_ha *localnet;
    /*!
     * \deprecated Moved to ast_sip_transport_state
     * \version 13.7.1 deprecated
     * DNS manager for refreshing the external address
     */
    struct ast_dnsmgr_entry *external_address_refresher;
    /*!
     * \deprecated Moved to ast_sip_transport_state
     * \version 13.7.1 deprecated
     * Optional external address information
     */
    struct ast_sockaddr external_address;
    /*!
     * \deprecated
     * \version 13.7.1 deprecated
     * Transport state information
     */
    struct ast_sip_transport_state *state;
    /*! QOS DSCP TOS bits */
    unsigned int tos;
    /*! QOS COS value */
    unsigned int cos;
    /*! Write timeout */
    int write_timeout;
    /*! Allow reload */
    int allow_reload;
    /*! Automatically send requests out the same transport requests have come in on */
    int symmetric_transport;
    /*! This is a flow to another target */
    int flow;
    /*! Enable TCP keepalive */
    int tcp_keepalive_enable;
    /*! Time in seconds the connection needs to remain idle before TCP starts sending keepalive probes */
    int tcp_keepalive_idle_time;
    /*! The time in seconds between individual keepalive probes */
    int tcp_keepalive_interval_time;
    /*! The maximum number of keepalive probes TCP should send before dropping the connection */
    int tcp_keepalive_probe_count;
};
 
#define SIP_SORCERY_DOMAIN_ALIAS_TYPE "domain_alias"
 
/*!
 * Details about a SIP domain alias
 */
struct ast_sip_domain_alias {
    /*! Sorcery object details */
    SORCERY_OBJECT(details);
    AST_DECLARE_STRING_FIELDS(
        /*! Domain to be aliased to */
        AST_STRING_FIELD(domain);
    );
};
 
/*!
 * \brief Structure for SIP nat hook information
 */
struct ast_sip_nat_hook {
    /*! Sorcery object details */
    SORCERY_OBJECT(details);
    /*! Callback for when a message is going outside of our local network */
    void (*outgoing_external_message)(struct pjsip_tx_data *tdata, struct ast_sip_transport *transport);
};
 
/*! \brief Structure which contains information about a transport */
struct ast_sip_request_transport_details {
    /*! \brief Type of transport */
    enum ast_transport type;
    /*! \brief Potential pointer to the transport itself, if UDP */
    pjsip_transport *transport;
    /*! \brief Potential pointer to the transport factory itself, if TCP/TLS */
    pjsip_tpfactory *factory;
    /*! \brief Local address for transport */
    pj_str_t local_address;
    /*! \brief Local port for transport */
    int local_port;
};
 
/*!
 * \brief The kind of security negotiation
 */
enum ast_sip_security_negotiation {
    /*! No security mechanism negotiation */
    AST_SIP_SECURITY_NEG_NONE = 0,
    /*! Use mediasec security mechanism negotiation */
    AST_SIP_SECURITY_NEG_MEDIASEC,
    /* Add RFC 3329 (sec-agree) mechanism negotiation in the future */
};
 
/*!
 * \brief The security mechanism type
 */
enum ast_sip_security_mechanism_type {
    AST_SIP_SECURITY_MECH_NONE = 0,
    /* Use msrp-tls as security mechanism */
    AST_SIP_SECURITY_MECH_MSRP_TLS,
    /* Use sdes-srtp as security mechanism */
    AST_SIP_SECURITY_MECH_SDES_SRTP,
    /* Use dtls-srtp as security mechanism */
    AST_SIP_SECURITY_MECH_DTLS_SRTP,
    /* Add RFC 3329 (sec-agree) mechanisms like tle, digest, ipsec-ike in the future */
};
 
/*!
 * \brief Structure representing a security mechanism as defined in RFC 3329
 */
struct ast_sip_security_mechanism {
    /* Used to determine which security mechanism to use. */
    enum ast_sip_security_mechanism_type type;
    /* The preference of this security mechanism. The higher the value, the more preferred. */
    float qvalue;
    /* Optional mechanism parameters. */
    struct ast_vector_string mechanism_parameters;
};
 
AST_VECTOR(ast_sip_security_mechanism_vector, struct ast_sip_security_mechanism *);
 
/*!
 * \brief Contact associated with an address of record
 */
struct ast_sip_contact {
    /*! Sorcery object details, the id is the aor name plus a random string */
    SORCERY_OBJECT(details);
    AST_DECLARE_STRING_FIELDS(
        /*! Full URI of the contact */
        AST_STRING_FIELD(uri);
        /*! Outbound proxy to use for qualify */
        AST_STRING_FIELD(outbound_proxy);
        /*! Path information to place in Route headers */
        AST_STRING_FIELD(path);
        /*! Content of the User-Agent header in REGISTER request */
        AST_STRING_FIELD(user_agent);
        /*! The name of the aor this contact belongs to */
        AST_STRING_FIELD(aor);
        /*! Asterisk Server name */
        AST_STRING_FIELD(reg_server);
        /*! IP-address of the Via header in REGISTER request */
        AST_STRING_FIELD(via_addr);
        /*! Content of the Call-ID header in REGISTER request */
        AST_STRING_FIELD(call_id);
        /*! The name of the endpoint that added the contact */
        AST_STRING_FIELD(endpoint_name);
    );
    /*! Absolute time that this contact is no longer valid after */
    struct timeval expiration_time;
    /*! Frequency to send OPTIONS requests to contact. 0 is disabled. */
    unsigned int qualify_frequency;
    /*! If true authenticate the qualify challenge response if needed */
    int authenticate_qualify;
    /*! Qualify timeout. 0 is diabled. */
    double qualify_timeout;
    /*! Endpoint that added the contact, only available in observers */
    struct ast_sip_endpoint *endpoint;
    /*! Port of the Via header in REGISTER request */
    int via_port;
    /*! If true delete the contact on Asterisk restart/boot */
    int prune_on_boot;
    /*! If true only authenticate if OPTIONS response is 2XX */
    int qualify_2xx_only;
};
 
/*!
 * \brief Status type for a contact.
 */
enum ast_sip_contact_status_type {
    /*! Frequency > 0, but no response from remote uri */
    UNAVAILABLE,
    /*! Frequency > 0, and got response from remote uri */
    AVAILABLE,
    /*! Default last status, and when a contact status object is not found */
    UNKNOWN,
    /*! Frequency == 0, has a contact, but don't know status (non-qualified) */
    CREATED,
    REMOVED,
};
 
/*!
 * \brief A contact's status.
 *
 * Maintains a contact's current status and round trip time if available.
 */
struct ast_sip_contact_status {
    AST_DECLARE_STRING_FIELDS(
        /*! The original contact's URI */
        AST_STRING_FIELD(uri);
        /*! The name of the aor this contact_status belongs to */
        AST_STRING_FIELD(aor);
    );
    /*! The round trip time in microseconds */
    int64_t rtt;
    /*!
     * The security mechanism list of the contact (RFC 3329).
     * Stores the values of Security-Server headers in 401/421/494 responses to an
     * in-dialog request or successful outbound registration which will be used to
     * set the Security-Verify headers of all subsequent requests to the contact.
     */
    struct ast_sip_security_mechanism_vector security_mechanisms;
    /*! Current status for a contact (default - unavailable) */
    enum ast_sip_contact_status_type status;
    /*! Last status for a contact (default - unavailable) */
    enum ast_sip_contact_status_type last_status;
    /*! Name of the contact */
    char name[0];
};
 
/*!
 * \brief A SIP address of record
 */
struct ast_sip_aor {
    /*! Sorcery object details, the id is the AOR name */
    SORCERY_OBJECT(details);
    AST_DECLARE_STRING_FIELDS(
        /*! Voicemail boxes for this AOR */
        AST_STRING_FIELD(mailboxes);
        /*! Outbound proxy for OPTIONS requests */
        AST_STRING_FIELD(outbound_proxy);
    );
    /*! Minimum expiration time */
    unsigned int minimum_expiration;
    /*! Maximum expiration time */
    unsigned int maximum_expiration;
    /*! Default contact expiration if one is not provided in the contact */
    unsigned int default_expiration;
    /*! Frequency to send OPTIONS requests to AOR contacts. 0 is disabled. */
    unsigned int qualify_frequency;
    /*! If true authenticate the qualify challenge response if needed */
    int authenticate_qualify;
    /*! Maximum number of external contacts, 0 to disable */
    unsigned int max_contacts;
    /*! Whether to remove any existing contacts not related to an incoming REGISTER when it comes in */
    unsigned int remove_existing;
    /*! Any permanent configured contacts */
    struct ao2_container *permanent_contacts;
    /*! Determines whether SIP Path headers are supported */
    unsigned int support_path;
    /*! Qualify timeout. 0 is diabled. */
    double qualify_timeout;
    /*! Voicemail extension to set in Message-Account */
    char *voicemail_extension;
    /*! Whether to remove unavailable contacts over max_contacts at all or first if remove_existing is enabled */
    unsigned int remove_unavailable;
    /*! If true only authenticate if OPTIONS response is 2XX */
    int qualify_2xx_only;
};
 
/*!
 * \brief A wrapper for contact that adds the aor_id and
 * a consistent contact id.  Used by ast_sip_for_each_contact.
 */
struct ast_sip_contact_wrapper {
    /*! The id of the parent aor. */
    char *aor_id;
    /*! The id of contact in form of aor_id/contact_uri. */
    char *contact_id;
    /*! Pointer to the actual contact. */
    struct ast_sip_contact *contact;
};
 
/*!
 * \brief 100rel modes for SIP endpoints
 */
enum ast_sip_100rel_mode {
    /*! Do not support 100rel. (no) */
    AST_SIP_100REL_UNSUPPORTED = 0,
    /*! As UAC, indicate 100rel support in Supported header. (yes) */
    AST_SIP_100REL_SUPPORTED,
    /*! As UAS, send 1xx responses reliably, if the UAC indicated its support. Otherwise same as AST_SIP_100REL_SUPPORTED. (peer_supported) */
    AST_SIP_100REL_PEER_SUPPORTED,
    /*! Require the use of 100rel. (required) */
    AST_SIP_100REL_REQUIRED,
};
 
/*!
 * \brief DTMF modes for SIP endpoints
 */
enum ast_sip_dtmf_mode {
    /*! No DTMF to be used */
    AST_SIP_DTMF_NONE,
    /* XXX Should this be 2833 instead? */
    /*! Use RFC 4733 events for DTMF */
    AST_SIP_DTMF_RFC_4733,
    /*! Use DTMF in the audio stream */
    AST_SIP_DTMF_INBAND,
    /*! Use SIP INFO DTMF (blech) */
    AST_SIP_DTMF_INFO,
    /*! Use SIP 4733 if supported by the other side or INBAND if not */
    AST_SIP_DTMF_AUTO,
    /*! Use SIP 4733 if supported by the other side or INFO DTMF (blech) if not */
    AST_SIP_DTMF_AUTO_INFO,
};
 
/*!
 * \brief Authentication methods.
 *
 * The meaning of this type has changed.  It used to indicate how
 * the credentials were stored, but now it indicates which authentication
 * method will be used...  Google Oauth, Artificial (fake auth) or Digest.
 * The USER_PASS and MD5 types are still used for backwards compatibility
 * but will map to DIGEST.
 */
enum ast_sip_auth_type {
    AST_SIP_AUTH_TYPE_NONE = -1,
    /*!
     * Credentials stored as a username and password combination
     * \deprecated Now automatically determined
     */
    AST_SIP_AUTH_TYPE_USER_PASS = 0,
    /*!
     * Credentials stored as an MD5 sum
     * \deprecated Use AST_SIP_AUTH_TYPE_DIGEST instead
     */
    AST_SIP_AUTH_TYPE_MD5,
    /*! Google Oauth */
    AST_SIP_AUTH_TYPE_GOOGLE_OAUTH,
    /*! Credentials not stored this is a fake auth */
    AST_SIP_AUTH_TYPE_ARTIFICIAL,
    /*! Digest method will be used */
    AST_SIP_AUTH_TYPE_DIGEST,
};
 
enum ast_sip_auth_cred_usage {
    /*! The credentials used as a UAC */
    AST_SIP_AUTH_CRED_USAGE_UAC,
    /*! The credentials used as a UAS */
    AST_SIP_AUTH_CRED_USAGE_UAS,
};
 
#define SIP_SORCERY_AUTH_TYPE "auth"
 
#ifndef HAVE_PJSIP_AUTH_NEW_DIGESTS
/*
 * These are needed if the version of pjproject in use
 * does not have the new digests.
 * NOTE: We don't support AKAV1_MD5 but we need to specify
 * it to be compatible with the pjproject definition.
 */
typedef enum pjsip_auth_algorithm_type
{
    PJSIP_AUTH_ALGORITHM_NOT_SET = 0,
    PJSIP_AUTH_ALGORITHM_MD5,
    PJSIP_AUTH_ALGORITHM_SHA256,
    PJSIP_AUTH_ALGORITHM_SHA512_256,
    PJSIP_AUTH_ALGORITHM_AKAV1_MD5,
    PJSIP_AUTH_ALGORITHM_COUNT,
} pjsip_auth_algorithm_type;
 
typedef struct pjsip_auth_algorithm
{
    pjsip_auth_algorithm_type algorithm_type;
    pj_str_t iana_name;
    const char *openssl_name;
    unsigned digest_length;
    unsigned digest_str_length;
} pjsip_auth_algorithm;
#endif
 
/*!
 * \brief Get algorithm by algorithm type
 *
 * \param algorithm_type The algorithm type
 * \retval The algorithm or NULL if not found
 */
const pjsip_auth_algorithm *ast_sip_auth_get_algorithm_by_type(
    pjsip_auth_algorithm_type algorithm_type);
 
/*!
 * \brief Get algorithm by IANA name
 *
 * \param iana_name The algorithm IANA name
 * \retval The algorithm or NULL if not found
 */
const pjsip_auth_algorithm *ast_sip_auth_get_algorithm_by_iana_name(
    const pj_str_t *iana_name);
 
/*!
 * \brief Is algorithm supported by OpenSSL and pjproject?
 *
 * \param algorithm_type The algorithm IANA name
 * \retval The algorithm or NULL if not found
 */
pj_bool_t ast_sip_auth_is_algorithm_supported(
    pjsip_auth_algorithm_type algorithm_type);
 
AST_VECTOR(pjsip_auth_algorithm_type_vector, pjsip_auth_algorithm_type);
 
struct ast_sip_auth_password_digest {
    pjsip_auth_algorithm_type algorithm_type;
    char digest[0];
};
 
struct ast_sip_auth {
    /*! Sorcery ID of the auth is its name */
    SORCERY_OBJECT(details);
    AST_DECLARE_STRING_FIELDS(
        /*! Identification for these credentials */
        AST_STRING_FIELD(realm);
        /*! Authentication username */
        AST_STRING_FIELD(auth_user);
        /*! Authentication password */
        AST_STRING_FIELD(auth_pass);
        /*!
         * Authentication credentials in MD5 format (hash of user:realm:pass)
         * \deprecated Use password_digests[PJSIP_AUTH_ALGORITHM_MD5] instead.
         */
        AST_STRING_FIELD(md5_creds);
        /*! Refresh token to use for OAuth authentication */
        AST_STRING_FIELD(refresh_token);
        /*! Client ID to use for OAuth authentication */
        AST_STRING_FIELD(oauth_clientid);
        /*! Secret to use for OAuth authentication */
        AST_STRING_FIELD(oauth_secret);
    );
    /*! The time period (in seconds) that a nonce may be reused */
    unsigned int nonce_lifetime;
    /*! Used to determine what to use when authenticating */
    enum ast_sip_auth_type type;
    /*! Digest algorithms to support when UAC */
    struct pjsip_auth_algorithm_type_vector supported_algorithms_uac;
    /*! Digest algorithms to send challenges for when UAS */
    struct pjsip_auth_algorithm_type_vector supported_algorithms_uas;
    /*! Array of pre-digested passwords indexed by pjsip_auth_algorithm_type */
    struct ast_sip_auth_password_digest *password_digests[PJSIP_AUTH_ALGORITHM_COUNT];
};
 
AST_VECTOR(ast_sip_auth_vector, const char *);
 
/*!
 * \brief Different methods by which incoming requests can be matched to endpoints
 */
enum ast_sip_endpoint_identifier_type {
    /*! Identify based on user name in From header */
    AST_SIP_ENDPOINT_IDENTIFY_BY_USERNAME = (1 << 0),
    /*! Identify based on user name in Auth header first, then From header */
    AST_SIP_ENDPOINT_IDENTIFY_BY_AUTH_USERNAME = (1 << 1),
    /*! Identify based on source IP address */
    AST_SIP_ENDPOINT_IDENTIFY_BY_IP = (1 << 2),
    /*! Identify based on arbitrary headers */
    AST_SIP_ENDPOINT_IDENTIFY_BY_HEADER = (1 << 3),
    /*! Identify based on request uri */
    AST_SIP_ENDPOINT_IDENTIFY_BY_REQUEST_URI = (1 << 4),
};
AST_VECTOR(ast_sip_identify_by_vector, enum ast_sip_endpoint_identifier_type);
 
enum ast_sip_session_refresh_method {
    /*! Use reinvite to negotiate direct media */
    AST_SIP_SESSION_REFRESH_METHOD_INVITE,
    /*! Use UPDATE to negotiate direct media */
    AST_SIP_SESSION_REFRESH_METHOD_UPDATE,
};
 
enum ast_sip_direct_media_glare_mitigation {
    /*! Take no special action to mitigate reinvite glare */
    AST_SIP_DIRECT_MEDIA_GLARE_MITIGATION_NONE,
    /*! Do not send an initial direct media session refresh on outgoing call legs
     * Subsequent session refreshes will be sent no matter the session direction
     */
    AST_SIP_DIRECT_MEDIA_GLARE_MITIGATION_OUTGOING,
    /*! Do not send an initial direct media session refresh on incoming call legs
     * Subsequent session refreshes will be sent no matter the session direction
     */
    AST_SIP_DIRECT_MEDIA_GLARE_MITIGATION_INCOMING,
};
 
enum ast_sip_session_media_encryption {
    /*! Invalid media encryption configuration */
    AST_SIP_MEDIA_TRANSPORT_INVALID = 0,
    /*! Do not allow any encryption of session media */
    AST_SIP_MEDIA_ENCRYPT_NONE,
    /*! Offer SDES-encrypted session media */
    AST_SIP_MEDIA_ENCRYPT_SDES,
    /*! Offer encrypted session media with datagram TLS key exchange */
    AST_SIP_MEDIA_ENCRYPT_DTLS,
};
 
enum ast_sip_session_redirect {
    /*! User portion of the target URI should be used as the target in the dialplan */
    AST_SIP_REDIRECT_USER = 0,
    /*! Target URI should be used as the target in the dialplan */
    AST_SIP_REDIRECT_URI_CORE,
    /*! Target URI should be used as the target within chan_pjsip itself */
    AST_SIP_REDIRECT_URI_PJSIP,
};
 
/*!
 * \brief Incoming/Outgoing call offer/answer joint codec preference.
 *
 * The default is INTERSECT ALL LOCAL.
 */
enum ast_sip_call_codec_pref {
    /*! Two bits for merge */
    /*! Intersection of local and remote */
    AST_SIP_CALL_CODEC_PREF_INTERSECT = 1 << 0,
    /*! Union of local and remote */
    AST_SIP_CALL_CODEC_PREF_UNION =     1 << 1,
 
    /*! Two bits for filter */
    /*! No filter */
    AST_SIP_CALL_CODEC_PREF_ALL =       1 << 2,
    /*! Only the first */
    AST_SIP_CALL_CODEC_PREF_FIRST =     1 << 3,
 
    /*! Two bits for preference and sort   */
    /*! Prefer, and order by local values */
    AST_SIP_CALL_CODEC_PREF_LOCAL =     1 << 4,
    /*! Prefer, and order by remote values */
    AST_SIP_CALL_CODEC_PREF_REMOTE =    1 << 5,
};
 
/*!
 * \brief Returns true if the preference is set in the parameter
 * \since 18.0.0
 *
 * \param __param A ast_flags struct with one or more of enum ast_sip_call_codec_pref set
 * \param __codec_pref The last component of one of the enum values
 * \retval 1 if the enum value is set
 * \retval 0 if not
 */
#define ast_sip_call_codec_pref_test(__param, __codec_pref) (!!(ast_test_flag( &__param, AST_SIP_CALL_CODEC_PREF_ ## __codec_pref )))
 
/*!
 * \brief Session timers options
 */
struct ast_sip_timer_options {
    /*! Minimum session expiration period, in seconds */
    unsigned int min_se;
    /*! Session expiration period, in seconds */
    unsigned int sess_expires;
};
 
/*!
 * \brief Endpoint configuration for SIP extensions.
 *
 * SIP extensions, in this case refers to features
 * indicated in Supported or Required headers.
 */
struct ast_sip_endpoint_extensions {
    /*! Enabled SIP extensions */
    unsigned int flags;
    /*! Timer options */
    struct ast_sip_timer_options timer;
};
 
/*!
 * \brief Endpoint configuration for unsolicited MWI
 */
struct ast_sip_mwi_configuration {
    AST_DECLARE_STRING_FIELDS(
        /*! Configured voicemail boxes for this endpoint. Used for MWI */
        AST_STRING_FIELD(mailboxes);
        /*! Username to use when sending MWI NOTIFYs to this endpoint */
        AST_STRING_FIELD(fromuser);
    );
    /*! Should mailbox states be combined into a single notification? */
    unsigned int aggregate;
    /*! Should a subscribe replace unsolicited notifies? */
    unsigned int subscribe_replaces_unsolicited;
    /*! Voicemail extension to set in Message-Account */
    char *voicemail_extension;
};
 
/*!
 * \brief Endpoint subscription configuration
 */
struct ast_sip_endpoint_subscription_configuration {
    /*! Indicates if endpoint is allowed to initiate subscriptions */
    unsigned int allow;
    /*! The minimum allowed expiration for subscriptions from endpoint */
    unsigned int minexpiry;
    /*! Message waiting configuration */
    struct ast_sip_mwi_configuration mwi;
    /*! Context for SUBSCRIBE requests */
    char context[AST_MAX_CONTEXT];
};
 
/*!
 * \brief NAT configuration options for endpoints
 */
struct ast_sip_endpoint_nat_configuration {
    /*! Whether to force using the source IP address/port for sending responses */
    unsigned int force_rport;
    /*! Whether to rewrite the Contact header with the source IP address/port or not */
    unsigned int rewrite_contact;
};
 
/*!
 * \brief Party identification options for endpoints
 *
 * This includes caller ID, connected line, and redirecting-related options
 */
struct ast_sip_endpoint_id_configuration {
    struct ast_party_id self;
    /*! Do we accept identification information from this endpoint */
    unsigned int trust_inbound;
    /*! Do we send private identification information to this endpoint? */
    unsigned int trust_outbound;
    /*! Do we send P-Asserted-Identity headers to this endpoint? */
    unsigned int send_pai;
    /*! Do we send Remote-Party-ID headers to this endpoint? */
    unsigned int send_rpid;
    /*! Do we send messages for connected line updates for unanswered incoming calls immediately to this endpoint? */
    unsigned int rpid_immediate;
    /*! Do we add Diversion headers to applicable outgoing requests/responses? */
    unsigned int send_diversion;
    /*! Do we accept connected line updates from this endpoint? */
    unsigned int trust_connected_line;
    /*! Do we send connected line updates to this endpoint? */
    unsigned int send_connected_line;
    /*! When performing connected line update, which method should be used */
    enum ast_sip_session_refresh_method refresh_method;
    /*! Do we add History-Info headers to applicable outgoing requests/responses? */
    unsigned int send_history_info;
};
 
/*!
 * \brief Call pickup configuration options for endpoints
 */
struct ast_sip_endpoint_pickup_configuration {
    /*! Call group */
    ast_group_t callgroup;
    /*! Pickup group */
    ast_group_t pickupgroup;
    /*! Named call group */
    struct ast_namedgroups *named_callgroups;
    /*! Named pickup group */
    struct ast_namedgroups *named_pickupgroups;
};
 
/*!
 * \brief Configuration for one-touch INFO recording
 */
struct ast_sip_info_recording_configuration {
    AST_DECLARE_STRING_FIELDS(
        /*! Feature to enact when one-touch recording INFO with Record: On is received */
        AST_STRING_FIELD(onfeature);
        /*! Feature to enact when one-touch recording INFO with Record: Off is received */
        AST_STRING_FIELD(offfeature);
    );
    /*! Is one-touch recording permitted? */
    unsigned int enabled;
};
 
/*!
 * \brief Endpoint configuration options for INFO packages
 */
struct ast_sip_endpoint_info_configuration {
    /*! Configuration for one-touch recording */
    struct ast_sip_info_recording_configuration recording;
};
 
/*!
 * \brief RTP configuration for SIP endpoints
 */
struct ast_sip_media_rtp_configuration {
    AST_DECLARE_STRING_FIELDS(
        /*! Configured RTP engine for this endpoint. */
        AST_STRING_FIELD(engine);
    );
    /*! Whether IPv6 RTP is enabled or not */
    unsigned int ipv6;
    /*! Whether symmetric RTP is enabled or not */
    unsigned int symmetric;
    /*! Whether ICE support is enabled or not */
    unsigned int ice_support;
    /*! Whether to use the "ptime" attribute received from the endpoint or not */
    unsigned int use_ptime;
    /*! Do we use AVPF exclusively for this endpoint? */
    unsigned int use_avpf;
    /*! Do we force AVP, AVPF, SAVP, or SAVPF even for DTLS media streams? */
    unsigned int force_avp;
    /*! Do we use the received media transport in our answer SDP */
    unsigned int use_received_transport;
    /*! \brief DTLS-SRTP configuration information */
    struct ast_rtp_dtls_cfg dtls_cfg;
    /*! Should SRTP use a 32 byte tag instead of an 80 byte tag? */
    unsigned int srtp_tag_32;
    /*! Do we use media encryption? what type? */
    enum ast_sip_session_media_encryption encryption;
    /*! Do we want to optimistically support encryption if possible? */
    unsigned int encryption_optimistic;
    /*! Number of seconds between RTP keepalive packets */
    unsigned int keepalive;
    /*! Number of seconds before terminating channel due to lack of RTP (when not on hold) */
    unsigned int timeout;
    /*! Number of seconds before terminating channel due to lack of RTP (when on hold) */
    unsigned int timeout_hold;
    /*! Follow forked media with a different To tag */
    unsigned int follow_early_media_fork;
    /*! Accept updated SDPs on non-100rel 18X and 2XX responses with the same To tag */
    unsigned int accept_multiple_sdp_answers;
};
 
/*!
 * \brief Direct media options for SIP endpoints
 */
struct ast_sip_direct_media_configuration {
    /*! Boolean indicating if direct_media is permissible */
    unsigned int enabled;
    /*! When using direct media, which method should be used */
    enum ast_sip_session_refresh_method method;
    /*! Take steps to mitigate glare for direct media */
    enum ast_sip_direct_media_glare_mitigation glare_mitigation;
    /*! Do not attempt direct media session refreshes if a media NAT is detected */
    unsigned int disable_on_nat;
};
 
struct ast_sip_t38_configuration {
    /*! Whether T.38 UDPTL support is enabled or not */
    unsigned int enabled;
    /*! Error correction setting for T.38 UDPTL */
    enum ast_t38_ec_modes error_correction;
    /*! Explicit T.38 max datagram value, may be 0 to indicate the remote side can be trusted */
    unsigned int maxdatagram;
    /*! Whether NAT Support is enabled for T.38 UDPTL sessions or not */
    unsigned int nat;
    /*! Whether to use IPv6 for UDPTL or not */
    unsigned int ipv6;
    /*! Bind the UDPTL instance to the media_address */
    unsigned int bind_udptl_to_media_address;
};
 
/*!
 * \brief Media configuration for SIP endpoints
 */
struct ast_sip_endpoint_media_configuration {
    AST_DECLARE_STRING_FIELDS(
        /*! Optional media address to use in SDP */
        AST_STRING_FIELD(address);
        /*! SDP origin username */
        AST_STRING_FIELD(sdpowner);
        /*! SDP session name */
        AST_STRING_FIELD(sdpsession);
    );
    /*! RTP media configuration */
    struct ast_sip_media_rtp_configuration rtp;
    /*! Direct media options */
    struct ast_sip_direct_media_configuration direct_media;
    /*! T.38 (FoIP) options */
    struct ast_sip_t38_configuration t38;
    /*! Configured codecs */
    struct ast_format_cap *codecs;
    /*! Capabilities in topology form */
    struct ast_stream_topology *topology;
    /*! DSCP TOS bits for audio streams */
    unsigned int tos_audio;
    /*! Priority for audio streams */
    unsigned int cos_audio;
    /*! DSCP TOS bits for video streams */
    unsigned int tos_video;
    /*! Priority for video streams */
    unsigned int cos_video;
    /*! Is g.726 packed in a non standard way */
    unsigned int g726_non_standard;
    /*! Bind the RTP instance to the media_address */
    unsigned int bind_rtp_to_media_address;
    /*! Use RTCP-MUX */
    unsigned int rtcp_mux;
    /*! Maximum number of audio streams to offer/accept */
    unsigned int max_audio_streams;
    /*! Maximum number of video streams to offer/accept */
    unsigned int max_video_streams;
    /*! Use BUNDLE */
    unsigned int bundle;
    /*! Enable webrtc settings and defaults */
    unsigned int webrtc;
    /*! Codec preference for an incoming offer */
    struct ast_flags incoming_call_offer_pref;
    /*! Codec preference for an outgoing offer */
    struct ast_flags outgoing_call_offer_pref;
    /*! Codec negotiation prefs for incoming offers */
    struct ast_stream_codec_negotiation_prefs codec_prefs_incoming_offer;
    /*! Codec negotiation prefs for outgoing offers */
    struct ast_stream_codec_negotiation_prefs codec_prefs_outgoing_offer;
    /*! Codec negotiation prefs for incoming answers */
    struct ast_stream_codec_negotiation_prefs codec_prefs_incoming_answer;
    /*! Codec negotiation prefs for outgoing answers */
    struct ast_stream_codec_negotiation_prefs codec_prefs_outgoing_answer;
};
 
/*!
 * \brief An entity with which Asterisk communicates
 */
struct ast_sip_endpoint {
    SORCERY_OBJECT(details);
    AST_DECLARE_STRING_FIELDS(
        /*! Context to send incoming calls to */
        AST_STRING_FIELD(context);
        /*! Name of an explicit transport to use */
        AST_STRING_FIELD(transport);
        /*! Outbound proxy to use */
        AST_STRING_FIELD(outbound_proxy);
        /*! Explicit AORs to dial if none are specified */
        AST_STRING_FIELD(aors);
        /*! Musiconhold class to suggest that the other side use when placing on hold */
        AST_STRING_FIELD(mohsuggest);
        /*! Configured tone zone for this endpoint. */
        AST_STRING_FIELD(zone);
        /*! Configured language for this endpoint. */
        AST_STRING_FIELD(language);
        /*! Default username to place in From header */
        AST_STRING_FIELD(fromuser);
        /*! Domain to place in From header */
        AST_STRING_FIELD(fromdomain);
        /*! Context to route incoming MESSAGE requests to */
        AST_STRING_FIELD(message_context);
        /*! Accountcode to auto-set on channels */
        AST_STRING_FIELD(accountcode);
        /*! If set, we'll push incoming MWI NOTIFYs to stasis using this mailbox */
        AST_STRING_FIELD(incoming_mwi_mailbox);
        /*! STIR/SHAKEN profile to use */
        AST_STRING_FIELD(stir_shaken_profile);
    );
    /*! Configuration for extensions */
    struct ast_sip_endpoint_extensions extensions;
    /*! Configuration relating to media */
    struct ast_sip_endpoint_media_configuration media;
    /*! SUBSCRIBE/NOTIFY configuration options */
    struct ast_sip_endpoint_subscription_configuration subscription;
    /*! NAT configuration */
    struct ast_sip_endpoint_nat_configuration nat;
    /*! Party identification options */
    struct ast_sip_endpoint_id_configuration id;
    /*! Configuration options for INFO packages */
    struct ast_sip_endpoint_info_configuration info;
    /*! Call pickup configuration */
    struct ast_sip_endpoint_pickup_configuration pickup;
    /*! Inbound authentication credentials */
    struct ast_sip_auth_vector inbound_auths;
    /*! Outbound authentication credentials */
    struct ast_sip_auth_vector outbound_auths;
    /*! DTMF mode to use with this endpoint */
    enum ast_sip_dtmf_mode dtmf;
    /*! Method(s) by which the endpoint should be identified. */
    enum ast_sip_endpoint_identifier_type ident_method;
    /*! Order of the method(s) by which the endpoint should be identified. */
    struct ast_sip_identify_by_vector ident_method_order;
    /*! Boolean indicating if ringing should be sent as inband progress */
    unsigned int inband_progress;
    /*! Pointer to the persistent Asterisk endpoint */
    struct ast_endpoint *persistent;
    /*! The number of channels at which busy device state is returned */
    unsigned int devicestate_busy_at;
    /*! Whether fax detection is enabled or not (CNG tone detection) */
    unsigned int faxdetect;
    /*! Determines if transfers (using REFER) are allowed by this endpoint */
    unsigned int allowtransfer;
    /*! Method used when handling redirects */
    enum ast_sip_session_redirect redirect_method;
    /*! Variables set on channel creation */
    struct ast_variable *channel_vars;
    /*! Whether to place a 'user=phone' parameter into the request URI if user is a number */
    unsigned int usereqphone;
    /*! Whether to pass through hold and unhold using re-invites with recvonly and sendrecv */
    unsigned int moh_passthrough;
    /*! Access control list */
    struct ast_acl_list *acl;
    /*! Restrict what IPs are allowed in the Contact header (for registration) */
    struct ast_acl_list *contact_acl;
    /*! The number of seconds into call to disable fax detection.  (0 = disabled) */
    unsigned int faxdetect_timeout;
    /*! Override the user on the outgoing Contact header with this value. */
    char *contact_user;
    /*! Whether to response SDP offer with single most preferred codec. */
    unsigned int preferred_codec_only;
    /*! Do we allow an asymmetric RTP codec? */
    unsigned int asymmetric_rtp_codec;
    /*! Do we allow overlap dialling? */
    unsigned int allow_overlap;
    /*! Whether to notifies all the progress details on blind transfer */
    unsigned int refer_blind_progress;
    /*! Whether to notifies dialog-info 'early' on INUSE && RINGING state */
    unsigned int notify_early_inuse_ringing;
    /*! Suppress Q.850 Reason headers on this endpoint */
    unsigned int suppress_q850_reason_headers;
    /*! Ignore 183 if no SDP is present */
    unsigned int ignore_183_without_sdp;
    /*! Type of security negotiation to use (RFC 3329). */
    enum ast_sip_security_negotiation security_negotiation;
    /*! Client security mechanisms (RFC 3329). */
    struct ast_sip_security_mechanism_vector security_mechanisms;
    /*! Set which STIR/SHAKEN behaviors we want on this endpoint */
    unsigned int stir_shaken;
    /*! Should we authenticate OPTIONS requests per RFC 3261? */
    unsigned int allow_unauthenticated_options;
    /*! The name of the geoloc profile to apply when Asterisk receives a call from this endpoint */
    AST_STRING_FIELD_EXTENDED(geoloc_incoming_call_profile);
    /*! The name of the geoloc profile to apply when Asterisk sends a call to this endpoint */
    AST_STRING_FIELD_EXTENDED(geoloc_outgoing_call_profile);
    /*! The context to use for overlap dialing, if different from the endpoint's context */
    AST_STRING_FIELD_EXTENDED(overlap_context);
    /*! 100rel mode to use with this endpoint */
    enum ast_sip_100rel_mode rel100;
    /*! Send Advice-of-Charge messages */
    unsigned int send_aoc;
    /*! Tenant ID for the endpoint */
    AST_STRING_FIELD_EXTENDED(tenantid);
    /*! Ignore remote hold requests */
    int suppress_moh_on_sendonly;
};
 
/*! URI parameter for symmetric transport */
#define AST_SIP_X_AST_TXP "x-ast-txp"
#define AST_SIP_X_AST_TXP_LEN 9
 
/*! Common media types used throughout res_pjsip and pjproject */
extern pjsip_media_type pjsip_media_type_application_json;
extern pjsip_media_type pjsip_media_type_application_media_control_xml;
extern pjsip_media_type pjsip_media_type_application_pidf_xml;
extern pjsip_media_type pjsip_media_type_application_xpidf_xml;
extern pjsip_media_type pjsip_media_type_application_cpim_xpidf_xml;
extern pjsip_media_type pjsip_media_type_application_rlmi_xml;
extern pjsip_media_type pjsip_media_type_application_simple_message_summary;
extern pjsip_media_type pjsip_media_type_application_sdp;
extern pjsip_media_type pjsip_media_type_multipart_alternative;
extern pjsip_media_type pjsip_media_type_multipart_mixed;
extern pjsip_media_type pjsip_media_type_multipart_related;
extern pjsip_media_type pjsip_media_type_text_plain;
 
/*!
 * \brief Compare pjsip media types
 *
 * \param a the first media type
 * \param b the second media type
 * \retval 1 Media types are equal
 * \retval 0 Media types are not equal
 */
int ast_sip_are_media_types_equal(pjsip_media_type *a, pjsip_media_type *b);
 
/*!
 * \brief Check if a media type is in a list of others
 *
 * \param a pjsip_media_type to search for
 * \param ... one or more pointers to pjsip_media_types the last of which must be "SENTINEL"
 * \retval 1 Media types are equal
 * \retval 0 Media types are not equal
 */
int ast_sip_is_media_type_in(pjsip_media_type *a, ...) attribute_sentinel;
 
/*!
 * \brief Add security headers to transmission data
 *
 * \param security_mechanisms Vector of security mechanisms.
 * \param header_name The header name under which to add the security mechanisms.
 * One of Security-Client, Security-Server, Security-Verify.
 * \param add_qval If zero, don't add the q-value to the header.
 * \param tdata The transmission data.
 * \retval 0 Success
 * \retval non-zero Failure
 */
int ast_sip_add_security_headers(struct ast_sip_security_mechanism_vector *security_mechanisms,
        const char *header_name, int add_qval, pjsip_tx_data *tdata);
 
/*!
 * \brief Append to security mechanism vector from SIP header
 *
 * \param hdr The header of the security mechanisms.
 * \param security_mechanisms Vector of security mechanisms to append to.
 * Header name must be one of Security-Client, Security-Server, Security-Verify.
 */
void ast_sip_header_to_security_mechanism(const pjsip_generic_string_hdr *hdr,
        struct ast_sip_security_mechanism_vector *security_mechanisms);
 
/*!
 * \brief Initialize security mechanism vector from string of security mechanisms.
 *
 * \param security_mechanism Pointer to vector of security mechanisms to initialize.
 * \param value String of security mechanisms as defined in RFC 3329.
 * \retval 0 Success
 * \retval non-zero Failure
 */
int ast_sip_security_mechanism_vector_init(struct ast_sip_security_mechanism_vector *security_mechanism, const char *value);
 
/*!
 * \brief Removes all headers of a specific name and value from a pjsip_msg.
 *
 * \param msg PJSIP message from which to remove headers.
 * \param hdr_name Name of the header to remove.
 * \param value Optional string value of the header to remove.
 * If NULL, remove all headers of given hdr_name.
 */
void ast_sip_remove_headers_by_name_and_value(pjsip_msg *msg, const pj_str_t *hdr_name, const char* value);
 
/*!
 * \brief Duplicate a security mechanism.
 *
 * \param dst Security mechanism to duplicate to.
 * \param src Security mechanism to duplicate.
 */
void ast_sip_security_mechanisms_vector_copy(struct ast_sip_security_mechanism_vector *dst,
    const struct ast_sip_security_mechanism_vector *src);
 
/*!
 * \brief Free contents of a security mechanism vector.
 *
 * \param security_mechanisms Vector whose contents are to be freed
 */
void ast_sip_security_mechanisms_vector_destroy(struct ast_sip_security_mechanism_vector *security_mechanisms);
 
/*!
 * \brief Allocate a security mechanism from a string.
 *
 * \param security_mechanism Pointer-pointer to the security mechanism to allocate.
 * \param value The security mechanism string as defined in RFC 3329 (section 2.2)
 *              in the form <mechanism_name>;q=<q_value>;<mechanism_parameters>
 * \retval 0 Success
 * \retval non-zero Failure
 */
int ast_sip_str_to_security_mechanism(struct ast_sip_security_mechanism **security_mechanism, const char *value);
 
/*!
 * \brief Writes the security mechanisms of an endpoint into a buffer as a string and returns the buffer.
 *
 * \note The buffer must be freed by the caller.
 *
 * \param endpoint Pointer to endpoint.
 * \param add_qvalue If non-zero, the q-value is printed as well
 * \param buf The buffer to write the string into
 * \retval 0 Success
 * \retval non-zero Failure
 */
int ast_sip_security_mechanisms_to_str(const struct ast_sip_security_mechanism_vector *security_mechanisms, int add_qvalue, char **buf);
 
/*!
 * \brief Set the security negotiation based on a given string.
 *
 * \param security_negotiation Security negotiation enum to set.
 * \param val String that represents a security_negotiation value.
 * \retval 0 Success
 * \retval non-zero Failure
 */
int ast_sip_set_security_negotiation(enum ast_sip_security_negotiation *security_negotiation, const char *val);
 
/*!
 * \brief Initialize an auth vector with the configured values.
 *
 * \param vector Vector to initialize
 * \param auth_names Comma-separated list of names to set in the array
 * \retval 0 Success
 * \retval non-zero Failure
 */
int ast_sip_auth_vector_init(struct ast_sip_auth_vector *vector, const char *auth_names);
 
/*!
 * \brief Free contents of an auth vector.
 *
 * \param vector Vector whose contents are to be freed
 */
void ast_sip_auth_vector_destroy(struct ast_sip_auth_vector *vector);
 
/*!
 * \brief Possible returns from ast_sip_check_authentication
 */
enum ast_sip_check_auth_result {
    /*! Authentication needs to be challenged */
    AST_SIP_AUTHENTICATION_CHALLENGE,
    /*! Authentication succeeded */
    AST_SIP_AUTHENTICATION_SUCCESS,
    /*! Authentication failed */
    AST_SIP_AUTHENTICATION_FAILED,
    /*! Authentication encountered some internal error */
    AST_SIP_AUTHENTICATION_ERROR,
};
 
/*!
 * \brief Populate a vector of algorithm types from a string.
 *
 * \param id           The object id to use in error messages
 * \param algorithms   The initialized but empty vector to populate
 * \param agent_type   The type of agent to use in error messages ("UAC" or "UAS")
 * \param value        The comma-separated string to parse for algorithms
 *
 * \retval 0 Success
 * \retval non-zero Failure
 */
int ast_sip_auth_digest_algorithms_vector_init(const char *id,
    struct pjsip_auth_algorithm_type_vector *algorithms, const char *agent_type, const char *value);
 
/*!
 * \brief Dump a vector of algorithm types to a string.
 *
 * \param algorithms The vector to dump
 * \param[out] buf   Pointer to the buffer to dump the algorithms to
 *                   Must be freed by the caller.
 *
 * \retval 0 Success
 * \retval non-zero Failure
 */
int ast_sip_auth_digest_algorithms_vector_to_str(
    const struct pjsip_auth_algorithm_type_vector *algorithms, char **buf);
 
/*!
 * \brief An interchangeable way of handling digest authentication for SIP.
 *
 * An authenticator is responsible for filling in the callbacks provided below. Each is called from a publicly available
 * function in res_sip. The authenticator can use configuration or other local policy to determine whether authentication
 * should take place and what credentials should be used when challenging and authenticating a request.
 */
struct ast_sip_authenticator {
    /*!
     * \brief Check if a request requires authentication
     * See ast_sip_requires_authentication for more details
     */
    int (*requires_authentication)(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata);
    /*!
     * \brief Check that an incoming request passes authentication.
     *
     * The tdata parameter is useful for adding information such as digest challenges.
     *
     * \param endpoint The endpoint sending the incoming request
     * \param rdata The incoming request
     * \param tdata Tentative outgoing request.
     */
    enum ast_sip_check_auth_result (*check_authentication)(struct ast_sip_endpoint *endpoint,
            pjsip_rx_data *rdata, pjsip_tx_data *tdata);
};
 
/*!
 * \brief an interchangeable way of responding to authentication challenges
 *
 * An outbound authenticator takes incoming challenges and formulates a new SIP request with
 * credentials.
 */
struct ast_sip_outbound_authenticator {
    /*!
     * \brief Create a new request with authentication credentials
     *
     * \param auths A vector of IDs of auth sorcery objects
     * \param challenge The SIP response with authentication challenge(s)
     * \param old_request The request that received the auth challenge(s)
     * \param new_request The new SIP request with challenge response(s)
     * \retval 0 Successfully created new request
     * \retval -1 Failed to create a new request
     */
    int (*create_request_with_auth)(const struct ast_sip_auth_vector *auths, struct pjsip_rx_data *challenge,
            struct pjsip_tx_data *old_request, struct pjsip_tx_data **new_request);
};
 
/*!
 * \brief An entity responsible for identifying the source of a SIP message
 */
struct ast_sip_endpoint_identifier {
    /*!
     * \brief Callback used to identify the source of a message.
     * See ast_sip_identify_endpoint for more details
     */
    struct ast_sip_endpoint *(*identify_endpoint)(pjsip_rx_data *rdata);
};
 
/*!
 * \brief Contact retrieval filtering flags
 */
enum ast_sip_contact_filter {
    /*! \brief Default filter flags */
    AST_SIP_CONTACT_FILTER_DEFAULT = 0,
 
    /*! \brief Return only reachable or unknown contacts */
    AST_SIP_CONTACT_FILTER_REACHABLE = (1 << 0),
};
 
/*!
 * \brief Adds a Date header to the tdata, formatted like:
 * Date: Wed, 01 Jan 2021 14:53:01 GMT
 * \since 16.19.0
 *
 * \note There is no checking done to see if the header already exists
 * before adding it. It's up to the caller of this function to determine
 * if that needs to be done or not.
 */
void ast_sip_add_date_header(pjsip_tx_data *tdata);
 
/*!
 * \brief Register a SIP service in Asterisk.
 *
 * This is more-or-less a wrapper around pjsip_endpt_register_module().
 * Registering a service makes it so that PJSIP will call into the
 * service at appropriate times. For more information about PJSIP module
 * callbacks, see the PJSIP documentation. Asterisk modules that call
 * this function will likely do so at module load time.
 *
 * \param module The module that is to be registered with PJSIP
 * \retval 0 Success
 * \retval -1 Failure
 */
int ast_sip_register_service(pjsip_module *module);
 
/*!
 * This is the opposite of ast_sip_register_service().  Unregistering a
 * service means that PJSIP will no longer call into the module any more.
 * This will likely occur when an Asterisk module is unloaded.
 *
 * \param module The PJSIP module to unregister
 */
void ast_sip_unregister_service(pjsip_module *module);
 
/*!
 * \brief Register a SIP authenticator
 *
 * An authenticator has three main purposes:
 * 1) Determining if authentication should be performed on an incoming request
 * 2) Gathering credentials necessary for issuing an authentication challenge
 * 3) Authenticating a request that has credentials
 *
 * Asterisk provides a default authenticator, but it may be replaced by a
 * custom one if desired.
 *
 * \param auth The authenticator to register
 * \retval 0 Success
 * \retval -1 Failure
 */
int ast_sip_register_authenticator(struct ast_sip_authenticator *auth);
 
/*!
 * \brief Unregister a SIP authenticator
 *
 * When there is no authenticator registered, requests cannot be challenged
 * or authenticated.
 *
 * \param auth The authenticator to unregister
 */
void ast_sip_unregister_authenticator(struct ast_sip_authenticator *auth);
 
 /*!
 * \brief Register an outbound SIP authenticator
 *
 * An outbound authenticator is responsible for creating responses to
 * authentication challenges by remote endpoints.
 *
 * \param outbound_auth The authenticator to register
 * \retval 0 Success
 * \retval -1 Failure
 */
int ast_sip_register_outbound_authenticator(struct ast_sip_outbound_authenticator *outbound_auth);
 
/*!
 * \brief Unregister an outbound SIP authenticator
 *
 * When there is no outbound authenticator registered, authentication challenges
 * will be handled as any other final response would be.
 *
 * \param auth The authenticator to unregister
 */
void ast_sip_unregister_outbound_authenticator(struct ast_sip_outbound_authenticator *auth);
 
/*!
 * \brief Register a SIP endpoint identifier with a name.
 *
 * An endpoint identifier's purpose is to determine which endpoint a given SIP
 * message has come from.
 *
 * Multiple endpoint identifiers may be registered so that if an endpoint
 * cannot be identified by one identifier, it may be identified by another.
 *
 * \param identifier The SIP endpoint identifier to register
 * \param name The name of the endpoint identifier
 * \retval 0 Success
 * \retval -1 Failure
 */
int ast_sip_register_endpoint_identifier_with_name(struct ast_sip_endpoint_identifier *identifier,
                           const char *name);
 
/*!
 * \brief Register a SIP endpoint identifier
 *
 * An endpoint identifier's purpose is to determine which endpoint a given SIP
 * message has come from.
 *
 * Multiple endpoint identifiers may be registered so that if an endpoint
 * cannot be identified by one identifier, it may be identified by another.
 *
 * Asterisk provides two endpoint identifiers. One identifies endpoints based
 * on the user part of the From header URI. The other identifies endpoints based
 * on the source IP address.
 *
 * If the order in which endpoint identifiers is run is important to you, then
 * be sure to load individual endpoint identifier modules in the order you wish
 * for them to be run in modules.conf
 *
 * \note endpoint identifiers registered using this method (no name specified)
 *       are placed at the front of the endpoint identifiers list ahead of any
 *       named identifiers.
 *
 * \param identifier The SIP endpoint identifier to register
 * \retval 0 Success
 * \retval -1 Failure
 */
int ast_sip_register_endpoint_identifier(struct ast_sip_endpoint_identifier *identifier);
 
/*!
 * \brief Unregister a SIP endpoint identifier
 *
 * This stops an endpoint identifier from being used.
 *
 * \param identifier The SIP endoint identifier to unregister
 */
void ast_sip_unregister_endpoint_identifier(struct ast_sip_endpoint_identifier *identifier);
 
/*!
 * \brief Allocate a new SIP endpoint
 *
 * This will return an endpoint with its refcount increased by one. This reference
 * can be released using ao2_ref().
 *
 * \param name The name of the endpoint.
 * \retval NULL Endpoint allocation failed
 * \retval non-NULL The newly allocated endpoint
 */
void *ast_sip_endpoint_alloc(const char *name);
 
/*!
 * \brief Change state of a persistent endpoint.
 *
 * \param endpoint_name The SIP endpoint name to change state.
 * \param state The new state
 * \retval 0 Success
 * \retval -1 Endpoint not found
 */
int ast_sip_persistent_endpoint_update_state(const char *endpoint_name, enum ast_endpoint_state state);
 
/*!
 * \brief Publish the change of state for a contact.
 *
 * \param endpoint_name The SIP endpoint name.
 * \param contact_status The contact status.
 */
void ast_sip_persistent_endpoint_publish_contact_state(const char *endpoint_name, const struct ast_sip_contact_status *contact_status);
 
/*!
 * \brief Retrieve the current status for a contact.
 *
 * \param contact The contact.
 *
 * \retval non-NULL Success
 * \retval NULL Status information not found
 *
 * \note The returned contact status object is immutable.
 */
struct ast_sip_contact_status *ast_sip_get_contact_status(const struct ast_sip_contact *contact);
 
/*!
 * \brief Get a pointer to the PJSIP endpoint.
 *
 * This is useful when modules have specific information they need
 * to register with the PJSIP core.
 * \retval NULL endpoint has not been created yet.
 * \retval non-NULL PJSIP endpoint.
 */
pjsip_endpoint *ast_sip_get_pjsip_endpoint(void);
 
/*!
 * \brief Get a pointer to the SIP sorcery structure.
 *
 * \retval NULL sorcery has not been initialized
 * \retval non-NULL sorcery structure
 */
struct ast_sorcery *ast_sip_get_sorcery(void);
 
/*!
 * \brief Retrieve a named AOR
 *
 * \param aor_name Name of the AOR
 *
 * \retval NULL if not found
 * \retval non-NULL if found
 */
struct ast_sip_aor *ast_sip_location_retrieve_aor(const char *aor_name);
 
/*!
 * \brief Retrieve the first bound contact for an AOR
 *
 * \param aor Pointer to the AOR
 * \retval NULL if no contacts available
 * \retval non-NULL if contacts available
 */
struct ast_sip_contact *ast_sip_location_retrieve_first_aor_contact(const struct ast_sip_aor *aor);
 
/*!
 * \brief Retrieve the first bound contact for an AOR and filter based on flags
 * \since 13.16.0
 *
 * \param aor Pointer to the AOR
 * \param flags Filtering flags
 * \retval NULL if no contacts available
 * \retval non-NULL if contacts available
 */
struct ast_sip_contact *ast_sip_location_retrieve_first_aor_contact_filtered(const struct ast_sip_aor *aor,
    unsigned int flags);
 
/*!
 * \brief Retrieve all contacts currently available for an AOR
 *
 * \param aor Pointer to the AOR
 *
 * \retval NULL if no contacts available
 * \retval non-NULL if contacts available
 *
 * \warning
 * Since this function prunes expired contacts before returning, it holds a named write
 * lock on the aor.  If you already hold the lock, call ast_sip_location_retrieve_aor_contacts_nolock instead.
 */
struct ao2_container *ast_sip_location_retrieve_aor_contacts(const struct ast_sip_aor *aor);
 
/*!
 * \brief Retrieve all contacts currently available for an AOR and filter based on flags
 * \since 13.16.0
 *
 * \param aor Pointer to the AOR
 * \param flags Filtering flags
 *
 * \retval NULL if no contacts available
 * \retval non-NULL if contacts available
 *
 * \warning
 * Since this function prunes expired contacts before returning, it holds a named write
 * lock on the aor.  If you already hold the lock, call ast_sip_location_retrieve_aor_contacts_nolock instead.
 */
struct ao2_container *ast_sip_location_retrieve_aor_contacts_filtered(const struct ast_sip_aor *aor,
    unsigned int flags);
 
/*!
 * \brief Retrieve all contacts currently available for an AOR without locking the AOR
 * \since 13.9.0
 *
 * \param aor Pointer to the AOR
 *
 * \retval NULL if no contacts available
 * \retval non-NULL if contacts available
 *
 * \warning
 * This function should only be called if you already hold a named write lock on the aor.
 */
struct ao2_container *ast_sip_location_retrieve_aor_contacts_nolock(const struct ast_sip_aor *aor);
 
/*!
 * \brief Retrieve all contacts currently available for an AOR without locking the AOR and filter based on flags
 * \since 13.16.0
 *
 * \param aor Pointer to the AOR
 * \param flags Filtering flags
 *
 * \retval NULL if no contacts available
 * \retval non-NULL if contacts available
 *
 * \warning
 * This function should only be called if you already hold a named write lock on the aor.
 */
struct ao2_container *ast_sip_location_retrieve_aor_contacts_nolock_filtered(const struct ast_sip_aor *aor,
    unsigned int flags);
 
/*!
 * \brief Retrieve the first bound contact from a list of AORs
 *
 * \param aor_list A comma-separated list of AOR names
 * \retval NULL if no contacts available
 * \retval non-NULL if contacts available
 */
struct ast_sip_contact *ast_sip_location_retrieve_contact_from_aor_list(const char *aor_list);
 
/*!
 * \brief Retrieve all contacts from a list of AORs
 *
 * \param aor_list A comma-separated list of AOR names
 * \retval NULL if no contacts available
 * \retval non-NULL container (which must be freed) if contacts available
 */
struct ao2_container *ast_sip_location_retrieve_contacts_from_aor_list(const char *aor_list);
 
/*!
 * \brief Retrieve the first bound contact AND the AOR chosen from a list of AORs
 *
 * \param aor_list A comma-separated list of AOR names
 * \param aor The chosen AOR
 * \param contact The chosen contact
 */
 void ast_sip_location_retrieve_contact_and_aor_from_list(const char *aor_list, struct ast_sip_aor **aor,
    struct ast_sip_contact **contact);
 
/*!
 * \brief Retrieve the first bound contact AND the AOR chosen from a list of AORs and filter based on flags
 * \since 13.16.0
 *
 * \param aor_list A comma-separated list of AOR names
 * \param flags Filtering flags
 * \param aor The chosen AOR
 * \param contact The chosen contact
 */
void ast_sip_location_retrieve_contact_and_aor_from_list_filtered(const char *aor_list, unsigned int flags,
    struct ast_sip_aor **aor, struct ast_sip_contact **contact);
 
/*!
 * \brief Retrieve a named contact
 *
 * \param contact_name Name of the contact
 *
 * \retval NULL if not found
 * \retval non-NULL if found
 */
struct ast_sip_contact *ast_sip_location_retrieve_contact(const char *contact_name);
 
/*!
 * \brief Add a new contact to an AOR
 *
 * \param aor Pointer to the AOR
 * \param uri Full contact URI
 * \param expiration_time Optional expiration time of the contact
 * \param path_info Path information
 * \param user_agent User-Agent header from REGISTER request
 * \param via_addr
 * \param via_port
 * \param call_id
 * \param endpoint The endpoint that resulted in the contact being added
 *
 * \retval -1 failure
 * \retval 0 success
 *
 * \warning
 * This function holds a named write lock on the aor.  If you already hold the lock
 * you should call ast_sip_location_add_contact_nolock instead.
 */
int ast_sip_location_add_contact(struct ast_sip_aor *aor, const char *uri,
    struct timeval expiration_time, const char *path_info, const char *user_agent,
    const char *via_addr, int via_port, const char *call_id,
    struct ast_sip_endpoint *endpoint);
 
/*!
 * \brief Add a new contact to an AOR without locking the AOR
 * \since 13.9.0
 *
 * \param aor Pointer to the AOR
 * \param uri Full contact URI
 * \param expiration_time Optional expiration time of the contact
 * \param path_info Path information
 * \param user_agent User-Agent header from REGISTER request
 * \param via_addr
 * \param via_port
 * \param call_id
 * \param endpoint The endpoint that resulted in the contact being added
 *
 * \retval -1 failure
 * \retval 0 success
 *
 * \warning
 * This function should only be called if you already hold a named write lock on the aor.
 */
int ast_sip_location_add_contact_nolock(struct ast_sip_aor *aor, const char *uri,
    struct timeval expiration_time, const char *path_info, const char *user_agent,
    const char *via_addr, int via_port, const char *call_id,
    struct ast_sip_endpoint *endpoint);
 
/*!
 * \brief Create a new contact for an AOR without locking the AOR
 * \since 13.18.0
 *
 * \param aor Pointer to the AOR
 * \param uri Full contact URI
 * \param expiration_time Optional expiration time of the contact
 * \param path_info Path information
 * \param user_agent User-Agent header from REGISTER request
 * \param via_addr
 * \param via_port
 * \param call_id
 * \param prune_on_boot Non-zero if the contact cannot survive a restart/boot.
 * \param endpoint The endpoint that resulted in the contact being added
 *
 * \return The created contact or NULL on failure.
 *
 * \warning
 * This function should only be called if you already hold a named write lock on the aor.
 */
struct ast_sip_contact *ast_sip_location_create_contact(struct ast_sip_aor *aor,
    const char *uri, struct timeval expiration_time, const char *path_info,
    const char *user_agent, const char *via_addr, int via_port, const char *call_id,
    int prune_on_boot, struct ast_sip_endpoint *endpoint);
 
/*!
 * \brief Update a contact
 *
 * \param contact New contact object with details
 *
 * \retval -1 failure
 * \retval 0 success
 */
int ast_sip_location_update_contact(struct ast_sip_contact *contact);
 
/*!
* \brief Delete a contact
*
* \param contact Contact object to delete
*
* \retval -1 failure
* \retval 0 success
*/
int ast_sip_location_delete_contact(struct ast_sip_contact *contact);
 
/*!
 * \brief Prune the prune_on_boot contacts
 * \since 13.18.0
 */
void ast_sip_location_prune_boot_contacts(void);
 
/*!
 * \brief Callback called when an outbound request with authentication credentials is to be sent in dialog
 *
 * This callback will have the created request on it. The callback's purpose is to do any extra
 * housekeeping that needs to be done as well as to send the request out.
 *
 * This callback is only necessary if working with a PJSIP API that sits between the application
 * and the dialog layer.
 *
 * \param dlg The dialog to which the request belongs
 * \param tdata The created request to be sent out
 * \param user_data Data supplied with the callback
 *
 * \retval 0 Success
 * \retval -1 Failure
 */
typedef int (*ast_sip_dialog_outbound_auth_cb)(pjsip_dialog *dlg, pjsip_tx_data *tdata, void *user_data);
 
/*!
 * \brief Set up outbound authentication on a SIP dialog
 *
 * This sets up the infrastructure so that all requests associated with a created dialog
 * can be re-sent with authentication credentials if the original request is challenged.
 *
 * \param dlg The dialog on which requests will be authenticated
 * \param endpoint The endpoint whom this dialog pertains to
 * \param cb Callback to call to send requests with authentication
 * \param user_data Data to be provided to the callback when it is called
 *
 * \retval 0 Success
 * \retval -1 Failure
 */
int ast_sip_dialog_setup_outbound_authentication(pjsip_dialog *dlg, const struct ast_sip_endpoint *endpoint,
        ast_sip_dialog_outbound_auth_cb cb, void *user_data);
 
/*!
 * \brief Retrieves a reference to the artificial auth.
 *
 * \retval The artificial auth
 */
struct ast_sip_auth *ast_sip_get_artificial_auth(void);
 
/*!
 * \brief Retrieves a reference to the artificial endpoint.
 *
 * \retval The artificial endpoint
 */
struct ast_sip_endpoint *ast_sip_get_artificial_endpoint(void);
 
/*! \defgroup pjsip_threading PJSIP Threading Model
 * @{
 * \page PJSIP PJSIP Threading Model
 *
 * There are three major types of threads that SIP will have to deal with:
 * \li Asterisk threads
 * \li PJSIP threads
 * \li SIP threadpool threads (a.k.a. "servants")
 *
 * \par Asterisk Threads
 *
 * Asterisk threads are those that originate from outside of SIP but within
 * Asterisk. The most common of these threads are PBX (channel) threads and
 * the autoservice thread. Most interaction with these threads will be through
 * channel technology callbacks. Within these threads, it is fine to handle
 * Asterisk data from outside of SIP, but any handling of SIP data should be
 * left to servants, \b especially if you wish to call into PJSIP for anything.
 * Asterisk threads are not registered with PJLIB, so attempting to call into
 * PJSIP will cause an assertion to be triggered, thus causing the program to
 * crash.
 *
 * \par PJSIP Threads
 *
 * PJSIP threads are those that originate from handling of PJSIP events, such
 * as an incoming SIP request or response, or a transaction timeout. The role
 * of these threads is to process information as quickly as possible so that
 * the next item on the SIP socket(s) can be serviced. On incoming messages,
 * Asterisk automatically will push the request to a servant thread. When your
 * module callback is called, processing will already be in a servant. However,
 * for other PJSIP events, such as transaction state changes due to timer
 * expirations, your module will be called into from a PJSIP thread. If you
 * are called into from a PJSIP thread, then you should push whatever processing
 * is needed to a servant as soon as possible. You can discern if you are currently
 * in a SIP servant thread using the \ref ast_sip_thread_is_servant function.
 *
 * \par Servants
 *
 * Servants are where the bulk of SIP work should be performed. These threads
 * exist in order to do the work that Asterisk threads and PJSIP threads hand
 * off to them. Servant threads register themselves with PJLIB, meaning that
 * they are capable of calling PJSIP and PJLIB functions if they wish.
 *
 * \par Serializer
 *
 * Tasks are handed off to servant threads using the API call \ref ast_sip_push_task.
 * The first parameter of this call is a serializer. If this pointer
 * is NULL, then the work will be handed off to whatever servant can currently handle
 * the task. If this pointer is non-NULL, then the task will not be executed until
 * previous tasks pushed with the same serializer have completed. For more information
 * on serializers and the benefits they provide, see \ref ast_threadpool_serializer
 *
 * \par Scheduler
 *
 * Some situations require that a task run periodically or at a future time.  Normally
 * the ast_sched functionality would be used but ast_sched only uses 1 thread for all
 * tasks and that thread isn't registered with PJLIB and therefore can't do any PJSIP
 * related work.
 *
 * ast_sip_sched uses ast_sched only as a scheduled queue.  When a task is ready to run,
 * it's pushed to a Serializer to be invoked asynchronously by a Servant.  This ensures
 * that the task is executed in a PJLIB registered thread and allows the ast_sched thread
 * to immediately continue processing the queue.  The Serializer used by ast_sip_sched
 * is one of your choosing or a random one from the res_pjsip pool if you don't choose one.
 *
 * \note
 *
 * Do not make assumptions about individual threads based on a corresponding serializer.
 * In other words, just because several tasks use the same serializer when being pushed
 * to servants, it does not mean that the same thread is necessarily going to execute those
 * tasks, even though they are all guaranteed to be executed in sequence.
 */
 
typedef int (*ast_sip_task)(void *user_data);
 
/*!
 * \brief Create a new serializer for SIP tasks
 * \since 13.8.0
 *
 * See \ref ast_threadpool_serializer for more information on serializers.
 * SIP creates serializers so that tasks operating on similar data will run
 * in sequence.
 *
 * \param name Name of the serializer. (must be unique)
 *
 * \retval NULL Failure
 * \retval non-NULL Newly-created serializer
 */
struct ast_taskprocessor *ast_sip_create_serializer(const char *name);
 
struct ast_serializer_shutdown_group;
 
/*!
 * \brief Create a new serializer for SIP tasks
 * \since 13.8.0
 *
 * See \ref ast_threadpool_serializer for more information on serializers.
 * SIP creates serializers so that tasks operating on similar data will run
 * in sequence.
 *
 * \param name Name of the serializer. (must be unique)
 * \param shutdown_group Group shutdown controller. (NULL if no group association)
 *
 * \retval NULL Failure
 * \retval non-NULL Newly-created serializer
 */
struct ast_taskprocessor *ast_sip_create_serializer_group(const char *name, struct ast_serializer_shutdown_group *shutdown_group);
 
/*!
 * \brief Determine the distributor serializer for the SIP message.
 * \since 13.10.0
 *
 * \param rdata The incoming message.
 *
 * \retval Calculated distributor serializer on success.
 * \retval NULL on error.
 */
struct ast_taskprocessor *ast_sip_get_distributor_serializer(pjsip_rx_data *rdata);
 
/*!
 * \brief Set a serializer on a SIP dialog so requests and responses are automatically serialized
 *
 * Passing a NULL serializer is a way to remove a serializer from a dialog.
 *
 * \param dlg The SIP dialog itself
 * \param serializer The serializer to use
 */
void ast_sip_dialog_set_serializer(pjsip_dialog *dlg, struct ast_taskprocessor *serializer);
 
/*!
 * \brief Set an endpoint on a SIP dialog so in-dialog requests do not undergo endpoint lookup.
 *
 * \param dlg The SIP dialog itself
 * \param endpoint The endpoint that this dialog is communicating with
 */
void ast_sip_dialog_set_endpoint(pjsip_dialog *dlg, struct ast_sip_endpoint *endpoint);
 
/*!
 * \brief Get the endpoint associated with this dialog
 *
 * This function increases the refcount of the endpoint by one. Release
 * the reference once you are finished with the endpoint.
 *
 * \param dlg The SIP dialog from which to retrieve the endpoint
 * \retval NULL No endpoint associated with this dialog
 * \retval non-NULL The endpoint.
 */
struct ast_sip_endpoint *ast_sip_dialog_get_endpoint(pjsip_dialog *dlg);
 
/*!
 * \brief Pushes a task to SIP servants
 *
 * This uses the serializer provided to determine how to push the task.
 * If the serializer is NULL, then the task will be pushed to the
 * servants directly. If the serializer is non-NULL, then the task will be
 * queued behind other tasks associated with the same serializer.
 *
 * \param serializer The serializer to which the task belongs. Can be NULL
 * \param sip_task The task to execute
 * \param task_data The parameter to pass to the task when it executes
 * \retval 0 Success
 * \retval -1 Failure
 */
int ast_sip_push_task(struct ast_taskprocessor *serializer, int (*sip_task)(void *), void *task_data);
 
/*!
 * \brief Push a task to SIP servants and wait for it to complete.
 *
 * Like \ref ast_sip_push_task except that it blocks until the task
 * completes.  If the current thread is a SIP servant thread then the
 * task executes immediately.  Otherwise, the specified serializer
 * executes the task and the current thread waits for it to complete.
 *
 * \note PJPROJECT callbacks tend to have locks already held when
 * called.
 *
 * \warning \b Never hold locks that may be acquired by a SIP servant
 * thread when calling this function.  Doing so may cause a deadlock
 * if all SIP servant threads are blocked waiting to acquire the lock
 * while the thread holding the lock is waiting for a free SIP servant
 * thread.
 *
 * \warning \b Use of this function in an ao2 destructor callback is a
 * bad idea.  You don't have control over which thread executes the
 * destructor.  Attempting to shift execution to another thread with
 * this function is likely to cause deadlock.
 *
 * \param serializer The SIP serializer to execute the task if the
 * current thread is not a SIP servant.  NULL if any of the default
 * serializers can be used.
 * \param sip_task The task to execute
 * \param task_data The parameter to pass to the task when it executes
 *
 * \note The sip_task() return value may need to be distinguished from
 * the failure to push the task.
 *
 * \return sip_task() return value on success.
 * \retval -1 Failure to push the task.
 */
int ast_sip_push_task_wait_servant(struct ast_taskprocessor *serializer, int (*sip_task)(void *), void *task_data);
 
/*!
 * \brief Push a task to SIP servants and wait for it to complete.
 * \deprecated Replaced with ast_sip_push_task_wait_servant().
 */
int ast_sip_push_task_synchronous(struct ast_taskprocessor *serializer, int (*sip_task)(void *), void *task_data);
 
/*!
 * \brief Push a task to the serializer and wait for it to complete.
 *
 * Like \ref ast_sip_push_task except that it blocks until the task is
 * completed by the specified serializer.  If the specified serializer
 * is the current thread then the task executes immediately.
 *
 * \note PJPROJECT callbacks tend to have locks already held when
 * called.
 *
 * \warning \b Never hold locks that may be acquired by a SIP servant
 * thread when calling this function.  Doing so may cause a deadlock
 * if all SIP servant threads are blocked waiting to acquire the lock
 * while the thread holding the lock is waiting for a free SIP servant
 * thread for the serializer to execute in.
 *
 * \warning \b Never hold locks that may be acquired by the serializer
 * when calling this function.  Doing so will cause a deadlock.
 *
 * \warning \b Never use this function in the pjsip monitor thread (It
 * is a SIP servant thread).  This is likely to cause a deadlock.
 *
 * \warning \b Use of this function in an ao2 destructor callback is a
 * bad idea.  You don't have control over which thread executes the
 * destructor.  Attempting to shift execution to another thread with
 * this function is likely to cause deadlock.
 *
 * \param serializer The SIP serializer to execute the task.  NULL if
 * any of the default serializers can be used.
 * \param sip_task The task to execute
 * \param task_data The parameter to pass to the task when it executes
 *
 * \note It is generally better to call
 * ast_sip_push_task_wait_servant() if you pass NULL for the
 * serializer parameter.
 *
 * \note The sip_task() return value may need to be distinguished from
 * the failure to push the task.
 *
 * \return sip_task() return value on success.
 * \retval -1 Failure to push the task.
 */
int ast_sip_push_task_wait_serializer(struct ast_taskprocessor *serializer, int (*sip_task)(void *), void *task_data);
 
/*!
 * \brief Determine if the current thread is a SIP servant thread
 *
 * \retval 0 This is not a SIP servant thread
 * \retval 1 This is a SIP servant thread
 */
int ast_sip_thread_is_servant(void);
 
/*!
 * \brief Task flags for the res_pjsip scheduler
 *
 * The default is AST_SIP_SCHED_TASK_FIXED
 *                | AST_SIP_SCHED_TASK_DATA_NOT_AO2
 *                | AST_SIP_SCHED_TASK_DATA_NO_CLEANUP
 *                | AST_SIP_SCHED_TASK_PERIODIC
 */
enum ast_sip_scheduler_task_flags {
    /*!
     * The defaults
     */
    AST_SIP_SCHED_TASK_DEFAULTS = (0 << 0),
 
    /*!
     * Run at a fixed interval.
     * Stop scheduling if the callback returns <= 0.
     * Any other value is ignored.
     */
    AST_SIP_SCHED_TASK_FIXED = (0 << 0),
    /*!
     * Run at a variable interval.
     * Stop scheduling if the callback returns <= 0.
     * Any other return value is used as the new interval.
     */
    AST_SIP_SCHED_TASK_VARIABLE = (1 << 0),
 
    /*!
     * Run just once.
     * Return values are ignored.
     */
    AST_SIP_SCHED_TASK_ONESHOT = (1 << 6),
 
    /*!
     * The task data is not an AO2 object.
     */
    AST_SIP_SCHED_TASK_DATA_NOT_AO2 = (0 << 1),
    /*!
     * The task data is an AO2 object.
     * A reference count will be held by the scheduler until
     * after the task has run for the final time (if ever).
     */
    AST_SIP_SCHED_TASK_DATA_AO2 = (1 << 1),
 
    /*!
     * Don't take any cleanup action on the data
     */
    AST_SIP_SCHED_TASK_DATA_NO_CLEANUP = (0 << 3),
    /*!
     * If AST_SIP_SCHED_TASK_DATA_AO2 is set, decrement the reference count
     * otherwise call ast_free on it.
     */
    AST_SIP_SCHED_TASK_DATA_FREE = ( 1 << 3 ),
 
    /*!
     * \brief The task is scheduled at multiples of interval
     * \see Interval
     */
    AST_SIP_SCHED_TASK_PERIODIC = (0 << 4),
    /*!
     * \brief The next invocation of the task is at last finish + interval
     * \see Interval
     */
    AST_SIP_SCHED_TASK_DELAY = (1 << 4),
    /*!
     * \brief The scheduled task's events are tracked in the debug log.
     * \details
     * Schedule events such as scheduling, running, rescheduling, canceling,
     * and destroying are logged about the task.
     */
    AST_SIP_SCHED_TASK_TRACK = (1 << 5),
};
 
/*!
 * \brief Scheduler task data structure
 */
struct ast_sip_sched_task;
 
/*!
 * \brief Schedule a task to run in the res_pjsip thread pool
 * \since 13.9.0
 *
 * \param serializer The serializer to use.  If NULL, don't use a serializer (see note below)
 * \param interval The invocation interval in milliseconds (see note below)
 * \param sip_task The task to invoke
 * \param name An optional name to associate with the task
 * \param task_data Optional data to pass to the task
 * \param flags One of enum ast_sip_scheduler_task_type
 *
 * \returns Pointer to \ref ast_sip_sched_task ao2 object which must be dereferenced when done.
 *
 * \par Serialization
 *
 * Specifying a serializer guarantees serialized execution but NOT specifying a serializer
 * may still result in tasks being effectively serialized if the thread pool is busy.
 * The point of the serializer BTW is not to prevent parallel executions of the SAME task.
 * That happens automatically (see below).  It's to prevent the task from running at the same
 * time as other work using the same serializer, whether or not it's being run by the scheduler.
 *
 * \par Interval
 *
 * The interval is used to calculate the next time the task should run.  There are two models.
 *
 * \ref AST_SIP_SCHED_TASK_PERIODIC specifies that the invocations of the task occur at the
 * specific interval.  That is, every \p interval milliseconds, regardless of how long the task
 * takes. If the task takes longer than \p interval, it will be scheduled at the next available
 * multiple of \p interval.  For example: If the task has an interval of 60 seconds and the task
 * takes 70 seconds, the next invocation will happen at 120 seconds.
 *
 * \ref AST_SIP_SCHED_TASK_DELAY specifies that the next invocation of the task should start
 * at \p interval milliseconds after the current invocation has finished.
 *
 */
struct ast_sip_sched_task *ast_sip_schedule_task(struct ast_taskprocessor *serializer,
    int interval, ast_sip_task sip_task, const char *name, void *task_data,
    enum ast_sip_scheduler_task_flags flags);
 
/*!
 * \brief Cancels the next invocation of a task
 * \since 13.9.0
 *
 * \param schtd The task structure pointer
 * \retval 0 Success
 * \retval -1 Failure
 * \note Only cancels future invocations not the currently running invocation.
 */
int ast_sip_sched_task_cancel(struct ast_sip_sched_task *schtd);
 
/*!
 * \brief Cancels the next invocation of a task by name
 * \since 13.9.0
 *
 * \param name The task name
 * \retval 0 Success
 * \retval -1 Failure
 * \note Only cancels future invocations not the currently running invocation.
 */
int ast_sip_sched_task_cancel_by_name(const char *name);
 
/*!
 * \brief Gets the last start and end times of the task
 * \since 13.9.0
 *
 * \param schtd The task structure pointer
 * \param[out] when_queued Pointer to a timeval structure to contain the time when queued
 * \param[out] last_start Pointer to a timeval structure to contain the time when last started
 * \param[out] last_end Pointer to a timeval structure to contain the time when last ended
 * \retval 0 Success
 * \retval -1 Failure
 * \note Any of the pointers can be NULL if you don't need them.
 */
int ast_sip_sched_task_get_times(struct ast_sip_sched_task *schtd,
    struct timeval *when_queued, struct timeval *last_start, struct timeval *last_end);
 
/*!
 * \brief Gets the queued, last start, last_end, time left, interval, next run
 * \since 16.15.0
 * \since 18.1.0
 *
 * \param schtd The task structure pointer
 * \param[out] when_queued Pointer to a timeval structure to contain the time when queued
 * \param[out] last_start Pointer to a timeval structure to contain the time when last started
 * \param[out] last_end Pointer to a timeval structure to contain the time when last ended
 * \param[out] interval Pointer to an int to contain the interval in ms
 * \param[out] time_left Pointer to an int to contain the ms left to the next run
 * \param[out] next_start Pointer to a timeval structure to contain the next run time
 * \retval 0 Success
 * \retval -1 Failure
 * \note Any of the pointers can be NULL if you don't need them.
 */
int ast_sip_sched_task_get_times2(struct ast_sip_sched_task *schtd,
    struct timeval *when_queued, struct timeval *last_start, struct timeval *last_end,
    int *interval, int *time_left, struct timeval *next_start);
 
/*!
 * \brief Gets the last start and end times of the task by name
 * \since 13.9.0
 *
 * \param name The task name
 * \param[out] when_queued Pointer to a timeval structure to contain the time when queued
 * \param[out] last_start Pointer to a timeval structure to contain the time when last started
 * \param[out] last_end Pointer to a timeval structure to contain the time when last ended
 * \retval 0 Success
 * \retval -1 Failure
 * \note Any of the pointers can be NULL if you don't need them.
 */
int ast_sip_sched_task_get_times_by_name(const char *name,
    struct timeval *when_queued, struct timeval *last_start, struct timeval *last_end);
 
/*!
 * \brief Gets the queued, last start, last_end, time left, interval, next run by task name
 * \since 16.15.0
 * \since 18.1.0
 *
 * \param name The task name
 * \param[out] when_queued Pointer to a timeval structure to contain the time when queued
 * \param[out] last_start Pointer to a timeval structure to contain the time when last started
 * \param[out] last_end Pointer to a timeval structure to contain the time when last ended
 * \param[out] interval Pointer to an int to contain the interval in ms
 * \param[out] time_left Pointer to an int to contain the ms left to the next run
 * \param[out] next_start Pointer to a timeval structure to contain the next run time
 * \retval 0 Success
 * \retval -1 Failure
 * \note Any of the pointers can be NULL if you don't need them.
 */
int ast_sip_sched_task_get_times_by_name2(const char *name,
    struct timeval *when_queued, struct timeval *last_start, struct timeval *last_end,
    int *interval, int *time_left, struct timeval *next_start);
 
/*!
 * \brief Gets the number of milliseconds until the next invocation
 * \since 13.9.0
 *
 * \param schtd The task structure pointer
 * \return The number of milliseconds until the next invocation or -1 if the task isn't scheduled
 */
int ast_sip_sched_task_get_next_run(struct ast_sip_sched_task *schtd);
 
/*!
 * \brief Gets the number of milliseconds until the next invocation
 * \since 13.9.0
 *
 * \param name The task name
 * \return The number of milliseconds until the next invocation or -1 if the task isn't scheduled
 */
int ast_sip_sched_task_get_next_run_by_name(const char *name);
 
/*!
 * \brief Checks if the task is currently running
 * \since 13.9.0
 *
 * \param schtd The task structure pointer
 * \retval 0 not running
 * \retval 1 running
 */
int ast_sip_sched_is_task_running(struct ast_sip_sched_task *schtd);
 
/*!
 * \brief Checks if the task is currently running
 * \since 13.9.0
 *
 * \param name The task name
 * \retval 0 not running or not found
 * \retval 1 running
 */
int ast_sip_sched_is_task_running_by_name(const char *name);
 
/*!
 * \brief Gets the task name
 * \since 13.9.0
 *
 * \param schtd The task structure pointer
 * \param name, maxlen
 * \retval 0 success
 * \retval 1 failure
 */
int ast_sip_sched_task_get_name(struct ast_sip_sched_task *schtd, char *name, size_t maxlen);
 
/*!
 *  @}
 */
 
/*!
 * \brief SIP body description
 *
 * This contains a type and subtype that will be added as
 * the "Content-Type" for the message as well as the body
 * text.
 */
struct ast_sip_body {
    /*! Type of the body, such as "application" */
    const char *type;
    /*! Subtype of the body, such as "sdp" */
    const char *subtype;
    /*! The text to go in the body */
    const char *body_text;
};
 
/*!
 * \brief General purpose method for creating a UAC dialog with an endpoint
 *
 * \param endpoint A pointer to the endpoint
 * \param aor_name Optional name of the AOR to target, may even be an explicit SIP URI
 * \param request_user Optional user to place into the target URI
 *
 * \retval non-NULL success
 * \retval NULL failure
 */
pjsip_dialog *ast_sip_create_dialog_uac(const struct ast_sip_endpoint *endpoint, const char *aor_name, const char *request_user);
 
/*!
 * \brief General purpose method for creating a UAS dialog with an endpoint
 *
 * \deprecated This function is unsafe (due to the returned object not being locked nor
 *             having its reference incremented) and should no longer be used. Instead
 *             use ast_sip_create_dialog_uas_locked so a properly locked and referenced
 *             object is returned.
 *
 * \param endpoint A pointer to the endpoint
 * \param rdata The request that is starting the dialog
 * \param[out] status On failure, the reason for failure in creating the dialog
 */
pjsip_dialog *ast_sip_create_dialog_uas(const struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata, pj_status_t *status);
 
/*!
 * \brief General purpose method for creating a UAS dialog with an endpoint
 *
 * This function creates and returns a locked, and referenced counted pjsip
 * dialog object. The caller is thus responsible for freeing the allocated
 * memory, decrementing the reference, and releasing the lock when done with
 * the returned object.
 *
 * \note The safest way to unlock the object, and decrement its reference is by
 *       calling pjsip_dlg_dec_lock. Alternatively, pjsip_dlg_dec_session can be
 *       used to decrement the reference only.
 *
 * The dialog is returned locked and with a reference in order to ensure that the
 * dialog object, and any of its associated objects (e.g. transaction) are not
 * untimely destroyed. For instance, that could happen when a transport error
 * occurs.
 *
 * As long as the caller maintains a reference to the dialog there should be no
 * worry that it might unknowingly be destroyed. However, once the caller unlocks
 * the dialog there is a danger that some of the dialog's internal objects could
 * be lost and/or compromised. For example, when the aforementioned transport error
 * occurs the dialog's associated transaction gets destroyed (see pjsip_dlg_on_tsx_state
 * in sip_dialog.c, and mod_inv_on_tsx_state in sip_inv.c).
 *
 * In this case and before using the dialog again the caller should re-lock the
 * dialog, check to make sure the dialog is still established, and the transaction
 * still exists and has not been destroyed.
 *
 * \param endpoint A pointer to the endpoint
 * \param rdata The request that is starting the dialog
 * \param[out] status On failure, the reason for failure in creating the dialog
 *
 * \retval A locked, and reference counted pjsip_dialog object.
 * \retval NULL on failure
 */
pjsip_dialog *ast_sip_create_dialog_uas_locked(const struct ast_sip_endpoint *endpoint,
    pjsip_rx_data *rdata, pj_status_t *status);
 
/*!
 * \brief General purpose method for creating an rdata structure using specific information
 * \since 13.15.0
 *
 * \param[out] rdata The rdata structure that will be populated
 * \param packet A SIP message
 * \param src_name The source IP address of the message
 * \param src_port The source port of the message
 * \param transport_type The type of transport the message was received on
 * \param local_name The local IP address the message was received on
 * \param local_port The local port the message was received on
 * \param contact_uri The contact URI of the message
 *
 * \retval 0 success
 * \retval -1 failure
 */
int ast_sip_create_rdata_with_contact(pjsip_rx_data *rdata, char *packet,
    const char *src_name, int src_port, char *transport_type, const char *local_name,
    int local_port, const char *contact_uri);
 
/*!
 * \brief General purpose method for creating an rdata structure using specific information
 *
 * \param[out] rdata The rdata structure that will be populated
 * \param packet A SIP message
 * \param src_name The source IP address of the message
 * \param src_port The source port of the message
 * \param transport_type The type of transport the message was received on
 * \param local_name The local IP address the message was received on
 * \param local_port The local port the message was received on
 *
 * \retval 0 success
 * \retval -1 failure
 */
int ast_sip_create_rdata(pjsip_rx_data *rdata, char *packet, const char *src_name,
    int src_port, char *transport_type, const char *local_name, int local_port);
 
/*!
 * \brief General purpose method for creating a SIP request
 *
 * Its typical use would be to create one-off requests such as an out of dialog
 * SIP MESSAGE.
 *
 * The request can either be in- or out-of-dialog. If in-dialog, the
 * dlg parameter MUST be present. If out-of-dialog the endpoint parameter
 * MUST be present. If both are present, then we will assume that the message
 * is to be sent in-dialog.
 *
 * The uri parameter can be specified if the request should be sent to an explicit
 * URI rather than one configured on the endpoint.
 *
 * \param method The method of the SIP request to send
 * \param dlg Optional. If specified, the dialog on which to request the message.
 * \param endpoint Optional. If specified, the request will be created out-of-dialog to the endpoint.
 * \param uri Optional. If specified, the request will be sent to this URI rather
 * than one configured for the endpoint.
 * \param contact The contact with which this request is associated for out-of-dialog requests.
 * \param[out] tdata The newly-created request
 *
 * The provided contact is attached to tdata with its reference bumped, but will
 * not survive for the entire lifetime of tdata since the contact is cleaned up
 * when all supplements have completed execution.
 *
 * \retval 0 Success
 * \retval -1 Failure
 */
int ast_sip_create_request(const char *method, struct pjsip_dialog *dlg,
        struct ast_sip_endpoint *endpoint, const char *uri,
        struct ast_sip_contact *contact, pjsip_tx_data **tdata);
 
/*!
 * \brief General purpose method for sending a SIP request
 *
 * This is a companion function for \ref ast_sip_create_request. The request
 * created there can be passed to this function, though any request may be
 * passed in.
 *
 * This will automatically set up handling outbound authentication challenges if
 * they arrive.
 *
 * \param tdata The request to send
 * \param dlg Optional. The dialog in which the request is sent.  Otherwise it is out-of-dialog.
 * \param endpoint Optional. If specified, the out-of-dialog request is sent to the endpoint.
 * \param token Data to be passed to the callback upon receipt of out-of-dialog response.
 * \param callback Callback to be called upon receipt of out-of-dialog response.
 *
 * \retval 0 Success
 * \retval -1 Failure (out-of-dialog callback will not be called.)
 */
int ast_sip_send_request(pjsip_tx_data *tdata, struct pjsip_dialog *dlg,
    struct ast_sip_endpoint *endpoint, void *token,
    void (*callback)(void *token, pjsip_event *e));
 
/*!
 * \brief General purpose method for sending an Out-Of-Dialog SIP request
 *
 * This is a companion function for \ref ast_sip_create_request. The request
 * created there can be passed to this function, though any request may be
 * passed in.
 *
 * This will automatically set up handling outbound authentication challenges if
 * they arrive.
 *
 * \param tdata The request to send
 * \param endpoint Optional. If specified, the out-of-dialog request is sent to the endpoint.
 * \param timeout If non-zero, after the timeout the transaction will be terminated
 * and the callback will be called with the PJSIP_EVENT_TIMER type.
 * \param token Data to be passed to the callback upon receipt of out-of-dialog response.
 * \param callback Callback to be called upon receipt of out-of-dialog response.
 *
 * \retval 0 Success
 * \retval -1 Failure (out-of-dialog callback will not be called.)
 *
 * \note Timeout processing:
 * There are 2 timers associated with this request, PJSIP timer_b which is
 * set globally in the "system" section of pjsip.conf, and the timeout specified
 * on this call.  The timer that expires first (before normal completion) will
 * cause the callback to be run with e->body.tsx_state.type = PJSIP_EVENT_TIMER.
 * The timer that expires second is simply ignored and the callback is not run again.
 */
int ast_sip_send_out_of_dialog_request(pjsip_tx_data *tdata,
    struct ast_sip_endpoint *endpoint, int timeout, void *token,
    void (*callback)(void *token, pjsip_event *e));
 
/*!
 * \brief General purpose method for creating a SIP response
 *
 * Its typical use would be to create responses for out of dialog
 * requests.
 *
 * \param rdata The rdata from the incoming request.
 * \param st_code The response code to transmit.
 * \param contact The contact with which this request is associated.
 * \param[out] p_tdata The newly-created response
 *
 * The provided contact is attached to tdata with its reference bumped, but will
 * not survive for the entire lifetime of tdata since the contact is cleaned up
 * when all supplements have completed execution.
 *
 * \retval 0 Success
 * \retval -1 Failure
 */
int ast_sip_create_response(const pjsip_rx_data *rdata, int st_code,
    struct ast_sip_contact *contact, pjsip_tx_data **p_tdata);
 
/*!
 * \brief Send a response to an out of dialog request
 *
 * Use this function sparingly, since this does not create a transaction
 * within PJSIP. This means that if the request is retransmitted, it is
 * your responsibility to detect this and not process the same request
 * twice, and to send the same response for each retransmission.
 *
 * \param res_addr The response address for this response
 * \param tdata The response to send
 * \param sip_endpoint The ast_sip_endpoint associated with this response
 *
 * \retval 0 Success
 * \retval -1 Failure
 */
int ast_sip_send_response(pjsip_response_addr *res_addr, pjsip_tx_data *tdata, struct ast_sip_endpoint *sip_endpoint);
 
/*!
 * \brief Send a stateful response to an out of dialog request
 *
 * This creates a transaction within PJSIP, meaning that if the request
 * that we are responding to is retransmitted, we will not attempt to
 * re-handle the request.
 *
 * \param rdata The request that is being responded to
 * \param tdata The response to send
 * \param sip_endpoint The ast_sip_endpoint associated with this response
 *
 * \since 13.4.0
 *
 * \retval 0 Success
 * \retval -1 Failure
 */
int ast_sip_send_stateful_response(pjsip_rx_data *rdata, pjsip_tx_data *tdata, struct ast_sip_endpoint *sip_endpoint);
 
/*!
 * \brief Determine if an incoming request requires authentication
 *
 * This calls into the registered authenticator's requires_authentication callback
 * in order to determine if the request requires authentication.
 *
 * If there is no registered authenticator, then authentication will be assumed
 * not to be required.
 *
 * \param endpoint The endpoint from which the request originates
 * \param rdata The incoming SIP request
 * \retval non-zero The request requires authentication
 * \retval 0 The request does not require authentication
 */
int ast_sip_requires_authentication(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata);
 
/*!
 * \brief Method to determine authentication status of an incoming request
 *
 * This will call into a registered authenticator. The registered authenticator will
 * do what is necessary to determine whether the incoming request passes authentication.
 * A tentative response is passed into this function so that if, say, a digest authentication
 * challenge should be sent in the ensuing response, it can be added to the response.
 *
 * \param endpoint The endpoint from the request was sent
 * \param rdata The request to potentially authenticate
 * \param tdata Tentative response to the request
 * \return The result of checking authentication.
 */
enum ast_sip_check_auth_result ast_sip_check_authentication(struct ast_sip_endpoint *endpoint,
        pjsip_rx_data *rdata, pjsip_tx_data *tdata);
 
/*!
 * \brief Create a response to an authentication challenge
 *
 * This will call into an outbound authenticator's create_request_with_auth callback
 * to create a new request with authentication credentials. See the create_request_with_auth
 * callback in the \ref ast_sip_outbound_authenticator structure for details about
 * the parameters and return values.
 */
int ast_sip_create_request_with_auth(const struct ast_sip_auth_vector *auths, pjsip_rx_data *challenge,
        pjsip_tx_data *tdata, pjsip_tx_data **new_request);
 
/*!
 * \brief Determine the endpoint that has sent a SIP message
 *
 * This will call into each of the registered endpoint identifiers'
 * identify_endpoint() callbacks until one returns a non-NULL endpoint.
 * This will return an ao2 object. Its reference count will need to be
 * decremented when completed using the endpoint.
 *
 * \param rdata The inbound SIP message to use when identifying the endpoint.
 * \retval NULL No matching endpoint
 * \retval non-NULL The matching endpoint
 */
struct ast_sip_endpoint *ast_sip_identify_endpoint(pjsip_rx_data *rdata);
 
/*!
 * \brief Get a specific header value from rdata
 *
 * \note The returned value does not need to be freed since it's from the rdata pool
 *
 * \param rdata The rdata
 * \param str The header to find
 *
 * \retval NULL on failure
 * \retval The header value on success
 */
char *ast_sip_rdata_get_header_value(pjsip_rx_data *rdata, const pj_str_t str);
 
/*!
 * \brief Set the outbound proxy for an outbound SIP message
 *
 * \param tdata The message to set the outbound proxy on
 * \param proxy SIP uri of the proxy
 * \retval 0 Success
 * \retval -1 Failure
 */
int ast_sip_set_outbound_proxy(pjsip_tx_data *tdata, const char *proxy);
 
/*!
 * \brief Add a header to an outbound SIP message
 *
 * \param tdata The message to add the header to
 * \param name The header name
 * \param value The header value
 * \retval 0 Success
 * \retval -1 Failure
 */
int ast_sip_add_header(pjsip_tx_data *tdata, const char *name, const char *value);
 
/*!
 * \brief Add a header to an outbound SIP message, returning a pointer to the header
 *
 * \param tdata The message to add the header to
 * \param name The header name
 * \param value The header value
 * \return The pjsip_generic_string_hdr * added.
 */
pjsip_generic_string_hdr *ast_sip_add_header2(pjsip_tx_data *tdata,
    const char *name, const char *value);
 
/*!
 * \brief Add a body to an outbound SIP message
 *
 * If this is called multiple times, the latest body will replace the current
 * body.
 *
 * \param tdata The message to add the body to
 * \param body The message body to add
 * \retval 0 Success
 * \retval -1 Failure
 */
int ast_sip_add_body(pjsip_tx_data *tdata, const struct ast_sip_body *body);
 
/*!
 * \brief Add a multipart body to an outbound SIP message
 *
 * This will treat each part of the input vector as part of a multipart body and
 * add each part to the SIP message.
 *
 * \param tdata The message to add the body to
 * \param bodies The message bodies to add
 * \param num_bodies The parts of the body to add
 * \retval 0 Success
 * \retval -1 Failure
 */
int ast_sip_add_body_multipart(pjsip_tx_data *tdata, const struct ast_sip_body *bodies[], int num_bodies);
 
/*!
 * \brief Append body data to a SIP message
 *
 * This acts mostly the same as ast_sip_add_body, except that rather than replacing
 * a body if it currently exists, it appends data to an existing body.
 *
 * \param tdata The message to append the body to
 * \param body_text The string to append to the end of the current body
 * \retval 0 Success
 * \retval -1 Failure
 */
int ast_sip_append_body(pjsip_tx_data *tdata, const char *body_text);
 
/*!
 * \brief Copy a pj_str_t into a standard character buffer.
 *
 * pj_str_t is not NULL-terminated. Any place that expects a NULL-
 * terminated string needs to have the pj_str_t copied into a separate
 * buffer.
 *
 * This method copies the pj_str_t contents into the destination buffer
 * and NULL-terminates the buffer.
 *
 * \param dest The destination buffer
 * \param src The pj_str_t to copy
 * \param size The size of the destination buffer.
 */
void ast_copy_pj_str(char *dest, const pj_str_t *src, size_t size);
 
/*!
 * \brief Create and copy a pj_str_t into a standard character buffer.
 *
 * pj_str_t is not NULL-terminated. Any place that expects a NULL-
 * terminated string needs to have the pj_str_t copied into a separate
 * buffer.
 *
 * Copies the pj_str_t contents into a newly allocated buffer pointed to
 * by dest. NULL-terminates the buffer.
 *
 * \note Caller is responsible for freeing the allocated memory.
 *
 * \param[out] dest The destination buffer
 * \param src The pj_str_t to copy
 * \return Number of characters copied or negative value on error
 */
int ast_copy_pj_str2(char **dest, const pj_str_t *src);
 
/*!
 * \brief Get the looked-up endpoint on an out-of dialog request or response
 *
 * The function may ONLY be called on out-of-dialog requests or responses. For
 * in-dialog requests and responses, it is required that the user of the dialog
 * has the looked-up endpoint stored locally.
 *
 * This function should never return NULL if the message is out-of-dialog. It will
 * always return NULL if the message is in-dialog.
 *
 * This function will increase the reference count of the returned endpoint by one.
 * Release your reference using the ao2_ref function when finished.
 *
 * \param rdata Out-of-dialog request or response
 * \return The looked up endpoint
 */
struct ast_sip_endpoint *ast_pjsip_rdata_get_endpoint(pjsip_rx_data *rdata);
 
/*!
 * \brief Add 'user=phone' parameter to URI if enabled and user is a phone number.
 *
 * \param endpoint The endpoint to use for configuration
 * \param pool The memory pool to allocate the parameter from
 * \param uri The URI to check for user and to add parameter to
 */
void ast_sip_add_usereqphone(const struct ast_sip_endpoint *endpoint, pj_pool_t *pool, pjsip_uri *uri);
 
/*!
 * \brief Retrieve any endpoints available to sorcery.
 *
 * \retval Endpoints available to sorcery, NULL if no endpoints found.
 */
struct ao2_container *ast_sip_get_endpoints(void);
 
/*!
 * \brief Retrieve the default outbound endpoint.
 *
 * \retval The default outbound endpoint, NULL if not found.
 */
struct ast_sip_endpoint *ast_sip_default_outbound_endpoint(void);
 
/*!
 * \brief Retrieve relevant SIP auth structures from sorcery
 *
 * \param auths Vector of sorcery IDs of auth credentials to retrieve
 * \param[out] out The retrieved auths are stored here
 */
int ast_sip_retrieve_auths(const struct ast_sip_auth_vector *auths, struct ast_sip_auth **out);
 
/*!
 * \brief Clean up retrieved auth structures from memory
 *
 * Call this function once you have completed operating on auths
 * retrieved from \ref ast_sip_retrieve_auths
 *
 * \param auths An array of auth object pointers to clean up
 * \param num_auths The number of auths in the array
 */
void ast_sip_cleanup_auths(struct ast_sip_auth *auths[], size_t num_auths);
 
AST_VECTOR(ast_sip_auth_objects_vector, struct ast_sip_auth *);
/*!
 * \brief Retrieve relevant SIP auth structures from sorcery as a vector
 *
 * \param auth_ids Vector of sorcery IDs of auth credentials to retrieve
 * \param[out] auth_objects A pointer ast_sip_auth_objects_vector to hold the objects
 *
 * \retval 0 Success
 * \retval -1 Number of auth objects found is less than the number of names supplied.
 *
 * \warning The number of auth objects retrieved may be less than the
 * number of auth ids supplied if auth objects couldn't be found for
 * some of them.
 *
 * \note Since the ref count on all auth objects returned has been
 * bumped, you must call ast_sip_cleanup_auth_objects_vector() to decrement
 * the ref count on all of the auth objects in the vector,
 * then call AST_VECTOR_FREE() on the vector itself.
 *
 */
int ast_sip_retrieve_auths_vector(const struct ast_sip_auth_vector *auth_ids,
    struct ast_sip_auth_objects_vector *auth_objects);
 
/*!
 * \brief Clean up retrieved auth objects in vector
 *
 * Call this function once you have completed operating on auths
 * retrieved from \ref ast_sip_retrieve_auths_vector.  All
 * auth objects will have their reference counts decremented and
 * the vector size will be reset to 0.  You must still call
 * AST_VECTOR_FREE() on the vector itself.
 *
 * \param auth_objects A vector of auth structures to clean up
 */
#define ast_sip_cleanup_auth_objects_vector(auth_objects) AST_VECTOR_RESET(auth_objects, ao2_cleanup)
 
/*!
 * \brief Checks if the given content type matches type/subtype.
 *
 * Compares the pjsip_media_type with the passed type and subtype and
 * returns the result of that comparison.  The media type parameters are
 * ignored.
 *
 * \param content_type The pjsip_media_type structure to compare
 * \param type The media type to compare
 * \param subtype The media subtype to compare
 * \retval 0 No match
 * \retval -1 Match
 */
int ast_sip_is_content_type(pjsip_media_type *content_type, char *type, char *subtype);
 
/*!
 * \brief Send a security event notification for when an invalid endpoint is requested
 *
 * \param name Name of the endpoint requested
 * \param rdata Received message
 */
void ast_sip_report_invalid_endpoint(const char *name, pjsip_rx_data *rdata);
 
/*!
 * \brief Send a security event notification for when an ACL check fails
 *
 * \param endpoint Pointer to the endpoint in use
 * \param rdata Received message
 * \param name Name of the ACL
 */
void ast_sip_report_failed_acl(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata, const char *name);
 
/*!
 * \brief Send a security event notification for when a challenge response has failed
 *
 * \param endpoint Pointer to the endpoint in use
 * \param rdata Received message
 */
void ast_sip_report_auth_failed_challenge_response(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata);
 
/*!
 * \brief Send a security event notification for when authentication succeeds
 *
 * \param endpoint Pointer to the endpoint in use
 * \param rdata Received message
 */
void ast_sip_report_auth_success(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata);
 
/*!
 * \brief Send a security event notification for when an authentication challenge is sent
 *
 * \param endpoint Pointer to the endpoint in use
 * \param rdata Received message
 * \param tdata Sent message
 */
void ast_sip_report_auth_challenge_sent(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata, pjsip_tx_data *tdata);
 
/*!
 * \brief Send a security event notification for when a request is not supported
 *
 * \param endpoint Pointer to the endpoint in use
 * \param rdata Received message
 * \param req_type the type of request
 */
void ast_sip_report_req_no_support(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata,
                   const char* req_type);
 
/*!
 * \brief Send a security event notification for when a memory limit is hit.
 *
 * \param endpoint Pointer to the endpoint in use
 * \param rdata Received message
 */
void ast_sip_report_mem_limit(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata);
 
int ast_sip_add_global_request_header(const char *name, const char *value, int replace);
int ast_sip_add_global_response_header(const char *name, const char *value, int replace);
 
/*!
 * \brief Retrieves the value associated with the given key.
 *
 * \param ht the hash table/dictionary to search
 * \param key the key to find
 *
 * \retval the value associated with the key, NULL otherwise.
 */
void *ast_sip_dict_get(void *ht, const char *key);
 
/*!
 * \brief Using the dictionary stored in mod_data array at a given id,
 *        retrieve the value associated with the given key.
 *
 * \param mod_data a module data array
 * \param id the mod_data array index
 * \param key the key to find
 *
 * \retval the value associated with the key, NULL otherwise.
 */
#define ast_sip_mod_data_get(mod_data, id, key)     \
    ast_sip_dict_get(mod_data[id], key)
 
/*!
 * \brief Set the value for the given key.
 *
 * Note - if the hash table does not exist one is created first, the key/value
 * pair is set, and the hash table returned.
 *
 * \param pool the pool to allocate memory in
 * \param ht the hash table/dictionary in which to store the key/value pair
 * \param key the key to associate a value with
 * \param val the value to associate with a key
 *
 * \retval the given, or newly created, hash table.
 */
void *ast_sip_dict_set(pj_pool_t* pool, void *ht,
               const char *key, void *val);
 
/*!
 * \brief Utilizing a mod_data array for a given id, set the value
 *        associated with the given key.
 *
 * For a given structure's mod_data array set the element indexed by id to
 * be a dictionary containing the key/val pair.
 *
 * \param pool a memory allocation pool
 * \param mod_data a module data array
 * \param id the mod_data array index
 * \param key the key to find
 * \param val the value to associate with a key
 */
#define ast_sip_mod_data_set(pool, mod_data, id, key, val)      \
    mod_data[id] = ast_sip_dict_set(pool, mod_data[id], key, val)
 
/*!
 * \brief For every contact on an AOR call the given 'on_contact' handler.
 *
 * \param aor the aor containing a list of contacts to iterate
 * \param on_contact callback on each contact on an AOR.  The object
 * received by the callback will be a ast_sip_contact_wrapper structure.
 * \param arg user data passed to handler
 * \retval 0 Success, non-zero on failure
 */
int ast_sip_for_each_contact(const struct ast_sip_aor *aor,
        ao2_callback_fn on_contact, void *arg);
 
/*!
 * \brief Handler used to convert a contact to a string.
 *
 * \param object the ast_sip_aor_contact_pair containing a list of contacts to iterate and the contact
 * \param arg user data passed to handler
 * \param flags
 * \retval 0 Success, non-zero on failure
 */
int ast_sip_contact_to_str(void *object, void *arg, int flags);
 
/*!
 * \brief For every aor in the comma separated aors string call the
 *        given 'on_aor' handler.
 *
 * \param aors a comma separated list of aors
 * \param on_aor callback for each aor
 * \param arg user data passed to handler
 * \retval 0 Success, non-zero on failure
 */
int ast_sip_for_each_aor(const char *aors, ao2_callback_fn on_aor, void *arg);
 
/*!
 * \brief For every auth in the array call the given 'on_auth' handler.
 *
 * \param array an array of auths
 * \param on_auth callback for each auth
 * \param arg user data passed to handler
 * \retval 0 Success, non-zero on failure
 */
int ast_sip_for_each_auth(const struct ast_sip_auth_vector *array,
              ao2_callback_fn on_auth, void *arg);
 
/*!
 * \brief Converts the given auth type to a string
 *
 * \param type the auth type to convert
 * \retval a string representative of the auth type
 */
const char *ast_sip_auth_type_to_str(enum ast_sip_auth_type type);
 
/*!
 * \brief Converts an auths array to a string of comma separated values
 *
 * \param auths an auth array
 * \param buf the string buffer to write the object data
 * \retval 0 Success, non-zero on failure
 */
int ast_sip_auths_to_str(const struct ast_sip_auth_vector *auths, char **buf);
 
/*!
 * \brief Checks an pjsip_auth_algorithm_type_vector to see if it contains an algorithm
 *
 * \param auth            The auth object
 * \param algorithms      The auth object's supported_algorithms_uac or supported_algorithms_uas
 * \param algorithm_type  The algorithm_type to check
 *
 * \retval 1 The algorithm-type is in the vector
 * \retval 0 The algorithm-type is not in the vector
 */
int ast_sip_auth_is_algorithm_available(const struct ast_sip_auth *auth,
    const struct pjsip_auth_algorithm_type_vector *algorithms,
    pjsip_auth_algorithm_type algorithm_type);
 
/*!
 * \brief Get the plain text or digest password from an auth object
 *
 * \param auth            The auth object
 * \param algorithm_type  The algorithm type to retrieve the password for
 * \param cred_type       [out]Pointer to an int to receive the credential type
 *
 * \note cred_type will contain one of the following values:
 *      - PJSIP_CRED_DATA_DIGEST
 *      - PJSIP_CRED_DATA_PLAIN_PASSWD
 
 * If a password digest is available for the algorithm type it will
 * be returned, otherwise if a plain text password is available
 * that will be returned instead.
 *
 * \retval The plain text or digest password or NULL if not found for the algorithm type
 */
const char *ast_sip_auth_get_creds(const struct ast_sip_auth *auth,
    const pjsip_auth_algorithm_type algorithm_type, int *cred_type);
 
/*!
 * \brief AMI variable container
 */
struct ast_sip_ami {
    /*! Manager session */
    struct mansession *s;
    /*! Manager message */
    const struct message *m;
    /*! Manager Action ID */
    const char *action_id;
    /*! user specified argument data */
    void *arg;
    /*! count of objects */
    int count;
};
 
/*!
 * \brief Creates a string to store AMI event data in.
 *
 * \param event the event to set
 * \param ami AMI session and message container
 * \retval an initialized ast_str or NULL on error.
 */
struct ast_str *ast_sip_create_ami_event(const char *event,
                     struct ast_sip_ami *ami);
 
/*!
 * \brief An entity responsible formatting endpoint information.
 */
struct ast_sip_endpoint_formatter {
    /*!
     * \brief Callback used to format endpoint information over AMI.
     */
    int (*format_ami)(const struct ast_sip_endpoint *endpoint,
              struct ast_sip_ami *ami);
    AST_RWLIST_ENTRY(ast_sip_endpoint_formatter) next;
};
 
/*!
 * \brief Register an endpoint formatter.
 *
 * \param obj the formatter to register
 */
void ast_sip_register_endpoint_formatter(struct ast_sip_endpoint_formatter *obj);
 
/*!
 * \brief Unregister an endpoint formatter.
 *
 * \param obj the formatter to unregister
 */
void ast_sip_unregister_endpoint_formatter(struct ast_sip_endpoint_formatter *obj);
 
/*!
 * \brief Converts a sorcery object to a string of object properties.
 *
 * \param obj the sorcery object to convert
 * \param buf the string buffer to write the object data
 * \retval 0 Success, non-zero on failure
 */
int ast_sip_sorcery_object_to_ami(const void *obj, struct ast_str **buf);
 
/*!
 * \brief Formats the endpoint and sends over AMI.
 *
 * \param endpoint the endpoint to format and send
 * \param ami AMI variable container
 * \param count the number of formatters operated on
 * \retval 0 Success, otherwise non-zero on error
 */
int ast_sip_format_endpoint_ami(struct ast_sip_endpoint *endpoint,
                struct ast_sip_ami *ami, int *count);
 
/*!
 * \brief Formats the contact and sends over AMI.
 *
 * \param obj a pointer an ast_sip_contact_wrapper structure
 * \param arg a pointer to an ast_sip_ami structure
 * \param flags ignored
 * \retval 0 Success, otherwise non-zero on error
 */
int ast_sip_format_contact_ami(void *obj, void *arg, int flags);
 
/*!
 * \brief Format auth details for AMI.
 *
 * \param auths an auth array
 * \param ami ami variable container
 * \retval 0 Success, non-zero on failure
 */
int ast_sip_format_auths_ami(const struct ast_sip_auth_vector *auths,
                 struct ast_sip_ami *ami);
 
/*!
 * \brief Retrieve the endpoint snapshot for an endpoint
 *
 * \param endpoint The endpoint whose snapshot is to be retrieved.
 * \retval The endpoint snapshot
 */
struct ast_endpoint_snapshot *ast_sip_get_endpoint_snapshot(
    const struct ast_sip_endpoint *endpoint);
 
/*!
 * \brief Retrieve the device state for an endpoint.
 *
 * \param endpoint The endpoint whose state is to be retrieved.
 * \retval The device state.
 */
const char *ast_sip_get_device_state(const struct ast_sip_endpoint *endpoint);
 
/*!
 * \brief For every channel snapshot on an endpoint snapshot call the given
 *        'on_channel_snapshot' handler.
 *
 * \param endpoint_snapshot snapshot of an endpoint
 * \param on_channel_snapshot callback for each channel snapshot
 * \param arg user data passed to handler
 * \retval 0 Success, non-zero on failure
 */
int ast_sip_for_each_channel_snapshot(const struct ast_endpoint_snapshot *endpoint_snapshot,
        ao2_callback_fn on_channel_snapshot,
                      void *arg);
 
/*!
 * \brief For every channel snapshot on an endpoint all the given
 *        'on_channel_snapshot' handler.
 *
 * \param endpoint endpoint
 * \param on_channel_snapshot callback for each channel snapshot
 * \param arg user data passed to handler
 * \retval 0 Success, non-zero on failure
 */
int ast_sip_for_each_channel(const struct ast_sip_endpoint *endpoint,
        ao2_callback_fn on_channel_snapshot,
                      void *arg);
 
enum ast_sip_supplement_priority {
    /*! Top priority. Supplements with this priority are those that need to run before any others */
    AST_SIP_SUPPLEMENT_PRIORITY_FIRST = 0,
    /*! Channel creation priority.
     * chan_pjsip creates a channel at this priority. If your supplement depends on being run before
     * or after channel creation, then set your priority to be lower or higher than this value.
     */
    AST_SIP_SUPPLEMENT_PRIORITY_CHANNEL = 1000000,
    /*! Lowest priority. Supplements with this priority should be run after all other supplements */
    AST_SIP_SUPPLEMENT_PRIORITY_LAST = INT_MAX,
};
 
/*!
 * \brief A supplement to SIP message processing
 *
 * These can be registered by any module in order to add
 * processing to incoming and outgoing SIP out of dialog
 * requests and responses
 */
struct ast_sip_supplement {
    /*! Method on which to call the callbacks. If NULL, call on all methods */
    const char *method;
    /*! Priority for this supplement. Lower numbers are visited before higher numbers */
    enum ast_sip_supplement_priority priority;
    /*!
     * \brief Called on incoming SIP request
     * This method can indicate a failure in processing in its return. If there
     * is a failure, it is required that this method sends a response to the request.
     * This method is always called from a SIP servant thread.
     *
     * \note
     * The following PJSIP methods will not work properly:
     * pjsip_rdata_get_dlg()
     * pjsip_rdata_get_tsx()
     * The reason is that the rdata passed into this function is a cloned rdata structure,
     * and its module data is not copied during the cloning operation.
     * If you need to get the dialog, you can get it via session->inv_session->dlg.
     *
     * \note
     * There is no guarantee that a channel will be present on the session when this is called.
     */
    int (*incoming_request)(struct ast_sip_endpoint *endpoint, struct pjsip_rx_data *rdata);
    /*!
     * \brief Called on an incoming SIP response
     * This method is always called from a SIP servant thread.
     *
     * \note
     * The following PJSIP methods will not work properly:
     * pjsip_rdata_get_dlg()
     * pjsip_rdata_get_tsx()
     * The reason is that the rdata passed into this function is a cloned rdata structure,
     * and its module data is not copied during the cloning operation.
     * If you need to get the dialog, you can get it via session->inv_session->dlg.
     *
     * \note
     * There is no guarantee that a channel will be present on the session when this is called.
     */
    void (*incoming_response)(struct ast_sip_endpoint *endpoint, struct pjsip_rx_data *rdata);
    /*!
     * \brief Called on an outgoing SIP request
     * This method is always called from a SIP servant thread.
     */
    void (*outgoing_request)(struct ast_sip_endpoint *endpoint, struct ast_sip_contact *contact, struct pjsip_tx_data *tdata);
    /*!
     * \brief Called on an outgoing SIP response
     * This method is always called from a SIP servant thread.
     */
    void (*outgoing_response)(struct ast_sip_endpoint *endpoint, struct ast_sip_contact *contact, struct pjsip_tx_data *tdata);
    /*! Next item in the list */
    AST_LIST_ENTRY(ast_sip_supplement) next;
};
 
/*!
 * \brief Register a supplement to SIP out of dialog processing
 *
 * This allows for someone to insert themselves in the processing of out
 * of dialog SIP requests and responses. This, for example could allow for
 * a module to set channel data based on headers in an incoming message.
 * Similarly, a module could reject an incoming request if desired.
 *
 * \param supplement The supplement to register
 */
void ast_sip_register_supplement(struct ast_sip_supplement *supplement);
 
/*!
 * \brief Unregister a an supplement to SIP out of dialog processing
 *
 * \param supplement The supplement to unregister
 */
void ast_sip_unregister_supplement(struct ast_sip_supplement *supplement);
 
/*!
 * \brief Retrieve the global MWI taskprocessor high water alert trigger level.
 *
 * \since 13.12.0
 *
 * \retval the system MWI taskprocessor high water alert trigger level
 */
unsigned int ast_sip_get_mwi_tps_queue_high(void);
 
/*!
 * \brief Retrieve the global MWI taskprocessor low water clear alert level.
 *
 * \since 13.12.0
 *
 * \retval the system MWI taskprocessor low water clear alert level
 */
int ast_sip_get_mwi_tps_queue_low(void);
 
/*!
 * \brief Retrieve the global setting 'disable sending unsolicited mwi on startup'.
 * \since 13.12.0
 *
 * \retval non zero if disable.
 */
unsigned int ast_sip_get_mwi_disable_initial_unsolicited(void);
 
/*!
 * \brief Retrieve the global setting 'allow_sending_180_after_183'.
 *
 * \retval non zero if disable.
 */
unsigned int ast_sip_get_allow_sending_180_after_183(void);
 
/*!
 * \brief Retrieve the global setting 'use_callerid_contact'.
 * \since 13.24.0
 *
 * \retval non zero if CALLERID(num) is to be used as the default username in the contact
 */
unsigned int ast_sip_get_use_callerid_contact(void);
 
/*!
 * \brief Retrieve the global setting 'norefersub'.
 *
 * \retval non zero if norefersub is to be sent in "Supported" Headers
 */
unsigned int ast_sip_get_norefersub(void);
 
/*!
 * \brief Retrieve the global setting 'ignore_uri_user_options'.
 * \since 13.12.0
 *
 * \retval non zero if ignore the user field options.
 */
unsigned int ast_sip_get_ignore_uri_user_options(void);
 
/*!
 * \brief Retrieve the global setting 'send_contact_status_on_update_registration'.
 * \since 16.2.0
 *
 * \retval non zero if need to send AMI ContactStatus event when a contact is updated.
 */
unsigned int ast_sip_get_send_contact_status_on_update_registration(void);
 
 
/*!
 * \brief Truncate the URI user field options string if enabled.
 * \since 13.12.0
 *
 * \param str URI user field string to truncate if enabled
 *
 * \details
 * We need to be able to handle URI's looking like
 * "sip:1235557890;phone-context=national@x.x.x.x;user=phone"
 *
 * Where the URI user field is:
 * "1235557890;phone-context=national"
 *
 * When truncated the string will become:
 * "1235557890"
 */
#define AST_SIP_USER_OPTIONS_TRUNCATE_CHECK(str)                \
    do {                                                        \
        char *__semi = strchr((str), ';');                      \
        if (__semi && ast_sip_get_ignore_uri_user_options()) {  \
            *__semi = '\0';                                     \
        }                                                       \
    } while (0)
 
/*!
 * \brief Retrieve the system debug setting (yes|no|host).
 *
 * \note returned string needs to be de-allocated by caller.
 *
 * \retval the system debug setting.
 */
char *ast_sip_get_debug(void);
 
/*!
 * \brief Retrieve the global regcontext setting.
 *
 * \since 13.8.0
 *
 * \note returned string needs to be de-allocated by caller.
 *
 * \retval the global regcontext setting
 */
char *ast_sip_get_regcontext(void);
 
/*!
 * \brief Retrieve the global endpoint_identifier_order setting.
 *
 * Specifies the order by which endpoint identifiers should be regarded.
 *
 * \retval the global endpoint_identifier_order value
 */
char *ast_sip_get_endpoint_identifier_order(void);
 
/*!
 * \brief Retrieve the default voicemail extension.
 * \since 13.9.0
 *
 * \note returned string needs to be de-allocated by caller.
 *
 * \retval the default voicemail extension
 */
char *ast_sip_get_default_voicemail_extension(void);
 
/*!
 * \brief Retrieve the global default realm.
 *
 * This is the value placed in outbound challenges' realm if there
 * is no better option (such as an auth-configured realm).
 *
 * \param[out] realm The default realm
 * \param size The buffer size of realm
 */
void ast_sip_get_default_realm(char *realm, size_t size);
 
/*!
 * \brief Retrieve the global auth algorithms for UAS.
 *
 * \param[out] default_auth_algorithms_uas The default algorithms
 * \param size The buffer size of default_auth_algorithms_uas
 */
void ast_sip_get_default_auth_algorithms_uas(char *default_auth_algorithms_uas, size_t size);
 
/*!
 * \brief Retrieve the global auth algorithms for UAC.
 *
 * \param[out] default_auth_algorithms_uac The default algorithms
 * \param size The buffer size of default_auth_algorithms_uac
 */
void ast_sip_get_default_auth_algorithms_uac(char *default_auth_algorithms_uac, size_t size);
 
/*!
 * \brief Retrieve the global default from user.
 *
 * This is the value placed in outbound requests' From header if there
 * is no better option (such as an endpoint-configured from_user or
 * caller ID number).
 *
 * \param[out] from_user The default from user
 * \param size The buffer size of from_user
 */
void ast_sip_get_default_from_user(char *from_user, size_t size);
 
/*!
 * \brief Retrieve the system keep alive interval setting.
 *
 * \retval the keep alive interval.
 */
unsigned int ast_sip_get_keep_alive_interval(void);
 
/*!
 * \brief Retrieve the system contact expiration check interval setting.
 *
 * \retval the contact expiration check interval.
 */
unsigned int ast_sip_get_contact_expiration_check_interval(void);
 
/*!
 * \brief Retrieve the system setting 'disable multi domain'.
 * \since 13.9.0
 *
 * \retval non zero if disable multi domain.
 */
unsigned int ast_sip_get_disable_multi_domain(void);
 
/*!
 * \brief Retrieve the system max initial qualify time.
 *
 * \retval the maximum initial qualify time.
 */
unsigned int ast_sip_get_max_initial_qualify_time(void);
 
/*!
 * \brief translate ast_sip_contact_status_type to character string.
 *
 * \retval the character string equivalent.
 */
 
const char *ast_sip_get_contact_status_label(const enum ast_sip_contact_status_type status);
const char *ast_sip_get_contact_short_status_label(const enum ast_sip_contact_status_type status);
 
/*!
 * \brief Set a request to use the next value in the list of resolved addresses.
 *
 * \param tdata the tx data from the original request
 * \retval 0 No more addresses to try
 * \retval 1 The request was successfully re-intialized
 */
int ast_sip_failover_request(pjsip_tx_data *tdata);
 
/*!
 * \brief Retrieve the local host address in IP form
 *
 * \param af The address family to retrieve
 * \param addr A place to store the local host address
 *
 * \retval 0 success
 * \retval -1 failure
 *
 * \since 13.6.0
 */
int ast_sip_get_host_ip(int af, pj_sockaddr *addr);
 
/*!
 * \brief Retrieve the local host address in string form
 *
 * \param af The address family to retrieve
 *
 * \retval non-NULL success
 * \retval NULL failure
 *
 * \since 13.6.0
 *
 * \note An empty string may be returned if the address family is valid but no local address exists
 */
const char *ast_sip_get_host_ip_string(int af);
 
/*!
 * \brief Return the size of the SIP threadpool's task queue
 * \since 13.7.0
 */
long ast_sip_threadpool_queue_size(void);
 
/*!
 * \brief Retrieve the SIP threadpool object
 */
struct ast_threadpool *ast_sip_threadpool(void);
 
/*!
 * \brief Retrieve transport state
 * \since 13.7.1
 *
 * \param transport_id
 * \retval transport_state
 *
 * \note ao2_cleanup(...) or ao2_ref(...,  -1) must be called on the returned object
 */
struct ast_sip_transport_state *ast_sip_get_transport_state(const char *transport_id);
 
/*!
 * \brief Return the SIP URI of the Contact header
 * 
 * \param tdata
 * \retval Pointer to SIP URI of Contact
 * \retval NULL if Contact header not found or not a SIP(S) URI
 *
 * \note Do not free the returned object.
 */
pjsip_sip_uri *ast_sip_get_contact_sip_uri(pjsip_tx_data *tdata);
 
/*!
 * \brief Returns the transport state currently in use based on request transport details
 *
 * \param details
 * \retval transport_state
 *
 * \note ao2_cleanup(...) or ao2_ref(...,  -1) must be called on the returned object
 */
struct ast_sip_transport_state *ast_sip_find_transport_state_in_use(struct ast_sip_request_transport_details *details);
 
/*!
 * \brief Sets request transport details based on tdata
 *
 * \param details pre-allocated request transport details to set
 * \param tdata
 * \param use_ipv6 if non-zero, ipv6 transports will be considered
 * \retval 0 success
 * \retval -1 failure
 */
int ast_sip_set_request_transport_details(struct ast_sip_request_transport_details *details, pjsip_tx_data *tdata, int use_ipv6);
 
/*!
 * \brief Replace domain and port of SIP URI to point to (external) signaling address of this Asterisk instance
 *
 * \param uri
 * \param tdata
 *
 * \retval 0 success
 * \retval -1 failure
 *
 * \note Uses domain and port in Contact header if it exists, otherwise the local URI of the dialog is used if the
 *       message is sent within the context of a dialog. Further, NAT settings are considered - i.e. if the target
 *       is not in the localnet, the external_signaling_address and port are used.
 */
int ast_sip_rewrite_uri_to_local(pjsip_sip_uri *uri, pjsip_tx_data *tdata);
 
/*!
 * \brief Retrieves all transport states
 * \since 13.7.1
 *
 * \retval ao2_container
 *
 * \note ao2_cleanup(...) or ao2_ref(...,  -1) must be called on the returned object
 */
struct ao2_container *ast_sip_get_transport_states(void);
 
/*!
 * \brief Sets pjsip_tpselector from ast_sip_transport
 * \since 13.8.0
 *
 * \param transport The transport to be used
 * \param selector The selector to be populated
 * \retval 0 success
 * \retval -1 failure
 *
 * \note The transport selector must be unreffed using ast_sip_tpselector_unref
 */
int ast_sip_set_tpselector_from_transport(const struct ast_sip_transport *transport, pjsip_tpselector *selector);
 
/*!
 * \brief Sets pjsip_tpselector from ast_sip_transport
 * \since 13.8.0
 *
 * \param transport_name The name of the transport to be used
 * \param selector The selector to be populated
 * \retval 0 success
 * \retval -1 failure
 *
 * \note The transport selector must be unreffed using ast_sip_tpselector_unref
 */
int ast_sip_set_tpselector_from_transport_name(const char *transport_name, pjsip_tpselector *selector);
 
/*!
 * \brief Unreference a pjsip_tpselector
 * \since 17.0.0
 *
 * \param selector The selector to be unreffed
 */
void ast_sip_tpselector_unref(pjsip_tpselector *selector);
 
/*!
 * \brief Sets the PJSIP transport on a child transport
 * \since 17.0.0
 *
 * \param transport_name The name of the transport to be updated
 * \param transport The PJSIP transport
 * \retval 0 success
 * \retval -1 failure
 */
int ast_sip_transport_state_set_transport(const char *transport_name, pjsip_transport *transport);
 
/*!
 * \brief Sets the P-Preferred-Identity on a child transport
 * \since 17.0.0
 *
 * \param transport_name The name of the transport to be set on
 * \param identity The P-Preferred-Identity to use on requests on this transport
 * \retval 0 success
 * \retval -1 failure
 */
int ast_sip_transport_state_set_preferred_identity(const char *transport_name, const char *identity);
 
/*!
 * \brief Sets the service routes on a child transport
 * \since 17.0.0
 *
 * \param transport_name The name of the transport to be set on
 * \param service_routes A vector of service routes
 * \retval 0 success
 * \retval -1 failure
 *
 * \note This assumes ownership of the service routes in both success and failure scenarios
 */
int ast_sip_transport_state_set_service_routes(const char *transport_name, struct ast_sip_service_route_vector *service_routes);
 
/*!
 * \brief Apply the configuration for a transport to an outgoing message
 * \since 17.0.0
 *
 * \param transport_name The name of the transport to apply configuration from
 * \param tdata The SIP message
 */
void ast_sip_message_apply_transport(const char *transport_name, pjsip_tx_data *tdata);
 
/*!
 * \brief Allocate a vector of service routes
 * \since 17.0.0
 *
 * \retval non-NULL success
 * \retval NULL failure
 */
struct ast_sip_service_route_vector *ast_sip_service_route_vector_alloc(void);
 
/*!
 * \brief Destroy a vector of service routes
 * \since 17.0.0
 *
 * \param service_routes A vector of service routes
 */
void ast_sip_service_route_vector_destroy(struct ast_sip_service_route_vector *service_routes);
 
/*!
 * \brief Set the ID for a connected line update
 *
 * \retval -1 on failure, 0 on success
 */
int ast_sip_set_id_connected_line(struct pjsip_rx_data *rdata, struct ast_party_id *id);
 
/*!
 * \brief Set the ID from an INVITE
 *
 * \param rdata
 * \param id ID structure to fill
 * \param default_id Default ID structure with data to use (for non-trusted endpoints)
 * \param trust_inbound Whether or not the endpoint is trusted (controls whether PAI or RPID can be used)
 *
 * \retval -1 on failure, 0 on success
 */
int ast_sip_set_id_from_invite(struct pjsip_rx_data *rdata, struct ast_party_id *id, struct ast_party_id *default_id, int trust_inbound);
 
/*!
 * \brief Set name and number information on an identity header.
 *
 * \param pool Memory pool to use for string duplication
 * \param id_hdr A From, P-Asserted-Identity, or Remote-Party-ID header to modify
 * \param id The identity information to apply to the header
 */
void ast_sip_modify_id_header(pj_pool_t *pool, pjsip_fromto_hdr *id_hdr,
    const struct ast_party_id *id);
 
/*!
 * \brief Retrieves an endpoint and URI from the "to" string.
 *
 * This URI is used as the Request URI.
 *
 * Expects the given 'to' to be in one of the following formats:
 * Why we allow so many is a mystery.
 *
 * Basic:
 *
 *      endpoint        : We'll get URI from the default aor/contact
 *      endpoint/aor    : We'll get the URI from the specific aor/contact
 *      endpoint@domain : We toss the domain part and just use the endpoint
 *
 *   These all use the endpoint and specified URI:
 * \verbatim
        endpoint/<sip[s]:host>
        endpoint/<sip[s]:user@host>
        endpoint/"Bob" <sip[s]:host>
        endpoint/"Bob" <sip[s]:user@host>
        endpoint/sip[s]:host
        endpoint/sip[s]:user@host
        endpoint/host
        endpoint/user@host
   \endverbatim
 *
 *   These all use the default endpoint and specified URI:
 * \verbatim
        <sip[s]:host>
        <sip[s]:user@host>
        "Bob" <sip[s]:host>
        "Bob" <sip[s]:user@host>
        sip[s]:host
        sip[s]:user@host
   \endverbatim
 *
 *   These use the default endpoint and specified host:
 * \verbatim
        host
        user@host
   \endverbatim
 *
 *   This form is similar to a dialstring:
 * \verbatim
        PJSIP/user@endpoint
   \endverbatim
 *
 *   In this case, the user will be added to the endpoint contact's URI.
 *   If the contact URI already has a user, it will be replaced.
 *
 * The ones that have the sip[s] scheme are the easiest to parse.
 * The rest all have some issue.
 *
 *      endpoint vs host              : We have to test for endpoint first
 *      endpoint/aor vs endpoint/host : We have to test for aor first
 *                                      What if there's an aor with the same
 *                                      name as the host?
 *      endpoint@domain vs user@host  : We have to test for endpoint first.
 *                                      What if there's an endpoint with the
 *                                      same name as the user?
 *
 * \param to 'To' field with possible endpoint
 * \param get_default_outbound If nonzero, try to retrieve the default
 *                 outbound endpoint if no endpoint was found.
 *                 Otherwise, return NULL if no endpoint was found.
 * \param uri Pointer to a char* which will be set to the URI.
 *            Always must be ast_free'd by the caller - even if the return value is NULL!
 *
 * \note The logic below could probably be condensed but then it wouldn't be
 * as clear.
 */
struct ast_sip_endpoint *ast_sip_get_endpoint(const char *to, int get_default_outbound, char **uri);
 
/*!
 * \brief Replace the To URI in the tdata with the supplied one
 *
 * \param tdata the outbound message data structure
 * \param to URI to replace the To URI with. Must be a valid SIP URI.
 *
 * \retval 0: success, -1: failure
 */
int ast_sip_update_to_uri(pjsip_tx_data *tdata, const char *to);
 
/*!
 * \brief Overwrite fields in the outbound 'From' header
 *
 * The outbound 'From' header is created/added in ast_sip_create_request with
 * default data.  If available that data may be info specified in the 'from_user'
 * and 'from_domain' options found on the endpoint.  That information will be
 * overwritten with data in the given 'from' parameter.
 *
 * \param tdata the outbound message data structure
 * \param from info to copy into the header.
 *        Can be either a SIP URI, or in the format user[@domain]
 *
 * \retval 0: success, -1: failure
 */
int ast_sip_update_from(pjsip_tx_data *tdata, char *from);
 
/*!
 * \brief Retrieve the unidentified request security event thresholds
 * \since 13.8.0
 *
 * \param count The maximum number of unidentified requests per source ip to accumulate before emitting a security event
 * \param period The period in seconds over which to accumulate unidentified requests
 * \param prune_interval The interval in seconds at which expired entries will be pruned
 */
void ast_sip_get_unidentified_request_thresholds(unsigned int *count, unsigned int *period,
    unsigned int *prune_interval);
 
/*!
 * \brief Get the transport name from an endpoint or request uri
 * \since 13.15.0
 *
 * \param endpoint
 * \param sip_uri
 * \param buf Buffer to receive transport name
 * \param buf_len Buffer length
 *
 * \retval 0 Success
 * \retval -1 Failure
 *
 * \note
 * If endpoint->transport is not NULL, it is returned in buf.
 * Otherwise if sip_uri has an 'x-ast-txp' parameter AND the sip_uri host is
 * an ip4 or ip6 address, its value is returned,
 */
int ast_sip_get_transport_name(const struct ast_sip_endpoint *endpoint,
    pjsip_sip_uri *sip_uri, char *buf, size_t buf_len);
 
/*!
 * \brief Sets pjsip_tpselector from an endpoint or uri
 * \since 13.15.0
 *
 * \param endpoint If endpoint->transport is set, it's used
 * \param sip_uri If sip_uri contains a x-ast-txp parameter, it's used
 * \param selector The selector to be populated
 *
 * \retval 0 success
 * \retval -1 failure
 */
int ast_sip_set_tpselector_from_ep_or_uri(const struct ast_sip_endpoint *endpoint,
    pjsip_sip_uri *sip_uri, pjsip_tpselector *selector);
 
/*!
 * \brief Set the transport on a dialog
 * \since 13.15.0
 *
 * \param endpoint
 * \param dlg
 * \param selector (optional)
 *
 * \note
 * This API calls ast_sip_get_transport_name(endpoint, dlg->target) and if the result is
 * non-NULL, calls pjsip_dlg_set_transport.  If 'selector' is non-NULL, it is updated with
 * the selector used.
 *
 * \note
 * It is the responsibility of the caller to unref the passed in selector if one is provided.
 */
int ast_sip_dlg_set_transport(const struct ast_sip_endpoint *endpoint, pjsip_dialog *dlg,
    pjsip_tpselector *selector);
 
/*!
 * \brief Convert the DTMF mode enum value into a string
 * \since 13.18.0
 *
 * \param dtmf the dtmf mode
 * \param buf Buffer to receive dtmf mode string
 * \param buf_len Buffer length
 *
 * \retval 0 Success
 * \retval -1 Failure
 *
 */
int ast_sip_dtmf_to_str(const enum ast_sip_dtmf_mode dtmf,
    char *buf, size_t buf_len);
 
/*!
 * \brief Convert the DTMF mode name into an enum
 * \since 13.18.0
 *
 * \param dtmf_mode dtmf mode as a string
 *
 * \retval  >= 0 The enum value
 * \retval -1 Failure
 *
 */
int ast_sip_str_to_dtmf(const char *dtmf_mode);
 
/*!
 * \brief Convert the call codec preference flags to a string
 * \since 18.0.0
 *
 * \param pref the call codec preference setting
 *
 * \returns a constant string with either the setting value or 'unknown'
 * \note Don't try to free the string!
 *
 */
const char *ast_sip_call_codec_pref_to_str(struct ast_flags pref);
 
/*!
 * \brief Convert a call codec preference string to preference flags
 * \since 18.0.0
 *
 * \param pref A pointer to an ast_flags structure to receive the preference flags
 * \param pref_str The call codec preference setting string
 * \param is_outgoing Is for outgoing calls?
 *
 * \retval 0 The string was parsed successfully
 * \retval -1 The string option was invalid
 */
int ast_sip_call_codec_str_to_pref(struct ast_flags *pref, const char *pref_str, int is_outgoing);
 
/*!
 * \brief Transport shutdown monitor callback.
 * \since 13.18.0
 *
 * \param data User data to know what to do when transport shuts down.
 *
 * \note The callback does not need to care that data is an ao2 object.
 */
typedef void (*ast_transport_monitor_shutdown_cb)(void *data);
 
/*!
 * \brief Transport shutdown monitor data matcher
 * \since 13.20.0
 *
 * \param a User data to compare.
 * \param b User data to compare.
 *
 * \retval 1 The data objects match
 * \retval 0 The data objects don't match
 */
typedef int (*ast_transport_monitor_data_matcher)(void *a, void *b);
 
enum ast_transport_monitor_reg {
    /*! \brief Successfully registered the transport monitor */
    AST_TRANSPORT_MONITOR_REG_SUCCESS,
    /*! \brief Replaced the already existing transport monitor with new one. */
    AST_TRANSPORT_MONITOR_REG_REPLACED,
    /*!
     * \brief Transport not found to monitor.
     * \note Transport is either already shutdown or is not reliable.
     */
    AST_TRANSPORT_MONITOR_REG_NOT_FOUND,
    /*! \brief Error while registering transport monitor. */
    AST_TRANSPORT_MONITOR_REG_FAILED,
};
 
/*!
 * \brief Register a reliable transport shutdown monitor callback.
 * \deprecated Replaced with ast_sip_transport_monitor_register_key().
 * \since 13.20.0
 *
 * \param transport Transport to monitor for shutdown.
 * \param cb Who to call when transport is shutdown.
 * \param ao2_data Data to pass with the callback.
 *
 * \note The data object passed will have its reference count automatically
 * incremented by this call and automatically decremented after the callback
 * runs or when the callback is unregistered.
 *
 * There is no checking for duplicate registrations.
 *
 * \return enum ast_transport_monitor_reg
 */
enum ast_transport_monitor_reg ast_sip_transport_monitor_register(pjsip_transport *transport,
    ast_transport_monitor_shutdown_cb cb, void *ao2_data);
 
/*!
 * \brief Register a reliable transport shutdown monitor callback.
 *
 * \param transport_key Key for the transport to monitor for shutdown.
 *                      Create the key with AST_SIP_MAKE_REMOTE_IPADDR_PORT_STR.
 * \param cb Who to call when transport is shutdown.
 * \param ao2_data Data to pass with the callback.
 *
 * \note The data object passed will have its reference count automatically
 * incremented by this call and automatically decremented after the callback
 * runs or when the callback is unregistered.
 *
 * There is no checking for duplicate registrations.
 *
 * \return enum ast_transport_monitor_reg
 */
enum ast_transport_monitor_reg ast_sip_transport_monitor_register_key(
    const char *transport_key, ast_transport_monitor_shutdown_cb cb,
    void *ao2_data);
 
/*!
 * \brief Register a reliable transport shutdown monitor callback replacing any duplicate.
 * \deprecated Replaced with ast_sip_transport_monitor_register_replace_key().
 * \since 13.26.0
 * \since 16.3.0
 *
 * \param transport Transport to monitor for shutdown.
 * \param cb Who to call when transport is shutdown.
 * \param ao2_data Data to pass with the callback.
 * \param matches Matcher function that returns true if data matches a previously
 *                registered data object
 *
 * \note The data object passed will have its reference count automatically
 * incremented by this call and automatically decremented after the callback
 * runs or when the callback is unregistered.
 *
 * This function checks for duplicates, and overwrites/replaces the old monitor
 * with the given one.
 *
 * \return enum ast_transport_monitor_reg
 */
enum ast_transport_monitor_reg ast_sip_transport_monitor_register_replace(pjsip_transport *transport,
    ast_transport_monitor_shutdown_cb cb, void *ao2_data, ast_transport_monitor_data_matcher matches);
 
/*!
 * \brief Register a reliable transport shutdown monitor callback replacing any duplicate.
 *
 * \param transport_key Key for the transport to monitor for shutdown.
 *                      Create the key with AST_SIP_MAKE_REMOTE_IPADDR_PORT_STR.
 * \param cb Who to call when transport is shutdown.
 * \param ao2_data Data to pass with the callback.
 * \param matches Matcher function that returns true if data matches a previously
 *                registered data object
 *
 * \note The data object passed will have its reference count automatically
 * incremented by this call and automatically decremented after the callback
 * runs or when the callback is unregistered.
 *
 * This function checks for duplicates, and overwrites/replaces the old monitor
 * with the given one.
 *
 * \return enum ast_transport_monitor_reg
 */
enum ast_transport_monitor_reg ast_sip_transport_monitor_register_replace_key(
    const char *transport_key, ast_transport_monitor_shutdown_cb cb,
    void *ao2_data, ast_transport_monitor_data_matcher matches);
 
/*!
 * \brief Unregister a reliable transport shutdown monitor
 * \deprecated Replaced with ast_sip_transport_monitor_unregister_key().
 * \since 13.20.0
 *
 * \param transport Transport to monitor for shutdown.
 * \param cb The callback that was used for the original register.
 * \param data Data to pass to the matcher. May be NULL and does NOT need to be an ao2 object.
 *             If NULL, all monitors with the provided callback are unregistered.
 * \param matches Matcher function that returns true if data matches the previously
 *                registered data object.  If NULL, a simple pointer comparison is done.
 *
 * \note The data object passed into the original register will have its reference count
 * automatically decremented.
 */
void ast_sip_transport_monitor_unregister(pjsip_transport *transport,
    ast_transport_monitor_shutdown_cb cb, void *data, ast_transport_monitor_data_matcher matches);
 
/*!
 * \brief Unregister a reliable transport shutdown monitor
 *
 * \param transport_key Key for the transport to monitor for shutdown.
 *                      Create the key with AST_SIP_MAKE_REMOTE_IPADDR_PORT_STR.
 * \param cb The callback that was used for the original register.
 * \param data Data to pass to the matcher. May be NULL and does NOT need to be an ao2 object.
 *             If NULL, all monitors with the provided callback are unregistered.
 * \param matches Matcher function that returns true if data matches the previously
 *                registered data object.  If NULL, a simple pointer comparison is done.
 *
 * \note The data object passed into the original register will have its reference count
 * automatically decremented.
 */
void ast_sip_transport_monitor_unregister_key(const char *transport_key,
    ast_transport_monitor_shutdown_cb cb, void *data, ast_transport_monitor_data_matcher matches);
 
/*!
 * \brief Unregister a transport shutdown monitor from all reliable transports
 * \since 13.20.0
 *
 * \param cb The callback that was used for the original register.
 * \param data Data to pass to the matcher. May be NULL and does NOT need to be an ao2 object.
 *             If NULL, all monitors with the provided callback are unregistered.
 * \param matches Matcher function that returns true if ao2_data matches the previously
 *                registered data object.  If NULL, a simple pointer comparison is done.
 *
 * \note The data object passed into the original register will have its reference count
 * automatically decremented.
 */
void ast_sip_transport_monitor_unregister_all(ast_transport_monitor_shutdown_cb cb,
    void *data, ast_transport_monitor_data_matcher matches);
 
/*! Transport state notification registration element.  */
struct ast_sip_tpmgr_state_callback {
    /*! PJPROJECT transport state notification callback */
    pjsip_tp_state_callback cb;
    AST_LIST_ENTRY(ast_sip_tpmgr_state_callback) node;
};
 
/*!
 * \brief Register a transport state notification callback element.
 * \since 13.18.0
 *
 * \param element What we are registering.
 */
void ast_sip_transport_state_register(struct ast_sip_tpmgr_state_callback *element);
 
/*!
 * \brief Unregister a transport state notification callback element.
 * \since 13.18.0
 *
 * \param element What we are unregistering.
 */
void ast_sip_transport_state_unregister(struct ast_sip_tpmgr_state_callback *element);
 
/*!
 * \brief Check whether a pjsip_uri is SIP/SIPS or not
 * \since 16.28.0
 *
 * \param uri The pjsip_uri to check
 *
 * \retval 1 if true
 * \retval 0 if false
 */
int ast_sip_is_uri_sip_sips(pjsip_uri *uri);
 
/*!
 * \brief Check whether a pjsip_uri is allowed or not
 * \since 16.28.0
 *
 * \param uri The pjsip_uri to check
 *
 * \retval 1 if allowed
 * \retval 0 if not allowed
 */
int ast_sip_is_allowed_uri(pjsip_uri *uri);
 
/*!
 * \brief Get the user portion of the pjsip_uri
 * \since 16.28.0
 *
 * \param uri The pjsip_uri to get the user from
 *
 * \note This function will check what kind of URI it receives and return
 * the user based off of that
 *
 * \return User string or empty string if not present
 */
const pj_str_t *ast_sip_pjsip_uri_get_username(pjsip_uri *uri);
 
/*!
 * \brief Get the host portion of the pjsip_uri
 * \since 16.28.0
 *
 * \param uri The pjsip_uri to get the host from
 *
 * \note This function will check what kind of URI it receives and return
 * the host based off of that
 *
 * \return Host string or empty string if not present
 */
const pj_str_t *ast_sip_pjsip_uri_get_hostname(pjsip_uri *uri);
 
/*!
 * \brief Find an 'other' SIP/SIPS URI parameter by name
 * \since 16.28.0
 *
 * A convenience function to find a named parameter from a SIP/SIPS URI. This
 * function will not find the following standard SIP/SIPS URI parameters which
 * are stored separately by PJSIP:
 *
 * \li `user`
 * \li `method`
 * \li `transport`
 * \li `ttl`
 * \li `lr`
 * \li `maddr`
 *
 * \param uri The pjsip_uri to get the parameter from
 * \param param_str The name of the parameter to find
 *
 * \note This function will check what kind of URI it receives and return
 * the parameter based off of that
 *
 * \return Find parameter or NULL if not present
 */
struct pjsip_param *ast_sip_pjsip_uri_get_other_param(pjsip_uri *uri, const pj_str_t *param_str);
 
/*!
 * \brief Retrieve the system setting 'all_codecs_on_empty_reinvite'.
 *
 * \retval non zero if we should return all codecs on empty re-INVITE
 */
unsigned int ast_sip_get_all_codecs_on_empty_reinvite(void);
 
 
/*!
 * \brief Convert SIP hangup causes to Asterisk hangup causes
 *
 * \param cause SIP cause
 *
 * \retval matched cause code from causes.h
 */
const int ast_sip_hangup_sip2cause(int cause);
 
/*!
 * \brief Convert name to SIP response code
 *
 * \param name SIP response code name matching one of the
 *             enum names defined in "enum pjsip_status_code"
 *             defined in sip_msg.h.  May be specified with or
 *             without the PJSIP_SC_ prefix.
 *
 * \retval SIP response code
 * \retval -1 if matching code not found
 */
int ast_sip_str2rc(const char *name);
 
#endif /* _RES_PJSIP_H */

ast_sip_mod_data_get

#define ast_sip_mod_data_get	(		mod_data,
			id,
			key
	)		ast_sip_dict_get(mod_data[id], key)

Using the dictionary stored in mod_data array at a given id, retrieve the value associated with the given key.

Parameters

mod_data	a module data array
id	the mod_data array index
key	the key to find

Return values

the	value associated with the key, NULL otherwise.

Definition at line 3067 of file res_pjsip.h.

ast_sip_mod_data_set

#define ast_sip_mod_data_set	(		pool,
			mod_data,
			id,
			key,
			val
	)		mod_data[id] = ast_sip_dict_set(pool, mod_data[id], key, val)

Utilizing a mod_data array for a given id, set the value associated with the given key.

For a given structure's mod_data array set the element indexed by id to be a dictionary containing the key/val pair.

Parameters

pool	a memory allocation pool
mod_data	a module data array
id	the mod_data array index
key	the key to find
val	the value to associate with a key

Definition at line 3099 of file res_pjsip.h.

ast_sip_transport_is_local

#define ast_sip_transport_is_local	(		transport_state,
			addr
	)		(transport_state->localnet && ast_apply_ha(transport_state->localnet, addr) != AST_SENSE_ALLOW)

Definition at line 213 of file res_pjsip.h.

ast_sip_transport_is_nonlocal

#define ast_sip_transport_is_nonlocal	(		transport_state,
			addr
	)		(!transport_state->localnet || ast_apply_ha(transport_state->localnet, addr) == AST_SENSE_ALLOW)

Definition at line 210 of file res_pjsip.h.

AST_SIP_USER_OPTIONS_TRUNCATE_CHECK

#define AST_SIP_USER_OPTIONS_TRUNCATE_CHECK

(

str

)

Truncate the URI user field options string if enabled.

Since

13.12.0

Parameters

str	URI user field string to truncate if enabled

We need to be able to handle URI's looking like "sip:1235557890;phone-context=national@x.x.x.x;user=phone"

Where the URI user field is: "1235557890;phone-context=national"

When truncated the string will become: "1235557890"

Definition at line 3504 of file res_pjsip.h.

       {                                                        \
        char *__semi = strchr((str), ';');                      \
        if (__semi && ast_sip_get_ignore_uri_user_options()) {  \
            *__semi = '\0';                                     \
        }                                                       \
    } while (0)

AST_SIP_X_AST_TXP

#define AST_SIP_X_AST_TXP   "x-ast-txp"

URI parameter for symmetric transport

Definition at line 1170 of file res_pjsip.h.

AST_SIP_X_AST_TXP_LEN

#define AST_SIP_X_AST_TXP_LEN   9

Definition at line 1171 of file res_pjsip.h.

COLON_PORT_STRLEN

#define COLON_PORT_STRLEN   6

Definition at line 78 of file res_pjsip.h.

IP6ADDR_COLON_PORT_BUFLEN

#define IP6ADDR_COLON_PORT_BUFLEN   (PJ_INET6_ADDRSTRLEN + COLON_PORT_STRLEN)

Definition at line 83 of file res_pjsip.h.

MAX_RX_CHALLENGES

#define MAX_RX_CHALLENGES   10

Maximum number of challenges before assuming that we are in a loop

Definition at line 108 of file res_pjsip.h.

PJSIP_EXPIRES_NOT_SPECIFIED

#define PJSIP_EXPIRES_NOT_SPECIFIED   ((pj_uint32_t)-1)

Definition at line 68 of file res_pjsip.h.

PJSIP_MINVERSION

#define PJSIP_MINVERSION	(		m,
			n,
			p
	)		(((m << 24) | (n << 16) | (p << 8)) >= PJ_VERSION_NUM)

Definition at line 59 of file res_pjsip.h.

PJSTR_PRINTF_SPEC

#define PJSTR_PRINTF_SPEC   "%.*s"

Definition at line 71 of file res_pjsip.h.

PJSTR_PRINTF_VAR

#define PJSTR_PRINTF_VAR

(

_v

)

((int)(_v).slen), ((_v).ptr)

Definition at line 72 of file res_pjsip.h.

SIP_SORCERY_AUTH_TYPE

#define SIP_SORCERY_AUTH_TYPE   "auth"

Definition at line 597 of file res_pjsip.h.

SIP_SORCERY_DOMAIN_ALIAS_TYPE

#define SIP_SORCERY_DOMAIN_ALIAS_TYPE   "domain_alias"

Definition at line 310 of file res_pjsip.h.

SIP_TLS_MAX_CIPHERS

#define SIP_TLS_MAX_CIPHERS   64

Maximum number of ciphers supported for a TLS transport.

Definition at line 105 of file res_pjsip.h.

Typedef Documentation

ast_sip_dialog_outbound_auth_cb

typedef int(* ast_sip_dialog_outbound_auth_cb) (pjsip_dialog *dlg, pjsip_tx_data *tdata, void *user_data)

Callback called when an outbound request with authentication credentials is to be sent in dialog.

This callback will have the created request on it. The callback's purpose is to do any extra housekeeping that needs to be done as well as to send the request out.

This callback is only necessary if working with a PJSIP API that sits between the application and the dialog layer.

Parameters

dlg	The dialog to which the request belongs
tdata	The created request to be sent out
user_data	Data supplied with the callback

Return values

0	Success
-1	Failure

Definition at line 1884 of file res_pjsip.h.

ast_transport_monitor_data_matcher

typedef int(* ast_transport_monitor_data_matcher) (void *a, void *b)

Transport shutdown monitor data matcher.

Since

13.20.0

Parameters

a	User data to compare.
b	User data to compare.

Return values

1	The data objects match
0	The data objects don't match

Definition at line 4102 of file res_pjsip.h.

ast_transport_monitor_shutdown_cb

typedef void(* ast_transport_monitor_shutdown_cb) (void *data)

Transport shutdown monitor callback.

Since

13.18.0

Parameters

data	User data to know what to do when transport shuts down.

Note

The callback does not need to care that data is an ao2 object.

Definition at line 4090 of file res_pjsip.h.

pjsip_auth_algorithm

typedef struct pjsip_auth_algorithm pjsip_auth_algorithm

pjsip_auth_algorithm_type

typedef enum pjsip_auth_algorithm_type pjsip_auth_algorithm_type

Enumeration Type Documentation

ast_sip_100rel_mode

enum ast_sip_100rel_mode

100rel modes for SIP endpoints

Enumerator
AST_SIP_100REL_UNSUPPORTED	Do not support 100rel. (no)
AST_SIP_100REL_SUPPORTED	As UAC, indicate 100rel support in Supported header. (yes)
AST_SIP_100REL_PEER_SUPPORTED	As UAS, send 1xx responses reliably, if the UAC indicated its support. Otherwise same as AST_SIP_100REL_SUPPORTED. (peer_supported)
AST_SIP_100REL_REQUIRED	Require the use of 100rel. (required)

Definition at line 531 of file res_pjsip.h.

                         {
    /*! Do not support 100rel. (no) */
    AST_SIP_100REL_UNSUPPORTED = 0,
    /*! As UAC, indicate 100rel support in Supported header. (yes) */
    AST_SIP_100REL_SUPPORTED,
    /*! As UAS, send 1xx responses reliably, if the UAC indicated its support. Otherwise same as AST_SIP_100REL_SUPPORTED. (peer_supported) */
    AST_SIP_100REL_PEER_SUPPORTED,
    /*! Require the use of 100rel. (required) */
    AST_SIP_100REL_REQUIRED,
};

ast_sip_auth_cred_usage

enum ast_sip_auth_cred_usage

Enumerator
AST_SIP_AUTH_CRED_USAGE_UAC	The credentials used as a UAC
AST_SIP_AUTH_CRED_USAGE_UAS	The credentials used as a UAS

Definition at line 590 of file res_pjsip.h.

                             {
    /*! The credentials used as a UAC */
    AST_SIP_AUTH_CRED_USAGE_UAC,
    /*! The credentials used as a UAS */
    AST_SIP_AUTH_CRED_USAGE_UAS,
};

ast_sip_auth_type

enum ast_sip_auth_type

Authentication methods.

The meaning of this type has changed. It used to indicate how the credentials were stored, but now it indicates which authentication method will be used... Google Oauth, Artificial (fake auth) or Digest. The USER_PASS and MD5 types are still used for backwards compatibility but will map to DIGEST.

Enumerator
AST_SIP_AUTH_TYPE_NONE
AST_SIP_AUTH_TYPE_USER_PASS	Credentials stored as a username and password combination Deprecated: Now automatically determined
AST_SIP_AUTH_TYPE_MD5	Credentials stored as an MD5 sum Deprecated: Use AST_SIP_AUTH_TYPE_DIGEST instead
AST_SIP_AUTH_TYPE_GOOGLE_OAUTH	Google Oauth
AST_SIP_AUTH_TYPE_ARTIFICIAL	Credentials not stored this is a fake auth
AST_SIP_AUTH_TYPE_DIGEST	Digest method will be used

Definition at line 570 of file res_pjsip.h.

                       {
    AST_SIP_AUTH_TYPE_NONE = -1,
    /*!
     * Credentials stored as a username and password combination
     * \deprecated Now automatically determined
     */
    AST_SIP_AUTH_TYPE_USER_PASS = 0,
    /*!
     * Credentials stored as an MD5 sum
     * \deprecated Use AST_SIP_AUTH_TYPE_DIGEST instead
     */
    AST_SIP_AUTH_TYPE_MD5,
    /*! Google Oauth */
    AST_SIP_AUTH_TYPE_GOOGLE_OAUTH,
    /*! Credentials not stored this is a fake auth */
    AST_SIP_AUTH_TYPE_ARTIFICIAL,
    /*! Digest method will be used */
    AST_SIP_AUTH_TYPE_DIGEST,
};

ast_sip_call_codec_pref

enum ast_sip_call_codec_pref

Incoming/Outgoing call offer/answer joint codec preference.

The default is INTERSECT ALL LOCAL.

Enumerator
AST_SIP_CALL_CODEC_PREF_INTERSECT	Two bits for merge Intersection of local and remote
AST_SIP_CALL_CODEC_PREF_UNION	Union of local and remote
AST_SIP_CALL_CODEC_PREF_ALL	Two bits for filter No filter
AST_SIP_CALL_CODEC_PREF_FIRST	Only the first
AST_SIP_CALL_CODEC_PREF_LOCAL	Two bits for preference and sort Prefer, and order by local values
AST_SIP_CALL_CODEC_PREF_REMOTE	Prefer, and order by remote values

Definition at line 758 of file res_pjsip.h.

                             {
    /*! Two bits for merge */
    /*! Intersection of local and remote */
    AST_SIP_CALL_CODEC_PREF_INTERSECT = 1 << 0,
    /*! Union of local and remote */
    AST_SIP_CALL_CODEC_PREF_UNION =     1 << 1,
 
    /*! Two bits for filter */
    /*! No filter */
    AST_SIP_CALL_CODEC_PREF_ALL =       1 << 2,
    /*! Only the first */
    AST_SIP_CALL_CODEC_PREF_FIRST =     1 << 3,
 
    /*! Two bits for preference and sort   */
    /*! Prefer, and order by local values */
    AST_SIP_CALL_CODEC_PREF_LOCAL =     1 << 4,
    /*! Prefer, and order by remote values */
    AST_SIP_CALL_CODEC_PREF_REMOTE =    1 << 5,
};

ast_sip_check_auth_result

enum ast_sip_check_auth_result

Possible returns from ast_sip_check_authentication.

Enumerator
AST_SIP_AUTHENTICATION_CHALLENGE	Authentication needs to be challenged
AST_SIP_AUTHENTICATION_SUCCESS	Authentication succeeded
AST_SIP_AUTHENTICATION_FAILED	Authentication failed
AST_SIP_AUTHENTICATION_ERROR	Authentication encountered some internal error

Definition at line 1321 of file res_pjsip.h.

                               {
    /*! Authentication needs to be challenged */
    AST_SIP_AUTHENTICATION_CHALLENGE,
    /*! Authentication succeeded */
    AST_SIP_AUTHENTICATION_SUCCESS,
    /*! Authentication failed */
    AST_SIP_AUTHENTICATION_FAILED,
    /*! Authentication encountered some internal error */
    AST_SIP_AUTHENTICATION_ERROR,
};

ast_sip_contact_filter

enum ast_sip_contact_filter

Contact retrieval filtering flags.

Enumerator
AST_SIP_CONTACT_FILTER_DEFAULT	Default filter flags.
AST_SIP_CONTACT_FILTER_REACHABLE	Return only reachable or unknown contacts.

Definition at line 1420 of file res_pjsip.h.

                            {
    /*! \brief Default filter flags */
    AST_SIP_CONTACT_FILTER_DEFAULT = 0,
 
    /*! \brief Return only reachable or unknown contacts */
    AST_SIP_CONTACT_FILTER_REACHABLE = (1 << 0),
};

ast_sip_contact_status_type

enum ast_sip_contact_status_type

Status type for a contact.

Enumerator
UNAVAILABLE	Frequency > 0, but no response from remote uri
AVAILABLE	Frequency > 0, and got response from remote uri
UNKNOWN	Default last status, and when a contact status object is not found
CREATED	Frequency == 0, has a contact, but don't know status (non-qualified)
REMOVED

Definition at line 434 of file res_pjsip.h.

                                 {
    /*! Frequency > 0, but no response from remote uri */
    UNAVAILABLE,
    /*! Frequency > 0, and got response from remote uri */
    AVAILABLE,
    /*! Default last status, and when a contact status object is not found */
    UNKNOWN,
    /*! Frequency == 0, has a contact, but don't know status (non-qualified) */
    CREATED,
    REMOVED,
};

ast_sip_direct_media_glare_mitigation

enum ast_sip_direct_media_glare_mitigation

Enumerator
AST_SIP_DIRECT_MEDIA_GLARE_MITIGATION_NONE	Take no special action to mitigate reinvite glare
AST_SIP_DIRECT_MEDIA_GLARE_MITIGATION_OUTGOING	Do not send an initial direct media session refresh on outgoing call legs Subsequent session refreshes will be sent no matter the session direction
AST_SIP_DIRECT_MEDIA_GLARE_MITIGATION_INCOMING	Do not send an initial direct media session refresh on incoming call legs Subsequent session refreshes will be sent no matter the session direction

Definition at line 720 of file res_pjsip.h.

                                           {
    /*! Take no special action to mitigate reinvite glare */
    AST_SIP_DIRECT_MEDIA_GLARE_MITIGATION_NONE,
    /*! Do not send an initial direct media session refresh on outgoing call legs
     * Subsequent session refreshes will be sent no matter the session direction
     */
    AST_SIP_DIRECT_MEDIA_GLARE_MITIGATION_OUTGOING,
    /*! Do not send an initial direct media session refresh on incoming call legs
     * Subsequent session refreshes will be sent no matter the session direction
     */
    AST_SIP_DIRECT_MEDIA_GLARE_MITIGATION_INCOMING,
};

ast_sip_dtmf_mode

enum ast_sip_dtmf_mode

DTMF modes for SIP endpoints.

Enumerator
AST_SIP_DTMF_NONE	No DTMF to be used
AST_SIP_DTMF_RFC_4733	Use RFC 4733 events for DTMF
AST_SIP_DTMF_INBAND	Use DTMF in the audio stream
AST_SIP_DTMF_INFO	Use SIP INFO DTMF (blech)
AST_SIP_DTMF_AUTO	Use SIP 4733 if supported by the other side or INBAND if not
AST_SIP_DTMF_AUTO_INFO	Use SIP 4733 if supported by the other side or INFO DTMF (blech) if not

Definition at line 545 of file res_pjsip.h.

                       {
    /*! No DTMF to be used */
    AST_SIP_DTMF_NONE,
    /* XXX Should this be 2833 instead? */
    /*! Use RFC 4733 events for DTMF */
    AST_SIP_DTMF_RFC_4733,
    /*! Use DTMF in the audio stream */
    AST_SIP_DTMF_INBAND,
    /*! Use SIP INFO DTMF (blech) */
    AST_SIP_DTMF_INFO,
    /*! Use SIP 4733 if supported by the other side or INBAND if not */
    AST_SIP_DTMF_AUTO,
    /*! Use SIP 4733 if supported by the other side or INFO DTMF (blech) if not */
    AST_SIP_DTMF_AUTO_INFO,
};

ast_sip_endpoint_identifier_type

enum ast_sip_endpoint_identifier_type

Different methods by which incoming requests can be matched to endpoints.

Enumerator
AST_SIP_ENDPOINT_IDENTIFY_BY_USERNAME	Identify based on user name in From header
AST_SIP_ENDPOINT_IDENTIFY_BY_AUTH_USERNAME	Identify based on user name in Auth header first, then From header
AST_SIP_ENDPOINT_IDENTIFY_BY_IP	Identify based on source IP address
AST_SIP_ENDPOINT_IDENTIFY_BY_HEADER	Identify based on arbitrary headers
AST_SIP_ENDPOINT_IDENTIFY_BY_REQUEST_URI	Identify based on request uri

Definition at line 699 of file res_pjsip.h.

                                      {
    /*! Identify based on user name in From header */
    AST_SIP_ENDPOINT_IDENTIFY_BY_USERNAME = (1 << 0),
    /*! Identify based on user name in Auth header first, then From header */
    AST_SIP_ENDPOINT_IDENTIFY_BY_AUTH_USERNAME = (1 << 1),
    /*! Identify based on source IP address */
    AST_SIP_ENDPOINT_IDENTIFY_BY_IP = (1 << 2),
    /*! Identify based on arbitrary headers */
    AST_SIP_ENDPOINT_IDENTIFY_BY_HEADER = (1 << 3),
    /*! Identify based on request uri */
    AST_SIP_ENDPOINT_IDENTIFY_BY_REQUEST_URI = (1 << 4),
};

ast_sip_security_mechanism_type

enum ast_sip_security_mechanism_type

The security mechanism type.

Enumerator
AST_SIP_SECURITY_MECH_NONE
AST_SIP_SECURITY_MECH_MSRP_TLS
AST_SIP_SECURITY_MECH_SDES_SRTP
AST_SIP_SECURITY_MECH_DTLS_SRTP

Definition at line 362 of file res_pjsip.h.

                                     {
    AST_SIP_SECURITY_MECH_NONE = 0,
    /* Use msrp-tls as security mechanism */
    AST_SIP_SECURITY_MECH_MSRP_TLS,
    /* Use sdes-srtp as security mechanism */
    AST_SIP_SECURITY_MECH_SDES_SRTP,
    /* Use dtls-srtp as security mechanism */
    AST_SIP_SECURITY_MECH_DTLS_SRTP,
    /* Add RFC 3329 (sec-agree) mechanisms like tle, digest, ipsec-ike in the future */
};

ast_sip_security_negotiation

enum ast_sip_security_negotiation

The kind of security negotiation.

Enumerator
AST_SIP_SECURITY_NEG_NONE	No security mechanism negotiation
AST_SIP_SECURITY_NEG_MEDIASEC	Use mediasec security mechanism negotiation

Definition at line 351 of file res_pjsip.h.

                                  {
    /*! No security mechanism negotiation */
    AST_SIP_SECURITY_NEG_NONE = 0,
    /*! Use mediasec security mechanism negotiation */
    AST_SIP_SECURITY_NEG_MEDIASEC,
    /* Add RFC 3329 (sec-agree) mechanism negotiation in the future */
};

ast_sip_session_media_encryption

enum ast_sip_session_media_encryption

Enumerator
AST_SIP_MEDIA_TRANSPORT_INVALID	Invalid media encryption configuration
AST_SIP_MEDIA_ENCRYPT_NONE	Do not allow any encryption of session media
AST_SIP_MEDIA_ENCRYPT_SDES	Offer SDES-encrypted session media
AST_SIP_MEDIA_ENCRYPT_DTLS	Offer encrypted session media with datagram TLS key exchange

Definition at line 733 of file res_pjsip.h.

                                      {
    /*! Invalid media encryption configuration */
    AST_SIP_MEDIA_TRANSPORT_INVALID = 0,
    /*! Do not allow any encryption of session media */
    AST_SIP_MEDIA_ENCRYPT_NONE,
    /*! Offer SDES-encrypted session media */
    AST_SIP_MEDIA_ENCRYPT_SDES,
    /*! Offer encrypted session media with datagram TLS key exchange */
    AST_SIP_MEDIA_ENCRYPT_DTLS,
};

ast_sip_session_redirect

enum ast_sip_session_redirect

Enumerator
AST_SIP_REDIRECT_USER	User portion of the target URI should be used as the target in the dialplan
AST_SIP_REDIRECT_URI_CORE	Target URI should be used as the target in the dialplan
AST_SIP_REDIRECT_URI_PJSIP	Target URI should be used as the target within chan_pjsip itself

Definition at line 744 of file res_pjsip.h.

                              {
    /*! User portion of the target URI should be used as the target in the dialplan */
    AST_SIP_REDIRECT_USER = 0,
    /*! Target URI should be used as the target in the dialplan */
    AST_SIP_REDIRECT_URI_CORE,
    /*! Target URI should be used as the target within chan_pjsip itself */
    AST_SIP_REDIRECT_URI_PJSIP,
};

ast_sip_session_refresh_method

enum ast_sip_session_refresh_method

Enumerator
AST_SIP_SESSION_REFRESH_METHOD_INVITE	Use reinvite to negotiate direct media
AST_SIP_SESSION_REFRESH_METHOD_UPDATE	Use UPDATE to negotiate direct media

Definition at line 713 of file res_pjsip.h.

                                    {
    /*! Use reinvite to negotiate direct media */
    AST_SIP_SESSION_REFRESH_METHOD_INVITE,
    /*! Use UPDATE to negotiate direct media */
    AST_SIP_SESSION_REFRESH_METHOD_UPDATE,
};

ast_sip_supplement_priority

enum ast_sip_supplement_priority

Enumerator
AST_SIP_SUPPLEMENT_PRIORITY_FIRST	Top priority. Supplements with this priority are those that need to run before any others
AST_SIP_SUPPLEMENT_PRIORITY_CHANNEL	Channel creation priority. chan_pjsip creates a channel at this priority. If your supplement depends on being run before or after channel creation, then set your priority to be lower or higher than this value.
AST_SIP_SUPPLEMENT_PRIORITY_LAST	Lowest priority. Supplements with this priority should be run after all other supplements

Definition at line 3332 of file res_pjsip.h.

                                 {
    /*! Top priority. Supplements with this priority are those that need to run before any others */
    AST_SIP_SUPPLEMENT_PRIORITY_FIRST = 0,
    /*! Channel creation priority.
     * chan_pjsip creates a channel at this priority. If your supplement depends on being run before
     * or after channel creation, then set your priority to be lower or higher than this value.
     */
    AST_SIP_SUPPLEMENT_PRIORITY_CHANNEL = 1000000,
    /*! Lowest priority. Supplements with this priority should be run after all other supplements */
    AST_SIP_SUPPLEMENT_PRIORITY_LAST = INT_MAX,
};

ast_transport_monitor_reg

enum ast_transport_monitor_reg

Enumerator
AST_TRANSPORT_MONITOR_REG_SUCCESS	Successfully registered the transport monitor.
AST_TRANSPORT_MONITOR_REG_REPLACED	Replaced the already existing transport monitor with new one.
AST_TRANSPORT_MONITOR_REG_NOT_FOUND	Transport not found to monitor. Note Transport is either already shutdown or is not reliable.
AST_TRANSPORT_MONITOR_REG_FAILED	Error while registering transport monitor.

Definition at line 4104 of file res_pjsip.h.

                               {
    /*! \brief Successfully registered the transport monitor */
    AST_TRANSPORT_MONITOR_REG_SUCCESS,
    /*! \brief Replaced the already existing transport monitor with new one. */
    AST_TRANSPORT_MONITOR_REG_REPLACED,
    /*!
     * \brief Transport not found to monitor.
     * \note Transport is either already shutdown or is not reliable.
     */
    AST_TRANSPORT_MONITOR_REG_NOT_FOUND,
    /*! \brief Error while registering transport monitor. */
    AST_TRANSPORT_MONITOR_REG_FAILED,
};

pjsip_auth_algorithm_type

enum pjsip_auth_algorithm_type

Enumerator
PJSIP_AUTH_ALGORITHM_NOT_SET
PJSIP_AUTH_ALGORITHM_MD5
PJSIP_AUTH_ALGORITHM_SHA256
PJSIP_AUTH_ALGORITHM_SHA512_256
PJSIP_AUTH_ALGORITHM_AKAV1_MD5
PJSIP_AUTH_ALGORITHM_COUNT

Definition at line 606 of file res_pjsip.h.

{
    PJSIP_AUTH_ALGORITHM_NOT_SET = 0,
    PJSIP_AUTH_ALGORITHM_MD5,
    PJSIP_AUTH_ALGORITHM_SHA256,
    PJSIP_AUTH_ALGORITHM_SHA512_256,
    PJSIP_AUTH_ALGORITHM_AKAV1_MD5,
    PJSIP_AUTH_ALGORITHM_COUNT,
} pjsip_auth_algorithm_type;

Function Documentation

ast_copy_pj_str()

void ast_copy_pj_str	(	char *	dest,
		const pj_str_t *	src,
		size_t	size
	)

Copy a pj_str_t into a standard character buffer.

pj_str_t is not NULL-terminated. Any place that expects a NULL- terminated string needs to have the pj_str_t copied into a separate buffer.

This method copies the pj_str_t contents into the destination buffer and NULL-terminates the buffer.

Parameters

dest	The destination buffer
src	The pj_str_t to copy
size	The size of the destination buffer.

Definition at line 2201 of file res_pjsip.c.

{
    size_t chars_to_copy = MIN(size - 1, pj_strlen(src));
    memcpy(dest, pj_strbuf(src), chars_to_copy);
    dest[chars_to_copy] = '\0';
}

References MIN.

Referenced by apply_dtls_attrib(), apply_negotiated_sdp_stream(), apply_negotiated_sdp_stream(), assign_uuid(), ast_sip_get_transport_name(), ast_sip_header_to_security_mechanism(), ast_sip_report_auth_challenge_sent(), ast_sip_report_auth_failed_challenge_response(), chan_pjsip_get_uniqueid(), change_outgoing_sdp_stream_media_address(), change_outgoing_sdp_stream_media_address(), channel_read_pjsip(), cli_complete_subscription_common(), cli_list_subscriptions_detail(), cli_show_subscriptions_detail(), copy_string(), determine_sip_publish_type(), dialog_info_generate_body_content(), endpoint_lookup(), evaluate_like(), extract_contact_addr(), extract_contact_addr(), extract_oli(), find_aor2(), find_aor_name(), find_authorization(), get_auth_header(), get_codecs(), get_dest_tn(), get_destination(), get_endpoint_details(), get_from_header(), get_mid_bundle_group(), get_user_agent(), handle_incoming_request(), handle_incoming_sdp(), handle_negotiated_sdp_session_media(), handle_registration_response(), headers_to_vars(), incoming_in_dialog_request(), log_failed_request(), negotiate_incoming_sdp_stream(), negotiate_incoming_sdp_stream(), options_on_rx_request(), parse_uri_cb(), process_extmap_attributes(), process_ice_attributes(), process_ice_auth_attrb(), process_ssrc_attributes(), publish_request_initial(), pubsub_on_rx_publish_request(), pubsub_on_rx_subscribe_request(), refer_blind_callback(), refer_incoming_ari_request(), refer_incoming_blind_request(), refer_incoming_refer_request(), register_aor_core(), rfc3326_use_reason_header(), rfc3329_incoming_response(), rx_data_to_ast_msg(), save_response_fields_to_transport(), sdp_requires_deferral(), security_event_populate(), session_inv_on_redirected(), session_outgoing_nat_hook(), set_id_from_hdr(), set_mid_and_bundle_group(), set_redirecting_value(), set_remote_mslabel_and_stream_group(), set_sipdomain_variable(), sip_subscription_to_ami(), sub_persistence_recreate(), subscription_get_generator_from_rdata(), subscription_get_handler_from_rdata(), subscription_persistence_create(), subscription_persistence_update(), and transfer_refer().

ast_copy_pj_str2()

int ast_copy_pj_str2	(	char **	dest,
		const pj_str_t *	src
	)

Create and copy a pj_str_t into a standard character buffer.

pj_str_t is not NULL-terminated. Any place that expects a NULL- terminated string needs to have the pj_str_t copied into a separate buffer.

Copies the pj_str_t contents into a newly allocated buffer pointed to by dest. NULL-terminates the buffer.

Note

Caller is responsible for freeing the allocated memory.

Parameters

[out]	dest	The destination buffer
	src	The pj_str_t to copy

Returns

Number of characters copied or negative value on error

Definition at line 2208 of file res_pjsip.c.

{
    int res = ast_asprintf(dest, "%.*s", (int)pj_strlen(src), pj_strbuf(src));
 
    if (res < 0) {
        *dest = NULL;
    }
 
    return res;
}

References ast_asprintf, and NULL.

ast_pjsip_rdata_get_endpoint()

struct ast_sip_endpoint * ast_pjsip_rdata_get_endpoint

(

pjsip_rx_data *

rdata

)

Get the looked-up endpoint on an out-of dialog request or response.

The function may ONLY be called on out-of-dialog requests or responses. For in-dialog requests and responses, it is required that the user of the dialog has the looked-up endpoint stored locally.

This function should never return NULL if the message is out-of-dialog. It will always return NULL if the message is in-dialog.

This function will increase the reference count of the returned endpoint by one. Release your reference using the ao2_ref function when finished.

Parameters

rdata

Out-of-dialog request or response

Returns

The looked up endpoint

Definition at line 981 of file pjsip_distributor.c.

{
    struct ast_sip_endpoint *endpoint = rdata->endpt_info.mod_data[endpoint_mod.id];
    if (endpoint) {
        ao2_ref(endpoint, +1);
    }
    return endpoint;
}

References ao2_ref, and endpoint_mod.

Referenced by authenticate(), handle_new_invite_request(), nat_on_rx_message(), options_on_rx_request(), pubsub_on_rx_mwi_notify_request(), pubsub_on_rx_publish_request(), pubsub_on_rx_refresh(), pubsub_on_rx_subscribe_request(), registrar_on_rx_request(), rx_data_to_ast_msg(), send_options_response(), send_response(), and supplement_on_rx_request().

ast_sip_add_body()

int ast_sip_add_body	(	pjsip_tx_data *	tdata,
		const struct ast_sip_body *	body
	)

Add a body to an outbound SIP message.

If this is called multiple times, the latest body will replace the current body.

Parameters

tdata	The message to add the body to
body	The message body to add

Return values

0	Success
-1	Failure

Definition at line 2052 of file res_pjsip.c.

{
    pjsip_msg_body *pjsip_body = ast_body_to_pjsip_body(tdata->pool, body);
    tdata->msg->body = pjsip_body;
    return 0;
}

References ast_body_to_pjsip_body().

Referenced by aoc_bye_outgoing_request(), aoc_bye_outgoing_response(), aoc_send_as_xml(), build_notify_body(), msg_send(), send_unsolicited_mwi_notify_to_contact(), sendtext(), sip_publisher_service_queue(), transmit_info_dtmf(), and transmit_info_with_vidupdate().

ast_sip_add_body_multipart()

int ast_sip_add_body_multipart	(	pjsip_tx_data *	tdata,
		const struct ast_sip_body *	bodies[],
		int	num_bodies
	)

Add a multipart body to an outbound SIP message.

This will treat each part of the input vector as part of a multipart body and add each part to the SIP message.

Parameters

tdata	The message to add the body to
bodies	The message bodies to add
num_bodies	The parts of the body to add

Return values

0	Success
-1	Failure

Definition at line 2059 of file res_pjsip.c.

{
    int i;
    /* NULL for type and subtype automatically creates "multipart/mixed" */
    pjsip_msg_body *body = pjsip_multipart_create(tdata->pool, NULL, NULL);
 
    for (i = 0; i < num_bodies; ++i) {
        pjsip_multipart_part *part = pjsip_multipart_create_part(tdata->pool);
        part->body = ast_body_to_pjsip_body(tdata->pool, bodies[i]);
        pjsip_multipart_add_part(tdata->pool, body, part);
    }
 
    tdata->msg->body = body;
    return 0;
}

References ast_body_to_pjsip_body(), and NULL.

ast_sip_add_date_header()

void ast_sip_add_date_header

(

pjsip_tx_data *

tdata

)

Adds a Date header to the tdata, formatted like: Date: Wed, 01 Jan 2021 14:53:01 GMT.

Since

16.19.0

Note

There is no checking done to see if the header already exists before adding it. It's up to the caller of this function to determine if that needs to be done or not.

Definition at line 90 of file res_pjsip.c.

{
    char date[256];
    struct tm tm;
    time_t t = time(NULL);
 
    gmtime_r(&t, &tm);
    strftime(date, sizeof(date), "%a, %d %b %Y %T GMT", &tm);
 
    ast_sip_add_header(tdata, "Date", date);
}

References ast_sip_add_header(), and NULL.

Referenced by add_date_header(), and register_aor_core().

ast_sip_add_global_request_header()

int ast_sip_add_global_request_header	(	const char *	name,
		const char *	value,
		int	replace
	)

Definition at line 153 of file pjsip_global_headers.c.

{
    return add_header(&request_headers, name, value, replace);
}

References add_header(), name, replace(), request_headers, and value.

Referenced by global_apply().

ast_sip_add_global_response_header()

int ast_sip_add_global_response_header	(	const char *	name,
		const char *	value,
		int	replace
	)

Definition at line 158 of file pjsip_global_headers.c.

{
    return add_header(&response_headers, name, value, replace);
}

References add_header(), name, replace(), response_headers, and value.

Referenced by global_apply().

ast_sip_add_header()

int ast_sip_add_header	(	pjsip_tx_data *	tdata,
		const char *	name,
		const char *	value
	)

Add a header to an outbound SIP message.

Parameters

tdata	The message to add the header to
name	The header name
value	The header value

Return values

0	Success
-1	Failure

Definition at line 2008 of file res_pjsip.c.

{
    pj_str_t hdr_name;
    pj_str_t hdr_value;
    pjsip_generic_string_hdr *hdr;
 
    pj_cstr(&hdr_name, name);
    pj_cstr(&hdr_value, value);
 
    hdr = pjsip_generic_string_hdr_create(tdata->pool, &hdr_name, &hdr_value);
 
    pjsip_msg_add_hdr(tdata->msg, (pjsip_hdr *) hdr);
    return 0;
}

References name, and value.

Referenced by add_header_from_channel_var(), add_headers_to_message(), ast_sip_add_date_header(), ast_sip_add_security_headers(), ast_sip_message_apply_transport(), build_notify(), handle_outgoing_request(), notify_channel(), notify_contact(), notify_uri(), options_incoming_request(), rfc3326_add_reason_header(), send_options_response(), sip_publication_respond(), transfer_refer(), vars_to_headers(), and vars_to_headers().

ast_sip_add_header2()

pjsip_generic_string_hdr * ast_sip_add_header2	(	pjsip_tx_data *	tdata,
		const char *	name,
		const char *	value
	)

Add a header to an outbound SIP message, returning a pointer to the header.

Parameters

tdata	The message to add the header to
name	The header name
value	The header value

Returns

The pjsip_generic_string_hdr * added.

Definition at line 2023 of file res_pjsip.c.

{
    pj_str_t hdr_name;
    pj_str_t hdr_value;
    pjsip_generic_string_hdr *hdr;
 
    pj_cstr(&hdr_name, name);
    pj_cstr(&hdr_value, value);
 
    hdr = pjsip_generic_string_hdr_create(tdata->pool, &hdr_name, &hdr_value);
 
    pjsip_msg_add_hdr(tdata->msg, (pjsip_hdr *) hdr);
    return hdr;
}

References name, and value.

Referenced by handle_outgoing_request().

ast_sip_add_security_headers()

int ast_sip_add_security_headers	(	struct ast_sip_security_mechanism_vector *	security_mechanisms,
		const char *	header_name,
		int	add_qval,
		pjsip_tx_data *	tdata
	)

Add security headers to transmission data.

Parameters

security_mechanisms	Vector of security mechanisms.
header_name	The header name under which to add the security mechanisms. One of Security-Client, Security-Server, Security-Verify.
add_qval	If zero, don't add the q-value to the header.
tdata	The transmission data.

Return values

0	Success
non-zero	Failure

Definition at line 290 of file security_agreements.c.

                                                                     {
    struct ast_sip_security_mechanism *mech;
    char *buf;
    int mech_cnt;
    int i;
    int add_qvalue = 1;
    static const pj_str_t proxy_require = { "Proxy-Require", 13 };
    static const pj_str_t require = { "Require", 7 };
 
    if (!security_mechanisms || !tdata) {
        return EINVAL;
    }
 
    if (!strcmp(header_name, "Security-Client")) {
        add_qvalue = 0;
    } else if (strcmp(header_name, "Security-Server") &&
            strcmp(header_name, "Security-Verify")) {
        return EINVAL;
    }
    /* If we're adding Security-Client headers, don't add q-value
     * even if the function caller requested it. */
    add_qvalue = add_qvalue && add_qval;
 
    mech_cnt = AST_VECTOR_SIZE(security_mechanisms);
    for (i = 0; i < mech_cnt; ++i) {
        mech = AST_VECTOR_GET(security_mechanisms, i);
        if (security_mechanism_to_str(mech, add_qvalue, &buf)) {
            continue;
        }
        ast_sip_add_header(tdata, header_name, buf);
        ast_free(buf);
    }
 
    if (pjsip_msg_find_hdr_by_name(tdata->msg, &require, NULL) == NULL) {
        ast_sip_add_header(tdata, "Require", "mediasec");
    }
    if (pjsip_msg_find_hdr_by_name(tdata->msg, &proxy_require, NULL) == NULL) {
        ast_sip_add_header(tdata, "Proxy-Require", "mediasec");
    }
    return 0;
}

References ast_free, ast_sip_add_header(), AST_VECTOR_GET, AST_VECTOR_SIZE, buf, NULL, and security_mechanism_to_str().

Referenced by add_outgoing_request_headers(), and add_security_headers().

ast_sip_add_usereqphone()

void ast_sip_add_usereqphone	(	const struct ast_sip_endpoint *	endpoint,
		pj_pool_t *	pool,
		pjsip_uri *	uri
	)

Add 'user=phone' parameter to URI if enabled and user is a phone number.

Parameters

endpoint	The endpoint to use for configuration
pool	The memory pool to allocate the parameter from
uri	The URI to check for user and to add parameter to

Definition at line 930 of file res_pjsip.c.

{
    pjsip_sip_uri *sip_uri;
    int i = 0;
    static const pj_str_t STR_PHONE = { "phone", 5 };
 
    if (!endpoint || !endpoint->usereqphone || (!PJSIP_URI_SCHEME_IS_SIP(uri) && !PJSIP_URI_SCHEME_IS_SIPS(uri))) {
        return;
    }
 
    sip_uri = pjsip_uri_get_uri(uri);
 
    if (!pj_strlen(&sip_uri->user)) {
        return;
    }
 
    if (pj_strbuf(&sip_uri->user)[0] == '+') {
        i = 1;
    }
 
    /* Test URI user against allowed characters in AST_DIGIT_ANY */
    for (; i < pj_strlen(&sip_uri->user); i++) {
        if (!strchr(AST_DIGIT_ANY, pj_strbuf(&sip_uri->user)[i])) {
            break;
        }
    }
 
    if (i < pj_strlen(&sip_uri->user)) {
        return;
    }
 
    sip_uri->user_param = STR_PHONE;
}

References AST_DIGIT_ANY, and ast_sip_endpoint::usereqphone.

Referenced by ast_sip_create_dialog_uac(), create_out_of_dialog_request(), and set_from_header().

ast_sip_append_body()

int ast_sip_append_body	(	pjsip_tx_data *	tdata,
		const char *	body_text
	)

Append body data to a SIP message.

This acts mostly the same as ast_sip_add_body, except that rather than replacing a body if it currently exists, it appends data to an existing body.

Parameters

tdata	The message to append the body to
body_text	The string to append to the end of the current body

Return values

0	Success
-1	Failure

Definition at line 2075 of file res_pjsip.c.

{
    size_t combined_size = strlen(body_text) + tdata->msg->body->len;
    struct ast_str *body_buffer = ast_str_alloca(combined_size);
 
    ast_str_set(&body_buffer, 0, "%.*s%s", (int) tdata->msg->body->len, (char *) tdata->msg->body->data, body_text);
 
    tdata->msg->body->data = pj_pool_alloc(tdata->pool, combined_size);
    pj_memcpy(tdata->msg->body->data, ast_str_buffer(body_buffer), combined_size);
    tdata->msg->body->len = combined_size;
 
    return 0;
}

References ast_str_alloca, ast_str_buffer(), and ast_str_set().

ast_sip_are_media_types_equal()

int ast_sip_are_media_types_equal	(	pjsip_media_type *	a,
		pjsip_media_type *	b
	)

Compare pjsip media types.

Parameters

a	the first media type
b	the second media type

Return values

1	Media types are equal
0	Media types are not equal

Definition at line 2219 of file res_pjsip.c.

{
    int rc = 0;
    if (a != NULL && b != NULL) {
        rc = pjsip_media_type_cmp(a, b, 0) ? 0 : 1;
    }
    return rc;
}

References a, b, and NULL.

Referenced by find_pidf(), and video_info_incoming_request().

ast_sip_auth_digest_algorithms_vector_init()

int ast_sip_auth_digest_algorithms_vector_init	(	const char *	id,
		struct pjsip_auth_algorithm_type_vector *	algorithms,
		const char *	agent_type,
		const char *	value
	)

Populate a vector of algorithm types from a string.

Parameters

id	The object id to use in error messages
algorithms	The initialized but empty vector to populate
agent_type	The type of agent to use in error messages ("UAC" or "UAS")
value	The comma-separated string to parse for algorithms

Return values

0	Success
non-zero	Failure

Definition at line 192 of file config_auth.c.

{
    char *iana_names = ast_strdupa(value);
    pj_str_t val;
    int res = 0;
 
    ast_assert(algorithms != NULL);
 
    while ((val.ptr = ast_strip(strsep(&iana_names, ",")))) {
        const pjsip_auth_algorithm *algo;
 
        if (ast_strlen_zero(val.ptr)) {
            continue;
        }
        val.slen = strlen(val.ptr);
 
        algo = ast_sip_auth_get_algorithm_by_iana_name(&val);
        if (!algo) {
            ast_log(LOG_WARNING, "%s: Unknown %s digest algorithm '%s' specified\n",
                id, agent_type, val.ptr);
            res = -1;
            continue;
        }
        if (!ast_sip_auth_is_algorithm_supported(algo->algorithm_type)) {
            ast_log(LOG_WARNING, "%s: %s digest algorithm '%s' is not supported by the version of OpenSSL in use\n",
                id, agent_type, val.ptr);
            res = -1;
            continue;
        }
 
        if (AST_VECTOR_APPEND(algorithms, algo->algorithm_type)) {
            AST_VECTOR_FREE(algorithms);
            return -1;
        }
    }
    return res;
}

References agent_type, pjsip_auth_algorithm::algorithm_type, ast_assert, ast_log, ast_sip_auth_get_algorithm_by_iana_name(), ast_sip_auth_is_algorithm_supported(), ast_strdupa, ast_strip(), ast_strlen_zero(), AST_VECTOR_APPEND, AST_VECTOR_FREE, LOG_WARNING, NULL, strsep(), and value.

Referenced by alloc_artificial_auth(), auth_apply(), global_apply(), uac_algorithms_handler(), and uas_algorithms_handler().

ast_sip_auth_digest_algorithms_vector_to_str()

int ast_sip_auth_digest_algorithms_vector_to_str	(	const struct pjsip_auth_algorithm_type_vector *	algorithms,
		char **	buf
	)

Dump a vector of algorithm types to a string.

Parameters

	algorithms	The vector to dump
[out]	buf	Pointer to the buffer to dump the algorithms to Must be freed by the caller.

Return values

0	Success
non-zero	Failure

Definition at line 248 of file config_auth.c.

{
    struct ast_str *str = NULL;
    int i = 0;
 
    if (!algorithms || !AST_VECTOR_SIZE(algorithms)) {
        return 0;
    }
 
    str = ast_str_alloca(256);
    if (!str) {
        return -1;
    }
 
    for (i = 0; i < AST_VECTOR_SIZE(algorithms); ++i) {
        const pjsip_auth_algorithm *algo = ast_sip_auth_get_algorithm_by_type(
            AST_VECTOR_GET(algorithms, i));
        ast_str_append(&str, 0, "%s" PJSTR_PRINTF_SPEC, i > 0 ? "," : "",
            PJSTR_PRINTF_VAR(algo->iana_name));
    }
 
    *buf = ast_strdup(ast_str_buffer(str));
 
    return *buf ? 0 : -1;
}

References ast_sip_auth_get_algorithm_by_type(), ast_str_alloca, ast_str_append(), ast_str_buffer(), ast_strdup, AST_VECTOR_GET, AST_VECTOR_SIZE, buf, pjsip_auth_algorithm::iana_name, NULL, PJSTR_PRINTF_SPEC, PJSTR_PRINTF_VAR, and str.

Referenced by uac_algorithms_to_str(), and uas_algorithms_to_str().

ast_sip_auth_get_algorithm_by_iana_name()

const pjsip_auth_algorithm * ast_sip_auth_get_algorithm_by_iana_name

(

const pj_str_t *

iana_name

)

Get algorithm by IANA name.

Parameters

iana_name

The algorithm IANA name

Return values

The	algorithm or NULL if not found

Definition at line 83 of file config_auth.c.

{
#ifdef HAVE_PJSIP_AUTH_NEW_DIGESTS
    return pjsip_auth_get_algorithm_by_iana_name(iana_name);
#else
    if (!iana_name) {
        return NULL;
    }
    /*
     * If we don't have a pjproject with the new algorithms, the
     * only one we support is MD5.  If iana_name is empty (but not NULL),
     * the default is MD5.
     */
    if (iana_name->slen == 0 || pj_stricmp2(iana_name, "MD5") == 0) {
        return &pjsip_auth_algorithms[PJSIP_AUTH_ALGORITHM_MD5];
    }
    return NULL;
#endif
}

References NULL, PJSIP_AUTH_ALGORITHM_MD5, and pjsip_auth_algorithms.

Referenced by ast_sip_auth_digest_algorithms_vector_init(), digest_lookup(), get_supported_algorithm(), and password_digest_handler().

ast_sip_auth_get_algorithm_by_type()

const pjsip_auth_algorithm * ast_sip_auth_get_algorithm_by_type

(

pjsip_auth_algorithm_type

algorithm_type

)

Get algorithm by algorithm type.

Parameters

algorithm_type

The algorithm type

Return values

The	algorithm or NULL if not found

Definition at line 66 of file config_auth.c.

{
#ifdef HAVE_PJSIP_AUTH_NEW_DIGESTS
    return pjsip_auth_get_algorithm_by_type(algorithm_type);
#else
    /*
     * If we don't have a pjproject with the new algorithms, the
     * only one we support is MD5.
     */
    if (algorithm_type == PJSIP_AUTH_ALGORITHM_MD5) {
        return &pjsip_auth_algorithms[algorithm_type];
    }
    return NULL;
#endif
}

References NULL, PJSIP_AUTH_ALGORITHM_MD5, and pjsip_auth_algorithms.

Referenced by ast_sip_auth_digest_algorithms_vector_to_str(), check_algorithm(), digest_check_auth(), and password_digest_to_str().

ast_sip_auth_get_creds()

const char * ast_sip_auth_get_creds	(	const struct ast_sip_auth *	auth,
		const pjsip_auth_algorithm_type	algorithm_type,
		int *	cred_type
	)

Get the plain text or digest password from an auth object.

Parameters

auth	The auth object
algorithm_type	The algorithm type to retrieve the password for
cred_type	[out]Pointer to an int to receive the credential type

Note

cred_type will contain one of the following values:

• PJSIP_CRED_DATA_DIGEST
• PJSIP_CRED_DATA_PLAIN_PASSWD

If a password digest is available for the algorithm type it will be returned, otherwise if a plain text password is available that will be returned instead.

Return values

The	plain text or digest password or NULL if not found for the algorithm type

Definition at line 407 of file config_auth.c.

{
    struct ast_sip_auth_password_digest *pw_digest =
        auth->password_digests[algorithm_type];
 
    if (pw_digest) {
        *cred_type = PJSIP_CRED_DATA_DIGEST;
        return pw_digest->digest;
    }
 
    *cred_type = PJSIP_CRED_DATA_PLAIN_PASSWD;
    return auth->auth_pass;
}

References ast_sip_auth_password_digest::algorithm_type, ast_sip_auth::auth_pass, ast_sip_auth_password_digest::digest, and ast_sip_auth::password_digests.

Referenced by digest_lookup(), and get_creds_for_header().

ast_sip_auth_is_algorithm_available()

int ast_sip_auth_is_algorithm_available	(	const struct ast_sip_auth *	auth,
		const struct pjsip_auth_algorithm_type_vector *	algorithms,
		pjsip_auth_algorithm_type	algorithm_type
	)

Checks an pjsip_auth_algorithm_type_vector to see if it contains an algorithm.

Parameters

auth	The auth object
algorithms	The auth object's supported_algorithms_uac or supported_algorithms_uas
algorithm_type	The algorithm_type to check

Return values

1	The algorithm-type is in the vector
0	The algorithm-type is not in the vector

Definition at line 386 of file config_auth.c.

{
    int i;
 
    if (!algorithms) {
        return 0;
    }
 
    for (i = 0; i < AST_VECTOR_SIZE(algorithms); ++i) {
        if (AST_VECTOR_GET(algorithms, i) == algorithm_type) {
            if (auth->password_digests[algorithm_type] || !ast_strlen_zero(auth->auth_pass)) {
                return 1;
            }
        }
    }
 
    return 0;
}

References ast_strlen_zero(), AST_VECTOR_GET, AST_VECTOR_SIZE, ast_sip_auth::auth_pass, and ast_sip_auth::password_digests.

Referenced by digest_lookup(), and get_creds_for_header().

ast_sip_auth_is_algorithm_supported()

pj_bool_t ast_sip_auth_is_algorithm_supported

(

pjsip_auth_algorithm_type

algorithm_type

)

Is algorithm supported by OpenSSL and pjproject?

Parameters

algorithm_type

The algorithm IANA name

Return values

The	algorithm or NULL if not found

Definition at line 104 of file config_auth.c.

{
#ifdef HAVE_PJSIP_AUTH_NEW_DIGESTS
    return pjsip_auth_is_algorithm_supported(algorithm_type);
#else
    return algorithm_type == PJSIP_AUTH_ALGORITHM_MD5;
#endif
}

References PJSIP_AUTH_ALGORITHM_MD5.

Referenced by ast_sip_auth_digest_algorithms_vector_init(), get_supported_algorithm(), and password_digest_handler().

ast_sip_auth_type_to_str()

const char * ast_sip_auth_type_to_str

(

enum ast_sip_auth_type

type

)

Converts the given auth type to a string.

Parameters

type	the auth type to convert

Return values

a	string representative of the auth type

Definition at line 179 of file config_auth.c.

{
    return ARRAY_IN_BOUNDS(type, auth_types_map) ?
        auth_types_map[type] : "";
}

References ARRAY_IN_BOUNDS, auth_types_map, and type.

Referenced by auth_type_to_str().

ast_sip_auth_vector_destroy()

void ast_sip_auth_vector_destroy

(

struct ast_sip_auth_vector *

vector

)

Free contents of an auth vector.

Parameters

vector

Vector whose contents are to be freed

Definition at line 306 of file pjsip_configuration.c.

{
    int i;
    size_t size;
 
    if (!auths) {
        return;
    }
 
    size = AST_VECTOR_SIZE(auths);
 
    for (i = 0; i < size; ++i) {
        const char *name = AST_VECTOR_REMOVE_UNORDERED(auths, 0);
        ast_free((char *) name);
    }
    AST_VECTOR_FREE(auths);
}

References ast_free, AST_VECTOR_FREE, AST_VECTOR_REMOVE_UNORDERED, AST_VECTOR_SIZE, and name.

Referenced by ast_sip_auth_vector_init(), endpoint_destructor(), handle_client_state_destruction(), sip_outbound_publish_destroy(), sip_outbound_registration_destroy(), and sip_outbound_registration_perform().

ast_sip_auth_vector_init()

int ast_sip_auth_vector_init	(	struct ast_sip_auth_vector *	vector,
		const char *	auth_names
	)

Initialize an auth vector with the configured values.

Parameters

vector	Vector to initialize
auth_names	Comma-separated list of names to set in the array

Return values

0	Success
non-zero	Failure

Definition at line 324 of file pjsip_configuration.c.

{
    char *auth_names = ast_strdupa(value);
    char *val;
 
    ast_assert(auths != NULL);
 
    if (AST_VECTOR_SIZE(auths)) {
        ast_sip_auth_vector_destroy(auths);
    }
    if (AST_VECTOR_INIT(auths, 1)) {
        return -1;
    }
 
    while ((val = ast_strip(strsep(&auth_names, ",")))) {
        if (ast_strlen_zero(val)) {
            continue;
        }
 
        val = ast_strdup(val);
        if (!val) {
            goto failure;
        }
        if (AST_VECTOR_APPEND(auths, val)) {
            ast_free(val);
 
            goto failure;
        }
    }
    return 0;
 
failure:
    ast_sip_auth_vector_destroy(auths);
    return -1;
}

References ast_assert, ast_free, ast_sip_auth_vector_destroy(), ast_strdup, ast_strdupa, ast_strip(), ast_strlen_zero(), AST_VECTOR_APPEND, AST_VECTOR_INIT, AST_VECTOR_SIZE, NULL, strsep(), and value.

Referenced by inbound_auth_handler(), outbound_auth_handler(), outbound_auth_handler(), and outbound_auth_handler().

ast_sip_auths_to_str()

int ast_sip_auths_to_str	(	const struct ast_sip_auth_vector *	auths,
		char **	buf
	)

Converts an auths array to a string of comma separated values.

Parameters

auths	an auth array
buf	the string buffer to write the object data

Return values

0	Success, non-zero on failure

Definition at line 374 of file pjsip_configuration.c.

{
    if (!auths || !AST_VECTOR_SIZE(auths)) {
        return 0;
    }
 
    if (!(*buf = ast_calloc(MAX_OBJECT_FIELD, sizeof(char)))) {
        return -1;
    }
 
    /* I feel like accessing the vector's elem array directly is cheating...*/
    ast_join_delim(*buf, MAX_OBJECT_FIELD, auths->elems, AST_VECTOR_SIZE(auths), ',');
    return 0;
}

References ast_calloc, ast_join_delim(), AST_VECTOR_SIZE, buf, ast_sip_auth_vector::elems, and MAX_OBJECT_FIELD.

Referenced by format_str_append_auth(), inbound_auths_to_str(), outbound_auths_to_str(), and outbound_auths_to_str().

ast_sip_call_codec_pref_to_str()

const char * ast_sip_call_codec_pref_to_str

(

struct ast_flags

pref

)

Convert the call codec preference flags to a string.

Since

18.0.0

Parameters

pref	the call codec preference setting

Returns

a constant string with either the setting value or 'unknown'

Note

Don't try to free the string!

Definition at line 2554 of file res_pjsip.c.

{
    const char *value;
 
    if (ast_sip_call_codec_pref_test(pref, LOCAL) &&  ast_sip_call_codec_pref_test(pref, INTERSECT) && ast_sip_call_codec_pref_test(pref, ALL)) {
        value = "local";
    } else if (ast_sip_call_codec_pref_test(pref, LOCAL) &&  ast_sip_call_codec_pref_test(pref, UNION) && ast_sip_call_codec_pref_test(pref, ALL)) {
        value = "local_merge";
    } else if (ast_sip_call_codec_pref_test(pref, LOCAL) &&  ast_sip_call_codec_pref_test(pref, INTERSECT) && ast_sip_call_codec_pref_test(pref, FIRST)) {
        value = "local_first";
    } else if (ast_sip_call_codec_pref_test(pref, REMOTE) &&  ast_sip_call_codec_pref_test(pref, INTERSECT) && ast_sip_call_codec_pref_test(pref, ALL)) {
        value = "remote";
    } else if (ast_sip_call_codec_pref_test(pref, REMOTE) &&  ast_sip_call_codec_pref_test(pref, UNION) && ast_sip_call_codec_pref_test(pref, ALL)) {
        value = "remote_merge";
    } else if (ast_sip_call_codec_pref_test(pref, REMOTE) &&  ast_sip_call_codec_pref_test(pref, UNION) && ast_sip_call_codec_pref_test(pref, FIRST)) {
        value = "remote_first";
    } else {
        value = "unknown";
    }
 
    return value;
}

References ast_sip_call_codec_pref_test, and value.

Referenced by incoming_call_offer_pref_to_str(), log_caps(), and outgoing_call_offer_pref_to_str().

ast_sip_call_codec_str_to_pref()

int ast_sip_call_codec_str_to_pref	(	struct ast_flags *	pref,
		const char *	pref_str,
		int	is_outgoing
	)

Convert a call codec preference string to preference flags.

Since

18.0.0

Parameters

pref	A pointer to an ast_flags structure to receive the preference flags
pref_str	The call codec preference setting string
is_outgoing	Is for outgoing calls?

Return values

0	The string was parsed successfully
-1	The string option was invalid

Definition at line 2577 of file res_pjsip.c.

{
    pref->flags = 0;
 
    if (strcmp(pref_str, "local") == 0) {
        ast_set_flag(pref, AST_SIP_CALL_CODEC_PREF_LOCAL | AST_SIP_CALL_CODEC_PREF_INTERSECT | AST_SIP_CALL_CODEC_PREF_ALL);
    } else if (is_outgoing && strcmp(pref_str, "local_merge") == 0) {
        ast_set_flag(pref, AST_SIP_CALL_CODEC_PREF_LOCAL | AST_SIP_CALL_CODEC_PREF_UNION | AST_SIP_CALL_CODEC_PREF_ALL);
    } else if (strcmp(pref_str, "local_first") == 0) {
        ast_set_flag(pref, AST_SIP_CALL_CODEC_PREF_LOCAL | AST_SIP_CALL_CODEC_PREF_INTERSECT | AST_SIP_CALL_CODEC_PREF_FIRST);
    } else if (strcmp(pref_str, "remote") == 0) {
        ast_set_flag(pref, AST_SIP_CALL_CODEC_PREF_REMOTE | AST_SIP_CALL_CODEC_PREF_INTERSECT | AST_SIP_CALL_CODEC_PREF_ALL);
    } else if (is_outgoing && strcmp(pref_str, "remote_merge") == 0) {
        ast_set_flag(pref, AST_SIP_CALL_CODEC_PREF_REMOTE | AST_SIP_CALL_CODEC_PREF_UNION | AST_SIP_CALL_CODEC_PREF_ALL);
    } else if (strcmp(pref_str, "remote_first") == 0) {
        ast_set_flag(pref, AST_SIP_CALL_CODEC_PREF_REMOTE | AST_SIP_CALL_CODEC_PREF_UNION | AST_SIP_CALL_CODEC_PREF_FIRST);
    } else {
        return -1;
    }
 
    return 0;
}

References ast_set_flag, AST_SIP_CALL_CODEC_PREF_ALL, AST_SIP_CALL_CODEC_PREF_FIRST, AST_SIP_CALL_CODEC_PREF_INTERSECT, AST_SIP_CALL_CODEC_PREF_LOCAL, AST_SIP_CALL_CODEC_PREF_REMOTE, AST_SIP_CALL_CODEC_PREF_UNION, and ast_flags::flags.

Referenced by call_offer_pref_handler(), and test_create_joint().

ast_sip_check_authentication()

enum ast_sip_check_auth_result ast_sip_check_authentication	(	struct ast_sip_endpoint *	endpoint,
		pjsip_rx_data *	rdata,
		pjsip_tx_data *	tdata
	)

Method to determine authentication status of an incoming request.

This will call into a registered authenticator. The registered authenticator will do what is necessary to determine whether the incoming request passes authentication. A tentative response is passed into this function so that if, say, a digest authentication challenge should be sent in the ensuing response, it can be added to the response.

Parameters

endpoint	The endpoint from the request was sent
rdata	The request to potentially authenticate
tdata	Tentative response to the request

Returns

The result of checking authentication.

Definition at line 179 of file res_pjsip.c.

{
    if (!registered_authenticator) {
        ast_log(LOG_WARNING, "No SIP authenticator registered. Assuming authentication is successful\n");
        return AST_SIP_AUTHENTICATION_SUCCESS;
    }
    return registered_authenticator->check_authentication(endpoint, rdata, tdata);
}

References ast_log, AST_SIP_AUTHENTICATION_SUCCESS, ast_sip_authenticator::check_authentication, LOG_WARNING, and registered_authenticator.

Referenced by authenticate().

ast_sip_cleanup_auths()

void ast_sip_cleanup_auths	(	struct ast_sip_auth *	auths[],
		size_t	num_auths
	)

Clean up retrieved auth structures from memory.

Call this function once you have completed operating on auths retrieved from ast_sip_retrieve_auths

Parameters

auths	An array of auth object pointers to clean up
num_auths	The number of auths in the array

Definition at line 2544 of file pjsip_configuration.c.

{
    int i;
    for (i = 0; i < num_auths; ++i) {
        ao2_cleanup(auths[i]);
    }
}

References ao2_cleanup.

Referenced by digest_check_auth(), and set_outbound_initial_authentication_credentials().

ast_sip_contact_to_str()

int ast_sip_contact_to_str	(	void *	object,
		void *	arg,
		int	flags
	)

Handler used to convert a contact to a string.

Parameters

object	the ast_sip_aor_contact_pair containing a list of contacts to iterate and the contact
arg	user data passed to handler
flags

Return values

0	Success, non-zero on failure

Definition at line 771 of file location.c.

{
    struct ast_sip_contact_wrapper *wrapper = object;
    struct ast_str **buf = arg;
 
    ast_str_append(buf, 0, "%s,", wrapper->contact_id);
 
    return 0;
}

References ast_str_append(), buf, and ast_sip_contact_wrapper::contact_id.

Referenced by contacts_to_str(), sip_contact_to_str(), and sip_endpoints_aors_ami().

ast_sip_create_ami_event()

struct ast_str * ast_sip_create_ami_event	(	const char *	event,
		struct ast_sip_ami *	ami
	)

Creates a string to store AMI event data in.

Parameters

event	the event to set
ami	AMI session and message container

Return values

an	initialized ast_str or NULL on error.

Definition at line 1726 of file pjsip_configuration.c.

{
    struct ast_str *buf = ast_str_create(AMI_DEFAULT_STR_SIZE);
 
    if (!(buf)) {
        astman_send_error_va(ami->s, ami->m, "Unable create event "
                     "for %s\n", event);
        return NULL;
    }
 
    ast_str_set(&buf, 0, "Event: %s\r\n", event);
    if (!ast_strlen_zero(ami->action_id)) {
        ast_str_append(&buf, 0, "ActionID: %s\r\n", ami->action_id);
    }
    return buf;
}

References ast_sip_ami::action_id, AMI_DEFAULT_STR_SIZE, ast_str_append(), ast_str_create, ast_str_set(), ast_strlen_zero(), astman_send_error_va(), buf, ast_sip_ami::m, NULL, and ast_sip_ami::s.

Referenced by ami_outbound_registration_task(), ami_registrations_aor(), ami_subscription_detail(), ast_sip_format_contact_ami(), format_ami_aor_handler(), format_ami_aorlist_handler(), format_ami_auth_handler(), format_ami_authlist_handler(), format_ami_contactlist_handler(), format_ami_endpoint(), format_ami_endpoint_transport(), format_ami_endpoints(), format_ami_resource_lists(), and send_identify_ami_event().

ast_sip_create_dialog_uac()

pjsip_dialog * ast_sip_create_dialog_uac	(	const struct ast_sip_endpoint *	endpoint,
		const char *	aor_name,
		const char *	request_user
	)

General purpose method for creating a UAC dialog with an endpoint.

Parameters

endpoint	A pointer to the endpoint
aor_name	Optional name of the AOR to target, may even be an explicit SIP URI
request_user	Optional user to place into the target URI

Return values

non-NULL	success
NULL	failure

Definition at line 964 of file res_pjsip.c.

{
    char enclosed_uri[PJSIP_MAX_URL_SIZE];
    pj_str_t local_uri = { "sip:temp@temp", 13 }, remote_uri, target_uri;
    pj_status_t res;
    pjsip_dialog *dlg = NULL;
    const char *outbound_proxy = endpoint->outbound_proxy;
    pjsip_tpselector selector = { .type = PJSIP_TPSELECTOR_NONE, };
    static const pj_str_t HCONTACT = { "Contact", 7 };
 
    if (!ast_begins_with(uri, "<")) {
        snprintf(enclosed_uri, sizeof(enclosed_uri), "<%s>", uri);
    } else {
        snprintf(enclosed_uri, sizeof(enclosed_uri), "%s", uri);
    }
    pj_cstr(&remote_uri, enclosed_uri);
 
    pj_cstr(&target_uri, uri);
 
    res = pjsip_dlg_create_uac(pjsip_ua_instance(), &local_uri, NULL, &remote_uri, &target_uri, &dlg);
    if (res == PJ_SUCCESS && !(PJSIP_URI_SCHEME_IS_SIP(dlg->target) || PJSIP_URI_SCHEME_IS_SIPS(dlg->target))) {
        /* dlg->target is a pjsip_other_uri, but it's assumed to be a
         * pjsip_sip_uri below. Fail fast. */
        res = PJSIP_EINVALIDURI;
        pjsip_dlg_terminate(dlg);
    }
    if (res != PJ_SUCCESS) {
        if (res == PJSIP_EINVALIDURI) {
            ast_log(LOG_ERROR,
                "Endpoint '%s': Could not create dialog to invalid URI '%s'.  Is endpoint registered and reachable?\n",
                ast_sorcery_object_get_id(endpoint), uri);
        }
        return NULL;
    }
 
    /* We have to temporarily bump up the sess_count here so the dialog is not prematurely destroyed */
    dlg->sess_count++;
 
    ast_sip_dlg_set_transport(endpoint, dlg, &selector);
 
    if (sip_dialog_create_from(dlg->pool, &local_uri, endpoint->fromuser, endpoint->fromdomain, &remote_uri, &selector)) {
        dlg->sess_count--;
        pjsip_dlg_terminate(dlg);
        ast_sip_tpselector_unref(&selector);
        return NULL;
    }
 
    ast_sip_tpselector_unref(&selector);
 
    /* Update the dialog with the new local URI, we do it afterwards so we can use the dialog pool for construction */
    pj_strdup_with_null(dlg->pool, &dlg->local.info_str, &local_uri);
    dlg->local.info->uri = pjsip_parse_uri(dlg->pool, dlg->local.info_str.ptr, dlg->local.info_str.slen, 0);
    if (!dlg->local.info->uri) {
        ast_log(LOG_ERROR,
            "Could not parse URI '%s' for endpoint '%s'\n",
            dlg->local.info_str.ptr, ast_sorcery_object_get_id(endpoint));
        dlg->sess_count--;
        pjsip_dlg_terminate(dlg);
        return NULL;
    }
 
    dlg->local.contact = pjsip_parse_hdr(dlg->pool, &HCONTACT, local_uri.ptr, local_uri.slen, NULL);
 
    if (!ast_strlen_zero(endpoint->contact_user)) {
        pjsip_sip_uri *sip_uri;
 
        sip_uri = pjsip_uri_get_uri(dlg->local.contact->uri);
        pj_strdup2(dlg->pool, &sip_uri->user, endpoint->contact_user);
    }
 
    /* If a request user has been specified and we are permitted to change it, do so */
    if (!ast_strlen_zero(request_user)) {
        pjsip_sip_uri *sip_uri;
 
        if (PJSIP_URI_SCHEME_IS_SIP(dlg->target) || PJSIP_URI_SCHEME_IS_SIPS(dlg->target)) {
            sip_uri = pjsip_uri_get_uri(dlg->target);
            pj_strdup2(dlg->pool, &sip_uri->user, request_user);
        }
        if (PJSIP_URI_SCHEME_IS_SIP(dlg->remote.info->uri) || PJSIP_URI_SCHEME_IS_SIPS(dlg->remote.info->uri)) {
            sip_uri = pjsip_uri_get_uri(dlg->remote.info->uri);
            pj_strdup2(dlg->pool, &sip_uri->user, request_user);
        }
    }
 
    /* Add the user=phone parameter if applicable */
    ast_sip_add_usereqphone(endpoint, dlg->pool, dlg->target);
    ast_sip_add_usereqphone(endpoint, dlg->pool, dlg->remote.info->uri);
    ast_sip_add_usereqphone(endpoint, dlg->pool, dlg->local.info->uri);
 
    if (!ast_strlen_zero(outbound_proxy)) {
        pjsip_route_hdr route_set, *route;
        static const pj_str_t ROUTE_HNAME = { "Route", 5 };
        pj_str_t tmp;
 
        pj_list_init(&route_set);
 
        pj_strdup2_with_null(dlg->pool, &tmp, outbound_proxy);
        if (!(route = pjsip_parse_hdr(dlg->pool, &ROUTE_HNAME, tmp.ptr, tmp.slen, NULL))) {
            ast_log(LOG_ERROR, "Could not create dialog to endpoint '%s' as outbound proxy URI '%s' is not valid\n",
                ast_sorcery_object_get_id(endpoint), outbound_proxy);
            dlg->sess_count--;
            pjsip_dlg_terminate(dlg);
            return NULL;
        }
        pj_list_insert_nodes_before(&route_set, route);
 
        pjsip_dlg_set_route_set(dlg, &route_set);
    }
 
    dlg->sess_count--;
 
    return dlg;
}

References ast_begins_with(), ast_log, ast_sip_add_usereqphone(), ast_sip_dlg_set_transport(), ast_sip_tpselector_unref(), ast_sorcery_object_get_id(), ast_strlen_zero(), ast_sip_endpoint::contact_user, ast_sip_endpoint::fromdomain, ast_sip_endpoint::fromuser, ast_sip_endpoint::info, LOG_ERROR, NULL, ast_sip_endpoint::outbound_proxy, and sip_dialog_create_from().

Referenced by ast_sip_create_subscription(), ast_sip_session_create_outgoing(), and refer_send().

ast_sip_create_dialog_uas()

pjsip_dialog * ast_sip_create_dialog_uas	(	const struct ast_sip_endpoint *	endpoint,
		pjsip_rx_data *	rdata,
		pj_status_t *	status
	)

General purpose method for creating a UAS dialog with an endpoint.

Deprecated:

This function is unsafe (due to the returned object not being locked nor having its reference incremented) and should no longer be used. Instead use ast_sip_create_dialog_uas_locked so a properly locked and referenced object is returned.

Parameters

	endpoint	A pointer to the endpoint
	rdata	The request that is starting the dialog
[out]	status	On failure, the reason for failure in creating the dialog

Definition at line 1176 of file res_pjsip.c.

{
#ifdef HAVE_PJSIP_DLG_CREATE_UAS_AND_INC_LOCK
    pjsip_dialog *dlg;
 
    dlg = create_dialog_uas(endpoint, rdata, status, pjsip_dlg_create_uas_and_inc_lock);
    if (dlg) {
        pjsip_dlg_dec_lock(dlg);
    }
 
    return dlg;
#else
    return create_dialog_uas(endpoint, rdata, status, pjsip_dlg_create_uas);
#endif
}

References create_dialog_uas(), and status.

ast_sip_create_dialog_uas_locked()

pjsip_dialog * ast_sip_create_dialog_uas_locked	(	const struct ast_sip_endpoint *	endpoint,
		pjsip_rx_data *	rdata,
		pj_status_t *	status
	)

General purpose method for creating a UAS dialog with an endpoint.

This function creates and returns a locked, and referenced counted pjsip dialog object. The caller is thus responsible for freeing the allocated memory, decrementing the reference, and releasing the lock when done with the returned object.

Note

The safest way to unlock the object, and decrement its reference is by calling pjsip_dlg_dec_lock. Alternatively, pjsip_dlg_dec_session can be used to decrement the reference only.

The dialog is returned locked and with a reference in order to ensure that the dialog object, and any of its associated objects (e.g. transaction) are not untimely destroyed. For instance, that could happen when a transport error occurs.

As long as the caller maintains a reference to the dialog there should be no worry that it might unknowingly be destroyed. However, once the caller unlocks the dialog there is a danger that some of the dialog's internal objects could be lost and/or compromised. For example, when the aforementioned transport error occurs the dialog's associated transaction gets destroyed (see pjsip_dlg_on_tsx_state in sip_dialog.c, and mod_inv_on_tsx_state in sip_inv.c).

In this case and before using the dialog again the caller should re-lock the dialog, check to make sure the dialog is still established, and the transaction still exists and has not been destroyed.

Parameters

	endpoint	A pointer to the endpoint
	rdata	The request that is starting the dialog
[out]	status	On failure, the reason for failure in creating the dialog

Return values

A	locked, and reference counted pjsip_dialog object.
NULL	on failure

Definition at line 1192 of file res_pjsip.c.

{
#ifdef HAVE_PJSIP_DLG_CREATE_UAS_AND_INC_LOCK
    return create_dialog_uas(endpoint, rdata, status, pjsip_dlg_create_uas_and_inc_lock);
#else
    /*
     * This is put here in order to be compatible with older versions of pjproject.
     * Best we can do in this case is immediately lock after getting the dialog.
     * However, that does leave a "gap" between creating and locking.
     */
    pjsip_dialog *dlg;
 
    dlg = create_dialog_uas(endpoint, rdata, status, pjsip_dlg_create_uas);
    if (dlg) {
        pjsip_dlg_inc_lock(dlg);
    }
 
    return dlg;
#endif
 }

References create_dialog_uas(), and status.

Referenced by create_subscription_tree(), and pre_session_setup().

ast_sip_create_rdata()

int ast_sip_create_rdata	(	pjsip_rx_data *	rdata,
		char *	packet,
		const char *	src_name,
		int	src_port,
		char *	transport_type,
		const char *	local_name,
		int	local_port
	)

General purpose method for creating an rdata structure using specific information.

Parameters

[out]	rdata	The rdata structure that will be populated
	packet	A SIP message
	src_name	The source IP address of the message
	src_port	The source port of the message
	transport_type	The type of transport the message was received on
	local_name	The local IP address the message was received on
	local_port	The local port the message was received on

Return values

0	success
-1	failure

Definition at line 1266 of file res_pjsip.c.

{
    return ast_sip_create_rdata_with_contact(rdata, packet, src_name, src_port, transport_type,
        local_name, local_port, NULL);
}

References ast_sip_create_rdata_with_contact(), and NULL.

ast_sip_create_rdata_with_contact()

int ast_sip_create_rdata_with_contact	(	pjsip_rx_data *	rdata,
		char *	packet,
		const char *	src_name,
		int	src_port,
		char *	transport_type,
		const char *	local_name,
		int	local_port,
		const char *	contact_uri
	)

General purpose method for creating an rdata structure using specific information.

Since

13.15.0

Parameters

[out]	rdata	The rdata structure that will be populated
	packet	A SIP message
	src_name	The source IP address of the message
	src_port	The source port of the message
	transport_type	The type of transport the message was received on
	local_name	The local IP address the message was received on
	local_port	The local port the message was received on
	contact_uri	The contact URI of the message

Return values

0	success
-1	failure

Definition at line 1214 of file res_pjsip.c.

{
    pj_str_t tmp;
 
    /*
     * Initialize the error list in case there is a parse error
     * in the given packet.
     */
    pj_list_init(&rdata->msg_info.parse_err);
 
    rdata->tp_info.transport = PJ_POOL_ZALLOC_T(rdata->tp_info.pool, pjsip_transport);
    if (!rdata->tp_info.transport) {
        return -1;
    }
 
    ast_copy_string(rdata->pkt_info.packet, packet, sizeof(rdata->pkt_info.packet));
    ast_copy_string(rdata->pkt_info.src_name, src_name, sizeof(rdata->pkt_info.src_name));
    rdata->pkt_info.src_port = src_port;
    pj_sockaddr_parse(pj_AF_UNSPEC(), 0, pj_cstr(&tmp, src_name), &rdata->pkt_info.src_addr);
    pj_sockaddr_set_port(&rdata->pkt_info.src_addr, src_port);
 
    pjsip_parse_rdata(packet, strlen(packet), rdata);
    if (!rdata->msg_info.msg || !pj_list_empty(&rdata->msg_info.parse_err)) {
        return -1;
    }
 
    if (!ast_strlen_zero(contact)) {
        pjsip_contact_hdr *contact_hdr;
 
        contact_hdr = pjsip_msg_find_hdr(rdata->msg_info.msg, PJSIP_H_CONTACT, NULL);
        if (contact_hdr) {
            contact_hdr->uri = pjsip_parse_uri(rdata->tp_info.pool, (char *)contact,
                strlen(contact), PJSIP_PARSE_URI_AS_NAMEADDR);
            if (!contact_hdr->uri) {
                ast_log(LOG_WARNING, "Unable to parse contact URI from '%s'.\n", contact);
                return -1;
            }
        }
    }
 
    pj_strdup2(rdata->tp_info.pool, &rdata->msg_info.via->recvd_param, rdata->pkt_info.src_name);
    rdata->msg_info.via->rport_param = -1;
 
    rdata->tp_info.transport->key.type = pjsip_transport_get_type_from_name(pj_cstr(&tmp, transport_type));
    rdata->tp_info.transport->type_name = transport_type;
    pj_strdup2(rdata->tp_info.pool, &rdata->tp_info.transport->local_name.host, local_name);
    rdata->tp_info.transport->local_name.port = local_port;
 
    return 0;
}

References ast_copy_string(), ast_log, ast_strlen_zero(), LOG_WARNING, and NULL.

Referenced by ast_sip_create_rdata(), and subscription_persistence_recreate().

ast_sip_create_request()

int ast_sip_create_request	(	const char *	method,
		struct pjsip_dialog *	dlg,
		struct ast_sip_endpoint *	endpoint,
		const char *	uri,
		struct ast_sip_contact *	contact,
		pjsip_tx_data **	tdata
	)

General purpose method for creating a SIP request.

Its typical use would be to create one-off requests such as an out of dialog SIP MESSAGE.

The request can either be in- or out-of-dialog. If in-dialog, the dlg parameter MUST be present. If out-of-dialog the endpoint parameter MUST be present. If both are present, then we will assume that the message is to be sent in-dialog.

The uri parameter can be specified if the request should be sent to an explicit URI rather than one configured on the endpoint.

Parameters

	method	The method of the SIP request to send
	dlg	Optional. If specified, the dialog on which to request the message.
	endpoint	Optional. If specified, the request will be created out-of-dialog to the endpoint.
	uri	Optional. If specified, the request will be sent to this URI rather than one configured for the endpoint.
	contact	The contact with which this request is associated for out-of-dialog requests.
[out]	tdata	The newly-created request

The provided contact is attached to tdata with its reference bumped, but will not survive for the entire lifetime of tdata since the contact is cleaned up when all supplements have completed execution.

Return values

0	Success
-1	Failure

Definition at line 1435 of file res_pjsip.c.

{
    const pjsip_method *pmethod = get_pjsip_method(method);
 
    if (!pmethod) {
        ast_log(LOG_WARNING, "Unknown method '%s'. Cannot send request\n", method);
        return -1;
    }
 
    if (dlg) {
        return create_in_dialog_request(pmethod, dlg, tdata);
    } else {
        ast_assert(endpoint != NULL);
        return create_out_of_dialog_request(pmethod, endpoint, uri, contact, tdata);
    }
}

References ast_assert, ast_log, create_in_dialog_request(), create_out_of_dialog_request(), get_pjsip_method(), LOG_WARNING, method, NULL, and pmethod.

Referenced by aoc_send_as_xml(), msg_send(), notify_channel(), notify_contact(), notify_uri(), send_unsolicited_mwi_notify_to_contact(), sendtext(), sip_options_qualify_contact(), transmit_info_dtmf(), and transmit_info_with_vidupdate().

ast_sip_create_request_with_auth()

int ast_sip_create_request_with_auth	(	const struct ast_sip_auth_vector *	auths,
		pjsip_rx_data *	challenge,
		pjsip_tx_data *	tdata,
		pjsip_tx_data **	new_request
	)

Create a response to an authentication challenge.

This will call into an outbound authenticator's create_request_with_auth callback to create a new request with authentication credentials. See the create_request_with_auth callback in the ast_sip_outbound_authenticator structure for details about the parameters and return values.

Definition at line 214 of file res_pjsip.c.

{
    if (!registered_outbound_authenticator) {
        ast_log(LOG_WARNING, "No SIP outbound authenticator registered. Cannot respond to authentication challenge\n");
        return -1;
    }
    return registered_outbound_authenticator->create_request_with_auth(auths, challenge, old_request, new_request);
}

References ast_log, challenge(), ast_sip_outbound_authenticator::create_request_with_auth, LOG_WARNING, and registered_outbound_authenticator.

Referenced by check_request_status(), handle_registration_response(), outbound_invite_auth(), refer_client_on_evsub_state(), session_inv_on_tsx_state_changed(), and sip_outbound_publish_callback().

ast_sip_create_response()

int ast_sip_create_response	(	const pjsip_rx_data *	rdata,
		int	st_code,
		struct ast_sip_contact *	contact,
		pjsip_tx_data **	p_tdata
	)

General purpose method for creating a SIP response.

Its typical use would be to create responses for out of dialog requests.

Parameters

	rdata	The rdata from the incoming request.
	st_code	The response code to transmit.
	contact	The contact with which this request is associated.
[out]	p_tdata	The newly-created response

The provided contact is attached to tdata with its reference bumped, but will not survive for the entire lifetime of tdata since the contact is cleaned up when all supplements have completed execution.

Return values

0	Success
-1	Failure

Definition at line 2468 of file res_pjsip.c.

{
    int res = pjsip_endpt_create_response(ast_sip_get_pjsip_endpoint(), rdata, st_code, NULL, tdata);
 
    if (!res) {
        ast_sip_mod_data_set((*tdata)->pool, (*tdata)->mod_data, supplement_module.id, MOD_DATA_CONTACT, ao2_bump(contact));
    }
 
    return res;
}

References ao2_bump, ast_sip_get_pjsip_endpoint(), ast_sip_mod_data_set, MOD_DATA_CONTACT, NULL, and supplement_module.

Referenced by register_aor_core(), send_options_response(), and send_response().

ast_sip_default_outbound_endpoint()

struct ast_sip_endpoint * ast_sip_default_outbound_endpoint

(

void

)

Retrieve the default outbound endpoint.

Return values

The	default outbound endpoint, NULL if not found.

Definition at line 2520 of file pjsip_configuration.c.

{
    RAII_VAR(char *, name, ast_sip_global_default_outbound_endpoint(), ast_free);
    return ast_strlen_zero(name) ? NULL : ast_sorcery_retrieve_by_id(
        sip_sorcery, "endpoint", name);
}

References ast_free, ast_sip_global_default_outbound_endpoint(), ast_sorcery_retrieve_by_id(), ast_strlen_zero(), name, NULL, RAII_VAR, and sip_sorcery.

Referenced by ast_sip_get_endpoint(), handle_atsign(), handle_single_token(), and notify_uri().

ast_sip_dialog_setup_outbound_authentication()

int ast_sip_dialog_setup_outbound_authentication	(	pjsip_dialog *	dlg,
		const struct ast_sip_endpoint *	endpoint,
		ast_sip_dialog_outbound_auth_cb	cb,
		void *	user_data
	)

Set up outbound authentication on a SIP dialog.

This sets up the infrastructure so that all requests associated with a created dialog can be re-sent with authentication credentials if the original request is challenged.

Parameters

dlg	The dialog on which requests will be authenticated
endpoint	The endpoint whom this dialog pertains to
cb	Callback to call to send requests with authentication
user_data	Data to be provided to the callback when it is called

Return values

0	Success
-1	Failure

ast_sip_dict_get()

void * ast_sip_dict_get	(	void *	ht,
		const char *	key
	)

Retrieves the value associated with the given key.

Parameters

ht	the hash table/dictionary to search
key	the key to find

Return values

the	value associated with the key, NULL otherwise.

Definition at line 2327 of file res_pjsip.c.

{
    unsigned int hval = 0;
 
    if (!ht) {
        return NULL;
    }
 
    return pj_hash_get(ht, key, PJ_HASH_KEY_STRING, &hval);
}

References NULL.

ast_sip_dict_set()

void * ast_sip_dict_set	(	pj_pool_t *	pool,
		void *	ht,
		const char *	key,
		void *	val
	)

Set the value for the given key.

Note - if the hash table does not exist one is created first, the key/value pair is set, and the hash table returned.

Parameters

pool	the pool to allocate memory in
ht	the hash table/dictionary in which to store the key/value pair
key	the key to associate a value with
val	the value to associate with a key

Return values

the	given, or newly created, hash table.

Definition at line 2338 of file res_pjsip.c.

{
    if (!ht) {
        ht = pj_hash_create(pool, 11);
    }
 
    pj_hash_set(pool, ht, key, PJ_HASH_KEY_STRING, 0, val);
 
    return ht;
}

ast_sip_dlg_set_transport()

int ast_sip_dlg_set_transport	(	const struct ast_sip_endpoint *	endpoint,
		pjsip_dialog *	dlg,
		pjsip_tpselector *	selector
	)

Set the transport on a dialog.

Since

13.15.0

Parameters

endpoint
dlg
selector	(optional)

Note

This API calls ast_sip_get_transport_name(endpoint, dlg->target) and if the result is non-NULL, calls pjsip_dlg_set_transport. If 'selector' is non-NULL, it is updated with the selector used.

It is the responsibility of the caller to unref the passed in selector if one is provided.

Definition at line 727 of file res_pjsip.c.

{
    pjsip_sip_uri *uri;
    pjsip_tpselector sel = { .type = PJSIP_TPSELECTOR_NONE, };
 
    uri = pjsip_uri_get_uri(dlg->target);
    if (!selector) {
        selector = &sel;
    }
 
    ast_sip_set_tpselector_from_ep_or_uri(endpoint, uri, selector);
 
    pjsip_dlg_set_transport(dlg, selector);
 
    if (selector == &sel) {
        ast_sip_tpselector_unref(&sel);
    }
 
    return 0;
}

References ast_sip_set_tpselector_from_ep_or_uri(), and ast_sip_tpselector_unref().

Referenced by ast_sip_create_dialog_uac().

ast_sip_dtmf_to_str()

int ast_sip_dtmf_to_str	(	const enum ast_sip_dtmf_mode	dtmf,
		char *	buf,
		size_t	buf_len
	)

Convert the DTMF mode enum value into a string.

Since

13.18.0

Parameters

dtmf	the dtmf mode
buf	Buffer to receive dtmf mode string
buf_len	Buffer length

Return values

0	Success
-1	Failure

Definition at line 2504 of file res_pjsip.c.

{
    switch (dtmf) {
    case AST_SIP_DTMF_NONE:
        ast_copy_string(buf, "none", buf_len);
        break;
    case AST_SIP_DTMF_RFC_4733:
        ast_copy_string(buf, "rfc4733", buf_len);
        break;
    case AST_SIP_DTMF_INBAND:
        ast_copy_string(buf, "inband", buf_len);
        break;
    case AST_SIP_DTMF_INFO:
        ast_copy_string(buf, "info", buf_len);
        break;
    case AST_SIP_DTMF_AUTO:
        ast_copy_string(buf, "auto", buf_len);
        break;
    case AST_SIP_DTMF_AUTO_INFO:
        ast_copy_string(buf, "auto_info", buf_len);
        break;
    default:
        buf[0] = '\0';
        return -1;
    }
    return 0;
}

References ast_copy_string(), AST_SIP_DTMF_AUTO, AST_SIP_DTMF_AUTO_INFO, AST_SIP_DTMF_INBAND, AST_SIP_DTMF_INFO, AST_SIP_DTMF_NONE, AST_SIP_DTMF_RFC_4733, and buf.

Referenced by dtmf_to_str(), and pjsip_acf_dtmf_mode_read().

ast_sip_endpoint_alloc()

void * ast_sip_endpoint_alloc

(

const char *

name

)

Allocate a new SIP endpoint.

This will return an endpoint with its refcount increased by one. This reference can be released using ao2_ref().

Parameters

name	The name of the endpoint.

Return values

NULL	Endpoint allocation failed
non-NULL	The newly allocated endpoint

Definition at line 2459 of file pjsip_configuration.c.

{
    struct ast_sip_endpoint *endpoint = ast_sorcery_generic_alloc(sizeof(*endpoint), endpoint_destructor);
    if (!endpoint) {
        return NULL;
    }
    if (ast_string_field_init(endpoint, 128)) {
        ao2_cleanup(endpoint);
        return NULL;
    }
 
    if (ast_string_field_init_extended(endpoint, geoloc_incoming_call_profile) ||
        ast_string_field_init_extended(endpoint, geoloc_outgoing_call_profile)) {
        ao2_cleanup(endpoint);
        return NULL;
    }
    if (ast_string_field_init_extended(endpoint, overlap_context)) {
        ao2_cleanup(endpoint);
        return NULL;
    }
    if (ast_string_field_init_extended(endpoint, tenantid)) {
        ao2_cleanup(endpoint);
        return NULL;
    }
 
    if (!(endpoint->media.codecs = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT))) {
        ao2_cleanup(endpoint);
        return NULL;
    }
    if (init_subscription_configuration(&endpoint->subscription)) {
        ao2_cleanup(endpoint);
        return NULL;
    }
    if (init_info_configuration(&endpoint->info)) {
        ao2_cleanup(endpoint);
        return NULL;
    }
    if (init_media_configuration(&endpoint->media)) {
        ao2_cleanup(endpoint);
        return NULL;
    }
 
    ast_party_id_init(&endpoint->id.self);
    endpoint->id.self.tag = ast_strdup("");
 
    if (AST_VECTOR_INIT(&endpoint->ident_method_order, 1)) {
        return NULL;
    }
 
    return endpoint;
}

References ao2_cleanup, ast_format_cap_alloc, AST_FORMAT_CAP_FLAG_DEFAULT, ast_party_id_init(), ast_sorcery_generic_alloc(), ast_strdup, ast_string_field_init, ast_string_field_init_extended, AST_VECTOR_INIT, ast_sip_endpoint_media_configuration::codecs, endpoint_destructor(), ast_sip_endpoint::id, ast_sip_endpoint::ident_method_order, ast_sip_endpoint::info, init_info_configuration(), init_media_configuration(), init_subscription_configuration(), ast_sip_endpoint::media, NULL, ast_sip_endpoint_id_configuration::self, ast_sip_endpoint::subscription, and ast_party_id::tag.

Referenced by ast_res_pjsip_initialize_configuration().

ast_sip_failover_request()

int ast_sip_failover_request

(

pjsip_tx_data *

tdata

)

Set a request to use the next value in the list of resolved addresses.

Parameters

tdata

the tx data from the original request

Return values

0	No more addresses to try
1	The request was successfully re-intialized

Definition at line 1816 of file res_pjsip.c.

{
    pjsip_via_hdr *via;
 
    if (!tdata || !tdata->dest_info.addr.count
        || (tdata->dest_info.cur_addr == tdata->dest_info.addr.count - 1)) {
        /* No more addresses to try */
        return 0;
    }
 
    /* Try next address */
    ++tdata->dest_info.cur_addr;
 
    via = (pjsip_via_hdr*)pjsip_msg_find_hdr(tdata->msg, PJSIP_H_VIA, NULL);
    via->branch_param.slen = 0;
 
    pjsip_tx_data_invalidate_msg(tdata);
 
    return 1;
}

References NULL, and send_request_wrapper::tdata.

Referenced by check_request_status(), check_request_status(), and handle_registration_response().

ast_sip_find_transport_state_in_use()

struct ast_sip_transport_state * ast_sip_find_transport_state_in_use

(

struct ast_sip_request_transport_details *

details

)

Returns the transport state currently in use based on request transport details.

Parameters

details

Return values

transport_state

Note

ao2_cleanup(...) or ao2_ref(..., -1) must be called on the returned object

Definition at line 595 of file res_pjsip.c.

                                                                                                                       {
    RAII_VAR(struct ao2_container *, transport_states, NULL, ao2_cleanup);
 
    if (!(transport_states = ast_sip_get_transport_states())) {
        return NULL;
    }
 
    return ao2_callback(transport_states, 0, find_transport_state_in_use, details);
}

References ao2_callback, ao2_cleanup, ast_sip_get_transport_states(), find_transport_state_in_use(), NULL, RAII_VAR, and transport_states.

Referenced by ast_sip_rewrite_uri_to_local(), and process_nat().

ast_sip_for_each_aor()

int ast_sip_for_each_aor	(	const char *	aors,
		ao2_callback_fn	on_aor,
		void *	arg
	)

For every aor in the comma separated aors string call the given 'on_aor' handler.

Parameters

aors	a comma separated list of aors
on_aor	callback for each aor
arg	user data passed to handler

Return values

0	Success, non-zero on failure

Definition at line 688 of file location.c.

{
    char *copy;
    char *name;
    int res;
 
    if (!on_aor || ast_strlen_zero(aors)) {
        return 0;
    }
 
    copy = ast_strdupa(aors);
    while ((name = ast_strip(strsep(&copy, ",")))) {
        struct ast_sip_aor *aor;
 
        aor = ast_sip_location_retrieve_aor(name);
        if (aor) {
            res = on_aor(aor, arg, 0);
            ao2_ref(aor, -1);
            if (res) {
                return -1;
            }
        }
    }
    return 0;
}

References ao2_ref, ast_sip_location_retrieve_aor(), ast_strdupa, ast_strip(), ast_strlen_zero(), copy(), name, and strsep().

Referenced by ami_registrations_endpoint(), ast_sip_location_retrieve_contacts_from_aor_list(), cli_aor_iterate(), format_ami_contact_status(), format_ami_endpoint_aor(), format_ami_endpoints(), mwi_new_subscribe(), and mwi_subscribe_all().

ast_sip_for_each_auth()

int ast_sip_for_each_auth	(	const struct ast_sip_auth_vector *	array,
		ao2_callback_fn	on_auth,
		void *	arg
	)

For every auth in the array call the given 'on_auth' handler.

Parameters

array	an array of auths
on_auth	callback for each auth
arg	user data passed to handler

Return values

0	Success, non-zero on failure

Definition at line 484 of file config_auth.c.

{
    int i;
 
    if (!vector || !AST_VECTOR_SIZE(vector)) {
        return 0;
    }
 
    for (i = 0; i < AST_VECTOR_SIZE(vector); ++i) {
        /* AST_VECTOR_GET is safe to use since the vector is immutable */
        RAII_VAR(struct ast_sip_auth *, auth, ast_sorcery_retrieve_by_id(
                 ast_sip_get_sorcery(), SIP_SORCERY_AUTH_TYPE,
                 AST_VECTOR_GET(vector,i)), ao2_cleanup);
 
        if (!auth) {
            continue;
        }
 
        if (on_auth(auth, arg, 0)) {
            return -1;
        }
    }
 
    return 0;
}

References ao2_cleanup, ast_sip_get_sorcery(), ast_sorcery_retrieve_by_id(), AST_VECTOR_GET, AST_VECTOR_SIZE, RAII_VAR, and SIP_SORCERY_AUTH_TYPE.

Referenced by ast_sip_format_auths_ami(), and cli_iterator().

ast_sip_for_each_channel()

int ast_sip_for_each_channel	(	const struct ast_sip_endpoint *	endpoint,
		ao2_callback_fn	on_channel_snapshot,
		void *	arg
	)

For every channel snapshot on an endpoint all the given 'on_channel_snapshot' handler.

Parameters

endpoint	endpoint
on_channel_snapshot	callback for each channel snapshot
arg	user data passed to handler

Return values

0	Success, non-zero on failure

Definition at line 1705 of file pjsip_configuration.c.

{
    RAII_VAR(struct ast_endpoint_snapshot *, endpoint_snapshot, ast_sip_get_endpoint_snapshot(endpoint), ao2_cleanup);
    return ast_sip_for_each_channel_snapshot(endpoint_snapshot, on_channel_snapshot, arg);
}

References ao2_cleanup, ast_sip_for_each_channel_snapshot(), ast_sip_get_endpoint_snapshot(), and RAII_VAR.

Referenced by cli_channel_iterate(), and cli_channelstats_iterate().

ast_sip_for_each_channel_snapshot()

int ast_sip_for_each_channel_snapshot	(	const struct ast_endpoint_snapshot *	endpoint_snapshot,
		ao2_callback_fn	on_channel_snapshot,
		void *	arg
	)

For every channel snapshot on an endpoint snapshot call the given 'on_channel_snapshot' handler.

Parameters

endpoint_snapshot	snapshot of an endpoint
on_channel_snapshot	callback for each channel snapshot
arg	user data passed to handler

Return values

0	Success, non-zero on failure

Definition at line 1678 of file pjsip_configuration.c.

{
    int num, num_channels = endpoint_snapshot->num_channels;
 
    if (!on_channel_snapshot || !num_channels) {
        return 0;
    }
 
    for (num = 0; num < num_channels; ++num) {
        RAII_VAR(struct ast_channel_snapshot *, snapshot, NULL, ao2_cleanup);
        int res;
 
        snapshot = ast_channel_snapshot_get_latest(endpoint_snapshot->channel_ids[num]);
        if (!snapshot) {
            continue;
        }
 
        res = on_channel_snapshot(snapshot, arg, 0);
        if (res) {
            return -1;
        }
    }
    return 0;
}

References ao2_cleanup, ast_channel_snapshot_get_latest(), ast_endpoint_snapshot::channel_ids, NULL, ast_endpoint_snapshot::num_channels, and RAII_VAR.

Referenced by ast_sip_for_each_channel().

ast_sip_for_each_contact()

int ast_sip_for_each_contact	(	const struct ast_sip_aor *	aor,
		ao2_callback_fn	on_contact,
		void *	arg
	)

For every contact on an AOR call the given 'on_contact' handler.

Parameters

aor	the aor containing a list of contacts to iterate
on_contact	callback on each contact on an AOR. The object received by the callback will be a ast_sip_contact_wrapper structure.
arg	user data passed to handler

Return values

0	Success, non-zero on failure

Definition at line 723 of file location.c.

{
    struct ao2_container *contacts;
    struct ao2_iterator i;
    int res = 0;
    void *object = NULL;
 
    if (!on_contact ||
        !(contacts = ast_sip_location_retrieve_aor_contacts(aor))) {
        return 0;
    }
 
    i = ao2_iterator_init(contacts, 0);
    while ((object = ao2_iterator_next(&i))) {
        RAII_VAR(struct ast_sip_contact *, contact, object, ao2_cleanup);
        RAII_VAR(struct ast_sip_contact_wrapper *, wrapper, NULL, ao2_cleanup);
        const char *aor_id = ast_sorcery_object_get_id(aor);
 
        wrapper = ao2_alloc_options(sizeof(struct ast_sip_contact_wrapper),
            contact_wrapper_destroy, AO2_ALLOC_OPT_LOCK_NOLOCK);
        if (!wrapper) {
            res = -1;
            break;
        }
        wrapper->contact_id = ast_malloc(strlen(aor_id) + strlen(contact->uri) + 2);
        if (!wrapper->contact_id) {
            res = -1;
            break;
        }
        sprintf(wrapper->contact_id, "%s/%s", aor_id, contact->uri);
        wrapper->aor_id = ast_strdup(aor_id);
        if (!wrapper->aor_id) {
            res = -1;
            break;
        }
        wrapper->contact = contact;
        ao2_bump(wrapper->contact);
 
        if ((res = on_contact(wrapper, arg, 0))) {
            break;
        }
    }
    ao2_iterator_destroy(&i);
    ao2_ref(contacts, -1);
    return res;
}

References AO2_ALLOC_OPT_LOCK_NOLOCK, ao2_alloc_options, ao2_bump, ao2_cleanup, ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_ref, ast_malloc, ast_sip_location_retrieve_aor_contacts(), ast_sorcery_object_get_id(), ast_strdup, contact_wrapper_destroy(), NULL, and RAII_VAR.

Referenced by ami_registrations_aor(), cli_aor_gather_contacts(), cli_contact_iterate(), contacts_to_str(), contacts_to_var_list(), format_contact_status_for_aor(), and sip_endpoints_aors_ami().

ast_sip_format_auths_ami()

int ast_sip_format_auths_ami	(	const struct ast_sip_auth_vector *	auths,
		struct ast_sip_ami *	ami
	)

Format auth details for AMI.

Parameters

auths	an auth array
ami	ami variable container

Return values

0	Success, non-zero on failure

Definition at line 544 of file config_auth.c.

{
    return ast_sip_for_each_auth(auths, format_ami_auth_handler, ami);
}

References ast_sip_for_each_auth(), and format_ami_auth_handler().

Referenced by ami_outbound_registration_task(), and format_ami_endpoint_auth().

ast_sip_format_contact_ami()

int ast_sip_format_contact_ami	(	void *	obj,
		void *	arg,
		int	flags
	)

Formats the contact and sends over AMI.

Parameters

obj	a pointer an ast_sip_contact_wrapper structure
arg	a pointer to an ast_sip_ami structure
flags	ignored

Return values

0	Success, otherwise non-zero on error

Definition at line 2730 of file pjsip_options.c.

{
    struct ast_sip_contact_wrapper *wrapper = obj;
    struct ast_sip_contact *contact = wrapper->contact;
    struct ast_sip_ami *ami = arg;
    struct ast_sip_contact_status *status;
    struct ast_str *buf;
    const struct ast_sip_endpoint *endpoint = ami->arg;
    char secs[AST_TIME_T_LEN];
 
    buf = ast_sip_create_ami_event("ContactStatusDetail", ami);
    if (!buf) {
        return -1;
    }
 
    status = ast_sip_get_contact_status(contact);
 
    ast_str_append(&buf, 0, "AOR: %s\r\n", wrapper->aor_id);
    ast_str_append(&buf, 0, "URI: %s\r\n", contact->uri);
    ast_str_append(&buf, 0, "UserAgent: %s\r\n", contact->user_agent);
    ast_time_t_to_string(contact->expiration_time.tv_sec, secs, sizeof(secs));
    ast_str_append(&buf, 0, "RegExpire: %s\r\n", secs);
    if (!ast_strlen_zero(contact->via_addr)) {
        ast_str_append(&buf, 0, "ViaAddress: %s", contact->via_addr);
        if (contact->via_port) {
            ast_str_append(&buf, 0, ":%d", contact->via_port);
        }
        ast_str_append(&buf, 0, "\r\n");
    }
    if (!ast_strlen_zero(contact->call_id)) {
        ast_str_append(&buf, 0, "CallID: %s\r\n", contact->call_id);
    }
    ast_str_append(&buf, 0, "Status: %s\r\n",
        ast_sip_get_contact_status_label(status ? status->status : UNKNOWN));
    if (!status || status->status != AVAILABLE) {
        ast_str_append(&buf, 0, "RoundtripUsec: N/A\r\n");
    } else {
        ast_str_append(&buf, 0, "RoundtripUsec: %" PRId64 "\r\n", status->rtt);
    }
    ast_str_append(&buf, 0, "EndpointName: %s\r\n",
        endpoint ? ast_sorcery_object_get_id(endpoint) : S_OR(contact->endpoint_name, ""));
 
    ast_str_append(&buf, 0, "ID: %s\r\n", ast_sorcery_object_get_id(contact));
    ast_str_append(&buf, 0, "AuthenticateQualify: %d\r\n", contact->authenticate_qualify);
    ast_str_append(&buf, 0, "OutboundProxy: %s\r\n", contact->outbound_proxy);
    ast_str_append(&buf, 0, "Path: %s\r\n", contact->path);
    ast_str_append(&buf, 0, "QualifyFrequency: %u\r\n", contact->qualify_frequency);
    ast_str_append(&buf, 0, "QualifyTimeout: %.3f\r\n", contact->qualify_timeout);
    ast_str_append(&buf, 0, "Qualify2xxOnly: %d\r\n", contact->qualify_2xx_only);
 
    astman_append(ami->s, "%s\r\n", ast_str_buffer(buf));
    ami->count++;
 
    ast_free(buf);
    ao2_cleanup(status);
    return 0;
}

References ao2_cleanup, ast_sip_contact_wrapper::aor_id, ast_sip_ami::arg, ast_free, ast_sip_create_ami_event(), ast_sip_get_contact_status(), ast_sip_get_contact_status_label(), ast_sorcery_object_get_id(), ast_str_append(), ast_str_buffer(), ast_strlen_zero(), AST_TIME_T_LEN, ast_time_t_to_string(), astman_append(), ast_sip_contact::authenticate_qualify, AVAILABLE, buf, ast_sip_contact::call_id, ast_sip_contact_wrapper::contact, ast_sip_ami::count, ast_sip_contact::endpoint_name, ast_sip_contact::expiration_time, ast_sip_contact::outbound_proxy, ast_sip_contact::path, ast_sip_contact::qualify_2xx_only, ast_sip_contact::qualify_frequency, ast_sip_contact::qualify_timeout, ast_sip_ami::s, S_OR, status, UNKNOWN, ast_sip_contact::uri, ast_sip_contact::user_agent, ast_sip_contact::via_addr, and ast_sip_contact::via_port.

Referenced by ami_show_registration_contact_statuses(), and format_contact_status_for_aor().

ast_sip_format_endpoint_ami()

int ast_sip_format_endpoint_ami	(	struct ast_sip_endpoint *	endpoint,
		struct ast_sip_ami *	ami,
		int *	count
	)

Formats the endpoint and sends over AMI.

Parameters

endpoint	the endpoint to format and send
ami	AMI variable container
count	the number of formatters operated on

Return values

0	Success, otherwise non-zero on error

Definition at line 501 of file res_pjsip.c.

{
    int res = 0;
    struct ast_sip_endpoint_formatter *i;
    SCOPED_LOCK(lock, &endpoint_formatters, AST_RWLIST_RDLOCK, AST_RWLIST_UNLOCK);
    *count = 0;
    AST_RWLIST_TRAVERSE(&endpoint_formatters, i, next) {
        if (i->format_ami && ((res = i->format_ami(endpoint, ami)) < 0)) {
            return res;
        }
 
        if (!res) {
            (*count)++;
        }
    }
    return 0;
}

References AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, ast_sip_endpoint_formatter::format_ami, lock, ast_sip_endpoint_formatter::next, and SCOPED_LOCK.

Referenced by ami_show_endpoint().

ast_sip_get_all_codecs_on_empty_reinvite()

unsigned int ast_sip_get_all_codecs_on_empty_reinvite

(

void

)

Retrieve the system setting 'all_codecs_on_empty_reinvite'.

Return values

non	zero if we should return all codecs on empty re-INVITE

Definition at line 596 of file config_global.c.

{
    unsigned int all_codecs_on_empty_reinvite;
    struct global_config *cfg;
 
    cfg = get_global_cfg();
    if (!cfg) {
        return DEFAULT_ALL_CODECS_ON_EMPTY_REINVITE;
    }
 
    all_codecs_on_empty_reinvite = cfg->all_codecs_on_empty_reinvite;
    ao2_ref(cfg, -1);
    return all_codecs_on_empty_reinvite;
}

References global_config::all_codecs_on_empty_reinvite, ao2_ref, DEFAULT_ALL_CODECS_ON_EMPTY_REINVITE, and get_global_cfg().

Referenced by session_inv_on_create_offer().

ast_sip_get_allow_sending_180_after_183()

unsigned int ast_sip_get_allow_sending_180_after_183

(

void

)

Retrieve the global setting 'allow_sending_180_after_183'.

Return values

non	zero if disable.

Definition at line 506 of file config_global.c.

{
    unsigned int allow_sending_180_after_183;
    struct global_config *cfg;
 
    cfg = get_global_cfg();
    if (!cfg) {
        return DEFAULT_ALLOW_SENDING_180_AFTER_183;
    }
 
    allow_sending_180_after_183 = cfg->allow_sending_180_after_183;
    ao2_ref(cfg, -1);
    return allow_sending_180_after_183;
}

References global_config::allow_sending_180_after_183, ao2_ref, DEFAULT_ALLOW_SENDING_180_AFTER_183, and get_global_cfg().

Referenced by chan_pjsip_indicate().

ast_sip_get_artificial_auth()

struct ast_sip_auth * ast_sip_get_artificial_auth

(

void

)

Retrieves a reference to the artificial auth.

Return values

The	artificial auth

Definition at line 643 of file pjsip_distributor.c.

{
    return ao2_global_obj_ref(artificial_auth);
}

References ao2_global_obj_ref.

Referenced by digest_check_auth().

ast_sip_get_artificial_endpoint()

struct ast_sip_endpoint * ast_sip_get_artificial_endpoint

(

void

)

Retrieves a reference to the artificial endpoint.

Return values

The	artificial endpoint

Definition at line 666 of file pjsip_distributor.c.

{
    ao2_ref(artificial_endpoint, +1);
    return artificial_endpoint;
}

References ao2_ref, and artificial_endpoint.

Referenced by digest_check_auth(), digest_requires_authentication(), endpoint_lookup(), and get_account_id().

ast_sip_get_contact_expiration_check_interval()

unsigned int ast_sip_get_contact_expiration_check_interval

(

void

)

Retrieve the system contact expiration check interval setting.

Return values

the	contact expiration check interval.

Definition at line 342 of file config_global.c.

{
    unsigned int interval;
    struct global_config *cfg;
 
    cfg = get_global_cfg();
    if (!cfg) {
        return DEFAULT_CONTACT_EXPIRATION_CHECK_INTERVAL;
    }
 
    interval = cfg->contact_expiration_check_interval;
    ao2_ref(cfg, -1);
    return interval;
}

References ao2_ref, global_config::contact_expiration_check_interval, DEFAULT_CONTACT_EXPIRATION_CHECK_INTERVAL, and get_global_cfg().

Referenced by expiration_global_loaded().

ast_sip_get_contact_short_status_label()

const char * ast_sip_get_contact_short_status_label

(

const enum ast_sip_contact_status_type

status

)

Definition at line 341 of file pjsip_options.c.

{
    ast_assert(0 <= status && status < ARRAY_LEN(short_status_map));
    return short_status_map[status];
}

References ARRAY_LEN, ast_assert, short_status_map, and status.

Referenced by cli_contact_print_body().

ast_sip_get_contact_sip_uri()

pjsip_sip_uri * ast_sip_get_contact_sip_uri

(

pjsip_tx_data *

tdata

)

Return the SIP URI of the Contact header.

Parameters

tdata

Return values

Pointer	to SIP URI of Contact
NULL	if Contact header not found or not a SIP(S) URI

Note

Do not free the returned object.

Definition at line 564 of file res_pjsip.c.

{
    pjsip_contact_hdr *contact = pjsip_msg_find_hdr(tdata->msg, PJSIP_H_CONTACT, NULL);
 
    if (!contact || (!PJSIP_URI_SCHEME_IS_SIP(contact->uri) && !PJSIP_URI_SCHEME_IS_SIPS(contact->uri))) {
        return NULL;
    }
 
    return pjsip_uri_get_uri(contact->uri);
}

References NULL.

Referenced by ast_sip_rewrite_uri_to_local(), ast_sip_set_request_transport_details(), and process_nat().

ast_sip_get_contact_status()

struct ast_sip_contact_status * ast_sip_get_contact_status

(

const struct ast_sip_contact *

contact

)

Retrieve the current status for a contact.

Parameters

contact

The contact.

Return values

non-NULL	Success
NULL	Status information not found

Note

The returned contact status object is immutable.

Definition at line 527 of file pjsip_options.c.

{
    return ao2_find(sip_options_contact_statuses, ast_sorcery_object_get_id(contact),
        OBJ_SEARCH_KEY);
}

References ao2_find, ast_sorcery_object_get_id(), OBJ_SEARCH_KEY, and sip_options_contact_statuses.

Referenced by add_outgoing_request_headers(), ast_sip_format_contact_ami(), cli_contact_print_body(), contact_add_security_headers_to_status(), contact_has_security_mechanisms(), contact_remove_unreachable(), format_ami_contactlist_handler(), pjsip_contact_function_read(), registrar_add_unreachable(), rfc3329_incoming_response(), sip_options_contact_update_task(), and vec_contact_cmp().

ast_sip_get_contact_status_label()

const char * ast_sip_get_contact_status_label

(

const enum ast_sip_contact_status_type

status

)

translate ast_sip_contact_status_type to character string.

Return values

the	character string equivalent.

Definition at line 335 of file pjsip_options.c.

{
    ast_assert(0 <= status && status < ARRAY_LEN(status_map));
    return status_map[status];
}

References ARRAY_LEN, ast_assert, status, and status_map.

Referenced by ast_res_pjsip_find_or_create_contact_status(), ast_sip_format_contact_ami(), ast_sip_initialize_sorcery_location(), ast_sip_persistent_endpoint_publish_contact_state(), format_ami_contactlist_handler(), pjsip_contact_function_read(), sip_options_contact_status_notify_task(), sip_options_remove_contact_status(), and sip_options_set_contact_status().

ast_sip_get_debug()

char * ast_sip_get_debug

(

void

)

Retrieve the system debug setting (yes|no|host).

Note

returned string needs to be de-allocated by caller.

Return values

the	system debug setting.

Definition at line 265 of file config_global.c.

{
    char *res;
    struct global_config *cfg;
 
    cfg = get_global_cfg();
    if (!cfg) {
        return ast_strdup(DEFAULT_DEBUG);
    }
 
    res = ast_strdup(cfg->debug);
    ao2_ref(cfg, -1);
    return res;
}

References ao2_ref, ast_strdup, global_config::debug, DEFAULT_DEBUG, and get_global_cfg().

Referenced by check_debug().

ast_sip_get_default_auth_algorithms_uac()

void ast_sip_get_default_auth_algorithms_uac	(	char *	default_auth_algorithms_uac,
		size_t	size
	)

Retrieve the global auth algorithms for UAC.

Parameters

[out]	default_auth_algorithms_uac	The default algorithms
	size	The buffer size of default_auth_algorithms_uac

Definition at line 434 of file config_global.c.

{
    struct global_config *cfg;
 
    cfg = get_global_cfg();
    if (!cfg) {
        ast_copy_string(default_auth_algorithms_uac, DEFAULT_AUTH_ALGORITHMS_UAC, size);
    } else {
        ast_copy_string(default_auth_algorithms_uac, cfg->default_auth_algorithms_uac, size);
        ao2_ref(cfg, -1);
    }
}

References ao2_ref, ast_copy_string(), DEFAULT_AUTH_ALGORITHMS_UAC, global_config::default_auth_algorithms_uac, and get_global_cfg().

Referenced by auth_apply(), and create_artificial_auth().

ast_sip_get_default_auth_algorithms_uas()

void ast_sip_get_default_auth_algorithms_uas	(	char *	default_auth_algorithms_uas,
		size_t	size
	)

Retrieve the global auth algorithms for UAS.

Parameters

[out]	default_auth_algorithms_uas	The default algorithms
	size	The buffer size of default_auth_algorithms_uas

Definition at line 421 of file config_global.c.

{
    struct global_config *cfg;
 
    cfg = get_global_cfg();
    if (!cfg) {
        ast_copy_string(default_auth_algorithms_uas, DEFAULT_AUTH_ALGORITHMS_UAS, size);
    } else {
        ast_copy_string(default_auth_algorithms_uas, cfg->default_auth_algorithms_uas, size);
        ao2_ref(cfg, -1);
    }
}

References ao2_ref, ast_copy_string(), DEFAULT_AUTH_ALGORITHMS_UAS, global_config::default_auth_algorithms_uas, and get_global_cfg().

Referenced by auth_apply(), and create_artificial_auth().

ast_sip_get_default_from_user()

void ast_sip_get_default_from_user	(	char *	from_user,
		size_t	size
	)

Retrieve the global default from user.

This is the value placed in outbound requests' From header if there is no better option (such as an endpoint-configured from_user or caller ID number).

Parameters

[out]	from_user	The default from user
	size	The buffer size of from_user

Definition at line 447 of file config_global.c.

{
    struct global_config *cfg;
 
    cfg = get_global_cfg();
    if (!cfg) {
        ast_copy_string(from_user, DEFAULT_FROM_USER, size);
    } else {
        ast_copy_string(from_user, cfg->default_from_user, size);
        ao2_ref(cfg, -1);
    }
}

References ao2_ref, ast_copy_string(), DEFAULT_FROM_USER, global_config::default_from_user, and get_global_cfg().

Referenced by sip_dialog_create_from().

ast_sip_get_default_realm()

void ast_sip_get_default_realm	(	char *	realm,
		size_t	size
	)

Retrieve the global default realm.

This is the value placed in outbound challenges' realm if there is no better option (such as an auth-configured realm).

Parameters

[out]	realm	The default realm
	size	The buffer size of realm

Definition at line 408 of file config_global.c.

{
    struct global_config *cfg;
 
    cfg = get_global_cfg();
    if (!cfg) {
        ast_copy_string(realm, DEFAULT_REALM, size);
    } else {
        ast_copy_string(realm, cfg->default_realm, size);
        ao2_ref(cfg, -1);
    }
}

References ao2_ref, ast_copy_string(), DEFAULT_REALM, global_config::default_realm, and get_global_cfg().

Referenced by create_artificial_auth(), and global_loaded().

ast_sip_get_default_voicemail_extension()

char * ast_sip_get_default_voicemail_extension

(

void

)

Retrieve the default voicemail extension.

Since

13.9.0

Note

returned string needs to be de-allocated by caller.

Return values

the	default voicemail extension

Definition at line 296 of file config_global.c.

{
    char *res;
    struct global_config *cfg;
 
    cfg = get_global_cfg();
    if (!cfg) {
        return ast_strdup(DEFAULT_VOICEMAIL_EXTENSION);
    }
 
    res = ast_strdup(cfg->default_voicemail_extension);
    ao2_ref(cfg, -1);
 
    return res;
}

References ao2_ref, ast_strdup, DEFAULT_VOICEMAIL_EXTENSION, global_config::default_voicemail_extension, and get_global_cfg().

Referenced by global_loaded().

ast_sip_get_device_state()

const char * ast_sip_get_device_state

(

const struct ast_sip_endpoint *

endpoint

)

Retrieve the device state for an endpoint.

Parameters

endpoint

The endpoint whose state is to be retrieved.

Return values

The	device state.

Definition at line 1662 of file pjsip_configuration.c.

{
    char device[MAX_OBJECT_FIELD];
 
    snprintf(device, MAX_OBJECT_FIELD, "PJSIP/%s", ast_sorcery_object_get_id(endpoint));
    return ast_devstate2str(ast_device_state(device));
}

References ast_devstate2str(), ast_sorcery_object_get_id(), and MAX_OBJECT_FIELD.

Referenced by cli_endpoint_print_body(), format_ami_endpoints(), and sip_endpoint_to_ami().

ast_sip_get_disable_multi_domain()

unsigned int ast_sip_get_disable_multi_domain

(

void

)

Retrieve the system setting 'disable multi domain'.

Since

13.9.0

Return values

non	zero if disable multi domain.

Definition at line 357 of file config_global.c.

{
    unsigned int disable_multi_domain;
    struct global_config *cfg;
 
    cfg = get_global_cfg();
    if (!cfg) {
        return DEFAULT_DISABLE_MULTI_DOMAIN;
    }
 
    disable_multi_domain = cfg->disable_multi_domain;
    ao2_ref(cfg, -1);
    return disable_multi_domain;
}

References ao2_ref, DEFAULT_DISABLE_MULTI_DOMAIN, global_config::disable_multi_domain, and get_global_cfg().

Referenced by anonymous_identify(), find_endpoint(), request(), and sip_dialog_create_from().

ast_sip_get_endpoint()

struct ast_sip_endpoint * ast_sip_get_endpoint	(	const char *	to,
		int	get_default_outbound,
		char **	uri
	)

Retrieves an endpoint and URI from the "to" string.

This URI is used as the Request URI.

Expects the given 'to' to be in one of the following formats: Why we allow so many is a mystery.

Basic:

 endpoint        : We'll get URI from the default aor/contact
 endpoint/aor    : We'll get the URI from the specific aor/contact
 endpoint@domain : We toss the domain part and just use the endpoint

These all use the endpoint and specified URI:

     endpoint/<sip[s]:host>
     endpoint/<sip[s]:user@host>
     endpoint/"Bob" <sip[s]:host>
     endpoint/"Bob" <sip[s]:user@host>
     endpoint/sip[s]:host
     endpoint/sip[s]:user@host
     endpoint/host
     endpoint/user@host

These all use the default endpoint and specified URI:

     <sip[s]:host>
     <sip[s]:user@host>
     "Bob" <sip[s]:host>
     "Bob" <sip[s]:user@host>
     sip[s]:host
     sip[s]:user@host

These use the default endpoint and specified host:

     host
     user@host

This form is similar to a dialstring:

     PJSIP/user@endpoint

In this case, the user will be added to the endpoint contact's URI. If the contact URI already has a user, it will be replaced.

The ones that have the sip[s] scheme are the easiest to parse. The rest all have some issue.

 endpoint vs host              : We have to test for endpoint first
 endpoint/aor vs endpoint/host : We have to test for aor first
                                 What if there's an aor with the same
                                 name as the host?
 endpoint@domain vs user@host  : We have to test for endpoint first.
                                 What if there's an endpoint with the
                                 same name as the user?

Parameters

to	'To' field with possible endpoint
get_default_outbound	If nonzero, try to retrieve the default outbound endpoint if no endpoint was found. Otherwise, return NULL if no endpoint was found.
uri	Pointer to a char* which will be set to the URI. Always must be ast_free'd by the caller - even if the return value is NULL!

Note

The logic below could probably be condensed but then it wouldn't be as clear.

Definition at line 3249 of file res_pjsip.c.

{
    char *destination;
    char *slash = NULL;
    char *atsign = NULL;
    char *scheme = NULL;
    struct ast_sip_endpoint *endpoint = NULL;
 
    destination = ast_strdupa(to);
 
    slash = strchr(destination, '/');
    atsign = strchr(destination, '@');
    scheme = S_OR(strstr(destination, "sip:"), strstr(destination, "sips:"));
 
    if (!slash && !atsign && !scheme) {
        /*
         * If there's only a single token, it can be either...
         *  endpoint
         *  host
         */
        return handle_single_token(to, destination, get_default_outbound, uri);
    }
 
    if (slash) {
        /*
         * If there's a '/', then the form must be one of the following...
         *  PJSIP/user@endpoint
         *  endpoint/aor
         *  endpoint/uri
         */
        return handle_slash(to, destination, uri, slash, atsign, scheme);
    }
 
    if (atsign && !scheme) {
        /*
         * If there's an '@' but no scheme then it's either following an endpoint name
         * and being followed by a domain name (which we discard).
         * OR is's a user@host uri without a scheme.  It's probably the latter but because
         * endpoint@domain looks just like user@host, we'll test for endpoint first.
         */
        return handle_atsign(to, destination, uri, slash, atsign, scheme, get_default_outbound);
    }
 
    /*
     * If all else fails, we assume it's a URI or just a hostname.
     */
    if (scheme) {
        *uri = ast_strdup(destination);
        if (!(*uri)) {
            goto failure;
        }
        ast_debug(3, "Dest: '%s' Didn't find an endpoint but did find a scheme so using URI '%s'%s\n",
            to, *uri, get_default_outbound ? " with default endpoint" : "");
    } else {
        *uri = ast_malloc(strlen(destination) + strlen("sip:") + 1);
        if (!(*uri)) {
            goto failure;
        }
        sprintf(*uri, "sip:%s", destination);
        ast_debug(3, "Dest: '%s' Didn't find an endpoint and didn't find scheme so adding scheme and using URI '%s'%s\n",
            to, *uri, get_default_outbound ? " with default endpoint" : "");
    }
    if (get_default_outbound) {
        endpoint = ast_sip_default_outbound_endpoint();
    }
 
    return endpoint;
 
failure:
    ao2_cleanup(endpoint);
    *uri = NULL;
    return NULL;
}

References ao2_cleanup, ast_debug, ast_malloc, ast_sip_default_outbound_endpoint(), ast_strdup, ast_strdupa, handle_atsign(), handle_single_token(), handle_slash(), NULL, and S_OR.

Referenced by msg_send(), and refer_send().

ast_sip_get_endpoint_identifier_order()

char * ast_sip_get_endpoint_identifier_order

(

void

)

Retrieve the global endpoint_identifier_order setting.

Specifies the order by which endpoint identifiers should be regarded.

Return values

the	global endpoint_identifier_order value

Definition at line 312 of file config_global.c.

{
    char *res;
    struct global_config *cfg;
 
    cfg = get_global_cfg();
    if (!cfg) {
        return ast_strdup(DEFAULT_ENDPOINT_IDENTIFIER_ORDER);
    }
 
    res = ast_strdup(cfg->endpoint_identifier_order);
    ao2_ref(cfg, -1);
    return res;
}

References ao2_ref, ast_strdup, DEFAULT_ENDPOINT_IDENTIFIER_ORDER, global_config::endpoint_identifier_order, and get_global_cfg().

Referenced by ast_sip_register_endpoint_identifier_with_name(), and global_loaded().

ast_sip_get_endpoint_snapshot()

struct ast_endpoint_snapshot * ast_sip_get_endpoint_snapshot

(

const struct ast_sip_endpoint *

endpoint

)

Retrieve the endpoint snapshot for an endpoint.

Parameters

endpoint

The endpoint whose snapshot is to be retrieved.

Return values

The	endpoint snapshot

Definition at line 1670 of file pjsip_configuration.c.

{
    return ast_endpoint_latest_snapshot(
        ast_endpoint_get_tech(endpoint->persistent),
        ast_endpoint_get_resource(endpoint->persistent));
}

References ast_endpoint_get_resource(), ast_endpoint_get_tech(), ast_endpoint_latest_snapshot(), and ast_sip_endpoint::persistent.

Referenced by active_channels_to_str(), ast_sip_for_each_channel(), and cli_endpoint_print_body().

ast_sip_get_endpoints()

struct ao2_container * ast_sip_get_endpoints

(

void

)

Retrieve any endpoints available to sorcery.

Return values

Endpoints

available to sorcery, NULL if no endpoints found.

Definition at line 2511 of file pjsip_configuration.c.

{
    struct ao2_container *endpoints;
 
    endpoints = ast_sorcery_retrieve_by_fields(sip_sorcery, "endpoint", AST_RETRIEVE_FLAG_MULTIPLE | AST_RETRIEVE_FLAG_ALL, NULL);
 
    return endpoints;
}

References AST_RETRIEVE_FLAG_ALL, AST_RETRIEVE_FLAG_MULTIPLE, ast_sorcery_retrieve_by_fields(), endpoints, NULL, and sip_sorcery.

Referenced by ami_registrations_endpoints(), ami_show_endpoints(), and load_module().

ast_sip_get_host_ip()

int ast_sip_get_host_ip	(	int	af,
		pj_sockaddr *	addr
	)

Retrieve the local host address in IP form.

Parameters

af	The address family to retrieve
addr	A place to store the local host address

Return values

0	success
-1	failure

Since

13.6.0

Definition at line 2480 of file res_pjsip.c.

{
    if (af == pj_AF_INET() && !ast_strlen_zero(host_ip_ipv4_string)) {
        pj_sockaddr_copy_addr(addr, &host_ip_ipv4);
        return 0;
    } else if (af == pj_AF_INET6() && !ast_strlen_zero(host_ip_ipv6_string)) {
        pj_sockaddr_copy_addr(addr, &host_ip_ipv6);
        return 0;
    }
 
    return -1;
}

References ast_strlen_zero(), host_ip_ipv4, host_ip_ipv4_string, host_ip_ipv6, and host_ip_ipv6_string.

ast_sip_get_host_ip_string()

const char * ast_sip_get_host_ip_string

(

int

af

)

Retrieve the local host address in string form.

Parameters

af	The address family to retrieve

Return values

non-NULL	success
NULL	failure

Since

13.6.0

Note

An empty string may be returned if the address family is valid but no local address exists

Definition at line 2493 of file res_pjsip.c.

{
    if (af == pj_AF_INET()) {
        return host_ip_ipv4_string;
    } else if (af == pj_AF_INET6()) {
        return host_ip_ipv6_string;
    }
 
    return NULL;
}

References host_ip_ipv4_string, host_ip_ipv6_string, and NULL.

Referenced by create_local_sdp(), create_outgoing_sdp_stream(), create_outgoing_sdp_stream(), and multihomed_rewrite_sdp().

ast_sip_get_ignore_uri_user_options()

unsigned int ast_sip_get_ignore_uri_user_options

(

void

)

Retrieve the global setting 'ignore_uri_user_options'.

Since

13.12.0

Return values

non	zero if ignore the user field options.

Definition at line 521 of file config_global.c.

{
    unsigned int ignore_uri_user_options;
    struct global_config *cfg;
 
    cfg = get_global_cfg();
    if (!cfg) {
        return DEFAULT_IGNORE_URI_USER_OPTIONS;
    }
 
    ignore_uri_user_options = cfg->ignore_uri_user_options;
    ao2_ref(cfg, -1);
    return ignore_uri_user_options;
}

References ao2_ref, DEFAULT_IGNORE_URI_USER_OPTIONS, get_global_cfg(), and global_config::ignore_uri_user_options.

Referenced by find_registrar_aor().

ast_sip_get_keep_alive_interval()

unsigned int ast_sip_get_keep_alive_interval

(

void

)

Retrieve the system keep alive interval setting.

Return values

the	keep alive interval.

Definition at line 327 of file config_global.c.

{
    unsigned int interval;
    struct global_config *cfg;
 
    cfg = get_global_cfg();
    if (!cfg) {
        return DEFAULT_KEEPALIVE_INTERVAL;
    }
 
    interval = cfg->keep_alive_interval;
    ao2_ref(cfg, -1);
    return interval;
}

References ao2_ref, DEFAULT_KEEPALIVE_INTERVAL, get_global_cfg(), and global_config::keep_alive_interval.

Referenced by keepalive_global_loaded().

ast_sip_get_max_initial_qualify_time()

unsigned int ast_sip_get_max_initial_qualify_time

(

void

)

Retrieve the system max initial qualify time.

Return values

the	maximum initial qualify time.

Definition at line 372 of file config_global.c.

{
    unsigned int time;
    struct global_config *cfg;
 
    cfg = get_global_cfg();
    if (!cfg) {
        return DEFAULT_MAX_INITIAL_QUALIFY_TIME;
    }
 
    time = cfg->max_initial_qualify_time;
    ao2_ref(cfg, -1);
    return time;
}

References ao2_ref, DEFAULT_MAX_INITIAL_QUALIFY_TIME, get_global_cfg(), and global_config::max_initial_qualify_time.

Referenced by sip_options_determine_initial_qualify_time().

ast_sip_get_mwi_disable_initial_unsolicited()

unsigned int ast_sip_get_mwi_disable_initial_unsolicited

(

void

)

Retrieve the global setting 'disable sending unsolicited mwi on startup'.

Since

13.12.0

Return values

non	zero if disable.

Definition at line 491 of file config_global.c.

{
    unsigned int disable_initial_unsolicited;
    struct global_config *cfg;
 
    cfg = get_global_cfg();
    if (!cfg) {
        return DEFAULT_MWI_DISABLE_INITIAL_UNSOLICITED;
    }
 
    disable_initial_unsolicited = cfg->mwi.disable_initial_unsolicited;
    ao2_ref(cfg, -1);
    return disable_initial_unsolicited;
}

References ao2_ref, DEFAULT_MWI_DISABLE_INITIAL_UNSOLICITED, global_config::disable_initial_unsolicited, get_global_cfg(), and global_config::mwi.

Referenced by load_module(), and reload().

ast_sip_get_mwi_tps_queue_high()

unsigned int ast_sip_get_mwi_tps_queue_high

(

void

)

Retrieve the global MWI taskprocessor high water alert trigger level.

Since

13.12.0

Return values

the	system MWI taskprocessor high water alert trigger level

Definition at line 461 of file config_global.c.

{
    unsigned int tps_queue_high;
    struct global_config *cfg;
 
    cfg = get_global_cfg();
    if (!cfg) {
        return DEFAULT_MWI_TPS_QUEUE_HIGH;
    }
 
    tps_queue_high = cfg->mwi.tps_queue_high;
    ao2_ref(cfg, -1);
    return tps_queue_high;
}

References ao2_ref, DEFAULT_MWI_TPS_QUEUE_HIGH, get_global_cfg(), global_config::mwi, and global_config::tps_queue_high.

Referenced by global_loaded().

ast_sip_get_mwi_tps_queue_low()

int ast_sip_get_mwi_tps_queue_low

(

void

)

Retrieve the global MWI taskprocessor low water clear alert level.

Since

13.12.0

Return values

the	system MWI taskprocessor low water clear alert level

Definition at line 476 of file config_global.c.

{
    int tps_queue_low;
    struct global_config *cfg;
 
    cfg = get_global_cfg();
    if (!cfg) {
        return DEFAULT_MWI_TPS_QUEUE_LOW;
    }
 
    tps_queue_low = cfg->mwi.tps_queue_low;
    ao2_ref(cfg, -1);
    return tps_queue_low;
}

References ao2_ref, DEFAULT_MWI_TPS_QUEUE_LOW, get_global_cfg(), global_config::mwi, and global_config::tps_queue_low.

Referenced by global_loaded().

ast_sip_get_norefersub()

unsigned int ast_sip_get_norefersub

(

void

)

Retrieve the global setting 'norefersub'.

Return values

non	zero if norefersub is to be sent in "Supported" Headers

Definition at line 581 of file config_global.c.

{
    unsigned int norefersub;
    struct global_config *cfg;
 
    cfg = get_global_cfg();
    if (!cfg) {
        return DEFAULT_NOREFERSUB;
    }
 
    norefersub = cfg->norefersub;
    ao2_ref(cfg, -1);
    return norefersub;
}

References ao2_ref, DEFAULT_NOREFERSUB, get_global_cfg(), and global_config::norefersub.

Referenced by load_module().

ast_sip_get_pjsip_endpoint()

pjsip_endpoint * ast_sip_get_pjsip_endpoint

(

void

)

Get a pointer to the PJSIP endpoint.

This is useful when modules have specific information they need to register with the PJSIP core.

Return values

NULL	endpoint has not been created yet.
non-NULL	PJSIP endpoint.

Definition at line 520 of file res_pjsip.c.

{
    return ast_pjsip_endpoint;
}

References ast_pjsip_endpoint.

Referenced by acl_on_rx_msg(), aoc_release_pool(), aoc_send_as_xml(), ast_res_pjsip_cleanup_options_handling(), ast_res_pjsip_init_options_handling(), ast_sip_create_response(), ast_sip_destroy_transport_events(), ast_sip_initialize_transport_events(), ast_sip_pubsub_register_body_generator(), ast_sip_send_response(), ast_sip_send_stateful_response(), ast_sip_session_defer_termination(), ast_sip_session_resume_reinvite(), authenticate(), cancel_publish_refresh(), cancel_registration(), channel_read_pjsip(), create_out_of_dialog_request(), digest_create_request_with_auth(), distribute(), distributor(), do_cli_dump_endpt(), endpoint_lookup(), endpt_send_request(), endpt_send_request_cb(), exten_state_data_alloc(), exten_state_data_destructor(), exten_state_publisher_cb(), filter_on_tx_message(), find_registrar_aor(), insert_user_in_contact_uri(), keepalive_transport_send_keepalive(), load_module(), load_module(), load_module(), load_module(), load_module(), load_module(), load_module(), logging_on_rx_msg(), logging_on_tx_msg(), notify_task(), on_rx_process_uris(), options_incoming_request(), parse_uri_cb(), pool_destroy_callback(), pre_session_setup(), publish_request_initial(), pubsub_on_rx_mwi_notify_request(), pubsub_on_rx_publish_request(), pubsub_on_rx_subscribe_request(), register_aor(), register_aor_core(), registrar_on_rx_request(), reschedule_reinvite(), schedule_publish_refresh(), schedule_registration(), send_options_response(), session_reinvite_on_rx_request(), sip_dialog_create_contact(), sip_dialog_create_from(), sip_outbound_publisher_init(), sip_outbound_registration_regc_alloc(), sip_publication_respond(), sip_session_defer_termination_stop_timer(), subscription_persistence_load(), system_create_resolver_and_set_nameservers(), t38_change_state(), transport_apply(), and transport_create().

ast_sip_get_regcontext()

char * ast_sip_get_regcontext

(

void

)

Retrieve the global regcontext setting.

Since

13.8.0

Note

returned string needs to be de-allocated by caller.

Return values

the	global regcontext setting

Definition at line 280 of file config_global.c.

{
    char *res;
    struct global_config *cfg;
 
    cfg = get_global_cfg();
    if (!cfg) {
        return ast_strdup(DEFAULT_REGCONTEXT);
    }
 
    res = ast_strdup(cfg->regcontext);
    ao2_ref(cfg, -1);
 
    return res;
}

References ao2_ref, ast_strdup, DEFAULT_REGCONTEXT, get_global_cfg(), and global_config::regcontext.

Referenced by ast_sip_persistent_endpoint_update_state().

ast_sip_get_send_contact_status_on_update_registration()

unsigned int ast_sip_get_send_contact_status_on_update_registration

(

void

)

Retrieve the global setting 'send_contact_status_on_update_registration'.

Since

16.2.0

Return values

non	zero if need to send AMI ContactStatus event when a contact is updated.

Definition at line 551 of file config_global.c.

{
    unsigned int send_contact_status_on_update_registration;
    struct global_config *cfg;
 
    cfg = get_global_cfg();
    if (!cfg) {
        return DEFAULT_SEND_CONTACT_STATUS_ON_UPDATE_REGISTRATION;
    }
 
    send_contact_status_on_update_registration = cfg->send_contact_status_on_update_registration;
    ao2_ref(cfg, -1);
    return send_contact_status_on_update_registration;
}

References ao2_ref, DEFAULT_SEND_CONTACT_STATUS_ON_UPDATE_REGISTRATION, get_global_cfg(), and global_config::send_contact_status_on_update_registration.

Referenced by contact_observer_updated().

ast_sip_get_sorcery()

struct ast_sorcery * ast_sip_get_sorcery

(

void

)

Get a pointer to the SIP sorcery structure.

Return values

NULL	sorcery has not been initialized
non-NULL	sorcery structure

Definition at line 2571 of file pjsip_configuration.c.

{
    return sip_sorcery;
}

References sip_sorcery.

Referenced by acl_change_stasis_cb(), acl_on_rx_msg(), add_security_headers(), alloc_artificial_auth(), ami_show_endpoint(), ami_show_registration_contact_statuses(), ami_show_resource_lists(), ami_sip_qualify(), anonymous_identify(), aor_deleted_observer(), ast_res_pjsip_cleanup_options_handling(), ast_sip_cli_print_sorcery_objectset(), ast_sip_destroy_distributor(), ast_sip_destroy_sorcery_auth(), ast_sip_destroy_sorcery_global(), ast_sip_destroy_sorcery_location(), ast_sip_destroy_transport_management(), ast_sip_for_each_auth(), ast_sip_initialize_distributor(), ast_sip_initialize_sorcery_auth(), ast_sip_initialize_sorcery_domain_alias(), ast_sip_initialize_sorcery_global(), ast_sip_initialize_sorcery_location(), ast_sip_initialize_sorcery_transport(), ast_sip_initialize_transport_management(), ast_sip_location_create_contact(), ast_sip_location_delete_contact(), ast_sip_location_prune_boot_contacts(), ast_sip_location_retrieve_aor(), ast_sip_location_retrieve_aor_contacts_nolock_filtered(), ast_sip_location_retrieve_contact(), ast_sip_location_update_contact(), ast_sip_retrieve_auths(), ast_sip_retrieve_auths_vector(), ast_sip_rewrite_uri_to_local(), ast_sip_set_tpselector_from_transport_name(), ast_sip_sorcery_object_to_ami(), asterisk_publication_devicestate_state_change(), asterisk_publication_mwi_state_change(), asterisk_publication_new(), asterisk_publication_send_refresh(), auth_observer(), can_reuse_registration(), chan_pjsip_devicestate(), check_expiration_thread(), check_state(), cli_aor_get_container(), cli_aor_retrieve_by_id(), cli_complete_endpoint(), cli_complete_registration(), cli_contact_get_container(), cli_endpoint_retrieve_by_id(), cli_get_aors(), cli_get_auths(), cli_get_container(), cli_get_container(), cli_get_container(), cli_get_container(), cli_iterate(), cli_iterator(), cli_qualify(), cli_reload_qualify_aor(), cli_reload_qualify_endpoint(), cli_retrieve_by_id(), cli_retrieve_by_id(), cli_retrieve_by_id(), cli_retrieve_by_id(), cli_show_qualify_endpoint(), common_identify(), contact_observer_updated(), create_artificial_endpoint(), create_mwi_subscriptions(), create_rtp(), find_aor2(), find_aor_name(), find_endpoint(), format_ami_endpoint_identify(), format_ami_endpoint_transport(), get_all_contacts(), get_publishes_and_update_state(), get_registrations(), get_write_timeout(), global_loaded(), handle_atsign(), handle_export_primitives(), handle_registration_response(), handle_single_token(), handle_slash(), line_identify(), load_module(), load_module(), load_module(), load_module(), load_module(), load_module(), load_module(), load_module(), load_module(), load_module(), load_module(), load_module(), load_module(), mwi_contact_changed(), mwi_contact_deleted(), mwi_subscription_shutdown(), on_rx_process_symmetric_transport(), permanent_uri_handler(), pjsip_acf_dial_contacts_read(), pjsip_aor_function_read(), pjsip_contact_function_read(), pjsip_endpoint_function_read(), pjsip_outbound_registration_metrics_init(), pjsip_outbound_registration_metrics_unload_cb(), process_nat(), publish_request_initial(), push_notify(), register_aor_core(), reload_module(), reload_module(), reload_module(), reload_module(), reload_module(), request(), reregister_all(), retrieve_resource_list(), send_unsolicited_mwi_notify(), sip_aor_to_ami(), sip_cli_print_global(), sip_options_aor_observer_modified_task(), sip_options_apply_aor_configuration(), sip_options_contact_add_management_task(), sip_options_init_task(), sip_options_qualify_contact(), sip_options_synchronize_task(), sub_persistence_recreate(), subscription_persistence_create(), subscription_persistence_load(), subscription_persistence_recreate(), subscription_persistence_remove(), subscription_persistence_update(), t38_initialize_session(), transfer(), unload_module(), unload_module(), unload_module(), unload_module(), unload_module(), unload_module(), unload_module(), and unload_module().

ast_sip_get_transport_name()

int ast_sip_get_transport_name	(	const struct ast_sip_endpoint *	endpoint,
		pjsip_sip_uri *	sip_uri,
		char *	buf,
		size_t	buf_len
	)

Get the transport name from an endpoint or request uri.

Since

13.15.0

Parameters

endpoint
sip_uri
buf	Buffer to receive transport name
buf_len	Buffer length

Return values

0	Success
-1	Failure

Note

If endpoint->transport is not NULL, it is returned in buf. Otherwise if sip_uri has an 'x-ast-txp' parameter AND the sip_uri host is an ip4 or ip6 address, its value is returned,

Definition at line 698 of file res_pjsip.c.

{
    char *host = NULL;
    static const pj_str_t x_name = { AST_SIP_X_AST_TXP, AST_SIP_X_AST_TXP_LEN };
    pjsip_param *x_transport;
 
    if (!ast_strlen_zero(endpoint->transport)) {
        ast_copy_string(buf, endpoint->transport, buf_len);
        return 0;
    }
 
    x_transport = pjsip_param_find(&sip_uri->other_param, &x_name);
    if (!x_transport) {
        return -1;
    }
 
    /* Only use x_transport if the uri host is an ip (4 or 6) address */
    host = ast_alloca(sip_uri->host.slen + 1);
    ast_copy_pj_str(host, &sip_uri->host, sip_uri->host.slen + 1);
    if (!ast_sockaddr_parse(NULL, host, PARSE_PORT_FORBID)) {
        return -1;
    }
 
    ast_copy_pj_str(buf, &x_transport->value, buf_len);
 
    return 0;
}

References ast_alloca, ast_copy_pj_str(), ast_copy_string(), AST_SIP_X_AST_TXP, AST_SIP_X_AST_TXP_LEN, ast_sockaddr_parse(), ast_strlen_zero(), buf, NULL, PARSE_PORT_FORBID, and ast_sip_endpoint::transport.

Referenced by ast_sip_set_tpselector_from_ep_or_uri().

ast_sip_get_transport_state()

struct ast_sip_transport_state * ast_sip_get_transport_state

(

const char *

transport_id

)

Retrieve transport state.

Since

13.7.1

Parameters

transport_id

Return values

transport_state

Note

ao2_cleanup(...) or ao2_ref(..., -1) must be called on the returned object

Definition at line 1744 of file config_transport.c.

{
    struct internal_state *state = NULL;
    struct ast_sip_transport_state *trans_state;
 
    if (!transport_states) {
        return NULL;
    }
 
    state = ao2_find(transport_states, transport_id, OBJ_SEARCH_KEY);
    if (!state) {
        return NULL;
    }
 
    trans_state = ao2_bump(state->state);
    ao2_ref(state, -1);
 
    /* If this is a child transport see if the transport is actually dead */
    if (trans_state->flow) {
        ao2_lock(trans_state);
        if (trans_state->transport && trans_state->transport->is_shutdown == PJ_TRUE) {
            pjsip_transport_dec_ref(trans_state->transport);
            trans_state->transport = NULL;
        }
        ao2_unlock(trans_state);
    }
 
    return trans_state;
}

References ao2_bump, ao2_find, ao2_lock, ao2_ref, ao2_unlock, ast_sip_transport_state::flow, NULL, OBJ_SEARCH_KEY, ast_sip_transport_state::transport, and transport_states.

Referenced by ast_sip_message_apply_transport(), ast_sip_set_tpselector_from_transport(), ast_sip_transport_state_set_preferred_identity(), ast_sip_transport_state_set_service_routes(), ast_sip_transport_state_set_transport(), change_outgoing_sdp_stream_media_address(), change_outgoing_sdp_stream_media_address(), create_rtp(), session_outgoing_nat_hook(), t38_initialize_session(), and transport_tls_verify().

ast_sip_get_transport_states()

struct ao2_container * ast_sip_get_transport_states

(

void

)

Retrieves all transport states.

Since

13.7.1

Return values

ao2_container

Note

ao2_cleanup(...) or ao2_ref(..., -1) must be called on the returned object

Definition at line 1784 of file config_transport.c.

{
    struct ao2_container *states = ao2_container_alloc_hash(AO2_ALLOC_OPT_LOCK_MUTEX, 0,
        DEFAULT_STATE_BUCKETS, transport_state_hash, NULL, transport_state_cmp);
 
    if (!states) {
        return NULL;
    }
 
    ao2_callback(transport_states, OBJ_NODATA | OBJ_MULTIPLE, populate_transport_states, states);
    return states;
}

References AO2_ALLOC_OPT_LOCK_MUTEX, ao2_callback, ao2_container_alloc_hash, DEFAULT_STATE_BUCKETS, NULL, OBJ_MULTIPLE, OBJ_NODATA, populate_transport_states(), transport_state_cmp(), transport_state_hash(), and transport_states.

Referenced by anonymous_identify(), ast_sip_find_transport_state_in_use(), find_endpoint(), get_udp_transport(), and get_write_timeout().

ast_sip_get_unidentified_request_thresholds()

void ast_sip_get_unidentified_request_thresholds	(	unsigned int *	count,
		unsigned int *	period,
		unsigned int *	prune_interval
	)

Retrieve the unidentified request security event thresholds.

Since

13.8.0

Parameters

count	The maximum number of unidentified requests per source ip to accumulate before emitting a security event
period	The period in seconds over which to accumulate unidentified requests
prune_interval	The interval in seconds at which expired entries will be pruned

Definition at line 387 of file config_global.c.

{
    struct global_config *cfg;
 
    cfg = get_global_cfg();
    if (!cfg) {
        *count = DEFAULT_UNIDENTIFIED_REQUEST_COUNT;
        *period = DEFAULT_UNIDENTIFIED_REQUEST_PERIOD;
        *prune_interval = DEFAULT_UNIDENTIFIED_REQUEST_PRUNE_INTERVAL;
        return;
    }
 
    *count = cfg->unidentified_request_count;
    *period = cfg->unidentified_request_period;
    *prune_interval = cfg->unidentified_request_prune_interval;
 
    ao2_ref(cfg, -1);
    return;
}

References ao2_ref, DEFAULT_UNIDENTIFIED_REQUEST_COUNT, DEFAULT_UNIDENTIFIED_REQUEST_PERIOD, DEFAULT_UNIDENTIFIED_REQUEST_PRUNE_INTERVAL, get_global_cfg(), global_config::unidentified_request_count, global_config::unidentified_request_period, and global_config::unidentified_request_prune_interval.

Referenced by global_loaded(), and prune_task().

ast_sip_get_use_callerid_contact()

unsigned int ast_sip_get_use_callerid_contact

(

void

)

Retrieve the global setting 'use_callerid_contact'.

Since

13.24.0

Return values

non	zero if CALLERID(num) is to be used as the default username in the contact

Definition at line 536 of file config_global.c.

{
    unsigned int use_callerid_contact;
    struct global_config *cfg;
 
    cfg = get_global_cfg();
    if (!cfg) {
        return DEFAULT_USE_CALLERID_CONTACT;
    }
 
    use_callerid_contact = cfg->use_callerid_contact;
    ao2_ref(cfg, -1);
    return use_callerid_contact;
}

References ao2_ref, DEFAULT_USE_CALLERID_CONTACT, get_global_cfg(), and global_config::use_callerid_contact.

Referenced by set_from_header().

ast_sip_hangup_sip2cause()

const int ast_sip_hangup_sip2cause

(

int

cause

)

Convert SIP hangup causes to Asterisk hangup causes.

Parameters

cause

SIP cause

Return values

matched

cause code from causes.h

Definition at line 3531 of file res_pjsip.c.

{
    /* Possible values taken from causes.h */
 
    switch(cause) {
    case 401:       /* Unauthorized */
        return AST_CAUSE_CALL_REJECTED;
    case 403:       /* Not found */
        return AST_CAUSE_CALL_REJECTED;
    case 404:       /* Not found */
        return AST_CAUSE_UNALLOCATED;
    case 405:       /* Method not allowed */
        return AST_CAUSE_INTERWORKING;
    case 407:       /* Proxy authentication required */
        return AST_CAUSE_CALL_REJECTED;
    case 408:       /* No reaction */
        return AST_CAUSE_NO_USER_RESPONSE;
    case 409:       /* Conflict */
        return AST_CAUSE_NORMAL_TEMPORARY_FAILURE;
    case 410:       /* Gone */
        return AST_CAUSE_NUMBER_CHANGED;
    case 411:       /* Length required */
        return AST_CAUSE_INTERWORKING;
    case 413:       /* Request entity too large */
        return AST_CAUSE_INTERWORKING;
    case 414:       /* Request URI too large */
        return AST_CAUSE_INTERWORKING;
    case 415:       /* Unsupported media type */
        return AST_CAUSE_INTERWORKING;
    case 420:       /* Bad extension */
        return AST_CAUSE_NO_ROUTE_DESTINATION;
    case 480:       /* No answer */
        return AST_CAUSE_NO_ANSWER;
    case 481:       /* No answer */
        return AST_CAUSE_INTERWORKING;
    case 482:       /* Loop detected */
        return AST_CAUSE_INTERWORKING;
    case 483:       /* Too many hops */
        return AST_CAUSE_NO_ANSWER;
    case 484:       /* Address incomplete */
        return AST_CAUSE_INVALID_NUMBER_FORMAT;
    case 485:       /* Ambiguous */
        return AST_CAUSE_UNALLOCATED;
    case 486:       /* Busy everywhere */
        return AST_CAUSE_BUSY;
    case 487:       /* Request terminated */
        return AST_CAUSE_INTERWORKING;
    case 488:       /* No codecs approved */
        return AST_CAUSE_BEARERCAPABILITY_NOTAVAIL;
    case 491:       /* Request pending */
        return AST_CAUSE_INTERWORKING;
    case 493:       /* Undecipherable */
        return AST_CAUSE_INTERWORKING;
    case 500:       /* Server internal failure */
        return AST_CAUSE_FAILURE;
    case 501:       /* Call rejected */
        return AST_CAUSE_FACILITY_REJECTED;
    case 502:
        return AST_CAUSE_DESTINATION_OUT_OF_ORDER;
    case 503:       /* Service unavailable */
        return AST_CAUSE_CONGESTION;
    case 504:       /* Gateway timeout */
        return AST_CAUSE_RECOVERY_ON_TIMER_EXPIRE;
    case 505:       /* SIP version not supported */
        return AST_CAUSE_INTERWORKING;
    case 600:       /* Busy everywhere */
        return AST_CAUSE_USER_BUSY;
    case 603:       /* Decline */
        return AST_CAUSE_CALL_REJECTED;
    case 604:       /* Does not exist anywhere */
        return AST_CAUSE_UNALLOCATED;
    case 606:       /* Not acceptable */
        return AST_CAUSE_BEARERCAPABILITY_NOTAVAIL;
    default:
        if (cause < 500 && cause >= 400) {
            /* 4xx class error that is unknown - someting wrong with our request */
            return AST_CAUSE_INTERWORKING;
        } else if (cause < 600 && cause >= 500) {
            /* 5xx class error - problem in the remote end */
            return AST_CAUSE_CONGESTION;
        } else if (cause < 700 && cause >= 600) {
            /* 6xx - global errors in the 4xx class */
            return AST_CAUSE_INTERWORKING;
        }
        return AST_CAUSE_NORMAL;
    }
    /* Never reached */
    return 0;
}

References AST_CAUSE_BEARERCAPABILITY_NOTAVAIL, AST_CAUSE_BUSY, AST_CAUSE_CALL_REJECTED, AST_CAUSE_CONGESTION, AST_CAUSE_DESTINATION_OUT_OF_ORDER, AST_CAUSE_FACILITY_REJECTED, AST_CAUSE_FAILURE, AST_CAUSE_INTERWORKING, AST_CAUSE_INVALID_NUMBER_FORMAT, AST_CAUSE_NO_ANSWER, AST_CAUSE_NO_ROUTE_DESTINATION, AST_CAUSE_NO_USER_RESPONSE, AST_CAUSE_NORMAL, AST_CAUSE_NORMAL_TEMPORARY_FAILURE, AST_CAUSE_NUMBER_CHANGED, AST_CAUSE_RECOVERY_ON_TIMER_EXPIRE, AST_CAUSE_UNALLOCATED, and AST_CAUSE_USER_BUSY.

Referenced by chan_pjsip_incoming_response_update_cause(), chan_pjsip_session_end(), and rfc3326_use_reason_header().

ast_sip_header_to_security_mechanism()

void ast_sip_header_to_security_mechanism	(	const pjsip_generic_string_hdr *	hdr,
		struct ast_sip_security_mechanism_vector *	security_mechanisms
	)

Append to security mechanism vector from SIP header.

Parameters

hdr	The header of the security mechanisms.
security_mechanisms	Vector of security mechanisms to append to. Header name must be one of Security-Client, Security-Server, Security-Verify.

Definition at line 333 of file security_agreements.c.

                                                                       {
 
    struct ast_sip_security_mechanism *mech;
    char buf[512];
    char *hdr_val;
    char *mechanism;
 
    if (!security_mechanisms || !hdr) {
        return;
    }
 
    if (pj_stricmp2(&hdr->name, "Security-Client") && pj_stricmp2(&hdr->name, "Security-Server") &&
            pj_stricmp2(&hdr->name, "Security-Verify")) {
        return;
    }
 
    ast_copy_pj_str(buf, &hdr->hvalue, sizeof(buf));
    hdr_val = ast_skip_blanks(buf);
 
    while ((mechanism = ast_strsep(&hdr_val, ',', AST_STRSEP_ALL))) {
        if (!ast_sip_str_to_security_mechanism(&mech, mechanism)) {
            AST_VECTOR_APPEND(security_mechanisms, mech);
        }
    }
}

References ast_copy_pj_str(), ast_sip_str_to_security_mechanism(), ast_skip_blanks(), ast_strsep(), AST_STRSEP_ALL, AST_VECTOR_APPEND, and buf.

Referenced by contact_add_security_headers_to_status(), and handle_registration_response().

ast_sip_identify_endpoint()

struct ast_sip_endpoint * ast_sip_identify_endpoint

(

pjsip_rx_data *

rdata

)

Determine the endpoint that has sent a SIP message.

This will call into each of the registered endpoint identifiers' identify_endpoint() callbacks until one returns a non-NULL endpoint. This will return an ao2 object. Its reference count will need to be decremented when completed using the endpoint.

Parameters

rdata

The inbound SIP message to use when identifying the endpoint.

Return values

NULL	No matching endpoint
non-NULL	The matching endpoint

Definition at line 330 of file res_pjsip.c.

{
    struct endpoint_identifier_list *iter;
    struct ast_sip_endpoint *endpoint = NULL;
    SCOPED_LOCK(lock, &endpoint_identifiers, AST_RWLIST_RDLOCK, AST_RWLIST_UNLOCK);
    AST_RWLIST_TRAVERSE(&endpoint_identifiers, iter, list) {
        ast_assert(iter->identifier->identify_endpoint != NULL);
        endpoint = iter->identifier->identify_endpoint(rdata);
        if (endpoint) {
            break;
        }
    }
    return endpoint;
}

References ast_assert, AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, endpoint_identifier_list::identifier, ast_sip_endpoint_identifier::identify_endpoint, lock, NULL, and SCOPED_LOCK.

Referenced by endpoint_lookup().

ast_sip_is_allowed_uri()

int ast_sip_is_allowed_uri

(

pjsip_uri *

uri

)

Check whether a pjsip_uri is allowed or not.

Since

16.28.0

Parameters

uri	The pjsip_uri to check

Return values

1	if allowed
0	if not allowed

Definition at line 3472 of file res_pjsip.c.

{
    return (ast_sip_is_uri_sip_sips(uri) || PJSIP_URI_SCHEME_IS_TEL(uri));
}

References ast_sip_is_uri_sip_sips().

Referenced by endpoint_lookup(), get_destination(), on_rx_process_uris(), options_on_rx_request(), rx_data_to_ast_msg(), and set_redirecting_reason_by_cause().

ast_sip_is_content_type()

int ast_sip_is_content_type	(	pjsip_media_type *	content_type,
		char *	type,
		char *	subtype
	)

Checks if the given content type matches type/subtype.

Compares the pjsip_media_type with the passed type and subtype and returns the result of that comparison. The media type parameters are ignored.

Parameters

content_type	The pjsip_media_type structure to compare
type	The media type to compare
subtype	The media subtype to compare

Return values

0	No match
-1	Match

Definition at line 2248 of file res_pjsip.c.

{
    pjsip_media_type compare;
 
    if (!content_type) {
        return 0;
    }
 
    pjsip_media_type_init2(&compare, type, subtype);
 
    return pjsip_media_type_cmp(content_type, &compare, 0) ? 0 : -1;
}

References compare(), and type.

Referenced by asterisk_publication_devicestate_state_change(), asterisk_publication_mwi_state_change(), check_content_type(), and pubsub_on_rx_notify_request().

ast_sip_is_media_type_in()

int ast_sip_is_media_type_in	(	pjsip_media_type *	a,
			...
	)

Check if a media type is in a list of others.

Parameters

a	pjsip_media_type to search for
...	one or more pointers to pjsip_media_types the last of which must be "SENTINEL"

Return values

1	Media types are equal
0	Media types are not equal

Definition at line 2228 of file res_pjsip.c.

{
    int rc = 0;
    pjsip_media_type *b = NULL;
    va_list ap;
 
    ast_assert(a != NULL);
    va_start(ap, a);
 
    while ((b = va_arg(ap, pjsip_media_type *)) != (pjsip_media_type *)SENTINEL) {
        if (pjsip_media_type_cmp(a, b, 0) == 0) {
            rc = 1;
            break;
        }
    }
    va_end(ap);
 
    return rc;
}

References a, ast_assert, b, NULL, and SENTINEL.

Referenced by check_content_disposition().

ast_sip_is_uri_sip_sips()

int ast_sip_is_uri_sip_sips

(

pjsip_uri *

uri

)

Check whether a pjsip_uri is SIP/SIPS or not.

Since

16.28.0

Parameters

uri	The pjsip_uri to check

Return values

1	if true
0	if false

Definition at line 3467 of file res_pjsip.c.

{
    return (PJSIP_URI_SCHEME_IS_SIP(uri) || PJSIP_URI_SCHEME_IS_SIPS(uri));
}

Referenced by ast_sip_is_allowed_uri(), ast_sip_pjsip_uri_get_hostname(), ast_sip_pjsip_uri_get_other_param(), ast_sip_pjsip_uri_get_username(), filter_on_tx_message(), get_endpoint_details(), get_from_header(), publish_request_initial(), pubsub_on_rx_subscribe_request(), sanitize_tdata(), and set_id_from_oli().

ast_sip_location_add_contact()

int ast_sip_location_add_contact	(	struct ast_sip_aor *	aor,
		const char *	uri,
		struct timeval	expiration_time,
		const char *	path_info,
		const char *	user_agent,
		const char *	via_addr,
		int	via_port,
		const char *	call_id,
		struct ast_sip_endpoint *	endpoint
	)

Add a new contact to an AOR.

Parameters

aor	Pointer to the AOR
uri	Full contact URI
expiration_time	Optional expiration time of the contact
path_info	Path information
user_agent	User-Agent header from REGISTER request
via_addr
via_port
call_id
endpoint	The endpoint that resulted in the contact being added

Return values

-1	failure
0	success

Warning

This function holds a named write lock on the aor. If you already hold the lock you should call ast_sip_location_add_contact_nolock instead.

Definition at line 430 of file location.c.

{
    int res;
 
    ao2_lock(aor);
    res = ast_sip_location_add_contact_nolock(aor, uri, expiration_time, path_info, user_agent,
        via_addr, via_port, call_id,
        endpoint);
    ao2_unlock(aor);
 
    return res;
}

References ao2_lock, ao2_unlock, ast_sip_contact::aor, ast_sip_location_add_contact_nolock(), ast_sip_contact::call_id, ast_sip_contact::endpoint, ast_sip_contact::expiration_time, ast_sip_contact::uri, ast_sip_contact::user_agent, ast_sip_contact::via_addr, and ast_sip_contact::via_port.

ast_sip_location_add_contact_nolock()

int ast_sip_location_add_contact_nolock	(	struct ast_sip_aor *	aor,
		const char *	uri,
		struct timeval	expiration_time,
		const char *	path_info,
		const char *	user_agent,
		const char *	via_addr,
		int	via_port,
		const char *	call_id,
		struct ast_sip_endpoint *	endpoint
	)

Add a new contact to an AOR without locking the AOR.

Since

13.9.0

Parameters

aor	Pointer to the AOR
uri	Full contact URI
expiration_time	Optional expiration time of the contact
path_info	Path information
user_agent	User-Agent header from REGISTER request
via_addr
via_port
call_id
endpoint	The endpoint that resulted in the contact being added

Return values

-1	failure
0	success

Warning

This function should only be called if you already hold a named write lock on the aor.

Definition at line 417 of file location.c.

{
    struct ast_sip_contact *contact;
 
    contact = ast_sip_location_create_contact(aor, uri, expiration_time, path_info,
        user_agent, via_addr, via_port, call_id, 0, endpoint);
    ao2_cleanup(contact);
    return contact ? 0 : -1;
}

References ao2_cleanup, ast_sip_contact::aor, ast_sip_location_create_contact(), ast_sip_contact::call_id, ast_sip_contact::endpoint, ast_sip_contact::expiration_time, ast_sip_contact::uri, ast_sip_contact::user_agent, ast_sip_contact::via_addr, and ast_sip_contact::via_port.

Referenced by ast_sip_location_add_contact().

ast_sip_location_create_contact()

struct ast_sip_contact * ast_sip_location_create_contact	(	struct ast_sip_aor *	aor,
		const char *	uri,
		struct timeval	expiration_time,
		const char *	path_info,
		const char *	user_agent,
		const char *	via_addr,
		int	via_port,
		const char *	call_id,
		int	prune_on_boot,
		struct ast_sip_endpoint *	endpoint
	)

Create a new contact for an AOR without locking the AOR.

Since

13.18.0

Parameters

aor	Pointer to the AOR
uri	Full contact URI
expiration_time	Optional expiration time of the contact
path_info	Path information
user_agent	User-Agent header from REGISTER request
via_addr
via_port
call_id
prune_on_boot	Non-zero if the contact cannot survive a restart/boot.
endpoint	The endpoint that resulted in the contact being added

Returns

The created contact or NULL on failure.

Warning

This function should only be called if you already hold a named write lock on the aor.

Definition at line 355 of file location.c.

{
    struct ast_sip_contact *contact;
    char name[MAX_OBJECT_FIELD * 2 + 3];
    char hash[33];
 
    ast_md5_hash(hash, uri);
    snprintf(name, sizeof(name), "%s;@%s", ast_sorcery_object_get_id(aor), hash);
 
    contact = ast_sorcery_alloc(ast_sip_get_sorcery(), "contact", name);
    if (!contact) {
        return NULL;
    }
 
    ast_string_field_set(contact, uri, uri);
    contact->expiration_time = expiration_time;
    contact->qualify_frequency = aor->qualify_frequency;
    contact->qualify_timeout = aor->qualify_timeout;
    contact->qualify_2xx_only = aor->qualify_2xx_only;
    contact->authenticate_qualify = aor->authenticate_qualify;
    if (path_info && aor->support_path) {
        ast_string_field_set(contact, path, path_info);
    }
 
    if (!ast_strlen_zero(aor->outbound_proxy)) {
        ast_string_field_set(contact, outbound_proxy, aor->outbound_proxy);
    }
 
    if (!ast_strlen_zero(user_agent)) {
        ast_string_field_set(contact, user_agent, user_agent);
    }
 
    if (!ast_strlen_zero(ast_config_AST_SYSTEM_NAME)) {
        ast_string_field_set(contact, reg_server, ast_config_AST_SYSTEM_NAME);
    }
 
    if (!ast_strlen_zero(via_addr)) {
        ast_string_field_set(contact, via_addr, via_addr);
    }
    contact->via_port = via_port;
 
    if (!ast_strlen_zero(call_id)) {
        ast_string_field_set(contact, call_id, call_id);
    }
 
    contact->endpoint = ao2_bump(endpoint);
    if (endpoint) {
        ast_string_field_set(contact, endpoint_name, ast_sorcery_object_get_id(endpoint));
    }
 
    contact->prune_on_boot = prune_on_boot;
 
    if (ast_sorcery_create(ast_sip_get_sorcery(), contact)) {
        ao2_ref(contact, -1);
        return NULL;
    }
    return contact;
}

References ao2_bump, ao2_ref, ast_sip_contact::aor, ast_config_AST_SYSTEM_NAME, ast_md5_hash(), ast_sip_get_sorcery(), ast_sorcery_alloc(), ast_sorcery_create(), ast_sorcery_object_get_id(), ast_string_field_set, ast_strlen_zero(), ast_sip_contact::authenticate_qualify, ast_sip_contact::call_id, ast_sip_contact::endpoint, ast_sip_contact::endpoint_name, ast_sip_contact::expiration_time, MAX_OBJECT_FIELD, name, NULL, ast_sip_contact::outbound_proxy, ast_sip_contact::path, ast_sip_contact::prune_on_boot, ast_sip_contact::qualify_2xx_only, ast_sip_contact::qualify_frequency, ast_sip_contact::qualify_timeout, ast_sip_contact::reg_server, ast_sip_contact::uri, ast_sip_contact::user_agent, ast_sip_contact::via_addr, and ast_sip_contact::via_port.

Referenced by ast_sip_location_add_contact_nolock(), and register_aor_core().

ast_sip_location_delete_contact()

int ast_sip_location_delete_contact

(

struct ast_sip_contact *

contact

)

Delete a contact.

Parameters

contact

Contact object to delete

Return values

-1	failure
0	success

Definition at line 451 of file location.c.

{
    return ast_sorcery_delete(ast_sip_get_sorcery(), contact);
}

References ast_sip_get_sorcery(), and ast_sorcery_delete().

Referenced by contact_expire(), destroy_contact(), prune_boot_contacts_cb(), and registrar_contact_delete().

ast_sip_location_prune_boot_contacts()

void ast_sip_location_prune_boot_contacts

(

void

)

Prune the prune_on_boot contacts.

Since

13.18.0

Definition at line 470 of file location.c.

{
    struct ao2_container *contacts;
 
    contacts = ast_sorcery_retrieve_by_fields(ast_sip_get_sorcery(), "contact",
        AST_RETRIEVE_FLAG_MULTIPLE | AST_RETRIEVE_FLAG_ALL, NULL);
    if (contacts) {
        ao2_callback(contacts, 0, prune_boot_contacts_cb, NULL);
        ao2_ref(contacts, -1);
    }
}

References ao2_callback, ao2_ref, AST_RETRIEVE_FLAG_ALL, AST_RETRIEVE_FLAG_MULTIPLE, ast_sip_get_sorcery(), ast_sorcery_retrieve_by_fields(), NULL, and prune_boot_contacts_cb().

Referenced by load_module().

ast_sip_location_retrieve_aor()

struct ast_sip_aor * ast_sip_location_retrieve_aor

(

const char *

aor_name

)

Retrieve a named AOR.

Parameters

aor_name

Name of the AOR

Return values

NULL	if not found
non-NULL	if found

Definition at line 147 of file location.c.

{
    return ast_sorcery_retrieve_by_id(ast_sip_get_sorcery(), "aor", aor_name);
}

References ast_sip_get_sorcery(), and ast_sorcery_retrieve_by_id().

Referenced by ast_sip_for_each_aor(), ast_sip_location_retrieve_contact_and_aor_from_list_filtered(), find_aor(), find_aor2(), find_aor_for_resource(), find_registrar_aor(), handle_slash(), notify_endpoint(), pjsip_acf_dial_contacts_read(), register_contact_transport_remove_cb(), send_unsolicited_mwi_notify(), and vec_contact_cmp().

ast_sip_location_retrieve_aor_contacts()

struct ao2_container * ast_sip_location_retrieve_aor_contacts

(

const struct ast_sip_aor *

aor

)

Retrieve all contacts currently available for an AOR.

Parameters

aor	Pointer to the AOR

Return values

NULL	if no contacts available
non-NULL	if contacts available

Warning

Since this function prunes expired contacts before returning, it holds a named write lock on the aor. If you already hold the lock, call ast_sip_location_retrieve_aor_contacts_nolock instead.

Definition at line 247 of file location.c.

{
    return ast_sip_location_retrieve_aor_contacts_filtered(aor, AST_SIP_CONTACT_FILTER_DEFAULT);
}

References AST_SIP_CONTACT_FILTER_DEFAULT, and ast_sip_location_retrieve_aor_contacts_filtered().

Referenced by ast_sip_for_each_contact(), find_contact(), format_ami_aor_handler(), gather_contacts_for_aor(), notify_endpoint(), pjsip_aor_function_read(), and send_unsolicited_mwi_notify().

ast_sip_location_retrieve_aor_contacts_filtered()

struct ao2_container * ast_sip_location_retrieve_aor_contacts_filtered	(	const struct ast_sip_aor *	aor,
		unsigned int	flags
	)

Retrieve all contacts currently available for an AOR and filter based on flags.

Since

13.16.0

Parameters

aor	Pointer to the AOR
flags	Filtering flags

Return values

NULL	if no contacts available
non-NULL	if contacts available

Warning

Since this function prunes expired contacts before returning, it holds a named write lock on the aor. If you already hold the lock, call ast_sip_location_retrieve_aor_contacts_nolock instead.

Definition at line 252 of file location.c.

{
    struct ao2_container *contacts;
 
    /* ao2_lock / ao2_unlock do not actually write aor since it has an ao2 lockobj. */
    ao2_lock((void*)aor);
    contacts = ast_sip_location_retrieve_aor_contacts_nolock_filtered(aor, flags);
    ao2_unlock((void*)aor);
 
    return contacts;
}

References ao2_lock, ao2_unlock, and ast_sip_location_retrieve_aor_contacts_nolock_filtered().

Referenced by ast_sip_location_retrieve_aor_contacts(), ast_sip_location_retrieve_first_aor_contact_filtered(), and pjsip_acf_dial_contacts_read().

ast_sip_location_retrieve_aor_contacts_nolock()

struct ao2_container * ast_sip_location_retrieve_aor_contacts_nolock

(

const struct ast_sip_aor *

aor

)

Retrieve all contacts currently available for an AOR without locking the AOR.

Since

13.9.0

Parameters

aor	Pointer to the AOR

Return values

NULL	if no contacts available
non-NULL	if contacts available

Warning

This function should only be called if you already hold a named write lock on the aor.

Definition at line 214 of file location.c.

{
    return ast_sip_location_retrieve_aor_contacts_nolock_filtered(aor, AST_SIP_CONTACT_FILTER_DEFAULT);
}

References AST_SIP_CONTACT_FILTER_DEFAULT, and ast_sip_location_retrieve_aor_contacts_nolock_filtered().

Referenced by register_aor().

ast_sip_location_retrieve_aor_contacts_nolock_filtered()

struct ao2_container * ast_sip_location_retrieve_aor_contacts_nolock_filtered	(	const struct ast_sip_aor *	aor,
		unsigned int	flags
	)

Retrieve all contacts currently available for an AOR without locking the AOR and filter based on flags.

Since

13.16.0

Parameters

aor	Pointer to the AOR
flags	Filtering flags

Return values

NULL	if no contacts available
non-NULL	if contacts available

Warning

This function should only be called if you already hold a named write lock on the aor.

Definition at line 219 of file location.c.

{
    /* Give enough space for ;@ at the end, since that is our object naming scheme */
    size_t prefix_len = strlen(ast_sorcery_object_get_id(aor)) + sizeof(";@") - 1;
    char prefix[prefix_len + 1];
    struct ao2_container *contacts;
 
    sprintf(prefix, "%s;@", ast_sorcery_object_get_id(aor)); /* Safe */
    if (!(contacts = ast_sorcery_retrieve_by_prefix(ast_sip_get_sorcery(), "contact", prefix, prefix_len))) {
        return NULL;
    }
 
    /* Prune any expired contacts and delete them, we do this first because static contacts can never expire */
    ao2_callback(contacts, OBJ_NODATA | OBJ_MULTIPLE | OBJ_UNLINK, contact_expire, NULL);
 
    /* Add any permanent contacts from the AOR */
    if (aor->permanent_contacts) {
        ao2_callback(aor->permanent_contacts, OBJ_NODATA, contact_link_static, contacts);
    }
 
    if (flags & AST_SIP_CONTACT_FILTER_REACHABLE) {
        ao2_callback(contacts, OBJ_NODATA | OBJ_MULTIPLE | OBJ_UNLINK, contact_remove_unreachable, NULL);
    }
 
    return contacts;
}

References ao2_callback, AST_SIP_CONTACT_FILTER_REACHABLE, ast_sip_get_sorcery(), ast_sorcery_object_get_id(), ast_sorcery_retrieve_by_prefix(), contact_expire(), contact_link_static(), contact_remove_unreachable(), NULL, OBJ_MULTIPLE, OBJ_NODATA, OBJ_UNLINK, ast_sip_aor::permanent_contacts, and prefix.

Referenced by ast_sip_location_retrieve_aor_contacts_filtered(), and ast_sip_location_retrieve_aor_contacts_nolock().

ast_sip_location_retrieve_contact()

struct ast_sip_contact * ast_sip_location_retrieve_contact

(

const char *

contact_name

)

Retrieve a named contact.

Parameters

contact_name

Name of the contact

Return values

NULL	if not found
non-NULL	if found

Definition at line 350 of file location.c.

{
    return ast_sorcery_retrieve_by_id(ast_sip_get_sorcery(), "contact", contact_name);
}

References ast_sip_get_sorcery(), and ast_sorcery_retrieve_by_id().

Referenced by register_contact_transport_remove_cb().

ast_sip_location_retrieve_contact_and_aor_from_list()

void ast_sip_location_retrieve_contact_and_aor_from_list	(	const char *	aor_list,
		struct ast_sip_aor **	aor,
		struct ast_sip_contact **	contact
	)

Retrieve the first bound contact AND the AOR chosen from a list of AORs.

Parameters

aor_list	A comma-separated list of AOR names
aor	The chosen AOR
contact	The chosen contact

Definition at line 266 of file location.c.

{
    ast_sip_location_retrieve_contact_and_aor_from_list_filtered(aor_list, AST_SIP_CONTACT_FILTER_DEFAULT, aor, contact);
}

References AST_SIP_CONTACT_FILTER_DEFAULT, and ast_sip_location_retrieve_contact_and_aor_from_list_filtered().

Referenced by ast_sip_location_retrieve_contact_from_aor_list().

ast_sip_location_retrieve_contact_and_aor_from_list_filtered()

void ast_sip_location_retrieve_contact_and_aor_from_list_filtered	(	const char *	aor_list,
		unsigned int	flags,
		struct ast_sip_aor **	aor,
		struct ast_sip_contact **	contact
	)

Retrieve the first bound contact AND the AOR chosen from a list of AORs and filter based on flags.

Since

13.16.0

Parameters

aor_list	A comma-separated list of AOR names
flags	Filtering flags
aor	The chosen AOR
contact	The chosen contact

Definition at line 272 of file location.c.

{
    char *aor_name;
    char *rest;
 
    /* If the location is still empty we have nowhere to go */
    if (ast_strlen_zero(aor_list) || !(rest = ast_strdupa(aor_list))) {
        ast_log(LOG_WARNING, "Unable to determine contacts from empty aor list\n");
        return;
    }
 
    *aor = NULL;
    *contact = NULL;
 
    while ((aor_name = ast_strip(strsep(&rest, ",")))) {
        *aor = ast_sip_location_retrieve_aor(aor_name);
 
        if (!(*aor)) {
            continue;
        }
        *contact = ast_sip_location_retrieve_first_aor_contact_filtered(*aor, flags);
        /* If a valid contact is available use its URI for dialing */
        if (*contact) {
            break;
        }
 
        ao2_ref(*aor, -1);
        *aor = NULL;
    }
}

References ao2_ref, ast_log, ast_sip_location_retrieve_aor(), ast_sip_location_retrieve_first_aor_contact_filtered(), ast_strdupa, ast_strip(), ast_strlen_zero(), LOG_WARNING, NULL, and strsep().

Referenced by ast_sip_location_retrieve_contact_and_aor_from_list(), and ast_sip_session_create_outgoing().

ast_sip_location_retrieve_contact_from_aor_list()

struct ast_sip_contact * ast_sip_location_retrieve_contact_from_aor_list

(

const char *

aor_list

)

Retrieve the first bound contact from a list of AORs.

Parameters

aor_list

A comma-separated list of AOR names

Return values

NULL	if no contacts available
non-NULL	if contacts available

Definition at line 304 of file location.c.

{
    struct ast_sip_aor *aor;
    struct ast_sip_contact *contact;
 
    ast_sip_location_retrieve_contact_and_aor_from_list(aor_list, &aor, &contact);
 
    ao2_cleanup(aor);
 
    return contact;
}

References ao2_cleanup, ast_sip_contact::aor, and ast_sip_location_retrieve_contact_and_aor_from_list().

Referenced by ast_sip_create_subscription(), create_out_of_dialog_request(), handle_atsign(), handle_single_token(), insert_user_in_contact_uri(), mwi_contact_deleted(), and transfer().

ast_sip_location_retrieve_contacts_from_aor_list()

struct ao2_container * ast_sip_location_retrieve_contacts_from_aor_list

(

const char *

aor_list

)

Retrieve all contacts from a list of AORs.

Parameters

aor_list

A comma-separated list of AOR names

Return values

NULL	if no contacts available
non-NULL	container (which must be freed) if contacts available

Definition at line 335 of file location.c.

{
    struct ao2_container *contacts;
 
    contacts = ao2_container_alloc_list(AO2_ALLOC_OPT_LOCK_NOLOCK,
        AO2_CONTAINER_ALLOC_OPT_DUPS_REJECT, permanent_uri_sort_fn, NULL);
    if (!contacts) {
        return NULL;
    }
 
    ast_sip_for_each_aor(aor_list, gather_contacts_for_aor, contacts);
 
    return contacts;
}

References AO2_ALLOC_OPT_LOCK_NOLOCK, ao2_container_alloc_list, AO2_CONTAINER_ALLOC_OPT_DUPS_REJECT, ast_sip_for_each_aor(), gather_contacts_for_aor(), NULL, and permanent_uri_sort_fn().

Referenced by add_security_headers(), and handle_registration_response().

ast_sip_location_retrieve_first_aor_contact()

struct ast_sip_contact * ast_sip_location_retrieve_first_aor_contact

(

const struct ast_sip_aor *

aor

)

Retrieve the first bound contact for an AOR.

Parameters

aor	Pointer to the AOR

Return values

NULL	if no contacts available
non-NULL	if contacts available

Definition at line 194 of file location.c.

{
    return ast_sip_location_retrieve_first_aor_contact_filtered(aor, AST_SIP_CONTACT_FILTER_DEFAULT);
}

References ast_sip_contact::aor, AST_SIP_CONTACT_FILTER_DEFAULT, and ast_sip_location_retrieve_first_aor_contact_filtered().

Referenced by handle_slash().

ast_sip_location_retrieve_first_aor_contact_filtered()

struct ast_sip_contact * ast_sip_location_retrieve_first_aor_contact_filtered	(	const struct ast_sip_aor *	aor,
		unsigned int	flags
	)

Retrieve the first bound contact for an AOR and filter based on flags.

Since

13.16.0

Parameters

aor	Pointer to the AOR
flags	Filtering flags

Return values

NULL	if no contacts available
non-NULL	if contacts available

Definition at line 199 of file location.c.

{
    struct ao2_container *contacts;
    struct ast_sip_contact *contact = NULL;
 
    contacts = ast_sip_location_retrieve_aor_contacts_filtered(aor, flags);
    if (contacts && ao2_container_count(contacts)) {
        /* Get the first AOR contact in the container. */
        contact = ao2_callback(contacts, 0, NULL, NULL);
    }
    ao2_cleanup(contacts);
    return contact;
}

References ao2_callback, ao2_cleanup, ao2_container_count(), ast_sip_contact::aor, ast_sip_location_retrieve_aor_contacts_filtered(), and NULL.

Referenced by ast_sip_location_retrieve_contact_and_aor_from_list_filtered(), and ast_sip_location_retrieve_first_aor_contact().

ast_sip_location_update_contact()

int ast_sip_location_update_contact

(

struct ast_sip_contact *

contact

)

Update a contact.

Parameters

contact

New contact object with details

Return values

-1	failure
0	success

Definition at line 446 of file location.c.

{
    return ast_sorcery_update(ast_sip_get_sorcery(), contact);
}

References ast_sip_get_sorcery(), and ast_sorcery_update().

Referenced by register_aor_core().

ast_sip_message_apply_transport()

void ast_sip_message_apply_transport	(	const char *	transport_name,
		pjsip_tx_data *	tdata
	)

Apply the configuration for a transport to an outgoing message.

Since

17.0.0

Parameters

transport_name	The name of the transport to apply configuration from
tdata	The SIP message

Definition at line 301 of file config_transport.c.

{
    struct ast_sip_transport_state *transport_state;
 
    if (ast_strlen_zero(transport_name)) {
        return;
    }
 
    /* We only currently care about requests that are of the INVITE, CANCEL, or OPTIONS
     * type but in the future we could support other messages.
     */
    if (tdata->msg->type != PJSIP_REQUEST_MSG ||
        (pjsip_method_cmp(&tdata->msg->line.req.method, &pjsip_invite_method) &&
        pjsip_method_cmp(&tdata->msg->line.req.method, &pjsip_cancel_method) &&
        pjsip_method_cmp(&tdata->msg->line.req.method, &pjsip_options_method))) {
        return;
    }
 
    transport_state = ast_sip_get_transport_state(transport_name);
    if (!transport_state) {
        return;
    }
 
    if (!transport_state->flow) {
        ao2_ref(transport_state, -1);
        return;
    }
 
    ao2_lock(transport_state);
 
    /* If a Preferred Identity has been set then add it to the request */
    if (transport_state->preferred_identity) {
        ast_sip_add_header(tdata, "P-Preferred-Identity", transport_state->preferred_identity);
    }
 
    /* If Service Routes have been set then add them to the request */
    if (transport_state->service_routes) {
        int idx;
 
        for (idx = 0; idx < AST_VECTOR_SIZE(transport_state->service_routes); ++idx) {
            char *service_route = AST_VECTOR_GET(transport_state->service_routes, idx);
 
            ast_sip_add_header(tdata, "Route", service_route);
        }
    }
 
    ao2_unlock(transport_state);
 
    ao2_ref(transport_state, -1);
}

References ao2_lock, ao2_ref, ao2_unlock, ast_sip_add_header(), ast_sip_get_transport_state(), ast_strlen_zero(), AST_VECTOR_GET, AST_VECTOR_SIZE, ast_sip_transport_state::flow, ast_sip_transport_state::preferred_identity, and ast_sip_transport_state::service_routes.

Referenced by ast_sip_send_out_of_dialog_request(), handle_outgoing_request(), handle_outgoing_response(), and supplement_outgoing_response().

ast_sip_modify_id_header()

void ast_sip_modify_id_header	(	pj_pool_t *	pool,
		pjsip_fromto_hdr *	id_hdr,
		const struct ast_party_id *	id
	)

Set name and number information on an identity header.

Parameters

pool	Memory pool to use for string duplication
id_hdr	A From, P-Asserted-Identity, or Remote-Party-ID header to modify
id	The identity information to apply to the header

Definition at line 2850 of file res_pjsip.c.

{
    pjsip_name_addr *id_name_addr;
    pjsip_sip_uri *id_uri;
 
    id_name_addr = (pjsip_name_addr *) id_hdr->uri;
    id_uri = pjsip_uri_get_uri(id_name_addr->uri);
 
    if (id->name.valid) {
        if (!ast_strlen_zero(id->name.str)) {
            int name_buf_len = strlen(id->name.str) * 2 + 1;
            char *name_buf = ast_alloca(name_buf_len);
 
            ast_escape_quoted(id->name.str, name_buf, name_buf_len);
            pj_strdup2(pool, &id_name_addr->display, name_buf);
        } else {
            pj_strdup2(pool, &id_name_addr->display, NULL);
        }
    }
 
    if (id->number.valid) {
        pj_strdup2(pool, &id_uri->user, id->number.str);
    }
}

References ast_alloca, ast_escape_quoted(), ast_strlen_zero(), id, and NULL.

Referenced by add_pai_header(), add_rpid_header(), and set_from_header().

ast_sip_persistent_endpoint_publish_contact_state()

void ast_sip_persistent_endpoint_publish_contact_state	(	const char *	endpoint_name,
		const struct ast_sip_contact_status *	contact_status
	)

Publish the change of state for a contact.

Parameters

endpoint_name	The SIP endpoint name.
contact_status	The contact status.

Definition at line 1504 of file pjsip_configuration.c.

{
    struct sip_persistent_endpoint *persistent;
    struct ast_json *blob;
    char rtt[32];
 
    persistent = ao2_find(persistent_endpoints, endpoint_name, OBJ_SEARCH_KEY);
    if (!persistent) {
        return;
    }
 
    snprintf(rtt, sizeof(rtt), "%" PRId64, contact_status->rtt);
    blob = ast_json_pack("{s: s, s: s, s: s, s: s, s: s}",
        "contact_status", ast_sip_get_contact_status_label(contact_status->status),
        "aor", contact_status->aor,
        "uri", contact_status->uri,
        "roundtrip_usec", rtt,
        "endpoint_name", ast_endpoint_get_resource(persistent->endpoint));
    if (blob) {
        ast_endpoint_blob_publish(persistent->endpoint, ast_endpoint_contact_state_type(), blob);
        ast_json_unref(blob);
    }
 
    ao2_ref(persistent, -1);
}

References ao2_find, ao2_ref, ast_sip_contact_status::aor, ast_endpoint_blob_publish(), ast_endpoint_contact_state_type(), ast_endpoint_get_resource(), ast_json_pack(), ast_json_unref(), ast_sip_get_contact_status_label(), sip_persistent_endpoint::endpoint, OBJ_SEARCH_KEY, persistent_endpoints, ast_sip_contact_status::rtt, ast_sip_contact_status::status, and ast_sip_contact_status::uri.

Referenced by sip_options_publish_contact_state().

ast_sip_persistent_endpoint_update_state()

int ast_sip_persistent_endpoint_update_state	(	const char *	endpoint_name,
		enum ast_endpoint_state	state
	)

Change state of a persistent endpoint.

Parameters

endpoint_name	The SIP endpoint name to change state.
state	The new state

Return values

0	Success
-1	Endpoint not found

Definition at line 1447 of file pjsip_configuration.c.

{
    struct sip_persistent_endpoint *persistent;
    struct ast_json *blob;
    char *regcontext;
 
    persistent = ao2_find(persistent_endpoints, endpoint_name, OBJ_SEARCH_KEY);
    if (!persistent) {
        return -1;
    }
 
    /* If there was no state change, don't publish anything. */
    if (ast_endpoint_get_state(persistent->endpoint) == state) {
        ao2_ref(persistent, -1);
        return 0;
    }
 
    regcontext = ast_sip_get_regcontext();
 
    if (state == AST_ENDPOINT_ONLINE) {
        ast_endpoint_set_state(persistent->endpoint, AST_ENDPOINT_ONLINE);
        blob = ast_json_pack("{s: s}", "peer_status", "Reachable");
 
        if (!ast_strlen_zero(regcontext)) {
            if (!ast_exists_extension(NULL, regcontext, ast_endpoint_get_resource(persistent->endpoint), 1, NULL)) {
                ast_add_extension(regcontext, 1, ast_endpoint_get_resource(persistent->endpoint), 1, NULL, NULL,
                    "Noop", ast_strdup(ast_endpoint_get_resource(persistent->endpoint)), ast_free_ptr, "PJSIP");
            }
        }
 
        ast_verb(2, "Endpoint %s is now Reachable\n", ast_endpoint_get_resource(persistent->endpoint));
    } else {
        ast_endpoint_set_state(persistent->endpoint, AST_ENDPOINT_OFFLINE);
        blob = ast_json_pack("{s: s}", "peer_status", "Unreachable");
 
        if (!ast_strlen_zero(regcontext)) {
            struct pbx_find_info q = { .stacklen = 0 };
 
            if (pbx_find_extension(NULL, NULL, &q, regcontext, ast_endpoint_get_resource(persistent->endpoint), 1, NULL, "", E_MATCH)) {
                ast_context_remove_extension(regcontext, ast_endpoint_get_resource(persistent->endpoint), 1, NULL);
            }
        }
 
        ast_verb(2, "Endpoint %s is now Unreachable\n", ast_endpoint_get_resource(persistent->endpoint));
    }
 
    ast_free(regcontext);
 
    ast_endpoint_blob_publish(persistent->endpoint, ast_endpoint_state_type(), blob);
    ast_json_unref(blob);
    ast_devstate_changed(AST_DEVICE_UNKNOWN, AST_DEVSTATE_CACHABLE, "PJSIP/%s", ast_endpoint_get_resource(persistent->endpoint));
 
    ao2_ref(persistent, -1);
 
    return 0;
}

References ao2_find, ao2_ref, ast_add_extension(), ast_context_remove_extension(), AST_DEVICE_UNKNOWN, AST_DEVSTATE_CACHABLE, ast_devstate_changed(), ast_endpoint_blob_publish(), ast_endpoint_get_resource(), ast_endpoint_get_state(), AST_ENDPOINT_OFFLINE, AST_ENDPOINT_ONLINE, ast_endpoint_set_state(), ast_endpoint_state_type(), ast_exists_extension(), ast_free, ast_free_ptr(), ast_json_pack(), ast_json_unref(), ast_sip_get_regcontext(), ast_strdup, ast_strlen_zero(), ast_verb, E_MATCH, sip_persistent_endpoint::endpoint, NULL, OBJ_SEARCH_KEY, pbx_find_extension(), persistent_endpoints, regcontext, and pbx_find_info::stacklen.

Referenced by sip_options_synchronize_endpoint(), sip_options_unused_endpoint_state_compositor(), and sip_options_update_endpoint_state_compositor_aor().

ast_sip_pjsip_uri_get_hostname()

const pj_str_t * ast_sip_pjsip_uri_get_hostname

(

pjsip_uri *

uri

)

Get the host portion of the pjsip_uri.

Since

16.28.0

Parameters

uri	The pjsip_uri to get the host from

Note

This function will check what kind of URI it receives and return the host based off of that

Returns

Host string or empty string if not present

Definition at line 3496 of file res_pjsip.c.

{
    if (ast_sip_is_uri_sip_sips(uri)) {
        pjsip_sip_uri *sip_uri = pjsip_uri_get_uri(uri);
        if (!sip_uri) {
            return &AST_PJ_STR_EMPTY;
        }
        return &sip_uri->host;
    } else if (PJSIP_URI_SCHEME_IS_TEL(uri)) {
        return &AST_PJ_STR_EMPTY;
    }
 
    return &AST_PJ_STR_EMPTY;
}

References AST_PJ_STR_EMPTY, and ast_sip_is_uri_sip_sips().

Referenced by dialog_info_generate_body_content(), find_aor2(), get_endpoint_details(), get_from_header(), rx_data_to_ast_msg(), and set_sipdomain_variable().

ast_sip_pjsip_uri_get_other_param()

struct pjsip_param * ast_sip_pjsip_uri_get_other_param	(	pjsip_uri *	uri,
		const pj_str_t *	param_str
	)

Find an 'other' SIP/SIPS URI parameter by name.

Since

16.28.0

A convenience function to find a named parameter from a SIP/SIPS URI. This function will not find the following standard SIP/SIPS URI parameters which are stored separately by PJSIP:

• user
• method
• transport
• ttl
• lr
• maddr

Parameters

uri	The pjsip_uri to get the parameter from
param_str	The name of the parameter to find

Note

This function will check what kind of URI it receives and return the parameter based off of that

Returns

Find parameter or NULL if not present

Definition at line 3511 of file res_pjsip.c.

{
    if (ast_sip_is_uri_sip_sips(uri)) {
        pjsip_sip_uri *sip_uri = pjsip_uri_get_uri(uri);
        if (!sip_uri) {
            return NULL;
        }
        return pjsip_param_find(&sip_uri->other_param, param_str);
    } else if (PJSIP_URI_SCHEME_IS_TEL(uri)) {
        pjsip_tel_uri *tel_uri = pjsip_uri_get_uri(uri);
        if (!tel_uri) {
            return NULL;
        }
        return pjsip_param_find(&tel_uri->other_param, param_str);
    }
 
    return NULL;
}

References ast_sip_is_uri_sip_sips(), and NULL.

Referenced by get_uri_option_line(), and set_redirecting_reason_by_cause().

ast_sip_pjsip_uri_get_username()

const pj_str_t * ast_sip_pjsip_uri_get_username

(

pjsip_uri *

uri

)

Get the user portion of the pjsip_uri.

Since

16.28.0

Parameters

uri	The pjsip_uri to get the user from

Note

This function will check what kind of URI it receives and return the user based off of that

Returns

User string or empty string if not present

Definition at line 3477 of file res_pjsip.c.

{
    if (ast_sip_is_uri_sip_sips(uri)) {
        pjsip_sip_uri *sip_uri = pjsip_uri_get_uri(uri);
        if (!sip_uri) {
            return &AST_PJ_STR_EMPTY;
        }
        return &sip_uri->user;
    } else if (PJSIP_URI_SCHEME_IS_TEL(uri)) {
        pjsip_tel_uri *tel_uri = pjsip_uri_get_uri(uri);
        if (!tel_uri) {
            return &AST_PJ_STR_EMPTY;
        }
        return &tel_uri->number;
    }
 
    return &AST_PJ_STR_EMPTY;
}

References AST_PJ_STR_EMPTY, and ast_sip_is_uri_sip_sips().

Referenced by add_diversion_header(), endpoint_lookup(), find_aor2(), get_destination(), get_from_header(), options_on_rx_request(), publish_request_initial(), pubsub_on_rx_subscribe_request(), rx_data_to_ast_msg(), set_id_from_hdr(), and sub_persistence_recreate().

ast_sip_rdata_get_header_value()

char * ast_sip_rdata_get_header_value	(	pjsip_rx_data *	rdata,
		const pj_str_t	str
	)

Get a specific header value from rdata.

Note

The returned value does not need to be freed since it's from the rdata pool

Parameters

rdata	The rdata
str	The header to find

Return values

NULL	on failure
The	header value on success

Definition at line 345 of file res_pjsip.c.

{
    pjsip_generic_string_hdr *hdr;
    pj_str_t hdr_val;
 
    hdr = pjsip_msg_find_hdr_by_name(rdata->msg_info.msg, &str, NULL);
    if (!hdr) {
        return NULL;
    }
 
    pj_strdup_with_null(rdata->tp_info.pool, &hdr_val, &hdr->hvalue);
 
    return hdr_val.ptr;
}

References NULL, and str.

Referenced by stir_shaken_incoming_request().

ast_sip_register_authenticator()

int ast_sip_register_authenticator

(

struct ast_sip_authenticator *

auth

)

Register a SIP authenticator.

An authenticator has three main purposes: 1) Determining if authentication should be performed on an incoming request 2) Gathering credentials necessary for issuing an authentication challenge 3) Authenticating a request that has credentials

Asterisk provides a default authenticator, but it may be replaced by a custom one if desired.

Parameters

auth	The authenticator to register

Return values

0	Success
-1	Failure

Definition at line 140 of file res_pjsip.c.

{
    if (registered_authenticator) {
        ast_log(LOG_WARNING, "Authenticator %p is already registered. Cannot register a new one\n", registered_authenticator);
        return -1;
    }
    registered_authenticator = auth;
    ast_debug(1, "Registered SIP authenticator module %p\n", auth);
 
    return 0;
}

References ast_debug, ast_log, LOG_WARNING, and registered_authenticator.

Referenced by load_module().

ast_sip_register_endpoint_formatter()

void ast_sip_register_endpoint_formatter

(

struct ast_sip_endpoint_formatter *

obj

)

Register an endpoint formatter.

Parameters

obj	the formatter to register

Definition at line 481 of file res_pjsip.c.

{
    SCOPED_LOCK(lock, &endpoint_formatters, AST_RWLIST_WRLOCK, AST_RWLIST_UNLOCK);
    AST_RWLIST_INSERT_TAIL(&endpoint_formatters, obj, next);
}

References AST_RWLIST_INSERT_TAIL, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, lock, ast_cli_entry::next, and SCOPED_LOCK.

Referenced by ast_res_pjsip_init_options_handling(), ast_sip_initialize_sorcery_auth(), ast_sip_initialize_sorcery_location(), ast_sip_initialize_sorcery_transport(), and load_module().

ast_sip_register_endpoint_identifier()

int ast_sip_register_endpoint_identifier

(

struct ast_sip_endpoint_identifier *

identifier

)

Register a SIP endpoint identifier.

An endpoint identifier's purpose is to determine which endpoint a given SIP message has come from.

Multiple endpoint identifiers may be registered so that if an endpoint cannot be identified by one identifier, it may be identified by another.

Asterisk provides two endpoint identifiers. One identifies endpoints based on the user part of the From header URI. The other identifies endpoints based on the source IP address.

If the order in which endpoint identifiers is run is important to you, then be sure to load individual endpoint identifier modules in the order you wish for them to be run in modules.conf

Note

endpoint identifiers registered using this method (no name specified) are placed at the front of the endpoint identifiers list ahead of any named identifiers.

Parameters

identifier

The SIP endpoint identifier to register

Return values

0	Success
-1	Failure

Definition at line 310 of file res_pjsip.c.

{
    return ast_sip_register_endpoint_identifier_with_name(identifier, NULL);
}

References ast_sip_register_endpoint_identifier_with_name(), endpoint_identifier_list::identifier, and NULL.

Referenced by load_module().

ast_sip_register_endpoint_identifier_with_name()

int ast_sip_register_endpoint_identifier_with_name	(	struct ast_sip_endpoint_identifier *	identifier,
		const char *	name
	)

Register a SIP endpoint identifier with a name.

An endpoint identifier's purpose is to determine which endpoint a given SIP message has come from.

Multiple endpoint identifiers may be registered so that if an endpoint cannot be identified by one identifier, it may be identified by another.

Parameters

identifier	The SIP endpoint identifier to register
name	The name of the endpoint identifier

Return values

0	Success
-1	Failure

Definition at line 233 of file res_pjsip.c.

{
    char *prev, *current, *identifier_order;
    struct endpoint_identifier_list *iter, *id_list_item;
    SCOPED_LOCK(lock, &endpoint_identifiers, AST_RWLIST_WRLOCK, AST_RWLIST_UNLOCK);
 
    id_list_item = ast_calloc(1, sizeof(*id_list_item));
    if (!id_list_item) {
        ast_log(LOG_ERROR, "Unable to add endpoint identifier. Out of memory.\n");
        return -1;
    }
    id_list_item->identifier = identifier;
    id_list_item->name = name;
 
    ast_debug(1, "Register endpoint identifier %s(%p)\n", name ?: "", identifier);
 
    if (ast_strlen_zero(name)) {
        /* if an identifier has no name then place in front */
        AST_RWLIST_INSERT_HEAD(&endpoint_identifiers, id_list_item, list);
        return 0;
    }
 
    /* see if the name of the identifier is in the global endpoint_identifier_order list */
    identifier_order = prev = current = ast_sip_get_endpoint_identifier_order();
 
    if (ast_strlen_zero(identifier_order)) {
        id_list_item->priority = UINT_MAX;
        AST_RWLIST_INSERT_TAIL(&endpoint_identifiers, id_list_item, list);
        ast_free(identifier_order);
        return 0;
    }
 
    id_list_item->priority = 0;
    while ((current = strchr(current, ','))) {
        ++id_list_item->priority;
        if (!strncmp(prev, name, current - prev)
            && strlen(name) == current - prev) {
            break;
        }
        prev = ++current;
    }
 
    if (!current) {
        /* check to see if it is the only or last item */
        if (!strcmp(prev, name)) {
            ++id_list_item->priority;
        } else {
            id_list_item->priority = UINT_MAX;
        }
    }
 
    if (id_list_item->priority == UINT_MAX || AST_RWLIST_EMPTY(&endpoint_identifiers)) {
        /* if not in the endpoint_identifier_order list then consider it less in
           priority and add it to the end */
        AST_RWLIST_INSERT_TAIL(&endpoint_identifiers, id_list_item, list);
        ast_free(identifier_order);
        return 0;
    }
 
    AST_RWLIST_TRAVERSE_SAFE_BEGIN(&endpoint_identifiers, iter, list) {
        if (id_list_item->priority < iter->priority) {
            AST_RWLIST_INSERT_BEFORE_CURRENT(id_list_item, list);
            break;
        }
 
        if (!AST_RWLIST_NEXT(iter, list)) {
            AST_RWLIST_INSERT_AFTER(&endpoint_identifiers, iter, id_list_item, list);
            break;
        }
    }
    AST_RWLIST_TRAVERSE_SAFE_END;
 
    ast_free(identifier_order);
    return 0;
}

References ast_calloc, ast_debug, ast_free, ast_log, AST_RWLIST_EMPTY, AST_RWLIST_INSERT_AFTER, AST_RWLIST_INSERT_BEFORE_CURRENT, AST_RWLIST_INSERT_HEAD, AST_RWLIST_INSERT_TAIL, AST_RWLIST_NEXT, AST_RWLIST_TRAVERSE_SAFE_BEGIN, AST_RWLIST_TRAVERSE_SAFE_END, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_sip_get_endpoint_identifier_order(), ast_strlen_zero(), current, endpoint_identifier_list::identifier, endpoint_identifier_list::list, lock, LOG_ERROR, name, endpoint_identifier_list::name, endpoint_identifier_list::priority, and SCOPED_LOCK.

Referenced by ast_sip_register_endpoint_identifier(), load_module(), load_module(), and load_module().

ast_sip_register_outbound_authenticator()

int ast_sip_register_outbound_authenticator

(

struct ast_sip_outbound_authenticator *

outbound_auth

)

Register an outbound SIP authenticator.

An outbound authenticator is responsible for creating responses to authentication challenges by remote endpoints.

Parameters

outbound_auth

The authenticator to register

Return values

0	Success
-1	Failure

Definition at line 191 of file res_pjsip.c.

{
    if (registered_outbound_authenticator) {
        ast_log(LOG_WARNING, "Outbound authenticator %p is already registered. Cannot register a new one\n", registered_outbound_authenticator);
        return -1;
    }
    registered_outbound_authenticator = auth;
    ast_debug(1, "Registered SIP outbound authenticator module %p\n", auth);
 
    return 0;
}

References ast_debug, ast_log, LOG_WARNING, and registered_outbound_authenticator.

Referenced by load_module().

ast_sip_register_service()

int ast_sip_register_service

(

pjsip_module *

module

)

Register a SIP service in Asterisk.

This is more-or-less a wrapper around pjsip_endpt_register_module(). Registering a service makes it so that PJSIP will call into the service at appropriate times. For more information about PJSIP module callbacks, see the PJSIP documentation. Asterisk modules that call this function will likely do so at module load time.

Parameters

module

The module that is to be registered with PJSIP

Return values

0	Success
-1	Failure

Definition at line 117 of file res_pjsip.c.

{
    return ast_sip_push_task_wait_servant(NULL, register_service, &module);
}

References ast_sip_push_task_wait_servant(), NULL, and register_service().

Referenced by ast_res_pjsip_init_message_filter(), ast_sip_initialize_distributor(), ast_sip_initialize_global_headers(), ast_sip_initialize_transport_management(), load_module(), load_module(), load_module(), load_module(), load_module(), load_module(), load_module(), load_module(), load_module(), load_module(), load_module(), load_module(), load_module(), and load_module().

ast_sip_register_supplement()

void ast_sip_register_supplement

(

struct ast_sip_supplement *

supplement

)

Register a supplement to SIP out of dialog processing.

This allows for someone to insert themselves in the processing of out of dialog SIP requests and responses. This, for example could allow for a module to set channel data based on headers in an incoming message. Similarly, a module could reject an incoming request if desired.

Parameters

supplement

The supplement to register

Definition at line 1456 of file res_pjsip.c.

{
    struct ast_sip_supplement *iter;
    int inserted = 0;
    SCOPED_LOCK(lock, &supplements, AST_RWLIST_WRLOCK, AST_RWLIST_UNLOCK);
 
    AST_RWLIST_TRAVERSE_SAFE_BEGIN(&supplements, iter, next) {
        if (iter->priority > supplement->priority) {
            AST_RWLIST_INSERT_BEFORE_CURRENT(supplement, next);
            inserted = 1;
            break;
        }
    }
    AST_RWLIST_TRAVERSE_SAFE_END;
 
    if (!inserted) {
        AST_RWLIST_INSERT_TAIL(&supplements, supplement, next);
    }
}

References AST_RWLIST_INSERT_BEFORE_CURRENT, AST_RWLIST_INSERT_TAIL, AST_RWLIST_TRAVERSE_SAFE_BEGIN, AST_RWLIST_TRAVERSE_SAFE_END, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, lock, ast_sip_supplement::next, ast_sip_supplement::priority, and SCOPED_LOCK.

Referenced by ast_res_pjsip_init_message_filter(), load_module(), and load_module().

ast_sip_remove_headers_by_name_and_value()

void ast_sip_remove_headers_by_name_and_value	(	pjsip_msg *	msg,
		const pj_str_t *	hdr_name,
		const char *	value
	)

Removes all headers of a specific name and value from a pjsip_msg.

Parameters

msg	PJSIP message from which to remove headers.
hdr_name	Name of the header to remove.
value	Optional string value of the header to remove. If NULL, remove all headers of given hdr_name.

Definition at line 203 of file security_agreements.c.

{
    struct pjsip_generic_string_hdr *hdr = pjsip_msg_find_hdr_by_name(msg, hdr_name, NULL);
    for (; hdr; hdr = pjsip_msg_find_hdr_by_name(msg, hdr_name, hdr->next)) {
        if (value == NULL || !pj_strcmp2(&hdr->hvalue, value)) {
            pj_list_erase(hdr);
        }
        if (hdr->next == hdr) {
            break;
        }
    }
}

References NULL, and value.

Referenced by add_security_headers().

ast_sip_report_auth_challenge_sent()

void ast_sip_report_auth_challenge_sent	(	struct ast_sip_endpoint *	endpoint,
		pjsip_rx_data *	rdata,
		pjsip_tx_data *	tdata
	)

Send a security event notification for when an authentication challenge is sent.

Parameters

endpoint	Pointer to the endpoint in use
rdata	Received message
tdata	Sent message

Definition at line 197 of file res/res_pjsip/security_events.c.

{
    pjsip_www_authenticate_hdr *auth = pjsip_msg_find_hdr(tdata->msg, PJSIP_H_WWW_AUTHENTICATE, NULL);
    enum ast_transport transport = security_event_get_transport(rdata);
    char nonce[64] = "", call_id[pj_strlen(&rdata->msg_info.cid->id) + 1];
    struct ast_sockaddr local, remote;
 
    struct ast_security_event_chal_sent chal_sent = {
            .common.event_type = AST_SECURITY_EVENT_CHAL_SENT,
            .common.version    = AST_SECURITY_EVENT_CHAL_SENT_VERSION,
            .common.service    = "PJSIP",
            .common.account_id = get_account_id(endpoint),
            .common.local_addr = {
                    .addr      = &local,
                    .transport = transport,
            },
            .common.remote_addr = {
                    .addr      = &remote,
                    .transport = transport,
            },
            .common.session_id = call_id,
            .challenge         = nonce,
    };
 
    if (auth && !pj_strcmp2(&auth->scheme, "digest")) {
        ast_copy_pj_str(nonce, &auth->challenge.digest.nonce, sizeof(nonce));
    }
 
    security_event_populate(rdata, call_id, sizeof(call_id), &local, &remote);
 
    ast_security_event_report(AST_SEC_EVT(&chal_sent));
}

References ast_copy_pj_str(), AST_SEC_EVT, AST_SECURITY_EVENT_CHAL_SENT, AST_SECURITY_EVENT_CHAL_SENT_VERSION, ast_security_event_report(), ast_security_event_chal_sent::common, ast_security_event_common::event_type, get_account_id(), NULL, security_event_get_transport(), and security_event_populate().

Referenced by authenticate().

ast_sip_report_auth_failed_challenge_response()

void ast_sip_report_auth_failed_challenge_response	(	struct ast_sip_endpoint *	endpoint,
		pjsip_rx_data *	rdata
	)

Send a security event notification for when a challenge response has failed.

Parameters

endpoint	Pointer to the endpoint in use
rdata	Received message

Definition at line 130 of file res/res_pjsip/security_events.c.

{
    pjsip_authorization_hdr *auth = pjsip_msg_find_hdr(rdata->msg_info.msg, PJSIP_H_AUTHORIZATION, NULL);
    enum ast_transport transport = security_event_get_transport(rdata);
    char call_id[pj_strlen(&rdata->msg_info.cid->id) + 1];
    char nonce[64] = "", response[256] = "";
    struct ast_sockaddr local, remote;
 
    struct ast_security_event_chal_resp_failed chal_resp_failed = {
                .common.event_type = AST_SECURITY_EVENT_CHAL_RESP_FAILED,
                .common.version    = AST_SECURITY_EVENT_CHAL_RESP_FAILED_VERSION,
                .common.service    = "PJSIP",
                .common.account_id = get_account_id(endpoint),
                .common.local_addr = {
                        .addr      = &local,
                        .transport = transport,
                },
                .common.remote_addr = {
                        .addr      = &remote,
                        .transport = transport,
                },
                .common.session_id = call_id,
 
                .challenge         = nonce,
                .response          = response,
                .expected_response = "",
    };
 
    if (auth && !pj_strcmp2(&auth->scheme, "Digest")) {
        ast_copy_pj_str(nonce, &auth->credential.digest.nonce, sizeof(nonce));
        ast_copy_pj_str(response, &auth->credential.digest.response, sizeof(response));
    }
 
    security_event_populate(rdata, call_id, sizeof(call_id), &local, &remote);
 
    ast_security_event_report(AST_SEC_EVT(&chal_resp_failed));
}

References ast_copy_pj_str(), AST_SEC_EVT, AST_SECURITY_EVENT_CHAL_RESP_FAILED, AST_SECURITY_EVENT_CHAL_RESP_FAILED_VERSION, ast_security_event_report(), ast_security_event_chal_resp_failed::common, ast_security_event_common::event_type, get_account_id(), NULL, ast_security_event_chal_resp_failed::response, security_event_get_transport(), and security_event_populate().

Referenced by authenticate().

ast_sip_report_auth_success()

void ast_sip_report_auth_success	(	struct ast_sip_endpoint *	endpoint,
		pjsip_rx_data *	rdata
	)

Send a security event notification for when authentication succeeds.

Parameters

endpoint	Pointer to the endpoint in use
rdata	Received message

Definition at line 168 of file res/res_pjsip/security_events.c.

{
    pjsip_authorization_hdr *auth = pjsip_msg_find_hdr(rdata->msg_info.msg, PJSIP_H_AUTHORIZATION, NULL);
    enum ast_transport transport = security_event_get_transport(rdata);
    char call_id[pj_strlen(&rdata->msg_info.cid->id) + 1];
    struct ast_sockaddr local, remote;
 
    struct ast_security_event_successful_auth successful_auth = {
            .common.event_type  = AST_SECURITY_EVENT_SUCCESSFUL_AUTH,
            .common.version     = AST_SECURITY_EVENT_SUCCESSFUL_AUTH_VERSION,
            .common.service     = "PJSIP",
            .common.account_id  = get_account_id(endpoint),
            .common.local_addr  = {
                    .addr       = &local,
                    .transport  = transport,
            },
            .common.remote_addr = {
                    .addr       = &remote,
                    .transport  = transport,
            },
            .common.session_id  = call_id,
            .using_password     = auth ? 1 : 0,
    };
 
    security_event_populate(rdata, call_id, sizeof(call_id), &local, &remote);
 
    ast_security_event_report(AST_SEC_EVT(&successful_auth));
}

References AST_SEC_EVT, ast_security_event_report(), AST_SECURITY_EVENT_SUCCESSFUL_AUTH, AST_SECURITY_EVENT_SUCCESSFUL_AUTH_VERSION, ast_security_event_successful_auth::common, ast_security_event_common::event_type, get_account_id(), NULL, security_event_get_transport(), and security_event_populate().

Referenced by authenticate().

ast_sip_report_failed_acl()

void ast_sip_report_failed_acl	(	struct ast_sip_endpoint *	endpoint,
		pjsip_rx_data *	rdata,
		const char *	name
	)

Send a security event notification for when an ACL check fails.

Parameters

endpoint	Pointer to the endpoint in use
rdata	Received message
name	Name of the ACL

Definition at line 102 of file res/res_pjsip/security_events.c.

{
    enum ast_transport transport = security_event_get_transport(rdata);
    char call_id[pj_strlen(&rdata->msg_info.cid->id) + 1];
    struct ast_sockaddr local, remote;
 
    struct ast_security_event_failed_acl failed_acl_event = {
            .common.event_type  = AST_SECURITY_EVENT_FAILED_ACL,
            .common.version     = AST_SECURITY_EVENT_FAILED_ACL_VERSION,
            .common.service     = "PJSIP",
            .common.account_id  = get_account_id(endpoint),
            .common.local_addr  = {
                    .addr       = &local,
                    .transport  = transport,
            },
            .common.remote_addr = {
                    .addr       = &remote,
                    .transport  = transport,
            },
            .common.session_id  = call_id,
            .acl_name           = name,
    };
 
    security_event_populate(rdata, call_id, sizeof(call_id), &local, &remote);
 
    ast_security_event_report(AST_SEC_EVT(&failed_acl_event));
}

References AST_SEC_EVT, AST_SECURITY_EVENT_FAILED_ACL, AST_SECURITY_EVENT_FAILED_ACL_VERSION, ast_security_event_report(), ast_security_event_failed_acl::common, ast_security_event_common::event_type, get_account_id(), name, security_event_get_transport(), and security_event_populate().

Referenced by apply_endpoint_acl(), apply_endpoint_contact_acl(), register_aor_core(), and registrar_on_rx_request().

ast_sip_report_invalid_endpoint()

void ast_sip_report_invalid_endpoint	(	const char *	name,
		pjsip_rx_data *	rdata
	)

Send a security event notification for when an invalid endpoint is requested.

Parameters

name	Name of the endpoint requested
rdata	Received message

Definition at line 75 of file res/res_pjsip/security_events.c.

{
    enum ast_transport transport = security_event_get_transport(rdata);
    char call_id[pj_strlen(&rdata->msg_info.cid->id) + 1];
    struct ast_sockaddr local, remote;
 
    struct ast_security_event_inval_acct_id inval_acct_id = {
        .common.event_type = AST_SECURITY_EVENT_INVAL_ACCT_ID,
        .common.version    = AST_SECURITY_EVENT_INVAL_ACCT_ID_VERSION,
        .common.service    = "PJSIP",
        .common.account_id = name,
        .common.local_addr = {
            .addr      = &local,
            .transport = transport,
        },
        .common.remote_addr = {
            .addr       = &remote,
            .transport = transport,
        },
        .common.session_id = call_id,
    };
 
    security_event_populate(rdata, call_id, sizeof(call_id), &local, &remote);
 
    ast_security_event_report(AST_SEC_EVT(&inval_acct_id));
}

References AST_SEC_EVT, AST_SECURITY_EVENT_INVAL_ACCT_ID, AST_SECURITY_EVENT_INVAL_ACCT_ID_VERSION, ast_security_event_report(), ast_security_event_inval_acct_id::common, ast_security_event_common::event_type, name, security_event_get_transport(), and security_event_populate().

Referenced by check_endpoint(), and endpoint_lookup().

ast_sip_report_mem_limit()

void ast_sip_report_mem_limit	(	struct ast_sip_endpoint *	endpoint,
		pjsip_rx_data *	rdata
	)

Send a security event notification for when a memory limit is hit.

Parameters

endpoint	Pointer to the endpoint in use
rdata	Received message

Definition at line 259 of file res/res_pjsip/security_events.c.

{
    enum ast_transport transport = security_event_get_transport(rdata);
    char call_id[pj_strlen(&rdata->msg_info.cid->id) + 1];
    struct ast_sockaddr local, remote;
 
    struct ast_security_event_mem_limit mem_limit_event = {
        .common.event_type  = AST_SECURITY_EVENT_MEM_LIMIT,
        .common.version     = AST_SECURITY_EVENT_MEM_LIMIT_VERSION,
        .common.service     = "PJSIP",
        .common.account_id  = get_account_id(endpoint),
        .common.local_addr  = {
            .addr       = &local,
            .transport  = transport,
        },
        .common.remote_addr = {
            .addr       = &remote,
            .transport  = transport,
        },
        .common.session_id  = call_id
    };
 
    security_event_populate(rdata, call_id, sizeof(call_id), &local, &remote);
 
    ast_security_event_report(AST_SEC_EVT(&mem_limit_event));
}

References AST_SEC_EVT, AST_SECURITY_EVENT_MEM_LIMIT, AST_SECURITY_EVENT_MEM_LIMIT_VERSION, ast_security_event_report(), ast_security_event_mem_limit::common, ast_security_event_common::event_type, get_account_id(), security_event_get_transport(), and security_event_populate().

ast_sip_report_req_no_support()

void ast_sip_report_req_no_support	(	struct ast_sip_endpoint *	endpoint,
		pjsip_rx_data *	rdata,
		const char *	req_type
	)

Send a security event notification for when a request is not supported.

Parameters

endpoint	Pointer to the endpoint in use
rdata	Received message
req_type	the type of request

Definition at line 230 of file res/res_pjsip/security_events.c.

{
    enum ast_transport transport = security_event_get_transport(rdata);
    char call_id[pj_strlen(&rdata->msg_info.cid->id) + 1];
    struct ast_sockaddr local, remote;
 
    struct ast_security_event_req_no_support req_no_support_event = {
        .common.event_type  = AST_SECURITY_EVENT_REQ_NO_SUPPORT,
        .common.version     = AST_SECURITY_EVENT_REQ_NO_SUPPORT_VERSION,
        .common.service     = "PJSIP",
        .common.account_id  = get_account_id(endpoint),
        .common.local_addr  = {
            .addr       = &local,
            .transport  = transport,
        },
        .common.remote_addr = {
            .addr       = &remote,
            .transport  = transport,
        },
        .common.session_id  = call_id,
        .request_type       = req_type
    };
 
    security_event_populate(rdata, call_id, sizeof(call_id), &local, &remote);
 
    ast_security_event_report(AST_SEC_EVT(&req_no_support_event));
}

References AST_SEC_EVT, ast_security_event_report(), AST_SECURITY_EVENT_REQ_NO_SUPPORT, AST_SECURITY_EVENT_REQ_NO_SUPPORT_VERSION, ast_security_event_req_no_support::common, ast_security_event_common::event_type, get_account_id(), security_event_get_transport(), and security_event_populate().

Referenced by find_registrar_aor(), and registrar_on_rx_request().

ast_sip_requires_authentication()

int ast_sip_requires_authentication	(	struct ast_sip_endpoint *	endpoint,
		pjsip_rx_data *	rdata
	)

Determine if an incoming request requires authentication.

This calls into the registered authenticator's requires_authentication callback in order to determine if the request requires authentication.

If there is no registered authenticator, then authentication will be assumed not to be required.

Parameters

endpoint	The endpoint from which the request originates
rdata	The incoming SIP request

Return values

non-zero	The request requires authentication
0	The request does not require authentication

Definition at line 163 of file res_pjsip.c.

{
    if (endpoint->allow_unauthenticated_options
        && !pjsip_method_cmp(&rdata->msg_info.msg->line.req.method, &pjsip_options_method)) {
        ast_debug(3, "Skipping OPTIONS authentication due to endpoint configuration\n");
        return 0;
    }
 
    if (!registered_authenticator) {
        ast_log(LOG_WARNING, "No SIP authenticator registered. Assuming authentication is not required\n");
        return 0;
    }
 
    return registered_authenticator->requires_authentication(endpoint, rdata);
}

References ast_sip_endpoint::allow_unauthenticated_options, ast_debug, ast_log, LOG_WARNING, registered_authenticator, and ast_sip_authenticator::requires_authentication.

Referenced by authenticate().

ast_sip_retrieve_auths()

int ast_sip_retrieve_auths	(	const struct ast_sip_auth_vector *	auths,
		struct ast_sip_auth **	out
	)

Retrieve relevant SIP auth structures from sorcery.

Parameters

	auths	Vector of sorcery IDs of auth credentials to retrieve
[out]	out	The retrieved auths are stored here

Definition at line 2527 of file pjsip_configuration.c.

{
    int i;
 
    for (i = 0; i < AST_VECTOR_SIZE(auths); ++i) {
        /* Using AST_VECTOR_GET is safe since the vector is immutable */
        const char *name = AST_VECTOR_GET(auths, i);
        out[i] = ast_sorcery_retrieve_by_id(ast_sip_get_sorcery(), SIP_SORCERY_AUTH_TYPE, name);
        if (!out[i]) {
            ast_log(LOG_NOTICE, "Couldn't find auth '%s'. Cannot authenticate\n", name);
            return -1;
        }
    }
 
    return 0;
}

References ast_log, ast_sip_get_sorcery(), ast_sorcery_retrieve_by_id(), AST_VECTOR_GET, AST_VECTOR_SIZE, LOG_NOTICE, name, out, and SIP_SORCERY_AUTH_TYPE.

Referenced by digest_check_auth(), and set_outbound_initial_authentication_credentials().

ast_sip_retrieve_auths_vector()

int ast_sip_retrieve_auths_vector	(	const struct ast_sip_auth_vector *	auth_ids,
		struct ast_sip_auth_objects_vector *	auth_objects
	)

Retrieve relevant SIP auth structures from sorcery as a vector.

Parameters

	auth_ids	Vector of sorcery IDs of auth credentials to retrieve
[out]	auth_objects	A pointer ast_sip_auth_objects_vector to hold the objects

Return values

0	Success
-1	Number of auth objects found is less than the number of names supplied.

Warning

The number of auth objects retrieved may be less than the number of auth ids supplied if auth objects couldn't be found for some of them.

Note

Since the ref count on all auth objects returned has been bumped, you must call ast_sip_cleanup_auth_objects_vector() to decrement the ref count on all of the auth objects in the vector, then call AST_VECTOR_FREE() on the vector itself.

Definition at line 2552 of file pjsip_configuration.c.

{
    int i;
 
    for (i = 0; i < AST_VECTOR_SIZE(auth_ids); ++i) {
        /* Using AST_VECTOR_GET is safe since the vector is immutable */
        const char *name = AST_VECTOR_GET(auth_ids, i);
        struct ast_sip_auth *auth_object = ast_sorcery_retrieve_by_id(ast_sip_get_sorcery(), SIP_SORCERY_AUTH_TYPE, name);
        if (!auth_object) {
            ast_log(LOG_WARNING, "Auth object '%s' could not be found\n", name);
        } else {
            AST_VECTOR_APPEND(auth_objects, auth_object);
        }
    }
 
    return AST_VECTOR_SIZE(auth_objects) == AST_VECTOR_SIZE(auth_ids) ? 0 : -1;
}

References ast_log, ast_sip_get_sorcery(), ast_sorcery_retrieve_by_id(), AST_VECTOR_APPEND, AST_VECTOR_GET, AST_VECTOR_SIZE, LOG_WARNING, name, and SIP_SORCERY_AUTH_TYPE.

Referenced by digest_create_request_with_auth().

ast_sip_rewrite_uri_to_local()

int ast_sip_rewrite_uri_to_local	(	pjsip_sip_uri *	uri,
		pjsip_tx_data *	tdata
	)

Replace domain and port of SIP URI to point to (external) signaling address of this Asterisk instance.

Parameters

uri
tdata

Return values

0	success
-1	failure

Note

Uses domain and port in Contact header if it exists, otherwise the local URI of the dialog is used if the message is sent within the context of a dialog. Further, NAT settings are considered - i.e. if the target is not in the localnet, the external_signaling_address and port are used.

Definition at line 605 of file res_pjsip.c.

                                                                           {
    RAII_VAR(struct ast_sip_transport *, transport, NULL, ao2_cleanup);
    RAII_VAR(struct ast_sip_transport_state *, transport_state, NULL, ao2_cleanup);
    struct ast_sip_request_transport_details details = { 0, };
    pjsip_sip_uri *tmp_uri;
    pjsip_dialog *dlg;
    struct ast_sockaddr addr = { { 0, } };
 
    if ((tmp_uri = ast_sip_get_contact_sip_uri(tdata))) {
        pj_strdup(tdata->pool, &uri->host, &tmp_uri->host);
        uri->port = tmp_uri->port;
    } else if ((dlg = pjsip_tdata_get_dlg(tdata))
        && (tmp_uri = pjsip_uri_get_uri(dlg->local.info->uri))
        && (PJSIP_URI_SCHEME_IS_SIP(tmp_uri) || PJSIP_URI_SCHEME_IS_SIPS(tmp_uri))) {
        pj_strdup(tdata->pool, &uri->host, &tmp_uri->host);
        uri->port = tmp_uri->port;
    }
 
    if (ast_sip_set_request_transport_details(&details, tdata, 1)
        || !(transport_state = ast_sip_find_transport_state_in_use(&details))
        || !(transport = ast_sorcery_retrieve_by_id(ast_sip_get_sorcery(), "transport", transport_state->id))) {
        return 0;
    }
 
    if (transport_state->localnet) {
        ast_sockaddr_parse(&addr, tdata->tp_info.dst_name, PARSE_PORT_FORBID);
        ast_sockaddr_set_port(&addr, tdata->tp_info.dst_port);
        if (ast_sip_transport_is_local(transport_state, &addr)) {
            return 0;
        }
    }
 
    if (!ast_sockaddr_isnull(&transport_state->external_signaling_address)) {
        pj_strdup2(tdata->pool, &uri->host, ast_sockaddr_stringify_host(&transport_state->external_signaling_address));
    }
 
    if (transport->external_signaling_port) {
        uri->port = transport->external_signaling_port;
    }
 
    return 0;
}

References ao2_cleanup, ast_sip_find_transport_state_in_use(), ast_sip_get_contact_sip_uri(), ast_sip_get_sorcery(), ast_sip_set_request_transport_details(), ast_sip_transport_is_local, ast_sockaddr_isnull(), ast_sockaddr_parse(), ast_sockaddr_set_port, ast_sockaddr_stringify_host(), ast_sorcery_retrieve_by_id(), NULL, PARSE_PORT_FORBID, RAII_VAR, and ast_sip_transport_state::transport.

Referenced by refer_on_tx_request().

ast_sip_security_mechanism_vector_init()

int ast_sip_security_mechanism_vector_init	(	struct ast_sip_security_mechanism_vector *	security_mechanism,
		const char *	value
	)

Initialize security mechanism vector from string of security mechanisms.

Parameters

security_mechanism	Pointer to vector of security mechanisms to initialize.
value	String of security mechanisms as defined in RFC 3329.

Return values

0	Success
non-zero	Failure

Definition at line 360 of file security_agreements.c.

{
    char *val = value ? ast_strdupa(value) : NULL;
    struct ast_sip_security_mechanism *mech;
    char *mechanism;
 
    ast_sip_security_mechanisms_vector_destroy(security_mechanisms);
    if (AST_VECTOR_INIT(security_mechanisms, 1)) {
        return -1;
    }
 
    if (!val) {
        return 0;
    }
 
    while ((mechanism = ast_strsep(&val, ',', AST_STRSEP_ALL))) {
        if (!ast_sip_str_to_security_mechanism(&mech, mechanism)) {
            AST_VECTOR_APPEND(security_mechanisms, mech);
        }
    }
 
    return 0;
}

References ast_sip_security_mechanisms_vector_destroy(), ast_sip_str_to_security_mechanism(), ast_strdupa, ast_strsep(), AST_STRSEP_ALL, AST_VECTOR_APPEND, AST_VECTOR_INIT, NULL, and value.

Referenced by security_mechanism_handler(), and security_mechanisms_handler().

ast_sip_security_mechanisms_to_str()

int ast_sip_security_mechanisms_to_str	(	const struct ast_sip_security_mechanism_vector *	security_mechanisms,
		int	add_qvalue,
		char **	buf
	)

Writes the security mechanisms of an endpoint into a buffer as a string and returns the buffer.

Note

The buffer must be freed by the caller.

Parameters

endpoint	Pointer to endpoint.
add_qvalue	If non-zero, the q-value is printed as well
buf	The buffer to write the string into

Return values

0	Success
non-zero	Failure

Definition at line 162 of file security_agreements.c.

{
    size_t vec_size;
    struct ast_sip_security_mechanism *mech;
    char *tmp_buf;
    RAII_VAR(struct ast_str *, str, ast_str_create(MAX_OBJECT_FIELD), ast_free);
    size_t i;
    int rc = 0;
 
    if (str == NULL) {
        return ENOMEM;
    }
 
    if (!security_mechanisms) {
        return -1;
    }
 
    vec_size = AST_VECTOR_SIZE(security_mechanisms);
    if (vec_size == 0) {
        return -1;
    }
 
    for (i = 0; i < vec_size; ++i) {
        mech = AST_VECTOR_GET(security_mechanisms, i);
        rc = security_mechanism_to_str(mech, add_qvalue, &tmp_buf);
        if (rc) {
            return rc;
        }
        rc = ast_str_append(&str, 0, "%s, ", tmp_buf);
        ast_free(tmp_buf);
        if (rc <= 0) {
            return ENOMEM;
        }
    }
 
    /* ast_str_truncate removes the trailing ", " on the last mechanism */
    *buf = ast_strdup(ast_str_truncate(str, -2));
 
    return 0;
}

References ast_free, ast_str_append(), ast_str_create, ast_str_truncate(), ast_strdup, AST_VECTOR_GET, AST_VECTOR_SIZE, buf, MAX_OBJECT_FIELD, NULL, RAII_VAR, security_mechanism_to_str(), and str.

Referenced by security_mechanism_to_str(), and security_mechanism_to_str().

ast_sip_security_mechanisms_vector_copy()

void ast_sip_security_mechanisms_vector_copy	(	struct ast_sip_security_mechanism_vector *	dst,
		const struct ast_sip_security_mechanism_vector *	src
	)

Duplicate a security mechanism.

Parameters

dst	Security mechanism to duplicate to.
src	Security mechanism to duplicate.

Definition at line 81 of file security_agreements.c.

{
    struct ast_sip_security_mechanism *mech;
    int i;
 
    ast_sip_security_mechanisms_vector_destroy(dst);
    for (i = 0; i < AST_VECTOR_SIZE(src); i++) {
        mech = AST_VECTOR_GET(src, i);
        AST_VECTOR_APPEND(dst, security_mechanisms_copy(mech));
    }
};

References ast_sip_security_mechanisms_vector_destroy(), AST_VECTOR_APPEND, AST_VECTOR_GET, AST_VECTOR_SIZE, and security_mechanisms_copy().

Referenced by sip_contact_status_copy(), and sip_outbound_registration_perform().

ast_sip_security_mechanisms_vector_destroy()

void ast_sip_security_mechanisms_vector_destroy

(

struct ast_sip_security_mechanism_vector *

security_mechanisms

)

Free contents of a security mechanism vector.

Parameters

security_mechanisms

Vector whose contents are to be freed

Definition at line 94 of file security_agreements.c.

{
    if (!security_mechanisms) {
        return;
    }
 
    AST_VECTOR_RESET(security_mechanisms, security_mechanism_destroy);
    AST_VECTOR_FREE(security_mechanisms);
}

References AST_VECTOR_FREE, AST_VECTOR_RESET, and security_mechanism_destroy().

Referenced by ast_sip_security_mechanism_vector_init(), ast_sip_security_mechanisms_vector_copy(), endpoint_destructor(), handle_client_state_destruction(), sip_contact_status_dtor(), sip_outbound_registration_destroy(), and sip_outbound_registration_perform().

ast_sip_send_out_of_dialog_request()

int ast_sip_send_out_of_dialog_request	(	pjsip_tx_data *	tdata,
		struct ast_sip_endpoint *	endpoint,
		int	timeout,
		void *	token,
		void(*)(void *token, pjsip_event *e)	callback
	)

General purpose method for sending an Out-Of-Dialog SIP request.

This is a companion function for ast_sip_create_request. The request created there can be passed to this function, though any request may be passed in.

This will automatically set up handling outbound authentication challenges if they arrive.

Parameters

tdata	The request to send
endpoint	Optional. If specified, the out-of-dialog request is sent to the endpoint.
timeout	If non-zero, after the timeout the transaction will be terminated and the callback will be called with the PJSIP_EVENT_TIMER type.
token	Data to be passed to the callback upon receipt of out-of-dialog response.
callback	Callback to be called upon receipt of out-of-dialog response.

Return values

0	Success
-1	Failure (out-of-dialog callback will not be called.)

Note

Timeout processing: There are 2 timers associated with this request, PJSIP timer_b which is set globally in the "system" section of pjsip.conf, and the timeout specified on this call. The timer that expires first (before normal completion) will cause the callback to be run with e->body.tsx_state.type = PJSIP_EVENT_TIMER. The timer that expires second is simply ignored and the callback is not run again.

Definition at line 1938 of file res_pjsip.c.

{
    struct ast_sip_supplement *supplement;
    struct send_request_data *req_data;
    struct ast_sip_contact *contact;
 
    req_data = send_request_data_alloc(endpoint, token, callback);
    if (!req_data) {
        pjsip_tx_data_dec_ref(tdata);
        return -1;
    }
 
    if (endpoint) {
        ast_sip_message_apply_transport(endpoint->transport, tdata);
    }
 
    contact = ast_sip_mod_data_get(tdata->mod_data, supplement_module.id, MOD_DATA_CONTACT);
 
    AST_RWLIST_RDLOCK(&supplements);
    AST_LIST_TRAVERSE(&supplements, supplement, next) {
        if (supplement->outgoing_request
            && does_method_match(&tdata->msg->line.req.method.name, supplement->method)) {
            supplement->outgoing_request(endpoint, contact, tdata);
        }
    }
    AST_RWLIST_UNLOCK(&supplements);
 
    ast_sip_mod_data_set(tdata->pool, tdata->mod_data, supplement_module.id, MOD_DATA_CONTACT, NULL);
    ao2_cleanup(contact);
 
    if (endpt_send_request(endpoint, tdata, timeout, req_data, send_request_cb)
        != PJ_SUCCESS) {
        ao2_cleanup(req_data);
        return -1;
    }
 
    return 0;
}

References ao2_cleanup, AST_LIST_TRAVERSE, AST_RWLIST_RDLOCK, AST_RWLIST_UNLOCK, ast_sip_message_apply_transport(), ast_sip_mod_data_get, ast_sip_mod_data_set, callback(), does_method_match(), ast_sip_contact::endpoint, endpt_send_request(), ast_sip_supplement::method, MOD_DATA_CONTACT, NULL, ast_sip_supplement::outgoing_request, send_request_cb(), send_request_data_alloc(), supplement_module, and ast_sip_endpoint::transport.

Referenced by ast_sip_send_request(), and sip_options_qualify_contact().

ast_sip_send_request()

int ast_sip_send_request	(	pjsip_tx_data *	tdata,
		struct pjsip_dialog *	dlg,
		struct ast_sip_endpoint *	endpoint,
		void *	token,
		void(*)(void *token, pjsip_event *e)	callback
	)

General purpose method for sending a SIP request.

This is a companion function for ast_sip_create_request. The request created there can be passed to this function, though any request may be passed in.

This will automatically set up handling outbound authentication challenges if they arrive.

Parameters

tdata	The request to send
dlg	Optional. The dialog in which the request is sent. Otherwise it is out-of-dialog.
endpoint	Optional. If specified, the out-of-dialog request is sent to the endpoint.
token	Data to be passed to the callback upon receipt of out-of-dialog response.
callback	Callback to be called upon receipt of out-of-dialog response.

Return values

0	Success
-1	Failure (out-of-dialog callback will not be called.)

Definition at line 1979 of file res_pjsip.c.

{
    ast_assert(tdata->msg->type == PJSIP_REQUEST_MSG);
 
    if (dlg) {
        return send_in_dialog_request(tdata, dlg);
    } else {
        return ast_sip_send_out_of_dialog_request(tdata, endpoint, -1, token, callback);
    }
}

References ast_assert, ast_sip_send_out_of_dialog_request(), callback(), ast_sip_contact::endpoint, and send_in_dialog_request().

Referenced by msg_send(), notify_channel(), notify_contact(), notify_uri(), refer_client_on_evsub_state(), send_unsolicited_mwi_notify_to_contact(), and sendtext().

ast_sip_send_response()

int ast_sip_send_response	(	pjsip_response_addr *	res_addr,
		pjsip_tx_data *	tdata,
		struct ast_sip_endpoint *	sip_endpoint
	)

Send a response to an out of dialog request.

Use this function sparingly, since this does not create a transaction within PJSIP. This means that if the request is retransmitted, it is your responsibility to detect this and not process the same request twice, and to send the same response for each retransmission.

Parameters

res_addr	The response address for this response
tdata	The response to send
sip_endpoint	The ast_sip_endpoint associated with this response

Return values

0	Success
-1	Failure

Definition at line 2396 of file res_pjsip.c.

{
    pj_status_t status;
 
    supplement_outgoing_response(tdata, sip_endpoint);
    status = pjsip_endpt_send_response(ast_sip_get_pjsip_endpoint(), res_addr, tdata, NULL, NULL);
    if (status != PJ_SUCCESS) {
        pjsip_tx_data_dec_ref(tdata);
    }
 
    return status == PJ_SUCCESS ? 0 : -1;
}

References ast_sip_get_pjsip_endpoint(), NULL, status, and supplement_outgoing_response().

ast_sip_send_stateful_response()

int ast_sip_send_stateful_response	(	pjsip_rx_data *	rdata,
		pjsip_tx_data *	tdata,
		struct ast_sip_endpoint *	sip_endpoint
	)

Send a stateful response to an out of dialog request.

This creates a transaction within PJSIP, meaning that if the request that we are responding to is retransmitted, we will not attempt to re-handle the request.

Parameters

rdata	The request that is being responded to
tdata	The response to send
sip_endpoint	The ast_sip_endpoint associated with this response

Since

13.4.0

Return values

0	Success
-1	Failure

Definition at line 2424 of file res_pjsip.c.

{
    pjsip_transaction *tsx;
    pj_grp_lock_t *tsx_glock;
    pj_pool_t *pool;
 
    /* Create and initialize global lock pool */
    pool = pjsip_endpt_create_pool(ast_sip_get_pjsip_endpoint(), "stateful response", PJSIP_POOL_TSX_LEN, PJSIP_POOL_TSX_INC);
    if (!pool){
        /* ast_sip_create_response bumps the refcount of the contact and adds it to the tdata.
         * We'll leak that reference if we don't get rid of it here.
         */
        clean_contact_from_tdata(tdata);
        return -1;
    }
    /* Create with handler so that we can release the pool once the glock derefs out */
    if(pj_grp_lock_create_w_handler(pool, NULL, pool, &pool_destroy_callback, &tsx_glock) != PJ_SUCCESS) {
        clean_contact_from_tdata(tdata);
        pool_destroy_callback((void *) pool);
        return -1;
    }
    /* We need an additional reference as the qualify thread may destroy this out
     * from under us. Add it now before it gets added to the tsx. */
    pj_grp_lock_add_ref(tsx_glock);
 
    if (pjsip_tsx_create_uas2(NULL, rdata, tsx_glock, &tsx) != PJ_SUCCESS) {
        clean_contact_from_tdata(tdata);
        pj_grp_lock_dec_ref(tsx_glock);
        return -1;
    }
 
    pjsip_tsx_recv_msg(tsx, rdata);
    supplement_outgoing_response(tdata, sip_endpoint);
 
    if (pjsip_tsx_send_msg(tsx, tdata) != PJ_SUCCESS) {
        pj_grp_lock_dec_ref(tsx_glock);
        pjsip_tx_data_dec_ref(tdata);
        return -1;
    }
 
    pj_grp_lock_dec_ref(tsx_glock);
    return 0;
}

References ast_sip_get_pjsip_endpoint(), clean_contact_from_tdata(), NULL, pool_destroy_callback(), and supplement_outgoing_response().

Referenced by register_aor(), send_options_response(), and send_response().

ast_sip_service_route_vector_alloc()

struct ast_sip_service_route_vector * ast_sip_service_route_vector_alloc

(

void

)

Allocate a vector of service routes.

Since

17.0.0

Return values

non-NULL	success
NULL	failure

Definition at line 352 of file config_transport.c.

{
    struct ast_sip_service_route_vector *service_routes;
 
    service_routes = ast_calloc(1, sizeof(*service_routes));
    if (!service_routes) {
        return NULL;
    }
 
    AST_VECTOR_INIT(service_routes, 0);
 
    return service_routes;
}

References ast_calloc, AST_VECTOR_INIT, and NULL.

Referenced by save_response_fields_to_transport().

ast_sip_service_route_vector_destroy()

void ast_sip_service_route_vector_destroy

(

struct ast_sip_service_route_vector *

service_routes

)

Destroy a vector of service routes.

Since

17.0.0

Parameters

service_routes

A vector of service routes

Definition at line 366 of file config_transport.c.

{
    if (!service_routes) {
        return;
    }
 
    AST_VECTOR_CALLBACK_VOID(service_routes, ast_free);
    ast_free(service_routes);
}

References ast_free, and AST_VECTOR_CALLBACK_VOID.

Referenced by ast_sip_transport_state_set_service_routes(), and save_response_fields_to_transport().

ast_sip_set_id_connected_line()

int ast_sip_set_id_connected_line	(	struct pjsip_rx_data *	rdata,
		struct ast_party_id *	id
	)

Set the ID for a connected line update.

Return values

-1	on failure, 0 on success

Definition at line 2822 of file res_pjsip.c.

{
    return !set_id_from_pai(rdata, id) || !set_id_from_rpid(rdata, id) ? 0 : -1;
}

References set_id_from_pai(), and set_id_from_rpid().

Referenced by update_incoming_connected_line().

ast_sip_set_id_from_invite()

int ast_sip_set_id_from_invite	(	struct pjsip_rx_data *	rdata,
		struct ast_party_id *	id,
		struct ast_party_id *	default_id,
		int	trust_inbound
	)

Set the ID from an INVITE.

Parameters

rdata
id	ID structure to fill
default_id	Default ID structure with data to use (for non-trusted endpoints)
trust_inbound	Whether or not the endpoint is trusted (controls whether PAI or RPID can be used)

Return values

-1	on failure, 0 on success

Definition at line 2827 of file res_pjsip.c.

{
    if (trust_inbound && (!set_id_from_pai(rdata, id) || !set_id_from_rpid(rdata, id))) {
        /* Trusted: Check PAI and RPID */
        ast_free(id->tag);
        id->tag = ast_strdup(default_id->tag);
        return 0;
    }
    /* Not trusted: check the endpoint config or use From. */
    ast_party_id_copy(id, default_id);
    if (!default_id->number.valid) {
        set_id_from_from(rdata, id);
    }
    return 0;
}

References ast_free, ast_party_id_copy(), ast_strdup, id, ast_party_id::number, set_id_from_from(), set_id_from_pai(), set_id_from_rpid(), ast_party_id::tag, and ast_party_number::valid.

Referenced by caller_id_incoming_request(), and fetch_callerid_num().

ast_sip_set_outbound_proxy()

int ast_sip_set_outbound_proxy	(	pjsip_tx_data *	tdata,
		const char *	proxy
	)

Set the outbound proxy for an outbound SIP message.

Parameters

tdata	The message to set the outbound proxy on
proxy	SIP uri of the proxy

Return values

0	Success
-1	Failure

Definition at line 1992 of file res_pjsip.c.

{
    pjsip_route_hdr *route;
    static const pj_str_t ROUTE_HNAME = { "Route", 5 };
    pj_str_t tmp;
 
    pj_strdup2_with_null(tdata->pool, &tmp, proxy);
    if (!(route = pjsip_parse_hdr(tdata->pool, &ROUTE_HNAME, tmp.ptr, tmp.slen, NULL))) {
        return -1;
    }
 
    pj_list_insert_nodes_before(&tdata->msg->hdr, (pjsip_hdr*)route);
 
    return 0;
}

References NULL.

Referenced by create_out_of_dialog_request(), path_outgoing_request(), and sip_options_qualify_contact().

ast_sip_set_request_transport_details()

int ast_sip_set_request_transport_details	(	struct ast_sip_request_transport_details *	details,
		pjsip_tx_data *	tdata,
		int	use_ipv6
	)

Sets request transport details based on tdata.

Parameters

details	pre-allocated request transport details to set
tdata
use_ipv6	if non-zero, ipv6 transports will be considered

Return values

0	success
-1	failure

Definition at line 648 of file res_pjsip.c.

                  {
    pjsip_sip_uri *uri;
    pjsip_via_hdr *via;
    long transport_type;
 
    if (!details || !tdata) {
        return -1;
    }
 
    /* If IPv6 should be considered, un-set Bit 7 to make TCP6 equal to TCP and TLS6 equal to TLS */
    transport_type = use_ipv6 ? tdata->tp_info.transport->key.type & ~(PJSIP_TRANSPORT_IPV6)
        : tdata->tp_info.transport->key.type;
 
    if (tdata->tp_sel.type == PJSIP_TPSELECTOR_TRANSPORT) {
        details->transport = tdata->tp_sel.u.transport;
    } else if (tdata->tp_sel.type == PJSIP_TPSELECTOR_LISTENER) {
        details->factory = tdata->tp_sel.u.listener;
    } else if (transport_type == PJSIP_TRANSPORT_UDP || transport_type == PJSIP_TRANSPORT_UDP6) {
        /* Connectionless uses the same transport for all requests */
        details->type = AST_TRANSPORT_UDP;
        details->transport = tdata->tp_info.transport;
    } else {
        if (transport_type == PJSIP_TRANSPORT_TCP) {
            details->type = AST_TRANSPORT_TCP;
        } else if (transport_type == PJSIP_TRANSPORT_TLS) {
            details->type = AST_TRANSPORT_TLS;
        } else {
            /* Unknown transport type, we can't map. */
            return -1;
        }
 
        if ((uri = ast_sip_get_contact_sip_uri(tdata))) {
            details->local_address = uri->host;
            details->local_port = uri->port;
        } else if ((tdata->msg->type == PJSIP_REQUEST_MSG) &&
            (via = pjsip_msg_find_hdr(tdata->msg, PJSIP_H_VIA, NULL))) {
            details->local_address = via->sent_by.host;
            details->local_port = via->sent_by.port;
        } else {
            return -1;
        }
 
        if (!details->local_port) {
            details->local_port = (details->type == AST_TRANSPORT_TLS) ? 5061 : 5060;
        }
    }
    return 0;
}

References ast_sip_get_contact_sip_uri(), AST_TRANSPORT_TCP, AST_TRANSPORT_TLS, AST_TRANSPORT_UDP, ast_sip_request_transport_details::factory, ast_sip_request_transport_details::local_address, ast_sip_request_transport_details::local_port, NULL, ast_sip_request_transport_details::transport, and ast_sip_request_transport_details::type.

Referenced by ast_sip_rewrite_uri_to_local(), and process_nat().

ast_sip_set_security_negotiation()

int ast_sip_set_security_negotiation	(	enum ast_sip_security_negotiation *	security_negotiation,
		const char *	val
	)

Set the security negotiation based on a given string.

Parameters

security_negotiation	Security negotiation enum to set.
val	String that represents a security_negotiation value.

Return values

0	Success
non-zero	Failure

Definition at line 288 of file pjsip_configuration.c.

                                                                                                               {
    if (!strcasecmp("no", val)) {
        *security_negotiation = AST_SIP_SECURITY_NEG_NONE;
    } else if (!strcasecmp("mediasec", val)) {
        *security_negotiation = AST_SIP_SECURITY_NEG_MEDIASEC;
    } else {
        return -1;
    }
    return 0;
}

References AST_SIP_SECURITY_NEG_MEDIASEC, AST_SIP_SECURITY_NEG_NONE, and ast_sip_endpoint::security_negotiation.

Referenced by security_negotiation_handler(), and security_negotiation_handler().

ast_sip_set_tpselector_from_ep_or_uri()

int ast_sip_set_tpselector_from_ep_or_uri	(	const struct ast_sip_endpoint *	endpoint,
		pjsip_sip_uri *	sip_uri,
		pjsip_tpselector *	selector
	)

Sets pjsip_tpselector from an endpoint or uri.

Since

13.15.0

Parameters

endpoint	If endpoint->transport is set, it's used
sip_uri	If sip_uri contains a x-ast-txp parameter, it's used
selector	The selector to be populated

Return values

0	success
-1	failure

Definition at line 911 of file res_pjsip.c.

{
    char transport_name[128];
 
    if (ast_sip_get_transport_name(endpoint, sip_uri, transport_name, sizeof(transport_name))) {
        return 0;
    }
 
    return ast_sip_set_tpselector_from_transport_name(transport_name, selector);
}

References ast_sip_get_transport_name(), and ast_sip_set_tpselector_from_transport_name().

Referenced by ast_sip_dlg_set_transport(), create_dialog_uas(), and create_out_of_dialog_request().

ast_sip_set_tpselector_from_transport()

int ast_sip_set_tpselector_from_transport	(	const struct ast_sip_transport *	transport,
		pjsip_tpselector *	selector
	)

Sets pjsip_tpselector from ast_sip_transport.

Since

13.8.0

Parameters

transport	The transport to be used
selector	The selector to be populated

Return values

0	success
-1	failure

Note

The transport selector must be unreffed using ast_sip_tpselector_unref

Definition at line 843 of file res_pjsip.c.

{
    int res = 0;
    struct ast_sip_transport_state *transport_state;
 
    transport_state = ast_sip_get_transport_state(ast_sorcery_object_get_id(transport));
    if (!transport_state) {
        ast_log(LOG_ERROR, "Unable to retrieve PJSIP transport state for '%s'\n",
            ast_sorcery_object_get_id(transport));
        return -1;
    }
 
    /* Only flows maintain dynamic state which needs protection */
    if (transport_state->flow) {
        ao2_lock(transport_state);
    }
 
    if (transport_state->transport) {
        selector->type = PJSIP_TPSELECTOR_TRANSPORT;
        selector->u.transport = transport_state->transport;
        pjsip_transport_add_ref(selector->u.transport);
    } else if (transport_state->factory) {
        selector->type = PJSIP_TPSELECTOR_LISTENER;
        selector->u.listener = transport_state->factory;
    } else if (transport->type == AST_TRANSPORT_WS || transport->type == AST_TRANSPORT_WSS) {
        /* The WebSocket transport has no factory as it can not create outgoing connections, so
         * even if an endpoint is locked to a WebSocket transport we let the PJSIP logic
         * find the existing connection if available and use it.
         */
    } else if (transport->flow) {
        /* This is a child of another transport, so we need to establish a new connection */
#ifdef HAVE_PJSIP_TRANSPORT_DISABLE_CONNECTION_REUSE
        selector->disable_connection_reuse = PJ_TRUE;
#else
        ast_log(LOG_WARNING, "Connection reuse could not be disabled on transport '%s' as support is not available\n",
            ast_sorcery_object_get_id(transport));
#endif
    } else {
        res = -1;
    }
 
    if (transport_state->flow) {
        ao2_unlock(transport_state);
    }
 
    ao2_ref(transport_state, -1);
 
    return res;
}

References ao2_lock, ao2_ref, ao2_unlock, ast_log, ast_sip_get_transport_state(), ast_sorcery_object_get_id(), AST_TRANSPORT_WS, AST_TRANSPORT_WSS, ast_sip_transport_state::factory, ast_sip_transport_state::flow, LOG_ERROR, LOG_WARNING, and ast_sip_transport_state::transport.

Referenced by ast_sip_set_tpselector_from_transport_name().

ast_sip_set_tpselector_from_transport_name()

int ast_sip_set_tpselector_from_transport_name	(	const char *	transport_name,
		pjsip_tpselector *	selector
	)

Sets pjsip_tpselector from ast_sip_transport.

Since

13.8.0

Parameters

transport_name	The name of the transport to be used
selector	The selector to be populated

Return values

0	success
-1	failure

Note

The transport selector must be unreffed using ast_sip_tpselector_unref

Definition at line 893 of file res_pjsip.c.

{
    RAII_VAR(struct ast_sip_transport *, transport, NULL, ao2_cleanup);
 
    if (ast_strlen_zero(transport_name)) {
        return 0;
    }
 
    transport = ast_sorcery_retrieve_by_id(ast_sip_get_sorcery(), "transport", transport_name);
    if (!transport) {
        ast_log(LOG_ERROR, "Unable to retrieve PJSIP transport '%s'\n",
            transport_name);
        return -1;
    }
 
    return ast_sip_set_tpselector_from_transport(transport, selector);
}

References ao2_cleanup, ast_log, ast_sip_get_sorcery(), ast_sip_set_tpselector_from_transport(), ast_sorcery_retrieve_by_id(), ast_strlen_zero(), LOG_ERROR, NULL, RAII_VAR, and ast_sip_transport_state::transport.

Referenced by ast_sip_set_tpselector_from_ep_or_uri(), registration_client_send(), set_transport(), and sip_outbound_registration_regc_alloc().

ast_sip_sorcery_object_to_ami()

int ast_sip_sorcery_object_to_ami	(	const void *	obj,
		struct ast_str **	buf
	)

Converts a sorcery object to a string of object properties.

Parameters

obj	the sorcery object to convert
buf	the string buffer to write the object data

Return values

0	Success, non-zero on failure

Definition at line 1751 of file pjsip_configuration.c.

{
    RAII_VAR(struct ast_variable *, objset, ast_sorcery_objectset_create2(
             ast_sip_get_sorcery(), obj, AST_HANDLER_ONLY_STRING), ast_variables_destroy);
    struct ast_variable *i;
 
    if (!objset) {
        return -1;
    }
 
    sip_sorcery_object_ami_set_type_name(obj, buf);
 
    for (i = objset; i; i = i->next) {
        RAII_VAR(char *, camel, ast_to_camel_case(i->name), ast_free);
        ast_str_append(buf, 0, "%s: %s\r\n", camel, i->value);
    }
 
    return 0;
}

References ast_free, AST_HANDLER_ONLY_STRING, ast_sip_get_sorcery(), ast_sorcery_objectset_create2(), ast_str_append(), ast_to_camel_case, ast_variables_destroy(), buf, ast_variable::name, ast_variable::next, RAII_VAR, sip_sorcery_object_ami_set_type_name(), and ast_variable::value.

Referenced by ami_outbound_registration_task(), ami_registrations_aor(), format_ami_resource_lists(), sip_auth_to_ami(), sip_contact_to_ami(), sip_endpoint_to_ami(), sip_identify_to_ami(), and sip_transport_to_ami().

ast_sip_str2rc()

int ast_sip_str2rc

(

const char *

name

)

Convert name to SIP response code.

Parameters

name	SIP response code name matching one of the enum names defined in "enum pjsip_status_code" defined in sip_msg.h. May be specified with or without the PJSIP_SC_ prefix.

Return values

SIP	response code
-1	if matching code not found

Definition at line 3714 of file res_pjsip.c.

{
    int i;
 
    if (ast_strlen_zero(name)) {
        return -1;
    }
 
    for (i = 0; i < ARRAY_LEN(rc_map); i++) {
        if (strcasecmp(rc_map[i].short_name, name) == 0 ||
            strcasecmp(rc_map[i].long_name, name) == 0) {
            return rc_map[i].code;
        }
    }
 
    return -1;
}

References ARRAY_LEN, ast_strlen_zero(), response_code_map::code, response_code_map::long_name, name, rc_map, and response_code_map::short_name.

Referenced by response_code_validator().

ast_sip_str_to_dtmf()

int ast_sip_str_to_dtmf

(

const char *

dtmf_mode

)

Convert the DTMF mode name into an enum.

Since

13.18.0

Parameters

dtmf_mode

dtmf mode as a string

Return values

>=	0 The enum value
-1	Failure

Definition at line 2533 of file res_pjsip.c.

{
    int result = -1;
 
    if (!strcasecmp(dtmf_mode, "info")) {
        result = AST_SIP_DTMF_INFO;
    } else if (!strcasecmp(dtmf_mode, "rfc4733")) {
        result = AST_SIP_DTMF_RFC_4733;
    } else if (!strcasecmp(dtmf_mode, "inband")) {
        result = AST_SIP_DTMF_INBAND;
    } else if (!strcasecmp(dtmf_mode, "none")) {
        result = AST_SIP_DTMF_NONE;
    } else if (!strcasecmp(dtmf_mode, "auto")) {
        result = AST_SIP_DTMF_AUTO;
    } else if (!strcasecmp(dtmf_mode, "auto_info")) {
        result = AST_SIP_DTMF_AUTO_INFO;
    }
 
    return result;
}

References AST_SIP_DTMF_AUTO, AST_SIP_DTMF_AUTO_INFO, AST_SIP_DTMF_INBAND, AST_SIP_DTMF_INFO, AST_SIP_DTMF_NONE, AST_SIP_DTMF_RFC_4733, and result.

Referenced by dtmf_handler(), and pjsip_acf_dtmf_mode_write().

ast_sip_str_to_security_mechanism()

int ast_sip_str_to_security_mechanism	(	struct ast_sip_security_mechanism **	security_mechanism,
		const char *	value
	)

Allocate a security mechanism from a string.

Parameters

security_mechanism	Pointer-pointer to the security mechanism to allocate.
value	The security mechanism string as defined in RFC 3329 (section 2.2) in the form <mechanism_name>;q=<q_value>;<mechanism_parameters>

Return values

0	Success
non-zero	Failure

Definition at line 242 of file security_agreements.c.

                                                                                                                 {
    struct ast_sip_security_mechanism *mech;
    char *param;
    char *tmp;
    char *mechanism = ast_strdupa(value);
    int err = 0;
    int type = -1;
 
    mech = security_mechanisms_alloc(1);
    if (!mech) {
        err = ENOMEM;
        goto out;
    }
 
    tmp = ast_strsep(&mechanism, ';', AST_STRSEP_ALL);
    type = str_to_security_mechanism_type(tmp);
    if (type == -1) {
        err = EINVAL;
        goto out;
    }
 
    mech->type = type;
    while ((param = ast_strsep(&mechanism, ';', AST_STRSEP_ALL))) {
        if (!param) {
            err = EINVAL;
            goto out;
        }
        if (!strncmp(param, "q=", 2)) {
            mech->qvalue = parse_qvalue(&param[2]);
            if (mech->qvalue < 0.0) {
                err = EINVAL;
                goto out;
            }
            continue;
        }
        param = ast_strdup(param);
        AST_VECTOR_APPEND(&mech->mechanism_parameters, param);
    }
 
    *security_mechanism = mech;
 
out:
    if (err && (mech != NULL)) {
        security_mechanism_destroy(mech);
    }
    return err;
}

References ast_strdup, ast_strdupa, ast_strsep(), AST_STRSEP_ALL, AST_VECTOR_APPEND, ast_sip_security_mechanism::mechanism_parameters, NULL, out, parse_qvalue(), ast_sip_security_mechanism::qvalue, security_mechanism_destroy(), security_mechanisms_alloc(), str_to_security_mechanism_type(), type, ast_sip_security_mechanism::type, and value.

Referenced by ast_sip_header_to_security_mechanism(), ast_sip_security_mechanism_vector_init(), and rfc3329_incoming_response().

ast_sip_threadpool()

struct ast_threadpool * ast_sip_threadpool

(

void

)

Retrieve the SIP threadpool object.

Definition at line 3462 of file res_pjsip.c.

{
    return sip_threadpool;
}

References sip_threadpool.

Referenced by load_module().

ast_sip_threadpool_queue_size()

long ast_sip_threadpool_queue_size

(

void

)

Return the size of the SIP threadpool's task queue.

Since

13.7.0

Definition at line 3457 of file res_pjsip.c.

{
    return ast_threadpool_queue_size(sip_threadpool);
}

References ast_threadpool_queue_size(), and sip_threadpool.

ast_sip_tpselector_unref()

void ast_sip_tpselector_unref

(

pjsip_tpselector *

selector

)

Unreference a pjsip_tpselector.

Since

17.0.0

Parameters

selector

The selector to be unreffed

Definition at line 923 of file res_pjsip.c.

{
    if (selector->type == PJSIP_TPSELECTOR_TRANSPORT && selector->u.transport) {
        pjsip_transport_dec_ref(selector->u.transport);
    }
}

Referenced by ast_sip_create_dialog_uac(), ast_sip_dlg_set_transport(), create_dialog_uas(), create_out_of_dialog_request(), registration_client_send(), set_transport(), and sip_outbound_registration_regc_alloc().

ast_sip_transport_monitor_register()

enum ast_transport_monitor_reg ast_sip_transport_monitor_register	(	pjsip_transport *	transport,
		ast_transport_monitor_shutdown_cb	cb,
		void *	ao2_data
	)

Register a reliable transport shutdown monitor callback.

Deprecated:

Replaced with ast_sip_transport_monitor_register_key().

Since

13.20.0

Parameters

transport	Transport to monitor for shutdown.
cb	Who to call when transport is shutdown.
ao2_data	Data to pass with the callback.

Note

The data object passed will have its reference count automatically incremented by this call and automatically decremented after the callback runs or when the callback is unregistered.

There is no checking for duplicate registrations.

Returns

enum ast_transport_monitor_reg

Definition at line 478 of file pjsip_transport_events.c.

{
    char key[IP6ADDR_COLON_PORT_BUFLEN];
    AST_SIP_MAKE_REMOTE_IPADDR_PORT_STR(transport, key);
 
    return ast_sip_transport_monitor_register_replace_key(key, cb, ao2_data, NULL);
}

References AST_SIP_MAKE_REMOTE_IPADDR_PORT_STR, ast_sip_transport_monitor_register_replace_key(), callback_data::cb, IP6ADDR_COLON_PORT_BUFLEN, and NULL.

ast_sip_transport_monitor_register_key()

enum ast_transport_monitor_reg ast_sip_transport_monitor_register_key	(	const char *	transport_key,
		ast_transport_monitor_shutdown_cb	cb,
		void *	ao2_data
	)

Register a reliable transport shutdown monitor callback.

Parameters

transport_key	Key for the transport to monitor for shutdown. Create the key with AST_SIP_MAKE_REMOTE_IPADDR_PORT_STR.
cb	Who to call when transport is shutdown.
ao2_data	Data to pass with the callback.

Note

The data object passed will have its reference count automatically incremented by this call and automatically decremented after the callback runs or when the callback is unregistered.

There is no checking for duplicate registrations.

Returns

enum ast_transport_monitor_reg

Definition at line 487 of file pjsip_transport_events.c.

{
    return ast_sip_transport_monitor_register_replace_key(transport_key, cb, ao2_data, NULL);
}

References ast_sip_transport_monitor_register_replace_key(), callback_data::cb, and NULL.

Referenced by subscription_persistence_update().

ast_sip_transport_monitor_register_replace()

enum ast_transport_monitor_reg ast_sip_transport_monitor_register_replace	(	pjsip_transport *	transport,
		ast_transport_monitor_shutdown_cb	cb,
		void *	ao2_data,
		ast_transport_monitor_data_matcher	matches
	)

Register a reliable transport shutdown monitor callback replacing any duplicate.

Deprecated:

Replaced with ast_sip_transport_monitor_register_replace_key().

Since

13.26.0

16.3.0

Parameters

transport	Transport to monitor for shutdown.
cb	Who to call when transport is shutdown.
ao2_data	Data to pass with the callback.
matches	Matcher function that returns true if data matches a previously registered data object

Note

The data object passed will have its reference count automatically incremented by this call and automatically decremented after the callback runs or when the callback is unregistered.

This function checks for duplicates, and overwrites/replaces the old monitor with the given one.

Returns

enum ast_transport_monitor_reg

Definition at line 493 of file pjsip_transport_events.c.

{
    char key[IP6ADDR_COLON_PORT_BUFLEN];
 
    AST_SIP_MAKE_REMOTE_IPADDR_PORT_STR(transport, key);
    return ast_sip_transport_monitor_register_replace_key(key, cb, ao2_data, NULL);
}

References AST_SIP_MAKE_REMOTE_IPADDR_PORT_STR, ast_sip_transport_monitor_register_replace_key(), callback_data::cb, IP6ADDR_COLON_PORT_BUFLEN, and NULL.

Referenced by register_aor_core().

ast_sip_transport_monitor_register_replace_key()

enum ast_transport_monitor_reg ast_sip_transport_monitor_register_replace_key	(	const char *	transport_key,
		ast_transport_monitor_shutdown_cb	cb,
		void *	ao2_data,
		ast_transport_monitor_data_matcher	matches
	)

Register a reliable transport shutdown monitor callback replacing any duplicate.

Parameters

transport_key	Key for the transport to monitor for shutdown. Create the key with AST_SIP_MAKE_REMOTE_IPADDR_PORT_STR.
cb	Who to call when transport is shutdown.
ao2_data	Data to pass with the callback.
matches	Matcher function that returns true if data matches a previously registered data object

Note

The data object passed will have its reference count automatically incremented by this call and automatically decremented after the callback runs or when the callback is unregistered.

This function checks for duplicates, and overwrites/replaces the old monitor with the given one.

Returns

enum ast_transport_monitor_reg

Definition at line 502 of file pjsip_transport_events.c.

{
    struct ao2_container *transports;
    struct transport_monitor *monitored;
    enum ast_transport_monitor_reg res = AST_TRANSPORT_MONITOR_REG_NOT_FOUND;
 
    ast_assert(transport_key != NULL && cb != NULL);
 
    transports = ao2_global_obj_ref(active_transports);
    if (!transports) {
        return res;
    }
 
    ao2_lock(transports);
    monitored = ao2_find(transports, transport_key, OBJ_SEARCH_KEY | OBJ_NOLOCK);
    if (monitored) {
        struct transport_monitor_notifier new_monitor;
        struct callback_data cb_data = {
            .cb = cb,
            .data = ao2_data,
            .matches = matches ?: ptr_matcher,
        };
 
        transport_monitor_unregister_cb(monitored, &cb_data, 0);
 
        /* Add new monitor to vector */
        new_monitor.cb = cb;
        new_monitor.data = ao2_bump(ao2_data);
        if (AST_VECTOR_APPEND(&monitored->monitors, new_monitor)) {
            ao2_cleanup(ao2_data);
            res = AST_TRANSPORT_MONITOR_REG_FAILED;
            ast_debug(3, "Transport %s(%s) RefCnt: %ld : Monitor registration failed %p(%p)\n",
                monitored->key, monitored->transport_obj_name,
                pj_atomic_get(monitored->transport->ref_cnt), cb, ao2_data);
        } else {
            res = AST_TRANSPORT_MONITOR_REG_SUCCESS;
            ast_debug(3, "Transport %s(%s,%s) RefCnt: %ld : Registered monitor %p(%p)\n",
                monitored->key, monitored->transport_obj_name,
                monitored->transport->type_name,
                pj_atomic_get(monitored->transport->ref_cnt), cb, ao2_data);
        }
 
        ao2_ref(monitored, -1);
    }
    ao2_unlock(transports);
    ao2_ref(transports, -1);
    return res;
}

References ao2_bump, ao2_cleanup, ao2_find, ao2_global_obj_ref, ao2_lock, ao2_ref, ao2_unlock, ast_assert, ast_debug, AST_TRANSPORT_MONITOR_REG_FAILED, AST_TRANSPORT_MONITOR_REG_NOT_FOUND, AST_TRANSPORT_MONITOR_REG_SUCCESS, AST_VECTOR_APPEND, transport_monitor_notifier::cb, callback_data::cb, transport_monitor_notifier::data, transport_monitor::key, callback_data::matches, transport_monitor::monitors, NULL, OBJ_NOLOCK, OBJ_SEARCH_KEY, ptr_matcher(), transport_monitor::transport, transport_monitor_unregister_cb(), and transport_monitor::transport_obj_name.

Referenced by ast_sip_transport_monitor_register(), ast_sip_transport_monitor_register_key(), ast_sip_transport_monitor_register_replace(), and registration_transport_monitor_setup().

ast_sip_transport_monitor_unregister()

void ast_sip_transport_monitor_unregister	(	pjsip_transport *	transport,
		ast_transport_monitor_shutdown_cb	cb,
		void *	data,
		ast_transport_monitor_data_matcher	matches
	)

Unregister a reliable transport shutdown monitor.

Deprecated:

Replaced with ast_sip_transport_monitor_unregister_key().

Since

13.20.0

Parameters

transport	Transport to monitor for shutdown.
cb	The callback that was used for the original register.
data	Data to pass to the matcher. May be NULL and does NOT need to be an ao2 object. If NULL, all monitors with the provided callback are unregistered.
matches	Matcher function that returns true if data matches the previously registered data object. If NULL, a simple pointer comparison is done.

Note

The data object passed into the original register will have its reference count automatically decremented.

Definition at line 441 of file pjsip_transport_events.c.

{
    char key[IP6ADDR_COLON_PORT_BUFLEN];
    AST_SIP_MAKE_REMOTE_IPADDR_PORT_STR(transport, key);
    ast_sip_transport_monitor_unregister_key(key, cb, data, matches);
}

References AST_SIP_MAKE_REMOTE_IPADDR_PORT_STR, ast_sip_transport_monitor_unregister_key(), callback_data::cb, callback_data::data, IP6ADDR_COLON_PORT_BUFLEN, and callback_data::matches.

Referenced by registrar_contact_delete().

ast_sip_transport_monitor_unregister_all()

void ast_sip_transport_monitor_unregister_all	(	ast_transport_monitor_shutdown_cb	cb,
		void *	data,
		ast_transport_monitor_data_matcher	matches
	)

Unregister a transport shutdown monitor from all reliable transports.

Since

13.20.0

Parameters

cb	The callback that was used for the original register.
data	Data to pass to the matcher. May be NULL and does NOT need to be an ao2 object. If NULL, all monitors with the provided callback are unregistered.
matches	Matcher function that returns true if ao2_data matches the previously registered data object. If NULL, a simple pointer comparison is done.

Note

The data object passed into the original register will have its reference count automatically decremented.

Definition at line 421 of file pjsip_transport_events.c.

{
    struct ao2_container *transports;
    struct callback_data cb_data = {
        .cb = cb,
        .data = data,
        .matches = matches ?: ptr_matcher,
    };
 
    ast_assert(cb != NULL);
 
    transports = ao2_global_obj_ref(active_transports);
    if (!transports) {
        return;
    }
    ao2_callback(transports, OBJ_MULTIPLE | OBJ_NODATA, transport_monitor_unregister_cb, &cb_data);
    ao2_ref(transports, -1);
}

References ao2_callback, ao2_global_obj_ref, ao2_ref, ast_assert, callback_data::cb, callback_data::data, callback_data::matches, NULL, OBJ_MULTIPLE, OBJ_NODATA, ptr_matcher(), and transport_monitor_unregister_cb().

Referenced by registrar_contact_delete(), unload_module(), unload_module(), and unload_module().

ast_sip_transport_monitor_unregister_key()

void ast_sip_transport_monitor_unregister_key	(	const char *	transport_key,
		ast_transport_monitor_shutdown_cb	cb,
		void *	data,
		ast_transport_monitor_data_matcher	matches
	)

Unregister a reliable transport shutdown monitor.

Parameters

transport_key	Key for the transport to monitor for shutdown. Create the key with AST_SIP_MAKE_REMOTE_IPADDR_PORT_STR.
cb	The callback that was used for the original register.
data	Data to pass to the matcher. May be NULL and does NOT need to be an ao2 object. If NULL, all monitors with the provided callback are unregistered.
matches	Matcher function that returns true if data matches the previously registered data object. If NULL, a simple pointer comparison is done.

Note

The data object passed into the original register will have its reference count automatically decremented.

Definition at line 449 of file pjsip_transport_events.c.

{
    struct ao2_container *transports;
    struct transport_monitor *monitored;
 
    ast_assert(transport_key != NULL && cb != NULL);
 
    transports = ao2_global_obj_ref(active_transports);
    if (!transports) {
        return;
    }
 
    ao2_lock(transports);
    monitored = ao2_find(transports, transport_key, OBJ_SEARCH_KEY | OBJ_NOLOCK);
    if (monitored) {
        struct callback_data cb_data = {
            .cb = cb,
            .data = data,
            .matches = matches ?: ptr_matcher,
        };
 
        transport_monitor_unregister_cb(monitored, &cb_data, 0);
        ao2_ref(monitored, -1);
    }
    ao2_unlock(transports);
    ao2_ref(transports, -1);
}

References ao2_find, ao2_global_obj_ref, ao2_lock, ao2_ref, ao2_unlock, ast_assert, callback_data::cb, callback_data::data, callback_data::matches, NULL, OBJ_NOLOCK, OBJ_SEARCH_KEY, ptr_matcher(), and transport_monitor_unregister_cb().

Referenced by ast_sip_transport_monitor_unregister(), handle_registration_response(), and subscription_persistence_remove().

ast_sip_transport_state_register()

void ast_sip_transport_state_register

(

struct ast_sip_tpmgr_state_callback *

element

)

Register a transport state notification callback element.

Since

13.18.0

Parameters

element

What we are registering.

Definition at line 559 of file pjsip_transport_events.c.

{
    struct ast_sip_tpmgr_state_callback *tpmgr_notifier;
 
    AST_RWLIST_WRLOCK(&transport_state_list);
    AST_LIST_TRAVERSE(&transport_state_list, tpmgr_notifier, node) {
        if (element == tpmgr_notifier) {
            /* Already registered. */
            AST_RWLIST_UNLOCK(&transport_state_list);
            return;
        }
    }
    AST_LIST_INSERT_HEAD(&transport_state_list, element, node);
    AST_RWLIST_UNLOCK(&transport_state_list);
}

References AST_LIST_INSERT_HEAD, AST_LIST_TRAVERSE, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, and transport_state_list.

Referenced by ast_sip_initialize_transport_management().

ast_sip_transport_state_set_preferred_identity()

int ast_sip_transport_state_set_preferred_identity	(	const char *	transport_name,
		const char *	identity
	)

Sets the P-Preferred-Identity on a child transport.

Since

17.0.0

Parameters

transport_name	The name of the transport to be set on
identity	The P-Preferred-Identity to use on requests on this transport

Return values

0	success
-1	failure

Definition at line 242 of file config_transport.c.

{
    struct ast_sip_transport_state *transport_state;
 
    if (ast_strlen_zero(transport_name)) {
        return 0;
    }
 
    transport_state = ast_sip_get_transport_state(transport_name);
    if (!transport_state) {
        return -1;
    }
 
    if (!transport_state->flow) {
        ao2_ref(transport_state, -1);
        return 0;
    }
 
    ao2_lock(transport_state);
    ast_free(transport_state->preferred_identity);
    transport_state->preferred_identity = ast_strdup(identity);
    ao2_unlock(transport_state);
 
    ao2_ref(transport_state, -1);
 
    return 0;
}

References ao2_lock, ao2_ref, ao2_unlock, ast_free, ast_sip_get_transport_state(), ast_strdup, ast_strlen_zero(), ast_sip_transport_state::flow, and ast_sip_transport_state::preferred_identity.

Referenced by save_response_fields_to_transport().

ast_sip_transport_state_set_service_routes()

int ast_sip_transport_state_set_service_routes	(	const char *	transport_name,
		struct ast_sip_service_route_vector *	service_routes
	)

Sets the service routes on a child transport.

Since

17.0.0

Parameters

transport_name	The name of the transport to be set on
service_routes	A vector of service routes

Return values

0	success
-1	failure

Note

This assumes ownership of the service routes in both success and failure scenarios

Definition at line 270 of file config_transport.c.

{
    struct ast_sip_transport_state *transport_state;
 
    if (ast_strlen_zero(transport_name)) {
        ast_sip_service_route_vector_destroy(service_routes);
        return 0;
    }
 
    transport_state = ast_sip_get_transport_state(transport_name);
    if (!transport_state) {
        ast_sip_service_route_vector_destroy(service_routes);
        return -1;
    }
 
    if (!transport_state->flow) {
        ao2_ref(transport_state, -1);
        ast_sip_service_route_vector_destroy(service_routes);
        return 0;
    }
 
    ao2_lock(transport_state);
    ast_sip_service_route_vector_destroy(transport_state->service_routes);
    transport_state->service_routes = service_routes;
    ao2_unlock(transport_state);
 
    ao2_ref(transport_state, -1);
 
    return 0;
}

References ao2_lock, ao2_ref, ao2_unlock, ast_sip_get_transport_state(), ast_sip_service_route_vector_destroy(), ast_strlen_zero(), ast_sip_transport_state::flow, and ast_sip_transport_state::service_routes.

Referenced by save_response_fields_to_transport().

ast_sip_transport_state_set_transport()

int ast_sip_transport_state_set_transport	(	const char *	transport_name,
		pjsip_transport *	transport
	)

Sets the PJSIP transport on a child transport.

Since

17.0.0

Parameters

transport_name	The name of the transport to be updated
transport	The PJSIP transport

Return values

0	success
-1	failure

Definition at line 206 of file config_transport.c.

{
    struct ast_sip_transport_state *transport_state;
 
    /* To make it easier on callers we allow an empty transport name */
    if (ast_strlen_zero(transport_name)) {
        return 0;
    }
 
    transport_state = ast_sip_get_transport_state(transport_name);
    if (!transport_state) {
        return -1;
    }
 
    if (!transport_state->flow) {
        ao2_ref(transport_state, -1);
        return 0;
    }
 
    ao2_lock(transport_state);
    if (transport_state->transport != transport) {
        if (transport_state->transport) {
            pjsip_transport_dec_ref(transport_state->transport);
        }
        transport_state->transport = transport;
        if (transport_state->transport) {
            pjsip_transport_add_ref(transport_state->transport);
        }
    }
    ao2_unlock(transport_state);
 
    ao2_ref(transport_state, -1);
 
    return 0;
}

References ao2_lock, ao2_ref, ao2_unlock, ast_sip_get_transport_state(), ast_strlen_zero(), ast_sip_transport_state::flow, and ast_sip_transport_state::transport.

Referenced by save_response_fields_to_transport().

ast_sip_transport_state_unregister()

void ast_sip_transport_state_unregister

(

struct ast_sip_tpmgr_state_callback *

element

)

Unregister a transport state notification callback element.

Since

13.18.0

Parameters

element

What we are unregistering.

Definition at line 552 of file pjsip_transport_events.c.

{
    AST_RWLIST_WRLOCK(&transport_state_list);
    AST_LIST_REMOVE(&transport_state_list, element, node);
    AST_RWLIST_UNLOCK(&transport_state_list);
}

References AST_LIST_REMOVE, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, and transport_state_list.

Referenced by ast_sip_destroy_transport_management().

ast_sip_unregister_authenticator()

void ast_sip_unregister_authenticator

(

struct ast_sip_authenticator *

auth

)

Unregister a SIP authenticator.

When there is no authenticator registered, requests cannot be challenged or authenticated.

Parameters

auth	The authenticator to unregister

Definition at line 152 of file res_pjsip.c.

{
    if (registered_authenticator != auth) {
        ast_log(LOG_WARNING, "Trying to unregister authenticator %p but authenticator %p registered\n",
                auth, registered_authenticator);
        return;
    }
    registered_authenticator = NULL;
    ast_debug(1, "Unregistered SIP authenticator %p\n", auth);
}

References ast_debug, ast_log, LOG_WARNING, NULL, and registered_authenticator.

Referenced by unload_module().

ast_sip_unregister_endpoint_formatter()

void ast_sip_unregister_endpoint_formatter

(

struct ast_sip_endpoint_formatter *

obj

)

Unregister an endpoint formatter.

Parameters

obj	the formatter to unregister

Definition at line 487 of file res_pjsip.c.

{
    struct ast_sip_endpoint_formatter *i;
    SCOPED_LOCK(lock, &endpoint_formatters, AST_RWLIST_WRLOCK, AST_RWLIST_UNLOCK);
 
    AST_RWLIST_TRAVERSE_SAFE_BEGIN(&endpoint_formatters, i, next) {
        if (i == obj) {
            AST_RWLIST_REMOVE_CURRENT(next);
            break;
        }
    }
    AST_RWLIST_TRAVERSE_SAFE_END;
}

References AST_RWLIST_REMOVE_CURRENT, AST_RWLIST_TRAVERSE_SAFE_BEGIN, AST_RWLIST_TRAVERSE_SAFE_END, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, lock, ast_sip_endpoint_formatter::next, and SCOPED_LOCK.

Referenced by ast_res_pjsip_cleanup_options_handling(), ast_sip_destroy_sorcery_auth(), ast_sip_destroy_sorcery_location(), ast_sip_destroy_sorcery_transport(), and unload_module().

ast_sip_unregister_endpoint_identifier()

void ast_sip_unregister_endpoint_identifier

(

struct ast_sip_endpoint_identifier *

identifier

)

Unregister a SIP endpoint identifier.

This stops an endpoint identifier from being used.

Parameters

identifier

The SIP endoint identifier to unregister

Definition at line 315 of file res_pjsip.c.

{
    struct endpoint_identifier_list *iter;
    SCOPED_LOCK(lock, &endpoint_identifiers, AST_RWLIST_WRLOCK, AST_RWLIST_UNLOCK);
    AST_RWLIST_TRAVERSE_SAFE_BEGIN(&endpoint_identifiers, iter, list) {
        if (iter->identifier == identifier) {
            AST_RWLIST_REMOVE_CURRENT(list);
            ast_free(iter);
            ast_debug(1, "Unregistered endpoint identifier %p\n", identifier);
            break;
        }
    }
    AST_RWLIST_TRAVERSE_SAFE_END;
}

References ast_debug, ast_free, AST_RWLIST_REMOVE_CURRENT, AST_RWLIST_TRAVERSE_SAFE_BEGIN, AST_RWLIST_TRAVERSE_SAFE_END, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, endpoint_identifier_list::identifier, endpoint_identifier_list::list, lock, and SCOPED_LOCK.

Referenced by unload_module(), unload_module(), unload_module(), and unload_module().

ast_sip_unregister_outbound_authenticator()

void ast_sip_unregister_outbound_authenticator

(

struct ast_sip_outbound_authenticator *

auth

)

Unregister an outbound SIP authenticator.

When there is no outbound authenticator registered, authentication challenges will be handled as any other final response would be.

Parameters

auth	The authenticator to unregister

Definition at line 203 of file res_pjsip.c.

{
    if (registered_outbound_authenticator != auth) {
        ast_log(LOG_WARNING, "Trying to unregister outbound authenticator %p but outbound authenticator %p registered\n",
                auth, registered_outbound_authenticator);
        return;
    }
    registered_outbound_authenticator = NULL;
    ast_debug(1, "Unregistered SIP outbound authenticator %p\n", auth);
}

References ast_debug, ast_log, LOG_WARNING, NULL, and registered_outbound_authenticator.

Referenced by unload_module().

ast_sip_unregister_service()

void ast_sip_unregister_service

(

pjsip_module *

module

)

This is the opposite of ast_sip_register_service(). Unregistering a service means that PJSIP will no longer call into the module any more. This will likely occur when an Asterisk module is unloaded.

Parameters

module

The PJSIP module to unregister

Definition at line 133 of file res_pjsip.c.

{
    ast_sip_push_task_wait_servant(NULL, unregister_service, &module);
}

References ast_sip_push_task_wait_servant(), NULL, and unregister_service().

Referenced by ast_res_pjsip_cleanup_message_filter(), ast_sip_destroy_distributor(), ast_sip_destroy_global_headers(), ast_sip_destroy_transport_management(), load_module(), load_module(), load_module(), load_module(), load_module(), unload_module(), unload_module(), unload_module(), unload_module(), unload_module(), unload_module(), unload_module(), unload_module(), unload_module(), unload_module(), unload_module(), unload_module(), unload_module(), and unload_pjsip().

ast_sip_unregister_supplement()

void ast_sip_unregister_supplement

(

struct ast_sip_supplement *

supplement

)

Unregister a an supplement to SIP out of dialog processing.

Parameters

supplement

The supplement to unregister

Definition at line 1476 of file res_pjsip.c.

{
    struct ast_sip_supplement *iter;
    SCOPED_LOCK(lock, &supplements, AST_RWLIST_WRLOCK, AST_RWLIST_UNLOCK);
 
    AST_RWLIST_TRAVERSE_SAFE_BEGIN(&supplements, iter, next) {
        if (supplement == iter) {
            AST_RWLIST_REMOVE_CURRENT(next);
            break;
        }
    }
    AST_RWLIST_TRAVERSE_SAFE_END;
}

References AST_RWLIST_REMOVE_CURRENT, AST_RWLIST_TRAVERSE_SAFE_BEGIN, AST_RWLIST_TRAVERSE_SAFE_END, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, lock, ast_sip_supplement::next, and SCOPED_LOCK.

Referenced by ast_res_pjsip_cleanup_message_filter(), unload_module(), and unload_module().

ast_sip_update_from()

int ast_sip_update_from	(	pjsip_tx_data *	tdata,
		char *	from
	)

Overwrite fields in the outbound 'From' header.

The outbound 'From' header is created/added in ast_sip_create_request with default data. If available that data may be info specified in the 'from_user' and 'from_domain' options found on the endpoint. That information will be overwritten with data in the given 'from' parameter.

Parameters

tdata	the outbound message data structure
from	info to copy into the header. Can be either a SIP URI, or in the format user[@domain]

Return values

0	success, -1: failure

Definition at line 3383 of file res_pjsip.c.

{
    pjsip_name_addr *name_addr;
    pjsip_sip_uri *uri;
    pjsip_name_addr *parsed_name_addr;
    pjsip_from_hdr *from_hdr;
 
    if (ast_strlen_zero(from)) {
        return 0;
    }
 
    from_hdr = PJSIP_MSG_FROM_HDR(tdata->msg);
    if (!from_hdr) {
        return -1;
    }
    name_addr = (pjsip_name_addr *) from_hdr->uri;
    uri = pjsip_uri_get_uri(name_addr);
 
    parsed_name_addr = (pjsip_name_addr *) pjsip_parse_uri(tdata->pool, from,
        strlen(from), PJSIP_PARSE_URI_AS_NAMEADDR);
    if (parsed_name_addr) {
        pjsip_sip_uri *parsed_uri;
 
        if (!PJSIP_URI_SCHEME_IS_SIP(parsed_name_addr->uri)
                && !PJSIP_URI_SCHEME_IS_SIPS(parsed_name_addr->uri)) {
            ast_log(LOG_WARNING, "From address '%s' is not a valid SIP/SIPS URI\n", from);
            return -1;
        }
 
        parsed_uri = pjsip_uri_get_uri(parsed_name_addr->uri);
 
        if (pj_strlen(&parsed_name_addr->display)) {
            pj_strdup(tdata->pool, &name_addr->display, &parsed_name_addr->display);
        }
 
        /* Unlike the To header, we only want to replace the user, host and port */
        pj_strdup(tdata->pool, &uri->user, &parsed_uri->user);
        pj_strdup(tdata->pool, &uri->host, &parsed_uri->host);
        uri->port = parsed_uri->port;
 
        return 0;
    } else {
        /* assume it is 'user[@domain]' format */
        char *domain = strchr(from, '@');
 
        if (domain) {
            pj_str_t pj_from;
 
            pj_strset3(&pj_from, from, domain);
            pj_strdup(tdata->pool, &uri->user, &pj_from);
 
            pj_strdup2(tdata->pool, &uri->host, domain + 1);
        } else {
            pj_strdup2(tdata->pool, &uri->user, from);
        }
 
        return 0;
    }
 
    return -1;
}

References ast_log, ast_strlen_zero(), and LOG_WARNING.

Referenced by msg_send(), and refer_send().

ast_sip_update_to_uri()

int ast_sip_update_to_uri	(	pjsip_tx_data *	tdata,
		const char *	to
	)

Replace the To URI in the tdata with the supplied one.

Parameters

tdata	the outbound message data structure
to	URI to replace the To URI with. Must be a valid SIP URI.

Return values

0	success, -1: failure

Definition at line 3323 of file res_pjsip.c.

{
    pjsip_name_addr *parsed_name_addr;
    pjsip_sip_uri *sip_uri;
    pjsip_name_addr *tdata_name_addr;
    pjsip_sip_uri *tdata_sip_uri;
    pjsip_to_hdr *to_hdr;
    char *buf = NULL;
#define DEBUG_BUF_SIZE 256
 
    parsed_name_addr = (pjsip_name_addr *) pjsip_parse_uri(tdata->pool, (char*)to, strlen(to),
        PJSIP_PARSE_URI_AS_NAMEADDR);
 
    if (!parsed_name_addr || (!PJSIP_URI_SCHEME_IS_SIP(parsed_name_addr->uri)
            && !PJSIP_URI_SCHEME_IS_SIPS(parsed_name_addr->uri))) {
        ast_log(LOG_WARNING, "To address '%s' is not a valid SIP/SIPS URI\n", to);
        return -1;
    }
 
    sip_uri = pjsip_uri_get_uri(parsed_name_addr->uri);
    if (DEBUG_ATLEAST(3)) {
        buf = ast_alloca(DEBUG_BUF_SIZE);
        pjsip_uri_print(PJSIP_URI_IN_FROMTO_HDR, sip_uri, buf, DEBUG_BUF_SIZE);
        ast_debug(3, "Parsed To: %.*s  %s\n", (int)parsed_name_addr->display.slen,
            parsed_name_addr->display.ptr, buf);
    }
 
    to_hdr = PJSIP_MSG_TO_HDR(tdata->msg);
    tdata_name_addr = to_hdr ? (pjsip_name_addr *) to_hdr->uri : NULL;
    if (!tdata_name_addr || (!PJSIP_URI_SCHEME_IS_SIP(tdata_name_addr->uri)
            && !PJSIP_URI_SCHEME_IS_SIPS(tdata_name_addr->uri))) {
        /* Highly unlikely but we have to check */
        ast_log(LOG_WARNING, "tdata To address '%s' is not a valid SIP/SIPS URI\n", to);
        return -1;
    }
 
    tdata_sip_uri = pjsip_uri_get_uri(tdata_name_addr->uri);
    if (DEBUG_ATLEAST(3)) {
        buf[0] = '\0';
        pjsip_uri_print(PJSIP_URI_IN_FROMTO_HDR, tdata_sip_uri, buf, DEBUG_BUF_SIZE);
        ast_debug(3, "Original tdata To: %.*s  %s\n", (int)tdata_name_addr->display.slen,
            tdata_name_addr->display.ptr, buf);
    }
 
    /* Replace the uri */
    pjsip_sip_uri_assign(tdata->pool, tdata_sip_uri, sip_uri);
    /* The display name isn't part of the URI so we need to replace it separately */
    pj_strdup(tdata->pool, &tdata_name_addr->display, &parsed_name_addr->display);
 
    if (DEBUG_ATLEAST(3)) {
        buf[0] = '\0';
        pjsip_uri_print(PJSIP_URI_IN_FROMTO_HDR, tdata_sip_uri, buf, 256);
        ast_debug(3, "New tdata To: %.*s  %s\n", (int)tdata_name_addr->display.slen,
            tdata_name_addr->display.ptr, buf);
    }
 
    return 0;
#undef DEBUG_BUF_SIZE
}

References ast_alloca, ast_debug, ast_log, buf, DEBUG_ATLEAST, DEBUG_BUF_SIZE, LOG_WARNING, and NULL.

Referenced by msg_send(), and refer_send().

Variable Documentation

AST_PJ_STR_EMPTY

const pj_str_t AST_PJ_STR_EMPTY = { "", 0 }

static

Definition at line 112 of file res_pjsip.h.

{ "", 0 };

Referenced by ast_sip_pjsip_uri_get_hostname(), and ast_sip_pjsip_uri_get_username().

pjsip_media_type_application_cpim_xpidf_xml

pjsip_media_type pjsip_media_type_application_cpim_xpidf_xml

extern

Definition at line 3913 of file res_pjsip.c.

Referenced by load_module().

pjsip_media_type_application_json

pjsip_media_type pjsip_media_type_application_json

extern

Common media types used throughout res_pjsip and pjproject

Definition at line 3909 of file res_pjsip.c.

Referenced by load_module().

pjsip_media_type_application_media_control_xml

pjsip_media_type pjsip_media_type_application_media_control_xml

extern

Definition at line 3910 of file res_pjsip.c.

Referenced by load_module(), and video_info_incoming_request().

pjsip_media_type_application_pidf_xml

pjsip_media_type pjsip_media_type_application_pidf_xml

extern

Definition at line 3911 of file res_pjsip.c.

Referenced by add_eprofile_to_tdata(), find_pidf(), and load_module().

pjsip_media_type_application_rlmi_xml

pjsip_media_type pjsip_media_type_application_rlmi_xml

extern

Definition at line 3914 of file res_pjsip.c.

Referenced by load_module().

pjsip_media_type_application_sdp

pjsip_media_type pjsip_media_type_application_sdp

extern

Definition at line 3916 of file res_pjsip.c.

Referenced by filter_on_tx_message(), load_module(), and session_outgoing_nat_hook().

pjsip_media_type_application_simple_message_summary

pjsip_media_type pjsip_media_type_application_simple_message_summary

extern

Definition at line 3915 of file res_pjsip.c.

Referenced by load_module().

pjsip_media_type_application_xpidf_xml

pjsip_media_type pjsip_media_type_application_xpidf_xml

extern

Definition at line 3912 of file res_pjsip.c.

Referenced by load_module().

pjsip_media_type_multipart_alternative

pjsip_media_type pjsip_media_type_multipart_alternative

extern

Definition at line 3917 of file res_pjsip.c.

Referenced by check_content_disposition(), and load_module().

pjsip_media_type_multipart_mixed

pjsip_media_type pjsip_media_type_multipart_mixed

extern

Definition at line 3918 of file res_pjsip.c.

Referenced by add_eprofile_to_tdata(), aoc_invite_outgoing_response(), check_content_disposition(), find_pidf(), and load_module().

pjsip_media_type_multipart_related

pjsip_media_type pjsip_media_type_multipart_related

extern

Definition at line 3919 of file res_pjsip.c.

Referenced by load_module().

pjsip_media_type_text_plain

pjsip_media_type pjsip_media_type_text_plain

extern

Definition at line 3920 of file res_pjsip.c.

Referenced by load_module().