aee27aa9e95ce26d088074eeab195e7358b478e1
[asterisk/asterisk.git] / include / asterisk / res_sip.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_SIP_H
20 #define _RES_SIP_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 pj_sockaddr */
34 #include <pjlib.h>
35
36 /* Forward declarations of PJSIP stuff */
37 struct pjsip_rx_data;
38 struct pjsip_module;
39 struct pjsip_tx_data;
40 struct pjsip_dialog;
41 struct pjsip_transport;
42 struct pjsip_tpfactory;
43 struct pjsip_tls_setting;
44 struct pjsip_tpselector;
45
46 /*!
47  * \brief Structure for SIP transport information
48  */
49 struct ast_sip_transport_state {
50         /*! \brief Transport itself */
51         struct pjsip_transport *transport;
52
53         /*! \brief Transport factory */
54         struct pjsip_tpfactory *factory;
55 };
56
57 #define SIP_SORCERY_DOMAIN_ALIAS_TYPE "domain_alias"
58
59 /*!
60  * Details about a SIP domain alias
61  */
62 struct ast_sip_domain_alias {
63         /*! Sorcery object details */
64         SORCERY_OBJECT(details);
65         AST_DECLARE_STRING_FIELDS(
66                 /*! Domain to be aliased to */
67                 AST_STRING_FIELD(domain);
68         );
69 };
70
71 /*! \brief Maximum number of ciphers supported for a TLS transport */
72 #define SIP_TLS_MAX_CIPHERS 64
73
74 /*
75  * \brief Transport to bind to
76  */
77 struct ast_sip_transport {
78         /*! Sorcery object details */
79         SORCERY_OBJECT(details);
80         AST_DECLARE_STRING_FIELDS(
81                 /*! Certificate of authority list file */
82                 AST_STRING_FIELD(ca_list_file);
83                 /*! Public certificate file */
84                 AST_STRING_FIELD(cert_file);
85                 /*! Optional private key of the certificate file */
86                 AST_STRING_FIELD(privkey_file);
87                 /*! Password to open the private key */
88                 AST_STRING_FIELD(password);
89                 /*! External signaling address */
90                 AST_STRING_FIELD(external_signaling_address);
91                 /*! External media address */
92                 AST_STRING_FIELD(external_media_address);
93                 /*! Optional domain to use for messages if provided could not be found */
94                 AST_STRING_FIELD(domain);
95                 );
96         /*! Type of transport */
97         enum ast_transport type;
98         /*! Address and port to bind to */
99         pj_sockaddr host;
100         /*! Number of simultaneous asynchronous operations */
101         unsigned int async_operations;
102         /*! Optional external port for signaling */
103         unsigned int external_signaling_port;
104         /*! TLS settings */
105         pjsip_tls_setting tls;
106         /*! Configured TLS ciphers */
107         pj_ssl_cipher ciphers[SIP_TLS_MAX_CIPHERS];
108         /*! Optional local network information, used for NAT purposes */
109         struct ast_ha *localnet;
110         /*! DNS manager for refreshing the external address */
111         struct ast_dnsmgr_entry *external_address_refresher;
112         /*! Optional external address information */
113         struct ast_sockaddr external_address;
114         /*! Transport state information */
115         struct ast_sip_transport_state *state;
116 };
117
118 /*!
119  * \brief Structure for SIP nat hook information
120  */
121 struct ast_sip_nat_hook {
122         /*! Sorcery object details */
123         SORCERY_OBJECT(details);
124         /*! Callback for when a message is going outside of our local network */
125         void (*outgoing_external_message)(struct pjsip_tx_data *tdata, struct ast_sip_transport *transport);
126 };
127
128 /*!
129  * \brief Contact associated with an address of record
130  */
131 struct ast_sip_contact {
132         /*! Sorcery object details, the id is the aor name plus a random string */
133         SORCERY_OBJECT(details);
134         AST_DECLARE_STRING_FIELDS(
135                 /*! Full URI of the contact */
136                 AST_STRING_FIELD(uri);
137         );
138         /*! Absolute time that this contact is no longer valid after */
139         struct timeval expiration_time;
140 };
141
142 /*!
143  * \brief A SIP address of record
144  */
145 struct ast_sip_aor {
146         /*! Sorcery object details, the id is the AOR name */
147         SORCERY_OBJECT(details);
148         AST_DECLARE_STRING_FIELDS(
149                 /*! Voicemail boxes for this AOR */
150                 AST_STRING_FIELD(mailboxes);
151         );
152         /*! Minimum expiration time */
153         unsigned int minimum_expiration;
154         /*! Maximum expiration time */
155         unsigned int maximum_expiration;
156         /*! Default contact expiration if one is not provided in the contact */
157         unsigned int default_expiration;
158         /*! Maximum number of external contacts, 0 to disable */
159         unsigned int max_contacts;
160         /*! Whether to remove any existing contacts not related to an incoming REGISTER when it comes in */
161         unsigned int remove_existing;
162         /*! Any permanent configured contacts */
163         struct ao2_container *permanent_contacts;
164 };
165
166 /*!
167  * \brief DTMF modes for SIP endpoints
168  */
169 enum ast_sip_dtmf_mode {
170         /*! No DTMF to be used */
171         AST_SIP_DTMF_NONE,
172         /* XXX Should this be 2833 instead? */
173         /*! Use RFC 4733 events for DTMF */
174         AST_SIP_DTMF_RFC_4733,
175         /*! Use DTMF in the audio stream */
176         AST_SIP_DTMF_INBAND,
177         /*! Use SIP INFO DTMF (blech) */
178         AST_SIP_DTMF_INFO,
179 };
180
181 /*!
182  * \brief Methods of storing SIP digest authentication credentials.
183  *
184  * Note that both methods result in MD5 digest authentication being
185  * used. The two methods simply alter how Asterisk determines the
186  * credentials for a SIP authentication
187  */
188 enum ast_sip_auth_type {
189         /*! Credentials stored as a username and password combination */
190         AST_SIP_AUTH_TYPE_USER_PASS,
191         /*! Credentials stored as an MD5 sum */
192         AST_SIP_AUTH_TYPE_MD5,
193 };
194
195 #define SIP_SORCERY_AUTH_TYPE "auth"
196
197 struct ast_sip_auth {
198         /* Sorcery ID of the auth is its name */
199         SORCERY_OBJECT(details);
200         AST_DECLARE_STRING_FIELDS(
201                 /* Identification for these credentials */
202                 AST_STRING_FIELD(realm);
203                 /* Authentication username */
204                 AST_STRING_FIELD(auth_user);
205                 /* Authentication password */
206                 AST_STRING_FIELD(auth_pass);
207                 /* Authentication credentials in MD5 format (hash of user:realm:pass) */
208                 AST_STRING_FIELD(md5_creds);
209         );
210         /* The time period (in seconds) that a nonce may be reused */
211         unsigned int nonce_lifetime;
212         /* Used to determine what to use when authenticating */
213         enum ast_sip_auth_type type;
214 };
215
216 /*!
217  * \brief Different methods by which incoming requests can be matched to endpoints
218  */
219 enum ast_sip_endpoint_identifier_type {
220         /*! Identify based on user name in From header */
221         AST_SIP_ENDPOINT_IDENTIFY_BY_USERNAME = (1 << 0),
222         /*! Identify based on source location of the SIP message */
223         AST_SIP_ENDPOINT_IDENTIFY_BY_LOCATION = (1 << 1),
224 };
225
226 enum ast_sip_session_refresh_method {
227         /*! Use reinvite to negotiate direct media */
228         AST_SIP_SESSION_REFRESH_METHOD_INVITE,
229         /*! Use UPDATE to negotiate direct media */
230         AST_SIP_SESSION_REFRESH_METHOD_UPDATE,
231 };
232
233 enum ast_sip_direct_media_glare_mitigation {
234         /*! Take no special action to mitigate reinvite glare */
235         AST_SIP_DIRECT_MEDIA_GLARE_MITIGATION_NONE,
236         /*! Do not send an initial direct media session refresh on outgoing call legs
237          * Subsequent session refreshes will be sent no matter the session direction
238          */
239         AST_SIP_DIRECT_MEDIA_GLARE_MITIGATION_OUTGOING,
240         /*! Do not send an initial direct media session refresh on incoming call legs
241          * Subsequent session refreshes will be sent no matter the session direction
242          */
243         AST_SIP_DIRECT_MEDIA_GLARE_MITIGATION_INCOMING,
244 };
245
246 /*!
247  * \brief An entity with which Asterisk communicates
248  */
249 struct ast_sip_endpoint {
250         SORCERY_OBJECT(details);
251         AST_DECLARE_STRING_FIELDS(
252                 /*! Context to send incoming calls to */
253                 AST_STRING_FIELD(context);
254                 /*! Name of an explicit transport to use */
255                 AST_STRING_FIELD(transport);
256                 /*! Outbound proxy to use */
257                 AST_STRING_FIELD(outbound_proxy);
258                 /*! Explicit AORs to dial if none are specified */
259                 AST_STRING_FIELD(aors);
260                 /*! Musiconhold class to suggest that the other side use when placing on hold */
261                 AST_STRING_FIELD(mohsuggest);
262                 /*! Optional external media address to use in SDP */
263                 AST_STRING_FIELD(external_media_address);
264                 /*! Configured voicemail boxes for this endpoint. Used for MWI */
265                 AST_STRING_FIELD(mailboxes);
266         );
267         /*! Identification information for this endpoint */
268         struct ast_party_id id;
269         /*! Domain to which this endpoint belongs */
270         struct ast_sip_domain *domain;
271         /*! Address of record for incoming registrations */
272         struct ast_sip_aor *aor;
273         /*! Codec preferences */
274         struct ast_codec_pref prefs;
275         /*! Configured codecs */
276         struct ast_format_cap *codecs;
277         /*! Names of inbound authentication credentials */
278         const char **sip_inbound_auths;
279         /*! Number of configured auths */
280         size_t num_inbound_auths;
281         /*! Names of outbound authentication credentials */
282         const char **sip_outbound_auths;
283         /*! Number of configured outbound auths */
284         size_t num_outbound_auths;
285         /*! DTMF mode to use with this endpoint */
286         enum ast_sip_dtmf_mode dtmf;
287         /*! Whether IPv6 RTP is enabled or not */
288         unsigned int rtp_ipv6;
289         /*! Whether symmetric RTP is enabled or not */
290         unsigned int rtp_symmetric;
291         /*! Whether ICE support is enabled or not */
292         unsigned int ice_support;
293         /*! Whether to use the "ptime" attribute received from the endpoint or not */
294         unsigned int use_ptime;
295         /*! Whether to force using the source IP address/port for sending responses */
296         unsigned int force_rport;
297         /*! Whether to rewrite the Contact header with the source IP address/port or not */
298         unsigned int rewrite_contact;
299         /*! Enabled SIP extensions */
300         unsigned int extensions;
301         /*! Minimum session expiration period, in seconds */
302         unsigned int min_se;
303         /*! Session expiration period, in seconds */
304         unsigned int sess_expires;
305         /*! List of outbound registrations */
306         AST_LIST_HEAD_NOLOCK(, ast_sip_registration) registrations;
307         /*! Frequency to send OPTIONS requests to endpoint. 0 is disabled. */
308         unsigned int qualify_frequency;
309         /*! Method(s) by which the endpoint should be identified. */
310         enum ast_sip_endpoint_identifier_type ident_method;
311         /*! Boolean indicating if direct_media is permissible */
312         unsigned int direct_media;
313         /*! When using direct media, which method should be used */
314         enum ast_sip_session_refresh_method direct_media_method;
315         /*! Take steps to mitigate glare for direct media */
316         enum ast_sip_direct_media_glare_mitigation direct_media_glare_mitigation;
317         /*! Do not attempt direct media session refreshes if a media NAT is detected */
318         unsigned int disable_direct_media_on_nat;
319         /*! Do we trust the endpoint with our outbound identity? */
320         unsigned int trust_id_outbound;
321         /*! Do we trust identity information that originates externally (e.g. P-Asserted-Identity header)? */
322         unsigned int trust_id_inbound;
323         /*! Do we send P-Asserted-Identity headers to this endpoint? */
324         unsigned int send_pai;
325         /*! Do we send Remote-Party-ID headers to this endpoint? */
326         unsigned int send_rpid;
327         /*! Should unsolicited MWI be aggregated into a single NOTIFY? */
328         unsigned int aggregate_mwi;
329 };
330
331 /*!
332  * \brief Possible returns from ast_sip_check_authentication
333  */
334 enum ast_sip_check_auth_result {
335     /*! Authentication needs to be challenged */
336     AST_SIP_AUTHENTICATION_CHALLENGE,
337     /*! Authentication succeeded */
338     AST_SIP_AUTHENTICATION_SUCCESS,
339     /*! Authentication failed */
340     AST_SIP_AUTHENTICATION_FAILED,
341     /*! Authentication encountered some internal error */
342     AST_SIP_AUTHENTICATION_ERROR,
343 };
344
345 /*!
346  * \brief An interchangeable way of handling digest authentication for SIP.
347  *
348  * An authenticator is responsible for filling in the callbacks provided below. Each is called from a publicly available
349  * function in res_sip. The authenticator can use configuration or other local policy to determine whether authentication
350  * should take place and what credentials should be used when challenging and authenticating a request.
351  */
352 struct ast_sip_authenticator {
353     /*!
354      * \brief Check if a request requires authentication
355      * See ast_sip_requires_authentication for more details
356      */
357     int (*requires_authentication)(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata);
358         /*!
359          * \brief Check that an incoming request passes authentication.
360          *
361          * The tdata parameter is useful for adding information such as digest challenges.
362          *
363          * \param endpoint The endpoint sending the incoming request
364          * \param rdata The incoming request
365          * \param tdata Tentative outgoing request.
366          */
367         enum ast_sip_check_auth_result (*check_authentication)(struct ast_sip_endpoint *endpoint,
368                         pjsip_rx_data *rdata, pjsip_tx_data *tdata);
369 };
370
371 /*!
372  * \brief an interchangeable way of responding to authentication challenges
373  *
374  * An outbound authenticator takes incoming challenges and formulates a new SIP request with
375  * credentials.
376  */
377 struct ast_sip_outbound_authenticator {
378         /*!
379          * \brief Create a new request with authentication credentials
380          *
381          * \param auths An array of IDs of auth sorcery objects
382          * \param num_auths The number of IDs in the array
383          * \param challenge The SIP response with authentication challenge(s)
384          * \param tsx The transaction in which the challenge was received
385          * \param new_request The new SIP request with challenge response(s)
386          * \retval 0 Successfully created new request
387          * \retval -1 Failed to create a new request
388          */
389         int (*create_request_with_auth)(const char **auths, size_t num_auths, struct pjsip_rx_data *challenge,
390                         struct pjsip_transaction *tsx, struct pjsip_tx_data **new_request);
391 };
392
393 /*!
394  * \brief An entity responsible for identifying the source of a SIP message
395  */
396 struct ast_sip_endpoint_identifier {
397     /*!
398      * \brief Callback used to identify the source of a message.
399      * See ast_sip_identify_endpoint for more details
400      */
401     struct ast_sip_endpoint *(*identify_endpoint)(pjsip_rx_data *rdata);
402 };
403
404 /*!
405  * \brief Register a SIP service in Asterisk.
406  *
407  * This is more-or-less a wrapper around pjsip_endpt_register_module().
408  * Registering a service makes it so that PJSIP will call into the
409  * service at appropriate times. For more information about PJSIP module
410  * callbacks, see the PJSIP documentation. Asterisk modules that call
411  * this function will likely do so at module load time.
412  *
413  * \param module The module that is to be registered with PJSIP
414  * \retval 0 Success
415  * \retval -1 Failure
416  */
417 int ast_sip_register_service(pjsip_module *module);
418
419 /*!
420  * This is the opposite of ast_sip_register_service().  Unregistering a
421  * service means that PJSIP will no longer call into the module any more.
422  * This will likely occur when an Asterisk module is unloaded.
423  *
424  * \param module The PJSIP module to unregister
425  */
426 void ast_sip_unregister_service(pjsip_module *module);
427
428 /*!
429  * \brief Register a SIP authenticator
430  *
431  * An authenticator has three main purposes:
432  * 1) Determining if authentication should be performed on an incoming request
433  * 2) Gathering credentials necessary for issuing an authentication challenge
434  * 3) Authenticating a request that has credentials
435  *
436  * Asterisk provides a default authenticator, but it may be replaced by a
437  * custom one if desired.
438  *
439  * \param auth The authenticator to register
440  * \retval 0 Success
441  * \retval -1 Failure
442  */
443 int ast_sip_register_authenticator(struct ast_sip_authenticator *auth);
444
445 /*!
446  * \brief Unregister a SIP authenticator
447  *
448  * When there is no authenticator registered, requests cannot be challenged
449  * or authenticated.
450  *
451  * \param auth The authenticator to unregister
452  */
453 void ast_sip_unregister_authenticator(struct ast_sip_authenticator *auth);
454
455  /*!
456  * \brief Register an outbound SIP authenticator
457  *
458  * An outbound authenticator is responsible for creating responses to
459  * authentication challenges by remote endpoints.
460  *
461  * \param auth The authenticator to register
462  * \retval 0 Success
463  * \retval -1 Failure
464  */
465 int ast_sip_register_outbound_authenticator(struct ast_sip_outbound_authenticator *outbound_auth);
466
467 /*!
468  * \brief Unregister an outbound SIP authenticator
469  *
470  * When there is no outbound authenticator registered, authentication challenges
471  * will be handled as any other final response would be.
472  *
473  * \param auth The authenticator to unregister
474  */
475 void ast_sip_unregister_outbound_authenticator(struct ast_sip_outbound_authenticator *auth);
476
477 /*!
478  * \brief Register a SIP endpoint identifier
479  *
480  * An endpoint identifier's purpose is to determine which endpoint a given SIP
481  * message has come from.
482  *
483  * Multiple endpoint identifiers may be registered so that if an endpoint
484  * cannot be identified by one identifier, it may be identified by another.
485  *
486  * Asterisk provides two endpoint identifiers. One identifies endpoints based
487  * on the user part of the From header URI. The other identifies endpoints based
488  * on the source IP address.
489  *
490  * If the order in which endpoint identifiers is run is important to you, then
491  * be sure to load individual endpoint identifier modules in the order you wish
492  * for them to be run in modules.conf
493  *
494  * \param identifier The SIP endpoint identifier to register
495  * \retval 0 Success
496  * \retval -1 Failure
497  */
498 int ast_sip_register_endpoint_identifier(struct ast_sip_endpoint_identifier *identifier);
499
500 /*!
501  * \brief Unregister a SIP endpoint identifier
502  *
503  * This stops an endpoint identifier from being used.
504  *
505  * \param identifier The SIP endoint identifier to unregister
506  */
507 void ast_sip_unregister_endpoint_identifier(struct ast_sip_endpoint_identifier *identifier);
508
509 /*!
510  * \brief Allocate a new SIP endpoint
511  *
512  * This will return an endpoint with its refcount increased by one. This reference
513  * can be released using ao2_ref().
514  *
515  * \param name The name of the endpoint.
516  * \retval NULL Endpoint allocation failed
517  * \retval non-NULL The newly allocated endpoint
518  */
519 void *ast_sip_endpoint_alloc(const char *name);
520
521 /*!
522  * \brief Get a pointer to the PJSIP endpoint.
523  *
524  * This is useful when modules have specific information they need
525  * to register with the PJSIP core.
526  * \retval NULL endpoint has not been created yet.
527  * \retval non-NULL PJSIP endpoint.
528  */
529 pjsip_endpoint *ast_sip_get_pjsip_endpoint(void);
530
531 /*!
532  * \brief Get a pointer to the SIP sorcery structure.
533  *
534  * \retval NULL sorcery has not been initialized
535  * \retval non-NULL sorcery structure
536  */
537 struct ast_sorcery *ast_sip_get_sorcery(void);
538
539 /*!
540  * \brief Initialize transport support on a sorcery instance
541  *
542  * \param sorcery The sorcery instance
543  *
544  * \retval -1 failure
545  * \retval 0 success
546  */
547 int ast_sip_initialize_sorcery_transport(struct ast_sorcery *sorcery);
548
549 /*!
550  * \brief Initialize location support on a sorcery instance
551  *
552  * \param sorcery The sorcery instance
553  *
554  * \retval -1 failure
555  * \retval 0 success
556  */
557 int ast_sip_initialize_sorcery_location(struct ast_sorcery *sorcery);
558
559 /*!
560  * \brief Retrieve a named AOR
561  *
562  * \param aor_name Name of the AOR
563  *
564  * \retval NULL if not found
565  * \retval non-NULL if found
566  */
567 struct ast_sip_aor *ast_sip_location_retrieve_aor(const char *aor_name);
568
569 /*!
570  * \brief Retrieve the first bound contact for an AOR
571  *
572  * \param aor Pointer to the AOR
573  * \retval NULL if no contacts available
574  * \retval non-NULL if contacts available
575  */
576 struct ast_sip_contact *ast_sip_location_retrieve_first_aor_contact(const struct ast_sip_aor *aor);
577
578 /*!
579  * \brief Retrieve all contacts currently available for an AOR
580  *
581  * \param aor Pointer to the AOR
582  *
583  * \retval NULL if no contacts available
584  * \retval non-NULL if contacts available
585  */
586 struct ao2_container *ast_sip_location_retrieve_aor_contacts(const struct ast_sip_aor *aor);
587
588 /*!
589  * \brief Retrieve the first bound contact from a list of AORs
590  *
591  * \param aor_list A comma-separated list of AOR names
592  * \retval NULL if no contacts available
593  * \retval non-NULL if contacts available
594  */
595 struct ast_sip_contact *ast_sip_location_retrieve_contact_from_aor_list(const char *aor_list);
596
597 /*!
598  * \brief Retrieve a named contact
599  *
600  * \param contact_name Name of the contact
601  *
602  * \retval NULL if not found
603  * \retval non-NULL if found
604  */
605 struct ast_sip_contact *ast_sip_location_retrieve_contact(const char *contact_name);
606
607 /*!
608  * \brief Add a new contact to an AOR
609  *
610  * \param aor Pointer to the AOR
611  * \param uri Full contact URI
612  * \param expiration_time Optional expiration time of the contact
613  *
614  * \retval -1 failure
615  * \retval 0 success
616  */
617 int ast_sip_location_add_contact(struct ast_sip_aor *aor, const char *uri, struct timeval expiration_time);
618
619 /*!
620  * \brief Update a contact
621  *
622  * \param contact New contact object with details
623  *
624  * \retval -1 failure
625  * \retval 0 success
626  */
627 int ast_sip_location_update_contact(struct ast_sip_contact *contact);
628
629 /*!
630 * \brief Delete a contact
631 *
632 * \param contact Contact object to delete
633 *
634 * \retval -1 failure
635 * \retval 0 success
636 */
637 int ast_sip_location_delete_contact(struct ast_sip_contact *contact);
638
639 /*!
640  * \brief Initialize domain aliases support on a sorcery instance
641  *
642  * \param sorcery The sorcery instance
643  *
644  * \retval -1 failure
645  * \retval 0 success
646  */
647 int ast_sip_initialize_sorcery_domain_alias(struct ast_sorcery *sorcery);
648
649 /*!
650  * \brief Initialize authentication support on a sorcery instance
651  *
652  * \param sorcery The sorcery instance
653  *
654  * \retval -1 failure
655  * \retval 0 success
656  */
657 int ast_sip_initialize_sorcery_auth(struct ast_sorcery *sorcery);
658
659 /*!
660  * \brief Callback called when an outbound request with authentication credentials is to be sent in dialog
661  *
662  * This callback will have the created request on it. The callback's purpose is to do any extra
663  * housekeeping that needs to be done as well as to send the request out.
664  *
665  * This callback is only necessary if working with a PJSIP API that sits between the application
666  * and the dialog layer.
667  *
668  * \param dlg The dialog to which the request belongs
669  * \param tdata The created request to be sent out
670  * \param user_data Data supplied with the callback
671  *
672  * \retval 0 Success
673  * \retval -1 Failure
674  */
675 typedef int (*ast_sip_dialog_outbound_auth_cb)(pjsip_dialog *dlg, pjsip_tx_data *tdata, void *user_data);
676
677 /*!
678  * \brief Set up outbound authentication on a SIP dialog
679  *
680  * This sets up the infrastructure so that all requests associated with a created dialog
681  * can be re-sent with authentication credentials if the original request is challenged.
682  *
683  * \param dlg The dialog on which requests will be authenticated
684  * \param endpoint The endpoint whom this dialog pertains to
685  * \param cb Callback to call to send requests with authentication
686  * \param user_data Data to be provided to the callback when it is called
687  *
688  * \retval 0 Success
689  * \retval -1 Failure
690  */
691 int ast_sip_dialog_setup_outbound_authentication(pjsip_dialog *dlg, const struct ast_sip_endpoint *endpoint,
692                 ast_sip_dialog_outbound_auth_cb cb, void *user_data);
693
694 /*!
695  * \brief Initialize the distributor module
696  *
697  * The distributor module is responsible for taking an incoming
698  * SIP message and placing it into the threadpool. Once in the threadpool,
699  * the distributor will perform endpoint lookups and authentication, and
700  * then distribute the message up the stack to any further modules.
701  *
702  * \retval -1 Failure
703  * \retval 0 Success
704  */
705 int ast_sip_initialize_distributor(void);
706
707 /*!
708  * \page Threading model for SIP
709  *
710  * There are three major types of threads that SIP will have to deal with:
711  * \li Asterisk threads
712  * \li PJSIP threads
713  * \li SIP threadpool threads (a.k.a. "servants")
714  *
715  * \par Asterisk Threads
716  *
717  * Asterisk threads are those that originate from outside of SIP but within
718  * Asterisk. The most common of these threads are PBX (channel) threads and
719  * the autoservice thread. Most interaction with these threads will be through
720  * channel technology callbacks. Within these threads, it is fine to handle
721  * Asterisk data from outside of SIP, but any handling of SIP data should be
722  * left to servants, \b especially if you wish to call into PJSIP for anything.
723  * Asterisk threads are not registered with PJLIB, so attempting to call into
724  * PJSIP will cause an assertion to be triggered, thus causing the program to
725  * crash.
726  *
727  * \par PJSIP Threads
728  *
729  * PJSIP threads are those that originate from handling of PJSIP events, such
730  * as an incoming SIP request or response, or a transaction timeout. The role
731  * of these threads is to process information as quickly as possible so that
732  * the next item on the SIP socket(s) can be serviced. On incoming messages,
733  * Asterisk automatically will push the request to a servant thread. When your
734  * module callback is called, processing will already be in a servant. However,
735  * for other PSJIP events, such as transaction state changes due to timer
736  * expirations, your module will be called into from a PJSIP thread. If you
737  * are called into from a PJSIP thread, then you should push whatever processing
738  * is needed to a servant as soon as possible. You can discern if you are currently
739  * in a SIP servant thread using the \ref ast_sip_thread_is_servant function.
740  *
741  * \par Servants
742  *
743  * Servants are where the bulk of SIP work should be performed. These threads
744  * exist in order to do the work that Asterisk threads and PJSIP threads hand
745  * off to them. Servant threads register themselves with PJLIB, meaning that
746  * they are capable of calling PJSIP and PJLIB functions if they wish.
747  *
748  * \par Serializer
749  *
750  * Tasks are handed off to servant threads using the API call \ref ast_sip_push_task.
751  * The first parameter of this call is a serializer. If this pointer
752  * is NULL, then the work will be handed off to whatever servant can currently handle
753  * the task. If this pointer is non-NULL, then the task will not be executed until
754  * previous tasks pushed with the same serializer have completed. For more information
755  * on serializers and the benefits they provide, see \ref ast_threadpool_serializer
756  *
757  * \note
758  *
759  * Do not make assumptions about individual threads based on a corresponding serializer.
760  * In other words, just because several tasks use the same serializer when being pushed
761  * to servants, it does not mean that the same thread is necessarily going to execute those
762  * tasks, even though they are all guaranteed to be executed in sequence.
763  */
764
765 /*!
766  * \brief Create a new serializer for SIP tasks
767  *
768  * See \ref ast_threadpool_serializer for more information on serializers.
769  * SIP creates serializers so that tasks operating on similar data will run
770  * in sequence.
771  *
772  * \retval NULL Failure
773  * \retval non-NULL Newly-created serializer
774  */
775 struct ast_taskprocessor *ast_sip_create_serializer(void);
776
777 /*!
778  * \brief Set a serializer on a SIP dialog so requests and responses are automatically serialized
779  *
780  * Passing a NULL serializer is a way to remove a serializer from a dialog.
781  *
782  * \param dlg The SIP dialog itself
783  * \param serializer The serializer to use
784  */
785 void ast_sip_dialog_set_serializer(pjsip_dialog *dlg, struct ast_taskprocessor *serializer);
786
787 /*!
788  * \brief Set an endpoint on a SIP dialog so in-dialog requests do not undergo endpoint lookup.
789  *
790  * \param dlg The SIP dialog itself
791  * \param endpoint The endpoint that this dialog is communicating with
792  */
793 void ast_sip_dialog_set_endpoint(pjsip_dialog *dlg, struct ast_sip_endpoint *endpoint);
794
795 /*!
796  * \brief Get the endpoint associated with this dialog
797  *
798  * This function increases the refcount of the endpoint by one. Release
799  * the reference once you are finished with the endpoint.
800  *
801  * \param dlg The SIP dialog from which to retrieve the endpoint
802  * \retval NULL No endpoint associated with this dialog
803  * \retval non-NULL The endpoint.
804  */
805 struct ast_sip_endpoint *ast_sip_dialog_get_endpoint(pjsip_dialog *dlg);
806
807 /*!
808  * \brief Pushes a task to SIP servants
809  *
810  * This uses the serializer provided to determine how to push the task.
811  * If the serializer is NULL, then the task will be pushed to the
812  * servants directly. If the serializer is non-NULL, then the task will be
813  * queued behind other tasks associated with the same serializer.
814  *
815  * \param serializer The serializer to which the task belongs. Can be NULL
816  * \param sip_task The task to execute
817  * \param task_data The parameter to pass to the task when it executes
818  * \retval 0 Success
819  * \retval -1 Failure
820  */
821 int ast_sip_push_task(struct ast_taskprocessor *serializer, int (*sip_task)(void *), void *task_data);
822
823 /*!
824  * \brief Push a task to SIP servants and wait for it to complete
825  *
826  * Like \ref ast_sip_push_task except that it blocks until the task completes.
827  *
828  * \warning \b Never use this function in a SIP servant thread. This can potentially
829  * cause a deadlock. If you are in a SIP servant thread, just call your function
830  * in-line.
831  *
832  * \param serializer The SIP serializer to which the task belongs. May be NULL.
833  * \param sip_task The task to execute
834  * \param task_data The parameter to pass to the task when it executes
835  * \retval 0 Success
836  * \retval -1 Failure
837  */
838 int ast_sip_push_task_synchronous(struct ast_taskprocessor *serializer, int (*sip_task)(void *), void *task_data);
839
840 /*!
841  * \brief Determine if the current thread is a SIP servant thread
842  *
843  * \retval 0 This is not a SIP servant thread
844  * \retval 1 This is a SIP servant thread
845  */
846 int ast_sip_thread_is_servant(void);
847
848 /*!
849  * \brief SIP body description
850  *
851  * This contains a type and subtype that will be added as
852  * the "Content-Type" for the message as well as the body
853  * text.
854  */
855 struct ast_sip_body {
856         /*! Type of the body, such as "application" */
857         const char *type;
858         /*! Subtype of the body, such as "sdp" */
859         const char *subtype;
860         /*! The text to go in the body */
861         const char *body_text;
862 };
863
864 /*!
865  * \brief General purpose method for creating a dialog with an endpoint
866  *
867  * \param endpoint A pointer to the endpoint
868  * \param aor_name Optional name of the AOR to target, may even be an explicit SIP URI
869  * \param request_user Optional user to place into the target URI
870  *
871  * \retval non-NULL success
872  * \retval NULL failure
873  */
874  pjsip_dialog *ast_sip_create_dialog(const struct ast_sip_endpoint *endpoint, const char *aor_name, const char *request_user);
875
876 /*!
877  * \brief General purpose method for creating a SIP request
878  *
879  * Its typical use would be to create one-off requests such as an out of dialog
880  * SIP MESSAGE.
881  *
882  * The request can either be in- or out-of-dialog. If in-dialog, the
883  * dlg parameter MUST be present. If out-of-dialog the endpoint parameter
884  * MUST be present. If both are present, then we will assume that the message
885  * is to be sent in-dialog.
886  *
887  * The uri parameter can be specified if the request should be sent to an explicit
888  * URI rather than one configured on the endpoint.
889  *
890  * \param method The method of the SIP request to send
891  * \param dlg Optional. If specified, the dialog on which to request the message.
892  * \param endpoint Optional. If specified, the request will be created out-of-dialog
893  * to the endpoint.
894  * \param uri Optional. If specified, the request will be sent to this URI rather
895  * than one configured for the endpoint.
896  * \param[out] tdata The newly-created request
897  * \retval 0 Success
898  * \retval -1 Failure
899  */
900 int ast_sip_create_request(const char *method, struct pjsip_dialog *dlg,
901                 struct ast_sip_endpoint *endpoint, const char *uri, pjsip_tx_data **tdata);
902
903 /*!
904  * \brief General purpose method for sending a SIP request
905  *
906  * This is a companion function for \ref ast_sip_create_request. The request
907  * created there can be passed to this function, though any request may be
908  * passed in.
909  *
910  * This will automatically set up handling outbound authentication challenges if
911  * they arrive.
912  *
913  * \param tdata The request to send
914  * \param dlg Optional. If specified, the dialog on which the request should be sent
915  * \param endpoint Optional. If specified, the request is sent out-of-dialog to the endpoint.
916  * \retval 0 Success
917  * \retval -1 Failure
918  */
919 int ast_sip_send_request(pjsip_tx_data *tdata, struct pjsip_dialog *dlg, struct ast_sip_endpoint *endpoint);
920
921 /*!
922  * \brief Determine if an incoming request requires authentication
923  *
924  * This calls into the registered authenticator's requires_authentication callback
925  * in order to determine if the request requires authentication.
926  *
927  * If there is no registered authenticator, then authentication will be assumed
928  * not to be required.
929  *
930  * \param endpoint The endpoint from which the request originates
931  * \param rdata The incoming SIP request
932  * \retval non-zero The request requires authentication
933  * \retval 0 The request does not require authentication
934  */
935 int ast_sip_requires_authentication(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata);
936
937 /*!
938  * \brief Method to determine authentication status of an incoming request
939  *
940  * This will call into a registered authenticator. The registered authenticator will
941  * do what is necessary to determine whether the incoming request passes authentication.
942  * A tentative response is passed into this function so that if, say, a digest authentication
943  * challenge should be sent in the ensuing response, it can be added to the response.
944  *
945  * \param endpoint The endpoint from the request was sent
946  * \param rdata The request to potentially authenticate
947  * \param tdata Tentative response to the request
948  * \return The result of checking authentication.
949  */
950 enum ast_sip_check_auth_result ast_sip_check_authentication(struct ast_sip_endpoint *endpoint,
951                 pjsip_rx_data *rdata, pjsip_tx_data *tdata);
952
953 /*!
954  * \brief Create a response to an authentication challenge
955  *
956  * This will call into an outbound authenticator's create_request_with_auth callback
957  * to create a new request with authentication credentials. See the create_request_with_auth
958  * callback in the \ref ast_sip_outbound_authenticator structure for details about
959  * the parameters and return values.
960  */
961 int ast_sip_create_request_with_auth(const char **auths, size_t num_auths, pjsip_rx_data *challenge,
962                 pjsip_transaction *tsx, pjsip_tx_data **new_request);
963
964 /*!
965  * \brief Determine the endpoint that has sent a SIP message
966  *
967  * This will call into each of the registered endpoint identifiers'
968  * identify_endpoint() callbacks until one returns a non-NULL endpoint.
969  * This will return an ao2 object. Its reference count will need to be
970  * decremented when completed using the endpoint.
971  *
972  * \param rdata The inbound SIP message to use when identifying the endpoint.
973  * \retval NULL No matching endpoint
974  * \retval non-NULL The matching endpoint
975  */
976 struct ast_sip_endpoint *ast_sip_identify_endpoint(pjsip_rx_data *rdata);
977
978 /*!
979  * \brief Add a header to an outbound SIP message
980  *
981  * \param tdata The message to add the header to
982  * \param name The header name
983  * \param value The header value
984  * \retval 0 Success
985  * \retval -1 Failure
986  */
987 int ast_sip_add_header(pjsip_tx_data *tdata, const char *name, const char *value);
988
989 /*!
990  * \brief Add a body to an outbound SIP message
991  *
992  * If this is called multiple times, the latest body will replace the current
993  * body.
994  *
995  * \param tdata The message to add the body to
996  * \param body The message body to add
997  * \retval 0 Success
998  * \retval -1 Failure
999  */
1000 int ast_sip_add_body(pjsip_tx_data *tdata, const struct ast_sip_body *body);
1001
1002 /*!
1003  * \brief Add a multipart body to an outbound SIP message
1004  *
1005  * This will treat each part of the input array as part of a multipart body and
1006  * add each part to the SIP message.
1007  *
1008  * \param tdata The message to add the body to
1009  * \param bodies The parts of the body to add
1010  * \retval 0 Success
1011  * \retval -1 Failure
1012  */
1013 int ast_sip_add_body_multipart(pjsip_tx_data *tdata, const struct ast_sip_body *bodies[], int num_bodies);
1014
1015 /*!
1016  * \brief Append body data to a SIP message
1017  *
1018  * This acts mostly the same as ast_sip_add_body, except that rather than replacing
1019  * a body if it currently exists, it appends data to an existing body.
1020  *
1021  * \param tdata The message to append the body to
1022  * \param body The string to append to the end of the current body
1023  * \retval 0 Success
1024  * \retval -1 Failure
1025  */
1026 int ast_sip_append_body(pjsip_tx_data *tdata, const char *body_text);
1027
1028 /*!
1029  * \brief Copy a pj_str_t into a standard character buffer.
1030  *
1031  * pj_str_t is not NULL-terminated. Any place that expects a NULL-
1032  * terminated string needs to have the pj_str_t copied into a separate
1033  * buffer.
1034  *
1035  * This method copies the pj_str_t contents into the destination buffer
1036  * and NULL-terminates the buffer.
1037  *
1038  * \param dest The destination buffer
1039  * \param src The pj_str_t to copy
1040  * \param size The size of the destination buffer.
1041  */
1042 void ast_copy_pj_str(char *dest, pj_str_t *src, size_t size);
1043
1044 /*!
1045  * \brief Get the looked-up endpoint on an out-of dialog request or response
1046  *
1047  * The function may ONLY be called on out-of-dialog requests or responses. For
1048  * in-dialog requests and responses, it is required that the user of the dialog
1049  * has the looked-up endpoint stored locally.
1050  *
1051  * This function should never return NULL if the message is out-of-dialog. It will
1052  * always return NULL if the message is in-dialog.
1053  *
1054  * This function will increase the reference count of the returned endpoint by one.
1055  * Release your reference using the ao2_ref function when finished.
1056  *
1057  * \param rdata Out-of-dialog request or response
1058  * \return The looked up endpoint
1059  */
1060 struct ast_sip_endpoint *ast_pjsip_rdata_get_endpoint(pjsip_rx_data *rdata);
1061
1062 /*!
1063  * \brief Retrieve relevant SIP auth structures from sorcery
1064  *
1065  * \param auth_names The sorcery IDs of auths to retrieve
1066  * \param num_auths The number of auths to retrieve
1067  * \param[out] out The retrieved auths are stored here
1068  */
1069 int ast_sip_retrieve_auths(const char *auth_names[], size_t num_auths, struct ast_sip_auth **out);
1070
1071 /*!
1072  * \brief Clean up retrieved auth structures from memory
1073  *
1074  * Call this function once you have completed operating on auths
1075  * retrieved from \ref ast_sip_retrieve_auths
1076  *
1077  * \param auths An array of auth structures to clean up
1078  * \param num_auths The number of auths in the array
1079  */
1080 void ast_sip_cleanup_auths(struct ast_sip_auth *auths[], size_t num_auths);
1081
1082 #endif /* _RES_SIP_H */