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