res_pjsip: Add an 'auto' option for DTMF Mode
[asterisk/asterisk.git] / include / asterisk / res_pjsip.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2013, Digium, Inc.
5  *
6  * Mark Michelson <mmichelson@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 #ifndef _RES_PJSIP_H
20 #define _RES_PJSIP_H
21
22 #include "asterisk/stringfields.h"
23 /* Needed for struct ast_sockaddr */
24 #include "asterisk/netsock2.h"
25 /* Needed for linked list macros */
26 #include "asterisk/linkedlists.h"
27 /* Needed for ast_party_id */
28 #include "asterisk/channel.h"
29 /* Needed for ast_sorcery */
30 #include "asterisk/sorcery.h"
31 /* Needed for ast_dnsmgr */
32 #include "asterisk/dnsmgr.h"
33 /* Needed for ast_endpoint */
34 #include "asterisk/endpoints.h"
35 /* Needed for ast_t38_ec_modes */
36 #include "asterisk/udptl.h"
37 /* Needed for pj_sockaddr */
38 #include <pjlib.h>
39 /* Needed for ast_rtp_dtls_cfg struct */
40 #include "asterisk/rtp_engine.h"
41 /* Needed for AST_VECTOR macro */
42 #include "asterisk/vector.h"
43 /* Needed for ast_sip_for_each_channel_snapshot struct */
44 #include "asterisk/stasis_channels.h"
45 #include "asterisk/stasis_endpoints.h"
46
47 /* Forward declarations of PJSIP stuff */
48 struct pjsip_rx_data;
49 struct pjsip_module;
50 struct pjsip_tx_data;
51 struct pjsip_dialog;
52 struct pjsip_transport;
53 struct pjsip_tpfactory;
54 struct pjsip_tls_setting;
55 struct pjsip_tpselector;
56
57 /*!
58  * \brief Structure for SIP transport information
59  */
60 struct ast_sip_transport_state {
61         /*! \brief Transport itself */
62         struct pjsip_transport *transport;
63
64         /*! \brief Transport factory */
65         struct pjsip_tpfactory *factory;
66 };
67
68 #define SIP_SORCERY_DOMAIN_ALIAS_TYPE "domain_alias"
69
70 /*!
71  * Details about a SIP domain alias
72  */
73 struct ast_sip_domain_alias {
74         /*! Sorcery object details */
75         SORCERY_OBJECT(details);
76         AST_DECLARE_STRING_FIELDS(
77                 /*! Domain to be aliased to */
78                 AST_STRING_FIELD(domain);
79         );
80 };
81
82 /*! \brief Maximum number of ciphers supported for a TLS transport */
83 #define SIP_TLS_MAX_CIPHERS 64
84
85 /*
86  * \brief Transport to bind to
87  */
88 struct ast_sip_transport {
89         /*! Sorcery object details */
90         SORCERY_OBJECT(details);
91         AST_DECLARE_STRING_FIELDS(
92                 /*! Certificate of authority list file */
93                 AST_STRING_FIELD(ca_list_file);
94                 /*! Certificate of authority list path */
95                 AST_STRING_FIELD(ca_list_path);
96                 /*! Public certificate file */
97                 AST_STRING_FIELD(cert_file);
98                 /*! Optional private key of the certificate file */
99                 AST_STRING_FIELD(privkey_file);
100                 /*! Password to open the private key */
101                 AST_STRING_FIELD(password);
102                 /*! External signaling address */
103                 AST_STRING_FIELD(external_signaling_address);
104                 /*! External media address */
105                 AST_STRING_FIELD(external_media_address);
106                 /*! Optional domain to use for messages if provided could not be found */
107                 AST_STRING_FIELD(domain);
108                 );
109         /*! Type of transport */
110         enum ast_transport type;
111         /*! Address and port to bind to */
112         pj_sockaddr host;
113         /*! Number of simultaneous asynchronous operations */
114         unsigned int async_operations;
115         /*! Optional external port for signaling */
116         unsigned int external_signaling_port;
117         /*! TLS settings */
118         pjsip_tls_setting tls;
119         /*! Configured TLS ciphers */
120         pj_ssl_cipher ciphers[SIP_TLS_MAX_CIPHERS];
121         /*! Optional local network information, used for NAT purposes */
122         struct ast_ha *localnet;
123         /*! DNS manager for refreshing the external address */
124         struct ast_dnsmgr_entry *external_address_refresher;
125         /*! Optional external address information */
126         struct ast_sockaddr external_address;
127         /*! Transport state information */
128         struct ast_sip_transport_state *state;
129         /*! QOS DSCP TOS bits */
130         unsigned int tos;
131         /*! QOS COS value */
132         unsigned int cos;
133         /*! Write timeout */
134         int write_timeout;
135 };
136
137 /*!
138  * \brief Structure for SIP nat hook information
139  */
140 struct ast_sip_nat_hook {
141         /*! Sorcery object details */
142         SORCERY_OBJECT(details);
143         /*! Callback for when a message is going outside of our local network */
144         void (*outgoing_external_message)(struct pjsip_tx_data *tdata, struct ast_sip_transport *transport);
145 };
146
147 /*!
148  * \brief Contact associated with an address of record
149  */
150 struct ast_sip_contact {
151         /*! Sorcery object details, the id is the aor name plus a random string */
152         SORCERY_OBJECT(details);
153         AST_DECLARE_STRING_FIELDS(
154                 /*! Full URI of the contact */
155                 AST_STRING_FIELD(uri);
156                 /*! Outbound proxy to use for qualify */
157                 AST_STRING_FIELD(outbound_proxy);
158                 /*! Path information to place in Route headers */
159                 AST_STRING_FIELD(path);
160                 /*! Content of the User-Agent header in REGISTER request */
161                 AST_STRING_FIELD(user_agent);
162         );
163         /*! Absolute time that this contact is no longer valid after */
164         struct timeval expiration_time;
165         /*! Frequency to send OPTIONS requests to contact. 0 is disabled. */
166         unsigned int qualify_frequency;
167         /*! If true authenticate the qualify if needed */
168         int authenticate_qualify;
169 };
170
171 #define CONTACT_STATUS "contact_status"
172
173 /*!
174  * \brief Status type for a contact.
175  */
176 enum ast_sip_contact_status_type {
177         UNAVAILABLE,
178         AVAILABLE
179 };
180
181 /*!
182  * \brief A contact's status.
183  *
184  * \detail Maintains a contact's current status and round trip time
185  *         if available.
186  */
187 struct ast_sip_contact_status {
188         SORCERY_OBJECT(details);
189         /*! Current status for a contact (default - unavailable) */
190         enum ast_sip_contact_status_type status;
191         /*! The round trip start time set before sending a qualify request */
192         struct timeval rtt_start;
193         /*! The round trip time in microseconds */
194         int64_t rtt;
195 };
196
197 /*!
198  * \brief A SIP address of record
199  */
200 struct ast_sip_aor {
201         /*! Sorcery object details, the id is the AOR name */
202         SORCERY_OBJECT(details);
203         AST_DECLARE_STRING_FIELDS(
204                 /*! Voicemail boxes for this AOR */
205                 AST_STRING_FIELD(mailboxes);
206                 /*! Outbound proxy for OPTIONS requests */
207                 AST_STRING_FIELD(outbound_proxy);
208         );
209         /*! Minimum expiration time */
210         unsigned int minimum_expiration;
211         /*! Maximum expiration time */
212         unsigned int maximum_expiration;
213         /*! Default contact expiration if one is not provided in the contact */
214         unsigned int default_expiration;
215         /*! Frequency to send OPTIONS requests to AOR contacts. 0 is disabled. */
216         unsigned int qualify_frequency;
217         /*! If true authenticate the qualify if needed */
218         int authenticate_qualify;
219         /*! Maximum number of external contacts, 0 to disable */
220         unsigned int max_contacts;
221         /*! Whether to remove any existing contacts not related to an incoming REGISTER when it comes in */
222         unsigned int remove_existing;
223         /*! Any permanent configured contacts */
224         struct ao2_container *permanent_contacts;
225         /*! Determines whether SIP Path headers are supported */
226         unsigned int support_path;
227 };
228
229 /*!
230  * \brief A wrapper for contact that adds the aor_id and
231  * a consistent contact id.  Used by ast_sip_for_each_contact.
232  */
233 struct ast_sip_contact_wrapper {
234         /*! The id of the parent aor. */
235         char *aor_id;
236         /*! The id of contact in form of aor_id/contact_uri. */
237         char *contact_id;
238         /*! Pointer to the actual contact. */
239         struct ast_sip_contact *contact;
240 };
241
242 /*!
243  * \brief DTMF modes for SIP endpoints
244  */
245 enum ast_sip_dtmf_mode {
246         /*! No DTMF to be used */
247         AST_SIP_DTMF_NONE,
248         /* XXX Should this be 2833 instead? */
249         /*! Use RFC 4733 events for DTMF */
250         AST_SIP_DTMF_RFC_4733,
251         /*! Use DTMF in the audio stream */
252         AST_SIP_DTMF_INBAND,
253         /*! Use SIP INFO DTMF (blech) */
254         AST_SIP_DTMF_INFO,
255         /*! Use SIP 4733 if supported by the other side or INBAND if not */
256         AST_SIP_DTMF_AUTO,
257 };
258
259 /*!
260  * \brief Methods of storing SIP digest authentication credentials.
261  *
262  * Note that both methods result in MD5 digest authentication being
263  * used. The two methods simply alter how Asterisk determines the
264  * credentials for a SIP authentication
265  */
266 enum ast_sip_auth_type {
267         /*! Credentials stored as a username and password combination */
268         AST_SIP_AUTH_TYPE_USER_PASS,
269         /*! Credentials stored as an MD5 sum */
270         AST_SIP_AUTH_TYPE_MD5,
271         /*! Credentials not stored this is a fake auth */
272         AST_SIP_AUTH_TYPE_ARTIFICIAL
273 };
274
275 #define SIP_SORCERY_AUTH_TYPE "auth"
276
277 struct ast_sip_auth {
278         /* Sorcery ID of the auth is its name */
279         SORCERY_OBJECT(details);
280         AST_DECLARE_STRING_FIELDS(
281                 /* Identification for these credentials */
282                 AST_STRING_FIELD(realm);
283                 /* Authentication username */
284                 AST_STRING_FIELD(auth_user);
285                 /* Authentication password */
286                 AST_STRING_FIELD(auth_pass);
287                 /* Authentication credentials in MD5 format (hash of user:realm:pass) */
288                 AST_STRING_FIELD(md5_creds);
289         );
290         /* The time period (in seconds) that a nonce may be reused */
291         unsigned int nonce_lifetime;
292         /* Used to determine what to use when authenticating */
293         enum ast_sip_auth_type type;
294 };
295
296 AST_VECTOR(ast_sip_auth_vector, const char *);
297
298 /*!
299  * \brief Different methods by which incoming requests can be matched to endpoints
300  */
301 enum ast_sip_endpoint_identifier_type {
302         /*! Identify based on user name in From header */
303         AST_SIP_ENDPOINT_IDENTIFY_BY_USERNAME = (1 << 0),
304 };
305
306 enum ast_sip_session_refresh_method {
307         /*! Use reinvite to negotiate direct media */
308         AST_SIP_SESSION_REFRESH_METHOD_INVITE,
309         /*! Use UPDATE to negotiate direct media */
310         AST_SIP_SESSION_REFRESH_METHOD_UPDATE,
311 };
312
313 enum ast_sip_direct_media_glare_mitigation {
314         /*! Take no special action to mitigate reinvite glare */
315         AST_SIP_DIRECT_MEDIA_GLARE_MITIGATION_NONE,
316         /*! Do not send an initial direct media session refresh on outgoing call legs
317          * Subsequent session refreshes will be sent no matter the session direction
318          */
319         AST_SIP_DIRECT_MEDIA_GLARE_MITIGATION_OUTGOING,
320         /*! Do not send an initial direct media session refresh on incoming call legs
321          * Subsequent session refreshes will be sent no matter the session direction
322          */
323         AST_SIP_DIRECT_MEDIA_GLARE_MITIGATION_INCOMING,
324 };
325
326 enum ast_sip_session_media_encryption {
327         /*! Invalid media encryption configuration */
328         AST_SIP_MEDIA_TRANSPORT_INVALID = 0,
329         /*! Do not allow any encryption of session media */
330         AST_SIP_MEDIA_ENCRYPT_NONE,
331         /*! Offer SDES-encrypted session media */
332         AST_SIP_MEDIA_ENCRYPT_SDES,
333         /*! Offer encrypted session media with datagram TLS key exchange */
334         AST_SIP_MEDIA_ENCRYPT_DTLS,
335 };
336
337 enum ast_sip_session_redirect {
338         /*! User portion of the target URI should be used as the target in the dialplan */
339         AST_SIP_REDIRECT_USER = 0,
340         /*! Target URI should be used as the target in the dialplan */
341         AST_SIP_REDIRECT_URI_CORE,
342         /*! Target URI should be used as the target within chan_pjsip itself */
343         AST_SIP_REDIRECT_URI_PJSIP,
344 };
345
346 /*!
347  * \brief Session timers options
348  */
349 struct ast_sip_timer_options {
350         /*! Minimum session expiration period, in seconds */
351         unsigned int min_se;
352         /*! Session expiration period, in seconds */
353         unsigned int sess_expires;
354 };
355
356 /*!
357  * \brief Endpoint configuration for SIP extensions.
358  *
359  * SIP extensions, in this case refers to features
360  * indicated in Supported or Required headers.
361  */
362 struct ast_sip_endpoint_extensions {
363         /*! Enabled SIP extensions */
364         unsigned int flags;
365         /*! Timer options */
366         struct ast_sip_timer_options timer;
367 };
368
369 /*!
370  * \brief Endpoint configuration for unsolicited MWI
371  */
372 struct ast_sip_mwi_configuration {
373         AST_DECLARE_STRING_FIELDS(
374                 /*! Configured voicemail boxes for this endpoint. Used for MWI */
375                 AST_STRING_FIELD(mailboxes);
376                 /*! Username to use when sending MWI NOTIFYs to this endpoint */
377                 AST_STRING_FIELD(fromuser);
378         );
379         /* Should mailbox states be combined into a single notification? */
380         unsigned int aggregate;
381 };
382
383 /*!
384  * \brief Endpoint subscription configuration
385  */
386 struct ast_sip_endpoint_subscription_configuration {
387         /*! Indicates if endpoint is allowed to initiate subscriptions */
388         unsigned int allow;
389         /*! The minimum allowed expiration for subscriptions from endpoint */
390         unsigned int minexpiry;
391         /*! Message waiting configuration */
392         struct ast_sip_mwi_configuration mwi;
393 };
394
395 /*!
396  * \brief NAT configuration options for endpoints
397  */
398 struct ast_sip_endpoint_nat_configuration {
399         /*! Whether to force using the source IP address/port for sending responses */
400         unsigned int force_rport;
401         /*! Whether to rewrite the Contact header with the source IP address/port or not */
402         unsigned int rewrite_contact;
403 };
404
405 /*!
406  * \brief Party identification options for endpoints
407  *
408  * This includes caller ID, connected line, and redirecting-related options
409  */
410 struct ast_sip_endpoint_id_configuration {
411         struct ast_party_id self;
412         /*! Do we accept identification information from this endpoint */
413         unsigned int trust_inbound;
414         /*! Do we send private identification information to this endpoint? */
415         unsigned int trust_outbound;
416         /*! Do we send P-Asserted-Identity headers to this endpoint? */
417         unsigned int send_pai;
418         /*! Do we send Remote-Party-ID headers to this endpoint? */
419         unsigned int send_rpid;
420         /*! Do we send messages for connected line updates for unanswered incoming calls immediately to this endpoint? */
421         unsigned int rpid_immediate;
422         /*! Do we add Diversion headers to applicable outgoing requests/responses? */
423         unsigned int send_diversion;
424         /*! When performing connected line update, which method should be used */
425         enum ast_sip_session_refresh_method refresh_method;
426 };
427
428 /*!
429  * \brief Call pickup configuration options for endpoints
430  */
431 struct ast_sip_endpoint_pickup_configuration {
432         /*! Call group */
433         ast_group_t callgroup;
434         /*! Pickup group */
435         ast_group_t pickupgroup;
436         /*! Named call group */
437         struct ast_namedgroups *named_callgroups;
438         /*! Named pickup group */
439         struct ast_namedgroups *named_pickupgroups;
440 };
441
442 /*!
443  * \brief Configuration for one-touch INFO recording
444  */
445 struct ast_sip_info_recording_configuration {
446         AST_DECLARE_STRING_FIELDS(
447                 /*! Feature to enact when one-touch recording INFO with Record: On is received */
448                 AST_STRING_FIELD(onfeature);
449                 /*! Feature to enact when one-touch recording INFO with Record: Off is received */
450                 AST_STRING_FIELD(offfeature);
451         );
452         /*! Is one-touch recording permitted? */
453         unsigned int enabled;
454 };
455
456 /*!
457  * \brief Endpoint configuration options for INFO packages
458  */
459 struct ast_sip_endpoint_info_configuration {
460         /*! Configuration for one-touch recording */
461         struct ast_sip_info_recording_configuration recording;
462 };
463
464 /*!
465  * \brief RTP configuration for SIP endpoints
466  */
467 struct ast_sip_media_rtp_configuration {
468         AST_DECLARE_STRING_FIELDS(
469                 /*! Configured RTP engine for this endpoint. */
470                 AST_STRING_FIELD(engine);
471         );
472         /*! Whether IPv6 RTP is enabled or not */
473         unsigned int ipv6;
474         /*! Whether symmetric RTP is enabled or not */
475         unsigned int symmetric;
476         /*! Whether ICE support is enabled or not */
477         unsigned int ice_support;
478         /*! Whether to use the "ptime" attribute received from the endpoint or not */
479         unsigned int use_ptime;
480         /*! Do we use AVPF exclusively for this endpoint? */
481         unsigned int use_avpf;
482         /*! Do we force AVP, AVPF, SAVP, or SAVPF even for DTLS media streams? */
483         unsigned int force_avp;
484         /*! Do we use the received media transport in our answer SDP */
485         unsigned int use_received_transport;
486         /*! \brief DTLS-SRTP configuration information */
487         struct ast_rtp_dtls_cfg dtls_cfg;
488         /*! Should SRTP use a 32 byte tag instead of an 80 byte tag? */
489         unsigned int srtp_tag_32;
490         /*! Do we use media encryption? what type? */
491         enum ast_sip_session_media_encryption encryption;
492         /*! Do we want to optimistically support encryption if possible? */
493         unsigned int encryption_optimistic;
494 };
495
496 /*!
497  * \brief Direct media options for SIP endpoints
498  */
499 struct ast_sip_direct_media_configuration {
500         /*! Boolean indicating if direct_media is permissible */
501         unsigned int enabled;
502         /*! When using direct media, which method should be used */
503         enum ast_sip_session_refresh_method method;
504         /*! Take steps to mitigate glare for direct media */
505         enum ast_sip_direct_media_glare_mitigation glare_mitigation;
506         /*! Do not attempt direct media session refreshes if a media NAT is detected */
507         unsigned int disable_on_nat;
508 };
509
510 struct ast_sip_t38_configuration {
511         /*! Whether T.38 UDPTL support is enabled or not */
512         unsigned int enabled;
513         /*! Error correction setting for T.38 UDPTL */
514         enum ast_t38_ec_modes error_correction;
515         /*! Explicit T.38 max datagram value, may be 0 to indicate the remote side can be trusted */
516         unsigned int maxdatagram;
517         /*! Whether NAT Support is enabled for T.38 UDPTL sessions or not */
518         unsigned int nat;
519         /*! Whether to use IPv6 for UDPTL or not */
520         unsigned int ipv6;
521 };
522
523 /*!
524  * \brief Media configuration for SIP endpoints
525  */
526 struct ast_sip_endpoint_media_configuration {
527         AST_DECLARE_STRING_FIELDS(
528                 /*! Optional media address to use in SDP */
529                 AST_STRING_FIELD(address);
530                 /*! SDP origin username */
531                 AST_STRING_FIELD(sdpowner);
532                 /*! SDP session name */
533                 AST_STRING_FIELD(sdpsession);
534         );
535         /*! RTP media configuration */
536         struct ast_sip_media_rtp_configuration rtp;
537         /*! Direct media options */
538         struct ast_sip_direct_media_configuration direct_media;
539         /*! T.38 (FoIP) options */
540         struct ast_sip_t38_configuration t38;
541         /*! Configured codecs */
542         struct ast_format_cap *codecs;
543         /*! DSCP TOS bits for audio streams */
544         unsigned int tos_audio;
545         /*! Priority for audio streams */
546         unsigned int cos_audio;
547         /*! DSCP TOS bits for video streams */
548         unsigned int tos_video;
549         /*! Priority for video streams */
550         unsigned int cos_video;
551 };
552
553 /*!
554  * \brief An entity with which Asterisk communicates
555  */
556 struct ast_sip_endpoint {
557         SORCERY_OBJECT(details);
558         AST_DECLARE_STRING_FIELDS(
559                 /*! Context to send incoming calls to */
560                 AST_STRING_FIELD(context);
561                 /*! Name of an explicit transport to use */
562                 AST_STRING_FIELD(transport);
563                 /*! Outbound proxy to use */
564                 AST_STRING_FIELD(outbound_proxy);
565                 /*! Explicit AORs to dial if none are specified */
566                 AST_STRING_FIELD(aors);
567                 /*! Musiconhold class to suggest that the other side use when placing on hold */
568                 AST_STRING_FIELD(mohsuggest);
569                 /*! Configured tone zone for this endpoint. */
570                 AST_STRING_FIELD(zone);
571                 /*! Configured language for this endpoint. */
572                 AST_STRING_FIELD(language);
573                 /*! Default username to place in From header */
574                 AST_STRING_FIELD(fromuser);
575                 /*! Domain to place in From header */
576                 AST_STRING_FIELD(fromdomain);
577                 /*! Context to route incoming MESSAGE requests to */
578                 AST_STRING_FIELD(message_context);
579                 /*! Accountcode to auto-set on channels */
580                 AST_STRING_FIELD(accountcode);
581         );
582         /*! Configuration for extensions */
583         struct ast_sip_endpoint_extensions extensions;
584         /*! Configuration relating to media */
585         struct ast_sip_endpoint_media_configuration media;
586         /*! SUBSCRIBE/NOTIFY configuration options */
587         struct ast_sip_endpoint_subscription_configuration subscription;
588         /*! NAT configuration */
589         struct ast_sip_endpoint_nat_configuration nat;
590         /*! Party identification options */
591         struct ast_sip_endpoint_id_configuration id;
592         /*! Configuration options for INFO packages */
593         struct ast_sip_endpoint_info_configuration info;
594         /*! Call pickup configuration */
595         struct ast_sip_endpoint_pickup_configuration pickup;
596         /*! Inbound authentication credentials */
597         struct ast_sip_auth_vector inbound_auths;
598         /*! Outbound authentication credentials */
599         struct ast_sip_auth_vector outbound_auths;
600         /*! DTMF mode to use with this endpoint */
601         enum ast_sip_dtmf_mode dtmf;
602         /*! Method(s) by which the endpoint should be identified. */
603         enum ast_sip_endpoint_identifier_type ident_method;
604         /*! Boolean indicating if ringing should be sent as inband progress */
605         unsigned int inband_progress;
606         /*! Pointer to the persistent Asterisk endpoint */
607         struct ast_endpoint *persistent;
608         /*! The number of channels at which busy device state is returned */
609         unsigned int devicestate_busy_at;
610         /*! Whether fax detection is enabled or not (CNG tone detection) */
611         unsigned int faxdetect;
612         /*! Determines if transfers (using REFER) are allowed by this endpoint */
613         unsigned int allowtransfer;
614         /*! Method used when handling redirects */
615         enum ast_sip_session_redirect redirect_method;
616         /*! Variables set on channel creation */
617         struct ast_variable *channel_vars;
618         /*! Whether to place a 'user=phone' parameter into the request URI if user is a number */
619         unsigned int usereqphone;
620         /*! Whether to pass through hold and unhold using re-invites with recvonly and sendrecv */
621         unsigned int moh_passthrough;
622 };
623
624 /*!
625  * \brief Initialize an auth vector with the configured values.
626  *
627  * \param vector Vector to initialize
628  * \param auth_names Comma-separated list of names to set in the array
629  * \retval 0 Success
630  * \retval non-zero Failure
631  */
632 int ast_sip_auth_vector_init(struct ast_sip_auth_vector *vector, const char *auth_names);
633
634 /*!
635  * \brief Free contents of an auth vector.
636  *
637  * \param array Vector whose contents are to be freed
638  */
639 void ast_sip_auth_vector_destroy(struct ast_sip_auth_vector *vector);
640
641 /*!
642  * \brief Possible returns from ast_sip_check_authentication
643  */
644 enum ast_sip_check_auth_result {
645     /*! Authentication needs to be challenged */
646     AST_SIP_AUTHENTICATION_CHALLENGE,
647     /*! Authentication succeeded */
648     AST_SIP_AUTHENTICATION_SUCCESS,
649     /*! Authentication failed */
650     AST_SIP_AUTHENTICATION_FAILED,
651     /*! Authentication encountered some internal error */
652     AST_SIP_AUTHENTICATION_ERROR,
653 };
654
655 /*!
656  * \brief An interchangeable way of handling digest authentication for SIP.
657  *
658  * An authenticator is responsible for filling in the callbacks provided below. Each is called from a publicly available
659  * function in res_sip. The authenticator can use configuration or other local policy to determine whether authentication
660  * should take place and what credentials should be used when challenging and authenticating a request.
661  */
662 struct ast_sip_authenticator {
663     /*!
664      * \brief Check if a request requires authentication
665      * See ast_sip_requires_authentication for more details
666      */
667     int (*requires_authentication)(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata);
668         /*!
669          * \brief Check that an incoming request passes authentication.
670          *
671          * The tdata parameter is useful for adding information such as digest challenges.
672          *
673          * \param endpoint The endpoint sending the incoming request
674          * \param rdata The incoming request
675          * \param tdata Tentative outgoing request.
676          */
677         enum ast_sip_check_auth_result (*check_authentication)(struct ast_sip_endpoint *endpoint,
678                         pjsip_rx_data *rdata, pjsip_tx_data *tdata);
679 };
680
681 /*!
682  * \brief an interchangeable way of responding to authentication challenges
683  *
684  * An outbound authenticator takes incoming challenges and formulates a new SIP request with
685  * credentials.
686  */
687 struct ast_sip_outbound_authenticator {
688         /*!
689          * \brief Create a new request with authentication credentials
690          *
691          * \param auths A vector of IDs of auth sorcery objects
692          * \param challenge The SIP response with authentication challenge(s)
693          * \param tsx The transaction in which the challenge was received
694          * \param new_request The new SIP request with challenge response(s)
695          * \retval 0 Successfully created new request
696          * \retval -1 Failed to create a new request
697          */
698         int (*create_request_with_auth)(const struct ast_sip_auth_vector *auths, struct pjsip_rx_data *challenge,
699                         struct pjsip_transaction *tsx, struct pjsip_tx_data **new_request);
700 };
701
702 /*!
703  * \brief An entity responsible for identifying the source of a SIP message
704  */
705 struct ast_sip_endpoint_identifier {
706     /*!
707      * \brief Callback used to identify the source of a message.
708      * See ast_sip_identify_endpoint for more details
709      */
710     struct ast_sip_endpoint *(*identify_endpoint)(pjsip_rx_data *rdata);
711 };
712
713 /*!
714  * \brief Register a SIP service in Asterisk.
715  *
716  * This is more-or-less a wrapper around pjsip_endpt_register_module().
717  * Registering a service makes it so that PJSIP will call into the
718  * service at appropriate times. For more information about PJSIP module
719  * callbacks, see the PJSIP documentation. Asterisk modules that call
720  * this function will likely do so at module load time.
721  *
722  * \param module The module that is to be registered with PJSIP
723  * \retval 0 Success
724  * \retval -1 Failure
725  */
726 int ast_sip_register_service(pjsip_module *module);
727
728 /*!
729  * This is the opposite of ast_sip_register_service().  Unregistering a
730  * service means that PJSIP will no longer call into the module any more.
731  * This will likely occur when an Asterisk module is unloaded.
732  *
733  * \param module The PJSIP module to unregister
734  */
735 void ast_sip_unregister_service(pjsip_module *module);
736
737 /*!
738  * \brief Register a SIP authenticator
739  *
740  * An authenticator has three main purposes:
741  * 1) Determining if authentication should be performed on an incoming request
742  * 2) Gathering credentials necessary for issuing an authentication challenge
743  * 3) Authenticating a request that has credentials
744  *
745  * Asterisk provides a default authenticator, but it may be replaced by a
746  * custom one if desired.
747  *
748  * \param auth The authenticator to register
749  * \retval 0 Success
750  * \retval -1 Failure
751  */
752 int ast_sip_register_authenticator(struct ast_sip_authenticator *auth);
753
754 /*!
755  * \brief Unregister a SIP authenticator
756  *
757  * When there is no authenticator registered, requests cannot be challenged
758  * or authenticated.
759  *
760  * \param auth The authenticator to unregister
761  */
762 void ast_sip_unregister_authenticator(struct ast_sip_authenticator *auth);
763
764  /*!
765  * \brief Register an outbound SIP authenticator
766  *
767  * An outbound authenticator is responsible for creating responses to
768  * authentication challenges by remote endpoints.
769  *
770  * \param auth The authenticator to register
771  * \retval 0 Success
772  * \retval -1 Failure
773  */
774 int ast_sip_register_outbound_authenticator(struct ast_sip_outbound_authenticator *outbound_auth);
775
776 /*!
777  * \brief Unregister an outbound SIP authenticator
778  *
779  * When there is no outbound authenticator registered, authentication challenges
780  * will be handled as any other final response would be.
781  *
782  * \param auth The authenticator to unregister
783  */
784 void ast_sip_unregister_outbound_authenticator(struct ast_sip_outbound_authenticator *auth);
785
786 /*!
787  * \brief Register a SIP endpoint identifier with a name.
788  *
789  * An endpoint identifier's purpose is to determine which endpoint a given SIP
790  * message has come from.
791  *
792  * Multiple endpoint identifiers may be registered so that if an endpoint
793  * cannot be identified by one identifier, it may be identified by another.
794  *
795  * \param identifier The SIP endpoint identifier to register
796  * \param name The name of the endpoint identifier
797  * \retval 0 Success
798  * \retval -1 Failure
799  */
800 int ast_sip_register_endpoint_identifier_with_name(struct ast_sip_endpoint_identifier *identifier,
801                                                    const char *name);
802
803 /*!
804  * \brief Register a SIP endpoint identifier
805  *
806  * An endpoint identifier's purpose is to determine which endpoint a given SIP
807  * message has come from.
808  *
809  * Multiple endpoint identifiers may be registered so that if an endpoint
810  * cannot be identified by one identifier, it may be identified by another.
811  *
812  * Asterisk provides two endpoint identifiers. One identifies endpoints based
813  * on the user part of the From header URI. The other identifies endpoints based
814  * on the source IP address.
815  *
816  * If the order in which endpoint identifiers is run is important to you, then
817  * be sure to load individual endpoint identifier modules in the order you wish
818  * for them to be run in modules.conf
819  *
820  * \note endpoint identifiers registered using this method (no name specified)
821  *       are placed at the front of the endpoint identifiers list ahead of any
822  *       named identifiers.
823  *
824  * \param identifier The SIP endpoint identifier to register
825  * \retval 0 Success
826  * \retval -1 Failure
827  */
828 int ast_sip_register_endpoint_identifier(struct ast_sip_endpoint_identifier *identifier);
829
830 /*!
831  * \brief Unregister a SIP endpoint identifier
832  *
833  * This stops an endpoint identifier from being used.
834  *
835  * \param identifier The SIP endoint identifier to unregister
836  */
837 void ast_sip_unregister_endpoint_identifier(struct ast_sip_endpoint_identifier *identifier);
838
839 /*!
840  * \brief Allocate a new SIP endpoint
841  *
842  * This will return an endpoint with its refcount increased by one. This reference
843  * can be released using ao2_ref().
844  *
845  * \param name The name of the endpoint.
846  * \retval NULL Endpoint allocation failed
847  * \retval non-NULL The newly allocated endpoint
848  */
849 void *ast_sip_endpoint_alloc(const char *name);
850
851 /*!
852  * \brief Get a pointer to the PJSIP endpoint.
853  *
854  * This is useful when modules have specific information they need
855  * to register with the PJSIP core.
856  * \retval NULL endpoint has not been created yet.
857  * \retval non-NULL PJSIP endpoint.
858  */
859 pjsip_endpoint *ast_sip_get_pjsip_endpoint(void);
860
861 /*!
862  * \brief Get a pointer to the SIP sorcery structure.
863  *
864  * \retval NULL sorcery has not been initialized
865  * \retval non-NULL sorcery structure
866  */
867 struct ast_sorcery *ast_sip_get_sorcery(void);
868
869 /*!
870  * \brief Retrieve a named AOR
871  *
872  * \param aor_name Name of the AOR
873  *
874  * \retval NULL if not found
875  * \retval non-NULL if found
876  */
877 struct ast_sip_aor *ast_sip_location_retrieve_aor(const char *aor_name);
878
879 /*!
880  * \brief Retrieve the first bound contact for an AOR
881  *
882  * \param aor Pointer to the AOR
883  * \retval NULL if no contacts available
884  * \retval non-NULL if contacts available
885  */
886 struct ast_sip_contact *ast_sip_location_retrieve_first_aor_contact(const struct ast_sip_aor *aor);
887
888 /*!
889  * \brief Retrieve all contacts currently available for an AOR
890  *
891  * \param aor Pointer to the AOR
892  *
893  * \retval NULL if no contacts available
894  * \retval non-NULL if contacts available
895  */
896 struct ao2_container *ast_sip_location_retrieve_aor_contacts(const struct ast_sip_aor *aor);
897
898 /*!
899  * \brief Retrieve the first bound contact from a list of AORs
900  *
901  * \param aor_list A comma-separated list of AOR names
902  * \retval NULL if no contacts available
903  * \retval non-NULL if contacts available
904  */
905 struct ast_sip_contact *ast_sip_location_retrieve_contact_from_aor_list(const char *aor_list);
906
907 /*!
908  * \brief Retrieve the first bound contact AND the AOR chosen from a list of AORs
909  *
910  * \param aor_list A comma-separated list of AOR names
911  * \param aor The chosen AOR
912  * \param contact The chosen contact
913  */
914  void ast_sip_location_retrieve_contact_and_aor_from_list(const char *aor_list, struct ast_sip_aor **aor,
915         struct ast_sip_contact **contact);
916
917 /*!
918  * \brief Retrieve a named contact
919  *
920  * \param contact_name Name of the contact
921  *
922  * \retval NULL if not found
923  * \retval non-NULL if found
924  */
925 struct ast_sip_contact *ast_sip_location_retrieve_contact(const char *contact_name);
926
927 /*!
928  * \brief Add a new contact to an AOR
929  *
930  * \param aor Pointer to the AOR
931  * \param uri Full contact URI
932  * \param expiration_time Optional expiration time of the contact
933  * \param path_info Path information
934  * \param user_agent User-Agent header from REGISTER request
935  *
936  * \retval -1 failure
937  * \retval 0 success
938  */
939 int ast_sip_location_add_contact(struct ast_sip_aor *aor, const char *uri,
940         struct timeval expiration_time, const char *path_info, const char *user_agent);
941
942 /*!
943  * \brief Update a contact
944  *
945  * \param contact New contact object with details
946  *
947  * \retval -1 failure
948  * \retval 0 success
949  */
950 int ast_sip_location_update_contact(struct ast_sip_contact *contact);
951
952 /*!
953 * \brief Delete a contact
954 *
955 * \param contact Contact object to delete
956 *
957 * \retval -1 failure
958 * \retval 0 success
959 */
960 int ast_sip_location_delete_contact(struct ast_sip_contact *contact);
961
962 /*!
963  * \brief Callback called when an outbound request with authentication credentials is to be sent in dialog
964  *
965  * This callback will have the created request on it. The callback's purpose is to do any extra
966  * housekeeping that needs to be done as well as to send the request out.
967  *
968  * This callback is only necessary if working with a PJSIP API that sits between the application
969  * and the dialog layer.
970  *
971  * \param dlg The dialog to which the request belongs
972  * \param tdata The created request to be sent out
973  * \param user_data Data supplied with the callback
974  *
975  * \retval 0 Success
976  * \retval -1 Failure
977  */
978 typedef int (*ast_sip_dialog_outbound_auth_cb)(pjsip_dialog *dlg, pjsip_tx_data *tdata, void *user_data);
979
980 /*!
981  * \brief Set up outbound authentication on a SIP dialog
982  *
983  * This sets up the infrastructure so that all requests associated with a created dialog
984  * can be re-sent with authentication credentials if the original request is challenged.
985  *
986  * \param dlg The dialog on which requests will be authenticated
987  * \param endpoint The endpoint whom this dialog pertains to
988  * \param cb Callback to call to send requests with authentication
989  * \param user_data Data to be provided to the callback when it is called
990  *
991  * \retval 0 Success
992  * \retval -1 Failure
993  */
994 int ast_sip_dialog_setup_outbound_authentication(pjsip_dialog *dlg, const struct ast_sip_endpoint *endpoint,
995                 ast_sip_dialog_outbound_auth_cb cb, void *user_data);
996
997 /*!
998  * \brief Retrieves a reference to the artificial auth.
999  *
1000  * \retval The artificial auth
1001  */
1002 struct ast_sip_auth *ast_sip_get_artificial_auth(void);
1003
1004 /*!
1005  * \brief Retrieves a reference to the artificial endpoint.
1006  *
1007  * \retval The artificial endpoint
1008  */
1009 struct ast_sip_endpoint *ast_sip_get_artificial_endpoint(void);
1010
1011 /*!
1012  * \page Threading model for SIP
1013  *
1014  * There are three major types of threads that SIP will have to deal with:
1015  * \li Asterisk threads
1016  * \li PJSIP threads
1017  * \li SIP threadpool threads (a.k.a. "servants")
1018  *
1019  * \par Asterisk Threads
1020  *
1021  * Asterisk threads are those that originate from outside of SIP but within
1022  * Asterisk. The most common of these threads are PBX (channel) threads and
1023  * the autoservice thread. Most interaction with these threads will be through
1024  * channel technology callbacks. Within these threads, it is fine to handle
1025  * Asterisk data from outside of SIP, but any handling of SIP data should be
1026  * left to servants, \b especially if you wish to call into PJSIP for anything.
1027  * Asterisk threads are not registered with PJLIB, so attempting to call into
1028  * PJSIP will cause an assertion to be triggered, thus causing the program to
1029  * crash.
1030  *
1031  * \par PJSIP Threads
1032  *
1033  * PJSIP threads are those that originate from handling of PJSIP events, such
1034  * as an incoming SIP request or response, or a transaction timeout. The role
1035  * of these threads is to process information as quickly as possible so that
1036  * the next item on the SIP socket(s) can be serviced. On incoming messages,
1037  * Asterisk automatically will push the request to a servant thread. When your
1038  * module callback is called, processing will already be in a servant. However,
1039  * for other PSJIP events, such as transaction state changes due to timer
1040  * expirations, your module will be called into from a PJSIP thread. If you
1041  * are called into from a PJSIP thread, then you should push whatever processing
1042  * is needed to a servant as soon as possible. You can discern if you are currently
1043  * in a SIP servant thread using the \ref ast_sip_thread_is_servant function.
1044  *
1045  * \par Servants
1046  *
1047  * Servants are where the bulk of SIP work should be performed. These threads
1048  * exist in order to do the work that Asterisk threads and PJSIP threads hand
1049  * off to them. Servant threads register themselves with PJLIB, meaning that
1050  * they are capable of calling PJSIP and PJLIB functions if they wish.
1051  *
1052  * \par Serializer
1053  *
1054  * Tasks are handed off to servant threads using the API call \ref ast_sip_push_task.
1055  * The first parameter of this call is a serializer. If this pointer
1056  * is NULL, then the work will be handed off to whatever servant can currently handle
1057  * the task. If this pointer is non-NULL, then the task will not be executed until
1058  * previous tasks pushed with the same serializer have completed. For more information
1059  * on serializers and the benefits they provide, see \ref ast_threadpool_serializer
1060  *
1061  * \note
1062  *
1063  * Do not make assumptions about individual threads based on a corresponding serializer.
1064  * In other words, just because several tasks use the same serializer when being pushed
1065  * to servants, it does not mean that the same thread is necessarily going to execute those
1066  * tasks, even though they are all guaranteed to be executed in sequence.
1067  */
1068
1069 /*!
1070  * \brief Create a new serializer for SIP tasks
1071  *
1072  * See \ref ast_threadpool_serializer for more information on serializers.
1073  * SIP creates serializers so that tasks operating on similar data will run
1074  * in sequence.
1075  *
1076  * \retval NULL Failure
1077  * \retval non-NULL Newly-created serializer
1078  */
1079 struct ast_taskprocessor *ast_sip_create_serializer(void);
1080
1081 /*!
1082  * \brief Set a serializer on a SIP dialog so requests and responses are automatically serialized
1083  *
1084  * Passing a NULL serializer is a way to remove a serializer from a dialog.
1085  *
1086  * \param dlg The SIP dialog itself
1087  * \param serializer The serializer to use
1088  */
1089 void ast_sip_dialog_set_serializer(pjsip_dialog *dlg, struct ast_taskprocessor *serializer);
1090
1091 /*!
1092  * \brief Set an endpoint on a SIP dialog so in-dialog requests do not undergo endpoint lookup.
1093  *
1094  * \param dlg The SIP dialog itself
1095  * \param endpoint The endpoint that this dialog is communicating with
1096  */
1097 void ast_sip_dialog_set_endpoint(pjsip_dialog *dlg, struct ast_sip_endpoint *endpoint);
1098
1099 /*!
1100  * \brief Get the endpoint associated with this dialog
1101  *
1102  * This function increases the refcount of the endpoint by one. Release
1103  * the reference once you are finished with the endpoint.
1104  *
1105  * \param dlg The SIP dialog from which to retrieve the endpoint
1106  * \retval NULL No endpoint associated with this dialog
1107  * \retval non-NULL The endpoint.
1108  */
1109 struct ast_sip_endpoint *ast_sip_dialog_get_endpoint(pjsip_dialog *dlg);
1110
1111 /*!
1112  * \brief Pushes a task to SIP servants
1113  *
1114  * This uses the serializer provided to determine how to push the task.
1115  * If the serializer is NULL, then the task will be pushed to the
1116  * servants directly. If the serializer is non-NULL, then the task will be
1117  * queued behind other tasks associated with the same serializer.
1118  *
1119  * \param serializer The serializer to which the task belongs. Can be NULL
1120  * \param sip_task The task to execute
1121  * \param task_data The parameter to pass to the task when it executes
1122  * \retval 0 Success
1123  * \retval -1 Failure
1124  */
1125 int ast_sip_push_task(struct ast_taskprocessor *serializer, int (*sip_task)(void *), void *task_data);
1126
1127 /*!
1128  * \brief Push a task to SIP servants and wait for it to complete
1129  *
1130  * Like \ref ast_sip_push_task except that it blocks until the task completes.
1131  *
1132  * \warning \b Never use this function in a SIP servant thread. This can potentially
1133  * cause a deadlock. If you are in a SIP servant thread, just call your function
1134  * in-line.
1135  *
1136  * \param serializer The SIP serializer to which the task belongs. May be NULL.
1137  * \param sip_task The task to execute
1138  * \param task_data The parameter to pass to the task when it executes
1139  * \retval 0 Success
1140  * \retval -1 Failure
1141  */
1142 int ast_sip_push_task_synchronous(struct ast_taskprocessor *serializer, int (*sip_task)(void *), void *task_data);
1143
1144 /*!
1145  * \brief Determine if the current thread is a SIP servant thread
1146  *
1147  * \retval 0 This is not a SIP servant thread
1148  * \retval 1 This is a SIP servant thread
1149  */
1150 int ast_sip_thread_is_servant(void);
1151
1152 /*!
1153  * \brief SIP body description
1154  *
1155  * This contains a type and subtype that will be added as
1156  * the "Content-Type" for the message as well as the body
1157  * text.
1158  */
1159 struct ast_sip_body {
1160         /*! Type of the body, such as "application" */
1161         const char *type;
1162         /*! Subtype of the body, such as "sdp" */
1163         const char *subtype;
1164         /*! The text to go in the body */
1165         const char *body_text;
1166 };
1167
1168 /*!
1169  * \brief General purpose method for creating a UAC dialog with an endpoint
1170  *
1171  * \param endpoint A pointer to the endpoint
1172  * \param aor_name Optional name of the AOR to target, may even be an explicit SIP URI
1173  * \param request_user Optional user to place into the target URI
1174  *
1175  * \retval non-NULL success
1176  * \retval NULL failure
1177  */
1178 pjsip_dialog *ast_sip_create_dialog_uac(const struct ast_sip_endpoint *endpoint, const char *aor_name, const char *request_user);
1179
1180 /*!
1181  * \brief General purpose method for creating a UAS dialog with an endpoint
1182  *
1183  * \param endpoint A pointer to the endpoint
1184  * \param rdata The request that is starting the dialog
1185  * \param[out] status On failure, the reason for failure in creating the dialog
1186  */
1187 pjsip_dialog *ast_sip_create_dialog_uas(const struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata, pj_status_t *status);
1188
1189 /*!
1190  * \brief General purpose method for creating an rdata structure using specific information
1191  *
1192  * \param rdata[out] The rdata structure that will be populated
1193  * \param packet A SIP message
1194  * \param src_name The source IP address of the message
1195  * \param src_port The source port of the message
1196  * \param transport_type The type of transport the message was received on
1197  * \param local_name The local IP address the message was received on
1198  * \param local_port The local port the message was received on
1199  *
1200  * \retval 0 success
1201  * \retval -1 failure
1202  */
1203 int ast_sip_create_rdata(pjsip_rx_data *rdata, char *packet, const char *src_name, int src_port, char *transport_type,
1204         const char *local_name, int local_port);
1205
1206 /*!
1207  * \brief General purpose method for creating a SIP request
1208  *
1209  * Its typical use would be to create one-off requests such as an out of dialog
1210  * SIP MESSAGE.
1211  *
1212  * The request can either be in- or out-of-dialog. If in-dialog, the
1213  * dlg parameter MUST be present. If out-of-dialog the endpoint parameter
1214  * MUST be present. If both are present, then we will assume that the message
1215  * is to be sent in-dialog.
1216  *
1217  * The uri parameter can be specified if the request should be sent to an explicit
1218  * URI rather than one configured on the endpoint.
1219  *
1220  * \param method The method of the SIP request to send
1221  * \param dlg Optional. If specified, the dialog on which to request the message.
1222  * \param endpoint Optional. If specified, the request will be created out-of-dialog to the endpoint.
1223  * \param uri Optional. If specified, the request will be sent to this URI rather
1224  * than one configured for the endpoint.
1225  * \param contact The contact with which this request is associated for out-of-dialog requests.
1226  * \param[out] tdata The newly-created request
1227  *
1228  * The provided contact is attached to tdata with its reference bumped, but will
1229  * not survive for the entire lifetime of tdata since the contact is cleaned up
1230  * when all supplements have completed execution.
1231  *
1232  * \retval 0 Success
1233  * \retval -1 Failure
1234  */
1235 int ast_sip_create_request(const char *method, struct pjsip_dialog *dlg,
1236                 struct ast_sip_endpoint *endpoint, const char *uri,
1237                 struct ast_sip_contact *contact, pjsip_tx_data **tdata);
1238
1239 /*!
1240  * \brief General purpose method for sending a SIP request
1241  *
1242  * This is a companion function for \ref ast_sip_create_request. The request
1243  * created there can be passed to this function, though any request may be
1244  * passed in.
1245  *
1246  * This will automatically set up handling outbound authentication challenges if
1247  * they arrive.
1248  *
1249  * \param tdata The request to send
1250  * \param dlg Optional. The dialog in which the request is sent.  Otherwise it is out-of-dialog.
1251  * \param endpoint Optional. If specified, the out-of-dialog request is sent to the endpoint.
1252  * \param token Data to be passed to the callback upon receipt of out-of-dialog response.
1253  * \param callback Callback to be called upon receipt of out-of-dialog response.
1254  *
1255  * \retval 0 Success
1256  * \retval -1 Failure (out-of-dialog callback will not be called.)
1257  */
1258 int ast_sip_send_request(pjsip_tx_data *tdata, struct pjsip_dialog *dlg,
1259         struct ast_sip_endpoint *endpoint, void *token,
1260         void (*callback)(void *token, pjsip_event *e));
1261
1262 /*!
1263  * \brief General purpose method for creating a SIP response
1264  *
1265  * Its typical use would be to create responses for out of dialog
1266  * requests.
1267  *
1268  * \param rdata The rdata from the incoming request.
1269  * \param st_code The response code to transmit.
1270  * \param contact The contact with which this request is associated.
1271  * \param[out] tdata The newly-created response
1272  *
1273  * The provided contact is attached to tdata with its reference bumped, but will
1274  * not survive for the entire lifetime of tdata since the contact is cleaned up
1275  * when all supplements have completed execution.
1276  *
1277  * \retval 0 Success
1278  * \retval -1 Failure
1279  */
1280 int ast_sip_create_response(const pjsip_rx_data *rdata, int st_code,
1281         struct ast_sip_contact *contact, pjsip_tx_data **p_tdata);
1282
1283 /*!
1284  * \brief Send a response to an out of dialog request
1285  *
1286  * Use this function sparingly, since this does not create a transaction
1287  * within PJSIP. This means that if the request is retransmitted, it is
1288  * your responsibility to detect this and not process the same request
1289  * twice, and to send the same response for each retransmission.
1290  *
1291  * \param res_addr The response address for this response
1292  * \param tdata The response to send
1293  * \param endpoint The ast_sip_endpoint associated with this response
1294  *
1295  * \retval 0 Success
1296  * \retval -1 Failure
1297  */
1298 int ast_sip_send_response(pjsip_response_addr *res_addr, pjsip_tx_data *tdata, struct ast_sip_endpoint *sip_endpoint);
1299
1300 /*!
1301  * \brief Send a stateful response to an out of dialog request
1302  *
1303  * This creates a transaction within PJSIP, meaning that if the request
1304  * that we are responding to is retransmitted, we will not attempt to
1305  * re-handle the request.
1306  *
1307  * \param rdata The request that is being responded to
1308  * \param tdata The response to send
1309  * \param endpoint The ast_sip_endpoint associated with this response
1310  *
1311  * \since 13.4.0
1312  *
1313  * \retval 0 Success
1314  * \retval -1 Failure
1315  */
1316 int ast_sip_send_stateful_response(pjsip_rx_data *rdata, pjsip_tx_data *tdata, struct ast_sip_endpoint *sip_endpoint);
1317
1318 /*!
1319  * \brief Determine if an incoming request requires authentication
1320  *
1321  * This calls into the registered authenticator's requires_authentication callback
1322  * in order to determine if the request requires authentication.
1323  *
1324  * If there is no registered authenticator, then authentication will be assumed
1325  * not to be required.
1326  *
1327  * \param endpoint The endpoint from which the request originates
1328  * \param rdata The incoming SIP request
1329  * \retval non-zero The request requires authentication
1330  * \retval 0 The request does not require authentication
1331  */
1332 int ast_sip_requires_authentication(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata);
1333
1334 /*!
1335  * \brief Method to determine authentication status of an incoming request
1336  *
1337  * This will call into a registered authenticator. The registered authenticator will
1338  * do what is necessary to determine whether the incoming request passes authentication.
1339  * A tentative response is passed into this function so that if, say, a digest authentication
1340  * challenge should be sent in the ensuing response, it can be added to the response.
1341  *
1342  * \param endpoint The endpoint from the request was sent
1343  * \param rdata The request to potentially authenticate
1344  * \param tdata Tentative response to the request
1345  * \return The result of checking authentication.
1346  */
1347 enum ast_sip_check_auth_result ast_sip_check_authentication(struct ast_sip_endpoint *endpoint,
1348                 pjsip_rx_data *rdata, pjsip_tx_data *tdata);
1349
1350 /*!
1351  * \brief Create a response to an authentication challenge
1352  *
1353  * This will call into an outbound authenticator's create_request_with_auth callback
1354  * to create a new request with authentication credentials. See the create_request_with_auth
1355  * callback in the \ref ast_sip_outbound_authenticator structure for details about
1356  * the parameters and return values.
1357  */
1358 int ast_sip_create_request_with_auth(const struct ast_sip_auth_vector *auths, pjsip_rx_data *challenge,
1359                 pjsip_transaction *tsx, pjsip_tx_data **new_request);
1360
1361 /*!
1362  * \brief Determine the endpoint that has sent a SIP message
1363  *
1364  * This will call into each of the registered endpoint identifiers'
1365  * identify_endpoint() callbacks until one returns a non-NULL endpoint.
1366  * This will return an ao2 object. Its reference count will need to be
1367  * decremented when completed using the endpoint.
1368  *
1369  * \param rdata The inbound SIP message to use when identifying the endpoint.
1370  * \retval NULL No matching endpoint
1371  * \retval non-NULL The matching endpoint
1372  */
1373 struct ast_sip_endpoint *ast_sip_identify_endpoint(pjsip_rx_data *rdata);
1374
1375 /*!
1376  * \brief Set the outbound proxy for an outbound SIP message
1377  *
1378  * \param tdata The message to set the outbound proxy on
1379  * \param proxy SIP uri of the proxy
1380  * \retval 0 Success
1381  * \retval -1 Failure
1382  */
1383 int ast_sip_set_outbound_proxy(pjsip_tx_data *tdata, const char *proxy);
1384
1385 /*!
1386  * \brief Add a header to an outbound SIP message
1387  *
1388  * \param tdata The message to add the header to
1389  * \param name The header name
1390  * \param value The header value
1391  * \retval 0 Success
1392  * \retval -1 Failure
1393  */
1394 int ast_sip_add_header(pjsip_tx_data *tdata, const char *name, const char *value);
1395
1396 /*!
1397  * \brief Add a body to an outbound SIP message
1398  *
1399  * If this is called multiple times, the latest body will replace the current
1400  * body.
1401  *
1402  * \param tdata The message to add the body to
1403  * \param body The message body to add
1404  * \retval 0 Success
1405  * \retval -1 Failure
1406  */
1407 int ast_sip_add_body(pjsip_tx_data *tdata, const struct ast_sip_body *body);
1408
1409 /*!
1410  * \brief Add a multipart body to an outbound SIP message
1411  *
1412  * This will treat each part of the input vector as part of a multipart body and
1413  * add each part to the SIP message.
1414  *
1415  * \param tdata The message to add the body to
1416  * \param bodies The parts of the body to add
1417  * \retval 0 Success
1418  * \retval -1 Failure
1419  */
1420 int ast_sip_add_body_multipart(pjsip_tx_data *tdata, const struct ast_sip_body *bodies[], int num_bodies);
1421
1422 /*!
1423  * \brief Append body data to a SIP message
1424  *
1425  * This acts mostly the same as ast_sip_add_body, except that rather than replacing
1426  * a body if it currently exists, it appends data to an existing body.
1427  *
1428  * \param tdata The message to append the body to
1429  * \param body The string to append to the end of the current body
1430  * \retval 0 Success
1431  * \retval -1 Failure
1432  */
1433 int ast_sip_append_body(pjsip_tx_data *tdata, const char *body_text);
1434
1435 /*!
1436  * \brief Copy a pj_str_t into a standard character buffer.
1437  *
1438  * pj_str_t is not NULL-terminated. Any place that expects a NULL-
1439  * terminated string needs to have the pj_str_t copied into a separate
1440  * buffer.
1441  *
1442  * This method copies the pj_str_t contents into the destination buffer
1443  * and NULL-terminates the buffer.
1444  *
1445  * \param dest The destination buffer
1446  * \param src The pj_str_t to copy
1447  * \param size The size of the destination buffer.
1448  */
1449 void ast_copy_pj_str(char *dest, const pj_str_t *src, size_t size);
1450
1451 /*!
1452  * \brief Get the looked-up endpoint on an out-of dialog request or response
1453  *
1454  * The function may ONLY be called on out-of-dialog requests or responses. For
1455  * in-dialog requests and responses, it is required that the user of the dialog
1456  * has the looked-up endpoint stored locally.
1457  *
1458  * This function should never return NULL if the message is out-of-dialog. It will
1459  * always return NULL if the message is in-dialog.
1460  *
1461  * This function will increase the reference count of the returned endpoint by one.
1462  * Release your reference using the ao2_ref function when finished.
1463  *
1464  * \param rdata Out-of-dialog request or response
1465  * \return The looked up endpoint
1466  */
1467 struct ast_sip_endpoint *ast_pjsip_rdata_get_endpoint(pjsip_rx_data *rdata);
1468
1469 /*!
1470  * \brief Add 'user=phone' parameter to URI if enabled and user is a phone number.
1471  *
1472  * \param endpoint The endpoint to use for configuration
1473  * \param pool The memory pool to allocate the parameter from
1474  * \param uri The URI to check for user and to add parameter to
1475  */
1476 void ast_sip_add_usereqphone(const struct ast_sip_endpoint *endpoint, pj_pool_t *pool, pjsip_uri *uri);
1477
1478 /*!
1479  * \brief Retrieve any endpoints available to sorcery.
1480  *
1481  * \retval Endpoints available to sorcery, NULL if no endpoints found.
1482  */
1483 struct ao2_container *ast_sip_get_endpoints(void);
1484
1485 /*!
1486  * \brief Retrieve the default outbound endpoint.
1487  *
1488  * \retval The default outbound endpoint, NULL if not found.
1489  */
1490 struct ast_sip_endpoint *ast_sip_default_outbound_endpoint(void);
1491
1492 /*!
1493  * \brief Retrieve relevant SIP auth structures from sorcery
1494  *
1495  * \param auths Vector of sorcery IDs of auth credentials to retrieve
1496  * \param[out] out The retrieved auths are stored here
1497  */
1498 int ast_sip_retrieve_auths(const struct ast_sip_auth_vector *auths, struct ast_sip_auth **out);
1499
1500 /*!
1501  * \brief Clean up retrieved auth structures from memory
1502  *
1503  * Call this function once you have completed operating on auths
1504  * retrieved from \ref ast_sip_retrieve_auths
1505  *
1506  * \param auths An vector of auth structures to clean up
1507  * \param num_auths The number of auths in the vector
1508  */
1509 void ast_sip_cleanup_auths(struct ast_sip_auth *auths[], size_t num_auths);
1510
1511 /*!
1512  * \brief Checks if the given content type matches type/subtype.
1513  *
1514  * Compares the pjsip_media_type with the passed type and subtype and
1515  * returns the result of that comparison.  The media type parameters are
1516  * ignored.
1517  *
1518  * \param content_type The pjsip_media_type structure to compare
1519  * \param type The media type to compare
1520  * \param subtype The media subtype to compare
1521  * \retval 0 No match
1522  * \retval -1 Match
1523  */
1524 int ast_sip_is_content_type(pjsip_media_type *content_type, char *type, char *subtype);
1525
1526 /*!
1527  * \brief Send a security event notification for when an invalid endpoint is requested
1528  *
1529  * \param name Name of the endpoint requested
1530  * \param rdata Received message
1531  */
1532 void ast_sip_report_invalid_endpoint(const char *name, pjsip_rx_data *rdata);
1533
1534 /*!
1535  * \brief Send a security event notification for when an ACL check fails
1536  *
1537  * \param endpoint Pointer to the endpoint in use
1538  * \param rdata Received message
1539  * \param name Name of the ACL
1540  */
1541 void ast_sip_report_failed_acl(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata, const char *name);
1542
1543 /*!
1544  * \brief Send a security event notification for when a challenge response has failed
1545  *
1546  * \param endpoint Pointer to the endpoint in use
1547  * \param rdata Received message
1548  */
1549 void ast_sip_report_auth_failed_challenge_response(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata);
1550
1551 /*!
1552  * \brief Send a security event notification for when authentication succeeds
1553  *
1554  * \param endpoint Pointer to the endpoint in use
1555  * \param rdata Received message
1556  */
1557 void ast_sip_report_auth_success(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata);
1558
1559 /*!
1560  * \brief Send a security event notification for when an authentication challenge is sent
1561  *
1562  * \param endpoint Pointer to the endpoint in use
1563  * \param rdata Received message
1564  * \param tdata Sent message
1565  */
1566 void ast_sip_report_auth_challenge_sent(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata, pjsip_tx_data *tdata);
1567
1568 /*!
1569  * \brief Send a security event notification for when a request is not supported
1570  *
1571  * \param endpoint Pointer to the endpoint in use
1572  * \param rdata Received message
1573  * \param req_type the type of request
1574  */
1575 void ast_sip_report_req_no_support(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata,
1576                                    const char* req_type);
1577
1578 /*!
1579  * \brief Send a security event notification for when a memory limit is hit.
1580  *
1581  * \param endpoint Pointer to the endpoint in use
1582  * \param rdata Received message
1583  */
1584 void ast_sip_report_mem_limit(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata);
1585
1586 int ast_sip_add_global_request_header(const char *name, const char *value, int replace);
1587 int ast_sip_add_global_response_header(const char *name, const char *value, int replace);
1588
1589 /*!
1590  * \brief Retrieves the value associated with the given key.
1591  *
1592  * \param ht the hash table/dictionary to search
1593  * \param key the key to find
1594  *
1595  * \retval the value associated with the key, NULL otherwise.
1596  */
1597 void *ast_sip_dict_get(void *ht, const char *key);
1598
1599 /*!
1600  * \brief Using the dictionary stored in mod_data array at a given id,
1601  *        retrieve the value associated with the given key.
1602  *
1603  * \param mod_data a module data array
1604  * \param id the mod_data array index
1605  * \param key the key to find
1606  *
1607  * \retval the value associated with the key, NULL otherwise.
1608  */
1609 #define ast_sip_mod_data_get(mod_data, id, key)         \
1610         ast_sip_dict_get(mod_data[id], key)
1611
1612 /*!
1613  * \brief Set the value for the given key.
1614  *
1615  * Note - if the hash table does not exist one is created first, the key/value
1616  * pair is set, and the hash table returned.
1617  *
1618  * \param pool the pool to allocate memory in
1619  * \param ht the hash table/dictionary in which to store the key/value pair
1620  * \param key the key to associate a value with
1621  * \param val the value to associate with a key
1622  *
1623  * \retval the given, or newly created, hash table.
1624  */
1625 void *ast_sip_dict_set(pj_pool_t* pool, void *ht,
1626                        const char *key, void *val);
1627
1628 /*!
1629  * \brief Utilizing a mod_data array for a given id, set the value
1630  *        associated with the given key.
1631  *
1632  * For a given structure's mod_data array set the element indexed by id to
1633  * be a dictionary containing the key/val pair.
1634  *
1635  * \param pool a memory allocation pool
1636  * \param mod_data a module data array
1637  * \param id the mod_data array index
1638  * \param key the key to find
1639  * \param val the value to associate with a key
1640  */
1641 #define ast_sip_mod_data_set(pool, mod_data, id, key, val)              \
1642         mod_data[id] = ast_sip_dict_set(pool, mod_data[id], key, val)
1643
1644 /*!
1645  * \brief For every contact on an AOR call the given 'on_contact' handler.
1646  *
1647  * \param aor the aor containing a list of contacts to iterate
1648  * \param on_contact callback on each contact on an AOR.  The object
1649  * received by the callback will be a ast_sip_contact_wrapper structure.
1650  * \param arg user data passed to handler
1651  * \retval 0 Success, non-zero on failure
1652  */
1653 int ast_sip_for_each_contact(const struct ast_sip_aor *aor,
1654                 ao2_callback_fn on_contact, void *arg);
1655
1656 /*!
1657  * \brief Handler used to convert a contact to a string.
1658  *
1659  * \param object the ast_sip_aor_contact_pair containing a list of contacts to iterate and the contact
1660  * \param arg user data passed to handler
1661  * \param flags
1662  * \retval 0 Success, non-zero on failure
1663  */
1664 int ast_sip_contact_to_str(void *object, void *arg, int flags);
1665
1666 /*!
1667  * \brief For every aor in the comma separated aors string call the
1668  *        given 'on_aor' handler.
1669  *
1670  * \param aors a comma separated list of aors
1671  * \param on_aor callback for each aor
1672  * \param arg user data passed to handler
1673  * \retval 0 Success, non-zero on failure
1674  */
1675 int ast_sip_for_each_aor(const char *aors, ao2_callback_fn on_aor, void *arg);
1676
1677 /*!
1678  * \brief For every auth in the array call the given 'on_auth' handler.
1679  *
1680  * \param array an array of auths
1681  * \param on_auth callback for each auth
1682  * \param arg user data passed to handler
1683  * \retval 0 Success, non-zero on failure
1684  */
1685 int ast_sip_for_each_auth(const struct ast_sip_auth_vector *array,
1686                           ao2_callback_fn on_auth, void *arg);
1687
1688 /*!
1689  * \brief Converts the given auth type to a string
1690  *
1691  * \param type the auth type to convert
1692  * \retval a string representative of the auth type
1693  */
1694 const char *ast_sip_auth_type_to_str(enum ast_sip_auth_type type);
1695
1696 /*!
1697  * \brief Converts an auths array to a string of comma separated values
1698  *
1699  * \param auths an auth array
1700  * \param buf the string buffer to write the object data
1701  * \retval 0 Success, non-zero on failure
1702  */
1703 int ast_sip_auths_to_str(const struct ast_sip_auth_vector *auths, char **buf);
1704
1705 /*
1706  * \brief AMI variable container
1707  */
1708 struct ast_sip_ami {
1709         /*! Manager session */
1710         struct mansession *s;
1711         /*! Manager message */
1712         const struct message *m;
1713         /*! Manager Action ID */
1714         const char *action_id;
1715         /*! user specified argument data */
1716         void *arg;
1717         /*! count of objects */
1718         int count;
1719 };
1720
1721 /*!
1722  * \brief Creates a string to store AMI event data in.
1723  *
1724  * \param event the event to set
1725  * \param ami AMI session and message container
1726  * \retval an initialized ast_str or NULL on error.
1727  */
1728 struct ast_str *ast_sip_create_ami_event(const char *event,
1729                                          struct ast_sip_ami *ami);
1730
1731 /*!
1732  * \brief An entity responsible formatting endpoint information.
1733  */
1734 struct ast_sip_endpoint_formatter {
1735         /*!
1736          * \brief Callback used to format endpoint information over AMI.
1737          */
1738         int (*format_ami)(const struct ast_sip_endpoint *endpoint,
1739                           struct ast_sip_ami *ami);
1740         AST_RWLIST_ENTRY(ast_sip_endpoint_formatter) next;
1741 };
1742
1743 /*!
1744  * \brief Register an endpoint formatter.
1745  *
1746  * \param obj the formatter to register
1747  * \retval 0 Success
1748  * \retval -1 Failure
1749  */
1750 int ast_sip_register_endpoint_formatter(struct ast_sip_endpoint_formatter *obj);
1751
1752 /*!
1753  * \brief Unregister an endpoint formatter.
1754  *
1755  * \param obj the formatter to unregister
1756  */
1757 void ast_sip_unregister_endpoint_formatter(struct ast_sip_endpoint_formatter *obj);
1758
1759 /*!
1760  * \brief Converts a sorcery object to a string of object properties.
1761  *
1762  * \param obj the sorcery object to convert
1763  * \param str the string buffer to write the object data
1764  * \retval 0 Success, non-zero on failure
1765  */
1766 int ast_sip_sorcery_object_to_ami(const void *obj, struct ast_str **buf);
1767
1768 /*!
1769  * \brief Formats the endpoint and sends over AMI.
1770  *
1771  * \param endpoint the endpoint to format and send
1772  * \param endpoint ami AMI variable container
1773  * \param count the number of formatters operated on
1774  * \retval 0 Success, otherwise non-zero on error
1775  */
1776 int ast_sip_format_endpoint_ami(struct ast_sip_endpoint *endpoint,
1777                                 struct ast_sip_ami *ami, int *count);
1778
1779 /*!
1780  * \brief Format auth details for AMI.
1781  *
1782  * \param auths an auth array
1783  * \param ami ami variable container
1784  * \retval 0 Success, non-zero on failure
1785  */
1786 int ast_sip_format_auths_ami(const struct ast_sip_auth_vector *auths,
1787                              struct ast_sip_ami *ami);
1788
1789 /*!
1790  * \brief Retrieve the endpoint snapshot for an endpoint
1791  *
1792  * \param endpoint The endpoint whose snapshot is to be retreieved.
1793  * \retval The endpoint snapshot
1794  */
1795 struct ast_endpoint_snapshot *ast_sip_get_endpoint_snapshot(
1796         const struct ast_sip_endpoint *endpoint);
1797
1798 /*!
1799  * \brief Retrieve the device state for an endpoint.
1800  *
1801  * \param endpoint The endpoint whose state is to be retrieved.
1802  * \retval The device state.
1803  */
1804 const char *ast_sip_get_device_state(const struct ast_sip_endpoint *endpoint);
1805
1806 /*!
1807  * \brief For every channel snapshot on an endpoint snapshot call the given
1808  *        'on_channel_snapshot' handler.
1809  *
1810  * \param endpoint_snapshot snapshot of an endpoint
1811  * \param on_channel_snapshot callback for each channel snapshot
1812  * \param arg user data passed to handler
1813  * \retval 0 Success, non-zero on failure
1814  */
1815 int ast_sip_for_each_channel_snapshot(const struct ast_endpoint_snapshot *endpoint_snapshot,
1816                 ao2_callback_fn on_channel_snapshot,
1817                                       void *arg);
1818
1819 /*!
1820  * \brief For every channel snapshot on an endpoint all the given
1821  *        'on_channel_snapshot' handler.
1822  *
1823  * \param endpoint endpoint
1824  * \param on_channel_snapshot callback for each channel snapshot
1825  * \param arg user data passed to handler
1826  * \retval 0 Success, non-zero on failure
1827  */
1828 int ast_sip_for_each_channel(const struct ast_sip_endpoint *endpoint,
1829                 ao2_callback_fn on_channel_snapshot,
1830                                       void *arg);
1831
1832 enum ast_sip_supplement_priority {
1833         /*! Top priority. Supplements with this priority are those that need to run before any others */
1834         AST_SIP_SUPPLEMENT_PRIORITY_FIRST = 0,
1835         /*! Channel creation priority.
1836          * chan_pjsip creates a channel at this priority. If your supplement depends on being run before
1837          * or after channel creation, then set your priority to be lower or higher than this value.
1838          */
1839         AST_SIP_SUPPLEMENT_PRIORITY_CHANNEL = 1000000,
1840         /*! Lowest priority. Supplements with this priority should be run after all other supplements */
1841         AST_SIP_SUPPLEMENT_PRIORITY_LAST = INT_MAX,
1842 };
1843
1844 /*!
1845  * \brief A supplement to SIP message processing
1846  *
1847  * These can be registered by any module in order to add
1848  * processing to incoming and outgoing SIP out of dialog
1849  * requests and responses
1850  */
1851 struct ast_sip_supplement {
1852         /*! Method on which to call the callbacks. If NULL, call on all methods */
1853         const char *method;
1854         /*! Priority for this supplement. Lower numbers are visited before higher numbers */
1855         enum ast_sip_supplement_priority priority;
1856         /*!
1857          * \brief Called on incoming SIP request
1858          * This method can indicate a failure in processing in its return. If there
1859          * is a failure, it is required that this method sends a response to the request.
1860          * This method is always called from a SIP servant thread.
1861          *
1862          * \note
1863          * The following PJSIP methods will not work properly:
1864          * pjsip_rdata_get_dlg()
1865          * pjsip_rdata_get_tsx()
1866          * The reason is that the rdata passed into this function is a cloned rdata structure,
1867          * and its module data is not copied during the cloning operation.
1868          * If you need to get the dialog, you can get it via session->inv_session->dlg.
1869          *
1870          * \note
1871          * There is no guarantee that a channel will be present on the session when this is called.
1872          */
1873         int (*incoming_request)(struct ast_sip_endpoint *endpoint, struct pjsip_rx_data *rdata);
1874         /*!
1875          * \brief Called on an incoming SIP response
1876          * This method is always called from a SIP servant thread.
1877          *
1878          * \note
1879          * The following PJSIP methods will not work properly:
1880          * pjsip_rdata_get_dlg()
1881          * pjsip_rdata_get_tsx()
1882          * The reason is that the rdata passed into this function is a cloned rdata structure,
1883          * and its module data is not copied during the cloning operation.
1884          * If you need to get the dialog, you can get it via session->inv_session->dlg.
1885          *
1886          * \note
1887          * There is no guarantee that a channel will be present on the session when this is called.
1888          */
1889         void (*incoming_response)(struct ast_sip_endpoint *endpoint, struct pjsip_rx_data *rdata);
1890         /*!
1891          * \brief Called on an outgoing SIP request
1892          * This method is always called from a SIP servant thread.
1893          */
1894         void (*outgoing_request)(struct ast_sip_endpoint *endpoint, struct ast_sip_contact *contact, struct pjsip_tx_data *tdata);
1895         /*!
1896          * \brief Called on an outgoing SIP response
1897          * This method is always called from a SIP servant thread.
1898          */
1899         void (*outgoing_response)(struct ast_sip_endpoint *endpoint, struct ast_sip_contact *contact, struct pjsip_tx_data *tdata);
1900         /*! Next item in the list */
1901         AST_LIST_ENTRY(ast_sip_supplement) next;
1902 };
1903
1904 /*!
1905  * \brief Register a supplement to SIP out of dialog processing
1906  *
1907  * This allows for someone to insert themselves in the processing of out
1908  * of dialog SIP requests and responses. This, for example could allow for
1909  * a module to set channel data based on headers in an incoming message.
1910  * Similarly, a module could reject an incoming request if desired.
1911  *
1912  * \param supplement The supplement to register
1913  * \retval 0 Success
1914  * \retval -1 Failure
1915  */
1916 int ast_sip_register_supplement(struct ast_sip_supplement *supplement);
1917
1918 /*!
1919  * \brief Unregister a an supplement to SIP out of dialog processing
1920  *
1921  * \param supplement The supplement to unregister
1922  */
1923 void ast_sip_unregister_supplement(struct ast_sip_supplement *supplement);
1924
1925 /*!
1926  * \brief Retrieve the system debug setting (yes|no|host).
1927  *
1928  * \note returned string needs to be de-allocated by caller.
1929  *
1930  * \retval the system debug setting.
1931  */
1932 char *ast_sip_get_debug(void);
1933
1934 /*!
1935  * \brief Retrieve the global endpoint_identifier_order setting.
1936  *
1937  * Specifies the order by which endpoint identifiers should be regarded.
1938  *
1939  * \retval the global endpoint_identifier_order value
1940  */
1941 char *ast_sip_get_endpoint_identifier_order(void);
1942
1943 /*! \brief Determines whether the res_pjsip module is loaded */
1944 #define CHECK_PJSIP_MODULE_LOADED()                             \
1945         do {                                                    \
1946                 if (!ast_module_check("res_pjsip.so")           \
1947                         || !ast_sip_get_pjsip_endpoint()) {     \
1948                         return AST_MODULE_LOAD_DECLINE;         \
1949                 }                                               \
1950         } while(0)
1951
1952 /*!
1953  * \brief Retrieve the system keep alive interval setting.
1954  *
1955  * \retval the keep alive interval.
1956  */
1957 unsigned int ast_sip_get_keep_alive_interval(void);
1958
1959 #endif /* _RES_PJSIP_H */