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