pjsip: Added "reg_server" to contacts.
[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 <pjsip.h>
23 /* Needed for SUBSCRIBE, NOTIFY, and PUBLISH method definitions */
24 #include <pjsip_simple.h>
25 #include <pjsip/sip_transaction.h>
26 #include <pj/timer.h>
27 #include <pjlib.h>
28
29 #include "asterisk/stringfields.h"
30 /* Needed for struct ast_sockaddr */
31 #include "asterisk/netsock2.h"
32 /* Needed for linked list macros */
33 #include "asterisk/linkedlists.h"
34 /* Needed for ast_party_id */
35 #include "asterisk/channel.h"
36 /* Needed for ast_sorcery */
37 #include "asterisk/sorcery.h"
38 /* Needed for ast_dnsmgr */
39 #include "asterisk/dnsmgr.h"
40 /* Needed for ast_endpoint */
41 #include "asterisk/endpoints.h"
42 /* Needed for ast_t38_ec_modes */
43 #include "asterisk/udptl.h"
44 /* Needed for pj_sockaddr */
45 #include <pjlib.h>
46 /* Needed for ast_rtp_dtls_cfg struct */
47 #include "asterisk/rtp_engine.h"
48 /* Needed for AST_VECTOR macro */
49 #include "asterisk/vector.h"
50 /* Needed for ast_sip_for_each_channel_snapshot struct */
51 #include "asterisk/stasis_channels.h"
52 #include "asterisk/stasis_endpoints.h"
53
54 /* Forward declarations of PJSIP stuff */
55 struct pjsip_rx_data;
56 struct pjsip_module;
57 struct pjsip_tx_data;
58 struct pjsip_dialog;
59 struct pjsip_transport;
60 struct pjsip_tpfactory;
61 struct pjsip_tls_setting;
62 struct pjsip_tpselector;
63
64 /*! \brief Maximum number of ciphers supported for a TLS transport */
65 #define SIP_TLS_MAX_CIPHERS 64
66
67 /*!
68  * \brief Structure for SIP transport information
69  */
70 struct ast_sip_transport_state {
71         /*! \brief Transport itself */
72         struct pjsip_transport *transport;
73         /*! \brief Transport factory */
74         struct pjsip_tpfactory *factory;
75         /*!
76          * Transport id
77          * \since 13.8.0
78          */
79         char *id;
80         /*!
81          * Transport type
82          * \since 13.8.0
83          */
84         enum ast_transport type;
85         /*!
86          * Address and port to bind to
87          * \since 13.8.0
88          */
89         pj_sockaddr host;
90         /*!
91          * TLS settings
92          * \since 13.8.0
93          */
94         pjsip_tls_setting tls;
95         /*!
96          * Configured TLS ciphers
97          * \since 13.8.0
98          */
99         pj_ssl_cipher ciphers[SIP_TLS_MAX_CIPHERS];
100         /*!
101          * Optional local network information, used for NAT purposes
102          * \since 13.8.0
103          */
104         struct ast_ha *localnet;
105         /*!
106          * DNS manager for refreshing the external address
107          * \since 13.8.0
108          */
109         struct ast_dnsmgr_entry *external_address_refresher;
110         /*!
111          * Optional external address information
112          * \since 13.8.0
113          */
114         struct ast_sockaddr external_address;
115 };
116
117 /*
118  * \brief Transport to bind to
119  */
120 struct ast_sip_transport {
121         /*! Sorcery object details */
122         SORCERY_OBJECT(details);
123         AST_DECLARE_STRING_FIELDS(
124                 /*! Certificate of authority list file */
125                 AST_STRING_FIELD(ca_list_file);
126                 /*! Certificate of authority list path */
127                 AST_STRING_FIELD(ca_list_path);
128                 /*! Public certificate file */
129                 AST_STRING_FIELD(cert_file);
130                 /*! Optional private key of the certificate file */
131                 AST_STRING_FIELD(privkey_file);
132                 /*! Password to open the private key */
133                 AST_STRING_FIELD(password);
134                 /*! External signaling address */
135                 AST_STRING_FIELD(external_signaling_address);
136                 /*! External media address */
137                 AST_STRING_FIELD(external_media_address);
138                 /*! Optional domain to use for messages if provided could not be found */
139                 AST_STRING_FIELD(domain);
140                 );
141         /*! Type of transport */
142         enum ast_transport type;
143         /*!
144          * \deprecated Moved to ast_sip_transport_state
145          * \version 13.8.0 deprecated
146          * Address and port to bind to
147          */
148         pj_sockaddr host;
149         /*! Number of simultaneous asynchronous operations */
150         unsigned int async_operations;
151         /*! Optional external port for signaling */
152         unsigned int external_signaling_port;
153         /*!
154          * \deprecated Moved to ast_sip_transport_state
155          * \version 13.7.1 deprecated
156          * TLS settings
157          */
158         pjsip_tls_setting tls;
159         /*!
160          * \deprecated Moved to ast_sip_transport_state
161          * \version 13.7.1 deprecated
162          * Configured TLS ciphers
163          */
164         pj_ssl_cipher ciphers[SIP_TLS_MAX_CIPHERS];
165         /*!
166          * \deprecated Moved to ast_sip_transport_state
167          * \version 13.7.1 deprecated
168          * Optional local network information, used for NAT purposes
169          */
170         struct ast_ha *localnet;
171         /*!
172          * \deprecated Moved to ast_sip_transport_state
173          * \version 13.7.1 deprecated
174          * DNS manager for refreshing the external address
175          */
176         struct ast_dnsmgr_entry *external_address_refresher;
177         /*!
178          * \deprecated Moved to ast_sip_transport_state
179          * \version 13.7.1 deprecated
180          * Optional external address information
181          */
182         struct ast_sockaddr external_address;
183         /*!
184          * \deprecated
185          * \version 13.7.1 deprecated
186          * Transport state information
187          */
188         struct ast_sip_transport_state *state;
189         /*! QOS DSCP TOS bits */
190         unsigned int tos;
191         /*! QOS COS value */
192         unsigned int cos;
193         /*! Write timeout */
194         int write_timeout;
195         /*! Allow reload */
196         int allow_reload;
197 };
198
199 #define SIP_SORCERY_DOMAIN_ALIAS_TYPE "domain_alias"
200
201 /*!
202  * Details about a SIP domain alias
203  */
204 struct ast_sip_domain_alias {
205         /*! Sorcery object details */
206         SORCERY_OBJECT(details);
207         AST_DECLARE_STRING_FIELDS(
208                 /*! Domain to be aliased to */
209                 AST_STRING_FIELD(domain);
210         );
211 };
212
213 /*!
214  * \brief Structure for SIP nat hook information
215  */
216 struct ast_sip_nat_hook {
217         /*! Sorcery object details */
218         SORCERY_OBJECT(details);
219         /*! Callback for when a message is going outside of our local network */
220         void (*outgoing_external_message)(struct pjsip_tx_data *tdata, struct ast_sip_transport *transport);
221 };
222
223 /*!
224  * \brief Contact associated with an address of record
225  */
226 struct ast_sip_contact {
227         /*! Sorcery object details, the id is the aor name plus a random string */
228         SORCERY_OBJECT(details);
229         AST_DECLARE_STRING_FIELDS(
230                 /*! Full URI of the contact */
231                 AST_STRING_FIELD(uri);
232                 /*! Outbound proxy to use for qualify */
233                 AST_STRING_FIELD(outbound_proxy);
234                 /*! Path information to place in Route headers */
235                 AST_STRING_FIELD(path);
236                 /*! Content of the User-Agent header in REGISTER request */
237                 AST_STRING_FIELD(user_agent);
238                 /*! The name of the aor this contact belongs to */
239                 AST_STRING_FIELD(aor);
240         );
241         /*! Absolute time that this contact is no longer valid after */
242         struct timeval expiration_time;
243         /*! Frequency to send OPTIONS requests to contact. 0 is disabled. */
244         unsigned int qualify_frequency;
245         /*! If true authenticate the qualify if needed */
246         int authenticate_qualify;
247         /*! Qualify timeout. 0 is diabled. */
248         double qualify_timeout;
249         /*! Endpoint that added the contact, only available in observers */
250         struct ast_sip_endpoint *endpoint;
251         /*! Asterisk Server name */
252         AST_STRING_FIELD_EXTENDED(reg_server);
253 };
254
255 #define CONTACT_STATUS "contact_status"
256
257 /*!
258  * \brief Status type for a contact.
259  */
260 enum ast_sip_contact_status_type {
261         UNAVAILABLE,
262         AVAILABLE,
263         UNKNOWN,
264         CREATED,
265         REMOVED,
266 };
267
268 /*!
269  * \brief A contact's status.
270  *
271  * \detail Maintains a contact's current status and round trip time
272  *         if available.
273  */
274 struct ast_sip_contact_status {
275         SORCERY_OBJECT(details);
276         AST_DECLARE_STRING_FIELDS(
277                 /*! The original contact's URI */
278                 AST_STRING_FIELD(uri);
279                 /*! The name of the aor this contact_status belongs to */
280                 AST_STRING_FIELD(aor);
281         );
282         /*! Current status for a contact (default - unavailable) */
283         enum ast_sip_contact_status_type status;
284         /*! The round trip start time set before sending a qualify request */
285         struct timeval rtt_start;
286         /*! The round trip time in microseconds */
287         int64_t rtt;
288         /*! Last status for a contact (default - unavailable) */
289         enum ast_sip_contact_status_type last_status;
290 };
291
292 /*!
293  * \brief A SIP address of record
294  */
295 struct ast_sip_aor {
296         /*! Sorcery object details, the id is the AOR name */
297         SORCERY_OBJECT(details);
298         AST_DECLARE_STRING_FIELDS(
299                 /*! Voicemail boxes for this AOR */
300                 AST_STRING_FIELD(mailboxes);
301                 /*! Outbound proxy for OPTIONS requests */
302                 AST_STRING_FIELD(outbound_proxy);
303         );
304         /*! Minimum expiration time */
305         unsigned int minimum_expiration;
306         /*! Maximum expiration time */
307         unsigned int maximum_expiration;
308         /*! Default contact expiration if one is not provided in the contact */
309         unsigned int default_expiration;
310         /*! Frequency to send OPTIONS requests to AOR contacts. 0 is disabled. */
311         unsigned int qualify_frequency;
312         /*! If true authenticate the qualify if needed */
313         int authenticate_qualify;
314         /*! Maximum number of external contacts, 0 to disable */
315         unsigned int max_contacts;
316         /*! Whether to remove any existing contacts not related to an incoming REGISTER when it comes in */
317         unsigned int remove_existing;
318         /*! Any permanent configured contacts */
319         struct ao2_container *permanent_contacts;
320         /*! Determines whether SIP Path headers are supported */
321         unsigned int support_path;
322         /*! Qualify timeout. 0 is diabled. */
323         double qualify_timeout;
324         /* Voicemail extension to set in Message-Account */
325         char *voicemail_extension;
326 };
327
328 /*!
329  * \brief A wrapper for contact that adds the aor_id and
330  * a consistent contact id.  Used by ast_sip_for_each_contact.
331  */
332 struct ast_sip_contact_wrapper {
333         /*! The id of the parent aor. */
334         char *aor_id;
335         /*! The id of contact in form of aor_id/contact_uri. */
336         char *contact_id;
337         /*! Pointer to the actual contact. */
338         struct ast_sip_contact *contact;
339 };
340
341 /*!
342  * \brief DTMF modes for SIP endpoints
343  */
344 enum ast_sip_dtmf_mode {
345         /*! No DTMF to be used */
346         AST_SIP_DTMF_NONE,
347         /* XXX Should this be 2833 instead? */
348         /*! Use RFC 4733 events for DTMF */
349         AST_SIP_DTMF_RFC_4733,
350         /*! Use DTMF in the audio stream */
351         AST_SIP_DTMF_INBAND,
352         /*! Use SIP INFO DTMF (blech) */
353         AST_SIP_DTMF_INFO,
354         /*! Use SIP 4733 if supported by the other side or INBAND if not */
355         AST_SIP_DTMF_AUTO,
356 };
357
358 /*!
359  * \brief Methods of storing SIP digest authentication credentials.
360  *
361  * Note that both methods result in MD5 digest authentication being
362  * used. The two methods simply alter how Asterisk determines the
363  * credentials for a SIP authentication
364  */
365 enum ast_sip_auth_type {
366         /*! Credentials stored as a username and password combination */
367         AST_SIP_AUTH_TYPE_USER_PASS,
368         /*! Credentials stored as an MD5 sum */
369         AST_SIP_AUTH_TYPE_MD5,
370         /*! Credentials not stored this is a fake auth */
371         AST_SIP_AUTH_TYPE_ARTIFICIAL
372 };
373
374 #define SIP_SORCERY_AUTH_TYPE "auth"
375
376 struct ast_sip_auth {
377         /*! Sorcery ID of the auth is its name */
378         SORCERY_OBJECT(details);
379         AST_DECLARE_STRING_FIELDS(
380                 /*! Identification for these credentials */
381                 AST_STRING_FIELD(realm);
382                 /*! Authentication username */
383                 AST_STRING_FIELD(auth_user);
384                 /*! Authentication password */
385                 AST_STRING_FIELD(auth_pass);
386                 /*! Authentication credentials in MD5 format (hash of user:realm:pass) */
387                 AST_STRING_FIELD(md5_creds);
388         );
389         /*! The time period (in seconds) that a nonce may be reused */
390         unsigned int nonce_lifetime;
391         /*! Used to determine what to use when authenticating */
392         enum ast_sip_auth_type type;
393 };
394
395 AST_VECTOR(ast_sip_auth_vector, const char *);
396
397 /*!
398  * \brief Different methods by which incoming requests can be matched to endpoints
399  */
400 enum ast_sip_endpoint_identifier_type {
401         /*! Identify based on user name in From header */
402         AST_SIP_ENDPOINT_IDENTIFY_BY_USERNAME = (1 << 0),
403         /*! Identify based on user name in Auth header first, then From header */
404         AST_SIP_ENDPOINT_IDENTIFY_BY_AUTH_USERNAME = (1 << 1),
405 };
406 AST_VECTOR(ast_sip_identify_by_vector, enum ast_sip_endpoint_identifier_type);
407
408 enum ast_sip_session_refresh_method {
409         /*! Use reinvite to negotiate direct media */
410         AST_SIP_SESSION_REFRESH_METHOD_INVITE,
411         /*! Use UPDATE to negotiate direct media */
412         AST_SIP_SESSION_REFRESH_METHOD_UPDATE,
413 };
414
415 enum ast_sip_direct_media_glare_mitigation {
416         /*! Take no special action to mitigate reinvite glare */
417         AST_SIP_DIRECT_MEDIA_GLARE_MITIGATION_NONE,
418         /*! Do not send an initial direct media session refresh on outgoing call legs
419          * Subsequent session refreshes will be sent no matter the session direction
420          */
421         AST_SIP_DIRECT_MEDIA_GLARE_MITIGATION_OUTGOING,
422         /*! Do not send an initial direct media session refresh on incoming call legs
423          * Subsequent session refreshes will be sent no matter the session direction
424          */
425         AST_SIP_DIRECT_MEDIA_GLARE_MITIGATION_INCOMING,
426 };
427
428 enum ast_sip_session_media_encryption {
429         /*! Invalid media encryption configuration */
430         AST_SIP_MEDIA_TRANSPORT_INVALID = 0,
431         /*! Do not allow any encryption of session media */
432         AST_SIP_MEDIA_ENCRYPT_NONE,
433         /*! Offer SDES-encrypted session media */
434         AST_SIP_MEDIA_ENCRYPT_SDES,
435         /*! Offer encrypted session media with datagram TLS key exchange */
436         AST_SIP_MEDIA_ENCRYPT_DTLS,
437 };
438
439 enum ast_sip_session_redirect {
440         /*! User portion of the target URI should be used as the target in the dialplan */
441         AST_SIP_REDIRECT_USER = 0,
442         /*! Target URI should be used as the target in the dialplan */
443         AST_SIP_REDIRECT_URI_CORE,
444         /*! Target URI should be used as the target within chan_pjsip itself */
445         AST_SIP_REDIRECT_URI_PJSIP,
446 };
447
448 /*!
449  * \brief Session timers options
450  */
451 struct ast_sip_timer_options {
452         /*! Minimum session expiration period, in seconds */
453         unsigned int min_se;
454         /*! Session expiration period, in seconds */
455         unsigned int sess_expires;
456 };
457
458 /*!
459  * \brief Endpoint configuration for SIP extensions.
460  *
461  * SIP extensions, in this case refers to features
462  * indicated in Supported or Required headers.
463  */
464 struct ast_sip_endpoint_extensions {
465         /*! Enabled SIP extensions */
466         unsigned int flags;
467         /*! Timer options */
468         struct ast_sip_timer_options timer;
469 };
470
471 /*!
472  * \brief Endpoint configuration for unsolicited MWI
473  */
474 struct ast_sip_mwi_configuration {
475         AST_DECLARE_STRING_FIELDS(
476                 /*! Configured voicemail boxes for this endpoint. Used for MWI */
477                 AST_STRING_FIELD(mailboxes);
478                 /*! Username to use when sending MWI NOTIFYs to this endpoint */
479                 AST_STRING_FIELD(fromuser);
480         );
481         /* Should mailbox states be combined into a single notification? */
482         unsigned int aggregate;
483         /* Should a subscribe replace unsolicited notifies? */
484         unsigned int subscribe_replaces_unsolicited;
485         /* Voicemail extension to set in Message-Account */
486         char *voicemail_extension;
487 };
488
489 /*!
490  * \brief Endpoint subscription configuration
491  */
492 struct ast_sip_endpoint_subscription_configuration {
493         /*! Indicates if endpoint is allowed to initiate subscriptions */
494         unsigned int allow;
495         /*! The minimum allowed expiration for subscriptions from endpoint */
496         unsigned int minexpiry;
497         /*! Message waiting configuration */
498         struct ast_sip_mwi_configuration mwi;
499 };
500
501 /*!
502  * \brief NAT configuration options for endpoints
503  */
504 struct ast_sip_endpoint_nat_configuration {
505         /*! Whether to force using the source IP address/port for sending responses */
506         unsigned int force_rport;
507         /*! Whether to rewrite the Contact header with the source IP address/port or not */
508         unsigned int rewrite_contact;
509 };
510
511 /*!
512  * \brief Party identification options for endpoints
513  *
514  * This includes caller ID, connected line, and redirecting-related options
515  */
516 struct ast_sip_endpoint_id_configuration {
517         struct ast_party_id self;
518         /*! Do we accept identification information from this endpoint */
519         unsigned int trust_inbound;
520         /*! Do we send private identification information to this endpoint? */
521         unsigned int trust_outbound;
522         /*! Do we send P-Asserted-Identity headers to this endpoint? */
523         unsigned int send_pai;
524         /*! Do we send Remote-Party-ID headers to this endpoint? */
525         unsigned int send_rpid;
526         /*! Do we send messages for connected line updates for unanswered incoming calls immediately to this endpoint? */
527         unsigned int rpid_immediate;
528         /*! Do we add Diversion headers to applicable outgoing requests/responses? */
529         unsigned int send_diversion;
530         /*! When performing connected line update, which method should be used */
531         enum ast_sip_session_refresh_method refresh_method;
532 };
533
534 /*!
535  * \brief Call pickup configuration options for endpoints
536  */
537 struct ast_sip_endpoint_pickup_configuration {
538         /*! Call group */
539         ast_group_t callgroup;
540         /*! Pickup group */
541         ast_group_t pickupgroup;
542         /*! Named call group */
543         struct ast_namedgroups *named_callgroups;
544         /*! Named pickup group */
545         struct ast_namedgroups *named_pickupgroups;
546 };
547
548 /*!
549  * \brief Configuration for one-touch INFO recording
550  */
551 struct ast_sip_info_recording_configuration {
552         AST_DECLARE_STRING_FIELDS(
553                 /*! Feature to enact when one-touch recording INFO with Record: On is received */
554                 AST_STRING_FIELD(onfeature);
555                 /*! Feature to enact when one-touch recording INFO with Record: Off is received */
556                 AST_STRING_FIELD(offfeature);
557         );
558         /*! Is one-touch recording permitted? */
559         unsigned int enabled;
560 };
561
562 /*!
563  * \brief Endpoint configuration options for INFO packages
564  */
565 struct ast_sip_endpoint_info_configuration {
566         /*! Configuration for one-touch recording */
567         struct ast_sip_info_recording_configuration recording;
568 };
569
570 /*!
571  * \brief RTP configuration for SIP endpoints
572  */
573 struct ast_sip_media_rtp_configuration {
574         AST_DECLARE_STRING_FIELDS(
575                 /*! Configured RTP engine for this endpoint. */
576                 AST_STRING_FIELD(engine);
577         );
578         /*! Whether IPv6 RTP is enabled or not */
579         unsigned int ipv6;
580         /*! Whether symmetric RTP is enabled or not */
581         unsigned int symmetric;
582         /*! Whether ICE support is enabled or not */
583         unsigned int ice_support;
584         /*! Whether to use the "ptime" attribute received from the endpoint or not */
585         unsigned int use_ptime;
586         /*! Do we use AVPF exclusively for this endpoint? */
587         unsigned int use_avpf;
588         /*! Do we force AVP, AVPF, SAVP, or SAVPF even for DTLS media streams? */
589         unsigned int force_avp;
590         /*! Do we use the received media transport in our answer SDP */
591         unsigned int use_received_transport;
592         /*! \brief DTLS-SRTP configuration information */
593         struct ast_rtp_dtls_cfg dtls_cfg;
594         /*! Should SRTP use a 32 byte tag instead of an 80 byte tag? */
595         unsigned int srtp_tag_32;
596         /*! Do we use media encryption? what type? */
597         enum ast_sip_session_media_encryption encryption;
598         /*! Do we want to optimistically support encryption if possible? */
599         unsigned int encryption_optimistic;
600         /*! Number of seconds between RTP keepalive packets */
601         unsigned int keepalive;
602         /*! Number of seconds before terminating channel due to lack of RTP (when not on hold) */
603         unsigned int timeout;
604         /*! Number of seconds before terminating channel due to lack of RTP (when on hold) */
605         unsigned int timeout_hold;
606 };
607
608 /*!
609  * \brief Direct media options for SIP endpoints
610  */
611 struct ast_sip_direct_media_configuration {
612         /*! Boolean indicating if direct_media is permissible */
613         unsigned int enabled;
614         /*! When using direct media, which method should be used */
615         enum ast_sip_session_refresh_method method;
616         /*! Take steps to mitigate glare for direct media */
617         enum ast_sip_direct_media_glare_mitigation glare_mitigation;
618         /*! Do not attempt direct media session refreshes if a media NAT is detected */
619         unsigned int disable_on_nat;
620 };
621
622 struct ast_sip_t38_configuration {
623         /*! Whether T.38 UDPTL support is enabled or not */
624         unsigned int enabled;
625         /*! Error correction setting for T.38 UDPTL */
626         enum ast_t38_ec_modes error_correction;
627         /*! Explicit T.38 max datagram value, may be 0 to indicate the remote side can be trusted */
628         unsigned int maxdatagram;
629         /*! Whether NAT Support is enabled for T.38 UDPTL sessions or not */
630         unsigned int nat;
631         /*! Whether to use IPv6 for UDPTL or not */
632         unsigned int ipv6;
633 };
634
635 /*!
636  * \brief Media configuration for SIP endpoints
637  */
638 struct ast_sip_endpoint_media_configuration {
639         AST_DECLARE_STRING_FIELDS(
640                 /*! Optional media address to use in SDP */
641                 AST_STRING_FIELD(address);
642                 /*! SDP origin username */
643                 AST_STRING_FIELD(sdpowner);
644                 /*! SDP session name */
645                 AST_STRING_FIELD(sdpsession);
646         );
647         /*! RTP media configuration */
648         struct ast_sip_media_rtp_configuration rtp;
649         /*! Direct media options */
650         struct ast_sip_direct_media_configuration direct_media;
651         /*! T.38 (FoIP) options */
652         struct ast_sip_t38_configuration t38;
653         /*! Configured codecs */
654         struct ast_format_cap *codecs;
655         /*! DSCP TOS bits for audio streams */
656         unsigned int tos_audio;
657         /*! Priority for audio streams */
658         unsigned int cos_audio;
659         /*! DSCP TOS bits for video streams */
660         unsigned int tos_video;
661         /*! Priority for video streams */
662         unsigned int cos_video;
663         /*! Is g.726 packed in a non standard way */
664         unsigned int g726_non_standard;
665         /*! Bind the RTP instance to the media_address */
666         unsigned int bind_rtp_to_media_address;
667 };
668
669 /*!
670  * \brief An entity with which Asterisk communicates
671  */
672 struct ast_sip_endpoint {
673         SORCERY_OBJECT(details);
674         AST_DECLARE_STRING_FIELDS(
675                 /*! Context to send incoming calls to */
676                 AST_STRING_FIELD(context);
677                 /*! Name of an explicit transport to use */
678                 AST_STRING_FIELD(transport);
679                 /*! Outbound proxy to use */
680                 AST_STRING_FIELD(outbound_proxy);
681                 /*! Explicit AORs to dial if none are specified */
682                 AST_STRING_FIELD(aors);
683                 /*! Musiconhold class to suggest that the other side use when placing on hold */
684                 AST_STRING_FIELD(mohsuggest);
685                 /*! Configured tone zone for this endpoint. */
686                 AST_STRING_FIELD(zone);
687                 /*! Configured language for this endpoint. */
688                 AST_STRING_FIELD(language);
689                 /*! Default username to place in From header */
690                 AST_STRING_FIELD(fromuser);
691                 /*! Domain to place in From header */
692                 AST_STRING_FIELD(fromdomain);
693                 /*! Context to route incoming MESSAGE requests to */
694                 AST_STRING_FIELD(message_context);
695                 /*! Accountcode to auto-set on channels */
696                 AST_STRING_FIELD(accountcode);
697         );
698         /*! Configuration for extensions */
699         struct ast_sip_endpoint_extensions extensions;
700         /*! Configuration relating to media */
701         struct ast_sip_endpoint_media_configuration media;
702         /*! SUBSCRIBE/NOTIFY configuration options */
703         struct ast_sip_endpoint_subscription_configuration subscription;
704         /*! NAT configuration */
705         struct ast_sip_endpoint_nat_configuration nat;
706         /*! Party identification options */
707         struct ast_sip_endpoint_id_configuration id;
708         /*! Configuration options for INFO packages */
709         struct ast_sip_endpoint_info_configuration info;
710         /*! Call pickup configuration */
711         struct ast_sip_endpoint_pickup_configuration pickup;
712         /*! Inbound authentication credentials */
713         struct ast_sip_auth_vector inbound_auths;
714         /*! Outbound authentication credentials */
715         struct ast_sip_auth_vector outbound_auths;
716         /*! DTMF mode to use with this endpoint */
717         enum ast_sip_dtmf_mode dtmf;
718         /*! Method(s) by which the endpoint should be identified. */
719         enum ast_sip_endpoint_identifier_type ident_method;
720         /*! Order of the method(s) by which the endpoint should be identified. */
721         struct ast_sip_identify_by_vector ident_method_order;
722         /*! Boolean indicating if ringing should be sent as inband progress */
723         unsigned int inband_progress;
724         /*! Pointer to the persistent Asterisk endpoint */
725         struct ast_endpoint *persistent;
726         /*! The number of channels at which busy device state is returned */
727         unsigned int devicestate_busy_at;
728         /*! Whether fax detection is enabled or not (CNG tone detection) */
729         unsigned int faxdetect;
730         /*! Determines if transfers (using REFER) are allowed by this endpoint */
731         unsigned int allowtransfer;
732         /*! Method used when handling redirects */
733         enum ast_sip_session_redirect redirect_method;
734         /*! Variables set on channel creation */
735         struct ast_variable *channel_vars;
736         /*! Whether to place a 'user=phone' parameter into the request URI if user is a number */
737         unsigned int usereqphone;
738         /*! Whether to pass through hold and unhold using re-invites with recvonly and sendrecv */
739         unsigned int moh_passthrough;
740 };
741
742 /*!
743  * \brief Initialize an auth vector with the configured values.
744  *
745  * \param vector Vector to initialize
746  * \param auth_names Comma-separated list of names to set in the array
747  * \retval 0 Success
748  * \retval non-zero Failure
749  */
750 int ast_sip_auth_vector_init(struct ast_sip_auth_vector *vector, const char *auth_names);
751
752 /*!
753  * \brief Free contents of an auth vector.
754  *
755  * \param array Vector whose contents are to be freed
756  */
757 void ast_sip_auth_vector_destroy(struct ast_sip_auth_vector *vector);
758
759 /*!
760  * \brief Possible returns from ast_sip_check_authentication
761  */
762 enum ast_sip_check_auth_result {
763     /*! Authentication needs to be challenged */
764     AST_SIP_AUTHENTICATION_CHALLENGE,
765     /*! Authentication succeeded */
766     AST_SIP_AUTHENTICATION_SUCCESS,
767     /*! Authentication failed */
768     AST_SIP_AUTHENTICATION_FAILED,
769     /*! Authentication encountered some internal error */
770     AST_SIP_AUTHENTICATION_ERROR,
771 };
772
773 /*!
774  * \brief An interchangeable way of handling digest authentication for SIP.
775  *
776  * An authenticator is responsible for filling in the callbacks provided below. Each is called from a publicly available
777  * function in res_sip. The authenticator can use configuration or other local policy to determine whether authentication
778  * should take place and what credentials should be used when challenging and authenticating a request.
779  */
780 struct ast_sip_authenticator {
781     /*!
782      * \brief Check if a request requires authentication
783      * See ast_sip_requires_authentication for more details
784      */
785     int (*requires_authentication)(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata);
786         /*!
787          * \brief Check that an incoming request passes authentication.
788          *
789          * The tdata parameter is useful for adding information such as digest challenges.
790          *
791          * \param endpoint The endpoint sending the incoming request
792          * \param rdata The incoming request
793          * \param tdata Tentative outgoing request.
794          */
795         enum ast_sip_check_auth_result (*check_authentication)(struct ast_sip_endpoint *endpoint,
796                         pjsip_rx_data *rdata, pjsip_tx_data *tdata);
797 };
798
799 /*!
800  * \brief an interchangeable way of responding to authentication challenges
801  *
802  * An outbound authenticator takes incoming challenges and formulates a new SIP request with
803  * credentials.
804  */
805 struct ast_sip_outbound_authenticator {
806         /*!
807          * \brief Create a new request with authentication credentials
808          *
809          * \param auths A vector of IDs of auth sorcery objects
810          * \param challenge The SIP response with authentication challenge(s)
811          * \param old_request The request that received the auth challenge(s)
812          * \param new_request The new SIP request with challenge response(s)
813          * \retval 0 Successfully created new request
814          * \retval -1 Failed to create a new request
815          */
816         int (*create_request_with_auth)(const struct ast_sip_auth_vector *auths, struct pjsip_rx_data *challenge,
817                         struct pjsip_tx_data *old_request, struct pjsip_tx_data **new_request);
818 };
819
820 /*!
821  * \brief An entity responsible for identifying the source of a SIP message
822  */
823 struct ast_sip_endpoint_identifier {
824     /*!
825      * \brief Callback used to identify the source of a message.
826      * See ast_sip_identify_endpoint for more details
827      */
828     struct ast_sip_endpoint *(*identify_endpoint)(pjsip_rx_data *rdata);
829 };
830
831 /*!
832  * \brief Register a SIP service in Asterisk.
833  *
834  * This is more-or-less a wrapper around pjsip_endpt_register_module().
835  * Registering a service makes it so that PJSIP will call into the
836  * service at appropriate times. For more information about PJSIP module
837  * callbacks, see the PJSIP documentation. Asterisk modules that call
838  * this function will likely do so at module load time.
839  *
840  * \param module The module that is to be registered with PJSIP
841  * \retval 0 Success
842  * \retval -1 Failure
843  */
844 int ast_sip_register_service(pjsip_module *module);
845
846 /*!
847  * This is the opposite of ast_sip_register_service().  Unregistering a
848  * service means that PJSIP will no longer call into the module any more.
849  * This will likely occur when an Asterisk module is unloaded.
850  *
851  * \param module The PJSIP module to unregister
852  */
853 void ast_sip_unregister_service(pjsip_module *module);
854
855 /*!
856  * \brief Register a SIP authenticator
857  *
858  * An authenticator has three main purposes:
859  * 1) Determining if authentication should be performed on an incoming request
860  * 2) Gathering credentials necessary for issuing an authentication challenge
861  * 3) Authenticating a request that has credentials
862  *
863  * Asterisk provides a default authenticator, but it may be replaced by a
864  * custom one if desired.
865  *
866  * \param auth The authenticator to register
867  * \retval 0 Success
868  * \retval -1 Failure
869  */
870 int ast_sip_register_authenticator(struct ast_sip_authenticator *auth);
871
872 /*!
873  * \brief Unregister a SIP authenticator
874  *
875  * When there is no authenticator registered, requests cannot be challenged
876  * or authenticated.
877  *
878  * \param auth The authenticator to unregister
879  */
880 void ast_sip_unregister_authenticator(struct ast_sip_authenticator *auth);
881
882  /*!
883  * \brief Register an outbound SIP authenticator
884  *
885  * An outbound authenticator is responsible for creating responses to
886  * authentication challenges by remote endpoints.
887  *
888  * \param auth The authenticator to register
889  * \retval 0 Success
890  * \retval -1 Failure
891  */
892 int ast_sip_register_outbound_authenticator(struct ast_sip_outbound_authenticator *outbound_auth);
893
894 /*!
895  * \brief Unregister an outbound SIP authenticator
896  *
897  * When there is no outbound authenticator registered, authentication challenges
898  * will be handled as any other final response would be.
899  *
900  * \param auth The authenticator to unregister
901  */
902 void ast_sip_unregister_outbound_authenticator(struct ast_sip_outbound_authenticator *auth);
903
904 /*!
905  * \brief Register a SIP endpoint identifier with a name.
906  *
907  * An endpoint identifier's purpose is to determine which endpoint a given SIP
908  * message has come from.
909  *
910  * Multiple endpoint identifiers may be registered so that if an endpoint
911  * cannot be identified by one identifier, it may be identified by another.
912  *
913  * \param identifier The SIP endpoint identifier to register
914  * \param name The name of the endpoint identifier
915  * \retval 0 Success
916  * \retval -1 Failure
917  */
918 int ast_sip_register_endpoint_identifier_with_name(struct ast_sip_endpoint_identifier *identifier,
919                                                    const char *name);
920
921 /*!
922  * \brief Register a SIP endpoint identifier
923  *
924  * An endpoint identifier's purpose is to determine which endpoint a given SIP
925  * message has come from.
926  *
927  * Multiple endpoint identifiers may be registered so that if an endpoint
928  * cannot be identified by one identifier, it may be identified by another.
929  *
930  * Asterisk provides two endpoint identifiers. One identifies endpoints based
931  * on the user part of the From header URI. The other identifies endpoints based
932  * on the source IP address.
933  *
934  * If the order in which endpoint identifiers is run is important to you, then
935  * be sure to load individual endpoint identifier modules in the order you wish
936  * for them to be run in modules.conf
937  *
938  * \note endpoint identifiers registered using this method (no name specified)
939  *       are placed at the front of the endpoint identifiers list ahead of any
940  *       named identifiers.
941  *
942  * \param identifier The SIP endpoint identifier to register
943  * \retval 0 Success
944  * \retval -1 Failure
945  */
946 int ast_sip_register_endpoint_identifier(struct ast_sip_endpoint_identifier *identifier);
947
948 /*!
949  * \brief Unregister a SIP endpoint identifier
950  *
951  * This stops an endpoint identifier from being used.
952  *
953  * \param identifier The SIP endoint identifier to unregister
954  */
955 void ast_sip_unregister_endpoint_identifier(struct ast_sip_endpoint_identifier *identifier);
956
957 /*!
958  * \brief Allocate a new SIP endpoint
959  *
960  * This will return an endpoint with its refcount increased by one. This reference
961  * can be released using ao2_ref().
962  *
963  * \param name The name of the endpoint.
964  * \retval NULL Endpoint allocation failed
965  * \retval non-NULL The newly allocated endpoint
966  */
967 void *ast_sip_endpoint_alloc(const char *name);
968
969 /*!
970  * \brief Get a pointer to the PJSIP endpoint.
971  *
972  * This is useful when modules have specific information they need
973  * to register with the PJSIP core.
974  * \retval NULL endpoint has not been created yet.
975  * \retval non-NULL PJSIP endpoint.
976  */
977 pjsip_endpoint *ast_sip_get_pjsip_endpoint(void);
978
979 /*!
980  * \brief Get a pointer to the SIP sorcery structure.
981  *
982  * \retval NULL sorcery has not been initialized
983  * \retval non-NULL sorcery structure
984  */
985 struct ast_sorcery *ast_sip_get_sorcery(void);
986
987 /*!
988  * \brief Retrieve a named AOR
989  *
990  * \param aor_name Name of the AOR
991  *
992  * \retval NULL if not found
993  * \retval non-NULL if found
994  */
995 struct ast_sip_aor *ast_sip_location_retrieve_aor(const char *aor_name);
996
997 /*!
998  * \brief Retrieve the first bound contact for an AOR
999  *
1000  * \param aor Pointer to the AOR
1001  * \retval NULL if no contacts available
1002  * \retval non-NULL if contacts available
1003  */
1004 struct ast_sip_contact *ast_sip_location_retrieve_first_aor_contact(const struct ast_sip_aor *aor);
1005
1006 /*!
1007  * \brief Retrieve all contacts currently available for an AOR
1008  *
1009  * \param aor Pointer to the AOR
1010  *
1011  * \retval NULL if no contacts available
1012  * \retval non-NULL if contacts available
1013  *
1014  * \warning
1015  * Since this function prunes expired contacts before returning, it holds a named write
1016  * lock on the aor.  If you already hold the lock, call ast_sip_location_retrieve_aor_contacts_nolock instead.
1017  */
1018 struct ao2_container *ast_sip_location_retrieve_aor_contacts(const struct ast_sip_aor *aor);
1019
1020 /*!
1021  * \brief Retrieve all contacts currently available for an AOR without locking the AOR
1022  * \since 13.9.0
1023  *
1024  * \param aor Pointer to the AOR
1025  *
1026  * \retval NULL if no contacts available
1027  * \retval non-NULL if contacts available
1028  *
1029  * \warning
1030  * This function should only be called if you already hold a named write lock on the aor.
1031  */
1032 struct ao2_container *ast_sip_location_retrieve_aor_contacts_nolock(const struct ast_sip_aor *aor);
1033
1034 /*!
1035  * \brief Retrieve the first bound contact from a list of AORs
1036  *
1037  * \param aor_list A comma-separated list of AOR names
1038  * \retval NULL if no contacts available
1039  * \retval non-NULL if contacts available
1040  */
1041 struct ast_sip_contact *ast_sip_location_retrieve_contact_from_aor_list(const char *aor_list);
1042
1043 /*!
1044  * \brief Retrieve all contacts from a list of AORs
1045  *
1046  * \param aor_list A comma-separated list of AOR names
1047  * \retval NULL if no contacts available
1048  * \retval non-NULL container (which must be freed) if contacts available
1049  */
1050 struct ao2_container *ast_sip_location_retrieve_contacts_from_aor_list(const char *aor_list);
1051
1052 /*!
1053  * \brief Retrieve the first bound contact AND the AOR chosen from a list of AORs
1054  *
1055  * \param aor_list A comma-separated list of AOR names
1056  * \param aor The chosen AOR
1057  * \param contact The chosen contact
1058  */
1059  void ast_sip_location_retrieve_contact_and_aor_from_list(const char *aor_list, struct ast_sip_aor **aor,
1060         struct ast_sip_contact **contact);
1061
1062 /*!
1063  * \brief Retrieve a named contact
1064  *
1065  * \param contact_name Name of the contact
1066  *
1067  * \retval NULL if not found
1068  * \retval non-NULL if found
1069  */
1070 struct ast_sip_contact *ast_sip_location_retrieve_contact(const char *contact_name);
1071
1072 /*!
1073  * \brief Add a new contact to an AOR
1074  *
1075  * \param aor Pointer to the AOR
1076  * \param uri Full contact URI
1077  * \param expiration_time Optional expiration time of the contact
1078  * \param path_info Path information
1079  * \param user_agent User-Agent header from REGISTER request
1080  * \param endpoint The endpoint that resulted in the contact being added
1081  *
1082  * \retval -1 failure
1083  * \retval 0 success
1084  *
1085  * \warning
1086  * This function holds a named write lock on the aor.  If you already hold the lock
1087  * you should call ast_sip_location_add_contact_nolock instead.
1088  */
1089 int ast_sip_location_add_contact(struct ast_sip_aor *aor, const char *uri,
1090         struct timeval expiration_time, const char *path_info, const char *user_agent,
1091         struct ast_sip_endpoint *endpoint);
1092
1093 /*!
1094  * \brief Add a new contact to an AOR without locking the AOR
1095  * \since 13.9.0
1096  *
1097  * \param aor Pointer to the AOR
1098  * \param uri Full contact URI
1099  * \param expiration_time Optional expiration time of the contact
1100  * \param path_info Path information
1101  * \param user_agent User-Agent header from REGISTER request
1102  * \param endpoint The endpoint that resulted in the contact being added
1103  *
1104  * \retval -1 failure
1105  * \retval 0 success
1106  *
1107  * \warning
1108  * This function should only be called if you already hold a named write lock on the aor.
1109  */
1110 int ast_sip_location_add_contact_nolock(struct ast_sip_aor *aor, const char *uri,
1111         struct timeval expiration_time, const char *path_info, const char *user_agent,
1112         struct ast_sip_endpoint *endpoint);
1113
1114 /*!
1115  * \brief Update a contact
1116  *
1117  * \param contact New contact object with details
1118  *
1119  * \retval -1 failure
1120  * \retval 0 success
1121  */
1122 int ast_sip_location_update_contact(struct ast_sip_contact *contact);
1123
1124 /*!
1125 * \brief Delete a contact
1126 *
1127 * \param contact Contact object to delete
1128 *
1129 * \retval -1 failure
1130 * \retval 0 success
1131 */
1132 int ast_sip_location_delete_contact(struct ast_sip_contact *contact);
1133
1134 /*!
1135  * \brief Callback called when an outbound request with authentication credentials is to be sent in dialog
1136  *
1137  * This callback will have the created request on it. The callback's purpose is to do any extra
1138  * housekeeping that needs to be done as well as to send the request out.
1139  *
1140  * This callback is only necessary if working with a PJSIP API that sits between the application
1141  * and the dialog layer.
1142  *
1143  * \param dlg The dialog to which the request belongs
1144  * \param tdata The created request to be sent out
1145  * \param user_data Data supplied with the callback
1146  *
1147  * \retval 0 Success
1148  * \retval -1 Failure
1149  */
1150 typedef int (*ast_sip_dialog_outbound_auth_cb)(pjsip_dialog *dlg, pjsip_tx_data *tdata, void *user_data);
1151
1152 /*!
1153  * \brief Set up outbound authentication on a SIP dialog
1154  *
1155  * This sets up the infrastructure so that all requests associated with a created dialog
1156  * can be re-sent with authentication credentials if the original request is challenged.
1157  *
1158  * \param dlg The dialog on which requests will be authenticated
1159  * \param endpoint The endpoint whom this dialog pertains to
1160  * \param cb Callback to call to send requests with authentication
1161  * \param user_data Data to be provided to the callback when it is called
1162  *
1163  * \retval 0 Success
1164  * \retval -1 Failure
1165  */
1166 int ast_sip_dialog_setup_outbound_authentication(pjsip_dialog *dlg, const struct ast_sip_endpoint *endpoint,
1167                 ast_sip_dialog_outbound_auth_cb cb, void *user_data);
1168
1169 /*!
1170  * \brief Retrieves a reference to the artificial auth.
1171  *
1172  * \retval The artificial auth
1173  */
1174 struct ast_sip_auth *ast_sip_get_artificial_auth(void);
1175
1176 /*!
1177  * \brief Retrieves a reference to the artificial endpoint.
1178  *
1179  * \retval The artificial endpoint
1180  */
1181 struct ast_sip_endpoint *ast_sip_get_artificial_endpoint(void);
1182
1183 /*! \defgroup pjsip_threading PJSIP Threading Model
1184  * @{
1185  * \page PJSIP PJSIP Threading Model
1186  *
1187  * There are three major types of threads that SIP will have to deal with:
1188  * \li Asterisk threads
1189  * \li PJSIP threads
1190  * \li SIP threadpool threads (a.k.a. "servants")
1191  *
1192  * \par Asterisk Threads
1193  *
1194  * Asterisk threads are those that originate from outside of SIP but within
1195  * Asterisk. The most common of these threads are PBX (channel) threads and
1196  * the autoservice thread. Most interaction with these threads will be through
1197  * channel technology callbacks. Within these threads, it is fine to handle
1198  * Asterisk data from outside of SIP, but any handling of SIP data should be
1199  * left to servants, \b especially if you wish to call into PJSIP for anything.
1200  * Asterisk threads are not registered with PJLIB, so attempting to call into
1201  * PJSIP will cause an assertion to be triggered, thus causing the program to
1202  * crash.
1203  *
1204  * \par PJSIP Threads
1205  *
1206  * PJSIP threads are those that originate from handling of PJSIP events, such
1207  * as an incoming SIP request or response, or a transaction timeout. The role
1208  * of these threads is to process information as quickly as possible so that
1209  * the next item on the SIP socket(s) can be serviced. On incoming messages,
1210  * Asterisk automatically will push the request to a servant thread. When your
1211  * module callback is called, processing will already be in a servant. However,
1212  * for other PSJIP events, such as transaction state changes due to timer
1213  * expirations, your module will be called into from a PJSIP thread. If you
1214  * are called into from a PJSIP thread, then you should push whatever processing
1215  * is needed to a servant as soon as possible. You can discern if you are currently
1216  * in a SIP servant thread using the \ref ast_sip_thread_is_servant function.
1217  *
1218  * \par Servants
1219  *
1220  * Servants are where the bulk of SIP work should be performed. These threads
1221  * exist in order to do the work that Asterisk threads and PJSIP threads hand
1222  * off to them. Servant threads register themselves with PJLIB, meaning that
1223  * they are capable of calling PJSIP and PJLIB functions if they wish.
1224  *
1225  * \par Serializer
1226  *
1227  * Tasks are handed off to servant threads using the API call \ref ast_sip_push_task.
1228  * The first parameter of this call is a serializer. If this pointer
1229  * is NULL, then the work will be handed off to whatever servant can currently handle
1230  * the task. If this pointer is non-NULL, then the task will not be executed until
1231  * previous tasks pushed with the same serializer have completed. For more information
1232  * on serializers and the benefits they provide, see \ref ast_threadpool_serializer
1233  *
1234  * \par Scheduler
1235  *
1236  * Some situations require that a task run periodically or at a future time.  Normally
1237  * the ast_sched functionality would be used but ast_sched only uses 1 thread for all
1238  * tasks and that thread isn't registered with PJLIB and therefore can't do any PJSIP
1239  * related work.
1240  *
1241  * ast_sip_sched uses ast_sched only as a scheduled queue.  When a task is ready to run,
1242  * it's pushed to a Serializer to be invoked asynchronously by a Servant.  This ensures
1243  * that the task is executed in a PJLIB registered thread and allows the ast_sched thread
1244  * to immediately continue processing the queue.  The Serializer used by ast_sip_sched
1245  * is one of your choosing or a random one from the res_pjsip pool if you don't choose one.
1246  *
1247  * \note
1248  *
1249  * Do not make assumptions about individual threads based on a corresponding serializer.
1250  * In other words, just because several tasks use the same serializer when being pushed
1251  * to servants, it does not mean that the same thread is necessarily going to execute those
1252  * tasks, even though they are all guaranteed to be executed in sequence.
1253  */
1254
1255 typedef int (*ast_sip_task)(void *user_data);
1256
1257 /*!
1258  * \brief Create a new serializer for SIP tasks
1259  * \since 13.8.0
1260  *
1261  * See \ref ast_threadpool_serializer for more information on serializers.
1262  * SIP creates serializers so that tasks operating on similar data will run
1263  * in sequence.
1264  *
1265  * \param name Name of the serializer. (must be unique)
1266  *
1267  * \retval NULL Failure
1268  * \retval non-NULL Newly-created serializer
1269  */
1270 struct ast_taskprocessor *ast_sip_create_serializer(const char *name);
1271
1272 struct ast_serializer_shutdown_group;
1273
1274 /*!
1275  * \brief Create a new serializer for SIP tasks
1276  * \since 13.8.0
1277  *
1278  * See \ref ast_threadpool_serializer for more information on serializers.
1279  * SIP creates serializers so that tasks operating on similar data will run
1280  * in sequence.
1281  *
1282  * \param name Name of the serializer. (must be unique)
1283  * \param shutdown_group Group shutdown controller. (NULL if no group association)
1284  *
1285  * \retval NULL Failure
1286  * \retval non-NULL Newly-created serializer
1287  */
1288 struct ast_taskprocessor *ast_sip_create_serializer_group(const char *name, struct ast_serializer_shutdown_group *shutdown_group);
1289
1290 /*!
1291  * \brief Set a serializer on a SIP dialog so requests and responses are automatically serialized
1292  *
1293  * Passing a NULL serializer is a way to remove a serializer from a dialog.
1294  *
1295  * \param dlg The SIP dialog itself
1296  * \param serializer The serializer to use
1297  */
1298 void ast_sip_dialog_set_serializer(pjsip_dialog *dlg, struct ast_taskprocessor *serializer);
1299
1300 /*!
1301  * \brief Set an endpoint on a SIP dialog so in-dialog requests do not undergo endpoint lookup.
1302  *
1303  * \param dlg The SIP dialog itself
1304  * \param endpoint The endpoint that this dialog is communicating with
1305  */
1306 void ast_sip_dialog_set_endpoint(pjsip_dialog *dlg, struct ast_sip_endpoint *endpoint);
1307
1308 /*!
1309  * \brief Get the endpoint associated with this dialog
1310  *
1311  * This function increases the refcount of the endpoint by one. Release
1312  * the reference once you are finished with the endpoint.
1313  *
1314  * \param dlg The SIP dialog from which to retrieve the endpoint
1315  * \retval NULL No endpoint associated with this dialog
1316  * \retval non-NULL The endpoint.
1317  */
1318 struct ast_sip_endpoint *ast_sip_dialog_get_endpoint(pjsip_dialog *dlg);
1319
1320 /*!
1321  * \brief Pushes a task to SIP servants
1322  *
1323  * This uses the serializer provided to determine how to push the task.
1324  * If the serializer is NULL, then the task will be pushed to the
1325  * servants directly. If the serializer is non-NULL, then the task will be
1326  * queued behind other tasks associated with the same serializer.
1327  *
1328  * \param serializer The serializer to which the task belongs. Can be NULL
1329  * \param sip_task The task to execute
1330  * \param task_data The parameter to pass to the task when it executes
1331  * \retval 0 Success
1332  * \retval -1 Failure
1333  */
1334 int ast_sip_push_task(struct ast_taskprocessor *serializer, int (*sip_task)(void *), void *task_data);
1335
1336 /*!
1337  * \brief Push a task to SIP servants and wait for it to complete
1338  *
1339  * Like \ref ast_sip_push_task except that it blocks until the task completes.
1340  *
1341  * \warning \b Never use this function in a SIP servant thread. This can potentially
1342  * cause a deadlock. If you are in a SIP servant thread, just call your function
1343  * in-line.
1344  *
1345  * \warning \b Never hold locks that may be acquired by a SIP servant thread when
1346  * calling this function. Doing so may cause a deadlock if all SIP servant threads
1347  * are blocked waiting to acquire the lock while the thread holding the lock is
1348  * waiting for a free SIP servant thread.
1349  *
1350  * \param serializer The SIP serializer to which the task belongs. May be NULL.
1351  * \param sip_task The task to execute
1352  * \param task_data The parameter to pass to the task when it executes
1353  * \retval 0 Success
1354  * \retval -1 Failure
1355  */
1356 int ast_sip_push_task_synchronous(struct ast_taskprocessor *serializer, int (*sip_task)(void *), void *task_data);
1357
1358 /*!
1359  * \brief Determine if the current thread is a SIP servant thread
1360  *
1361  * \retval 0 This is not a SIP servant thread
1362  * \retval 1 This is a SIP servant thread
1363  */
1364 int ast_sip_thread_is_servant(void);
1365
1366 /*!
1367  * \brief Task flags for the res_pjsip scheduler
1368  *
1369  * The default is AST_SIP_SCHED_TASK_FIXED
1370  *                | AST_SIP_SCHED_TASK_DATA_NOT_AO2
1371  *                | AST_SIP_SCHED_TASK_DATA_NO_CLEANUP
1372  *                | AST_SIP_SCHED_TASK_PERIODIC
1373  */
1374 enum ast_sip_scheduler_task_flags {
1375         /*!
1376          * The defaults
1377          */
1378         AST_SIP_SCHED_TASK_DEFAULTS = (0 << 0),
1379
1380         /*!
1381          * Run at a fixed interval.
1382          * Stop scheduling if the callback returns 0.
1383          * Any other value is ignored.
1384          */
1385         AST_SIP_SCHED_TASK_FIXED = (0 << 0),
1386         /*!
1387          * Run at a variable interval.
1388          * Stop scheduling if the callback returns 0.
1389          * Any other return value is used as the new interval.
1390          */
1391         AST_SIP_SCHED_TASK_VARIABLE = (1 << 0),
1392
1393         /*!
1394          * The task data is not an AO2 object.
1395          */
1396         AST_SIP_SCHED_TASK_DATA_NOT_AO2 = (0 << 1),
1397         /*!
1398          * The task data is an AO2 object.
1399          * A reference count will be held by the scheduler until
1400          * after the task has run for the final time (if ever).
1401          */
1402         AST_SIP_SCHED_TASK_DATA_AO2 = (1 << 1),
1403
1404         /*!
1405          * Don't take any cleanup action on the data
1406          */
1407         AST_SIP_SCHED_TASK_DATA_NO_CLEANUP = (0 << 3),
1408         /*!
1409          * If AST_SIP_SCHED_TASK_DATA_AO2 is set, decrement the reference count
1410          * otherwise call ast_free on it.
1411          */
1412         AST_SIP_SCHED_TASK_DATA_FREE = ( 1 << 3 ),
1413
1414         /*! \brief AST_SIP_SCHED_TASK_PERIODIC
1415          * The task is scheduled at multiples of interval
1416          * \see Interval
1417          */
1418         AST_SIP_SCHED_TASK_PERIODIC = (0 << 4),
1419         /*! \brief AST_SIP_SCHED_TASK_DELAY
1420          * The next invocation of the task is at last finish + interval
1421          * \see Interval
1422          */
1423         AST_SIP_SCHED_TASK_DELAY = (1 << 4),
1424 };
1425
1426 /*!
1427  * \brief Scheduler task data structure
1428  */
1429 struct ast_sip_sched_task;
1430
1431 /*!
1432  * \brief Schedule a task to run in the res_pjsip thread pool
1433  * \since 13.9.0
1434  *
1435  * \param serializer The serializer to use.  If NULL, don't use a serializer (see note below)
1436  * \param interval The invocation interval in milliseconds (see note below)
1437  * \param sip_task The task to invoke
1438  * \param name An optional name to associate with the task
1439  * \param task_data Optional data to pass to the task
1440  * \param flags One of enum ast_sip_scheduler_task_type
1441  *
1442  * \returns Pointer to \ref ast_sip_sched_task ao2 object which must be dereferenced when done.
1443  *
1444  * \paragraph Serialization
1445  *
1446  * Specifying a serializer guarantees serialized execution but NOT specifying a serializer
1447  * may still result in tasks being effectively serialized if the thread pool is busy.
1448  * The point of the serializer BTW is not to prevent parallel executions of the SAME task.
1449  * That happens automatically (see below).  It's to prevent the task from running at the same
1450  * time as other work using the same serializer, whether or not it's being run by the scheduler.
1451  *
1452  * \paragraph Interval
1453  *
1454  * The interval is used to calculate the next time the task should run.  There are two models.
1455  *
1456  * \ref AST_SIP_SCHED_TASK_PERIODIC specifies that the invocations of the task occur at the
1457  * specific interval.  That is, every \ref "interval" milliseconds, regardless of how long the task
1458  * takes. If the task takes longer than \ref interval, it will be scheduled at the next available
1459  * multiple of \ref interval.  For exmaple: If the task has an interval of 60 seconds and the task
1460  * takes 70 seconds, the next invocation will happen at 120 seconds.
1461  *
1462  * \ref AST_SIP_SCHED_TASK_DELAY specifies that the next invocation of the task should start
1463  * at \ref interval milliseconds after the current invocation has finished.
1464  *
1465  */
1466 struct ast_sip_sched_task *ast_sip_schedule_task(struct ast_taskprocessor *serializer,
1467         int interval, ast_sip_task sip_task, char *name, void *task_data,
1468         enum ast_sip_scheduler_task_flags flags);
1469
1470 /*!
1471  * \brief Cancels the next invocation of a task
1472  * \since 13.9.0
1473  *
1474  * \param schtd The task structure pointer
1475  * \retval 0 Success
1476  * \retval -1 Failure
1477  * \note Only cancels future invocations not the currently running invocation.
1478  */
1479 int ast_sip_sched_task_cancel(struct ast_sip_sched_task *schtd);
1480
1481 /*!
1482  * \brief Cancels the next invocation of a task by name
1483  * \since 13.9.0
1484  *
1485  * \param name The task name
1486  * \retval 0 Success
1487  * \retval -1 Failure
1488  * \note Only cancels future invocations not the currently running invocation.
1489  */
1490 int ast_sip_sched_task_cancel_by_name(const char *name);
1491
1492 /*!
1493  * \brief Gets the last start and end times of the task
1494  * \since 13.9.0
1495  *
1496  * \param schtd The task structure pointer
1497  * \param[out] when_queued Pointer to a timeval structure to contain the time when queued
1498  * \param[out] last_start Pointer to a timeval structure to contain the time when last started
1499  * \param[out] last_end Pointer to a timeval structure to contain the time when last ended
1500  * \retval 0 Success
1501  * \retval -1 Failure
1502  * \note Any of the pointers can be NULL if you don't need them.
1503  */
1504 int ast_sip_sched_task_get_times(struct ast_sip_sched_task *schtd,
1505         struct timeval *when_queued, struct timeval *last_start, struct timeval *last_end);
1506
1507 /*!
1508  * \brief Gets the last start and end times of the task by name
1509  * \since 13.9.0
1510  *
1511  * \param name The task name
1512  * \param[out] when_queued Pointer to a timeval structure to contain the time when queued
1513  * \param[out] last_start Pointer to a timeval structure to contain the time when last started
1514  * \param[out] last_end Pointer to a timeval structure to contain the time when last ended
1515  * \retval 0 Success
1516  * \retval -1 Failure
1517  * \note Any of the pointers can be NULL if you don't need them.
1518  */
1519 int ast_sip_sched_task_get_times_by_name(const char *name,
1520         struct timeval *when_queued, struct timeval *last_start, struct timeval *last_end);
1521
1522 /*!
1523  * \brief Gets the number of milliseconds until the next invocation
1524  * \since 13.9.0
1525  *
1526  * \param schtd The task structure pointer
1527  * \return The number of milliseconds until the next invocation or -1 if the task isn't scheduled
1528  */
1529 int ast_sip_sched_task_get_next_run(struct ast_sip_sched_task *schtd);
1530
1531 /*!
1532  * \brief Gets the number of milliseconds until the next invocation
1533  * \since 13.9.0
1534  *
1535  * \param name The task name
1536  * \return The number of milliseconds until the next invocation or -1 if the task isn't scheduled
1537  */
1538 int ast_sip_sched_task_get_next_run_by_name(const char *name);
1539
1540 /*!
1541  * \brief Checks if the task is currently running
1542  * \since 13.9.0
1543  *
1544  * \param schtd The task structure pointer
1545  * \retval 0 not running
1546  * \retval 1 running
1547  */
1548 int ast_sip_sched_is_task_running(struct ast_sip_sched_task *schtd);
1549
1550 /*!
1551  * \brief Checks if the task is currently running
1552  * \since 13.9.0
1553  *
1554  * \param name The task name
1555  * \retval 0 not running or not found
1556  * \retval 1 running
1557  */
1558 int ast_sip_sched_is_task_running_by_name(const char *name);
1559
1560 /*!
1561  * \brief Gets the task name
1562  * \since 13.9.0
1563  *
1564  * \param schtd The task structure pointer
1565  * \retval 0 success
1566  * \retval 1 failure
1567  */
1568 int ast_sip_sched_task_get_name(struct ast_sip_sched_task *schtd, char *name, size_t maxlen);
1569
1570 /*!
1571  *  @}
1572  */
1573
1574 /*!
1575  * \brief SIP body description
1576  *
1577  * This contains a type and subtype that will be added as
1578  * the "Content-Type" for the message as well as the body
1579  * text.
1580  */
1581 struct ast_sip_body {
1582         /*! Type of the body, such as "application" */
1583         const char *type;
1584         /*! Subtype of the body, such as "sdp" */
1585         const char *subtype;
1586         /*! The text to go in the body */
1587         const char *body_text;
1588 };
1589
1590 /*!
1591  * \brief General purpose method for creating a UAC dialog with an endpoint
1592  *
1593  * \param endpoint A pointer to the endpoint
1594  * \param aor_name Optional name of the AOR to target, may even be an explicit SIP URI
1595  * \param request_user Optional user to place into the target URI
1596  *
1597  * \retval non-NULL success
1598  * \retval NULL failure
1599  */
1600 pjsip_dialog *ast_sip_create_dialog_uac(const struct ast_sip_endpoint *endpoint, const char *aor_name, const char *request_user);
1601
1602 /*!
1603  * \brief General purpose method for creating a UAS dialog with an endpoint
1604  *
1605  * \param endpoint A pointer to the endpoint
1606  * \param rdata The request that is starting the dialog
1607  * \param[out] status On failure, the reason for failure in creating the dialog
1608  */
1609 pjsip_dialog *ast_sip_create_dialog_uas(const struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata, pj_status_t *status);
1610
1611 /*!
1612  * \brief General purpose method for creating an rdata structure using specific information
1613  *
1614  * \param rdata[out] The rdata structure that will be populated
1615  * \param packet A SIP message
1616  * \param src_name The source IP address of the message
1617  * \param src_port The source port of the message
1618  * \param transport_type The type of transport the message was received on
1619  * \param local_name The local IP address the message was received on
1620  * \param local_port The local port the message was received on
1621  *
1622  * \retval 0 success
1623  * \retval -1 failure
1624  */
1625 int ast_sip_create_rdata(pjsip_rx_data *rdata, char *packet, const char *src_name, int src_port, char *transport_type,
1626         const char *local_name, int local_port);
1627
1628 /*!
1629  * \brief General purpose method for creating a SIP request
1630  *
1631  * Its typical use would be to create one-off requests such as an out of dialog
1632  * SIP MESSAGE.
1633  *
1634  * The request can either be in- or out-of-dialog. If in-dialog, the
1635  * dlg parameter MUST be present. If out-of-dialog the endpoint parameter
1636  * MUST be present. If both are present, then we will assume that the message
1637  * is to be sent in-dialog.
1638  *
1639  * The uri parameter can be specified if the request should be sent to an explicit
1640  * URI rather than one configured on the endpoint.
1641  *
1642  * \param method The method of the SIP request to send
1643  * \param dlg Optional. If specified, the dialog on which to request the message.
1644  * \param endpoint Optional. If specified, the request will be created out-of-dialog to the endpoint.
1645  * \param uri Optional. If specified, the request will be sent to this URI rather
1646  * than one configured for the endpoint.
1647  * \param contact The contact with which this request is associated for out-of-dialog requests.
1648  * \param[out] tdata The newly-created request
1649  *
1650  * The provided contact is attached to tdata with its reference bumped, but will
1651  * not survive for the entire lifetime of tdata since the contact is cleaned up
1652  * when all supplements have completed execution.
1653  *
1654  * \retval 0 Success
1655  * \retval -1 Failure
1656  */
1657 int ast_sip_create_request(const char *method, struct pjsip_dialog *dlg,
1658                 struct ast_sip_endpoint *endpoint, const char *uri,
1659                 struct ast_sip_contact *contact, pjsip_tx_data **tdata);
1660
1661 /*!
1662  * \brief General purpose method for sending a SIP request
1663  *
1664  * This is a companion function for \ref ast_sip_create_request. The request
1665  * created there can be passed to this function, though any request may be
1666  * passed in.
1667  *
1668  * This will automatically set up handling outbound authentication challenges if
1669  * they arrive.
1670  *
1671  * \param tdata The request to send
1672  * \param dlg Optional. The dialog in which the request is sent.  Otherwise it is out-of-dialog.
1673  * \param endpoint Optional. If specified, the out-of-dialog request is sent to the endpoint.
1674  * \param token Data to be passed to the callback upon receipt of out-of-dialog response.
1675  * \param callback Callback to be called upon receipt of out-of-dialog response.
1676  *
1677  * \retval 0 Success
1678  * \retval -1 Failure (out-of-dialog callback will not be called.)
1679  */
1680 int ast_sip_send_request(pjsip_tx_data *tdata, struct pjsip_dialog *dlg,
1681         struct ast_sip_endpoint *endpoint, void *token,
1682         void (*callback)(void *token, pjsip_event *e));
1683
1684 /*!
1685  * \brief General purpose method for sending an Out-Of-Dialog SIP request
1686  *
1687  * This is a companion function for \ref ast_sip_create_request. The request
1688  * created there can be passed to this function, though any request may be
1689  * passed in.
1690  *
1691  * This will automatically set up handling outbound authentication challenges if
1692  * they arrive.
1693  *
1694  * \param tdata The request to send
1695  * \param endpoint Optional. If specified, the out-of-dialog request is sent to the endpoint.
1696  * \param timeout.  If non-zero, after the timeout the transaction will be terminated
1697  * and the callback will be called with the PJSIP_EVENT_TIMER type.
1698  * \param token Data to be passed to the callback upon receipt of out-of-dialog response.
1699  * \param callback Callback to be called upon receipt of out-of-dialog response.
1700  *
1701  * \retval 0 Success
1702  * \retval -1 Failure (out-of-dialog callback will not be called.)
1703  *
1704  * \note Timeout processing:
1705  * There are 2 timers associated with this request, PJSIP timer_b which is
1706  * set globally in the "system" section of pjsip.conf, and the timeout specified
1707  * on this call.  The timer that expires first (before normal completion) will
1708  * cause the callback to be run with e->body.tsx_state.type = PJSIP_EVENT_TIMER.
1709  * The timer that expires second is simply ignored and the callback is not run again.
1710  */
1711 int ast_sip_send_out_of_dialog_request(pjsip_tx_data *tdata,
1712         struct ast_sip_endpoint *endpoint, int timeout, void *token,
1713         void (*callback)(void *token, pjsip_event *e));
1714
1715 /*!
1716  * \brief General purpose method for creating a SIP response
1717  *
1718  * Its typical use would be to create responses for out of dialog
1719  * requests.
1720  *
1721  * \param rdata The rdata from the incoming request.
1722  * \param st_code The response code to transmit.
1723  * \param contact The contact with which this request is associated.
1724  * \param[out] tdata The newly-created response
1725  *
1726  * The provided contact is attached to tdata with its reference bumped, but will
1727  * not survive for the entire lifetime of tdata since the contact is cleaned up
1728  * when all supplements have completed execution.
1729  *
1730  * \retval 0 Success
1731  * \retval -1 Failure
1732  */
1733 int ast_sip_create_response(const pjsip_rx_data *rdata, int st_code,
1734         struct ast_sip_contact *contact, pjsip_tx_data **p_tdata);
1735
1736 /*!
1737  * \brief Send a response to an out of dialog request
1738  *
1739  * Use this function sparingly, since this does not create a transaction
1740  * within PJSIP. This means that if the request is retransmitted, it is
1741  * your responsibility to detect this and not process the same request
1742  * twice, and to send the same response for each retransmission.
1743  *
1744  * \param res_addr The response address for this response
1745  * \param tdata The response to send
1746  * \param endpoint The ast_sip_endpoint associated with this response
1747  *
1748  * \retval 0 Success
1749  * \retval -1 Failure
1750  */
1751 int ast_sip_send_response(pjsip_response_addr *res_addr, pjsip_tx_data *tdata, struct ast_sip_endpoint *sip_endpoint);
1752
1753 /*!
1754  * \brief Send a stateful response to an out of dialog request
1755  *
1756  * This creates a transaction within PJSIP, meaning that if the request
1757  * that we are responding to is retransmitted, we will not attempt to
1758  * re-handle the request.
1759  *
1760  * \param rdata The request that is being responded to
1761  * \param tdata The response to send
1762  * \param endpoint The ast_sip_endpoint associated with this response
1763  *
1764  * \since 13.4.0
1765  *
1766  * \retval 0 Success
1767  * \retval -1 Failure
1768  */
1769 int ast_sip_send_stateful_response(pjsip_rx_data *rdata, pjsip_tx_data *tdata, struct ast_sip_endpoint *sip_endpoint);
1770
1771 /*!
1772  * \brief Determine if an incoming request requires authentication
1773  *
1774  * This calls into the registered authenticator's requires_authentication callback
1775  * in order to determine if the request requires authentication.
1776  *
1777  * If there is no registered authenticator, then authentication will be assumed
1778  * not to be required.
1779  *
1780  * \param endpoint The endpoint from which the request originates
1781  * \param rdata The incoming SIP request
1782  * \retval non-zero The request requires authentication
1783  * \retval 0 The request does not require authentication
1784  */
1785 int ast_sip_requires_authentication(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata);
1786
1787 /*!
1788  * \brief Method to determine authentication status of an incoming request
1789  *
1790  * This will call into a registered authenticator. The registered authenticator will
1791  * do what is necessary to determine whether the incoming request passes authentication.
1792  * A tentative response is passed into this function so that if, say, a digest authentication
1793  * challenge should be sent in the ensuing response, it can be added to the response.
1794  *
1795  * \param endpoint The endpoint from the request was sent
1796  * \param rdata The request to potentially authenticate
1797  * \param tdata Tentative response to the request
1798  * \return The result of checking authentication.
1799  */
1800 enum ast_sip_check_auth_result ast_sip_check_authentication(struct ast_sip_endpoint *endpoint,
1801                 pjsip_rx_data *rdata, pjsip_tx_data *tdata);
1802
1803 /*!
1804  * \brief Create a response to an authentication challenge
1805  *
1806  * This will call into an outbound authenticator's create_request_with_auth callback
1807  * to create a new request with authentication credentials. See the create_request_with_auth
1808  * callback in the \ref ast_sip_outbound_authenticator structure for details about
1809  * the parameters and return values.
1810  */
1811 int ast_sip_create_request_with_auth(const struct ast_sip_auth_vector *auths, pjsip_rx_data *challenge,
1812                 pjsip_tx_data *tdata, pjsip_tx_data **new_request);
1813
1814 /*!
1815  * \brief Determine the endpoint that has sent a SIP message
1816  *
1817  * This will call into each of the registered endpoint identifiers'
1818  * identify_endpoint() callbacks until one returns a non-NULL endpoint.
1819  * This will return an ao2 object. Its reference count will need to be
1820  * decremented when completed using the endpoint.
1821  *
1822  * \param rdata The inbound SIP message to use when identifying the endpoint.
1823  * \retval NULL No matching endpoint
1824  * \retval non-NULL The matching endpoint
1825  */
1826 struct ast_sip_endpoint *ast_sip_identify_endpoint(pjsip_rx_data *rdata);
1827
1828 /*!
1829  * \brief Set the outbound proxy for an outbound SIP message
1830  *
1831  * \param tdata The message to set the outbound proxy on
1832  * \param proxy SIP uri of the proxy
1833  * \retval 0 Success
1834  * \retval -1 Failure
1835  */
1836 int ast_sip_set_outbound_proxy(pjsip_tx_data *tdata, const char *proxy);
1837
1838 /*!
1839  * \brief Add a header to an outbound SIP message
1840  *
1841  * \param tdata The message to add the header to
1842  * \param name The header name
1843  * \param value The header value
1844  * \retval 0 Success
1845  * \retval -1 Failure
1846  */
1847 int ast_sip_add_header(pjsip_tx_data *tdata, const char *name, const char *value);
1848
1849 /*!
1850  * \brief Add a body to an outbound SIP message
1851  *
1852  * If this is called multiple times, the latest body will replace the current
1853  * body.
1854  *
1855  * \param tdata The message to add the body to
1856  * \param body The message body to add
1857  * \retval 0 Success
1858  * \retval -1 Failure
1859  */
1860 int ast_sip_add_body(pjsip_tx_data *tdata, const struct ast_sip_body *body);
1861
1862 /*!
1863  * \brief Add a multipart body to an outbound SIP message
1864  *
1865  * This will treat each part of the input vector as part of a multipart body and
1866  * add each part to the SIP message.
1867  *
1868  * \param tdata The message to add the body to
1869  * \param bodies The parts of the body to add
1870  * \retval 0 Success
1871  * \retval -1 Failure
1872  */
1873 int ast_sip_add_body_multipart(pjsip_tx_data *tdata, const struct ast_sip_body *bodies[], int num_bodies);
1874
1875 /*!
1876  * \brief Append body data to a SIP message
1877  *
1878  * This acts mostly the same as ast_sip_add_body, except that rather than replacing
1879  * a body if it currently exists, it appends data to an existing body.
1880  *
1881  * \param tdata The message to append the body to
1882  * \param body The string to append to the end of the current body
1883  * \retval 0 Success
1884  * \retval -1 Failure
1885  */
1886 int ast_sip_append_body(pjsip_tx_data *tdata, const char *body_text);
1887
1888 /*!
1889  * \brief Copy a pj_str_t into a standard character buffer.
1890  *
1891  * pj_str_t is not NULL-terminated. Any place that expects a NULL-
1892  * terminated string needs to have the pj_str_t copied into a separate
1893  * buffer.
1894  *
1895  * This method copies the pj_str_t contents into the destination buffer
1896  * and NULL-terminates the buffer.
1897  *
1898  * \param dest The destination buffer
1899  * \param src The pj_str_t to copy
1900  * \param size The size of the destination buffer.
1901  */
1902 void ast_copy_pj_str(char *dest, const pj_str_t *src, size_t size);
1903
1904 /*!
1905  * \brief Get the looked-up endpoint on an out-of dialog request or response
1906  *
1907  * The function may ONLY be called on out-of-dialog requests or responses. For
1908  * in-dialog requests and responses, it is required that the user of the dialog
1909  * has the looked-up endpoint stored locally.
1910  *
1911  * This function should never return NULL if the message is out-of-dialog. It will
1912  * always return NULL if the message is in-dialog.
1913  *
1914  * This function will increase the reference count of the returned endpoint by one.
1915  * Release your reference using the ao2_ref function when finished.
1916  *
1917  * \param rdata Out-of-dialog request or response
1918  * \return The looked up endpoint
1919  */
1920 struct ast_sip_endpoint *ast_pjsip_rdata_get_endpoint(pjsip_rx_data *rdata);
1921
1922 /*!
1923  * \brief Add 'user=phone' parameter to URI if enabled and user is a phone number.
1924  *
1925  * \param endpoint The endpoint to use for configuration
1926  * \param pool The memory pool to allocate the parameter from
1927  * \param uri The URI to check for user and to add parameter to
1928  */
1929 void ast_sip_add_usereqphone(const struct ast_sip_endpoint *endpoint, pj_pool_t *pool, pjsip_uri *uri);
1930
1931 /*!
1932  * \brief Retrieve any endpoints available to sorcery.
1933  *
1934  * \retval Endpoints available to sorcery, NULL if no endpoints found.
1935  */
1936 struct ao2_container *ast_sip_get_endpoints(void);
1937
1938 /*!
1939  * \brief Retrieve the default outbound endpoint.
1940  *
1941  * \retval The default outbound endpoint, NULL if not found.
1942  */
1943 struct ast_sip_endpoint *ast_sip_default_outbound_endpoint(void);
1944
1945 /*!
1946  * \brief Retrieve relevant SIP auth structures from sorcery
1947  *
1948  * \param auths Vector of sorcery IDs of auth credentials to retrieve
1949  * \param[out] out The retrieved auths are stored here
1950  */
1951 int ast_sip_retrieve_auths(const struct ast_sip_auth_vector *auths, struct ast_sip_auth **out);
1952
1953 /*!
1954  * \brief Clean up retrieved auth structures from memory
1955  *
1956  * Call this function once you have completed operating on auths
1957  * retrieved from \ref ast_sip_retrieve_auths
1958  *
1959  * \param auths An vector of auth structures to clean up
1960  * \param num_auths The number of auths in the vector
1961  */
1962 void ast_sip_cleanup_auths(struct ast_sip_auth *auths[], size_t num_auths);
1963
1964 /*!
1965  * \brief Checks if the given content type matches type/subtype.
1966  *
1967  * Compares the pjsip_media_type with the passed type and subtype and
1968  * returns the result of that comparison.  The media type parameters are
1969  * ignored.
1970  *
1971  * \param content_type The pjsip_media_type structure to compare
1972  * \param type The media type to compare
1973  * \param subtype The media subtype to compare
1974  * \retval 0 No match
1975  * \retval -1 Match
1976  */
1977 int ast_sip_is_content_type(pjsip_media_type *content_type, char *type, char *subtype);
1978
1979 /*!
1980  * \brief Send a security event notification for when an invalid endpoint is requested
1981  *
1982  * \param name Name of the endpoint requested
1983  * \param rdata Received message
1984  */
1985 void ast_sip_report_invalid_endpoint(const char *name, pjsip_rx_data *rdata);
1986
1987 /*!
1988  * \brief Send a security event notification for when an ACL check fails
1989  *
1990  * \param endpoint Pointer to the endpoint in use
1991  * \param rdata Received message
1992  * \param name Name of the ACL
1993  */
1994 void ast_sip_report_failed_acl(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata, const char *name);
1995
1996 /*!
1997  * \brief Send a security event notification for when a challenge response has failed
1998  *
1999  * \param endpoint Pointer to the endpoint in use
2000  * \param rdata Received message
2001  */
2002 void ast_sip_report_auth_failed_challenge_response(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata);
2003
2004 /*!
2005  * \brief Send a security event notification for when authentication succeeds
2006  *
2007  * \param endpoint Pointer to the endpoint in use
2008  * \param rdata Received message
2009  */
2010 void ast_sip_report_auth_success(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata);
2011
2012 /*!
2013  * \brief Send a security event notification for when an authentication challenge is sent
2014  *
2015  * \param endpoint Pointer to the endpoint in use
2016  * \param rdata Received message
2017  * \param tdata Sent message
2018  */
2019 void ast_sip_report_auth_challenge_sent(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata, pjsip_tx_data *tdata);
2020
2021 /*!
2022  * \brief Send a security event notification for when a request is not supported
2023  *
2024  * \param endpoint Pointer to the endpoint in use
2025  * \param rdata Received message
2026  * \param req_type the type of request
2027  */
2028 void ast_sip_report_req_no_support(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata,
2029                                    const char* req_type);
2030
2031 /*!
2032  * \brief Send a security event notification for when a memory limit is hit.
2033  *
2034  * \param endpoint Pointer to the endpoint in use
2035  * \param rdata Received message
2036  */
2037 void ast_sip_report_mem_limit(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata);
2038
2039 int ast_sip_add_global_request_header(const char *name, const char *value, int replace);
2040 int ast_sip_add_global_response_header(const char *name, const char *value, int replace);
2041
2042 /*!
2043  * \brief Retrieves the value associated with the given key.
2044  *
2045  * \param ht the hash table/dictionary to search
2046  * \param key the key to find
2047  *
2048  * \retval the value associated with the key, NULL otherwise.
2049  */
2050 void *ast_sip_dict_get(void *ht, const char *key);
2051
2052 /*!
2053  * \brief Using the dictionary stored in mod_data array at a given id,
2054  *        retrieve the value associated with the given key.
2055  *
2056  * \param mod_data a module data array
2057  * \param id the mod_data array index
2058  * \param key the key to find
2059  *
2060  * \retval the value associated with the key, NULL otherwise.
2061  */
2062 #define ast_sip_mod_data_get(mod_data, id, key)         \
2063         ast_sip_dict_get(mod_data[id], key)
2064
2065 /*!
2066  * \brief Set the value for the given key.
2067  *
2068  * Note - if the hash table does not exist one is created first, the key/value
2069  * pair is set, and the hash table returned.
2070  *
2071  * \param pool the pool to allocate memory in
2072  * \param ht the hash table/dictionary in which to store the key/value pair
2073  * \param key the key to associate a value with
2074  * \param val the value to associate with a key
2075  *
2076  * \retval the given, or newly created, hash table.
2077  */
2078 void *ast_sip_dict_set(pj_pool_t* pool, void *ht,
2079                        const char *key, void *val);
2080
2081 /*!
2082  * \brief Utilizing a mod_data array for a given id, set the value
2083  *        associated with the given key.
2084  *
2085  * For a given structure's mod_data array set the element indexed by id to
2086  * be a dictionary containing the key/val pair.
2087  *
2088  * \param pool a memory allocation pool
2089  * \param mod_data a module data array
2090  * \param id the mod_data array index
2091  * \param key the key to find
2092  * \param val the value to associate with a key
2093  */
2094 #define ast_sip_mod_data_set(pool, mod_data, id, key, val)              \
2095         mod_data[id] = ast_sip_dict_set(pool, mod_data[id], key, val)
2096
2097 /*!
2098  * \brief For every contact on an AOR call the given 'on_contact' handler.
2099  *
2100  * \param aor the aor containing a list of contacts to iterate
2101  * \param on_contact callback on each contact on an AOR.  The object
2102  * received by the callback will be a ast_sip_contact_wrapper structure.
2103  * \param arg user data passed to handler
2104  * \retval 0 Success, non-zero on failure
2105  */
2106 int ast_sip_for_each_contact(const struct ast_sip_aor *aor,
2107                 ao2_callback_fn on_contact, void *arg);
2108
2109 /*!
2110  * \brief Handler used to convert a contact to a string.
2111  *
2112  * \param object the ast_sip_aor_contact_pair containing a list of contacts to iterate and the contact
2113  * \param arg user data passed to handler
2114  * \param flags
2115  * \retval 0 Success, non-zero on failure
2116  */
2117 int ast_sip_contact_to_str(void *object, void *arg, int flags);
2118
2119 /*!
2120  * \brief For every aor in the comma separated aors string call the
2121  *        given 'on_aor' handler.
2122  *
2123  * \param aors a comma separated list of aors
2124  * \param on_aor callback for each aor
2125  * \param arg user data passed to handler
2126  * \retval 0 Success, non-zero on failure
2127  */
2128 int ast_sip_for_each_aor(const char *aors, ao2_callback_fn on_aor, void *arg);
2129
2130 /*!
2131  * \brief For every auth in the array call the given 'on_auth' handler.
2132  *
2133  * \param array an array of auths
2134  * \param on_auth callback for each auth
2135  * \param arg user data passed to handler
2136  * \retval 0 Success, non-zero on failure
2137  */
2138 int ast_sip_for_each_auth(const struct ast_sip_auth_vector *array,
2139                           ao2_callback_fn on_auth, void *arg);
2140
2141 /*!
2142  * \brief Converts the given auth type to a string
2143  *
2144  * \param type the auth type to convert
2145  * \retval a string representative of the auth type
2146  */
2147 const char *ast_sip_auth_type_to_str(enum ast_sip_auth_type type);
2148
2149 /*!
2150  * \brief Converts an auths array to a string of comma separated values
2151  *
2152  * \param auths an auth array
2153  * \param buf the string buffer to write the object data
2154  * \retval 0 Success, non-zero on failure
2155  */
2156 int ast_sip_auths_to_str(const struct ast_sip_auth_vector *auths, char **buf);
2157
2158 /*!
2159  * \brief AMI variable container
2160  */
2161 struct ast_sip_ami {
2162         /*! Manager session */
2163         struct mansession *s;
2164         /*! Manager message */
2165         const struct message *m;
2166         /*! Manager Action ID */
2167         const char *action_id;
2168         /*! user specified argument data */
2169         void *arg;
2170         /*! count of objects */
2171         int count;
2172 };
2173
2174 /*!
2175  * \brief Creates a string to store AMI event data in.
2176  *
2177  * \param event the event to set
2178  * \param ami AMI session and message container
2179  * \retval an initialized ast_str or NULL on error.
2180  */
2181 struct ast_str *ast_sip_create_ami_event(const char *event,
2182                                          struct ast_sip_ami *ami);
2183
2184 /*!
2185  * \brief An entity responsible formatting endpoint information.
2186  */
2187 struct ast_sip_endpoint_formatter {
2188         /*!
2189          * \brief Callback used to format endpoint information over AMI.
2190          */
2191         int (*format_ami)(const struct ast_sip_endpoint *endpoint,
2192                           struct ast_sip_ami *ami);
2193         AST_RWLIST_ENTRY(ast_sip_endpoint_formatter) next;
2194 };
2195
2196 /*!
2197  * \brief Register an endpoint formatter.
2198  *
2199  * \param obj the formatter to register
2200  * \retval 0 Success
2201  * \retval -1 Failure
2202  */
2203 int ast_sip_register_endpoint_formatter(struct ast_sip_endpoint_formatter *obj);
2204
2205 /*!
2206  * \brief Unregister an endpoint formatter.
2207  *
2208  * \param obj the formatter to unregister
2209  */
2210 void ast_sip_unregister_endpoint_formatter(struct ast_sip_endpoint_formatter *obj);
2211
2212 /*!
2213  * \brief Converts a sorcery object to a string of object properties.
2214  *
2215  * \param obj the sorcery object to convert
2216  * \param str the string buffer to write the object data
2217  * \retval 0 Success, non-zero on failure
2218  */
2219 int ast_sip_sorcery_object_to_ami(const void *obj, struct ast_str **buf);
2220
2221 /*!
2222  * \brief Formats the endpoint and sends over AMI.
2223  *
2224  * \param endpoint the endpoint to format and send
2225  * \param endpoint ami AMI variable container
2226  * \param count the number of formatters operated on
2227  * \retval 0 Success, otherwise non-zero on error
2228  */
2229 int ast_sip_format_endpoint_ami(struct ast_sip_endpoint *endpoint,
2230                                 struct ast_sip_ami *ami, int *count);
2231
2232 /*!
2233  * \brief Format auth details for AMI.
2234  *
2235  * \param auths an auth array
2236  * \param ami ami variable container
2237  * \retval 0 Success, non-zero on failure
2238  */
2239 int ast_sip_format_auths_ami(const struct ast_sip_auth_vector *auths,
2240                              struct ast_sip_ami *ami);
2241
2242 /*!
2243  * \brief Retrieve the endpoint snapshot for an endpoint
2244  *
2245  * \param endpoint The endpoint whose snapshot is to be retreieved.
2246  * \retval The endpoint snapshot
2247  */
2248 struct ast_endpoint_snapshot *ast_sip_get_endpoint_snapshot(
2249         const struct ast_sip_endpoint *endpoint);
2250
2251 /*!
2252  * \brief Retrieve the device state for an endpoint.
2253  *
2254  * \param endpoint The endpoint whose state is to be retrieved.
2255  * \retval The device state.
2256  */
2257 const char *ast_sip_get_device_state(const struct ast_sip_endpoint *endpoint);
2258
2259 /*!
2260  * \brief For every channel snapshot on an endpoint snapshot call the given
2261  *        'on_channel_snapshot' handler.
2262  *
2263  * \param endpoint_snapshot snapshot of an endpoint
2264  * \param on_channel_snapshot callback for each channel snapshot
2265  * \param arg user data passed to handler
2266  * \retval 0 Success, non-zero on failure
2267  */
2268 int ast_sip_for_each_channel_snapshot(const struct ast_endpoint_snapshot *endpoint_snapshot,
2269                 ao2_callback_fn on_channel_snapshot,
2270                                       void *arg);
2271
2272 /*!
2273  * \brief For every channel snapshot on an endpoint all the given
2274  *        'on_channel_snapshot' handler.
2275  *
2276  * \param endpoint endpoint
2277  * \param on_channel_snapshot callback for each channel snapshot
2278  * \param arg user data passed to handler
2279  * \retval 0 Success, non-zero on failure
2280  */
2281 int ast_sip_for_each_channel(const struct ast_sip_endpoint *endpoint,
2282                 ao2_callback_fn on_channel_snapshot,
2283                                       void *arg);
2284
2285 enum ast_sip_supplement_priority {
2286         /*! Top priority. Supplements with this priority are those that need to run before any others */
2287         AST_SIP_SUPPLEMENT_PRIORITY_FIRST = 0,
2288         /*! Channel creation priority.
2289          * chan_pjsip creates a channel at this priority. If your supplement depends on being run before
2290          * or after channel creation, then set your priority to be lower or higher than this value.
2291          */
2292         AST_SIP_SUPPLEMENT_PRIORITY_CHANNEL = 1000000,
2293         /*! Lowest priority. Supplements with this priority should be run after all other supplements */
2294         AST_SIP_SUPPLEMENT_PRIORITY_LAST = INT_MAX,
2295 };
2296
2297 /*!
2298  * \brief A supplement to SIP message processing
2299  *
2300  * These can be registered by any module in order to add
2301  * processing to incoming and outgoing SIP out of dialog
2302  * requests and responses
2303  */
2304 struct ast_sip_supplement {
2305         /*! Method on which to call the callbacks. If NULL, call on all methods */
2306         const char *method;
2307         /*! Priority for this supplement. Lower numbers are visited before higher numbers */
2308         enum ast_sip_supplement_priority priority;
2309         /*!
2310          * \brief Called on incoming SIP request
2311          * This method can indicate a failure in processing in its return. If there
2312          * is a failure, it is required that this method sends a response to the request.
2313          * This method is always called from a SIP servant thread.
2314          *
2315          * \note
2316          * The following PJSIP methods will not work properly:
2317          * pjsip_rdata_get_dlg()
2318          * pjsip_rdata_get_tsx()
2319          * The reason is that the rdata passed into this function is a cloned rdata structure,
2320          * and its module data is not copied during the cloning operation.
2321          * If you need to get the dialog, you can get it via session->inv_session->dlg.
2322          *
2323          * \note
2324          * There is no guarantee that a channel will be present on the session when this is called.
2325          */
2326         int (*incoming_request)(struct ast_sip_endpoint *endpoint, struct pjsip_rx_data *rdata);
2327         /*!
2328          * \brief Called on an incoming SIP response
2329          * This method is always called from a SIP servant thread.
2330          *
2331          * \note
2332          * The following PJSIP methods will not work properly:
2333          * pjsip_rdata_get_dlg()
2334          * pjsip_rdata_get_tsx()
2335          * The reason is that the rdata passed into this function is a cloned rdata structure,
2336          * and its module data is not copied during the cloning operation.
2337          * If you need to get the dialog, you can get it via session->inv_session->dlg.
2338          *
2339          * \note
2340          * There is no guarantee that a channel will be present on the session when this is called.
2341          */
2342         void (*incoming_response)(struct ast_sip_endpoint *endpoint, struct pjsip_rx_data *rdata);
2343         /*!
2344          * \brief Called on an outgoing SIP request
2345          * This method is always called from a SIP servant thread.
2346          */
2347         void (*outgoing_request)(struct ast_sip_endpoint *endpoint, struct ast_sip_contact *contact, struct pjsip_tx_data *tdata);
2348         /*!
2349          * \brief Called on an outgoing SIP response
2350          * This method is always called from a SIP servant thread.
2351          */
2352         void (*outgoing_response)(struct ast_sip_endpoint *endpoint, struct ast_sip_contact *contact, struct pjsip_tx_data *tdata);
2353         /*! Next item in the list */
2354         AST_LIST_ENTRY(ast_sip_supplement) next;
2355 };
2356
2357 /*!
2358  * \brief Register a supplement to SIP out of dialog processing
2359  *
2360  * This allows for someone to insert themselves in the processing of out
2361  * of dialog SIP requests and responses. This, for example could allow for
2362  * a module to set channel data based on headers in an incoming message.
2363  * Similarly, a module could reject an incoming request if desired.
2364  *
2365  * \param supplement The supplement to register
2366  * \retval 0 Success
2367  * \retval -1 Failure
2368  */
2369 int ast_sip_register_supplement(struct ast_sip_supplement *supplement);
2370
2371 /*!
2372  * \brief Unregister a an supplement to SIP out of dialog processing
2373  *
2374  * \param supplement The supplement to unregister
2375  */
2376 void ast_sip_unregister_supplement(struct ast_sip_supplement *supplement);
2377
2378 /*!
2379  * \brief Retrieve the system debug setting (yes|no|host).
2380  *
2381  * \note returned string needs to be de-allocated by caller.
2382  *
2383  * \retval the system debug setting.
2384  */
2385 char *ast_sip_get_debug(void);
2386
2387 /*!
2388  * \brief Retrieve the global regcontext setting.
2389  *
2390  * \since 13.8.0
2391  *
2392  * \note returned string needs to be de-allocated by caller.
2393  *
2394  * \retval the global regcontext setting
2395  */
2396 char *ast_sip_get_regcontext(void);
2397
2398 /*!
2399  * \brief Retrieve the global endpoint_identifier_order setting.
2400  *
2401  * Specifies the order by which endpoint identifiers should be regarded.
2402  *
2403  * \retval the global endpoint_identifier_order value
2404  */
2405 char *ast_sip_get_endpoint_identifier_order(void);
2406
2407 /*!
2408  * \brief Retrieve the default voicemail extension.
2409  * \since 13.9.0
2410  *
2411  * \note returned string needs to be de-allocated by caller.
2412  *
2413  * \retval the default voicemail extension
2414  */
2415 char *ast_sip_get_default_voicemail_extension(void);
2416
2417 /*!
2418  * \brief Retrieve the global default realm.
2419  *
2420  * This is the value placed in outbound challenges' realm if there
2421  * is no better option (such as an auth-configured realm).
2422  *
2423  * \param[out] realm The default realm
2424  * \param size The buffer size of realm
2425  * \return nothing
2426  */
2427 void ast_sip_get_default_realm(char *realm, size_t size);
2428
2429 /*!
2430  * \brief Retrieve the global default from user.
2431  *
2432  * This is the value placed in outbound requests' From header if there
2433  * is no better option (such as an endpoint-configured from_user or
2434  * caller ID number).
2435  *
2436  * \param[out] from_user The default from user
2437  * \param size The buffer size of from_user
2438  * \return nothing
2439  */
2440 void ast_sip_get_default_from_user(char *from_user, size_t size);
2441
2442 /*! \brief Determines whether the res_pjsip module is loaded */
2443 #define CHECK_PJSIP_MODULE_LOADED()                             \
2444         do {                                                    \
2445                 if (!ast_module_check("res_pjsip.so")           \
2446                         || !ast_sip_get_pjsip_endpoint()) {     \
2447                         return AST_MODULE_LOAD_DECLINE;         \
2448                 }                                               \
2449         } while(0)
2450
2451 /*!
2452  * \brief Retrieve the system keep alive interval setting.
2453  *
2454  * \retval the keep alive interval.
2455  */
2456 unsigned int ast_sip_get_keep_alive_interval(void);
2457
2458 /*!
2459  * \brief Retrieve the system contact expiration check interval setting.
2460  *
2461  * \retval the contact expiration check interval.
2462  */
2463 unsigned int ast_sip_get_contact_expiration_check_interval(void);
2464
2465 /*!
2466  * \brief Retrieve the system setting 'disable multi domain'.
2467  * \since 13.9.0
2468  *
2469  * \retval non zero if disable multi domain.
2470  */
2471 unsigned int ast_sip_get_disable_multi_domain(void);
2472
2473 /*!
2474  * \brief Retrieve the system max initial qualify time.
2475  *
2476  * \retval the maximum initial qualify time.
2477  */
2478 unsigned int ast_sip_get_max_initial_qualify_time(void);
2479
2480 /*!
2481  * \brief translate ast_sip_contact_status_type to character string.
2482  *
2483  * \retval the character string equivalent.
2484  */
2485
2486 const char *ast_sip_get_contact_status_label(const enum ast_sip_contact_status_type status);
2487 const char *ast_sip_get_contact_short_status_label(const enum ast_sip_contact_status_type status);
2488
2489 /*!
2490  * \brief Set a request to use the next value in the list of resolved addresses.
2491  *
2492  * \param tdata the tx data from the original request
2493  * \retval 0 No more addresses to try
2494  * \retval 1 The request was successfully re-intialized
2495  */
2496 int ast_sip_failover_request(pjsip_tx_data *tdata);
2497
2498 /*
2499  * \brief Retrieve the local host address in IP form
2500  *
2501  * \param af The address family to retrieve
2502  * \param addr A place to store the local host address
2503  *
2504  * \retval 0 success
2505  * \retval -1 failure
2506  *
2507  * \since 13.6.0
2508  */
2509 int ast_sip_get_host_ip(int af, pj_sockaddr *addr);
2510
2511 /*!
2512  * \brief Retrieve the local host address in string form
2513  *
2514  * \param af The address family to retrieve
2515  *
2516  * \retval non-NULL success
2517  * \retval NULL failure
2518  *
2519  * \since 13.6.0
2520  *
2521  * \note An empty string may be returned if the address family is valid but no local address exists
2522  */
2523 const char *ast_sip_get_host_ip_string(int af);
2524
2525 /*!
2526  * \brief Return the size of the SIP threadpool's task queue
2527  * \since 13.7.0
2528  */
2529 long ast_sip_threadpool_queue_size(void);
2530
2531 /*!
2532  * \brief Retrieve transport state
2533  * \since 13.7.1
2534  *
2535  * @param transport_id
2536  * @returns transport_state
2537  *
2538  * \note ao2_cleanup(...) or ao2_ref(...,  -1) must be called on the returned object
2539  */
2540 struct ast_sip_transport_state *ast_sip_get_transport_state(const char *transport_id);
2541
2542 /*!
2543  * \brief Retrieves all transport states
2544  * \since 13.7.1
2545  *
2546  * @returns ao2_container
2547  *
2548  * \note ao2_cleanup(...) or ao2_ref(...,  -1) must be called on the returned object
2549  */
2550 struct ao2_container *ast_sip_get_transport_states(void);
2551
2552 /*!
2553  * \brief Sets pjsip_tpselector from ast_sip_transport
2554  * \since 13.8.0
2555  *
2556  * \param transport The transport to be used
2557  * \param selector The selector to be populated
2558  * \retval 0 success
2559  * \retval -1 failure
2560  */
2561 int ast_sip_set_tpselector_from_transport(const struct ast_sip_transport *transport, pjsip_tpselector *selector);
2562
2563 /*!
2564  * \brief Sets pjsip_tpselector from ast_sip_transport
2565  * \since 13.8.0
2566  *
2567  * \param transport_name The name of the transport to be used
2568  * \param selector The selector to be populated
2569  * \retval 0 success
2570  * \retval -1 failure
2571  */
2572 int ast_sip_set_tpselector_from_transport_name(const char *transport_name, pjsip_tpselector *selector);
2573
2574 /*!
2575  * \brief Set name and number information on an identity header.
2576  *
2577  * \param pool Memory pool to use for string duplication
2578  * \param id_hdr A From, P-Asserted-Identity, or Remote-Party-ID header to modify
2579  * \param id The identity information to apply to the header
2580  */
2581 void ast_sip_modify_id_header(pj_pool_t *pool, pjsip_fromto_hdr *id_hdr,
2582         const struct ast_party_id *id);
2583
2584 /*!
2585  * \brief Retrieve the unidentified request security event thresholds
2586  * \since 13.8.0
2587  *
2588  * \param count The maximum number of unidentified requests per source ip to accumulate before emitting a security event
2589  * \param period The period in seconds over which to accumulate unidentified requests
2590  * \param prune_interval The interval in seconds at which expired entries will be pruned
2591  */
2592 void ast_sip_get_unidentified_request_thresholds(unsigned int *count, unsigned int *period,
2593         unsigned int *prune_interval);
2594
2595 #endif /* _RES_PJSIP_H */