fs/cifs/cifs_ioctl.h

   1 /* SPDX-License-Identifier: LGPL-2.1 */
   2 /*
   3  *   fs/cifs/cifs_ioctl.h
   4  *
   5  *   Structure definitions for io control for cifs/smb3
   6  *
   7  *   Copyright (c) 2015 Steve French <steve.french@primarydata.com>
   8  *
   9  */
  10
  11 struct smb_mnt_fs_info {
  12         __u32   version; /* 0001 */
  13         __u16   protocol_id;
  14         __u16   tcon_flags;
  15         __u32   vol_serial_number;
  16         __u32   vol_create_time;
  17         __u32   share_caps;
  18         __u32   share_flags;
  19         __u32   sector_flags;
  20         __u32   optimal_sector_size;
  21         __u32   max_bytes_chunk;
  22         __u32   fs_attributes;
  23         __u32   max_path_component;
  24         __u32   device_type;
  25         __u32   device_characteristics;
  26         __u32   maximal_access;
  27         __u64   cifs_posix_caps;
  28 } __packed;
  29
  30 struct smb_snapshot_array {
  31         __u32   number_of_snapshots;
  32         __u32   number_of_snapshots_returned;
  33         __u32   snapshot_array_size;
  34         /*      snapshots[]; */
  35 } __packed;
  36
  37 /* query_info flags */
  38 #define PASSTHRU_QUERY_INFO     0x00000000
  39 #define PASSTHRU_FSCTL          0x00000001
  40 #define PASSTHRU_SET_INFO       0x00000002
  41 struct smb_query_info {
  42         __u32   info_type;
  43         __u32   file_info_class;
  44         __u32   additional_information;
  45         __u32   flags;
  46         __u32   input_buffer_length;
  47         __u32   output_buffer_length;
  48         /* char buffer[]; */
  49 } __packed;
  50
  51 /*
  52  * Dumping the commonly used 16 byte (e.g. CCM and GCM128) keys still supported
  53  * for backlevel compatibility, but is not sufficient for dumping the less
  54  * frequently used GCM256 (32 byte) keys (see the newer "CIFS_DUMP_FULL_KEY"
  55  * ioctl for dumping decryption info for GCM256 mounts)
  56  */
  57 struct smb3_key_debug_info {
  58         __u64   Suid;
  59         __u16   cipher_type;
  60         __u8    auth_key[16]; /* SMB2_NTLMV2_SESSKEY_SIZE */
  61         __u8    smb3encryptionkey[SMB3_SIGN_KEY_SIZE];
  62         __u8    smb3decryptionkey[SMB3_SIGN_KEY_SIZE];
  63 } __packed;
  64
  65 /*
  66  * Dump variable-sized keys
  67  */
  68 struct smb3_full_key_debug_info {
  69         /* INPUT: size of userspace buffer */
  70         __u32   in_size;
  71
  72         /*
  73          * INPUT: 0 for current user, otherwise session to dump
  74          * OUTPUT: session id that was dumped
  75          */
  76         __u64   session_id;
  77         __u16   cipher_type;
  78         __u8    session_key_length;
  79         __u8    server_in_key_length;
  80         __u8    server_out_key_length;
  81         __u8    data[];
  82         /*
  83          * return this struct with the keys appended at the end:
  84          * __u8 session_key[session_key_length];
  85          * __u8 server_in_key[server_in_key_length];
  86          * __u8 server_out_key[server_out_key_length];
  87          */
  88 } __packed;
  89
  90 struct smb3_notify {
  91         __u32   completion_filter;
  92         bool    watch_tree;
  93 } __packed;
  94
  95 #define CIFS_IOCTL_MAGIC        0xCF
  96 #define CIFS_IOC_COPYCHUNK_FILE _IOW(CIFS_IOCTL_MAGIC, 3, int)
  97 #define CIFS_IOC_SET_INTEGRITY  _IO(CIFS_IOCTL_MAGIC, 4)
  98 #define CIFS_IOC_GET_MNT_INFO _IOR(CIFS_IOCTL_MAGIC, 5, struct smb_mnt_fs_info)
  99 #define CIFS_ENUMERATE_SNAPSHOTS _IOR(CIFS_IOCTL_MAGIC, 6, struct smb_snapshot_array)
 100 #define CIFS_QUERY_INFO _IOWR(CIFS_IOCTL_MAGIC, 7, struct smb_query_info)
 101 #define CIFS_DUMP_KEY _IOWR(CIFS_IOCTL_MAGIC, 8, struct smb3_key_debug_info)
 102 #define CIFS_IOC_NOTIFY _IOW(CIFS_IOCTL_MAGIC, 9, struct smb3_notify)
 103 #define CIFS_DUMP_FULL_KEY _IOWR(CIFS_IOCTL_MAGIC, 10, struct smb3_full_key_debug_info)
 104 #define CIFS_IOC_SHUTDOWN _IOR ('X', 125, __u32)
 105
 106 /*
 107  * Flags for going down operation
 108  */
 109 #define CIFS_GOING_FLAGS_DEFAULT                0x0     /* going down */
 110 #define CIFS_GOING_FLAGS_LOGFLUSH               0x1     /* flush log but not data */
 111 #define CIFS_GOING_FLAGS_NOLOGFLUSH             0x2     /* don't flush log nor data */
 112
 113 static inline bool cifs_forced_shutdown(struct cifs_sb_info *sbi)
 114 {
 115         if (CIFS_MOUNT_SHUTDOWN & sbi->mnt_cifs_flags)
 116                 return true;
 117         else
 118                 return false;
 119 }