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