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