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