1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /*
3 * Copyright (C) 2018 Samsung Electronics Co., Ltd.
4 *
5 * linux-ksmbd-devel@lists.sourceforge.net
6 */
7
8 #ifndef _LINUX_KSMBD_SERVER_H
9 #define _LINUX_KSMBD_SERVER_H
10
11 #include <linux/types.h>
12
13 /*
14 * This is a userspace ABI to communicate data between ksmbd and user IPC
15 * daemon using netlink. This is added to track and cache user account DB
16 * and share configuration info from userspace.
17 *
18 * - KSMBD_EVENT_HEARTBEAT_REQUEST(ksmbd_heartbeat)
19 * This event is to check whether user IPC daemon is alive. If user IPC
20 * daemon is dead, ksmbd keep existing connection till disconnecting and
21 * new connection will be denied.
22 *
23 * - KSMBD_EVENT_STARTING_UP(ksmbd_startup_request)
24 * This event is to receive the information that initializes the ksmbd
25 * server from the user IPC daemon and to start the server. The global
26 * section parameters are given from smb.conf as initialization
27 * information.
28 *
29 * - KSMBD_EVENT_SHUTTING_DOWN(ksmbd_shutdown_request)
30 * This event is to shutdown ksmbd server.
31 *
32 * - KSMBD_EVENT_LOGIN_REQUEST/RESPONSE(ksmbd_login_request/response)
33 * This event is to get user account info to user IPC daemon.
34 *
35 * - KSMBD_EVENT_SHARE_CONFIG_REQUEST/RESPONSE(ksmbd_share_config_request/response)
36 * This event is to get net share configuration info.
37 *
38 * - KSMBD_EVENT_TREE_CONNECT_REQUEST/RESPONSE(ksmbd_tree_connect_request/response)
39 * This event is to get session and tree connect info.
40 *
41 * - KSMBD_EVENT_TREE_DISCONNECT_REQUEST(ksmbd_tree_disconnect_request)
42 * This event is to send tree disconnect info to user IPC daemon.
43 *
44 * - KSMBD_EVENT_LOGOUT_REQUEST(ksmbd_logout_request)
45 * This event is to send logout request to user IPC daemon.
46 *
47 * - KSMBD_EVENT_RPC_REQUEST/RESPONSE(ksmbd_rpc_command)
48 * This event is to make DCE/RPC request like srvsvc, wkssvc, lsarpc,
49 * samr to be processed in userspace.
50 *
51 * - KSMBD_EVENT_SPNEGO_AUTHEN_REQUEST/RESPONSE(ksmbd_spnego_authen_request/response)
52 * This event is to make kerberos authentication to be processed in
53 * userspace.
54 */
55
56 #define KSMBD_GENL_NAME "SMBD_GENL"
57 #define KSMBD_GENL_VERSION 0x01
58
59 #define KSMBD_REQ_MAX_ACCOUNT_NAME_SZ 48
60 #define KSMBD_REQ_MAX_HASH_SZ 18
61 #define KSMBD_REQ_MAX_SHARE_NAME 64
62
63 /*
64 * IPC heartbeat frame to check whether user IPC daemon is alive.
65 */
66 struct ksmbd_heartbeat {
67 __u32 handle;
68 };
69
70 /*
71 * Global config flags.
72 */
73 #define KSMBD_GLOBAL_FLAG_INVALID (0)
74 #define KSMBD_GLOBAL_FLAG_SMB2_LEASES BIT(0)
75 #define KSMBD_GLOBAL_FLAG_SMB2_ENCRYPTION BIT(1)
76 #define KSMBD_GLOBAL_FLAG_SMB3_MULTICHANNEL BIT(2)
77
78 /*
79 * IPC request for ksmbd server startup
80 */
81 struct ksmbd_startup_request {
82 __u32 flags; /* Flags for global config */
83 __s32 signing; /* Signing enabled */
84 __s8 min_prot[16]; /* The minimum SMB protocol version */
85 __s8 max_prot[16]; /* The maximum SMB protocol version */
86 __s8 netbios_name[16];
87 __s8 work_group[64]; /* Workgroup */
88 __s8 server_string[64]; /* Server string */
89 __u16 tcp_port; /* tcp port */
90 __u16 ipc_timeout; /*
91 * specifies the number of seconds
92 * server will wait for the userspace to
93 * reply to heartbeat frames.
94 */
95 __u32 deadtime; /* Number of minutes of inactivity */
96 __u32 file_max; /* Limits the maximum number of open files */
97 __u32 smb2_max_write; /* MAX write size */
98 __u32 smb2_max_read; /* MAX read size */
99 __u32 smb2_max_trans; /* MAX trans size */
100 __u32 share_fake_fscaps; /*
101 * Support some special application that
102 * makes QFSINFO calls to check whether
103 * we set the SPARSE_FILES bit (0x40).
104 */
105 __u32 sub_auth[3]; /* Subauth value for Security ID */
106 __u32 smb2_max_credits; /* MAX credits */
107 __u32 smbd_max_io_size; /* smbd read write size */
108 __u32 reserved[127]; /* Reserved room */
109 __u32 ifc_list_sz; /* interfaces list size */
110 __s8 ____payload[];
111 };
112
113 #define KSMBD_STARTUP_CONFIG_INTERFACES(s) ((s)->____payload)
114
115 /*
116 * IPC request to shutdown ksmbd server.
117 */
118 struct ksmbd_shutdown_request {
119 __s32 reserved[16];
120 };
121
122 /*
123 * IPC user login request.
124 */
125 struct ksmbd_login_request {
126 __u32 handle;
127 __s8 account[KSMBD_REQ_MAX_ACCOUNT_NAME_SZ]; /* user account name */
128 __u32 reserved[16]; /* Reserved room */
129 };
130
131 /*
132 * IPC user login response.
133 */
134 struct ksmbd_login_response {
135 __u32 handle;
136 __u32 gid; /* group id */
137 __u32 uid; /* user id */
138 __s8 account[KSMBD_REQ_MAX_ACCOUNT_NAME_SZ]; /* user account name */
139 __u16 status;
140 __u16 hash_sz; /* hash size */
141 __s8 hash[KSMBD_REQ_MAX_HASH_SZ]; /* password hash */
142 __u32 reserved[16]; /* Reserved room */
143 };
144
145 /*
146 * IPC request to fetch net share config.
147 */
148 struct ksmbd_share_config_request {
149 __u32 handle;
150 __s8 share_name[KSMBD_REQ_MAX_SHARE_NAME]; /* share name */
151 __u32 reserved[16]; /* Reserved room */
152 };
153
154 /*
155 * IPC response to the net share config request.
156 */
157 struct ksmbd_share_config_response {
158 __u32 handle;
159 __u32 flags;
160 __u16 create_mask;
161 __u16 directory_mask;
162 __u16 force_create_mode;
163 __u16 force_directory_mode;
164 __u16 force_uid;
165 __u16 force_gid;
166 __s8 share_name[KSMBD_REQ_MAX_SHARE_NAME];
167 __u32 reserved[112]; /* Reserved room */
168 __u32 veto_list_sz;
169 __s8 ____payload[];
170 };
171
172 #define KSMBD_SHARE_CONFIG_VETO_LIST(s) ((s)->____payload)
173
174 static inline char *
ksmbd_share_config_path(struct ksmbd_share_config_response * sc)175 ksmbd_share_config_path(struct ksmbd_share_config_response *sc)
176 {
177 char *p = sc->____payload;
178
179 if (sc->veto_list_sz)
180 p += sc->veto_list_sz + 1;
181
182 return p;
183 }
184
185 /*
186 * IPC request for tree connection. This request include session and tree
187 * connect info from client.
188 */
189 struct ksmbd_tree_connect_request {
190 __u32 handle;
191 __u16 account_flags;
192 __u16 flags;
193 __u64 session_id;
194 __u64 connect_id;
195 __s8 account[KSMBD_REQ_MAX_ACCOUNT_NAME_SZ];
196 __s8 share[KSMBD_REQ_MAX_SHARE_NAME];
197 __s8 peer_addr[64];
198 __u32 reserved[16]; /* Reserved room */
199 };
200
201 /*
202 * IPC Response structure for tree connection.
203 */
204 struct ksmbd_tree_connect_response {
205 __u32 handle;
206 __u16 status;
207 __u16 connection_flags;
208 __u32 reserved[16]; /* Reserved room */
209 };
210
211 /*
212 * IPC Request struture to disconnect tree connection.
213 */
214 struct ksmbd_tree_disconnect_request {
215 __u64 session_id; /* session id */
216 __u64 connect_id; /* tree connection id */
217 __u32 reserved[16]; /* Reserved room */
218 };
219
220 /*
221 * IPC Response structure to logout user account.
222 */
223 struct ksmbd_logout_request {
224 __s8 account[KSMBD_REQ_MAX_ACCOUNT_NAME_SZ]; /* user account name */
225 __u32 account_flags;
226 __u32 reserved[16]; /* Reserved room */
227 };
228
229 /*
230 * RPC command structure to send rpc request like srvsvc or wkssvc to
231 * IPC user daemon.
232 */
233 struct ksmbd_rpc_command {
234 __u32 handle;
235 __u32 flags;
236 __u32 payload_sz;
237 __u8 payload[];
238 };
239
240 /*
241 * IPC Request Kerberos authentication
242 */
243 struct ksmbd_spnego_authen_request {
244 __u32 handle;
245 __u16 spnego_blob_len; /* the length of spnego_blob */
246 __u8 spnego_blob[]; /*
247 * the GSS token from SecurityBuffer of
248 * SMB2 SESSION SETUP request
249 */
250 };
251
252 /*
253 * Response data which includes the GSS token and the session key generated by
254 * user daemon.
255 */
256 struct ksmbd_spnego_authen_response {
257 __u32 handle;
258 struct ksmbd_login_response login_response; /*
259 * the login response with
260 * a user identified by the
261 * GSS token from a client
262 */
263 __u16 session_key_len; /* the length of the session key */
264 __u16 spnego_blob_len; /*
265 * the length of the GSS token which will be
266 * stored in SecurityBuffer of SMB2 SESSION
267 * SETUP response
268 */
269 __u8 payload[]; /* session key + AP_REP */
270 };
271
272 /*
273 * This also used as NETLINK attribute type value.
274 *
275 * NOTE:
276 * Response message type value should be equal to
277 * request message type value + 1.
278 */
279 enum ksmbd_event {
280 KSMBD_EVENT_UNSPEC = 0,
281 KSMBD_EVENT_HEARTBEAT_REQUEST,
282
283 KSMBD_EVENT_STARTING_UP,
284 KSMBD_EVENT_SHUTTING_DOWN,
285
286 KSMBD_EVENT_LOGIN_REQUEST,
287 KSMBD_EVENT_LOGIN_RESPONSE = 5,
288
289 KSMBD_EVENT_SHARE_CONFIG_REQUEST,
290 KSMBD_EVENT_SHARE_CONFIG_RESPONSE,
291
292 KSMBD_EVENT_TREE_CONNECT_REQUEST,
293 KSMBD_EVENT_TREE_CONNECT_RESPONSE,
294
295 KSMBD_EVENT_TREE_DISCONNECT_REQUEST = 10,
296
297 KSMBD_EVENT_LOGOUT_REQUEST,
298
299 KSMBD_EVENT_RPC_REQUEST,
300 KSMBD_EVENT_RPC_RESPONSE,
301
302 KSMBD_EVENT_SPNEGO_AUTHEN_REQUEST,
303 KSMBD_EVENT_SPNEGO_AUTHEN_RESPONSE = 15,
304
305 KSMBD_EVENT_MAX
306 };
307
308 /*
309 * Enumeration for IPC tree connect status.
310 */
311 enum KSMBD_TREE_CONN_STATUS {
312 KSMBD_TREE_CONN_STATUS_OK = 0,
313 KSMBD_TREE_CONN_STATUS_NOMEM,
314 KSMBD_TREE_CONN_STATUS_NO_SHARE,
315 KSMBD_TREE_CONN_STATUS_NO_USER,
316 KSMBD_TREE_CONN_STATUS_INVALID_USER,
317 KSMBD_TREE_CONN_STATUS_HOST_DENIED = 5,
318 KSMBD_TREE_CONN_STATUS_CONN_EXIST,
319 KSMBD_TREE_CONN_STATUS_TOO_MANY_CONNS,
320 KSMBD_TREE_CONN_STATUS_TOO_MANY_SESSIONS,
321 KSMBD_TREE_CONN_STATUS_ERROR,
322 };
323
324 /*
325 * User config flags.
326 */
327 #define KSMBD_USER_FLAG_INVALID (0)
328 #define KSMBD_USER_FLAG_OK BIT(0)
329 #define KSMBD_USER_FLAG_BAD_PASSWORD BIT(1)
330 #define KSMBD_USER_FLAG_BAD_UID BIT(2)
331 #define KSMBD_USER_FLAG_BAD_USER BIT(3)
332 #define KSMBD_USER_FLAG_GUEST_ACCOUNT BIT(4)
333 #define KSMBD_USER_FLAG_DELAY_SESSION BIT(5)
334
335 /*
336 * Share config flags.
337 */
338 #define KSMBD_SHARE_FLAG_INVALID (0)
339 #define KSMBD_SHARE_FLAG_AVAILABLE BIT(0)
340 #define KSMBD_SHARE_FLAG_BROWSEABLE BIT(1)
341 #define KSMBD_SHARE_FLAG_WRITEABLE BIT(2)
342 #define KSMBD_SHARE_FLAG_READONLY BIT(3)
343 #define KSMBD_SHARE_FLAG_GUEST_OK BIT(4)
344 #define KSMBD_SHARE_FLAG_GUEST_ONLY BIT(5)
345 #define KSMBD_SHARE_FLAG_STORE_DOS_ATTRS BIT(6)
346 #define KSMBD_SHARE_FLAG_OPLOCKS BIT(7)
347 #define KSMBD_SHARE_FLAG_PIPE BIT(8)
348 #define KSMBD_SHARE_FLAG_HIDE_DOT_FILES BIT(9)
349 #define KSMBD_SHARE_FLAG_INHERIT_OWNER BIT(10)
350 #define KSMBD_SHARE_FLAG_STREAMS BIT(11)
351 #define KSMBD_SHARE_FLAG_FOLLOW_SYMLINKS BIT(12)
352 #define KSMBD_SHARE_FLAG_ACL_XATTR BIT(13)
353 #define KSMBD_SHARE_FLAG_UPDATE BIT(14)
354
355 /*
356 * Tree connect request flags.
357 */
358 #define KSMBD_TREE_CONN_FLAG_REQUEST_SMB1 (0)
359 #define KSMBD_TREE_CONN_FLAG_REQUEST_IPV6 BIT(0)
360 #define KSMBD_TREE_CONN_FLAG_REQUEST_SMB2 BIT(1)
361
362 /*
363 * Tree connect flags.
364 */
365 #define KSMBD_TREE_CONN_FLAG_GUEST_ACCOUNT BIT(0)
366 #define KSMBD_TREE_CONN_FLAG_READ_ONLY BIT(1)
367 #define KSMBD_TREE_CONN_FLAG_WRITABLE BIT(2)
368 #define KSMBD_TREE_CONN_FLAG_ADMIN_ACCOUNT BIT(3)
369 #define KSMBD_TREE_CONN_FLAG_UPDATE BIT(4)
370
371 /*
372 * RPC over IPC.
373 */
374 #define KSMBD_RPC_METHOD_RETURN BIT(0)
375 #define KSMBD_RPC_SRVSVC_METHOD_INVOKE BIT(1)
376 #define KSMBD_RPC_SRVSVC_METHOD_RETURN (KSMBD_RPC_SRVSVC_METHOD_INVOKE | KSMBD_RPC_METHOD_RETURN)
377 #define KSMBD_RPC_WKSSVC_METHOD_INVOKE BIT(2)
378 #define KSMBD_RPC_WKSSVC_METHOD_RETURN (KSMBD_RPC_WKSSVC_METHOD_INVOKE | KSMBD_RPC_METHOD_RETURN)
379 #define KSMBD_RPC_IOCTL_METHOD (BIT(3) | KSMBD_RPC_METHOD_RETURN)
380 #define KSMBD_RPC_OPEN_METHOD BIT(4)
381 #define KSMBD_RPC_WRITE_METHOD BIT(5)
382 #define KSMBD_RPC_READ_METHOD (BIT(6) | KSMBD_RPC_METHOD_RETURN)
383 #define KSMBD_RPC_CLOSE_METHOD BIT(7)
384 #define KSMBD_RPC_RAP_METHOD (BIT(8) | KSMBD_RPC_METHOD_RETURN)
385 #define KSMBD_RPC_RESTRICTED_CONTEXT BIT(9)
386 #define KSMBD_RPC_SAMR_METHOD_INVOKE BIT(10)
387 #define KSMBD_RPC_SAMR_METHOD_RETURN (KSMBD_RPC_SAMR_METHOD_INVOKE | KSMBD_RPC_METHOD_RETURN)
388 #define KSMBD_RPC_LSARPC_METHOD_INVOKE BIT(11)
389 #define KSMBD_RPC_LSARPC_METHOD_RETURN (KSMBD_RPC_LSARPC_METHOD_INVOKE | KSMBD_RPC_METHOD_RETURN)
390
391 /*
392 * RPC status definitions.
393 */
394 #define KSMBD_RPC_OK 0
395 #define KSMBD_RPC_EBAD_FUNC 0x00000001
396 #define KSMBD_RPC_EACCESS_DENIED 0x00000005
397 #define KSMBD_RPC_EBAD_FID 0x00000006
398 #define KSMBD_RPC_ENOMEM 0x00000008
399 #define KSMBD_RPC_EBAD_DATA 0x0000000D
400 #define KSMBD_RPC_ENOTIMPLEMENTED 0x00000040
401 #define KSMBD_RPC_EINVALID_PARAMETER 0x00000057
402 #define KSMBD_RPC_EMORE_DATA 0x000000EA
403 #define KSMBD_RPC_EINVALID_LEVEL 0x0000007C
404 #define KSMBD_RPC_SOME_NOT_MAPPED 0x00000107
405
406 #define KSMBD_CONFIG_OPT_DISABLED 0
407 #define KSMBD_CONFIG_OPT_ENABLED 1
408 #define KSMBD_CONFIG_OPT_AUTO 2
409 #define KSMBD_CONFIG_OPT_MANDATORY 3
410
411 #endif /* _LINUX_KSMBD_SERVER_H */
412
