xref: /illumos-gate/usr/src/uts/common/smbsrv/smb_ioctl.h (revision a61ed2ce7a86a4d6428f2a83eb4739fae945447e)
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  * Copyright 2017 Nexenta Systems, Inc.  All rights reserved.
24  * Copyright 2017 Joyent, Inc.
25  */
26 
27 #ifndef _SMB_IOCTL_H_
28 #define	_SMB_IOCTL_H_
29 
30 #ifdef	__cplusplus
31 extern "C" {
32 #endif
33 
34 #include <sys/types.h>
35 #include <sys/param.h>
36 #include <smbsrv/smbinfo.h>
37 
38 #define	SMB_IOC_VERSION		0x534D4201	/* SMB1 */
39 
40 #define	SMB_IOC_BASE		(('S' << 16) | ('B' << 8))
41 
42 #define	SMB_IOC_CONFIG		_IOW(SMB_IOC_BASE, 1, int)
43 #define	SMB_IOC_START		_IOW(SMB_IOC_BASE, 2, int)
44 #define	SMB_IOC_GMTOFF		_IOW(SMB_IOC_BASE, 3, int)
45 #define	SMB_IOC_SHARE		_IOW(SMB_IOC_BASE, 4, int)
46 #define	SMB_IOC_UNSHARE		_IOW(SMB_IOC_BASE, 5, int)
47 #define	SMB_IOC_NUMOPEN		_IOW(SMB_IOC_BASE, 6, int)
48 #define	SMB_IOC_SVCENUM		_IOW(SMB_IOC_BASE, 7, int)
49 #define	SMB_IOC_FILE_CLOSE	_IOW(SMB_IOC_BASE, 8, int)
50 #define	SMB_IOC_SESSION_CLOSE	_IOW(SMB_IOC_BASE, 9, int)
51 #define	SMB_IOC_STOP		_IOW(SMB_IOC_BASE, 10, int)
52 #define	SMB_IOC_EVENT		_IOW(SMB_IOC_BASE, 11, int)
53 #define	SMB_IOC_SHAREINFO	_IOW(SMB_IOC_BASE, 12, int)
54 #define	SMB_IOC_SPOOLDOC	_IOW(SMB_IOC_BASE, 13, int)
55 
56 typedef struct smb_ioc_header {
57 	uint32_t	version;
58 	uint32_t	crc;
59 	uint32_t	len;
60 	int		cmd;
61 } smb_ioc_header_t;
62 
63 typedef	struct smb_ioc_spooldoc {
64 	smb_ioc_header_t hdr;
65 	smb_inaddr_t	ipaddr;
66 	uint32_t	spool_num;
67 	char		username[MAXNAMELEN];
68 	char		path[MAXPATHLEN];
69 } smb_ioc_spooldoc_t;
70 
71 typedef	struct {
72 	smb_ioc_header_t hdr;
73 	int32_t		offset;
74 } smb_ioc_gmt_t;
75 
76 typedef struct smb_ioc_share {
77 	smb_ioc_header_t hdr;
78 	uint32_t	shrlen;
79 	char		shr[1];
80 } smb_ioc_share_t;
81 
82 typedef struct smb_ioc_shareinfo {
83 	smb_ioc_header_t hdr;
84 	char		shrname[MAXNAMELEN];
85 	uint32_t	shortnames;
86 } smb_ioc_shareinfo_t;
87 
88 typedef	struct smb_ioc_start {
89 	smb_ioc_header_t hdr;
90 	int		opipe;
91 	int		lmshrd;
92 	int		udoor;
93 	/* These are used only by libfksmbsrv */
94 	void		*opipe_func;
95 	void		*lmshr_func;
96 	void		*udoor_func;
97 } smb_ioc_start_t;
98 
99 typedef	struct smb_ioc_event {
100 	smb_ioc_header_t hdr;
101 	uint32_t	txid;
102 } smb_ioc_event_t;
103 
104 typedef	struct smb_ioc_opennum {
105 	smb_ioc_header_t hdr;
106 	uint32_t	open_users;
107 	uint32_t	open_trees;
108 	uint32_t	open_files;
109 	uint32_t	qualtype;
110 	char		qualifier[MAXNAMELEN];
111 } smb_ioc_opennum_t;
112 
113 /*
114  * For enumeration, user and session are synonymous, as are
115  * connection and tree.
116  */
117 #define	SMB_SVCENUM_TYPE_USER	0x55534552	/* 'USER' */
118 #define	SMB_SVCENUM_TYPE_TREE	0x54524545	/* 'TREE' */
119 #define	SMB_SVCENUM_TYPE_FILE	0x46494C45	/* 'FILE' */
120 #define	SMB_SVCENUM_TYPE_SHARE	0x53484152	/* 'SHAR' */
121 
122 /* Maximum size of payload data an smbsrv ioctl may use. */
123 #define	SMB_IOC_DATA_SIZE		(256 * 1024)
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 					/* (ignored by kernel) */
130 	uint32_t	se_resume;	/* client resume handle */
131 	uint32_t	se_bavail;	/* remaining buffer space in bytes */
132 	uint32_t	se_bused;	/* consumed buffer space in bytes */
133 	uint32_t	se_ntotal;	/* total number of objects */
134 	uint32_t	se_nlimit;	/* max number of objects to return */
135 	uint32_t	se_nitems;	/* number of objects in buf */
136 	uint32_t	se_nskip;	/* number of objects to skip */
137 	uint32_t	se_status;	/* enumeration status */
138 	uint32_t	se_buflen;	/* length of the buffer in bytes */
139 	uint8_t		se_buf[1];	/* buffer to hold enumeration data */
140 } smb_svcenum_t;
141 
142 typedef	struct smb_ioc_svcenum {
143 	smb_ioc_header_t hdr;
144 	smb_svcenum_t	svcenum;
145 } smb_ioc_svcenum_t;
146 
147 typedef struct smb_ioc_session {
148 	smb_ioc_header_t hdr;
149 	char		client[MAXNAMELEN];
150 	char		username[MAXNAMELEN];
151 } smb_ioc_session_t;
152 
153 typedef	struct smb_ioc_fileid {
154 	smb_ioc_header_t hdr;
155 	uint32_t	uniqid;
156 } smb_ioc_fileid_t;
157 
158 /* See also: smb_kmod_cfg_t */
159 typedef struct smb_ioc_cfg {
160 	smb_ioc_header_t hdr;
161 	uint32_t	maxworkers;
162 	uint32_t	maxconnections;
163 	uint32_t	keepalive;
164 	int32_t		restrict_anon;
165 	int32_t		signing_enable;
166 	int32_t		signing_required;
167 	int32_t		oplock_enable;
168 	int32_t		sync_enable;
169 	int32_t		secmode;
170 	int32_t		netbios_enable;
171 	int32_t		ipv6_enable;
172 	int32_t		print_enable;
173 	int32_t		traverse_mounts;
174 	uint32_t	max_protocol;
175 	uint32_t	min_protocol;
176 	uint32_t	encrypt;
177 	uint32_t	exec_flags;
178 	uint32_t	negtok_len;
179 	smb_version_t	version;
180 	uint16_t	initial_credits;
181 	uint16_t	maximum_credits;
182 	/* SMB negotiate protocol response. */
183 	uuid_t		machine_uuid;
184 	uchar_t		negtok[SMB_PI_MAX_NEGTOK];
185 	char		native_os[SMB_PI_MAX_NATIVE_OS];
186 	char		native_lm[SMB_PI_MAX_LANMAN];
187 	char		nbdomain[NETBIOS_NAME_SZ];
188 	char		fqdn[SMB_PI_MAX_DOMAIN];
189 	char		hostname[SMB_PI_MAX_HOST];
190 	char		system_comment[SMB_PI_MAX_COMMENT];
191 } smb_ioc_cfg_t;
192 
193 typedef union smb_ioc {
194 	smb_ioc_header_t	ioc_hdr;
195 	smb_ioc_gmt_t		ioc_gmt;
196 	smb_ioc_cfg_t		ioc_cfg;
197 	smb_ioc_start_t		ioc_start;
198 	smb_ioc_event_t		ioc_event;
199 	smb_ioc_opennum_t	ioc_opennum;
200 	smb_ioc_svcenum_t	ioc_svcenum;
201 	smb_ioc_session_t	ioc_session;
202 	smb_ioc_fileid_t	ioc_fileid;
203 	smb_ioc_share_t		ioc_share;
204 	smb_ioc_shareinfo_t	ioc_shareinfo;
205 	smb_ioc_spooldoc_t	ioc_spooldoc;
206 } smb_ioc_t;
207 
208 uint32_t smb_crc_gen(uint8_t *, size_t);
209 
210 /* fksmbd (init,open,close,ioctl) calls into libfksmbsrv */
211 int fksmbsrv_drv_open(void);
212 int fksmbsrv_drv_close(void);
213 int fksmbsrv_drv_ioctl(int cmd, void *arg);
214 void fksmbsrv_drv_load(void);
215 
216 #ifdef __cplusplus
217 }
218 #endif
219 
220 #endif /* _SMB_IOCTL_H_ */
221