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