smb_share.h revision 29bd28862cfb8abbd3a0f0a4b17e08bbc3652836
/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License (the "License").
* You may not use this file except in compliance with the License.
*
* You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at usr/src/OPENSOLARIS.LICENSE.
* If applicable, add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your own identifying
* information: Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*/
/*
* Copyright 2009 Sun Microsystems, Inc. All rights reserved.
* Use is subject to license terms.
*/
#ifndef _SMB_SHARE_H
#define _SMB_SHARE_H
#include <smbsrv/hash_table.h>
#include <smbsrv/wintypes.h>
#include <smbsrv/smb_common_door.h>
#ifndef _KERNEL
#include <libshare.h>
#else
#endif
#ifdef __cplusplus
extern "C" {
#endif
/*
* Share Properties:
*
* name Advertised name of the share
*
* ad-container Active directory container in which the share
* will be published
*
* csc Client-side caching (CSC) options applied to this share
* disabled The client MUST NOT cache any files
* manual The client should not automatically cache every file
* that it opens
* auto The client may cache every file that it opens
* vdo The client may cache every file that it opens
* and satisfy file requests from its local cache.
*
* catia CATIA character substitution
*
* guestok Determines whether guest access is allowed
*
* next three properties use access-list a al NFS
*
* ro list of hosts that will have read-only access
* none list of hosts that won't be allowed access
*/
#define SHOPT_AD_CONTAINER "ad-container"
#define SHOPT_NAME "name"
#define SHOPT_CSC "csc"
#define SHOPT_CATIA "catia"
#define SHOPT_GUEST "guestok"
#define SHOPT_RO "ro"
#define SHOPT_RW "rw"
#define SHOPT_NONE "none"
#define SMB_DEFAULT_SHARE_GROUP "smb"
#define SMB_PROTOCOL_NAME "smb"
#define SMB_SHR_MAP 0
#define SMB_SHR_UNMAP 1
#define SMB_SHR_DISP_CONT_STR "continue"
#define SMB_SHR_DISP_TERM_STR "terminate"
/*
* RAP protocol share related commands only understand
* share names in OEM format and there is a 13 char size
* limitation
*/
#define SMB_SHARE_OEMNAME_MAX 13
/*
* struct SHARE_INFO_1 {
* char shi1_netname[13]
* char shi1_pad;
* unsigned short shi1_type
* char *shi1_remark;
* }
*/
/*
* Share flags:
*
* SMB_SHRF_TRANS Transient share
* SMB_SHRF_PERM Permanent share
* SMB_SHRF_AUTOHOME Autohome share.
* SMB_SHRF_LONGNAME Share name in OEM is longer than 13 chars
* SMB_SHRF_CSC_DISABLED Client-side caching is disabled for this share
* SMB_SHRF_CSC_MANUAL Manual client-side caching is allowed
* SMB_SHRF_CSC_AUTO Automatic client-side caching (CSC) is allowed
* SMB_SHRF_CSC_VDO Automatic CSC and local cache lookup is allowed
* SMB_SHRF_ACC_OPEN No restrictions set
* SMB_SHRF_ACC_NONE "none" property set
* SMB_SHRF_ACC_RO "ro" (readonly) property set
* SMB_SHRF_ACC_ALL All of the access bits
* SMB_SHRF_ADMIN Admin share
*
* SMB_SHRF_MAP Map command is specified
* SMB_SHRF_UNMAP Unmap command is specified
* SMB_SHRF_DISP_TERM Disposition is set to terminate
* SMB_SHRF_EXEC_MASK All of the exec bits
*
* All autohome shares are transient but not all transient shares are autohome.
* IPC$ and drive letter shares (e.g. d$, e$, etc) are transient but
* not autohome.
*/
#define SMB_SHRF_TRANS 0x0001
#define SMB_SHRF_PERM 0x0002
#define SMB_SHRF_AUTOHOME 0x0004
#define SMB_SHRF_LONGNAME 0x0008
#define SMB_SHRF_CSC_MASK 0x00F0
#define SMB_SHRF_CSC_DISABLED 0x0010
#define SMB_SHRF_CSC_MANUAL 0x0020
#define SMB_SHRF_CSC_AUTO 0x0040
#define SMB_SHRF_CSC_VDO 0x0080
/* Access Flags */
#define SMB_SHRF_ACC_OPEN 0x0000
#define SMB_SHRF_ACC_NONE 0x0100
#define SMB_SHRF_ACC_RO 0x0200
#define SMB_SHRF_ACC_RW 0x0400
#define SMB_SHRF_ACC_ALL 0x0F00
#define SMB_SHRF_ADMIN 0x1000
#define SMB_SHRF_CATIA 0x2000
#define SMB_SHRF_GUEST_OK 0x4000
/* Exec Flags */
#define SMB_SHRF_MAP 0x10000
#define SMB_SHRF_UNMAP 0x20000
#define SMB_SHRF_DISP_TERM 0x40000
#define SMB_SHRF_EXEC_MASK 0x70000
/*
* refcnt is currently only used for autohome. autohome needs a refcnt
* because a user can map his autohome share from more than one client
* at the same time and the share should only be removed when the last
* one is disconnected
*/
typedef struct smb_share {
char shr_name[MAXNAMELEN];
char shr_path[MAXPATHLEN];
char shr_cmnt[SMB_SHARE_CMNT_MAX];
char shr_container[MAXPATHLEN];
char shr_oemname[SMB_SHARE_OEMNAME_MAX];
char shr_access_none[MAXPATHLEN];
char shr_access_ro[MAXPATHLEN];
char shr_access_rw[MAXPATHLEN];
} smb_share_t;
typedef struct smb_shriter {
#define LMSHARES_PER_REQUEST 10
typedef struct smb_shrlist {
int sl_cnt;
/*
* This structure is a helper for building NetShareEnum response
* in user space and send it back down to kernel.
*
* es_username name of the user requesting the shares list which
* is used to detect if the user has any autohome
* es_bufsize size of the response buffer
* es_buf pointer to the response buffer
* es_ntotal total number of shares exported by server which
* their OEM names is less then 13 chars
* es_nsent number of shares that can fit in the specified buffer
* es_datasize actual data size (share's data) which was encoded
* in the response buffer
*/
typedef struct smb_enumshare_info {
char *es_username;
char *es_buf;
typedef struct smb_execsub_info {
char *e_winname;
char *e_userdom;
char *e_cli_netbiosname;
/*
*
* NOTE: If any error is encounted by either the door server or client,
* NERR_InternalError will be returned by most functions, smb_share_count
* will return -1.
*/
#ifndef _KERNEL
/*
* CIFS share management functions exported by libmlsvc
*/
int smb_shr_start(void);
void smb_shr_stop(void);
int smb_shr_load(void);
void smb_shr_iterinit(smb_shriter_t *);
void smb_shr_list(int, smb_shrlist_t *);
int smb_shr_count(void);
uint32_t smb_shr_remove(char *);
uint32_t smb_shr_rename(char *, char *);
uint32_t smb_shr_get_realpath(const char *, char *, int);
int smb_shr_exec(char *, smb_execsub_info_t *, int);
boolean_t smb_shr_exists(char *);
int smb_shr_is_special(char *);
boolean_t smb_shr_is_restricted(char *);
boolean_t smb_shr_is_admin(char *);
boolean_t smb_shr_chkname(char *);
sa_handle_t smb_shr_sa_enter(void);
void smb_shr_sa_exit(void);
void smb_shr_sa_csc_option(const char *, smb_share_t *);
char *smb_shr_sa_csc_name(const smb_share_t *);
void smb_shr_sa_catia_option(const char *, smb_share_t *);
/*
* CIFS share management API exported for other processes
*/
int smb_share_count(void);
uint32_t smb_share_delete(char *);
uint32_t smb_share_rename(char *, char *);
#else
door_handle_t smb_kshare_init(int);
void smb_kshare_fini(door_handle_t);
smb_inaddr_t *);
#endif
#define SMB_SHARE_DNAME "/var/run/smb_share_door"
/*
* Door interface
*
* Define door operations
*/
#define SMB_SHROP_NUM_SHARES 1
#define SMB_SHROP_DELETE 2
#define SMB_SHROP_RENAME 3
#define SMB_SHROP_GETINFO 4
#define SMB_SHROP_ADD 5
#define SMB_SHROP_MODIFY 6
#define SMB_SHROP_LIST 7
#define SMB_SHROP_ENUM 8
#define SMB_SHROP_EXEC 9
/*
* Door server status
*
* SMB_SHARE_DERROR is returned by the door server if there is problem
* with marshalling/unmarshalling. Otherwise, SMB_SHARE_DSUCCESS is
* returned.
*
*/
#define SMB_SHARE_DSUCCESS 0
#define SMB_SHARE_DERROR -1
void smb_share_door_clnt_init(void);
void smb_share_door_clnt_fini(void);
#ifdef __cplusplus
}
#endif
#endif /* _SMB_SHARE_H */