2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2012 The FreeBSD Foundation
7 * This software was developed by Edward Tomasz Napierala under sponsorship
8 * from the FreeBSD Foundation.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37 #include <sys/queue.h>
38 #ifdef ICL_KERNEL_PROXY
39 #include <sys/types.h>
41 #include <sys/socket.h>
45 #define DEFAULT_CONFIG_PATH "/etc/ctl.conf"
46 #define DEFAULT_PIDFILE "/var/run/ctld.pid"
47 #define DEFAULT_BLOCKSIZE 512
48 #define DEFAULT_CD_BLOCKSIZE 2048
51 #define MAX_NAME_LEN 223
52 #define MAX_DATA_SEGMENT_LENGTH (128 * 1024)
53 #define SOCKBUF_SIZE 1048576
56 TAILQ_ENTRY(auth) a_next;
57 struct auth_group *a_auth_group;
61 char *a_mutual_secret;
65 TAILQ_ENTRY(auth_name) an_next;
66 struct auth_group *an_auth_group;
67 char *an_initator_name;
71 TAILQ_ENTRY(auth_portal) ap_next;
72 struct auth_group *ap_auth_group;
73 char *ap_initator_portal;
74 struct sockaddr_storage ap_sa;
78 #define AG_TYPE_UNKNOWN 0
79 #define AG_TYPE_DENY 1
80 #define AG_TYPE_NO_AUTHENTICATION 2
81 #define AG_TYPE_CHAP 3
82 #define AG_TYPE_CHAP_MUTUAL 4
85 TAILQ_ENTRY(auth_group) ag_next;
88 struct target *ag_target;
90 TAILQ_HEAD(, auth) ag_auths;
91 TAILQ_HEAD(, auth_name) ag_names;
92 TAILQ_HEAD(, auth_portal) ag_portals;
96 TAILQ_ENTRY(portal) p_next;
97 struct portal_group *p_portal_group;
100 struct addrinfo *p_ai;
101 #ifdef ICL_KERNEL_PROXY
105 TAILQ_HEAD(, target) p_targets;
109 TAILQ_HEAD(options, option);
111 #define PG_FILTER_UNKNOWN 0
112 #define PG_FILTER_NONE 1
113 #define PG_FILTER_PORTAL 2
114 #define PG_FILTER_PORTAL_NAME 3
115 #define PG_FILTER_PORTAL_NAME_AUTH 4
117 struct portal_group {
118 TAILQ_ENTRY(portal_group) pg_next;
119 struct conf *pg_conf;
120 struct options pg_options;
122 struct auth_group *pg_discovery_auth_group;
123 int pg_discovery_filter;
126 TAILQ_HEAD(, portal) pg_portals;
127 TAILQ_HEAD(, port) pg_ports;
129 char *pg_redirection;
137 TAILQ_ENTRY(pport) pp_next;
138 TAILQ_HEAD(, port) pp_ports;
139 struct conf *pp_conf;
142 uint32_t pp_ctl_port;
146 TAILQ_ENTRY(port) p_next;
147 TAILQ_ENTRY(port) p_pgs;
148 TAILQ_ENTRY(port) p_pps;
149 TAILQ_ENTRY(port) p_ts;
152 struct auth_group *p_auth_group;
153 struct portal_group *p_portal_group;
154 struct pport *p_pport;
155 struct target *p_target;
164 TAILQ_ENTRY(option) o_next;
170 TAILQ_ENTRY(lun) l_next;
172 struct options l_options;
175 uint8_t l_device_type;
187 TAILQ_ENTRY(target) t_next;
189 struct lun *t_luns[MAX_LUNS];
190 struct auth_group *t_auth_group;
191 TAILQ_HEAD(, port) t_ports;
198 TAILQ_ENTRY(isns) i_next;
201 struct addrinfo *i_ai;
205 char *conf_pidfile_path;
206 TAILQ_HEAD(, lun) conf_luns;
207 TAILQ_HEAD(, target) conf_targets;
208 TAILQ_HEAD(, auth_group) conf_auth_groups;
209 TAILQ_HEAD(, port) conf_ports;
210 TAILQ_HEAD(, portal_group) conf_portal_groups;
211 TAILQ_HEAD(, pport) conf_pports;
212 TAILQ_HEAD(, isns) conf_isns;
213 int conf_isns_period;
214 int conf_isns_timeout;
219 #ifdef ICL_KERNEL_PROXY
222 struct pidfh *conf_pidfh;
224 bool conf_default_pg_defined;
225 bool conf_default_ag_defined;
226 bool conf_kernel_port_on;
229 #define CONN_SESSION_TYPE_NONE 0
230 #define CONN_SESSION_TYPE_DISCOVERY 1
231 #define CONN_SESSION_TYPE_NORMAL 2
233 #define CONN_DIGEST_NONE 0
234 #define CONN_DIGEST_CRC32C 1
237 struct portal *conn_portal;
238 struct port *conn_port;
239 struct target *conn_target;
241 int conn_session_type;
242 char *conn_initiator_name;
243 char *conn_initiator_addr;
244 char *conn_initiator_alias;
245 uint8_t conn_initiator_isid[6];
246 struct sockaddr_storage conn_initiator_sa;
248 uint32_t conn_statsn;
249 int conn_max_recv_data_segment_limit;
250 int conn_max_send_data_segment_limit;
251 int conn_max_burst_limit;
252 int conn_first_burst_limit;
253 int conn_max_recv_data_segment_length;
254 int conn_max_send_data_segment_length;
255 int conn_max_burst_length;
256 int conn_first_burst_length;
257 int conn_immediate_data;
258 int conn_header_digest;
259 int conn_data_digest;
260 const char *conn_user;
261 struct chap *conn_chap;
265 struct connection *pdu_connection;
266 struct iscsi_bhs *pdu_bhs;
271 #define KEYS_MAX 1024
274 char *keys_names[KEYS_MAX];
275 char *keys_values[KEYS_MAX];
277 size_t keys_data_len;
280 #define CHAP_CHALLENGE_LEN 1024
281 #define CHAP_DIGEST_LEN 16 /* Equal to MD5 digest size. */
284 unsigned char chap_id;
285 char chap_challenge[CHAP_CHALLENGE_LEN];
286 char chap_response[CHAP_DIGEST_LEN];
291 unsigned char rchap_id;
292 void *rchap_challenge;
293 size_t rchap_challenge_len;
296 struct chap *chap_new(void);
297 char *chap_get_id(const struct chap *chap);
298 char *chap_get_challenge(const struct chap *chap);
299 int chap_receive(struct chap *chap, const char *response);
300 int chap_authenticate(struct chap *chap,
302 void chap_delete(struct chap *chap);
304 struct rchap *rchap_new(const char *secret);
305 int rchap_receive(struct rchap *rchap,
306 const char *id, const char *challenge);
307 char *rchap_get_response(struct rchap *rchap);
308 void rchap_delete(struct rchap *rchap);
310 int parse_conf(struct conf *conf, const char *path);
311 int uclparse_conf(struct conf *conf, const char *path);
313 struct conf *conf_new(void);
314 struct conf *conf_new_from_kernel(void);
315 void conf_delete(struct conf *conf);
316 int conf_verify(struct conf *conf);
318 struct auth_group *auth_group_new(struct conf *conf, const char *name);
319 void auth_group_delete(struct auth_group *ag);
320 struct auth_group *auth_group_find(const struct conf *conf,
322 int auth_group_set_type(struct auth_group *ag,
325 const struct auth *auth_new_chap(struct auth_group *ag,
326 const char *user, const char *secret);
327 const struct auth *auth_new_chap_mutual(struct auth_group *ag,
328 const char *user, const char *secret,
329 const char *user2, const char *secret2);
330 const struct auth *auth_find(const struct auth_group *ag,
333 const struct auth_name *auth_name_new(struct auth_group *ag,
334 const char *initiator_name);
335 bool auth_name_defined(const struct auth_group *ag);
336 const struct auth_name *auth_name_find(const struct auth_group *ag,
337 const char *initiator_name);
338 int auth_name_check(const struct auth_group *ag,
339 const char *initiator_name);
341 const struct auth_portal *auth_portal_new(struct auth_group *ag,
342 const char *initiator_portal);
343 bool auth_portal_defined(const struct auth_group *ag);
344 const struct auth_portal *auth_portal_find(const struct auth_group *ag,
345 const struct sockaddr_storage *sa);
346 int auth_portal_check(const struct auth_group *ag,
347 const struct sockaddr_storage *sa);
349 struct portal_group *portal_group_new(struct conf *conf, const char *name);
350 void portal_group_delete(struct portal_group *pg);
351 struct portal_group *portal_group_find(const struct conf *conf,
353 int portal_group_add_listen(struct portal_group *pg,
354 const char *listen, bool iser);
355 int portal_group_set_filter(struct portal_group *pg,
357 int portal_group_set_offload(struct portal_group *pg,
358 const char *offload);
359 int portal_group_set_redirection(struct portal_group *pg,
362 int isns_new(struct conf *conf, const char *addr);
363 void isns_delete(struct isns *is);
364 void isns_register(struct isns *isns, struct isns *oldisns);
365 void isns_check(struct isns *isns);
366 void isns_deregister(struct isns *isns);
368 struct pport *pport_new(struct conf *conf, const char *name,
370 struct pport *pport_find(const struct conf *conf, const char *name);
371 struct pport *pport_copy(struct pport *pport, struct conf *conf);
372 void pport_delete(struct pport *pport);
374 struct port *port_new(struct conf *conf, struct target *target,
375 struct portal_group *pg);
376 struct port *port_new_ioctl(struct conf *conf, struct target *target,
378 struct port *port_new_pp(struct conf *conf, struct target *target,
380 struct port *port_find(const struct conf *conf, const char *name);
381 struct port *port_find_in_pg(const struct portal_group *pg,
383 void port_delete(struct port *port);
384 int port_is_dummy(struct port *port);
386 struct target *target_new(struct conf *conf, const char *name);
387 void target_delete(struct target *target);
388 struct target *target_find(struct conf *conf,
390 int target_set_redirection(struct target *target,
393 struct lun *lun_new(struct conf *conf, const char *name);
394 void lun_delete(struct lun *lun);
395 struct lun *lun_find(const struct conf *conf, const char *name);
396 void lun_set_backend(struct lun *lun, const char *value);
397 void lun_set_device_type(struct lun *lun, uint8_t value);
398 void lun_set_blocksize(struct lun *lun, size_t value);
399 void lun_set_device_id(struct lun *lun, const char *value);
400 void lun_set_path(struct lun *lun, const char *value);
401 void lun_set_scsiname(struct lun *lun, const char *value);
402 void lun_set_serial(struct lun *lun, const char *value);
403 void lun_set_size(struct lun *lun, size_t value);
404 void lun_set_ctl_lun(struct lun *lun, uint32_t value);
406 struct option *option_new(struct options *os,
407 const char *name, const char *value);
408 void option_delete(struct options *os, struct option *co);
409 struct option *option_find(const struct options *os, const char *name);
410 void option_set(struct option *o, const char *value);
412 void kernel_init(void);
413 int kernel_lun_add(struct lun *lun);
414 int kernel_lun_modify(struct lun *lun);
415 int kernel_lun_remove(struct lun *lun);
416 void kernel_handoff(struct connection *conn);
417 void kernel_limits(const char *offload,
418 int *max_recv_data_segment_length,
419 int *max_send_data_segment_length,
420 int *max_burst_length,
421 int *first_burst_length);
422 int kernel_port_add(struct port *port);
423 int kernel_port_update(struct port *port, struct port *old);
424 int kernel_port_remove(struct port *port);
425 void kernel_capsicate(void);
427 #ifdef ICL_KERNEL_PROXY
428 void kernel_listen(struct addrinfo *ai, bool iser,
430 void kernel_accept(int *connection_id, int *portal_id,
431 struct sockaddr *client_sa,
432 socklen_t *client_salen);
433 void kernel_send(struct pdu *pdu);
434 void kernel_receive(struct pdu *pdu);
437 struct keys *keys_new(void);
438 void keys_delete(struct keys *keys);
439 void keys_load(struct keys *keys, const struct pdu *pdu);
440 void keys_save(struct keys *keys, struct pdu *pdu);
441 const char *keys_find(struct keys *keys, const char *name);
442 void keys_add(struct keys *keys,
443 const char *name, const char *value);
444 void keys_add_int(struct keys *keys,
445 const char *name, int value);
447 struct pdu *pdu_new(struct connection *conn);
448 struct pdu *pdu_new_response(struct pdu *request);
449 void pdu_delete(struct pdu *pdu);
450 void pdu_receive(struct pdu *request);
451 void pdu_send(struct pdu *response);
453 void login(struct connection *conn);
455 void discovery(struct connection *conn);
457 void log_init(int level);
458 void log_set_peer_name(const char *name);
459 void log_set_peer_addr(const char *addr);
460 void log_err(int, const char *, ...)
461 __dead2 __printflike(2, 3);
462 void log_errx(int, const char *, ...)
463 __dead2 __printflike(2, 3);
464 void log_warn(const char *, ...) __printflike(1, 2);
465 void log_warnx(const char *, ...) __printflike(1, 2);
466 void log_debugx(const char *, ...) __printflike(1, 2);
468 char *checked_strdup(const char *);
469 bool valid_iscsi_name(const char *name);
470 void set_timeout(int timeout, int fatal);
471 bool timed_out(void);