cifs_ioctl.h

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