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