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