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