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