fs/cifs/cifs_ioctl.h

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