xref: /freebsd/usr.bin/iscsictl/iscsictl.h (revision 31ac8806885f22d6b3a3948a8f660ba0cf24e9cf)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2012 The FreeBSD Foundation
5  *
6  * This software was developed by Edward Tomasz Napierala under sponsorship
7  * from the FreeBSD Foundation.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28  * SUCH DAMAGE.
29  */
30 
31 #ifndef ISCSICTL_H
32 #define	ISCSICTL_H
33 
34 #include <sys/queue.h>
35 #include <stdbool.h>
36 #include <libutil.h>
37 
38 #define	DEFAULT_CONFIG_PATH		"/etc/iscsi.conf"
39 #define	DEFAULT_IQN			"iqn.1994-09.org.freebsd:"
40 
41 #define	ISCSICTL_XO_VERSION		"1"
42 
43 #define	MAX_NAME_LEN			223
44 
45 #define	AUTH_METHOD_UNSPECIFIED		0
46 #define	AUTH_METHOD_NONE		1
47 #define	AUTH_METHOD_CHAP		2
48 
49 #define	DIGEST_UNSPECIFIED		0
50 #define	DIGEST_NONE			1
51 #define	DIGEST_CRC32C			2
52 
53 #define	SESSION_TYPE_UNSPECIFIED	0
54 #define	SESSION_TYPE_NORMAL		1
55 #define	SESSION_TYPE_DISCOVERY		2
56 
57 #define	PROTOCOL_UNSPECIFIED		0
58 #define	PROTOCOL_ISCSI			1
59 #define	PROTOCOL_ISER			2
60 
61 #define	ENABLE_UNSPECIFIED		0
62 #define	ENABLE_ON			1
63 #define	ENABLE_OFF			2
64 
65 struct target {
66 	TAILQ_ENTRY(target)	t_next;
67 	struct conf		*t_conf;
68 	char			*t_nickname;
69 	char			*t_name;
70 	char			*t_address;
71 	char			*t_initiator_name;
72 	char			*t_initiator_address;
73 	char			*t_initiator_alias;
74 	int			t_header_digest;
75 	int			t_data_digest;
76 	int			t_auth_method;
77 	int			t_session_type;
78 	int			t_enable;
79 	int			t_protocol;
80 	int			t_dscp;
81 	int			t_pcp;
82 	int			t_pingtimeout;
83 	int			t_logintimeout;
84 	char			*t_offload;
85 	char			*t_user;
86 	char			*t_secret;
87 	char			*t_mutual_user;
88 	char			*t_mutual_secret;
89 };
90 
91 struct conf {
92 	TAILQ_HEAD(, target)	conf_targets;
93 };
94 
95 struct conf	*conf_new(void);
96 struct conf	*conf_new_from_file(const char *path);
97 void		conf_delete(struct conf *conf);
98 void		conf_verify(struct conf *conf);
99 
100 struct target	*target_new(struct conf *conf);
101 struct target	*target_find(struct conf *conf, const char *nickname);
102 void		target_delete(struct target *ic);
103 
104 void		print_periphs(int session_id);
105 
106 bool		valid_iscsi_name(const char *name);
107 int		parse_enable(const char *enable);
108 
109 #endif /* !ISCSICTL_H */
110