xref: /freebsd/usr.sbin/iscsid/iscsid.h (revision 7dbbd1aeaed98e379ee3b1589f659831dd39709c)
1009ea47eSEdward Tomasz Napierala /*-
21de7b4b8SPedro F. Giffuni  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
31de7b4b8SPedro F. Giffuni  *
4009ea47eSEdward Tomasz Napierala  * Copyright (c) 2012 The FreeBSD Foundation
5009ea47eSEdward Tomasz Napierala  * All rights reserved.
6009ea47eSEdward Tomasz Napierala  *
7009ea47eSEdward Tomasz Napierala  * This software was developed by Edward Tomasz Napierala under sponsorship
8009ea47eSEdward Tomasz Napierala  * from the FreeBSD Foundation.
9009ea47eSEdward Tomasz Napierala  *
10009ea47eSEdward Tomasz Napierala  * Redistribution and use in source and binary forms, with or without
11009ea47eSEdward Tomasz Napierala  * modification, are permitted provided that the following conditions
12009ea47eSEdward Tomasz Napierala  * are met:
13009ea47eSEdward Tomasz Napierala  * 1. Redistributions of source code must retain the above copyright
14009ea47eSEdward Tomasz Napierala  *    notice, this list of conditions and the following disclaimer.
15009ea47eSEdward Tomasz Napierala  * 2. Redistributions in binary form must reproduce the above copyright
16009ea47eSEdward Tomasz Napierala  *    notice, this list of conditions and the following disclaimer in the
17009ea47eSEdward Tomasz Napierala  *    documentation and/or other materials provided with the distribution.
18009ea47eSEdward Tomasz Napierala  *
19009ea47eSEdward Tomasz Napierala  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20009ea47eSEdward Tomasz Napierala  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21009ea47eSEdward Tomasz Napierala  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22009ea47eSEdward Tomasz Napierala  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
23009ea47eSEdward Tomasz Napierala  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24009ea47eSEdward Tomasz Napierala  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25009ea47eSEdward Tomasz Napierala  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26009ea47eSEdward Tomasz Napierala  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27009ea47eSEdward Tomasz Napierala  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28009ea47eSEdward Tomasz Napierala  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29009ea47eSEdward Tomasz Napierala  * SUCH DAMAGE.
30009ea47eSEdward Tomasz Napierala  *
31009ea47eSEdward Tomasz Napierala  * $FreeBSD$
32009ea47eSEdward Tomasz Napierala  */
33009ea47eSEdward Tomasz Napierala 
34009ea47eSEdward Tomasz Napierala #ifndef ISCSID_H
35009ea47eSEdward Tomasz Napierala #define	ISCSID_H
36009ea47eSEdward Tomasz Napierala 
37009ea47eSEdward Tomasz Napierala #include <stdbool.h>
38009ea47eSEdward Tomasz Napierala #include <stdint.h>
39009ea47eSEdward Tomasz Napierala 
40009ea47eSEdward Tomasz Napierala #include <iscsi_ioctl.h>
41009ea47eSEdward Tomasz Napierala 
42009ea47eSEdward Tomasz Napierala #define	DEFAULT_PIDFILE			"/var/run/iscsid.pid"
43009ea47eSEdward Tomasz Napierala 
44009ea47eSEdward Tomasz Napierala #define	CONN_DIGEST_NONE		0
45009ea47eSEdward Tomasz Napierala #define	CONN_DIGEST_CRC32C		1
46009ea47eSEdward Tomasz Napierala 
47009ea47eSEdward Tomasz Napierala #define	CONN_MUTUAL_CHALLENGE_LEN	1024
488b94b583SAlexander Motin #define	SOCKBUF_SIZE			1048576
49009ea47eSEdward Tomasz Napierala 
50009ea47eSEdward Tomasz Napierala struct connection {
51009ea47eSEdward Tomasz Napierala 	int			conn_iscsi_fd;
52009ea47eSEdward Tomasz Napierala 	int			conn_socket;
53009ea47eSEdward Tomasz Napierala 	unsigned int		conn_session_id;
54009ea47eSEdward Tomasz Napierala 	struct iscsi_session_conf	conn_conf;
5582babffbSEdward Tomasz Napierala 	struct iscsi_session_limits	conn_limits;
56009ea47eSEdward Tomasz Napierala 	char			conn_target_alias[ISCSI_ADDR_LEN];
57009ea47eSEdward Tomasz Napierala 	uint8_t			conn_isid[6];
58ffe82e05SAlexander Motin 	uint16_t		conn_tsih;
59009ea47eSEdward Tomasz Napierala 	uint32_t		conn_statsn;
60*7dbbd1aeSAlexander Motin 	int			conn_protocol_level;
61009ea47eSEdward Tomasz Napierala 	int			conn_header_digest;
62009ea47eSEdward Tomasz Napierala 	int			conn_data_digest;
63009ea47eSEdward Tomasz Napierala 	bool			conn_initial_r2t;
64009ea47eSEdward Tomasz Napierala 	bool			conn_immediate_data;
6597b84d34SNavdeep Parhar 	int			conn_max_recv_data_segment_length;
6697b84d34SNavdeep Parhar 	int			conn_max_send_data_segment_length;
6797b84d34SNavdeep Parhar 	int			conn_max_burst_length;
6897b84d34SNavdeep Parhar 	int			conn_first_burst_length;
6945078155SEdward Tomasz Napierala 	struct chap		*conn_mutual_chap;
70009ea47eSEdward Tomasz Napierala };
71009ea47eSEdward Tomasz Napierala 
72009ea47eSEdward Tomasz Napierala struct pdu {
73009ea47eSEdward Tomasz Napierala 	struct connection	*pdu_connection;
74009ea47eSEdward Tomasz Napierala 	struct iscsi_bhs	*pdu_bhs;
75009ea47eSEdward Tomasz Napierala 	char			*pdu_data;
76009ea47eSEdward Tomasz Napierala 	size_t			pdu_data_len;
77009ea47eSEdward Tomasz Napierala };
78009ea47eSEdward Tomasz Napierala 
79009ea47eSEdward Tomasz Napierala #define	KEYS_MAX		1024
80009ea47eSEdward Tomasz Napierala 
81009ea47eSEdward Tomasz Napierala struct keys {
82009ea47eSEdward Tomasz Napierala 	char			*keys_names[KEYS_MAX];
83009ea47eSEdward Tomasz Napierala 	char			*keys_values[KEYS_MAX];
84009ea47eSEdward Tomasz Napierala 	char			*keys_data;
85009ea47eSEdward Tomasz Napierala 	size_t			keys_data_len;
86009ea47eSEdward Tomasz Napierala };
87009ea47eSEdward Tomasz Napierala 
8845078155SEdward Tomasz Napierala #define	CHAP_CHALLENGE_LEN	1024
89424a3f57SEdward Tomasz Napierala #define	CHAP_DIGEST_LEN		16 /* Equal to MD5 digest size. */
9045078155SEdward Tomasz Napierala 
9145078155SEdward Tomasz Napierala struct chap {
9245078155SEdward Tomasz Napierala 	unsigned char	chap_id;
9345078155SEdward Tomasz Napierala 	char		chap_challenge[CHAP_CHALLENGE_LEN];
94424a3f57SEdward Tomasz Napierala 	char		chap_response[CHAP_DIGEST_LEN];
9545078155SEdward Tomasz Napierala };
9645078155SEdward Tomasz Napierala 
9745078155SEdward Tomasz Napierala struct rchap {
9845078155SEdward Tomasz Napierala 	char		*rchap_secret;
9945078155SEdward Tomasz Napierala 	unsigned char	rchap_id;
10045078155SEdward Tomasz Napierala 	void		*rchap_challenge;
10145078155SEdward Tomasz Napierala 	size_t		rchap_challenge_len;
10245078155SEdward Tomasz Napierala };
10345078155SEdward Tomasz Napierala 
10445078155SEdward Tomasz Napierala struct chap		*chap_new(void);
10545078155SEdward Tomasz Napierala char			*chap_get_id(const struct chap *chap);
10645078155SEdward Tomasz Napierala char			*chap_get_challenge(const struct chap *chap);
10745078155SEdward Tomasz Napierala int			chap_receive(struct chap *chap, const char *response);
10845078155SEdward Tomasz Napierala int			chap_authenticate(struct chap *chap,
10945078155SEdward Tomasz Napierala 			    const char *secret);
11045078155SEdward Tomasz Napierala void			chap_delete(struct chap *chap);
11145078155SEdward Tomasz Napierala 
11245078155SEdward Tomasz Napierala struct rchap		*rchap_new(const char *secret);
11345078155SEdward Tomasz Napierala int			rchap_receive(struct rchap *rchap,
11445078155SEdward Tomasz Napierala 			    const char *id, const char *challenge);
11545078155SEdward Tomasz Napierala char			*rchap_get_response(struct rchap *rchap);
11645078155SEdward Tomasz Napierala void			rchap_delete(struct rchap *rchap);
11745078155SEdward Tomasz Napierala 
118009ea47eSEdward Tomasz Napierala struct keys		*keys_new(void);
119009ea47eSEdward Tomasz Napierala void			keys_delete(struct keys *key);
120009ea47eSEdward Tomasz Napierala void			keys_load(struct keys *keys, const struct pdu *pdu);
121009ea47eSEdward Tomasz Napierala void			keys_save(struct keys *keys, struct pdu *pdu);
122009ea47eSEdward Tomasz Napierala const char		*keys_find(struct keys *keys, const char *name);
123009ea47eSEdward Tomasz Napierala void			keys_add(struct keys *keys,
124009ea47eSEdward Tomasz Napierala 			    const char *name, const char *value);
125009ea47eSEdward Tomasz Napierala void			keys_add_int(struct keys *keys,
126009ea47eSEdward Tomasz Napierala 			    const char *name, int value);
127009ea47eSEdward Tomasz Napierala 
128009ea47eSEdward Tomasz Napierala struct pdu		*pdu_new(struct connection *ic);
129009ea47eSEdward Tomasz Napierala struct pdu		*pdu_new_response(struct pdu *request);
130009ea47eSEdward Tomasz Napierala void			pdu_receive(struct pdu *request);
131009ea47eSEdward Tomasz Napierala void			pdu_send(struct pdu *response);
132009ea47eSEdward Tomasz Napierala void			pdu_delete(struct pdu *ip);
133009ea47eSEdward Tomasz Napierala 
134009ea47eSEdward Tomasz Napierala void			login(struct connection *ic);
135009ea47eSEdward Tomasz Napierala 
136009ea47eSEdward Tomasz Napierala void			discovery(struct connection *ic);
137009ea47eSEdward Tomasz Napierala 
138009ea47eSEdward Tomasz Napierala void			log_init(int level);
139009ea47eSEdward Tomasz Napierala void			log_set_peer_name(const char *name);
140009ea47eSEdward Tomasz Napierala void			log_set_peer_addr(const char *addr);
141009ea47eSEdward Tomasz Napierala void			log_err(int, const char *, ...)
1423fa953a0SEdward Tomasz Napierala 			    __dead2 __printflike(2, 3);
143009ea47eSEdward Tomasz Napierala void			log_errx(int, const char *, ...)
1443fa953a0SEdward Tomasz Napierala 			    __dead2 __printflike(2, 3);
1453fa953a0SEdward Tomasz Napierala void			log_warn(const char *, ...) __printflike(1, 2);
146009ea47eSEdward Tomasz Napierala void			log_warnx(const char *, ...) __printflike(1, 2);
1473fa953a0SEdward Tomasz Napierala void			log_debugx(const char *, ...) __printflike(1, 2);
148009ea47eSEdward Tomasz Napierala 
149009ea47eSEdward Tomasz Napierala char			*checked_strdup(const char *);
150009ea47eSEdward Tomasz Napierala bool			timed_out(void);
151009ea47eSEdward Tomasz Napierala void			fail(const struct connection *, const char *);
152009ea47eSEdward Tomasz Napierala 
153009ea47eSEdward Tomasz Napierala #endif /* !ISCSID_H */
154