usr.sbin/ctld/ctld.h

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