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