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