1 #ifndef _SECURITY_UTIL_H
2 #define _SECURITY_UTIL_H
5 * Amanda, The Advanced Maryland Automatic Network Disk Archiver
6 * Copyright (c) 1999 University of Maryland
9 * Permission to use, copy, modify, distribute, and sell this software and its
10 * documentation for any purpose is hereby granted without fee, provided that
11 * the above copyright notice appear in all copies and that both that
12 * copyright notice and this permission notice appear in supporting
13 * documentation, and that the name of U.M. not be used in advertising or
14 * publicity pertaining to distribution of the software without specific,
15 * written prior permission. U.M. makes no representations about the
16 * suitability of this software for any purpose. It is provided "as is"
17 * without express or implied warranty.
19 * U.M. DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL U.M.
21 * BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
22 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
23 * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
24 * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
26 * Authors: the Amanda Development Team. Its members are listed in a
27 * file named AUTHORS, in the root directory of this distribution.
31 * $Id: security-util.h,v 1.5 2006/07/01 00:10:38 paddy_s Exp $
41 #define auth_debug(i, ...) do { \
42 if ((i) <= debug_auth) { \
43 dbprintf(__VA_ARGS__); \
49 * Magic values for sec_conn->handle
51 #define H_TAKEN -1 /* sec_conn->tok was already read */
52 #define H_EOF -2 /* this connection has been shut down */
55 # define KRB5_DEPRECATED 1
56 # ifndef KRB5_HEIMDAL_INCLUDES
57 # include <gssapi/gssapi_generic.h>
59 # include <gssapi/gssapi.h>
67 * This is a sec connection to a host. We should only have
68 * one connection per host.
71 const struct security_driver *driver; /* MUST be first */
72 int read, write; /* pipes to sec */
73 pid_t pid; /* pid of sec process */
74 char * pkt; /* last pkt read */
75 ssize_t pktlen; /* len of above */
76 event_handle_t * ev_read; /* read (EV_READFD) handle */
77 int ev_read_refcnt; /* number of readers */
78 char hostname[MAX_HOSTNAME_LENGTH+1];
79 /* host we're talking to */
80 char * errmsg; /* error passed up */
81 int refcnt; /* number of handles using */
82 int handle; /* last proto handle read */
83 int event_id; /* event ID fired when token read */
84 void (*accept_fn)(security_handle_t *, pkt_t *);
86 int (*recv_security_ok)(struct sec_handle *, pkt_t *);
87 char * (*prefix_packet)(void *, pkt_t *);
91 char * (*conf_fn)(char *, void *);
95 gss_ctx_id_t gss_context;
97 unsigned int netint[2];
99 ssize_t size_header_read;
100 ssize_t size_buffer_read;
107 * This is the private handle data.
110 security_handle_t sech; /* MUST be first */
111 char * hostname; /* ptr to rc->hostname */
112 struct sec_stream * rs; /* virtual stream we xmit over */
113 struct tcp_conn * rc; /* */
115 void (*recvpkt)(void *, pkt_t *, security_status_t);
116 /* func to call when packet recvd */
117 void (*connect)(void *, security_handle_t *, security_status_t);
118 /* func to call when connected */
120 void * arg; /* argument to pass function */
121 event_handle_t * ev_timeout; /* timeout handle for recv */
126 event_handle_t * ev_read;
127 struct sec_handle * prev;
128 struct sec_handle * next;
129 struct udp_handle * udp;
130 void (*accept_fn)(security_handle_t *, pkt_t *);
131 int (*recv_security_ok)(struct sec_handle *, pkt_t *);
135 * This is the internal security_stream data for sec.
138 security_stream_t secstr; /* MUST be first */
139 struct tcp_conn * rc; /* physical connection */
140 int handle; /* protocol handle */
141 event_handle_t * ev_read; /* read (EV_WAIT) event handle */
142 void (*fn)(void *, void *, ssize_t); /* read event fn */
143 void * arg; /* arg for previous */
145 char databuf[NETWORK_BLOCK_BYTES];
150 int closed_by_network;
154 * This is data local to the datagram socket. We have one datagram
155 * per process per auth.
157 typedef struct udp_handle {
158 const struct security_driver *driver; /* MUST be first */
159 dgram_t dgram; /* datagram to read/write from */
160 sockaddr_union peer; /* who sent it to us */
161 pkt_t pkt; /* parsed form of dgram */
162 char *handle; /* handle from recvd packet */
163 int sequence; /* seq no of packet */
164 event_handle_t *ev_read; /* read event handle from dgram */
165 int refcnt; /* number of handles blocked for reading */
166 struct sec_handle *bh_first, *bh_last;
167 void (*accept_fn)(security_handle_t *, pkt_t *);
168 int (*recv_security_ok)(struct sec_handle *, pkt_t *);
169 char *(*prefix_packet)(void *, pkt_t *);
173 * We register one event handler for our network fd which takes
174 * care of all of our async requests. When all async requests
175 * have either been satisfied or cancelled, we unregister our
176 * network event handler.
178 #define udp_addref(udp, netfd_read_callback) do { \
179 if ((udp)->refcnt++ == 0) { \
180 assert((udp)->ev_read == NULL); \
181 (udp)->ev_read = event_register((event_id_t)(udp)->dgram.socket,\
182 EV_READFD, netfd_read_callback, (udp)); \
184 assert((udp)->refcnt > 0); \
188 * If this is the last request to be removed, then remove the
189 * reader event from the netfd.
191 #define udp_delref(udp) do { \
192 assert((udp)->refcnt > 0); \
193 if (--(udp)->refcnt == 0) { \
194 assert((udp)->ev_read != NULL); \
195 event_release((udp)->ev_read); \
196 (udp)->ev_read = NULL; \
201 int sec_stream_auth(void *);
202 int sec_stream_id(void *);
203 void sec_accept(const security_driver_t *,
204 char *(*)(char *, void *),
206 void (*)(security_handle_t *, pkt_t *),
208 void sec_close(void *);
209 void sec_connect_callback(void *);
210 void sec_connect_timeout(void *);
211 void sec_close_connection_none(void *, char *);
213 ssize_t stream_sendpkt(void *, pkt_t *);
214 void stream_recvpkt(void *,
215 void (*)(void *, pkt_t *, security_status_t),
217 void stream_recvpkt_timeout(void *);
218 void stream_recvpkt_cancel(void *);
220 int tcpm_stream_write(void *, const void *, size_t);
221 void tcpm_stream_read(void *, void (*)(void *, void *, ssize_t), void *);
222 ssize_t tcpm_stream_read_sync(void *, void **);
223 void tcpm_stream_read_cancel(void *);
224 ssize_t tcpm_send_token(struct tcp_conn *, int, int, char **, const void *, size_t);
225 ssize_t tcpm_recv_token_timeout(struct tcp_conn *, int, int *, char **, char **, ssize_t *, int);
226 ssize_t tcpm_recv_token(struct tcp_conn *, int, int *, char **, char **, ssize_t *);
227 void tcpm_close_connection(void *, char *);
229 int tcpma_stream_accept(void *);
230 void * tcpma_stream_client(void *, int);
231 void * tcpma_stream_server(void *);
232 void tcpma_stream_close(void *);
234 void * tcp1_stream_server(void *);
235 int tcp1_stream_accept(void *);
236 void * tcp1_stream_client(void *, int);
238 int tcp_stream_write(void *, const void *, size_t);
240 char * bsd_prefix_packet(void *, pkt_t *);
241 int bsd_recv_security_ok(struct sec_handle *, pkt_t *);
243 ssize_t udpbsd_sendpkt(void *, pkt_t *);
244 void udp_close(void *);
245 void udp_recvpkt(void *, void (*)(void *, pkt_t *, security_status_t),
247 void udp_recvpkt_cancel(void *);
248 void udp_recvpkt_callback(void *);
249 void udp_recvpkt_timeout(void *);
250 int udp_inithandle(udp_handle_t *, struct sec_handle *, char *hostname,
251 sockaddr_union *, in_port_t, char *, int);
252 void udp_netfd_read_callback(void *);
254 struct tcp_conn *sec_tcp_conn_get(const char *, int);
255 void sec_tcp_conn_put(struct tcp_conn *);
256 void sec_tcp_conn_read(struct tcp_conn *);
257 void parse_pkt(pkt_t *, const void *, size_t);
258 const char *pkthdr2str(const struct sec_handle *, const pkt_t *);
259 int str2pkthdr(udp_handle_t *);
260 char * check_user(struct sec_handle *, const char *, const char *);
262 char * check_user_ruserok (const char *host,
265 char * check_user_amandahosts(const char *host,
266 sockaddr_union *addr,
269 const char *service);
271 ssize_t net_read(int, void *, size_t, int);
272 ssize_t net_read_fillbuf(int, int, void *, size_t);
273 void show_stat_info(char *a, char *b);
274 int check_name_give_sockaddr(const char *hostname, struct sockaddr *addr,
276 in_port_t find_port_for_service(char *service, char *proto);
277 char *sec_get_authenticated_peer_name_gethostname(security_handle_t *);
278 char *sec_get_authenticated_peer_name_hostname(security_handle_t *);
280 #endif /* _SECURITY_INFO_H */