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