modules/ims_qos: added patch for flow-description bug when request originates from...
[sip-router] / tls_hooks.h
1 /*
2  * Copyright (C) 2007 iptelorg GmbH 
3  *
4  * Permission to use, copy, modify, and distribute this software for any
5  * purpose with or without fee is hereby granted, provided that the above
6  * copyright notice and this permission notice appear in all copies.
7  *
8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15  */
16
17 /**
18  * @file
19  * @brief Kamailio TLS support :: TLS hooks for modules
20  * @ingroup tls
21  * Module: @ref tls
22  */
23
24
25 #ifndef _tls_hooks_h
26 #define _tls_hooks_h
27
28 #ifdef TLS_HOOKS
29
30 #ifndef USE_TLS
31 #error "USE_TLS required and not defined (please compile with make \
32         TLS_HOOKS=1)"
33 #endif
34
35 #ifdef CORE_TLS
36 #error "Conflict: CORE_TLS and TLS_HOOKS cannot be defined in the same time"
37 #endif
38
39 #include "tcp_conn.h"
40
41
42
43 struct tls_hooks{
44         /* read using tls (should use tcp internal read functions to
45            get the data from the connection) */
46         int  (*read)(struct tcp_connection* c, int* flags);
47         /* process data for sending. Should replace pbuf & plen with
48            an internal buffer containing the tls records. If it was not able
49            to process the whole pbuf, it should set (rest_buf, rest_len) to
50            the remaining unprocessed part, else they must be set to 0.
51            send_flags are passed as a pointer and they can also be changed
52            (e.g. reset a FORCE_CLOSE flag if there is internal queued data
53             waiting to be written).
54            If rest_len or rest_buf are not 0 the call will be repeated after the
55            contents of pbuf is sent, with (rest_buf, rest_len) as input.
56            Should return *plen (if >=0).
57            If it returns < 0 => error (tcp connection will be closed).
58         */
59         int (*encode)(struct tcp_connection* c,
60                                         const char** pbuf, unsigned int* plen,
61                                         const char** rest_buf, unsigned int* rest_len,
62                                         snd_flags_t* send_flags);
63         int  (*on_tcpconn_init)(struct tcp_connection *c, int sock);
64         void (*tcpconn_clean)(struct tcp_connection* c);
65         void (*tcpconn_close)(struct tcp_connection*c , int fd);
66         
67         /* per listening socket init, called on kamailio startup (after modules,
68          *  process table, init() and udp socket initialization)*/
69         int (*init_si)(struct socket_info* si);
70         /* generic init function (called at kamailio init, after module initialization
71          *  and process table creation)*/
72         int (*init)(void);
73         /* destroy function, called after the modules are destroyed, and 
74          * after  destroy_tcp() */
75         void (*destroy)(void);
76         /* generic pre-init function (called at kamailio start, before module
77          * initialization (after modparams) */
78         int (*pre_init)(void);
79 };
80
81
82 extern struct tls_hooks tls_hook;
83
84 #ifdef __SUNPRO_C
85         #define tls_hook_call(name, ret_not_set, ...) \
86                 ((tls_hook.name)?(tls_hook.name(__VA_ARGS__)): (ret_not_set))
87         #define tls_hook_call_v(name, ...) \
88                 do{ \
89                         if (tls_hook.name) tls_hook.name(__VA_ARGS__); \
90                 }while(0)
91 #else
92         #define tls_hook_call(name, ret_not_set, args...) \
93                 ((tls_hook.name)?(tls_hook.name(args)): (ret_not_set))
94         #define tls_hook_call_v(name, args...) \
95                 do{ \
96                         if (tls_hook.name) tls_hook.name(args); \
97                 }while(0)
98 #endif
99
100 /* hooks */
101
102 #define tls_tcpconn_init(c, s)  tls_hook_call(on_tcpconn_init, 0, (c), (s))
103 #define tls_tcpconn_clean(c)    tls_hook_call_v(tcpconn_clean, (c))
104 #define tls_encode(c, pbuf, plen, rbuf, rlen, sflags) \
105         tls_hook_call(encode, -1, (c), (pbuf), (plen), (rbuf), (rlen), (sflags))
106 #define tls_close(conn, fd)             tls_hook_call_v(tcpconn_close, (conn), (fd))
107 #define tls_read(c, flags)                              tls_hook_call(read, -1, (c), (flags))
108
109 int register_tls_hooks(struct tls_hooks* h);
110
111 #endif /* TLS_HOOKS */
112 #endif