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