usr.sbin/iscsid/iscsid.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 ISCSID_H
  33 #define ISCSID_H
  34
  35 #include <stdbool.h>
  36 #include <stdint.h>
  37
  38 #include <iscsi_ioctl.h>
  39
  40 #define DEFAULT_PIDFILE                 "/var/run/iscsid.pid"
  41
  42 #define CONN_DIGEST_NONE                0
  43 #define CONN_DIGEST_CRC32C              1
  44
  45 #define CONN_MUTUAL_CHALLENGE_LEN       1024
  46 #define SOCKBUF_SIZE                    1048576
  47 #define MAX_BURST_LENGTH                (256 * 1024)
  48 #define FIRST_BURST_LENGTH              (128 * 1024)
  49
  50 struct connection {
  51         int                     conn_iscsi_fd;
  52         int                     conn_socket;
  53         unsigned int            conn_session_id;
  54         struct iscsi_session_conf       conn_conf;
  55         struct iscsi_session_limits     conn_limits;
  56         char                    conn_target_alias[ISCSI_ADDR_LEN];
  57         uint8_t                 conn_isid[6];
  58         uint16_t                conn_tsih;
  59         uint32_t                conn_statsn;
  60         int                     conn_header_digest;
  61         int                     conn_data_digest;
  62         bool                    conn_initial_r2t;
  63         bool                    conn_immediate_data;
  64         size_t                  conn_max_data_segment_length;
  65         size_t                  conn_max_burst_length;
  66         size_t                  conn_first_burst_length;
  67         struct chap             *conn_mutual_chap;
  68 };
  69
  70 struct pdu {
  71         struct connection       *pdu_connection;
  72         struct iscsi_bhs        *pdu_bhs;
  73         char                    *pdu_data;
  74         size_t                  pdu_data_len;
  75 };
  76
  77 #define KEYS_MAX                1024
  78
  79 struct keys {
  80         char                    *keys_names[KEYS_MAX];
  81         char                    *keys_values[KEYS_MAX];
  82         char                    *keys_data;
  83         size_t                  keys_data_len;
  84 };
  85
  86 #define CHAP_CHALLENGE_LEN      1024
  87 #define CHAP_DIGEST_LEN         16 /* Equal to MD5 digest size. */
  88
  89 struct chap {
  90         unsigned char   chap_id;
  91         char            chap_challenge[CHAP_CHALLENGE_LEN];
  92         char            chap_response[CHAP_DIGEST_LEN];
  93 };
  94
  95 struct rchap {
  96         char            *rchap_secret;
  97         unsigned char   rchap_id;
  98         void            *rchap_challenge;
  99         size_t          rchap_challenge_len;
 100 };
 101
 102 struct chap             *chap_new(void);
 103 char                    *chap_get_id(const struct chap *chap);
 104 char                    *chap_get_challenge(const struct chap *chap);
 105 int                     chap_receive(struct chap *chap, const char *response);
 106 int                     chap_authenticate(struct chap *chap,
 107                             const char *secret);
 108 void                    chap_delete(struct chap *chap);
 109
 110 struct rchap            *rchap_new(const char *secret);
 111 int                     rchap_receive(struct rchap *rchap,
 112                             const char *id, const char *challenge);
 113 char                    *rchap_get_response(struct rchap *rchap);
 114 void                    rchap_delete(struct rchap *rchap);
 115
 116 struct keys             *keys_new(void);
 117 void                    keys_delete(struct keys *key);
 118 void                    keys_load(struct keys *keys, const struct pdu *pdu);
 119 void                    keys_save(struct keys *keys, struct pdu *pdu);
 120 const char              *keys_find(struct keys *keys, const char *name);
 121 void                    keys_add(struct keys *keys,
 122                             const char *name, const char *value);
 123 void                    keys_add_int(struct keys *keys,
 124                             const char *name, int value);
 125
 126 struct pdu              *pdu_new(struct connection *ic);
 127 struct pdu              *pdu_new_response(struct pdu *request);
 128 void                    pdu_receive(struct pdu *request);
 129 void                    pdu_send(struct pdu *response);
 130 void                    pdu_delete(struct pdu *ip);
 131
 132 void                    login(struct connection *ic);
 133
 134 void                    discovery(struct connection *ic);
 135
 136 void                    log_init(int level);
 137 void                    log_set_peer_name(const char *name);
 138 void                    log_set_peer_addr(const char *addr);
 139 void                    log_err(int, const char *, ...)
 140                             __dead2 __printflike(2, 3);
 141 void                    log_errx(int, const char *, ...)
 142                             __dead2 __printflike(2, 3);
 143 void                    log_warn(const char *, ...) __printflike(1, 2);
 144 void                    log_warnx(const char *, ...) __printflike(1, 2);
 145 void                    log_debugx(const char *, ...) __printflike(1, 2);
 146
 147 char                    *checked_strdup(const char *);
 148 bool                    timed_out(void);
 149 void                    fail(const struct connection *, const char *);
 150
 151 #endif /* !ISCSID_H */