1 /* 2 * fs/cifs/smb2proto.h 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 * This library is free software; you can redistribute it and/or modify 10 * it under the terms of the GNU Lesser General Public License as published 11 * by the Free Software Foundation; either version 2.1 of the License, or 12 * (at your option) any later version. 13 * 14 * This library is distributed in the hope that it will be useful, 15 * but WITHOUT ANY WARRANTY; without even the implied warranty of 16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See 17 * the GNU Lesser General Public License for more details. 18 * 19 * You should have received a copy of the GNU Lesser General Public License 20 * along with this library; if not, write to the Free Software 21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 22 */ 23 #ifndef _SMB2PROTO_H 24 #define _SMB2PROTO_H 25 #include <linux/nls.h> 26 #include <linux/key-type.h> 27 28 struct statfs; 29 struct smb_rqst; 30 31 /* 32 ***************************************************************** 33 * All Prototypes 34 ***************************************************************** 35 */ 36 extern int map_smb2_to_linux_error(char *buf, bool log_err); 37 extern int smb2_check_message(char *buf, unsigned int length, 38 struct TCP_Server_Info *server); 39 extern unsigned int smb2_calc_size(void *buf, struct TCP_Server_Info *server); 40 extern char *smb2_get_data_area_len(int *off, int *len, 41 struct smb2_sync_hdr *shdr); 42 extern __le16 *cifs_convert_path_to_utf16(const char *from, 43 struct cifs_sb_info *cifs_sb); 44 45 extern int smb2_verify_signature(struct smb_rqst *, struct TCP_Server_Info *); 46 extern int smb2_check_receive(struct mid_q_entry *mid, 47 struct TCP_Server_Info *server, bool log_error); 48 extern struct mid_q_entry *smb2_setup_request(struct cifs_ses *ses, 49 struct smb_rqst *rqst); 50 extern struct mid_q_entry *smb2_setup_async_request( 51 struct TCP_Server_Info *server, struct smb_rqst *rqst); 52 extern struct cifs_ses *smb2_find_smb_ses(struct TCP_Server_Info *server, 53 __u64 ses_id); 54 extern struct cifs_tcon *smb2_find_smb_tcon(struct TCP_Server_Info *server, 55 __u64 ses_id, __u32 tid); 56 extern int smb2_calc_signature(struct smb_rqst *rqst, 57 struct TCP_Server_Info *server); 58 extern int smb3_calc_signature(struct smb_rqst *rqst, 59 struct TCP_Server_Info *server); 60 extern void smb2_echo_request(struct work_struct *work); 61 extern __le32 smb2_get_lease_state(struct cifsInodeInfo *cinode); 62 extern bool smb2_is_valid_oplock_break(char *buffer, 63 struct TCP_Server_Info *srv); 64 extern struct cifs_ses *smb2_find_smb_ses(struct TCP_Server_Info *server, 65 __u64 ses_id); 66 extern int smb3_handle_read_data(struct TCP_Server_Info *server, 67 struct mid_q_entry *mid); 68 69 extern int open_shroot(unsigned int xid, struct cifs_tcon *tcon, 70 struct cifs_sb_info *cifs_sb, struct cifs_fid *pfid); 71 extern void close_shroot(struct cached_fid *cfid); 72 extern void move_smb2_info_to_cifs(FILE_ALL_INFO *dst, 73 struct smb2_file_all_info *src); 74 extern int smb2_query_path_info(const unsigned int xid, struct cifs_tcon *tcon, 75 struct cifs_sb_info *cifs_sb, 76 const char *full_path, FILE_ALL_INFO *data, 77 bool *adjust_tz, bool *symlink); 78 extern int smb2_set_path_size(const unsigned int xid, struct cifs_tcon *tcon, 79 const char *full_path, __u64 size, 80 struct cifs_sb_info *cifs_sb, bool set_alloc); 81 extern int smb2_set_file_info(struct inode *inode, const char *full_path, 82 FILE_BASIC_INFO *buf, const unsigned int xid); 83 extern int smb311_posix_mkdir(const unsigned int xid, struct inode *inode, 84 umode_t mode, struct cifs_tcon *tcon, 85 const char *full_path, 86 struct cifs_sb_info *cifs_sb); 87 extern int smb2_mkdir(const unsigned int xid, struct inode *inode, 88 umode_t mode, struct cifs_tcon *tcon, 89 const char *name, struct cifs_sb_info *cifs_sb); 90 extern void smb2_mkdir_setinfo(struct inode *inode, const char *full_path, 91 struct cifs_sb_info *cifs_sb, 92 struct cifs_tcon *tcon, const unsigned int xid); 93 extern int smb2_rmdir(const unsigned int xid, struct cifs_tcon *tcon, 94 const char *name, struct cifs_sb_info *cifs_sb); 95 extern int smb2_unlink(const unsigned int xid, struct cifs_tcon *tcon, 96 const char *name, struct cifs_sb_info *cifs_sb); 97 extern int smb2_rename_path(const unsigned int xid, struct cifs_tcon *tcon, 98 const char *from_name, const char *to_name, 99 struct cifs_sb_info *cifs_sb); 100 extern int smb2_create_hardlink(const unsigned int xid, struct cifs_tcon *tcon, 101 const char *from_name, const char *to_name, 102 struct cifs_sb_info *cifs_sb); 103 extern int smb3_create_mf_symlink(unsigned int xid, struct cifs_tcon *tcon, 104 struct cifs_sb_info *cifs_sb, const unsigned char *path, 105 char *pbuf, unsigned int *pbytes_written); 106 extern int smb3_query_mf_symlink(unsigned int xid, struct cifs_tcon *tcon, 107 struct cifs_sb_info *cifs_sb, 108 const unsigned char *path, char *pbuf, 109 unsigned int *pbytes_read); 110 extern int smb2_open_file(const unsigned int xid, 111 struct cifs_open_parms *oparms, 112 __u32 *oplock, FILE_ALL_INFO *buf); 113 extern int smb2_unlock_range(struct cifsFileInfo *cfile, 114 struct file_lock *flock, const unsigned int xid); 115 extern int smb2_push_mandatory_locks(struct cifsFileInfo *cfile); 116 extern void smb2_reconnect_server(struct work_struct *work); 117 extern int smb3_crypto_aead_allocate(struct TCP_Server_Info *server); 118 extern unsigned long smb_rqst_len(struct TCP_Server_Info *server, 119 struct smb_rqst *rqst); 120 extern void smb2_set_next_command(struct cifs_tcon *tcon, 121 struct smb_rqst *rqst); 122 extern void smb2_set_related(struct smb_rqst *rqst); 123 124 /* 125 * SMB2 Worker functions - most of protocol specific implementation details 126 * are contained within these calls. 127 */ 128 extern int SMB2_negotiate(const unsigned int xid, struct cifs_ses *ses); 129 extern int SMB2_sess_setup(const unsigned int xid, struct cifs_ses *ses, 130 const struct nls_table *nls_cp); 131 extern int SMB2_logoff(const unsigned int xid, struct cifs_ses *ses); 132 extern int SMB2_tcon(const unsigned int xid, struct cifs_ses *ses, 133 const char *tree, struct cifs_tcon *tcon, 134 const struct nls_table *); 135 extern int SMB2_tdis(const unsigned int xid, struct cifs_tcon *tcon); 136 extern int SMB2_open(const unsigned int xid, struct cifs_open_parms *oparms, 137 __le16 *path, __u8 *oplock, 138 struct smb2_file_all_info *buf, 139 struct kvec *err_iov, int *resp_buftype); 140 extern int SMB2_open_init(struct cifs_tcon *tcon, struct smb_rqst *rqst, 141 __u8 *oplock, struct cifs_open_parms *oparms, 142 __le16 *path); 143 extern void SMB2_open_free(struct smb_rqst *rqst); 144 extern int SMB2_ioctl(const unsigned int xid, struct cifs_tcon *tcon, 145 u64 persistent_fid, u64 volatile_fid, u32 opcode, 146 bool is_fsctl, char *in_data, u32 indatalen, u32 maxoutlen, 147 char **out_data, u32 *plen /* returned data len */); 148 extern int SMB2_ioctl_init(struct cifs_tcon *tcon, struct smb_rqst *rqst, 149 u64 persistent_fid, u64 volatile_fid, u32 opcode, 150 bool is_fsctl, char *in_data, u32 indatalen, 151 __u32 max_response_size); 152 extern void SMB2_ioctl_free(struct smb_rqst *rqst); 153 extern int SMB2_change_notify(const unsigned int xid, struct cifs_tcon *tcon, 154 u64 persistent_fid, u64 volatile_fid, bool watch_tree, 155 u32 completion_filter); 156 157 extern int SMB2_close(const unsigned int xid, struct cifs_tcon *tcon, 158 u64 persistent_file_id, u64 volatile_file_id); 159 extern int SMB2_close_init(struct cifs_tcon *tcon, struct smb_rqst *rqst, 160 u64 persistent_file_id, u64 volatile_file_id); 161 extern void SMB2_close_free(struct smb_rqst *rqst); 162 extern int SMB2_flush(const unsigned int xid, struct cifs_tcon *tcon, 163 u64 persistent_file_id, u64 volatile_file_id); 164 extern int SMB2_flush_init(const unsigned int xid, struct smb_rqst *rqst, 165 struct cifs_tcon *tcon, 166 u64 persistent_file_id, u64 volatile_file_id); 167 extern void SMB2_flush_free(struct smb_rqst *rqst); 168 extern int SMB2_query_info(const unsigned int xid, struct cifs_tcon *tcon, 169 u64 persistent_file_id, u64 volatile_file_id, 170 struct smb2_file_all_info *data); 171 extern int SMB2_query_info_init(struct cifs_tcon *tcon, struct smb_rqst *rqst, 172 u64 persistent_fid, u64 volatile_fid, 173 u8 info_class, u8 info_type, 174 u32 additional_info, size_t output_len, 175 size_t input_len, void *input); 176 extern void SMB2_query_info_free(struct smb_rqst *rqst); 177 extern int SMB2_query_acl(const unsigned int xid, struct cifs_tcon *tcon, 178 u64 persistent_file_id, u64 volatile_file_id, 179 void **data, unsigned int *plen); 180 extern int SMB2_get_srv_num(const unsigned int xid, struct cifs_tcon *tcon, 181 u64 persistent_fid, u64 volatile_fid, 182 __le64 *uniqueid); 183 extern int smb2_async_readv(struct cifs_readdata *rdata); 184 extern int SMB2_read(const unsigned int xid, struct cifs_io_parms *io_parms, 185 unsigned int *nbytes, char **buf, int *buf_type); 186 extern int smb2_async_writev(struct cifs_writedata *wdata, 187 void (*release)(struct kref *kref)); 188 extern int SMB2_write(const unsigned int xid, struct cifs_io_parms *io_parms, 189 unsigned int *nbytes, struct kvec *iov, int n_vec); 190 extern int SMB2_echo(struct TCP_Server_Info *server); 191 extern int SMB2_query_directory(const unsigned int xid, struct cifs_tcon *tcon, 192 u64 persistent_fid, u64 volatile_fid, int index, 193 struct cifs_search_info *srch_inf); 194 extern int SMB2_set_eof(const unsigned int xid, struct cifs_tcon *tcon, 195 u64 persistent_fid, u64 volatile_fid, u32 pid, 196 __le64 *eof); 197 extern int SMB2_set_info_init(struct cifs_tcon *tcon, struct smb_rqst *rqst, 198 u64 persistent_fid, u64 volatile_fid, u32 pid, 199 u8 info_class, u8 info_type, u32 additional_info, 200 void **data, unsigned int *size); 201 extern void SMB2_set_info_free(struct smb_rqst *rqst); 202 extern int SMB2_set_acl(const unsigned int xid, struct cifs_tcon *tcon, 203 u64 persistent_fid, u64 volatile_fid, 204 struct cifs_ntsd *pnntsd, int pacllen, int aclflag); 205 extern int SMB2_set_ea(const unsigned int xid, struct cifs_tcon *tcon, 206 u64 persistent_fid, u64 volatile_fid, 207 struct smb2_file_full_ea_info *buf, int len); 208 extern int SMB2_set_compression(const unsigned int xid, struct cifs_tcon *tcon, 209 u64 persistent_fid, u64 volatile_fid); 210 extern int SMB2_oplock_break(const unsigned int xid, struct cifs_tcon *tcon, 211 const u64 persistent_fid, const u64 volatile_fid, 212 const __u8 oplock_level); 213 extern int smb2_handle_cancelled_close(struct cifs_tcon *tcon, 214 __u64 persistent_fid, 215 __u64 volatile_fid); 216 extern int smb2_handle_cancelled_mid(char *buffer, 217 struct TCP_Server_Info *server); 218 void smb2_cancelled_close_fid(struct work_struct *work); 219 extern int SMB2_QFS_info(const unsigned int xid, struct cifs_tcon *tcon, 220 u64 persistent_file_id, u64 volatile_file_id, 221 struct kstatfs *FSData); 222 extern int SMB311_posix_qfs_info(const unsigned int xid, struct cifs_tcon *tcon, 223 u64 persistent_file_id, u64 volatile_file_id, 224 struct kstatfs *FSData); 225 extern int SMB2_QFS_attr(const unsigned int xid, struct cifs_tcon *tcon, 226 u64 persistent_file_id, u64 volatile_file_id, int lvl); 227 extern int SMB2_lock(const unsigned int xid, struct cifs_tcon *tcon, 228 const __u64 persist_fid, const __u64 volatile_fid, 229 const __u32 pid, const __u64 length, const __u64 offset, 230 const __u32 lockFlags, const bool wait); 231 extern int smb2_lockv(const unsigned int xid, struct cifs_tcon *tcon, 232 const __u64 persist_fid, const __u64 volatile_fid, 233 const __u32 pid, const __u32 num_lock, 234 struct smb2_lock_element *buf); 235 extern int SMB2_lease_break(const unsigned int xid, struct cifs_tcon *tcon, 236 __u8 *lease_key, const __le32 lease_state); 237 extern int smb3_validate_negotiate(const unsigned int, struct cifs_tcon *); 238 239 extern enum securityEnum smb2_select_sectype(struct TCP_Server_Info *, 240 enum securityEnum); 241 extern void smb2_parse_contexts(struct TCP_Server_Info *server, 242 struct smb2_create_rsp *rsp, 243 unsigned int *epoch, char *lease_key, 244 __u8 *oplock, struct smb2_file_all_info *buf); 245 extern int smb3_encryption_required(const struct cifs_tcon *tcon); 246 extern int smb2_validate_iov(unsigned int offset, unsigned int buffer_length, 247 struct kvec *iov, unsigned int min_buf_size); 248 extern int smb2_validate_and_copy_iov(unsigned int offset, 249 unsigned int buffer_length, 250 struct kvec *iov, 251 unsigned int minbufsize, char *data); 252 extern void smb2_copy_fs_info_to_kstatfs( 253 struct smb2_fs_full_size_info *pfs_inf, 254 struct kstatfs *kst); 255 extern int smb311_crypto_shash_allocate(struct TCP_Server_Info *server); 256 extern int smb311_update_preauth_hash(struct cifs_ses *ses, 257 struct kvec *iov, int nvec); 258 extern int smb2_query_info_compound(const unsigned int xid, 259 struct cifs_tcon *tcon, 260 __le16 *utf16_path, u32 desired_access, 261 u32 class, u32 type, u32 output_len, 262 struct kvec *rsp, int *buftype, 263 struct cifs_sb_info *cifs_sb); 264 #endif /* _SMB2PROTO_H */ 265