13034Sdougm /* 23034Sdougm * CDDL HEADER START 33034Sdougm * 43034Sdougm * The contents of this file are subject to the terms of the 53034Sdougm * Common Development and Distribution License (the "License"). 63034Sdougm * You may not use this file except in compliance with the License. 73034Sdougm * 83034Sdougm * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 93034Sdougm * or http://www.opensolaris.org/os/licensing. 103034Sdougm * See the License for the specific language governing permissions 113034Sdougm * and limitations under the License. 123034Sdougm * 133034Sdougm * When distributing Covered Code, include this CDDL HEADER in each 143034Sdougm * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 153034Sdougm * If applicable, add the following below this CDDL HEADER, with the 163034Sdougm * fields enclosed by brackets "[]" replaced with your own identifying 173034Sdougm * information: Portions Copyright [yyyy] [name of copyright owner] 183034Sdougm * 193034Sdougm * CDDL HEADER END 203034Sdougm */ 213034Sdougm 223034Sdougm /* 2312508Samw@Sun.COM * Copyright (c) 2006, 2010, Oracle and/or its affiliates. All rights reserved. 243034Sdougm */ 253034Sdougm 263034Sdougm /* 273034Sdougm * basic API declarations for share management 283034Sdougm */ 293034Sdougm 303034Sdougm #ifndef _LIBSHARE_H 313034Sdougm #define _LIBSHARE_H 323034Sdougm 333034Sdougm #ifdef __cplusplus 343034Sdougm extern "C" { 353034Sdougm #endif 363034Sdougm 375331Samw #include <sys/types.h> 3812508Samw@Sun.COM #include <libnvpair.h> 395331Samw 403034Sdougm /* 413034Sdougm * Basic datatypes for most functions 423034Sdougm */ 433034Sdougm typedef void *sa_group_t; 443034Sdougm typedef void *sa_share_t; 453034Sdougm typedef void *sa_property_t; 463034Sdougm typedef void *sa_optionset_t; 473034Sdougm typedef void *sa_security_t; 483034Sdougm typedef void *sa_protocol_properties_t; 495331Samw typedef void *sa_resource_t; 503034Sdougm 513034Sdougm typedef void *sa_handle_t; /* opaque handle to access core functions */ 523034Sdougm 533034Sdougm /* 543034Sdougm * defined error values 553034Sdougm */ 563034Sdougm 573034Sdougm #define SA_OK 0 583034Sdougm #define SA_NO_SUCH_PATH 1 /* provided path doesn't exist */ 593034Sdougm #define SA_NO_MEMORY 2 /* no memory for data structures */ 603034Sdougm #define SA_DUPLICATE_NAME 3 /* object name is already in use */ 613034Sdougm #define SA_BAD_PATH 4 /* not a full path */ 623034Sdougm #define SA_NO_SUCH_GROUP 5 /* group is not defined */ 633034Sdougm #define SA_CONFIG_ERR 6 /* system configuration error */ 643034Sdougm #define SA_SYSTEM_ERR 7 /* system error, use errno */ 653034Sdougm #define SA_SYNTAX_ERR 8 /* syntax error on command line */ 663034Sdougm #define SA_NO_PERMISSION 9 /* no permission for operation */ 673034Sdougm #define SA_BUSY 10 /* resource is busy */ 683034Sdougm #define SA_NO_SUCH_PROP 11 /* property doesn't exist */ 693034Sdougm #define SA_INVALID_NAME 12 /* name of object is invalid */ 703034Sdougm #define SA_INVALID_PROTOCOL 13 /* specified protocol not valid */ 713034Sdougm #define SA_NOT_ALLOWED 14 /* operation not allowed */ 723034Sdougm #define SA_BAD_VALUE 15 /* bad value for property */ 733034Sdougm #define SA_INVALID_SECURITY 16 /* invalid security type */ 743034Sdougm #define SA_NO_SUCH_SECURITY 17 /* security set not found */ 753034Sdougm #define SA_VALUE_CONFLICT 18 /* property value conflict */ 763034Sdougm #define SA_NOT_IMPLEMENTED 19 /* plugin interface not implemented */ 773034Sdougm #define SA_INVALID_PATH 20 /* path is sub-dir of existing share */ 783034Sdougm #define SA_NOT_SUPPORTED 21 /* operation not supported for proto */ 793034Sdougm #define SA_PROP_SHARE_ONLY 22 /* property valid on share only */ 803034Sdougm #define SA_NOT_SHARED 23 /* path is not shared */ 815331Samw #define SA_NO_SUCH_RESOURCE 24 /* resource not found */ 825331Samw #define SA_RESOURCE_REQUIRED 25 /* resource name is required */ 835331Samw #define SA_MULTIPLE_ERROR 26 /* multiple protocols reported error */ 845331Samw #define SA_PATH_IS_SUBDIR 27 /* check_path found path is subdir */ 855331Samw #define SA_PATH_IS_PARENTDIR 28 /* check_path found path is parent */ 866007Sthurlow #define SA_NO_SECTION 29 /* protocol requires section info */ 876007Sthurlow #define SA_NO_SUCH_SECTION 30 /* no section found */ 886007Sthurlow #define SA_NO_PROPERTIES 31 /* no properties found */ 896007Sthurlow #define SA_PASSWORD_ENC 32 /* passwords must be encrypted */ 90*12679SPavel.Filipensky@Sun.COM #define SA_SHARE_EXISTS 33 /* path or file is already shared */ 913034Sdougm 923034Sdougm /* API Initialization */ 933034Sdougm #define SA_INIT_SHARE_API 0x0001 /* init share specific interface */ 943034Sdougm #define SA_INIT_CONTROL_API 0x0002 /* init control specific interface */ 953034Sdougm 963034Sdougm /* not part of API returns */ 973034Sdougm #define SA_LEGACY_ERR 32 /* share/unshare error return */ 983034Sdougm 993034Sdougm /* 1003034Sdougm * other defined values 1013034Sdougm */ 1023034Sdougm 1033034Sdougm #define SA_MAX_NAME_LEN 100 /* must fit service instance name */ 1045331Samw #define SA_MAX_RESOURCE_NAME 255 /* Maximum length of resource name */ 1053348Sdougm 1065331Samw /* Used in calls to sa_add_share() and sa_add_resource() */ 1073348Sdougm #define SA_SHARE_TRANSIENT 0 /* shared but not across reboot */ 1083034Sdougm #define SA_SHARE_LEGACY 1 /* share is in dfstab only */ 1093348Sdougm #define SA_SHARE_PERMANENT 2 /* share goes to repository */ 1103348Sdougm 1113348Sdougm /* sa_check_path() related */ 1123348Sdougm #define SA_CHECK_NORMAL 0 /* only check against active shares */ 1133348Sdougm #define SA_CHECK_STRICT 1 /* check against all shares */ 1143034Sdougm 1153034Sdougm /* RBAC related */ 1163034Sdougm #define SA_RBAC_MANAGE "solaris.smf.manage.shares" 1173034Sdougm #define SA_RBAC_VALUE "solaris.smf.value.shares" 1183034Sdougm 1193034Sdougm /* 1205331Samw * Feature set bit definitions 1215331Samw */ 1225331Samw 1235331Samw #define SA_FEATURE_NONE 0x0000 /* no feature flags set */ 1245331Samw #define SA_FEATURE_RESOURCE 0x0001 /* resource names are required */ 1255331Samw #define SA_FEATURE_DFSTAB 0x0002 /* need to manage in dfstab */ 1265331Samw #define SA_FEATURE_ALLOWSUBDIRS 0x0004 /* allow subdirs to be shared */ 1275331Samw #define SA_FEATURE_ALLOWPARDIRS 0x0008 /* allow parent dirs to be shared */ 1286007Sthurlow #define SA_FEATURE_HAS_SECTIONS 0x0010 /* protocol supports sections */ 1296007Sthurlow #define SA_FEATURE_ADD_PROPERTIES 0x0020 /* can add properties */ 1306088Sdougm #define SA_FEATURE_SERVER 0x0040 /* protocol supports server mode */ 1315331Samw 1325331Samw /* 1333034Sdougm * legacy files 1343034Sdougm */ 1353034Sdougm 1363034Sdougm #define SA_LEGACY_DFSTAB "/etc/dfs/dfstab" 1373034Sdougm #define SA_LEGACY_SHARETAB "/etc/dfs/sharetab" 1383034Sdougm 1393034Sdougm /* 1403034Sdougm * SMF related 1413034Sdougm */ 1423034Sdougm 1433034Sdougm #define SA_SVC_FMRI_BASE "svc:/network/shares/group" 1443034Sdougm 1453034Sdougm /* initialization */ 1463910Sdougm extern sa_handle_t sa_init(int); 1473910Sdougm extern void sa_fini(sa_handle_t); 1483910Sdougm extern int sa_update_config(sa_handle_t); 1493034Sdougm extern char *sa_errorstr(int); 1503034Sdougm 1513034Sdougm /* protocol names */ 1523034Sdougm extern int sa_get_protocols(char ***); 1533034Sdougm extern int sa_valid_protocol(char *); 1543034Sdougm 1553034Sdougm /* group control (create, remove, etc) */ 1563910Sdougm extern sa_group_t sa_create_group(sa_handle_t, char *, int *); 1573034Sdougm extern int sa_remove_group(sa_group_t); 1583910Sdougm extern sa_group_t sa_get_group(sa_handle_t, char *); 1593034Sdougm extern sa_group_t sa_get_next_group(sa_group_t); 1603034Sdougm extern char *sa_get_group_attr(sa_group_t, char *); 1613034Sdougm extern int sa_set_group_attr(sa_group_t, char *, char *); 1623034Sdougm extern sa_group_t sa_get_sub_group(sa_group_t); 1633034Sdougm extern int sa_valid_group_name(char *); 1643034Sdougm 1653034Sdougm /* share control */ 1663034Sdougm extern sa_share_t sa_add_share(sa_group_t, char *, int, int *); 1673348Sdougm extern int sa_check_path(sa_group_t, char *, int); 1683034Sdougm extern int sa_move_share(sa_group_t, sa_share_t); 1693034Sdougm extern int sa_remove_share(sa_share_t); 1703034Sdougm extern sa_share_t sa_get_share(sa_group_t, char *); 1713910Sdougm extern sa_share_t sa_find_share(sa_handle_t, char *); 1723034Sdougm extern sa_share_t sa_get_next_share(sa_share_t); 1733034Sdougm extern char *sa_get_share_attr(sa_share_t, char *); 1743034Sdougm extern char *sa_get_share_description(sa_share_t); 1753034Sdougm extern sa_group_t sa_get_parent_group(sa_share_t); 1763034Sdougm extern int sa_set_share_attr(sa_share_t, char *, char *); 1773034Sdougm extern int sa_set_share_description(sa_share_t, char *); 1783034Sdougm extern int sa_enable_share(sa_group_t, char *); 1795331Samw extern int sa_disable_share(sa_share_t, char *); 1803034Sdougm extern int sa_is_share(void *); 1813034Sdougm 1825331Samw /* resource name related */ 1835331Samw extern sa_resource_t sa_find_resource(sa_handle_t, char *); 1845331Samw extern sa_resource_t sa_get_resource(sa_group_t, char *); 1855331Samw extern sa_resource_t sa_get_next_resource(sa_resource_t); 1865331Samw extern sa_share_t sa_get_resource_parent(sa_resource_t); 1875331Samw extern sa_resource_t sa_get_share_resource(sa_share_t, char *); 1885331Samw extern sa_resource_t sa_add_resource(sa_share_t, char *, int, int *); 1895331Samw extern int sa_remove_resource(sa_resource_t); 1905331Samw extern char *sa_get_resource_attr(sa_resource_t, char *); 1915331Samw extern int sa_set_resource_attr(sa_resource_t, char *, char *); 1925331Samw extern int sa_set_resource_description(sa_resource_t, char *); 1935331Samw extern char *sa_get_resource_description(sa_resource_t); 1945331Samw extern int sa_enable_resource(sa_resource_t, char *); 1955331Samw extern int sa_disable_resource(sa_resource_t, char *); 1965331Samw extern int sa_rename_resource(sa_resource_t, char *); 1975331Samw extern void sa_fix_resource_name(char *); 1985331Samw 1993034Sdougm /* data structure free calls */ 2003034Sdougm extern void sa_free_attr_string(char *); 2013034Sdougm extern void sa_free_share_description(char *); 2023034Sdougm 2033034Sdougm /* optionset control */ 2043034Sdougm extern sa_optionset_t sa_get_optionset(sa_group_t, char *); 2053034Sdougm extern sa_optionset_t sa_get_next_optionset(sa_group_t); 2063034Sdougm extern char *sa_get_optionset_attr(sa_optionset_t, char *); 2073034Sdougm extern void sa_set_optionset_attr(sa_optionset_t, char *, char *); 2083034Sdougm extern sa_optionset_t sa_create_optionset(sa_group_t, char *); 2093034Sdougm extern int sa_destroy_optionset(sa_optionset_t); 2103034Sdougm extern sa_optionset_t sa_get_derived_optionset(void *, char *, int); 2113034Sdougm extern void sa_free_derived_optionset(sa_optionset_t); 2123034Sdougm 2133034Sdougm /* property functions */ 2144180Sdougm extern sa_property_t sa_get_property(sa_optionset_t, char *); 2154180Sdougm extern sa_property_t sa_get_next_property(sa_group_t); 2163034Sdougm extern char *sa_get_property_attr(sa_property_t, char *); 2176007Sthurlow extern sa_property_t sa_create_section(char *, char *); 2186007Sthurlow extern void sa_set_section_attr(sa_property_t, char *, char *); 2193034Sdougm extern sa_property_t sa_create_property(char *, char *); 2203034Sdougm extern int sa_add_property(void *, sa_property_t); 2213034Sdougm extern int sa_update_property(sa_property_t, char *); 2223034Sdougm extern int sa_remove_property(sa_property_t); 2233034Sdougm extern int sa_commit_properties(sa_optionset_t, int); 2246214Sdougm extern int sa_valid_property(sa_handle_t, void *, char *, sa_property_t); 2255331Samw extern int sa_is_persistent(void *); 2263034Sdougm 2273034Sdougm /* security control */ 2283034Sdougm extern sa_security_t sa_get_security(sa_group_t, char *, char *); 2293034Sdougm extern sa_security_t sa_get_next_security(sa_security_t); 2303034Sdougm extern char *sa_get_security_attr(sa_optionset_t, char *); 2313034Sdougm extern sa_security_t sa_create_security(sa_group_t, char *, char *); 2323034Sdougm extern int sa_destroy_security(sa_security_t); 2333034Sdougm extern void sa_set_security_attr(sa_security_t, char *, char *); 2343034Sdougm extern sa_optionset_t sa_get_all_security_types(void *, char *, int); 2353034Sdougm extern sa_security_t sa_get_derived_security(void *, char *, char *, int); 2363034Sdougm extern void sa_free_derived_security(sa_security_t); 2373034Sdougm 2383034Sdougm /* protocol specific interfaces */ 2393034Sdougm extern int sa_parse_legacy_options(sa_group_t, char *, char *); 2403034Sdougm extern char *sa_proto_legacy_format(char *, sa_group_t, int); 2413034Sdougm extern int sa_is_security(char *, char *); 2423034Sdougm extern sa_protocol_properties_t sa_proto_get_properties(char *); 2435331Samw extern uint64_t sa_proto_get_featureset(char *); 2446007Sthurlow extern sa_property_t sa_get_protocol_section(sa_protocol_properties_t, char *); 2456007Sthurlow extern sa_property_t sa_get_next_protocol_section(sa_property_t, char *); 2463034Sdougm extern sa_property_t sa_get_protocol_property(sa_protocol_properties_t, char *); 2476007Sthurlow extern sa_property_t sa_get_next_protocol_property(sa_property_t, char *); 2486007Sthurlow extern int sa_set_protocol_property(sa_property_t, char *, char *); 2493034Sdougm extern char *sa_get_protocol_status(char *); 2503034Sdougm extern void sa_format_free(char *); 2513034Sdougm extern sa_protocol_properties_t sa_create_protocol_properties(char *); 2523034Sdougm extern int sa_add_protocol_property(sa_protocol_properties_t, sa_property_t); 2536214Sdougm extern int sa_proto_valid_prop(sa_handle_t, char *, sa_property_t, 2546214Sdougm sa_optionset_t); 2553034Sdougm extern int sa_proto_valid_space(char *, char *); 2563034Sdougm extern char *sa_proto_space_alias(char *, char *); 2575331Samw extern int sa_proto_get_transients(sa_handle_t, char *); 2585331Samw extern int sa_proto_notify_resource(sa_resource_t, char *); 2595331Samw extern int sa_proto_change_notify(sa_share_t, char *); 2606007Sthurlow extern int sa_proto_delete_section(char *, char *); 2613034Sdougm 2623034Sdougm /* handle legacy (dfstab/sharetab) files */ 2635331Samw extern int sa_delete_legacy(sa_share_t, char *); 2643034Sdougm extern int sa_update_legacy(sa_share_t, char *); 2653034Sdougm extern int sa_update_sharetab(sa_share_t, char *); 2665951Sdougm extern int sa_delete_sharetab(sa_handle_t, char *, char *); 2673034Sdougm 2683034Sdougm /* ZFS functions */ 2693910Sdougm extern int sa_zfs_is_shared(sa_handle_t, char *); 2703034Sdougm extern int sa_group_is_zfs(sa_group_t); 2714543Smarks extern int sa_path_is_zfs(char *); 27212508Samw@Sun.COM extern int sa_zfs_setprop(sa_handle_t, char *, nvlist_t *); 2733910Sdougm 2743910Sdougm /* SA Handle specific functions */ 2753910Sdougm extern sa_handle_t sa_find_group_handle(sa_group_t); 2763910Sdougm 2773034Sdougm #ifdef __cplusplus 2783034Sdougm } 2793034Sdougm #endif 2803034Sdougm 2813034Sdougm #endif /* _LIBSHARE_H */ 282