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, struct TCP_Server_Info *server); 27 extern char *smb2_get_data_area_len(int *off, int *len, 28 struct smb2_sync_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 57 extern int open_cached_dir(unsigned int xid, struct cifs_tcon *tcon, 58 const char *path, 59 struct cifs_sb_info *cifs_sb, 60 struct cached_fid **cfid); 61 extern int open_cached_dir_by_dentry(struct cifs_tcon *tcon, 62 struct dentry *dentry, 63 struct cached_fid **cfid); 64 extern void close_cached_dir(struct cached_fid *cfid); 65 extern void close_cached_dir_lease(struct cached_fid *cfid); 66 extern void close_cached_dir_lease_locked(struct cached_fid *cfid); 67 extern void move_smb2_info_to_cifs(FILE_ALL_INFO *dst, 68 struct smb2_file_all_info *src); 69 extern int smb2_query_reparse_tag(const unsigned int xid, struct cifs_tcon *tcon, 70 struct cifs_sb_info *cifs_sb, const char *path, 71 __u32 *reparse_tag); 72 extern int smb2_query_path_info(const unsigned int xid, struct cifs_tcon *tcon, 73 struct cifs_sb_info *cifs_sb, 74 const char *full_path, FILE_ALL_INFO *data, 75 bool *adjust_tz, bool *symlink); 76 extern int smb2_set_path_size(const unsigned int xid, struct cifs_tcon *tcon, 77 const char *full_path, __u64 size, 78 struct cifs_sb_info *cifs_sb, bool set_alloc); 79 extern int smb2_set_file_info(struct inode *inode, const char *full_path, 80 FILE_BASIC_INFO *buf, const unsigned int xid); 81 extern int smb311_posix_mkdir(const unsigned int xid, struct inode *inode, 82 umode_t mode, struct cifs_tcon *tcon, 83 const char *full_path, 84 struct cifs_sb_info *cifs_sb); 85 extern int smb2_mkdir(const unsigned int xid, struct inode *inode, 86 umode_t mode, struct cifs_tcon *tcon, 87 const char *name, struct cifs_sb_info *cifs_sb); 88 extern void smb2_mkdir_setinfo(struct inode *inode, const char *full_path, 89 struct cifs_sb_info *cifs_sb, 90 struct cifs_tcon *tcon, const unsigned int xid); 91 extern int smb2_rmdir(const unsigned int xid, struct cifs_tcon *tcon, 92 const char *name, struct cifs_sb_info *cifs_sb); 93 extern int smb2_unlink(const unsigned int xid, struct cifs_tcon *tcon, 94 const char *name, struct cifs_sb_info *cifs_sb); 95 extern int smb2_rename_path(const unsigned int xid, struct cifs_tcon *tcon, 96 const char *from_name, const char *to_name, 97 struct cifs_sb_info *cifs_sb); 98 extern int smb2_create_hardlink(const unsigned int xid, struct cifs_tcon *tcon, 99 const char *from_name, const char *to_name, 100 struct cifs_sb_info *cifs_sb); 101 extern int smb3_create_mf_symlink(unsigned int xid, struct cifs_tcon *tcon, 102 struct cifs_sb_info *cifs_sb, const unsigned char *path, 103 char *pbuf, unsigned int *pbytes_written); 104 extern int smb3_query_mf_symlink(unsigned int xid, struct cifs_tcon *tcon, 105 struct cifs_sb_info *cifs_sb, 106 const unsigned char *path, char *pbuf, 107 unsigned int *pbytes_read); 108 extern int smb2_open_file(const unsigned int xid, 109 struct cifs_open_parms *oparms, 110 __u32 *oplock, FILE_ALL_INFO *buf); 111 extern int smb2_unlock_range(struct cifsFileInfo *cfile, 112 struct file_lock *flock, const unsigned int xid); 113 extern int smb2_push_mandatory_locks(struct cifsFileInfo *cfile); 114 extern void smb2_reconnect_server(struct work_struct *work); 115 extern int smb3_crypto_aead_allocate(struct TCP_Server_Info *server); 116 extern unsigned long smb_rqst_len(struct TCP_Server_Info *server, 117 struct smb_rqst *rqst); 118 extern void smb2_set_next_command(struct cifs_tcon *tcon, 119 struct smb_rqst *rqst); 120 extern void smb2_set_related(struct smb_rqst *rqst); 121 122 /* 123 * SMB2 Worker functions - most of protocol specific implementation details 124 * are contained within these calls. 125 */ 126 extern int SMB2_negotiate(const unsigned int xid, struct cifs_ses *ses); 127 extern int SMB2_sess_setup(const unsigned int xid, struct cifs_ses *ses, 128 const struct nls_table *nls_cp); 129 extern int SMB2_logoff(const unsigned int xid, struct cifs_ses *ses); 130 extern int SMB2_tcon(const unsigned int xid, struct cifs_ses *ses, 131 const char *tree, struct cifs_tcon *tcon, 132 const struct nls_table *); 133 extern int SMB2_tdis(const unsigned int xid, struct cifs_tcon *tcon); 134 extern int SMB2_open(const unsigned int xid, struct cifs_open_parms *oparms, 135 __le16 *path, __u8 *oplock, 136 struct smb2_file_all_info *buf, 137 struct create_posix_rsp *posix, 138 struct kvec *err_iov, int *resp_buftype); 139 extern int SMB2_open_init(struct cifs_tcon *tcon, 140 struct TCP_Server_Info *server, 141 struct smb_rqst *rqst, 142 __u8 *oplock, struct cifs_open_parms *oparms, 143 __le16 *path); 144 extern void SMB2_open_free(struct smb_rqst *rqst); 145 extern int SMB2_ioctl(const unsigned int xid, struct cifs_tcon *tcon, 146 u64 persistent_fid, u64 volatile_fid, u32 opcode, 147 bool is_fsctl, char *in_data, u32 indatalen, u32 maxoutlen, 148 char **out_data, u32 *plen /* returned data len */); 149 extern int SMB2_ioctl_init(struct cifs_tcon *tcon, 150 struct TCP_Server_Info *server, 151 struct smb_rqst *rqst, 152 u64 persistent_fid, u64 volatile_fid, u32 opcode, 153 bool is_fsctl, char *in_data, u32 indatalen, 154 __u32 max_response_size); 155 extern void SMB2_ioctl_free(struct smb_rqst *rqst); 156 extern int SMB2_change_notify(const unsigned int xid, struct cifs_tcon *tcon, 157 u64 persistent_fid, u64 volatile_fid, bool watch_tree, 158 u32 completion_filter); 159 160 extern int __SMB2_close(const unsigned int xid, struct cifs_tcon *tcon, 161 u64 persistent_fid, u64 volatile_fid, 162 struct smb2_file_network_open_info *pbuf); 163 extern int SMB2_close(const unsigned int xid, struct cifs_tcon *tcon, 164 u64 persistent_file_id, u64 volatile_file_id); 165 extern int SMB2_close_init(struct cifs_tcon *tcon, 166 struct TCP_Server_Info *server, 167 struct smb_rqst *rqst, 168 u64 persistent_fid, u64 volatile_fid, 169 bool query_attrs); 170 extern void SMB2_close_free(struct smb_rqst *rqst); 171 extern int SMB2_flush(const unsigned int xid, struct cifs_tcon *tcon, 172 u64 persistent_file_id, u64 volatile_file_id); 173 extern int SMB2_flush_init(const unsigned int xid, struct smb_rqst *rqst, 174 struct cifs_tcon *tcon, 175 struct TCP_Server_Info *server, 176 u64 persistent_file_id, u64 volatile_file_id); 177 extern void SMB2_flush_free(struct smb_rqst *rqst); 178 extern int SMB311_posix_query_info(const unsigned int xid, struct cifs_tcon *tcon, 179 u64 persistent_fid, u64 volatile_fid, struct smb311_posix_qinfo *data, u32 *plen); 180 extern int SMB2_query_info(const unsigned int xid, struct cifs_tcon *tcon, 181 u64 persistent_file_id, u64 volatile_file_id, 182 struct smb2_file_all_info *data); 183 extern int SMB2_query_info_init(struct cifs_tcon *tcon, 184 struct TCP_Server_Info *server, 185 struct smb_rqst *rqst, 186 u64 persistent_fid, u64 volatile_fid, 187 u8 info_class, u8 info_type, 188 u32 additional_info, size_t output_len, 189 size_t input_len, void *input); 190 extern void SMB2_query_info_free(struct smb_rqst *rqst); 191 extern int SMB2_query_acl(const unsigned int xid, struct cifs_tcon *tcon, 192 u64 persistent_file_id, u64 volatile_file_id, 193 void **data, unsigned int *plen, u32 info); 194 extern int SMB2_get_srv_num(const unsigned int xid, struct cifs_tcon *tcon, 195 u64 persistent_fid, u64 volatile_fid, 196 __le64 *uniqueid); 197 extern int smb2_async_readv(struct cifs_readdata *rdata); 198 extern int SMB2_read(const unsigned int xid, struct cifs_io_parms *io_parms, 199 unsigned int *nbytes, char **buf, int *buf_type); 200 extern int smb2_async_writev(struct cifs_writedata *wdata, 201 void (*release)(struct kref *kref)); 202 extern int SMB2_write(const unsigned int xid, struct cifs_io_parms *io_parms, 203 unsigned int *nbytes, struct kvec *iov, int n_vec); 204 extern int SMB2_echo(struct TCP_Server_Info *server); 205 extern int SMB2_query_directory(const unsigned int xid, struct cifs_tcon *tcon, 206 u64 persistent_fid, u64 volatile_fid, int index, 207 struct cifs_search_info *srch_inf); 208 extern int SMB2_query_directory_init(unsigned int xid, struct cifs_tcon *tcon, 209 struct TCP_Server_Info *server, 210 struct smb_rqst *rqst, 211 u64 persistent_fid, u64 volatile_fid, 212 int index, int info_level); 213 extern void SMB2_query_directory_free(struct smb_rqst *rqst); 214 extern int SMB2_set_eof(const unsigned int xid, struct cifs_tcon *tcon, 215 u64 persistent_fid, u64 volatile_fid, u32 pid, 216 __le64 *eof); 217 extern int SMB2_set_info_init(struct cifs_tcon *tcon, 218 struct TCP_Server_Info *server, 219 struct smb_rqst *rqst, 220 u64 persistent_fid, u64 volatile_fid, u32 pid, 221 u8 info_class, u8 info_type, u32 additional_info, 222 void **data, unsigned int *size); 223 extern void SMB2_set_info_free(struct smb_rqst *rqst); 224 extern int SMB2_set_acl(const unsigned int xid, struct cifs_tcon *tcon, 225 u64 persistent_fid, u64 volatile_fid, 226 struct cifs_ntsd *pnntsd, int pacllen, int aclflag); 227 extern int SMB2_set_ea(const unsigned int xid, struct cifs_tcon *tcon, 228 u64 persistent_fid, u64 volatile_fid, 229 struct smb2_file_full_ea_info *buf, int len); 230 extern int SMB2_set_compression(const unsigned int xid, struct cifs_tcon *tcon, 231 u64 persistent_fid, u64 volatile_fid); 232 extern int SMB2_oplock_break(const unsigned int xid, struct cifs_tcon *tcon, 233 const u64 persistent_fid, const u64 volatile_fid, 234 const __u8 oplock_level); 235 extern int smb2_handle_cancelled_close(struct cifs_tcon *tcon, 236 __u64 persistent_fid, 237 __u64 volatile_fid); 238 extern int smb2_handle_cancelled_mid(struct mid_q_entry *mid, struct TCP_Server_Info *server); 239 void smb2_cancelled_close_fid(struct work_struct *work); 240 extern int SMB2_QFS_info(const unsigned int xid, struct cifs_tcon *tcon, 241 u64 persistent_file_id, u64 volatile_file_id, 242 struct kstatfs *FSData); 243 extern int SMB311_posix_qfs_info(const unsigned int xid, struct cifs_tcon *tcon, 244 u64 persistent_file_id, u64 volatile_file_id, 245 struct kstatfs *FSData); 246 extern int SMB2_QFS_attr(const unsigned int xid, struct cifs_tcon *tcon, 247 u64 persistent_file_id, u64 volatile_file_id, int lvl); 248 extern int SMB2_lock(const unsigned int xid, struct cifs_tcon *tcon, 249 const __u64 persist_fid, const __u64 volatile_fid, 250 const __u32 pid, const __u64 length, const __u64 offset, 251 const __u32 lockFlags, const bool wait); 252 extern int smb2_lockv(const unsigned int xid, struct cifs_tcon *tcon, 253 const __u64 persist_fid, const __u64 volatile_fid, 254 const __u32 pid, const __u32 num_lock, 255 struct smb2_lock_element *buf); 256 extern int SMB2_lease_break(const unsigned int xid, struct cifs_tcon *tcon, 257 __u8 *lease_key, const __le32 lease_state); 258 extern int smb3_validate_negotiate(const unsigned int, struct cifs_tcon *); 259 260 extern enum securityEnum smb2_select_sectype(struct TCP_Server_Info *, 261 enum securityEnum); 262 extern void smb2_parse_contexts(struct TCP_Server_Info *server, 263 struct smb2_create_rsp *rsp, 264 unsigned int *epoch, char *lease_key, 265 __u8 *oplock, struct smb2_file_all_info *buf, 266 struct create_posix_rsp *posix); 267 extern int smb3_encryption_required(const struct cifs_tcon *tcon); 268 extern int smb2_validate_iov(unsigned int offset, unsigned int buffer_length, 269 struct kvec *iov, unsigned int min_buf_size); 270 extern int smb2_validate_and_copy_iov(unsigned int offset, 271 unsigned int buffer_length, 272 struct kvec *iov, 273 unsigned int minbufsize, char *data); 274 extern void smb2_copy_fs_info_to_kstatfs( 275 struct smb2_fs_full_size_info *pfs_inf, 276 struct kstatfs *kst); 277 extern int smb311_crypto_shash_allocate(struct TCP_Server_Info *server); 278 extern int smb311_update_preauth_hash(struct cifs_ses *ses, 279 struct kvec *iov, int nvec); 280 extern int smb2_query_info_compound(const unsigned int xid, 281 struct cifs_tcon *tcon, 282 __le16 *utf16_path, u32 desired_access, 283 u32 class, u32 type, u32 output_len, 284 struct kvec *rsp, int *buftype, 285 struct cifs_sb_info *cifs_sb); 286 /* query path info from the server using SMB311 POSIX extensions*/ 287 extern int smb311_posix_query_path_info(const unsigned int xid, struct cifs_tcon *tcon, 288 struct cifs_sb_info *sb, const char *path, struct smb311_posix_qinfo *qinf, 289 bool *adjust_tx, bool *symlink); 290 int posix_info_parse(const void *beg, const void *end, 291 struct smb2_posix_info_parsed *out); 292 int posix_info_sid_size(const void *beg, const void *end); 293 #endif /* _SMB2PROTO_H */ 294