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