1 /*
2 * CDDL HEADER START
3 *
4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
7 *
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
12 *
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
18 *
19 * CDDL HEADER END
20 */
21
22 /*
23 * Copyright (c) 2006, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Copyright (c) 2013 RackTop Systems.
25 */
26
27 /*
28 * basic API declarations for share management
29 */
30
31 #ifndef _LIBSHARE_H
32 #define _LIBSHARE_H
33
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
37
38 #include <sys/types.h>
39 #include <libnvpair.h>
40
41 /*
42 * Basic datatypes for most functions
43 */
44 typedef void *sa_group_t;
45 typedef void *sa_share_t;
46 typedef void *sa_property_t;
47 typedef void *sa_optionset_t;
48 typedef void *sa_security_t;
49 typedef void *sa_protocol_properties_t;
50 typedef void *sa_resource_t;
51
52 typedef struct sa_handle *sa_handle_t; /* opaque handle to access core functions */
53
54 /*
55 * defined error values
56 */
57
58 #define SA_OK 0
59 #define SA_NO_SUCH_PATH 1 /* provided path doesn't exist */
60 #define SA_NO_MEMORY 2 /* no memory for data structures */
61 #define SA_DUPLICATE_NAME 3 /* object name is already in use */
62 #define SA_BAD_PATH 4 /* not a full path */
63 #define SA_NO_SUCH_GROUP 5 /* group is not defined */
64 #define SA_CONFIG_ERR 6 /* system configuration error */
65 #define SA_SYSTEM_ERR 7 /* system error, use errno */
66 #define SA_SYNTAX_ERR 8 /* syntax error on command line */
67 #define SA_NO_PERMISSION 9 /* no permission for operation */
68 #define SA_BUSY 10 /* resource is busy */
69 #define SA_NO_SUCH_PROP 11 /* property doesn't exist */
70 #define SA_INVALID_NAME 12 /* name of object is invalid */
71 #define SA_INVALID_PROTOCOL 13 /* specified protocol not valid */
72 #define SA_NOT_ALLOWED 14 /* operation not allowed */
73 #define SA_BAD_VALUE 15 /* bad value for property */
74 #define SA_INVALID_SECURITY 16 /* invalid security type */
75 #define SA_NO_SUCH_SECURITY 17 /* security set not found */
76 #define SA_VALUE_CONFLICT 18 /* property value conflict */
77 #define SA_NOT_IMPLEMENTED 19 /* plugin interface not implemented */
78 #define SA_INVALID_PATH 20 /* path is sub-dir of existing share */
79 #define SA_NOT_SUPPORTED 21 /* operation not supported for proto */
80 #define SA_PROP_SHARE_ONLY 22 /* property valid on share only */
81 #define SA_NOT_SHARED 23 /* path is not shared */
82 #define SA_NO_SUCH_RESOURCE 24 /* resource not found */
83 #define SA_RESOURCE_REQUIRED 25 /* resource name is required */
84 #define SA_MULTIPLE_ERROR 26 /* multiple protocols reported error */
85 #define SA_PATH_IS_SUBDIR 27 /* check_path found path is subdir */
86 #define SA_PATH_IS_PARENTDIR 28 /* check_path found path is parent */
87 #define SA_NO_SECTION 29 /* protocol requires section info */
88 #define SA_NO_SUCH_SECTION 30 /* no section found */
89 #define SA_NO_PROPERTIES 31 /* no properties found */
90 #define SA_PASSWORD_ENC 32 /* passwords must be encrypted */
91 #define SA_SHARE_EXISTS 33 /* path or file is already shared */
92
93 /* API Initialization */
94 #define SA_INIT_SHARE_API 0x0001 /* init share specific interface */
95 #define SA_INIT_CONTROL_API 0x0002 /* init control specific interface */
96
97 /* not part of API returns */
98 #define SA_LEGACY_ERR 32 /* share/unshare error return */
99
100 /*
101 * other defined values
102 */
103
104 #define SA_MAX_NAME_LEN 100 /* must fit service instance name */
105 #define SA_MAX_RESOURCE_NAME 255 /* Maximum length of resource name */
106
107 /* Used in calls to sa_add_share() and sa_add_resource() */
108 #define SA_SHARE_TRANSIENT 0 /* shared but not across reboot */
109 #define SA_SHARE_LEGACY 1 /* share is in dfstab only */
110 #define SA_SHARE_PERMANENT 2 /* share goes to repository */
111
112 /* sa_check_path() related */
113 #define SA_CHECK_NORMAL 0 /* only check against active shares */
114 #define SA_CHECK_STRICT 1 /* check against all shares */
115
116 /* RBAC related */
117 #define SA_RBAC_MANAGE "solaris.smf.manage.shares"
118 #define SA_RBAC_VALUE "solaris.smf.value.shares"
119
120 /*
121 * Feature set bit definitions
122 */
123
124 #define SA_FEATURE_NONE 0x0000 /* no feature flags set */
125 #define SA_FEATURE_RESOURCE 0x0001 /* resource names are required */
126 #define SA_FEATURE_DFSTAB 0x0002 /* need to manage in dfstab */
127 #define SA_FEATURE_ALLOWSUBDIRS 0x0004 /* allow subdirs to be shared */
128 #define SA_FEATURE_ALLOWPARDIRS 0x0008 /* allow parent dirs to be shared */
129 #define SA_FEATURE_HAS_SECTIONS 0x0010 /* protocol supports sections */
130 #define SA_FEATURE_ADD_PROPERTIES 0x0020 /* can add properties */
131 #define SA_FEATURE_SERVER 0x0040 /* protocol supports server mode */
132
133 /*
134 * legacy files
135 */
136
137 #define SA_LEGACY_DFSTAB "/etc/dfs/dfstab"
138 #define SA_LEGACY_SHARETAB "/etc/dfs/sharetab"
139
140 /*
141 * SMF related
142 */
143
144 #define SA_SVC_FMRI_BASE "svc:/network/shares/group"
145
146 /* initialization */
147 extern sa_handle_t sa_init(int);
148 extern void sa_fini(sa_handle_t);
149 extern int sa_update_config(sa_handle_t);
150 extern char *sa_errorstr(int);
151
152 /* protocol names */
153 extern int sa_get_protocols(char ***);
154 extern int sa_valid_protocol(char *);
155
156 /* group control (create, remove, etc) */
157 extern sa_group_t sa_create_group(sa_handle_t, char *, int *);
158 extern int sa_remove_group(sa_group_t);
159 extern sa_group_t sa_get_group(sa_handle_t, char *);
160 extern sa_group_t sa_get_next_group(sa_group_t);
161 extern char *sa_get_group_attr(sa_group_t, char *);
162 extern int sa_set_group_attr(sa_group_t, char *, char *);
163 extern sa_group_t sa_get_sub_group(sa_group_t);
164 extern int sa_valid_group_name(char *);
165
166 /* share control */
167 extern sa_share_t sa_add_share(sa_group_t, char *, int, int *);
168 extern int sa_check_path(sa_group_t, char *, int);
169 extern int sa_move_share(sa_group_t, sa_share_t);
170 extern int sa_remove_share(sa_share_t);
171 extern sa_share_t sa_get_share(sa_group_t, char *);
172 extern sa_share_t sa_find_share(sa_handle_t, char *);
173 extern sa_share_t sa_get_next_share(sa_share_t);
174 extern char *sa_get_share_attr(sa_share_t, char *);
175 extern char *sa_get_share_description(sa_share_t);
176 extern sa_group_t sa_get_parent_group(sa_share_t);
177 extern int sa_set_share_attr(sa_share_t, char *, char *);
178 extern int sa_set_share_description(sa_share_t, char *);
179 extern int sa_enable_share(sa_group_t, char *);
180 extern int sa_disable_share(sa_share_t, char *);
181 extern boolean_t sa_is_share(void *);
182
183 /* resource name related */
184 extern sa_resource_t sa_find_resource(sa_handle_t, char *);
185 extern sa_resource_t sa_get_resource(sa_group_t, char *);
186 extern sa_resource_t sa_get_next_resource(sa_resource_t);
187 extern sa_share_t sa_get_resource_parent(sa_resource_t);
188 extern sa_resource_t sa_get_share_resource(sa_share_t, char *);
189 extern sa_resource_t sa_add_resource(sa_share_t, char *, int, int *);
190 extern int sa_remove_resource(sa_resource_t);
191 extern char *sa_get_resource_attr(sa_resource_t, char *);
192 extern int sa_set_resource_attr(sa_resource_t, char *, char *);
193 extern int sa_set_resource_description(sa_resource_t, char *);
194 extern char *sa_get_resource_description(sa_resource_t);
195 extern int sa_enable_resource(sa_resource_t, char *);
196 extern int sa_disable_resource(sa_resource_t, char *);
197 extern int sa_rename_resource(sa_resource_t, char *);
198 extern void sa_fix_resource_name(char *);
199
200 /* data structure free calls */
201 extern void sa_free_attr_string(char *);
202 extern void sa_free_share_description(char *);
203
204 /* optionset control */
205 extern sa_optionset_t sa_get_optionset(sa_group_t, char *);
206 extern sa_optionset_t sa_get_next_optionset(sa_group_t);
207 extern char *sa_get_optionset_attr(sa_optionset_t, char *);
208 extern void sa_set_optionset_attr(sa_optionset_t, char *, char *);
209 extern sa_optionset_t sa_create_optionset(sa_group_t, char *);
210 extern int sa_destroy_optionset(sa_optionset_t);
211 extern sa_optionset_t sa_get_derived_optionset(void *, char *, int);
212 extern void sa_free_derived_optionset(sa_optionset_t);
213
214 /* property functions */
215 extern sa_property_t sa_get_property(sa_optionset_t, char *);
216 extern sa_property_t sa_get_next_property(sa_group_t);
217 extern char *sa_get_property_attr(sa_property_t, char *);
218 extern sa_property_t sa_create_section(char *, char *);
219 extern void sa_set_section_attr(sa_property_t, char *, char *);
220 extern sa_property_t sa_create_property(char *, char *);
221 extern int sa_add_property(void *, sa_property_t);
222 extern int sa_update_property(sa_property_t, char *);
223 extern int sa_remove_property(sa_property_t);
224 extern int sa_commit_properties(sa_optionset_t, int);
225 extern int sa_valid_property(sa_handle_t, void *, char *, sa_property_t);
226 extern boolean_t sa_is_persistent(void *);
227
228 /* security control */
229 extern sa_security_t sa_get_security(sa_group_t, char *, char *);
230 extern sa_security_t sa_get_next_security(sa_security_t);
231 extern char *sa_get_security_attr(sa_optionset_t, char *);
232 extern sa_security_t sa_create_security(sa_group_t, char *, char *);
233 extern int sa_destroy_security(sa_security_t);
234 extern void sa_set_security_attr(sa_security_t, char *, char *);
235 extern sa_optionset_t sa_get_all_security_types(void *, char *, int);
236 extern sa_security_t sa_get_derived_security(void *, char *, char *, int);
237 extern void sa_free_derived_security(sa_security_t);
238
239 /* protocol specific interfaces */
240 extern int sa_parse_legacy_options(sa_group_t, char *, char *);
241 extern char *sa_proto_legacy_format(char *, sa_group_t, int);
242 extern boolean_t sa_is_security(char *, char *);
243 extern sa_protocol_properties_t sa_proto_get_properties(char *);
244 extern uint64_t sa_proto_get_featureset(char *);
245 extern sa_property_t sa_get_protocol_section(sa_protocol_properties_t, char *);
246 extern sa_property_t sa_get_next_protocol_section(sa_property_t, char *);
247 extern sa_property_t sa_get_protocol_property(sa_protocol_properties_t, char *);
248 extern sa_property_t sa_get_next_protocol_property(sa_property_t, char *);
249 extern int sa_set_protocol_property(sa_property_t, char *, char *);
250 extern char *sa_get_protocol_status(char *);
251 extern void sa_format_free(char *);
252 extern sa_protocol_properties_t sa_create_protocol_properties(char *);
253 extern int sa_add_protocol_property(sa_protocol_properties_t, sa_property_t);
254 extern int sa_proto_valid_prop(sa_handle_t, char *, sa_property_t,
255 sa_optionset_t);
256 extern int sa_proto_valid_space(char *, char *);
257 extern char *sa_proto_space_alias(char *, char *);
258 extern int sa_proto_get_transients(sa_handle_t, char *);
259 extern int sa_proto_notify_resource(sa_resource_t, char *);
260 extern int sa_proto_change_notify(sa_share_t, char *);
261 extern int sa_proto_delete_section(char *, char *);
262
263 /* handle legacy (dfstab/sharetab) files */
264 extern int sa_delete_legacy(sa_share_t, char *);
265 extern int sa_update_legacy(sa_share_t, char *);
266 extern int sa_update_sharetab(sa_share_t, char *);
267 extern int sa_delete_sharetab(sa_handle_t, char *, char *);
268
269 /* ZFS functions */
270 extern boolean_t sa_zfs_is_shared(sa_handle_t, char *);
271 extern boolean_t sa_group_is_zfs(sa_group_t);
272 extern boolean_t sa_path_is_zfs(char *);
273 extern int sa_zfs_setprop(sa_handle_t, char *, nvlist_t *);
274
275 /* SA Handle specific functions */
276 extern sa_handle_t sa_find_group_handle(sa_group_t);
277
278 #ifdef __cplusplus
279 }
280 #endif
281
282 #endif /* _LIBSHARE_H */