xref: /illumos-gate/usr/src/uts/common/smbsrv/smb_ioctl.h (revision 581cede61ac9c14d8d4ea452562a567189eead78)
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  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 #ifndef _SMB_IOCTL_H_
27 #define	_SMB_IOCTL_H_
28 
29 #ifdef	__cplusplus
30 extern "C" {
31 #endif
32 
33 #include <sys/types.h>
34 #include <sys/param.h>
35 #include <smbsrv/smbinfo.h>
36 
37 #define	SMB_IOC_VERSION		0x534D4201	/* SMB1 */
38 
39 #define	SMB_IOC_BASE		(('S' << 16) | ('B' << 8))
40 
41 #define	SMB_IOC_CONFIG		_IOW(SMB_IOC_BASE, 1, int)
42 #define	SMB_IOC_START		_IOW(SMB_IOC_BASE, 2, int)
43 #define	SMB_IOC_NBT_LISTEN	_IOW(SMB_IOC_BASE, 3, int)
44 #define	SMB_IOC_TCP_LISTEN	_IOW(SMB_IOC_BASE, 4, int)
45 #define	SMB_IOC_NBT_RECEIVE	_IOW(SMB_IOC_BASE, 5, int)
46 #define	SMB_IOC_TCP_RECEIVE	_IOW(SMB_IOC_BASE, 6, int)
47 #define	SMB_IOC_GMTOFF		_IOW(SMB_IOC_BASE, 7, int)
48 #define	SMB_IOC_SHARE		_IOW(SMB_IOC_BASE, 8, int)
49 #define	SMB_IOC_UNSHARE		_IOW(SMB_IOC_BASE, 9, int)
50 #define	SMB_IOC_NUMOPEN		_IOW(SMB_IOC_BASE, 10, int)
51 #define	SMB_IOC_SVCENUM		_IOW(SMB_IOC_BASE, 11, int)
52 #define	SMB_IOC_FILE_CLOSE	_IOW(SMB_IOC_BASE, 12, int)
53 #define	SMB_IOC_SESSION_CLOSE	_IOW(SMB_IOC_BASE, 13, int)
54 
55 typedef struct smb_ioc_header {
56 	uint32_t	version;
57 	uint32_t	crc;
58 	uint32_t	len;
59 	int		cmd;
60 } smb_ioc_header_t;
61 
62 typedef	struct {
63 	smb_ioc_header_t hdr;
64 	int32_t 	offset;
65 } smb_ioc_gmt_t;
66 
67 typedef struct smb_ioc_share {
68 	smb_ioc_header_t hdr;
69 	char		path[MAXPATHLEN];
70 	char		name[MAXNAMELEN];
71 } smb_ioc_share_t;
72 
73 typedef	struct smb_ioc_listen {
74 	smb_ioc_header_t hdr;
75 	int		error;
76 } smb_ioc_listen_t;
77 
78 typedef	struct smb_ioc_start {
79 	smb_ioc_header_t hdr;
80 	int		opipe;
81 	int		lmshrd;
82 	int		udoor;
83 } smb_ioc_start_t;
84 
85 typedef	struct smb_ioc_opennum {
86 	smb_ioc_header_t hdr;
87 	uint32_t	open_users;
88 	uint32_t	open_trees;
89 	uint32_t	open_files;
90 	uint32_t	qualtype;
91 	char		qualifier[MAXNAMELEN];
92 } smb_ioc_opennum_t;
93 
94 /*
95  * For enumeration, user and session are synonymous, as are
96  * connection and tree.
97  */
98 #define	SMB_SVCENUM_TYPE_USER	0x55534552	/* 'USER' */
99 #define	SMB_SVCENUM_TYPE_TREE	0x54524545	/* 'TREE' */
100 #define	SMB_SVCENUM_TYPE_FILE	0x46494C45	/* 'FILE' */
101 #define	SMB_SVCENUM_TYPE_SHARE	0x53484152	/* 'SHAR' */
102 
103 typedef struct smb_svcenum {
104 	uint32_t	se_type;	/* object type to enumerate */
105 	uint32_t	se_level;	/* level of detail being requested */
106 	uint32_t	se_prefmaxlen;	/* client max size buffer preference */
107 	uint32_t	se_resume;	/* client resume handle */
108 	uint32_t	se_bavail;	/* remaining buffer space in bytes */
109 	uint32_t	se_bused;	/* consumed buffer space in bytes */
110 	uint32_t	se_ntotal;	/* total number of objects */
111 	uint32_t	se_nlimit;	/* max number of objects to return */
112 	uint32_t	se_nitems;	/* number of objects in buf */
113 	uint32_t	se_nskip;	/* number of objects to skip */
114 	uint32_t	se_status;	/* enumeration status */
115 	uint32_t	se_buflen;	/* length of the buffer in bytes */
116 	uint8_t		se_buf[1];	/* buffer to hold enumeration data */
117 } smb_svcenum_t;
118 
119 typedef	struct smb_ioc_svcenum {
120 	smb_ioc_header_t hdr;
121 	smb_svcenum_t	svcenum;
122 } smb_ioc_svcenum_t;
123 
124 typedef struct smb_ioc_session {
125 	smb_ioc_header_t hdr;
126 	char		client[MAXNAMELEN];
127 	char		username[MAXNAMELEN];
128 } smb_ioc_session_t;
129 
130 typedef	struct smb_ioc_fileid {
131 	smb_ioc_header_t hdr;
132 	uint32_t	uniqid;
133 } smb_ioc_fileid_t;
134 
135 typedef struct smb_ioc_cfg {
136 	smb_ioc_header_t hdr;
137 	uint32_t	maxworkers;
138 	uint32_t	maxconnections;
139 	uint32_t	keepalive;
140 	int32_t		restrict_anon;
141 	int32_t		signing_enable;
142 	int32_t		signing_required;
143 	int32_t		oplock_enable;
144 	int32_t		sync_enable;
145 	int32_t		secmode;
146 	int32_t		ipv6_enable;
147 	char		nbdomain[NETBIOS_NAME_SZ];
148 	char		fqdn[SMB_PI_MAX_DOMAIN];
149 	char		hostname[SMB_PI_MAX_HOST];
150 	char		system_comment[SMB_PI_MAX_COMMENT];
151 } smb_ioc_cfg_t;
152 
153 typedef union smb_ioc {
154 	smb_ioc_header_t	ioc_hdr;
155 	smb_ioc_gmt_t		ioc_gmt;
156 	smb_ioc_cfg_t		ioc_cfg;
157 	smb_ioc_start_t		ioc_start;
158 	smb_ioc_listen_t	ioc_listen;
159 	smb_ioc_opennum_t	ioc_opennum;
160 	smb_ioc_svcenum_t	ioc_svcenum;
161 	smb_ioc_session_t	ioc_session;
162 	smb_ioc_fileid_t	ioc_fileid;
163 	smb_ioc_share_t		ioc_share;
164 } smb_ioc_t;
165 
166 uint32_t smb_crc_gen(uint8_t *, size_t);
167 
168 #ifdef __cplusplus
169 }
170 #endif
171 
172 #endif /* _SMB_IOCTL_H_ */
173