1 /* SPDX-License-Identifier: LGPL-2.1 */ 2 /* 3 * 4 * Copyright (c) International Business Machines Corp., 2002, 2011 5 * Etersoft, 2012 6 * Author(s): Steve French (sfrench@us.ibm.com) 7 * Pavel Shilovsky (pshilovsky@samba.org) 2012 8 * 9 */ 10 #ifndef _SMB2PROTO_H 11 #define _SMB2PROTO_H 12 #include <linux/nls.h> 13 #include <linux/key-type.h> 14 15 struct statfs; 16 struct smb_rqst; 17 18 /* 19 ***************************************************************** 20 * All Prototypes 21 ***************************************************************** 22 */ 23 extern int map_smb2_to_linux_error(char *buf, bool log_err); 24 extern int smb2_check_message(char *buf, unsigned int length, 25 struct TCP_Server_Info *server); 26 extern unsigned int smb2_calc_size(void *buf); 27 extern char *smb2_get_data_area_len(int *off, int *len, 28 struct smb2_hdr *shdr); 29 extern __le16 *cifs_convert_path_to_utf16(const char *from, 30 struct cifs_sb_info *cifs_sb); 31 32 extern int smb2_verify_signature(struct smb_rqst *, struct TCP_Server_Info *); 33 extern int smb2_check_receive(struct mid_q_entry *mid, 34 struct TCP_Server_Info *server, bool log_error); 35 extern struct mid_q_entry *smb2_setup_request(struct cifs_ses *ses, 36 struct TCP_Server_Info *, 37 struct smb_rqst *rqst); 38 extern struct mid_q_entry *smb2_setup_async_request( 39 struct TCP_Server_Info *server, struct smb_rqst *rqst); 40 extern struct cifs_ses *smb2_find_smb_ses(struct TCP_Server_Info *server, 41 __u64 ses_id); 42 extern struct cifs_tcon *smb2_find_smb_tcon(struct TCP_Server_Info *server, 43 __u64 ses_id, __u32 tid); 44 extern int smb2_calc_signature(struct smb_rqst *rqst, 45 struct TCP_Server_Info *server, 46 bool allocate_crypto); 47 extern int smb3_calc_signature(struct smb_rqst *rqst, 48 struct TCP_Server_Info *server, 49 bool allocate_crypto); 50 extern void smb2_echo_request(struct work_struct *work); 51 extern __le32 smb2_get_lease_state(struct cifsInodeInfo *cinode); 52 extern bool smb2_is_valid_oplock_break(char *buffer, 53 struct TCP_Server_Info *srv); 54 extern int smb3_handle_read_data(struct TCP_Server_Info *server, 55 struct mid_q_entry *mid); 56 extern int smb2_query_reparse_tag(const unsigned int xid, struct cifs_tcon *tcon, 57 struct cifs_sb_info *cifs_sb, const char *path, 58 __u32 *reparse_tag); 59 int smb2_query_path_info(const unsigned int xid, 60 struct cifs_tcon *tcon, 61 struct cifs_sb_info *cifs_sb, 62 const char *full_path, 63 struct cifs_open_info_data *data); 64 extern int smb2_set_path_size(const unsigned int xid, struct cifs_tcon *tcon, 65 const char *full_path, __u64 size, 66 struct cifs_sb_info *cifs_sb, bool set_alloc); 67 extern int smb2_set_file_info(struct inode *inode, const char *full_path, 68 FILE_BASIC_INFO *buf, const unsigned int xid); 69 extern int smb311_posix_mkdir(const unsigned int xid, struct inode *inode, 70 umode_t mode, struct cifs_tcon *tcon, 71 const char *full_path, 72 struct cifs_sb_info *cifs_sb); 73 extern int smb2_mkdir(const unsigned int xid, struct inode *inode, 74 umode_t mode, struct cifs_tcon *tcon, 75 const char *name, struct cifs_sb_info *cifs_sb); 76 extern void smb2_mkdir_setinfo(struct inode *inode, const char *full_path, 77 struct cifs_sb_info *cifs_sb, 78 struct cifs_tcon *tcon, const unsigned int xid); 79 extern int smb2_rmdir(const unsigned int xid, struct cifs_tcon *tcon, 80 const char *name, struct cifs_sb_info *cifs_sb); 81 extern int smb2_unlink(const unsigned int xid, struct cifs_tcon *tcon, 82 const char *name, struct cifs_sb_info *cifs_sb); 83 int smb2_rename_path(const unsigned int xid, 84 struct cifs_tcon *tcon, 85 struct dentry *source_dentry, 86 const char *from_name, const char *to_name, 87 struct cifs_sb_info *cifs_sb); 88 int smb2_create_hardlink(const unsigned int xid, 89 struct cifs_tcon *tcon, 90 struct dentry *source_dentry, 91 const char *from_name, const char *to_name, 92 struct cifs_sb_info *cifs_sb); 93 extern int smb3_create_mf_symlink(unsigned int xid, struct cifs_tcon *tcon, 94 struct cifs_sb_info *cifs_sb, const unsigned char *path, 95 char *pbuf, unsigned int *pbytes_written); 96 extern int smb3_query_mf_symlink(unsigned int xid, struct cifs_tcon *tcon, 97 struct cifs_sb_info *cifs_sb, 98 const unsigned char *path, char *pbuf, 99 unsigned int *pbytes_read); 100 int smb2_parse_symlink_response(struct cifs_sb_info *cifs_sb, const struct kvec *iov, char **path); 101 int smb2_open_file(const unsigned int xid, struct cifs_open_parms *oparms, __u32 *oplock, 102 void *buf); 103 extern int smb2_unlock_range(struct cifsFileInfo *cfile, 104 struct file_lock *flock, const unsigned int xid); 105 extern int smb2_push_mandatory_locks(struct cifsFileInfo *cfile); 106 extern void smb2_reconnect_server(struct work_struct *work); 107 extern int smb3_crypto_aead_allocate(struct TCP_Server_Info *server); 108 extern unsigned long smb_rqst_len(struct TCP_Server_Info *server, 109 struct smb_rqst *rqst); 110 extern void smb2_set_next_command(struct cifs_tcon *tcon, 111 struct smb_rqst *rqst); 112 extern void smb2_set_related(struct smb_rqst *rqst); 113 114 /* 115 * SMB2 Worker functions - most of protocol specific implementation details 116 * are contained within these calls. 117 */ 118 extern int SMB2_negotiate(const unsigned int xid, 119 struct cifs_ses *ses, 120 struct TCP_Server_Info *server); 121 extern int SMB2_sess_setup(const unsigned int xid, struct cifs_ses *ses, 122 struct TCP_Server_Info *server, 123 const struct nls_table *nls_cp); 124 extern int SMB2_logoff(const unsigned int xid, struct cifs_ses *ses); 125 extern int SMB2_tcon(const unsigned int xid, struct cifs_ses *ses, 126 const char *tree, struct cifs_tcon *tcon, 127 const struct nls_table *); 128 extern int SMB2_tdis(const unsigned int xid, struct cifs_tcon *tcon); 129 extern int SMB2_open(const unsigned int xid, struct cifs_open_parms *oparms, 130 __le16 *path, __u8 *oplock, 131 struct smb2_file_all_info *buf, 132 struct create_posix_rsp *posix, 133 struct kvec *err_iov, int *resp_buftype); 134 extern int SMB2_open_init(struct cifs_tcon *tcon, 135 struct TCP_Server_Info *server, 136 struct smb_rqst *rqst, 137 __u8 *oplock, struct cifs_open_parms *oparms, 138 __le16 *path); 139 extern void SMB2_open_free(struct smb_rqst *rqst); 140 extern int SMB2_ioctl(const unsigned int xid, struct cifs_tcon *tcon, 141 u64 persistent_fid, u64 volatile_fid, u32 opcode, 142 char *in_data, u32 indatalen, u32 maxoutlen, 143 char **out_data, u32 *plen /* returned data len */); 144 extern int SMB2_ioctl_init(struct cifs_tcon *tcon, 145 struct TCP_Server_Info *server, 146 struct smb_rqst *rqst, 147 u64 persistent_fid, u64 volatile_fid, u32 opcode, 148 char *in_data, u32 indatalen, 149 __u32 max_response_size); 150 extern void SMB2_ioctl_free(struct smb_rqst *rqst); 151 extern int SMB2_change_notify(const unsigned int xid, struct cifs_tcon *tcon, 152 u64 persistent_fid, u64 volatile_fid, bool watch_tree, 153 u32 completion_filter, u32 max_out_data_len, 154 char **out_data, u32 *plen /* returned data len */); 155 156 extern int __SMB2_close(const unsigned int xid, struct cifs_tcon *tcon, 157 u64 persistent_fid, u64 volatile_fid, 158 struct smb2_file_network_open_info *pbuf); 159 extern int SMB2_close(const unsigned int xid, struct cifs_tcon *tcon, 160 u64 persistent_file_id, u64 volatile_file_id); 161 extern int SMB2_close_init(struct cifs_tcon *tcon, 162 struct TCP_Server_Info *server, 163 struct smb_rqst *rqst, 164 u64 persistent_fid, u64 volatile_fid, 165 bool query_attrs); 166 extern void SMB2_close_free(struct smb_rqst *rqst); 167 extern int SMB2_flush(const unsigned int xid, struct cifs_tcon *tcon, 168 u64 persistent_file_id, u64 volatile_file_id); 169 extern int SMB2_flush_init(const unsigned int xid, struct smb_rqst *rqst, 170 struct cifs_tcon *tcon, 171 struct TCP_Server_Info *server, 172 u64 persistent_file_id, u64 volatile_file_id); 173 extern void SMB2_flush_free(struct smb_rqst *rqst); 174 extern int SMB311_posix_query_info(const unsigned int xid, struct cifs_tcon *tcon, 175 u64 persistent_fid, u64 volatile_fid, struct smb311_posix_qinfo *data, u32 *plen); 176 extern int SMB2_query_info(const unsigned int xid, struct cifs_tcon *tcon, 177 u64 persistent_file_id, u64 volatile_file_id, 178 struct smb2_file_all_info *data); 179 extern int SMB2_query_info_init(struct cifs_tcon *tcon, 180 struct TCP_Server_Info *server, 181 struct smb_rqst *rqst, 182 u64 persistent_fid, u64 volatile_fid, 183 u8 info_class, u8 info_type, 184 u32 additional_info, size_t output_len, 185 size_t input_len, void *input); 186 extern void SMB2_query_info_free(struct smb_rqst *rqst); 187 extern int SMB2_query_acl(const unsigned int xid, struct cifs_tcon *tcon, 188 u64 persistent_file_id, u64 volatile_file_id, 189 void **data, unsigned int *plen, u32 info); 190 extern int SMB2_get_srv_num(const unsigned int xid, struct cifs_tcon *tcon, 191 u64 persistent_fid, u64 volatile_fid, 192 __le64 *uniqueid); 193 extern int smb2_async_readv(struct cifs_readdata *rdata); 194 extern int SMB2_read(const unsigned int xid, struct cifs_io_parms *io_parms, 195 unsigned int *nbytes, char **buf, int *buf_type); 196 extern int smb2_async_writev(struct cifs_writedata *wdata, 197 void (*release)(struct kref *kref)); 198 extern int SMB2_write(const unsigned int xid, struct cifs_io_parms *io_parms, 199 unsigned int *nbytes, struct kvec *iov, int n_vec); 200 extern int SMB2_echo(struct TCP_Server_Info *server); 201 extern int SMB2_query_directory(const unsigned int xid, struct cifs_tcon *tcon, 202 u64 persistent_fid, u64 volatile_fid, int index, 203 struct cifs_search_info *srch_inf); 204 extern int SMB2_query_directory_init(unsigned int xid, struct cifs_tcon *tcon, 205 struct TCP_Server_Info *server, 206 struct smb_rqst *rqst, 207 u64 persistent_fid, u64 volatile_fid, 208 int index, int info_level); 209 extern void SMB2_query_directory_free(struct smb_rqst *rqst); 210 extern int SMB2_set_eof(const unsigned int xid, struct cifs_tcon *tcon, 211 u64 persistent_fid, u64 volatile_fid, u32 pid, 212 __le64 *eof); 213 extern int SMB2_set_info_init(struct cifs_tcon *tcon, 214 struct TCP_Server_Info *server, 215 struct smb_rqst *rqst, 216 u64 persistent_fid, u64 volatile_fid, u32 pid, 217 u8 info_class, u8 info_type, u32 additional_info, 218 void **data, unsigned int *size); 219 extern void SMB2_set_info_free(struct smb_rqst *rqst); 220 extern int SMB2_set_acl(const unsigned int xid, struct cifs_tcon *tcon, 221 u64 persistent_fid, u64 volatile_fid, 222 struct cifs_ntsd *pnntsd, int pacllen, int aclflag); 223 extern int SMB2_set_ea(const unsigned int xid, struct cifs_tcon *tcon, 224 u64 persistent_fid, u64 volatile_fid, 225 struct smb2_file_full_ea_info *buf, int len); 226 extern int SMB2_set_compression(const unsigned int xid, struct cifs_tcon *tcon, 227 u64 persistent_fid, u64 volatile_fid); 228 extern int SMB2_oplock_break(const unsigned int xid, struct cifs_tcon *tcon, 229 const u64 persistent_fid, const u64 volatile_fid, 230 const __u8 oplock_level); 231 extern int smb2_handle_cancelled_close(struct cifs_tcon *tcon, 232 __u64 persistent_fid, 233 __u64 volatile_fid); 234 extern int smb2_handle_cancelled_mid(struct mid_q_entry *mid, struct TCP_Server_Info *server); 235 void smb2_cancelled_close_fid(struct work_struct *work); 236 extern int SMB2_QFS_info(const unsigned int xid, struct cifs_tcon *tcon, 237 u64 persistent_file_id, u64 volatile_file_id, 238 struct kstatfs *FSData); 239 extern int SMB311_posix_qfs_info(const unsigned int xid, struct cifs_tcon *tcon, 240 u64 persistent_file_id, u64 volatile_file_id, 241 struct kstatfs *FSData); 242 extern int SMB2_QFS_attr(const unsigned int xid, struct cifs_tcon *tcon, 243 u64 persistent_file_id, u64 volatile_file_id, int lvl); 244 extern int SMB2_lock(const unsigned int xid, struct cifs_tcon *tcon, 245 const __u64 persist_fid, const __u64 volatile_fid, 246 const __u32 pid, const __u64 length, const __u64 offset, 247 const __u32 lockFlags, const bool wait); 248 extern int smb2_lockv(const unsigned int xid, struct cifs_tcon *tcon, 249 const __u64 persist_fid, const __u64 volatile_fid, 250 const __u32 pid, const __u32 num_lock, 251 struct smb2_lock_element *buf); 252 extern int SMB2_lease_break(const unsigned int xid, struct cifs_tcon *tcon, 253 __u8 *lease_key, const __le32 lease_state); 254 extern int smb3_validate_negotiate(const unsigned int, struct cifs_tcon *); 255 256 extern enum securityEnum smb2_select_sectype(struct TCP_Server_Info *, 257 enum securityEnum); 258 int smb2_parse_contexts(struct TCP_Server_Info *server, 259 struct kvec *rsp_iov, 260 unsigned int *epoch, 261 char *lease_key, __u8 *oplock, 262 struct smb2_file_all_info *buf, 263 struct create_posix_rsp *posix); 264 265 extern int smb3_encryption_required(const struct cifs_tcon *tcon); 266 extern int smb2_validate_iov(unsigned int offset, unsigned int buffer_length, 267 struct kvec *iov, unsigned int min_buf_size); 268 extern int smb2_validate_and_copy_iov(unsigned int offset, 269 unsigned int buffer_length, 270 struct kvec *iov, 271 unsigned int minbufsize, char *data); 272 extern void smb2_copy_fs_info_to_kstatfs( 273 struct smb2_fs_full_size_info *pfs_inf, 274 struct kstatfs *kst); 275 extern int smb311_crypto_shash_allocate(struct TCP_Server_Info *server); 276 extern int smb311_update_preauth_hash(struct cifs_ses *ses, 277 struct TCP_Server_Info *server, 278 struct kvec *iov, int nvec); 279 extern int smb2_query_info_compound(const unsigned int xid, 280 struct cifs_tcon *tcon, 281 const char *path, u32 desired_access, 282 u32 class, u32 type, u32 output_len, 283 struct kvec *rsp, int *buftype, 284 struct cifs_sb_info *cifs_sb); 285 /* query path info from the server using SMB311 POSIX extensions*/ 286 int smb311_posix_query_path_info(const unsigned int xid, 287 struct cifs_tcon *tcon, 288 struct cifs_sb_info *cifs_sb, 289 const char *full_path, 290 struct cifs_open_info_data *data, 291 struct cifs_sid *owner, 292 struct cifs_sid *group); 293 int posix_info_parse(const void *beg, const void *end, 294 struct smb2_posix_info_parsed *out); 295 int posix_info_sid_size(const void *beg, const void *end); 296 #endif /* _SMB2PROTO_H */ 297