xref: /freebsd/usr.sbin/ctld/ctld.h (revision cdc58367265a2bd6e8f913db2bdc591699ee229f)
1 /*-
2  * Copyright (c) 2012 The FreeBSD Foundation
3  * All rights reserved.
4  *
5  * This software was developed by Edward Tomasz Napierala under sponsorship
6  * from the FreeBSD Foundation.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  * $FreeBSD$
30  */
31 
32 #ifndef CTLD_H
33 #define	CTLD_H
34 
35 #include <sys/queue.h>
36 #ifdef ICL_KERNEL_PROXY
37 #include <sys/types.h>
38 #endif
39 #include <sys/socket.h>
40 #include <stdbool.h>
41 #include <libutil.h>
42 #include <openssl/md5.h>
43 
44 #define	DEFAULT_CONFIG_PATH		"/etc/ctl.conf"
45 #define	DEFAULT_PIDFILE			"/var/run/ctld.pid"
46 #define	DEFAULT_BLOCKSIZE		512
47 
48 #define	MAX_LUNS			1024
49 #define	MAX_NAME_LEN			223
50 #define	MAX_DATA_SEGMENT_LENGTH		(128 * 1024)
51 #define	MAX_BURST_LENGTH		16776192
52 #define	SOCKBUF_SIZE			1048576
53 
54 struct auth {
55 	TAILQ_ENTRY(auth)		a_next;
56 	struct auth_group		*a_auth_group;
57 	char				*a_user;
58 	char				*a_secret;
59 	char				*a_mutual_user;
60 	char				*a_mutual_secret;
61 };
62 
63 struct auth_name {
64 	TAILQ_ENTRY(auth_name)		an_next;
65 	struct auth_group		*an_auth_group;
66 	char				*an_initator_name;
67 };
68 
69 struct auth_portal {
70 	TAILQ_ENTRY(auth_portal)	ap_next;
71 	struct auth_group		*ap_auth_group;
72 	char				*ap_initator_portal;
73 	struct sockaddr_storage		ap_sa;
74 	int				ap_mask;
75 };
76 
77 #define	AG_TYPE_UNKNOWN			0
78 #define	AG_TYPE_DENY			1
79 #define	AG_TYPE_NO_AUTHENTICATION	2
80 #define	AG_TYPE_CHAP			3
81 #define	AG_TYPE_CHAP_MUTUAL		4
82 
83 struct auth_group {
84 	TAILQ_ENTRY(auth_group)		ag_next;
85 	struct conf			*ag_conf;
86 	char				*ag_name;
87 	struct target			*ag_target;
88 	int				ag_type;
89 	TAILQ_HEAD(, auth)		ag_auths;
90 	TAILQ_HEAD(, auth_name)		ag_names;
91 	TAILQ_HEAD(, auth_portal)	ag_portals;
92 };
93 
94 struct portal {
95 	TAILQ_ENTRY(portal)		p_next;
96 	struct portal_group		*p_portal_group;
97 	bool				p_iser;
98 	char				*p_listen;
99 	struct addrinfo			*p_ai;
100 #ifdef ICL_KERNEL_PROXY
101 	int				p_id;
102 #endif
103 
104 	TAILQ_HEAD(, target)		p_targets;
105 	int				p_socket;
106 };
107 
108 #define	PG_FILTER_UNKNOWN		0
109 #define	PG_FILTER_NONE			1
110 #define	PG_FILTER_PORTAL		2
111 #define	PG_FILTER_PORTAL_NAME		3
112 #define	PG_FILTER_PORTAL_NAME_AUTH	4
113 
114 struct portal_group {
115 	TAILQ_ENTRY(portal_group)	pg_next;
116 	struct conf			*pg_conf;
117 	char				*pg_name;
118 	struct auth_group		*pg_discovery_auth_group;
119 	int				pg_discovery_filter;
120 	bool				pg_unassigned;
121 	TAILQ_HEAD(, portal)		pg_portals;
122 	TAILQ_HEAD(, port)		pg_ports;
123 	char				*pg_offload;
124 	char				*pg_redirection;
125 
126 	uint16_t			pg_tag;
127 };
128 
129 struct pport {
130 	TAILQ_ENTRY(pport)		pp_next;
131 	TAILQ_HEAD(, port)		pp_ports;
132 	struct conf			*pp_conf;
133 	char				*pp_name;
134 
135 	uint32_t			pp_ctl_port;
136 };
137 
138 struct port {
139 	TAILQ_ENTRY(port)		p_next;
140 	TAILQ_ENTRY(port)		p_pgs;
141 	TAILQ_ENTRY(port)		p_pps;
142 	TAILQ_ENTRY(port)		p_ts;
143 	struct conf			*p_conf;
144 	char				*p_name;
145 	struct auth_group		*p_auth_group;
146 	struct portal_group		*p_portal_group;
147 	struct pport			*p_pport;
148 	struct target			*p_target;
149 
150 	uint32_t			p_ctl_port;
151 };
152 
153 struct lun_option {
154 	TAILQ_ENTRY(lun_option)		lo_next;
155 	struct lun			*lo_lun;
156 	char				*lo_name;
157 	char				*lo_value;
158 };
159 
160 struct lun {
161 	TAILQ_ENTRY(lun)		l_next;
162 	struct conf			*l_conf;
163 	TAILQ_HEAD(, lun_option)	l_options;
164 	char				*l_name;
165 	char				*l_backend;
166 	int				l_blocksize;
167 	char				*l_device_id;
168 	char				*l_path;
169 	char				*l_scsiname;
170 	char				*l_serial;
171 	int64_t				l_size;
172 
173 	int				l_ctl_lun;
174 };
175 
176 struct target {
177 	TAILQ_ENTRY(target)		t_next;
178 	struct conf			*t_conf;
179 	struct lun			*t_luns[MAX_LUNS];
180 	struct auth_group		*t_auth_group;
181 	TAILQ_HEAD(, port)		t_ports;
182 	char				*t_name;
183 	char				*t_alias;
184 	char				*t_redirection;
185 };
186 
187 struct isns {
188 	TAILQ_ENTRY(isns)		i_next;
189 	struct conf			*i_conf;
190 	char				*i_addr;
191 	struct addrinfo			*i_ai;
192 };
193 
194 struct conf {
195 	char				*conf_pidfile_path;
196 	TAILQ_HEAD(, lun)		conf_luns;
197 	TAILQ_HEAD(, target)		conf_targets;
198 	TAILQ_HEAD(, auth_group)	conf_auth_groups;
199 	TAILQ_HEAD(, port)		conf_ports;
200 	TAILQ_HEAD(, portal_group)	conf_portal_groups;
201 	TAILQ_HEAD(, pport)		conf_pports;
202 	TAILQ_HEAD(, isns)		conf_isns;
203 	int				conf_isns_period;
204 	int				conf_isns_timeout;
205 	int				conf_debug;
206 	int				conf_timeout;
207 	int				conf_maxproc;
208 
209 #ifdef ICL_KERNEL_PROXY
210 	int				conf_portal_id;
211 #endif
212 	struct pidfh			*conf_pidfh;
213 
214 	bool				conf_default_pg_defined;
215 	bool				conf_default_ag_defined;
216 	bool				conf_kernel_port_on;
217 };
218 
219 #define	CONN_SESSION_TYPE_NONE		0
220 #define	CONN_SESSION_TYPE_DISCOVERY	1
221 #define	CONN_SESSION_TYPE_NORMAL	2
222 
223 #define	CONN_DIGEST_NONE		0
224 #define	CONN_DIGEST_CRC32C		1
225 
226 struct connection {
227 	struct portal		*conn_portal;
228 	struct port		*conn_port;
229 	struct target		*conn_target;
230 	int			conn_socket;
231 	int			conn_session_type;
232 	char			*conn_initiator_name;
233 	char			*conn_initiator_addr;
234 	char			*conn_initiator_alias;
235 	uint8_t			conn_initiator_isid[6];
236 	struct sockaddr_storage	conn_initiator_sa;
237 	uint32_t		conn_cmdsn;
238 	uint32_t		conn_statsn;
239 	size_t			conn_data_segment_limit;
240 	size_t			conn_max_data_segment_length;
241 	size_t			conn_max_burst_length;
242 	int			conn_immediate_data;
243 	int			conn_header_digest;
244 	int			conn_data_digest;
245 	const char		*conn_user;
246 	struct chap		*conn_chap;
247 };
248 
249 struct pdu {
250 	struct connection	*pdu_connection;
251 	struct iscsi_bhs	*pdu_bhs;
252 	char			*pdu_data;
253 	size_t			pdu_data_len;
254 };
255 
256 #define	KEYS_MAX	1024
257 
258 struct keys {
259 	char		*keys_names[KEYS_MAX];
260 	char		*keys_values[KEYS_MAX];
261 	char		*keys_data;
262 	size_t		keys_data_len;
263 };
264 
265 #define	CHAP_CHALLENGE_LEN	1024
266 
267 struct chap {
268 	unsigned char	chap_id;
269 	char		chap_challenge[CHAP_CHALLENGE_LEN];
270 	char		chap_response[MD5_DIGEST_LENGTH];
271 };
272 
273 struct rchap {
274 	char		*rchap_secret;
275 	unsigned char	rchap_id;
276 	void		*rchap_challenge;
277 	size_t		rchap_challenge_len;
278 };
279 
280 struct chap		*chap_new(void);
281 char			*chap_get_id(const struct chap *chap);
282 char			*chap_get_challenge(const struct chap *chap);
283 int			chap_receive(struct chap *chap, const char *response);
284 int			chap_authenticate(struct chap *chap,
285 			    const char *secret);
286 void			chap_delete(struct chap *chap);
287 
288 struct rchap		*rchap_new(const char *secret);
289 int			rchap_receive(struct rchap *rchap,
290 			    const char *id, const char *challenge);
291 char			*rchap_get_response(struct rchap *rchap);
292 void			rchap_delete(struct rchap *rchap);
293 
294 struct conf		*conf_new(void);
295 struct conf		*conf_new_from_file(const char *path, struct conf *old);
296 struct conf		*conf_new_from_kernel(void);
297 void			conf_delete(struct conf *conf);
298 int			conf_verify(struct conf *conf);
299 
300 struct auth_group	*auth_group_new(struct conf *conf, const char *name);
301 void			auth_group_delete(struct auth_group *ag);
302 struct auth_group	*auth_group_find(const struct conf *conf,
303 			    const char *name);
304 int			auth_group_set_type(struct auth_group *ag,
305 			    const char *type);
306 
307 const struct auth	*auth_new_chap(struct auth_group *ag,
308 			    const char *user, const char *secret);
309 const struct auth	*auth_new_chap_mutual(struct auth_group *ag,
310 			    const char *user, const char *secret,
311 			    const char *user2, const char *secret2);
312 const struct auth	*auth_find(const struct auth_group *ag,
313 			    const char *user);
314 
315 const struct auth_name	*auth_name_new(struct auth_group *ag,
316 			    const char *initiator_name);
317 bool			auth_name_defined(const struct auth_group *ag);
318 const struct auth_name	*auth_name_find(const struct auth_group *ag,
319 			    const char *initiator_name);
320 int			auth_name_check(const struct auth_group *ag,
321 			    const char *initiator_name);
322 
323 const struct auth_portal	*auth_portal_new(struct auth_group *ag,
324 				    const char *initiator_portal);
325 bool			auth_portal_defined(const struct auth_group *ag);
326 const struct auth_portal	*auth_portal_find(const struct auth_group *ag,
327 				    const struct sockaddr_storage *sa);
328 int				auth_portal_check(const struct auth_group *ag,
329 				    const struct sockaddr_storage *sa);
330 
331 struct portal_group	*portal_group_new(struct conf *conf, const char *name);
332 void			portal_group_delete(struct portal_group *pg);
333 struct portal_group	*portal_group_find(const struct conf *conf,
334 			    const char *name);
335 int			portal_group_add_listen(struct portal_group *pg,
336 			    const char *listen, bool iser);
337 int			portal_group_set_filter(struct portal_group *pg,
338 			    const char *filter);
339 int			portal_group_set_offload(struct portal_group *pg,
340 			    const char *offload);
341 int			portal_group_set_redirection(struct portal_group *pg,
342 			    const char *addr);
343 
344 int			isns_new(struct conf *conf, const char *addr);
345 void			isns_delete(struct isns *is);
346 void			isns_register(struct isns *isns, struct isns *oldisns);
347 void			isns_check(struct isns *isns);
348 void			isns_deregister(struct isns *isns);
349 
350 struct pport		*pport_new(struct conf *conf, const char *name,
351 			    uint32_t ctl_port);
352 struct pport		*pport_find(const struct conf *conf, const char *name);
353 struct pport		*pport_copy(struct pport *pport, struct conf *conf);
354 void			pport_delete(struct pport *pport);
355 
356 struct port		*port_new(struct conf *conf, struct target *target,
357 			    struct portal_group *pg);
358 struct port		*port_new_pp(struct conf *conf, struct target *target,
359 			    struct pport *pp);
360 struct port		*port_find(const struct conf *conf, const char *name);
361 struct port		*port_find_in_pg(const struct portal_group *pg,
362 			    const char *target);
363 void			port_delete(struct port *port);
364 
365 struct target		*target_new(struct conf *conf, const char *name);
366 void			target_delete(struct target *target);
367 struct target		*target_find(struct conf *conf,
368 			    const char *name);
369 int			target_set_redirection(struct target *target,
370 			    const char *addr);
371 
372 struct lun		*lun_new(struct conf *conf, const char *name);
373 void			lun_delete(struct lun *lun);
374 struct lun		*lun_find(const struct conf *conf, const char *name);
375 void			lun_set_backend(struct lun *lun, const char *value);
376 void			lun_set_blocksize(struct lun *lun, size_t value);
377 void			lun_set_device_id(struct lun *lun, const char *value);
378 void			lun_set_path(struct lun *lun, const char *value);
379 void			lun_set_scsiname(struct lun *lun, const char *value);
380 void			lun_set_serial(struct lun *lun, const char *value);
381 void			lun_set_size(struct lun *lun, size_t value);
382 void			lun_set_ctl_lun(struct lun *lun, uint32_t value);
383 
384 struct lun_option	*lun_option_new(struct lun *lun,
385 			    const char *name, const char *value);
386 void			lun_option_delete(struct lun_option *clo);
387 struct lun_option	*lun_option_find(const struct lun *lun,
388 			    const char *name);
389 void			lun_option_set(struct lun_option *clo,
390 			    const char *value);
391 
392 void			kernel_init(void);
393 int			kernel_lun_add(struct lun *lun);
394 int			kernel_lun_resize(struct lun *lun);
395 int			kernel_lun_remove(struct lun *lun);
396 void			kernel_handoff(struct connection *conn);
397 void			kernel_limits(const char *offload,
398 			    size_t *max_data_segment_length);
399 int			kernel_port_add(struct port *port);
400 int			kernel_port_update(struct port *port);
401 int			kernel_port_remove(struct port *port);
402 void			kernel_capsicate(void);
403 
404 #ifdef ICL_KERNEL_PROXY
405 void			kernel_listen(struct addrinfo *ai, bool iser,
406 			    int portal_id);
407 void			kernel_accept(int *connection_id, int *portal_id,
408 			    struct sockaddr *client_sa,
409 			    socklen_t *client_salen);
410 void			kernel_send(struct pdu *pdu);
411 void			kernel_receive(struct pdu *pdu);
412 #endif
413 
414 struct keys		*keys_new(void);
415 void			keys_delete(struct keys *keys);
416 void			keys_load(struct keys *keys, const struct pdu *pdu);
417 void			keys_save(struct keys *keys, struct pdu *pdu);
418 const char		*keys_find(struct keys *keys, const char *name);
419 void			keys_add(struct keys *keys,
420 			    const char *name, const char *value);
421 void			keys_add_int(struct keys *keys,
422 			    const char *name, int value);
423 
424 struct pdu		*pdu_new(struct connection *conn);
425 struct pdu		*pdu_new_response(struct pdu *request);
426 void			pdu_delete(struct pdu *pdu);
427 void			pdu_receive(struct pdu *request);
428 void			pdu_send(struct pdu *response);
429 
430 void			login(struct connection *conn);
431 
432 void			discovery(struct connection *conn);
433 
434 void			log_init(int level);
435 void			log_set_peer_name(const char *name);
436 void			log_set_peer_addr(const char *addr);
437 void			log_err(int, const char *, ...)
438 			    __dead2 __printflike(2, 3);
439 void			log_errx(int, const char *, ...)
440 			    __dead2 __printflike(2, 3);
441 void			log_warn(const char *, ...) __printflike(1, 2);
442 void			log_warnx(const char *, ...) __printflike(1, 2);
443 void			log_debugx(const char *, ...) __printflike(1, 2);
444 
445 char			*checked_strdup(const char *);
446 bool			valid_iscsi_name(const char *name);
447 void			set_timeout(int timeout, int fatal);
448 bool			timed_out(void);
449 
450 #endif /* !CTLD_H */
451