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 47 #define MAX_LUNS 1024 48 #define MAX_NAME_LEN 223 49 #define MAX_DATA_SEGMENT_LENGTH (128 * 1024) 50 #define MAX_BURST_LENGTH 16776192 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 #define PG_FILTER_UNKNOWN 0 108 #define PG_FILTER_NONE 1 109 #define PG_FILTER_PORTAL 2 110 #define PG_FILTER_PORTAL_NAME 3 111 #define PG_FILTER_PORTAL_NAME_AUTH 4 112 113 struct portal_group { 114 TAILQ_ENTRY(portal_group) pg_next; 115 struct conf *pg_conf; 116 char *pg_name; 117 struct auth_group *pg_discovery_auth_group; 118 int pg_discovery_filter; 119 bool pg_unassigned; 120 TAILQ_HEAD(, portal) pg_portals; 121 TAILQ_HEAD(, port) pg_ports; 122 char *pg_offload; 123 char *pg_redirection; 124 125 uint16_t pg_tag; 126 }; 127 128 struct pport { 129 TAILQ_ENTRY(pport) pp_next; 130 TAILQ_HEAD(, port) pp_ports; 131 struct conf *pp_conf; 132 char *pp_name; 133 134 uint32_t pp_ctl_port; 135 }; 136 137 struct port { 138 TAILQ_ENTRY(port) p_next; 139 TAILQ_ENTRY(port) p_pgs; 140 TAILQ_ENTRY(port) p_pps; 141 TAILQ_ENTRY(port) p_ts; 142 struct conf *p_conf; 143 char *p_name; 144 struct auth_group *p_auth_group; 145 struct portal_group *p_portal_group; 146 struct pport *p_pport; 147 struct target *p_target; 148 149 uint32_t p_ctl_port; 150 }; 151 152 struct lun_option { 153 TAILQ_ENTRY(lun_option) lo_next; 154 struct lun *lo_lun; 155 char *lo_name; 156 char *lo_value; 157 }; 158 159 struct lun { 160 TAILQ_ENTRY(lun) l_next; 161 struct conf *l_conf; 162 TAILQ_HEAD(, lun_option) l_options; 163 char *l_name; 164 char *l_backend; 165 int l_blocksize; 166 char *l_device_id; 167 char *l_path; 168 char *l_scsiname; 169 char *l_serial; 170 int64_t l_size; 171 172 int l_ctl_lun; 173 }; 174 175 struct target { 176 TAILQ_ENTRY(target) t_next; 177 struct conf *t_conf; 178 struct lun *t_luns[MAX_LUNS]; 179 struct auth_group *t_auth_group; 180 TAILQ_HEAD(, port) t_ports; 181 char *t_name; 182 char *t_alias; 183 char *t_redirection; 184 }; 185 186 struct isns { 187 TAILQ_ENTRY(isns) i_next; 188 struct conf *i_conf; 189 char *i_addr; 190 struct addrinfo *i_ai; 191 }; 192 193 struct conf { 194 char *conf_pidfile_path; 195 TAILQ_HEAD(, lun) conf_luns; 196 TAILQ_HEAD(, target) conf_targets; 197 TAILQ_HEAD(, auth_group) conf_auth_groups; 198 TAILQ_HEAD(, port) conf_ports; 199 TAILQ_HEAD(, portal_group) conf_portal_groups; 200 TAILQ_HEAD(, pport) conf_pports; 201 TAILQ_HEAD(, isns) conf_isns; 202 int conf_isns_period; 203 int conf_isns_timeout; 204 int conf_debug; 205 int conf_timeout; 206 int conf_maxproc; 207 208 #ifdef ICL_KERNEL_PROXY 209 int conf_portal_id; 210 #endif 211 struct pidfh *conf_pidfh; 212 213 bool conf_default_pg_defined; 214 bool conf_default_ag_defined; 215 bool conf_kernel_port_on; 216 }; 217 218 #define CONN_SESSION_TYPE_NONE 0 219 #define CONN_SESSION_TYPE_DISCOVERY 1 220 #define CONN_SESSION_TYPE_NORMAL 2 221 222 #define CONN_DIGEST_NONE 0 223 #define CONN_DIGEST_CRC32C 1 224 225 struct connection { 226 struct portal *conn_portal; 227 struct port *conn_port; 228 struct target *conn_target; 229 int conn_socket; 230 int conn_session_type; 231 char *conn_initiator_name; 232 char *conn_initiator_addr; 233 char *conn_initiator_alias; 234 uint8_t conn_initiator_isid[6]; 235 struct sockaddr_storage conn_initiator_sa; 236 uint32_t conn_cmdsn; 237 uint32_t conn_statsn; 238 size_t conn_data_segment_limit; 239 size_t conn_max_data_segment_length; 240 size_t conn_max_burst_length; 241 int conn_immediate_data; 242 int conn_header_digest; 243 int conn_data_digest; 244 const char *conn_user; 245 struct chap *conn_chap; 246 }; 247 248 struct pdu { 249 struct connection *pdu_connection; 250 struct iscsi_bhs *pdu_bhs; 251 char *pdu_data; 252 size_t pdu_data_len; 253 }; 254 255 #define KEYS_MAX 1024 256 257 struct keys { 258 char *keys_names[KEYS_MAX]; 259 char *keys_values[KEYS_MAX]; 260 char *keys_data; 261 size_t keys_data_len; 262 }; 263 264 #define CHAP_CHALLENGE_LEN 1024 265 #define CHAP_DIGEST_LEN 16 /* Equal to MD5 digest size. */ 266 267 struct chap { 268 unsigned char chap_id; 269 char chap_challenge[CHAP_CHALLENGE_LEN]; 270 char chap_response[CHAP_DIGEST_LEN]; 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