1116743Ssam/*- 2186904Ssam * Copyright (c) 2012 The FreeBSD Foundation 3116743Ssam * All rights reserved. 4116743Ssam * 5116743Ssam * This software was developed by Edward Tomasz Napierala under sponsorship 6116743Ssam * from the FreeBSD Foundation. 7116743Ssam * 8116743Ssam * Redistribution and use in source and binary forms, with or without 9116743Ssam * modification, are permitted provided that the following conditions 10116743Ssam * are met: 11116743Ssam * 1. Redistributions of source code must retain the above copyright 12116743Ssam * notice, this list of conditions and the following disclaimer. 13116743Ssam * 2. Redistributions in binary form must reproduce the above copyright 14116743Ssam * notice, this list of conditions and the following disclaimer in the 15116743Ssam * documentation and/or other materials provided with the distribution. 16116743Ssam * 17116743Ssam * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 18116743Ssam * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19116743Ssam * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20116743Ssam * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 21116743Ssam * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22116743Ssam * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23116743Ssam * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24116743Ssam * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25116743Ssam * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26116743Ssam * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27116743Ssam * SUCH DAMAGE. 28116743Ssam * 29116743Ssam * $FreeBSD: releng/11.0/usr.sbin/ctld/ctld.h 301720 2016-06-09 07:19:02Z trasz $ 30116743Ssam */ 31116743Ssam 32116743Ssam#ifndef CTLD_H 33116743Ssam#define CTLD_H 34116743Ssam 35116743Ssam#include <sys/queue.h> 36116743Ssam#ifdef ICL_KERNEL_PROXY 37116743Ssam#include <sys/types.h> 38185522Ssam#endif 39185522Ssam#include <sys/socket.h> 40119783Ssam#include <stdbool.h> 41116743Ssam#include <libutil.h> 42138570Ssam 43116743Ssam#define DEFAULT_CONFIG_PATH "/etc/ctl.conf" 44116743Ssam#define DEFAULT_PIDFILE "/var/run/ctld.pid" 45116743Ssam#define DEFAULT_BLOCKSIZE 512 46220033Sadrian#define DEFAULT_CD_BLOCKSIZE 2048 47237000Sadrian 48237000Sadrian#define MAX_LUNS 1024 49237000Sadrian#define MAX_NAME_LEN 223 50237000Sadrian#define MAX_DATA_SEGMENT_LENGTH (128 * 1024) 51237000Sadrian#define MAX_BURST_LENGTH 16776192 52237000Sadrian#define FIRST_BURST_LENGTH (128 * 1024) 53237000Sadrian#define SOCKBUF_SIZE 1048576 54237000Sadrian 55220033Sadrianstruct auth { 56220033Sadrian TAILQ_ENTRY(auth) a_next; 57220053Sadrian struct auth_group *a_auth_group; 58235804Sadrian char *a_user; 59220033Sadrian char *a_secret; 60220033Sadrian char *a_mutual_user; 61220033Sadrian char *a_mutual_secret; 62155481Ssam}; 63116743Ssam 64155481Ssamstruct auth_name { 65155481Ssam TAILQ_ENTRY(auth_name) an_next; 66170530Ssam struct auth_group *an_auth_group; 67155481Ssam char *an_initator_name; 68178354Ssam}; 69178354Ssam 70140438Ssamstruct auth_portal { 71138570Ssam TAILQ_ENTRY(auth_portal) ap_next; 72155480Ssam struct auth_group *ap_auth_group; 73138570Ssam char *ap_initator_portal; 74116743Ssam struct sockaddr_storage ap_sa; 75225818Sadrian int ap_mask; 76147067Ssam}; 77147067Ssam 78147067Ssam#define AG_TYPE_UNKNOWN 0 79147057Ssam#define AG_TYPE_DENY 1 80147057Ssam#define AG_TYPE_NO_AUTHENTICATION 2 81147057Ssam#define AG_TYPE_CHAP 3 82147057Ssam#define AG_TYPE_CHAP_MUTUAL 4 83147057Ssam 84147057Ssamstruct auth_group { 85147057Ssam TAILQ_ENTRY(auth_group) ag_next; 86147057Ssam struct conf *ag_conf; 87147057Ssam char *ag_name; 88147057Ssam struct target *ag_target; 89147057Ssam int ag_type; 90170530Ssam TAILQ_HEAD(, auth) ag_auths; 91170530Ssam TAILQ_HEAD(, auth_name) ag_names; 92170530Ssam TAILQ_HEAD(, auth_portal) ag_portals; 93170530Ssam}; 94227328Sadrian 95227328Sadrianstruct portal { 96227328Sadrian TAILQ_ENTRY(portal) p_next; 97227328Sadrian struct portal_group *p_portal_group; 98227328Sadrian bool p_iser; 99227328Sadrian char *p_listen; 100227328Sadrian struct addrinfo *p_ai; 101227328Sadrian#ifdef ICL_KERNEL_PROXY 102227328Sadrian int p_id; 103227328Sadrian#endif 104227328Sadrian 105227328Sadrian TAILQ_HEAD(, target) p_targets; 106227328Sadrian int p_socket; 107227328Sadrian}; 108227328Sadrian 109227328SadrianTAILQ_HEAD(options, option); 110227328Sadrian 111227328Sadrian#define PG_FILTER_UNKNOWN 0 112227328Sadrian#define PG_FILTER_NONE 1 113227328Sadrian#define PG_FILTER_PORTAL 2 114227328Sadrian#define PG_FILTER_PORTAL_NAME 3 115227328Sadrian#define PG_FILTER_PORTAL_NAME_AUTH 4 116227328Sadrian 117235774Sadrianstruct portal_group { 118233908Sadrian TAILQ_ENTRY(portal_group) pg_next; 119233908Sadrian struct conf *pg_conf; 120227328Sadrian struct options pg_options; 121227328Sadrian char *pg_name; 122227328Sadrian struct auth_group *pg_discovery_auth_group; 123227328Sadrian int pg_discovery_filter; 124227328Sadrian int pg_foreign; 125227328Sadrian bool pg_unassigned; 126227328Sadrian TAILQ_HEAD(, portal) pg_portals; 127227328Sadrian TAILQ_HEAD(, port) pg_ports; 128227328Sadrian char *pg_offload; 129227328Sadrian char *pg_redirection; 130227328Sadrian 131227328Sadrian uint16_t pg_tag; 132227328Sadrian}; 133227328Sadrian 134227328Sadrianstruct pport { 135227328Sadrian TAILQ_ENTRY(pport) pp_next; 136227328Sadrian TAILQ_HEAD(, port) pp_ports; 137227328Sadrian struct conf *pp_conf; 138227328Sadrian char *pp_name; 139227328Sadrian 140227328Sadrian uint32_t pp_ctl_port; 141227328Sadrian}; 142227328Sadrian 143227328Sadrianstruct port { 144227328Sadrian TAILQ_ENTRY(port) p_next; 145227328Sadrian TAILQ_ENTRY(port) p_pgs; 146227328Sadrian TAILQ_ENTRY(port) p_pps; 147227328Sadrian TAILQ_ENTRY(port) p_ts; 148227328Sadrian struct conf *p_conf; 149227328Sadrian char *p_name; 150227328Sadrian struct auth_group *p_auth_group; 151227328Sadrian struct portal_group *p_portal_group; 152227328Sadrian struct pport *p_pport; 153227328Sadrian struct target *p_target; 154227328Sadrian int p_foreign; 155138570Ssam 156116743Ssam uint32_t p_ctl_port; 157119150Ssam}; 158178354Ssam 159178354Ssamstruct option { 160170530Ssam TAILQ_ENTRY(option) o_next; 161227328Sadrian char *o_name; 162227328Sadrian char *o_value; 163227328Sadrian}; 164138570Ssam 165116743Ssamstruct lun { 166138570Ssam TAILQ_ENTRY(lun) l_next; 167138570Ssam struct conf *l_conf; 168116743Ssam struct options l_options; 169138570Ssam char *l_name; 170138570Ssam char *l_backend; 171138570Ssam uint8_t l_device_type; 172138570Ssam int l_blocksize; 173138570Ssam char *l_device_id; 174138570Ssam char *l_path; 175138570Ssam char *l_scsiname; 176138570Ssam char *l_serial; 177138570Ssam int64_t l_size; 178138570Ssam 179184358Ssam int l_ctl_lun; 180184358Ssam}; 181184358Ssam 182138570Ssamstruct target { 183237000Sadrian TAILQ_ENTRY(target) t_next; 184237000Sadrian struct conf *t_conf; 185237000Sadrian struct lun *t_luns[MAX_LUNS]; 186237000Sadrian struct auth_group *t_auth_group; 187237000Sadrian TAILQ_HEAD(, port) t_ports; 188116743Ssam char *t_name; 189227344Sadrian char *t_alias; 190227328Sadrian char *t_redirection; 191116743Ssam}; 192238436Sadrian 193186904Ssamstruct isns { 194116743Ssam TAILQ_ENTRY(isns) i_next; 195165185Ssam struct conf *i_conf; 196116743Ssam char *i_addr; 197138570Ssam struct addrinfo *i_ai; 198116743Ssam}; 199116743Ssam 200227328Sadrianstruct conf { 201227328Sadrian char *conf_pidfile_path; 202116743Ssam TAILQ_HEAD(, lun) conf_luns; 203140438Ssam TAILQ_HEAD(, target) conf_targets; 204116743Ssam TAILQ_HEAD(, auth_group) conf_auth_groups; 205227328Sadrian TAILQ_HEAD(, port) conf_ports; 206227328Sadrian TAILQ_HEAD(, portal_group) conf_portal_groups; 207227328Sadrian TAILQ_HEAD(, pport) conf_pports; 208227328Sadrian TAILQ_HEAD(, isns) conf_isns; 209227328Sadrian int conf_isns_period; 210227328Sadrian int conf_isns_timeout; 211227328Sadrian int conf_debug; 212227328Sadrian int conf_timeout; 213227328Sadrian int conf_maxproc; 214227328Sadrian 215237046Sadrian#ifdef ICL_KERNEL_PROXY 216227328Sadrian int conf_portal_id; 217227328Sadrian#endif 218237046Sadrian struct pidfh *conf_pidfh; 219237046Sadrian 220237046Sadrian bool conf_default_pg_defined; 221237046Sadrian bool conf_default_ag_defined; 222237046Sadrian bool conf_kernel_port_on; 223237046Sadrian}; 224237046Sadrian 225234109Sadrian#define CONN_SESSION_TYPE_NONE 0 226234109Sadrian#define CONN_SESSION_TYPE_DISCOVERY 1 227234109Sadrian#define CONN_SESSION_TYPE_NORMAL 2 228234109Sadrian 229234109Sadrian#define CONN_DIGEST_NONE 0 230234109Sadrian#define CONN_DIGEST_CRC32C 1 231234109Sadrian 232234109Sadrianstruct connection { 233234109Sadrian struct portal *conn_portal; 234236872Sadrian struct port *conn_port; 235234109Sadrian struct target *conn_target; 236227328Sadrian int conn_socket; 237227328Sadrian int conn_session_type; 238227328Sadrian char *conn_initiator_name; 239227328Sadrian char *conn_initiator_addr; 240237153Sadrian char *conn_initiator_alias; 241237153Sadrian uint8_t conn_initiator_isid[6]; 242227328Sadrian struct sockaddr_storage conn_initiator_sa; 243237153Sadrian uint32_t conn_cmdsn; 244237153Sadrian uint32_t conn_statsn; 245237153Sadrian size_t conn_data_segment_limit; 246237153Sadrian size_t conn_max_data_segment_length; 247227328Sadrian size_t conn_max_burst_length; 248237153Sadrian size_t conn_first_burst_length; 249237153Sadrian int conn_immediate_data; 250237153Sadrian int conn_header_digest; 251237153Sadrian int conn_data_digest; 252237153Sadrian const char *conn_user; 253237153Sadrian struct chap *conn_chap; 254227328Sadrian}; 255237153Sadrian 256237153Sadrianstruct pdu { 257237153Sadrian struct connection *pdu_connection; 258237153Sadrian struct iscsi_bhs *pdu_bhs; 259237153Sadrian char *pdu_data; 260237153Sadrian size_t pdu_data_len; 261237153Sadrian}; 262227328Sadrian 263237153Sadrian#define KEYS_MAX 1024 264237153Sadrian 265237153Sadrianstruct keys { 266227328Sadrian char *keys_names[KEYS_MAX]; 267227328Sadrian char *keys_values[KEYS_MAX]; 268116743Ssam char *keys_data; 269227344Sadrian size_t keys_data_len; 270116743Ssam}; 271237000Sadrian 272186904Ssam#define CHAP_CHALLENGE_LEN 1024 273186904Ssam#define CHAP_DIGEST_LEN 16 /* Equal to MD5 digest size. */ 274138570Ssam 275138570Ssamstruct chap { 276138570Ssam unsigned char chap_id; 277138570Ssam char chap_challenge[CHAP_CHALLENGE_LEN]; 278138570Ssam char chap_response[CHAP_DIGEST_LEN]; 279138570Ssam}; 280238708Sadrian 281138570Ssamstruct rchap { 282158298Ssam char *rchap_secret; 283138570Ssam unsigned char rchap_id; 284138570Ssam void *rchap_challenge; 285138570Ssam size_t rchap_challenge_len; 286138570Ssam}; 287138570Ssam 288138570Ssamstruct chap *chap_new(void); 289138570Ssamchar *chap_get_id(const struct chap *chap); 290138570Ssamchar *chap_get_challenge(const struct chap *chap); 291138570Ssamint chap_receive(struct chap *chap, const char *response); 292138570Ssamint chap_authenticate(struct chap *chap, 293138570Ssam const char *secret); 294138570Ssamvoid chap_delete(struct chap *chap); 295138570Ssam 296138570Ssamstruct rchap *rchap_new(const char *secret); 297138570Ssamint rchap_receive(struct rchap *rchap, 298138570Ssam const char *id, const char *challenge); 299227328Sadrianchar *rchap_get_response(struct rchap *rchap); 300138570Ssamvoid rchap_delete(struct rchap *rchap); 301178354Ssam 302190579Ssamint parse_conf(struct conf *conf, const char *path); 303186904Ssamint uclparse_conf(struct conf *conf, const char *path); 304186904Ssam 305156073Ssamstruct conf *conf_new(void); 306227328Sadrianstruct conf *conf_new_from_kernel(void); 307138570Ssamvoid conf_delete(struct conf *conf); 308138570Ssamint conf_verify(struct conf *conf); 309227344Sadrian 310138570Ssamstruct auth_group *auth_group_new(struct conf *conf, const char *name); 311155482Ssamvoid auth_group_delete(struct auth_group *ag); 312227344Sadrianstruct auth_group *auth_group_find(const struct conf *conf, 313227328Sadrian const char *name); 314227328Sadrianint auth_group_set_type(struct auth_group *ag, 315138570Ssam const char *type); 316138570Ssam 317227328Sadrianconst struct auth *auth_new_chap(struct auth_group *ag, 318227328Sadrian const char *user, const char *secret); 319227328Sadrianconst struct auth *auth_new_chap_mutual(struct auth_group *ag, 320227328Sadrian const char *user, const char *secret, 321155482Ssam const char *user2, const char *secret2); 322155482Ssamconst struct auth *auth_find(const struct auth_group *ag, 323155482Ssam const char *user); 324167252Ssam 325161425Simpconst struct auth_name *auth_name_new(struct auth_group *ag, 326138570Ssam const char *initiator_name); 327138570Ssambool auth_name_defined(const struct auth_group *ag); 328138570Ssamconst struct auth_name *auth_name_find(const struct auth_group *ag, 329138570Ssam const char *initiator_name); 330227328Sadrianint auth_name_check(const struct auth_group *ag, 331138570Ssam const char *initiator_name); 332236873Sadrian 333236873Sadrianconst struct auth_portal *auth_portal_new(struct auth_group *ag, 334236873Sadrian const char *initiator_portal); 335227344Sadrianbool auth_portal_defined(const struct auth_group *ag); 336227344Sadrianconst struct auth_portal *auth_portal_find(const struct auth_group *ag, 337227344Sadrian const struct sockaddr_storage *sa); 338227344Sadrianint auth_portal_check(const struct auth_group *ag, 339138570Ssam const struct sockaddr_storage *sa); 340227344Sadrian 341138570Ssamstruct portal_group *portal_group_new(struct conf *conf, const char *name); 342138570Ssamvoid portal_group_delete(struct portal_group *pg); 343227344Sadrianstruct portal_group *portal_group_find(const struct conf *conf, 344227344Sadrian const char *name); 345138570Ssamint portal_group_add_listen(struct portal_group *pg, 346138570Ssam const char *listen, bool iser); 347227344Sadrianint portal_group_set_filter(struct portal_group *pg, 348138570Ssam const char *filter); 349178354Ssamint portal_group_set_offload(struct portal_group *pg, 350178354Ssam const char *offload); 351178354Ssamint portal_group_set_redirection(struct portal_group *pg, 352178354Ssam const char *addr); 353178354Ssam 354178354Ssamint isns_new(struct conf *conf, const char *addr); 355178354Ssamvoid isns_delete(struct isns *is); 356178354Ssamvoid isns_register(struct isns *isns, struct isns *oldisns); 357192468Ssamvoid isns_check(struct isns *isns); 358178354Ssamvoid isns_deregister(struct isns *isns); 359178354Ssam 360178354Ssamstruct pport *pport_new(struct conf *conf, const char *name, 361178354Ssam uint32_t ctl_port); 362178354Ssamstruct pport *pport_find(const struct conf *conf, const char *name); 363178354Ssamstruct pport *pport_copy(struct pport *pport, struct conf *conf); 364155491Ssamvoid pport_delete(struct pport *pport); 365155486Ssam 366155486Ssamstruct port *port_new(struct conf *conf, struct target *target, 367227328Sadrian struct portal_group *pg); 368227328Sadrianstruct port *port_new_pp(struct conf *conf, struct target *target, 369227328Sadrian struct pport *pp); 370227328Sadrianstruct port *port_find(const struct conf *conf, const char *name); 371227328Sadrianstruct port *port_find_in_pg(const struct portal_group *pg, 372227328Sadrian const char *target); 373227328Sadrianvoid port_delete(struct port *port); 374227328Sadrian 375227328Sadrianstruct target *target_new(struct conf *conf, const char *name); 376227328Sadrianvoid target_delete(struct target *target); 377238055Sadrianstruct target *target_find(struct conf *conf, 378238055Sadrian const char *name); 379238055Sadrianint target_set_redirection(struct target *target, 380238055Sadrian const char *addr); 381238055Sadrian 382238055Sadrianstruct lun *lun_new(struct conf *conf, const char *name); 383238055Sadrianvoid lun_delete(struct lun *lun); 384238284Sadrianstruct lun *lun_find(const struct conf *conf, const char *name); 385238284Sadrianvoid lun_set_backend(struct lun *lun, const char *value); 386238055Sadrianvoid lun_set_device_type(struct lun *lun, uint8_t value); 387238055Sadrianvoid lun_set_blocksize(struct lun *lun, size_t value); 388238284Sadrianvoid lun_set_device_id(struct lun *lun, const char *value); 389238284Sadrianvoid lun_set_path(struct lun *lun, const char *value); 390238284Sadrianvoid lun_set_scsiname(struct lun *lun, const char *value); 391238284Sadrianvoid lun_set_serial(struct lun *lun, const char *value); 392238284Sadrianvoid lun_set_size(struct lun *lun, size_t value); 393238284Sadrianvoid lun_set_ctl_lun(struct lun *lun, uint32_t value); 394238284Sadrian 395238284Sadrianstruct option *option_new(struct options *os, 396238284Sadrian const char *name, const char *value); 397238284Sadrianvoid option_delete(struct options *os, struct option *co); 398238284Sadrianstruct option *option_find(const struct options *os, const char *name); 399238284Sadrianvoid option_set(struct option *o, const char *value); 400238710Sadrian 401238710Sadrianvoid kernel_init(void); 402238710Sadrianint kernel_lun_add(struct lun *lun); 403238710Sadrianint kernel_lun_modify(struct lun *lun); 404238710Sadrianint kernel_lun_remove(struct lun *lun); 405116743Ssamvoid kernel_handoff(struct connection *conn); 406147256Sbrooksvoid kernel_limits(const char *offload, 407138570Ssam size_t *max_data_segment_length); 408227328Sadrianint kernel_port_add(struct port *port); 409234090Sadrianint kernel_port_update(struct port *port, struct port *old); 410235491Sadrianint kernel_port_remove(struct port *port); 411178354Ssamvoid kernel_capsicate(void); 412178354Ssam 413195807Ssam#ifdef ICL_KERNEL_PROXY 414178354Ssamvoid kernel_listen(struct addrinfo *ai, bool iser, 415178354Ssam int portal_id); 416178354Ssamvoid kernel_accept(int *connection_id, int *portal_id, 417178354Ssam struct sockaddr *client_sa, 418238055Sadrian socklen_t *client_salen); 419238608Sadrianvoid kernel_send(struct pdu *pdu); 420238710Sadrianvoid kernel_receive(struct pdu *pdu); 421238710Sadrian#endif 422238284Sadrian 423238284Sadrianstruct keys *keys_new(void); 424238284Sadrianvoid keys_delete(struct keys *keys); 425238284Sadrianvoid keys_load(struct keys *keys, const struct pdu *pdu); 426238284Sadrianvoid keys_save(struct keys *keys, struct pdu *pdu); 427238055Sadrianconst char *keys_find(struct keys *keys, const char *name); 428227328Sadrianvoid keys_add(struct keys *keys, 429138570Ssam const char *name, const char *value); 430116743Ssamvoid keys_add_int(struct keys *keys, 431159290Ssam const char *name, int value); 432159290Ssam 433116743Ssamstruct pdu *pdu_new(struct connection *conn); 434116743Ssamstruct pdu *pdu_new_response(struct pdu *request); 435227328Sadrianvoid pdu_delete(struct pdu *pdu); 436227328Sadrianvoid pdu_receive(struct pdu *request); 437238433Sadrianvoid pdu_send(struct pdu *response); 438238433Sadrian 439155491Ssamvoid login(struct connection *conn); 440116743Ssam 441138570Ssamvoid discovery(struct connection *conn); 442155486Ssam 443138570Ssamvoid log_init(int level); 444178354Ssamvoid log_set_peer_name(const char *name); 445178354Ssamvoid log_set_peer_addr(const char *addr); 446178354Ssamvoid log_err(int, const char *, ...) 447228891Sadrian __dead2 __printflike(2, 3); 448178354Ssamvoid log_errx(int, const char *, ...) 449178354Ssam __dead2 __printflike(2, 3); 450178354Ssamvoid log_warn(const char *, ...) __printflike(1, 2); 451178354Ssamvoid log_warnx(const char *, ...) __printflike(1, 2); 452178354Ssamvoid log_debugx(const char *, ...) __printflike(1, 2); 453178354Ssam 454178354Ssamchar *checked_strdup(const char *); 455178354Ssambool valid_iscsi_name(const char *name); 456155496Ssamvoid set_timeout(int timeout, int fatal); 457178354Ssambool timed_out(void); 458165571Ssam 459170530Ssam#endif /* !CTLD_H */ 460178354Ssam