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) 2008, 2010, Oracle and/or its affiliates. All rights reserved. 24 * Copyright 2013 Nexenta Systems, Inc. All rights reserved. 25 */ 26 27 #ifndef _SMB_SHARE_H 28 #define _SMB_SHARE_H 29 30 #include <sys/param.h> 31 #include <smbsrv/string.h> 32 #include <smbsrv/smb_inet.h> 33 #include <smbsrv/hash_table.h> 34 #include <smbsrv/wintypes.h> 35 #include <smb/lmerr.h> 36 37 #if !defined(_KERNEL) && !defined(_FAKE_KERNEL) 38 #include <libshare.h> 39 #endif 40 41 #ifdef __cplusplus 42 extern "C" { 43 #endif 44 45 #define SMB_CVOL "/var/smb/cvol" 46 #define SMB_SYSROOT SMB_CVOL "/windows" 47 #define SMB_SYSTEM32 SMB_SYSROOT "/system32" 48 #define SMB_VSS SMB_SYSTEM32 "/vss" 49 50 /* 51 * Share Properties: 52 * 53 * name Advertised name of the share 54 * 55 * ad-container Active directory container in which the share 56 * will be published 57 * 58 * abe Determines whether Access Based Enumeration is applied 59 * to a share 60 * 61 * csc Client-side caching (CSC) options applied to this share 62 * disabled The client MUST NOT cache any files 63 * manual The client should not automatically cache every file 64 * that it opens 65 * auto The client may cache every file that it opens 66 * vdo The client may cache every file that it opens 67 * and satisfy file requests from its local cache. 68 * 69 * catia CATIA character substitution 70 * 71 * guestok Determines whether guest access is allowed 72 * 73 * next three properties use access-list a al NFS 74 * 75 * ro list of hosts that will have read-only access 76 * rw list of hosts that will have read/write access 77 * none list of hosts that won't be allowed access 78 */ 79 #define SHOPT_AD_CONTAINER "ad-container" 80 #define SHOPT_ABE "abe" 81 #define SHOPT_NAME "name" 82 #define SHOPT_CSC "csc" 83 #define SHOPT_CATIA "catia" 84 #define SHOPT_GUEST "guestok" 85 #define SHOPT_RO "ro" 86 #define SHOPT_RW "rw" 87 #define SHOPT_NONE "none" 88 #define SHOPT_DFSROOT "dfsroot" 89 #define SHOPT_DESCRIPTION "description" 90 91 #define SMB_DEFAULT_SHARE_GROUP "smb" 92 #define SMB_PROTOCOL_NAME "smb" 93 94 /* 95 * RAP protocol share related commands only understand 96 * share names in OEM format and there is a 13 char size 97 * limitation 98 */ 99 #define SMB_SHARE_OEMNAME_MAX 13 100 #define SMB_SHARE_NTNAME_MAX 81 101 #define SMB_SHARE_CMNT_MAX (64 * MTS_MB_CHAR_MAX) 102 103 /* 104 * struct SHARE_INFO_1 { 105 * char shi1_netname[13] 106 * char shi1_pad; 107 * unsigned short shi1_type 108 * char *shi1_remark; 109 * } 110 */ 111 #define SHARE_INFO_1_SIZE (SMB_SHARE_OEMNAME_MAX + 1 + 2 + 4) 112 113 /* 114 * Share flags: 115 * 116 * There are two types of flags: 117 * 118 * - flags that represent a share property 119 * - other flags set at runtime 120 * 121 * Property flags: 122 * 123 * SMB_SHRF_CSC_DISABLED Client-side caching is disabled for this share 124 * SMB_SHRF_CSC_MANUAL Manual client-side caching is allowed 125 * SMB_SHRF_CSC_AUTO Automatic client-side caching (CSC) is allowed 126 * SMB_SHRF_CSC_VDO Automatic CSC and local cache lookup is allowed 127 * SMB_SHRF_ACC_OPEN No restrictions set 128 * SMB_SHRF_ACC_NONE "none" property set 129 * SMB_SHRF_ACC_RO "ro" (readonly) property set 130 * SMB_SHRF_ACC_RW "rw" (read/write) property set 131 * SMB_SHRF_ACC_ALL All of the access bits 132 * SMB_SHRF_CATIA CATIA character translation on/off 133 * SMB_SHRF_GUEST_OK Guest access on/off 134 * SMB_SHRF_ABE Access Based Enumeration on/off 135 * SMB_SHRF_DFSROOT Share is a standalone DFS root 136 * 137 * Runtime flags: 138 * 139 * SMB_SHRF_TRANS Transient share 140 * SMB_SHRF_PERM Permanent share 141 * SMB_SHRF_AUTOHOME Autohome share. 142 * SMB_SHRF_ADMIN Admin share 143 * 144 * All autohome shares are transient but not all transient shares are autohome. 145 * IPC$ and drive letter shares (e.g. d$, e$, etc) are transient but 146 * not autohome. 147 */ 148 149 /* 150 * Property flags 151 */ 152 #define SMB_SHRF_DFSROOT 0x0001 153 #define SMB_SHRF_CATIA 0x0002 154 #define SMB_SHRF_GUEST_OK 0x0004 155 #define SMB_SHRF_ABE 0x0008 156 157 #define SMB_SHRF_CSC_DISABLED 0x0010 158 #define SMB_SHRF_CSC_MANUAL 0x0020 159 #define SMB_SHRF_CSC_AUTO 0x0040 160 #define SMB_SHRF_CSC_VDO 0x0080 161 #define SMB_SHRF_CSC_MASK 0x00F0 162 163 #define SMB_SHRF_ACC_OPEN 0x0000 164 #define SMB_SHRF_ACC_NONE 0x0100 165 #define SMB_SHRF_ACC_RO 0x0200 166 #define SMB_SHRF_ACC_RW 0x0400 167 #define SMB_SHRF_ACC_ALL 0x0F00 168 169 /* 170 * Runtime flags 171 */ 172 #define SMB_SHRF_ADMIN 0x01000000 173 #define SMB_SHRF_TRANS 0x10000000 174 #define SMB_SHRF_PERM 0x20000000 175 #define SMB_SHRF_AUTOHOME 0x40000000 176 177 #define SMB_SHARE_PRINT "print$" 178 #define SMB_SHARE_PRINT_LEN 6 179 /* 180 * refcnt is currently only used for autohome. autohome needs a refcnt 181 * because a user can map his autohome share from more than one client 182 * at the same time and the share should only be removed when the last 183 * one is disconnected 184 */ 185 typedef struct smb_share { 186 char shr_name[MAXNAMELEN]; 187 char shr_path[MAXPATHLEN]; 188 char shr_cmnt[SMB_SHARE_CMNT_MAX]; 189 char shr_container[MAXPATHLEN]; 190 uint32_t shr_flags; 191 uint32_t shr_type; 192 uint32_t shr_refcnt; 193 uint32_t shr_access_value; /* host return access value */ 194 uid_t shr_uid; /* autohome only */ 195 gid_t shr_gid; /* autohome only */ 196 char shr_access_none[MAXPATHLEN]; 197 char shr_access_ro[MAXPATHLEN]; 198 char shr_access_rw[MAXPATHLEN]; 199 } smb_share_t; 200 201 typedef struct smb_shriter { 202 smb_share_t si_share; 203 HT_ITERATOR si_hashiter; 204 boolean_t si_first; 205 } smb_shriter_t; 206 207 #define LMSHARES_PER_REQUEST 10 208 typedef struct smb_shrlist { 209 int sl_cnt; 210 smb_share_t sl_shares[LMSHARES_PER_REQUEST]; 211 } smb_shrlist_t; 212 213 typedef struct smb_shr_execinfo { 214 char *e_sharename; 215 char *e_winname; 216 char *e_userdom; 217 smb_inaddr_t e_srv_ipaddr; 218 smb_inaddr_t e_cli_ipaddr; 219 char *e_cli_netbiosname; 220 uid_t e_uid; 221 int e_type; 222 } smb_shr_execinfo_t; 223 224 /* 225 * LanMan share API (for both SMB kernel module and GUI/CLI sub-system) 226 * 227 * NOTE: If any error is encounted by either the door server or client, 228 * NERR_InternalError will be returned by most functions, smb_share_count 229 * will return -1. 230 */ 231 232 #if !defined(_KERNEL) && !defined(_FAKE_KERNEL) 233 234 /* 235 * CIFS share management functions exported by libmlsvc 236 */ 237 int smb_shr_start(void); 238 void smb_shr_stop(void); 239 void *smb_shr_load(void *); 240 void smb_shr_iterinit(smb_shriter_t *); 241 smb_share_t *smb_shr_iterate(smb_shriter_t *); 242 void smb_shr_list(int, smb_shrlist_t *); 243 int smb_shr_count(void); 244 uint32_t smb_shr_add(smb_share_t *); 245 uint32_t smb_shr_remove(char *); 246 uint32_t smb_shr_rename(char *, char *); 247 uint32_t smb_shr_get(char *, smb_share_t *); 248 uint32_t smb_shr_modify(smb_share_t *); 249 uint32_t smb_shr_get_realpath(const char *, char *, int); 250 uint32_t smb_shr_hostaccess(smb_inaddr_t *, char *, char *, char *, uint32_t); 251 int smb_shr_exec(smb_shr_execinfo_t *); 252 253 boolean_t smb_shr_exists(char *); 254 int smb_shr_is_special(char *); 255 boolean_t smb_shr_is_restricted(char *); 256 boolean_t smb_shr_is_admin(char *); 257 char smb_shr_drive_letter(const char *); 258 259 sa_handle_t smb_shr_sa_enter(void); 260 void smb_shr_sa_exit(void); 261 void smb_shr_sa_csc_option(const char *, smb_share_t *); 262 char *smb_shr_sa_csc_name(const smb_share_t *); 263 void smb_shr_sa_setflag(const char *, smb_share_t *, uint32_t); 264 265 /* 266 * CIFS share management API exported for other processes 267 */ 268 uint32_t smb_share_list(int, smb_shrlist_t *); 269 int smb_share_count(void); 270 uint32_t smb_share_delete(char *); 271 uint32_t smb_share_rename(char *, char *); 272 uint32_t smb_share_create(smb_share_t *); 273 uint32_t smb_share_modify(smb_share_t *); 274 275 #endif /* _KERNEL */ 276 277 #ifdef __cplusplus 278 } 279 #endif 280 281 #endif /* _SMB_SHARE_H */ 282