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