summaryrefslogtreecommitdiff
path: root/sbin/isakmpd/transport.h
blob: 4ef75f567c32149be862cd84b90422beb7297a9f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
/* $OpenBSD: transport.h,v 1.18 2006/06/02 19:35:55 hshoexer Exp $	 */
/* $EOM: transport.h,v 1.16 2000/07/17 18:57:59 provos Exp $	 */

/*
 * Copyright (c) 1998, 1999 Niklas Hallqvist.  All rights reserved.
 * Copyright (c) 2001, 2004 H�kan Olsson.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/*
 * This code was written under funding by Ericsson Radio Systems.
 */

/*
 * The transport module tries to separate out details concerning the
 * actual transferral of ISAKMP messages to other parties.
 */

#ifndef _TRANSPORT_H_
#define _TRANSPORT_H_

#include <sys/param.h>
#include <sys/queue.h>
#include <sys/types.h>
#include <sys/socket.h>

#include "message.h"

struct transport;

LIST_HEAD(transport_list, transport) transport_list;

/* This describes a transport "method" like UDP or similar.  */
struct transport_vtbl {
	/* All transport methods are linked together.  */
	LIST_ENTRY(transport_vtbl) link;

	/* A textual name of the transport method.  */
	char           *name;

	/* Create a transport instance of this method.  */
	struct transport *(*create) (char *);

	/* Reinitialize specific transport.  */
	void            (*reinit) (void);

	/* Remove a transport instance of this method.  */
	void            (*remove) (struct transport *);

	/* Report status of given transport */
	void            (*report) (struct transport *);

	/* Let the given transport set it's bit in the fd_set passed in.  */
	int             (*fd_set) (struct transport *, fd_set *, int);

	/* Is the given transport ready for I/O?  */
	int             (*fd_isset) (struct transport *, fd_set *);

	/*
	 * Read a message from the transport's incoming pipe and start
	 * handling it.
         */
	void            (*handle_message) (struct transport *);

	/* Send a message through the outgoing pipe.  */
	int             (*send_message) (struct message *, struct transport *);

	/*
	 * Fill out a sockaddr structure with the transport's destination end's
	 * address info.
         */
	void            (*get_dst) (struct transport *, struct sockaddr **);

	/*
	 * Fill out a sockaddr structure with the transport's source end's
	 * address info.
         */
	void            (*get_src) (struct transport *, struct sockaddr **);

	/*
	 * Return a string with decoded src and dst information
         */
	char           *(*decode_ids) (struct transport *);

	/*
	 * Clone a transport for outbound use.
	 */
	struct transport *(*clone) (struct transport *, struct sockaddr *);

	/*
	 * Locate the correct sendq to use for outbound messages.
	 */
	struct msg_head *(*get_queue) (struct message *);
};

struct transport {
	/* All transports used are linked together.  */
	LIST_ENTRY(transport) link;

	/* What transport method is this an instance of?  */
	struct transport_vtbl *vtbl;

	/* The queue holding messages to send on this transport.  */
	struct msg_head sendq;

	/*
	 * Prioritized send queue.  Messages in this queue will be transmitted
	 * before the normal sendq, they will also all be transmitted prior
	 * to a daemon shutdown.  Currently only used for DELETE notifications.
         */
	struct msg_head prio_sendq;

	/* Flags describing the transport.  */
	int             flags;

	/* Reference counter.  */
	int             refcnt;

	/* Pointer to parent virtual transport, if any.  */
	struct transport *virtual;
};

/* Set if this is a transport we want to listen on.  */
#define TRANSPORT_LISTEN	1
/* Used for mark-and-sweep-type garbage collection of transports */
#define TRANSPORT_MARK		2

extern struct transport *transport_create(char *, char *);
extern int      transport_fd_set(fd_set *);
extern void     transport_handle_messages(fd_set *);
extern void     transport_init(void);
extern void     transport_method_add(struct transport_vtbl *);
extern int      transport_pending_wfd_set(fd_set *);
extern int      transport_prio_sendqs_empty(void);
extern void     transport_reference(struct transport *);
extern void     transport_reinit(void);
extern void     transport_release(struct transport *);
extern void     transport_report(void);
extern void     transport_send_messages(fd_set *);
extern void     transport_setup(struct transport *, int);
#endif				/* _TRANSPORT_H_ */