1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3 * 4 * Copyright (c) 2012 The FreeBSD Foundation 5 * All rights reserved. 6 * 7 * This software was developed by Edward Tomasz Napierala under sponsorship 8 * from the FreeBSD Foundation. 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions 12 * are met: 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. 18 * 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 29 * SUCH DAMAGE. 30 * 31 * $FreeBSD$ 32 */ 33 34 #ifndef CTLD_H 35 #define CTLD_H 36 37 #include <sys/queue.h> 38 #ifdef ICL_KERNEL_PROXY 39 #include <sys/types.h> 40 #endif 41 #include <sys/socket.h> 42 #include <stdbool.h> 43 #include <libutil.h> 44 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 49 50 #define MAX_LUNS 1024 51 #define MAX_NAME_LEN 223 52 #define MAX_DATA_SEGMENT_LENGTH (128 * 1024) 53 #define SOCKBUF_SIZE 1048576 54 55 struct auth { 56 TAILQ_ENTRY(auth) a_next; 57 struct auth_group *a_auth_group; 58 char *a_user; 59 char *a_secret; 60 char *a_mutual_user; 61 char *a_mutual_secret; 62 }; 63 64 struct auth_name { 65 TAILQ_ENTRY(auth_name) an_next; 66 struct auth_group *an_auth_group; 67 char *an_initator_name; 68 }; 69 70 struct auth_portal { 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; 75 int ap_mask; 76 }; 77 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 83 84 struct auth_group { 85 TAILQ_ENTRY(auth_group) ag_next; 86 struct conf *ag_conf; 87 char *ag_name; 88 struct target *ag_target; 89 int ag_type; 90 TAILQ_HEAD(, auth) ag_auths; 91 TAILQ_HEAD(, auth_name) ag_names; 92 TAILQ_HEAD(, auth_portal) ag_portals; 93 }; 94 95 struct portal { 96 TAILQ_ENTRY(portal) p_next; 97 struct portal_group *p_portal_group; 98 bool p_iser; 99 char *p_listen; 100 struct addrinfo *p_ai; 101 #ifdef ICL_KERNEL_PROXY 102 int p_id; 103 #endif 104 105 TAILQ_HEAD(, target) p_targets; 106 int p_socket; 107 }; 108 109 TAILQ_HEAD(options, option); 110 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 116 117 struct portal_group { 118 TAILQ_ENTRY(portal_group) pg_next; 119 struct conf *pg_conf; 120 struct options pg_options; 121 char *pg_name; 122 struct auth_group *pg_discovery_auth_group; 123 int pg_discovery_filter; 124 int pg_foreign; 125 bool pg_unassigned; 126 TAILQ_HEAD(, portal) pg_portals; 127 TAILQ_HEAD(, port) pg_ports; 128 char *pg_offload; 129 char *pg_redirection; 130 int pg_dscp; 131 int pg_pcp; 132 133 uint16_t pg_tag; 134 }; 135 136 struct pport { 137 TAILQ_ENTRY(pport) pp_next; 138 TAILQ_HEAD(, port) pp_ports; 139 struct conf *pp_conf; 140 char *pp_name; 141 142 uint32_t pp_ctl_port; 143 }; 144 145 struct 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; 150 struct conf *p_conf; 151 char *p_name; 152 struct auth_group *p_auth_group; 153 struct portal_group *p_portal_group; 154 struct pport *p_pport; 155 struct target *p_target; 156 157 int p_ioctl_port; 158 int p_ioctl_pp; 159 int p_ioctl_vp; 160 uint32_t p_ctl_port; 161 }; 162 163 struct option { 164 TAILQ_ENTRY(option) o_next; 165 char *o_name; 166 char *o_value; 167 }; 168 169 struct lun { 170 TAILQ_ENTRY(lun) l_next; 171 struct conf *l_conf; 172 struct options l_options; 173 char *l_name; 174 char *l_backend; 175 uint8_t l_device_type; 176 int l_blocksize; 177 char *l_device_id; 178 char *l_path; 179 char *l_scsiname; 180 char *l_serial; 181 int64_t l_size; 182 183 int l_ctl_lun; 184 }; 185 186 struct target { 187 TAILQ_ENTRY(target) t_next; 188 struct conf *t_conf; 189 struct lun *t_luns[MAX_LUNS]; 190 struct auth_group *t_auth_group; 191 TAILQ_HEAD(, port) t_ports; 192 char *t_name; 193 char *t_alias; 194 char *t_redirection; 195 }; 196 197 struct isns { 198 TAILQ_ENTRY(isns) i_next; 199 struct conf *i_conf; 200 char *i_addr; 201 struct addrinfo *i_ai; 202 }; 203 204 struct conf { 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; 215 int conf_debug; 216 int conf_timeout; 217 int conf_maxproc; 218 219 #ifdef ICL_KERNEL_PROXY 220 int conf_portal_id; 221 #endif 222 struct pidfh *conf_pidfh; 223 224 bool conf_default_pg_defined; 225 bool conf_default_ag_defined; 226 bool conf_kernel_port_on; 227 }; 228 229 #define CONN_SESSION_TYPE_NONE 0 230 #define CONN_SESSION_TYPE_DISCOVERY 1 231 #define CONN_SESSION_TYPE_NORMAL 2 232 233 #define CONN_DIGEST_NONE 0 234 #define CONN_DIGEST_CRC32C 1 235 236 struct connection { 237 struct portal *conn_portal; 238 struct port *conn_port; 239 struct target *conn_target; 240 int conn_socket; 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; 247 uint32_t conn_cmdsn; 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; 262 }; 263 264 struct pdu { 265 struct connection *pdu_connection; 266 struct iscsi_bhs *pdu_bhs; 267 char *pdu_data; 268 size_t pdu_data_len; 269 }; 270 271 #define KEYS_MAX 1024 272 273 struct keys { 274 char *keys_names[KEYS_MAX]; 275 char *keys_values[KEYS_MAX]; 276 char *keys_data; 277 size_t keys_data_len; 278 }; 279 280 #define CHAP_CHALLENGE_LEN 1024 281 #define CHAP_DIGEST_LEN 16 /* Equal to MD5 digest size. */ 282 283 struct chap { 284 unsigned char chap_id; 285 char chap_challenge[CHAP_CHALLENGE_LEN]; 286 char chap_response[CHAP_DIGEST_LEN]; 287 }; 288 289 struct rchap { 290 char *rchap_secret; 291 unsigned char rchap_id; 292 void *rchap_challenge; 293 size_t rchap_challenge_len; 294 }; 295 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, 301 const char *secret); 302 void chap_delete(struct chap *chap); 303 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); 309 310 int parse_conf(struct conf *conf, const char *path); 311 int uclparse_conf(struct conf *conf, const char *path); 312 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); 317 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, 321 const char *name); 322 int auth_group_set_type(struct auth_group *ag, 323 const char *type); 324 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, 331 const char *user); 332 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); 340 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); 348 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, 352 const char *name); 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, 356 const char *filter); 357 int portal_group_set_offload(struct portal_group *pg, 358 const char *offload); 359 int portal_group_set_redirection(struct portal_group *pg, 360 const char *addr); 361 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); 367 368 struct pport *pport_new(struct conf *conf, const char *name, 369 uint32_t ctl_port); 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); 373 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, 377 int pp, int vp); 378 struct port *port_new_pp(struct conf *conf, struct target *target, 379 struct pport *pp); 380 struct port *port_find(const struct conf *conf, const char *name); 381 struct port *port_find_in_pg(const struct portal_group *pg, 382 const char *target); 383 void port_delete(struct port *port); 384 int port_is_dummy(struct port *port); 385 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, 389 const char *name); 390 int target_set_redirection(struct target *target, 391 const char *addr); 392 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); 405 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); 411 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); 426 427 #ifdef ICL_KERNEL_PROXY 428 void kernel_listen(struct addrinfo *ai, bool iser, 429 int portal_id); 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); 435 #endif 436 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); 446 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); 452 453 void login(struct connection *conn); 454 455 void discovery(struct connection *conn); 456 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); 467 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); 472 473 #endif /* !CTLD_H */ 474