fs/ksmbd/ksmbd_netlink.h

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