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