PJSIP: Add Path header support
[asterisk/asterisk.git] / include / asterisk / res_pjsip_session.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_SESSION_H
20 #define _RES_PJSIP_SESSION_H
21
22 /* Needed for pj_timer_entry definition */
23 #include "pjlib.h"
24 #include "asterisk/linkedlists.h"
25 /* Needed for AST_MAX_EXTENSION constant */
26 #include "asterisk/channel.h"
27 /* Needed for ast_sockaddr struct */
28 #include "asterisk/netsock.h"
29 /* Needed for ast_sdp_srtp struct */
30 #include "asterisk/sdp_srtp.h"
31
32 /* Forward declarations */
33 struct ast_sip_endpoint;
34 struct ast_sip_transport;
35 struct pjsip_inv_session;
36 struct ast_channel;
37 struct ast_datastore;
38 struct ast_datastore_info;
39 struct ao2_container;
40 struct pjsip_tx_data;
41 struct pjsip_rx_data;
42 struct ast_party_id;
43 struct pjmedia_sdp_media;
44 struct pjmedia_sdp_session;
45 struct ast_dsp;
46 struct ast_udptl;
47
48 /*! \brief T.38 states for a session */
49 enum ast_sip_session_t38state {
50         T38_DISABLED = 0,   /*!< Not enabled */
51         T38_LOCAL_REINVITE, /*!< Offered from local - REINVITE */
52         T38_PEER_REINVITE,  /*!< Offered from peer - REINVITE */
53         T38_ENABLED,        /*!< Negotiated (enabled) */
54         T38_REJECTED,       /*!< Refused */
55         T38_MAX_ENUM,       /*!< Not an actual state; used as max value in the enum */
56 };
57
58 struct ast_sip_session_sdp_handler;
59
60 /*!
61  * \brief A structure containing SIP session media information
62  */
63 struct ast_sip_session_media {
64         union {
65                 /*! \brief RTP instance itself */
66                 struct ast_rtp_instance *rtp;
67                 /*! \brief UDPTL instance itself */
68                 struct ast_udptl *udptl;
69         };
70         /*! \brief Direct media address */
71         struct ast_sockaddr direct_media_addr;
72         /*! \brief SDP handler that setup the RTP */
73         struct ast_sip_session_sdp_handler *handler;
74         /*! \brief Holds SRTP information */
75         struct ast_sdp_srtp *srtp;
76         /*! \brief Stream is on hold */
77         unsigned int held:1;
78         /*! \brief Stream type this session media handles */
79         char stream_type[1];
80 };
81
82 /*!
83  * \brief Opaque structure representing a request that could not be sent
84  * due to an outstanding INVITE transaction
85  */
86 struct ast_sip_session_delayed_request;
87
88 /*!
89  * \brief A structure describing a SIP session
90  *
91  * For the sake of brevity, a "SIP session" in Asterisk is referring to
92  * a dialog initiated by an INVITE. While "session" is typically interpreted
93  * to refer to the negotiated media within a SIP dialog, we have opted
94  * to use the term "SIP session" to refer to the INVITE dialog itself.
95  */
96 struct ast_sip_session {
97         /* Dialplan extension where incoming call is destined */
98         char exten[AST_MAX_EXTENSION];
99         /* The endpoint with which Asterisk is communicating */
100         struct ast_sip_endpoint *endpoint;
101         /* The contact associated with this session */
102         struct ast_sip_contact *contact;
103         /* The PJSIP details of the session, which includes the dialog */
104         struct pjsip_inv_session *inv_session;
105         /* The Asterisk channel associated with the session */
106         struct ast_channel *channel;
107         /* Registered session supplements */
108         AST_LIST_HEAD(, ast_sip_session_supplement) supplements;
109         /* Datastores added to the session by supplements to the session */
110         struct ao2_container *datastores;
111         /* Media streams */
112         struct ao2_container *media;
113         /* Serializer for tasks relating to this SIP session */
114         struct ast_taskprocessor *serializer;
115         /* Requests that could not be sent due to current inv_session state */
116         AST_LIST_HEAD_NOLOCK(, ast_sip_session_delayed_request) delayed_requests;
117         /* When we need to reschedule a reinvite, we use this structure to do it */
118         pj_timer_entry rescheduled_reinvite;
119         /* Format capabilities pertaining to direct media */
120         struct ast_format_cap *direct_media_cap;
121         /* When we need to forcefully end the session */
122         pj_timer_entry scheduled_termination;
123         /* Identity of endpoint this session deals with */
124         struct ast_party_id id;
125         /* Requested capabilities */
126         struct ast_format_cap *req_caps;
127         /* Codecs overriden by dialplan on an outgoing request */
128         struct ast_codec_pref override_prefs;
129         /* Optional DSP, used only for inband DTMF detection if configured */
130         struct ast_dsp *dsp;
131         /* Whether the termination of the session should be deferred */
132         unsigned int defer_terminate:1;
133         /* Deferred incoming re-invite */
134         pjsip_rx_data *deferred_reinvite;
135         /* Current T.38 state */
136         enum ast_sip_session_t38state t38state;
137 };
138
139 typedef int (*ast_sip_session_request_creation_cb)(struct ast_sip_session *session, pjsip_tx_data *tdata);
140 typedef int (*ast_sip_session_response_cb)(struct ast_sip_session *session, pjsip_rx_data *rdata);
141 typedef int (*ast_sip_session_sdp_creation_cb)(struct ast_sip_session *session, pjmedia_sdp_session *sdp);
142
143 /*!
144  * \brief A supplement to SIP message processing
145  *
146  * These can be registered by any module in order to add
147  * processing to incoming and outgoing SIP requests and responses
148  */
149 struct ast_sip_session_supplement {
150     /*! Method on which to call the callbacks. If NULL, call on all methods */
151     const char *method;
152         /*! Priority for this supplement. Lower numbers are visited before higher numbers */
153         enum ast_sip_supplement_priority priority;
154     /*!
155          * \brief Notification that the session has begun
156          * This method will always be called from a SIP servant thread.
157          */
158     void (*session_begin)(struct ast_sip_session *session);
159     /*! 
160          * \brief Notification that the session has ended
161          *
162          * This method may or may not be called from a SIP servant thread. Do
163          * not make assumptions about being able to call PJSIP methods from within
164          * this method.
165          */
166     void (*session_end)(struct ast_sip_session *session);
167         /*!
168          * \brief Notification that the session is being destroyed
169          */
170         void (*session_destroy)(struct ast_sip_session *session);
171     /*!
172      * \brief Called on incoming SIP request
173      * This method can indicate a failure in processing in its return. If there
174      * is a failure, it is required that this method sends a response to the request.
175          * This method is always called from a SIP servant thread.
176          *
177          * \note
178          * The following PJSIP methods will not work properly:
179          * pjsip_rdata_get_dlg()
180          * pjsip_rdata_get_tsx()
181          * The reason is that the rdata passed into this function is a cloned rdata structure,
182          * and its module data is not copied during the cloning operation.
183          * If you need to get the dialog, you can get it via session->inv_session->dlg.
184          *
185          * \note
186          * There is no guarantee that a channel will be present on the session when this is called.
187      */
188     int (*incoming_request)(struct ast_sip_session *session, struct pjsip_rx_data *rdata);
189     /*! 
190          * \brief Called on an incoming SIP response
191          * This method is always called from a SIP servant thread.
192          *
193          * \note
194          * The following PJSIP methods will not work properly:
195          * pjsip_rdata_get_dlg()
196          * pjsip_rdata_get_tsx()
197          * The reason is that the rdata passed into this function is a cloned rdata structure,
198          * and its module data is not copied during the cloning operation.
199          * If you need to get the dialog, you can get it via session->inv_session->dlg.
200          *
201          * \note
202          * There is no guarantee that a channel will be present on the session when this is called.
203          */
204     void (*incoming_response)(struct ast_sip_session *session, struct pjsip_rx_data *rdata);
205     /*!
206          * \brief Called on an outgoing SIP request
207          * This method is always called from a SIP servant thread.
208          */
209     void (*outgoing_request)(struct ast_sip_session *session, struct pjsip_tx_data *tdata);
210     /*! 
211          * \brief Called on an outgoing SIP response
212          * This method is always called from a SIP servant thread.
213          */
214     void (*outgoing_response)(struct ast_sip_session *session, struct pjsip_tx_data *tdata);
215         /*! Next item in the list */
216         AST_LIST_ENTRY(ast_sip_session_supplement) next;
217 };
218
219 /*!
220  * \brief A handler for SDPs in SIP sessions
221  *
222  * An SDP handler is registered by a module that is interested in being the
223  * responsible party for specific types of SDP streams.
224  */
225 struct ast_sip_session_sdp_handler {
226         /*! An identifier for this handler */
227         const char *id;
228         /*!
229          * \brief Determine whether a stream requires that the re-invite be deferred.
230          * If a stream can not be immediately negotiated the re-invite can be deferred and
231          * resumed at a later time. It is up to the handler which caused deferral to occur
232          * to resume it.
233          * \param session The session for which the media is being re-invited
234          * \param session_media The media being reinvited
235          * \param sdp The entire SDP.
236          * \retval 0 The stream was unhandled or does not need the re-invite to be deferred.
237          * \retval 1 Re-invite should be deferred and will be resumed later. No further operations will take place.
238          * \note This is optional, if not implemented the stream is assumed to not be deferred.
239          */
240         int (*defer_incoming_sdp_stream)(struct ast_sip_session *session, struct ast_sip_session_media *session_media, const struct pjmedia_sdp_session *sdp, const struct pjmedia_sdp_media *stream);
241         /*!
242          * \brief Set session details based on a stream in an incoming SDP offer or answer
243          * \param session The session for which the media is being negotiated
244          * \param session_media The media to be setup for this session
245          * \param sdp The entire SDP. Useful for getting "global" information, such as connections or attributes
246          * \param stream The stream on which to operate
247          * \retval 0 The stream was not handled by this handler. If there are other registered handlers for this stream type, they will be called.
248          * \retval <0 There was an error encountered. No further operation will take place and the current negotiation will be abandoned.
249          * \retval >0 The stream was handled by this handler. No further handler of this stream type will be called.
250          */
251         int (*negotiate_incoming_sdp_stream)(struct ast_sip_session *session, struct ast_sip_session_media *session_media, const struct pjmedia_sdp_session *sdp, const struct pjmedia_sdp_media *stream);
252         /*!
253          * \brief Create an SDP media stream and add it to the outgoing SDP offer or answer
254          * \param session The session for which media is being added
255          * \param session_media The media to be setup for this session
256          * \param stream The stream on which to operate
257          * \retval 0 The stream was not handled by this handler. If there are other registered handlers for this stream type, they will be called.
258          * \retval <0 There was an error encountered. No further operation will take place and the current negotiation will be abandoned.
259          * \retval >0 The stream was handled by this handler. No further handler of this stream type will be called.
260          */
261         int (*handle_incoming_sdp_stream)(struct ast_sip_session *session, struct ast_sip_session_media *session_media, const struct pjmedia_sdp_session *sdp, struct pjmedia_sdp_media *stream);
262         /*!
263          * \brief Create an SDP media stream and add it to the outgoing SDP offer or answer
264          * \param session The session for which media is being added
265          * \param session_media The media to be setup for this session
266          * \param sdp The entire SDP as currently built
267          * \retval 0 This handler has no stream to add. If there are other registered handlers for this stream type, they will be called.
268          * \retval <0 There was an error encountered. No further operation will take place and the current SDP negotiation will be abandoned.
269          * \retval >0 The handler has a stream to be added to the SDP. No further handler of this stream type will be called.
270          */
271         int (*create_outgoing_sdp_stream)(struct ast_sip_session *session, struct ast_sip_session_media *session_media, struct pjmedia_sdp_session *sdp);
272         /*!
273          * \brief Update media stream with external address if applicable
274          * \param tdata The outgoing message itself
275          * \param stream The stream on which to operate
276          * \param transport The transport the SDP is going out on
277          */
278         void (*change_outgoing_sdp_stream_media_address)(struct pjsip_tx_data *tdata, struct pjmedia_sdp_media *stream, struct ast_sip_transport *transport);
279         /*!
280          * \brief Apply a negotiated SDP media stream
281          * \param session The session for which media is being applied
282          * \param session_media The media to be setup for this session
283          * \param local The entire local negotiated SDP
284          * \param local_stream The local stream which to apply
285          * \param remote The entire remote negotiated SDP
286          * \param remote_stream The remote stream which to apply
287          * \retval 0 The stream was not applied by this handler. If there are other registered handlers for this stream type, they will be called.
288          * \retval <0 There was an error encountered. No further operation will take place and the current application will be abandoned.
289          * \retval >0 The stream was handled by this handler. No further handler of this stream type will be called.
290          */
291         int (*apply_negotiated_sdp_stream)(struct ast_sip_session *session, struct ast_sip_session_media *session_media, const struct pjmedia_sdp_session *local, const struct pjmedia_sdp_media *local_stream,
292                 const struct pjmedia_sdp_session *remote, const struct pjmedia_sdp_media *remote_stream);
293         /*!
294          * \brief Destroy a session_media created by this handler
295          * \param session The session for which media is being destroyed
296          * \param session_media The media to destroy
297          */
298         void (*stream_destroy)(struct ast_sip_session_media *session_media);
299         /*! Next item in the list. */
300         AST_LIST_ENTRY(ast_sip_session_sdp_handler) next;
301 };
302
303 /*!
304  * \brief A structure which contains a channel implementation and session
305  */
306 struct ast_sip_channel_pvt {
307         /*! \brief Pointer to channel specific implementation information, must be ao2 object */
308         void *pvt;
309         /*! \brief Pointer to session */
310         struct ast_sip_session *session;
311 };
312
313 /*!
314  * \brief Allocate a new SIP channel pvt structure
315  *
316  * \param pvt Pointer to channel specific implementation
317  * \param session Pointer to SIP session
318  *
319  * \retval non-NULL success
320  * \retval NULL failure
321  */
322 struct ast_sip_channel_pvt *ast_sip_channel_pvt_alloc(void *pvt, struct ast_sip_session *session);
323
324 /*!
325  * \brief Allocate a new SIP session
326  *
327  * This will take care of allocating the datastores container on the session as well
328  * as placing all registered supplements onto the session.
329  *
330  * The endpoint that is passed in will have its reference count increased by one since
331  * the session will be keeping a reference to the endpoint. The session will relinquish
332  * this reference when the session is destroyed.
333  *
334  * \param endpoint The endpoint that this session communicates with
335  * \param contact The contact associated with this session
336  * \param inv_session The PJSIP INVITE session data
337  */
338 struct ast_sip_session *ast_sip_session_alloc(struct ast_sip_endpoint *endpoint,
339         struct ast_sip_contact *contact, pjsip_inv_session *inv);
340
341 /*!
342  * \brief Create a new outgoing SIP session
343  *
344  * The endpoint that is passed in will have its reference count increased by one since
345  * the session will be keeping a reference to the endpoint. The session will relinquish
346  * this reference when the session is destroyed.
347  *
348  * \param endpoint The endpoint that this session uses for settings
349  * \param contact The contact that this session will communicate with
350  * \param location Name of the location to call, be it named location or explicit URI. Overrides contact if present.
351  * \param request_user Optional request user to place in the request URI if permitted
352  * \param req_caps The requested capabilities
353  */
354 struct ast_sip_session *ast_sip_session_create_outgoing(struct ast_sip_endpoint *endpoint,
355         struct ast_sip_contact *contact, const char *location, const char *request_user,
356         struct ast_format_cap *req_caps);
357
358 /*!
359  * \brief Defer local termination of a session until remote side terminates, or an amount of time passes
360  *
361  * \param session The session to defer termination on
362  */
363 void ast_sip_session_defer_termination(struct ast_sip_session *session);
364
365 /*!
366  * \brief Register an SDP handler
367  *
368  * An SDP handler is responsible for parsing incoming SDP streams and ensuring that
369  * Asterisk can cope with the contents. Similarly, the SDP handler will be
370  * responsible for constructing outgoing SDP streams.
371  *
372  * Multiple handlers for the same stream type may be registered. They will be
373  * visited in the order they were registered. Handlers will be visited for each
374  * stream type until one claims to have handled the stream.
375  *
376  * \param handler The SDP handler to register
377  * \param stream_type The type of media stream for which to call the handler
378  * \retval 0 Success
379  * \retval -1 Failure
380  */
381 int ast_sip_session_register_sdp_handler(struct ast_sip_session_sdp_handler *handler, const char *stream_type);
382
383 /*!
384  * \brief Unregister an SDP handler
385  *
386  * \param handler The SDP handler to unregister
387  * \param stream_type Stream type for which the SDP handler was registered
388  */
389 void ast_sip_session_unregister_sdp_handler(struct ast_sip_session_sdp_handler *handler, const char *stream_type);
390
391 /*!
392  * \brief Register a supplement to SIP session processing
393  *
394  * This allows for someone to insert themselves in the processing of SIP
395  * requests and responses. This, for example could allow for a module to
396  * set channel data based on headers in an incoming message. Similarly,
397  * a module could reject an incoming request if desired.
398  *
399  * \param supplement The supplement to register
400  * \retval 0 Success
401  * \retval -1 Failure
402  */
403 int ast_sip_session_register_supplement(struct ast_sip_session_supplement *supplement);
404
405 /*!
406  * \brief Unregister a an supplement to SIP session processing
407  *
408  * \param supplement The supplement to unregister
409  */
410 void ast_sip_session_unregister_supplement(struct ast_sip_session_supplement *supplement);
411
412 /*!
413  * \brief Alternative for ast_datastore_alloc()
414  *
415  * There are two major differences between this and ast_datastore_alloc()
416  * 1) This allocates a refcounted object
417  * 2) This will fill in a uid if one is not provided
418  *
419  * DO NOT call ast_datastore_free() on a datastore allocated in this
420  * way since that function will attempt to free the datastore rather
421  * than play nicely with its refcount.
422  *
423  * \param info Callbacks for datastore
424  * \param uid Identifier for datastore
425  * \retval NULL Failed to allocate datastore
426  * \retval non-NULL Newly allocated datastore
427  */
428 struct ast_datastore *ast_sip_session_alloc_datastore(const struct ast_datastore_info *info, const char *uid);
429
430 /*!
431  * \brief Add a datastore to a SIP session
432  *
433  * Note that SIP uses reference counted datastores. The datastore passed into this function
434  * must have been allocated using ao2_alloc() or there will be serious problems.
435  *
436  * \param session The session to add the datastore to
437  * \param datastore The datastore to be added to the session
438  * \retval 0 Success
439  * \retval -1 Failure
440  */
441 int ast_sip_session_add_datastore(struct ast_sip_session *session, struct ast_datastore *datastore);
442
443 /*!
444  * \brief Retrieve a session datastore
445  *
446  * The datastore retrieved will have its reference count incremented. When the caller is done
447  * with the datastore, the reference counted needs to be decremented using ao2_ref().
448  *
449  * \param session The session from which to retrieve the datastore
450  * \param name The name of the datastore to retrieve
451  * \retval NULL Failed to find the specified datastore
452  * \retval non-NULL The specified datastore
453  */
454 struct ast_datastore *ast_sip_session_get_datastore(struct ast_sip_session *session, const char *name);
455
456 /*!
457  * \brief Remove a session datastore from the session
458  *
459  * This operation may cause the datastore's free() callback to be called if the reference
460  * count reaches zero.
461  *
462  * \param session The session to remove the datastore from
463  * \param name The name of the datastore to remove
464  */
465 void ast_sip_session_remove_datastore(struct ast_sip_session *session, const char *name);
466
467 /*!
468  * \brief Send a reinvite or UPDATE on a session
469  *
470  * This method will inspect the session in order to construct an appropriate
471  * session refresh request. As with any outgoing request in res_pjsip_session,
472  * this will call into registered supplements in case they wish to add anything.
473  *
474  * Note: The on_request_creation callback may or may not be called in the same
475  * thread where this function is called. Request creation may need to be delayed
476  * due to the current INVITE transaction state.
477  * 
478  * \param session The session on which the reinvite will be sent
479  * \param on_request_creation Callback called when request is created
480  * \param on_sdp_creation Callback called when SDP is created
481  * \param on_response Callback called when response for request is received
482  * \param method The method that should be used when constructing the session refresh
483  * \param generate_new_sdp Boolean to indicate if a new SDP should be created
484  * \retval 0 Successfully sent refresh
485  * \retval -1 Failure to send refresh
486  */
487 int ast_sip_session_refresh(struct ast_sip_session *session,
488                 ast_sip_session_request_creation_cb on_request_creation,
489                 ast_sip_session_sdp_creation_cb on_sdp_creation,
490                 ast_sip_session_response_cb on_response,
491                 enum ast_sip_session_refresh_method method,
492                 int generate_new_sdp);
493
494 /*!
495  * \brief Send a SIP response
496  *
497  * This will send the SIP response specified in tdata and
498  * call into any registered supplements' outgoing_response callback.
499  *
500  * \param session The session on which to send the response.
501  * \param tdata The response to send
502  */
503 void ast_sip_session_send_response(struct ast_sip_session *session, pjsip_tx_data *tdata);
504
505 /*!
506  * \brief Send a SIP request
507  *
508  * This will send the SIP request specified in tdata and
509  * call into any registered supplements' outgoing_request callback.
510  *
511  * \param session The session to which to send the request
512  * \param tdata The request to send
513  */
514 void ast_sip_session_send_request(struct ast_sip_session *session, pjsip_tx_data *tdata);
515
516 /*!
517  * \brief Creates an INVITE request.
518  *
519  * \param session Starting session for the INVITE
520  * \param tdata The created request.
521  */
522 int ast_sip_session_create_invite(struct ast_sip_session *session, pjsip_tx_data **tdata);
523
524 /*!
525  * \brief Send a SIP request and get called back when a response is received
526  *
527  * This will send the request out exactly the same as ast_sip_send_request() does.
528  * The difference is that when a response arrives, the specified callback will be
529  * called into
530  *
531  * \param session The session on which to send the request
532  * \param tdata The request to send
533  * \param on_response Callback to be called when a response is received
534  */
535 void ast_sip_session_send_request_with_cb(struct ast_sip_session *session, pjsip_tx_data *tdata,
536                 ast_sip_session_response_cb on_response);
537
538 /*!
539  * \brief Retrieves a session from a dialog
540  *
541  * \param dlg The dialog to retrieve the session from
542  *
543  * \retval non-NULL if session exists
544  * \retval NULL if no session
545  *
546  * \note The reference count of the session is increased when returned
547  *
548  * \note This function *must* be called with the dialog locked
549  */
550 struct ast_sip_session *ast_sip_dialog_get_session(pjsip_dialog *dlg);
551
552 /*!
553  * \brief Resumes processing of a deferred incoming re-invite
554  *
555  * \param session The session which has a pending incoming re-invite
556  *
557  * \note When resuming a re-invite it is given to the pjsip stack as if it
558  *       had just been received from a transport, this means that the deferral
559  *       callback will be called again.
560  */
561 void ast_sip_session_resume_reinvite(struct ast_sip_session *session);
562
563 #endif /* _RES_PJSIP_SESSION_H */