cifs_ioctl.h 3.7 KB

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