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 131 uint16_t pg_tag; 132 }; 133 134 struct pport { 135 TAILQ_ENTRY(pport) pp_next; 136 TAILQ_HEAD(, port) pp_ports; 137 struct conf *pp_conf; 138 char *pp_name; 139 140 uint32_t pp_ctl_port; 141 }; 142 143 struct port { 144 TAILQ_ENTRY(port) p_next; 145 TAILQ_ENTRY(port) p_pgs; 146 TAILQ_ENTRY(port) p_pps; 147 TAILQ_ENTRY(port) p_ts; 148 struct conf *p_conf; 149 char *p_name; 150 struct auth_group *p_auth_group; 151 struct portal_group *p_portal_group; 152 struct pport *p_pport; 153 struct target *p_target; 154 155 uint32_t p_ctl_port; 156 }; 157 158 struct option { 159 TAILQ_ENTRY(option) o_next; 160 char *o_name; 161 char *o_value; 162 }; 163 164 struct lun { 165 TAILQ_ENTRY(lun) l_next; 166 struct conf *l_conf; 167 struct options l_options; 168 char *l_name; 169 char *l_backend; 170 uint8_t l_device_type; 171 int l_blocksize; 172 char *l_device_id; 173 char *l_path; 174 char *l_scsiname; 175 char *l_serial; 176 int64_t l_size; 177 178 int l_ctl_lun; 179 }; 180 181 struct target { 182 TAILQ_ENTRY(target) t_next; 183 struct conf *t_conf; 184 struct lun *t_luns[MAX_LUNS]; 185 struct auth_group *t_auth_group; 186 TAILQ_HEAD(, port) t_ports; 187 char *t_name; 188 char *t_alias; 189 char *t_redirection; 190 }; 191 192 struct isns { 193 TAILQ_ENTRY(isns) i_next; 194 struct conf *i_conf; 195 char *i_addr; 196 struct addrinfo *i_ai; 197 }; 198 199 struct conf { 200 char *conf_pidfile_path; 201 TAILQ_HEAD(, lun) conf_luns; 202 TAILQ_HEAD(, target) conf_targets; 203 TAILQ_HEAD(, auth_group) conf_auth_groups; 204 TAILQ_HEAD(, port) conf_ports; 205 TAILQ_HEAD(, portal_group) conf_portal_groups; 206 TAILQ_HEAD(, pport) conf_pports; 207 TAILQ_HEAD(, isns) conf_isns; 208 int conf_isns_period; 209 int conf_isns_timeout; 210 int conf_debug; 211 int conf_timeout; 212 int conf_maxproc; 213 214 #ifdef ICL_KERNEL_PROXY 215 int conf_portal_id; 216 #endif 217 struct pidfh *conf_pidfh; 218 219 bool conf_default_pg_defined; 220 bool conf_default_ag_defined; 221 bool conf_kernel_port_on; 222 }; 223 224 #define CONN_SESSION_TYPE_NONE 0 225 #define CONN_SESSION_TYPE_DISCOVERY 1 226 #define CONN_SESSION_TYPE_NORMAL 2 227 228 #define CONN_DIGEST_NONE 0 229 #define CONN_DIGEST_CRC32C 1 230 231 struct connection { 232 struct portal *conn_portal; 233 struct port *conn_port; 234 struct target *conn_target; 235 int conn_socket; 236 int conn_session_type; 237 char *conn_initiator_name; 238 char *conn_initiator_addr; 239 char *conn_initiator_alias; 240 uint8_t conn_initiator_isid[6]; 241 struct sockaddr_storage conn_initiator_sa; 242 uint32_t conn_cmdsn; 243 uint32_t conn_statsn; 244 int conn_max_recv_data_segment_limit; 245 int conn_max_send_data_segment_limit; 246 int conn_max_burst_limit; 247 int conn_first_burst_limit; 248 int conn_max_recv_data_segment_length; 249 int conn_max_send_data_segment_length; 250 int conn_max_burst_length; 251 int conn_first_burst_length; 252 int conn_immediate_data; 253 int conn_header_digest; 254 int conn_data_digest; 255 const char *conn_user; 256 struct chap *conn_chap; 257 }; 258 259 struct pdu { 260 struct connection *pdu_connection; 261 struct iscsi_bhs *pdu_bhs; 262 char *pdu_data; 263 size_t pdu_data_len; 264 }; 265 266 #define KEYS_MAX 1024 267 268 struct keys { 269 char *keys_names[KEYS_MAX]; 270 char *keys_values[KEYS_MAX]; 271 char *keys_data; 272 size_t keys_data_len; 273 }; 274 275 #define CHAP_CHALLENGE_LEN 1024 276 #define CHAP_DIGEST_LEN 16 /* Equal to MD5 digest size. */ 277 278 struct chap { 279 unsigned char chap_id; 280 char chap_challenge[CHAP_CHALLENGE_LEN]; 281 char chap_response[CHAP_DIGEST_LEN]; 282 }; 283 284 struct rchap { 285 char *rchap_secret; 286 unsigned char rchap_id; 287 void *rchap_challenge; 288 size_t rchap_challenge_len; 289 }; 290 291 struct chap *chap_new(void); 292 char *chap_get_id(const struct chap *chap); 293 char *chap_get_challenge(const struct chap *chap); 294 int chap_receive(struct chap *chap, const char *response); 295 int chap_authenticate(struct chap *chap, 296 const char *secret); 297 void chap_delete(struct chap *chap); 298 299 struct rchap *rchap_new(const char *secret); 300 int rchap_receive(struct rchap *rchap, 301 const char *id, const char *challenge); 302 char *rchap_get_response(struct rchap *rchap); 303 void rchap_delete(struct rchap *rchap); 304 305 int parse_conf(struct conf *conf, const char *path); 306 int uclparse_conf(struct conf *conf, const char *path); 307 308 struct conf *conf_new(void); 309 struct conf *conf_new_from_kernel(void); 310 void conf_delete(struct conf *conf); 311 int conf_verify(struct conf *conf); 312 313 struct auth_group *auth_group_new(struct conf *conf, const char *name); 314 void auth_group_delete(struct auth_group *ag); 315 struct auth_group *auth_group_find(const struct conf *conf, 316 const char *name); 317 int auth_group_set_type(struct auth_group *ag, 318 const char *type); 319 320 const struct auth *auth_new_chap(struct auth_group *ag, 321 const char *user, const char *secret); 322 const struct auth *auth_new_chap_mutual(struct auth_group *ag, 323 const char *user, const char *secret, 324 const char *user2, const char *secret2); 325 const struct auth *auth_find(const struct auth_group *ag, 326 const char *user); 327 328 const struct auth_name *auth_name_new(struct auth_group *ag, 329 const char *initiator_name); 330 bool auth_name_defined(const struct auth_group *ag); 331 const struct auth_name *auth_name_find(const struct auth_group *ag, 332 const char *initiator_name); 333 int auth_name_check(const struct auth_group *ag, 334 const char *initiator_name); 335 336 const struct auth_portal *auth_portal_new(struct auth_group *ag, 337 const char *initiator_portal); 338 bool auth_portal_defined(const struct auth_group *ag); 339 const struct auth_portal *auth_portal_find(const struct auth_group *ag, 340 const struct sockaddr_storage *sa); 341 int auth_portal_check(const struct auth_group *ag, 342 const struct sockaddr_storage *sa); 343 344 struct portal_group *portal_group_new(struct conf *conf, const char *name); 345 void portal_group_delete(struct portal_group *pg); 346 struct portal_group *portal_group_find(const struct conf *conf, 347 const char *name); 348 int portal_group_add_listen(struct portal_group *pg, 349 const char *listen, bool iser); 350 int portal_group_set_filter(struct portal_group *pg, 351 const char *filter); 352 int portal_group_set_offload(struct portal_group *pg, 353 const char *offload); 354 int portal_group_set_redirection(struct portal_group *pg, 355 const char *addr); 356 357 int isns_new(struct conf *conf, const char *addr); 358 void isns_delete(struct isns *is); 359 void isns_register(struct isns *isns, struct isns *oldisns); 360 void isns_check(struct isns *isns); 361 void isns_deregister(struct isns *isns); 362 363 struct pport *pport_new(struct conf *conf, const char *name, 364 uint32_t ctl_port); 365 struct pport *pport_find(const struct conf *conf, const char *name); 366 struct pport *pport_copy(struct pport *pport, struct conf *conf); 367 void pport_delete(struct pport *pport); 368 369 struct port *port_new(struct conf *conf, struct target *target, 370 struct portal_group *pg); 371 struct port *port_new_pp(struct conf *conf, struct target *target, 372 struct pport *pp); 373 struct port *port_find(const struct conf *conf, const char *name); 374 struct port *port_find_in_pg(const struct portal_group *pg, 375 const char *target); 376 void port_delete(struct port *port); 377 int port_is_dummy(struct port *port); 378 379 struct target *target_new(struct conf *conf, const char *name); 380 void target_delete(struct target *target); 381 struct target *target_find(struct conf *conf, 382 const char *name); 383 int target_set_redirection(struct target *target, 384 const char *addr); 385 386 struct lun *lun_new(struct conf *conf, const char *name); 387 void lun_delete(struct lun *lun); 388 struct lun *lun_find(const struct conf *conf, const char *name); 389 void lun_set_backend(struct lun *lun, const char *value); 390 void lun_set_device_type(struct lun *lun, uint8_t value); 391 void lun_set_blocksize(struct lun *lun, size_t value); 392 void lun_set_device_id(struct lun *lun, const char *value); 393 void lun_set_path(struct lun *lun, const char *value); 394 void lun_set_scsiname(struct lun *lun, const char *value); 395 void lun_set_serial(struct lun *lun, const char *value); 396 void lun_set_size(struct lun *lun, size_t value); 397 void lun_set_ctl_lun(struct lun *lun, uint32_t value); 398 399 struct option *option_new(struct options *os, 400 const char *name, const char *value); 401 void option_delete(struct options *os, struct option *co); 402 struct option *option_find(const struct options *os, const char *name); 403 void option_set(struct option *o, const char *value); 404 405 void kernel_init(void); 406 int kernel_lun_add(struct lun *lun); 407 int kernel_lun_modify(struct lun *lun); 408 int kernel_lun_remove(struct lun *lun); 409 void kernel_handoff(struct connection *conn); 410 void kernel_limits(const char *offload, 411 int *max_recv_data_segment_length, 412 int *max_send_data_segment_length, 413 int *max_burst_length, 414 int *first_burst_length); 415 int kernel_port_add(struct port *port); 416 int kernel_port_update(struct port *port, struct port *old); 417 int kernel_port_remove(struct port *port); 418 void kernel_capsicate(void); 419 420 #ifdef ICL_KERNEL_PROXY 421 void kernel_listen(struct addrinfo *ai, bool iser, 422 int portal_id); 423 void kernel_accept(int *connection_id, int *portal_id, 424 struct sockaddr *client_sa, 425 socklen_t *client_salen); 426 void kernel_send(struct pdu *pdu); 427 void kernel_receive(struct pdu *pdu); 428 #endif 429 430 struct keys *keys_new(void); 431 void keys_delete(struct keys *keys); 432 void keys_load(struct keys *keys, const struct pdu *pdu); 433 void keys_save(struct keys *keys, struct pdu *pdu); 434 const char *keys_find(struct keys *keys, const char *name); 435 void keys_add(struct keys *keys, 436 const char *name, const char *value); 437 void keys_add_int(struct keys *keys, 438 const char *name, int value); 439 440 struct pdu *pdu_new(struct connection *conn); 441 struct pdu *pdu_new_response(struct pdu *request); 442 void pdu_delete(struct pdu *pdu); 443 void pdu_receive(struct pdu *request); 444 void pdu_send(struct pdu *response); 445 446 void login(struct connection *conn); 447 448 void discovery(struct connection *conn); 449 450 void log_init(int level); 451 void log_set_peer_name(const char *name); 452 void log_set_peer_addr(const char *addr); 453 void log_err(int, const char *, ...) 454 __dead2 __printflike(2, 3); 455 void log_errx(int, const char *, ...) 456 __dead2 __printflike(2, 3); 457 void log_warn(const char *, ...) __printflike(1, 2); 458 void log_warnx(const char *, ...) __printflike(1, 2); 459 void log_debugx(const char *, ...) __printflike(1, 2); 460 461 char *checked_strdup(const char *); 462 bool valid_iscsi_name(const char *name); 463 void set_timeout(int timeout, int fatal); 464 bool timed_out(void); 465 466 #endif /* !CTLD_H */ 467