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