tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
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
15struct statfs;
16struct smb_rqst;
17
18/*
19 *****************************************************************
20 * All Prototypes
21 *****************************************************************
22 */
23extern int map_smb2_to_linux_error(char *buf, bool log_err);
24extern int smb2_check_message(char *buf, unsigned int length,
25 struct TCP_Server_Info *server);
26extern unsigned int smb2_calc_size(void *buf);
27extern char *smb2_get_data_area_len(int *off, int *len,
28 struct smb2_hdr *shdr);
29extern __le16 *cifs_convert_path_to_utf16(const char *from,
30 struct cifs_sb_info *cifs_sb);
31
32extern int smb2_verify_signature(struct smb_rqst *, struct TCP_Server_Info *);
33extern int smb2_check_receive(struct mid_q_entry *mid,
34 struct TCP_Server_Info *server, bool log_error);
35extern struct mid_q_entry *smb2_setup_request(struct cifs_ses *ses,
36 struct TCP_Server_Info *,
37 struct smb_rqst *rqst);
38extern struct mid_q_entry *smb2_setup_async_request(
39 struct TCP_Server_Info *server, struct smb_rqst *rqst);
40extern struct cifs_ses *smb2_find_smb_ses(struct TCP_Server_Info *server,
41 __u64 ses_id);
42extern struct cifs_tcon *smb2_find_smb_tcon(struct TCP_Server_Info *server,
43 __u64 ses_id, __u32 tid);
44extern int smb2_calc_signature(struct smb_rqst *rqst,
45 struct TCP_Server_Info *server,
46 bool allocate_crypto);
47extern int smb3_calc_signature(struct smb_rqst *rqst,
48 struct TCP_Server_Info *server,
49 bool allocate_crypto);
50extern void smb2_echo_request(struct work_struct *work);
51extern __le32 smb2_get_lease_state(struct cifsInodeInfo *cinode);
52extern bool smb2_is_valid_oplock_break(char *buffer,
53 struct TCP_Server_Info *srv);
54extern int smb3_handle_read_data(struct TCP_Server_Info *server,
55 struct mid_q_entry *mid);
56extern 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);
59struct inode *smb2_get_reparse_inode(struct cifs_open_info_data *data,
60 struct super_block *sb,
61 const unsigned int xid,
62 struct cifs_tcon *tcon,
63 const char *full_path,
64 struct kvec *reparse_iov,
65 struct kvec *xattr_iov);
66int smb2_query_reparse_point(const unsigned int xid,
67 struct cifs_tcon *tcon,
68 struct cifs_sb_info *cifs_sb,
69 const char *full_path,
70 u32 *tag, struct kvec *rsp,
71 int *rsp_buftype);
72int smb2_query_path_info(const unsigned int xid,
73 struct cifs_tcon *tcon,
74 struct cifs_sb_info *cifs_sb,
75 const char *full_path,
76 struct cifs_open_info_data *data);
77extern int smb2_set_path_size(const unsigned int xid, struct cifs_tcon *tcon,
78 const char *full_path, __u64 size,
79 struct cifs_sb_info *cifs_sb, bool set_alloc,
80 struct dentry *dentry);
81extern int smb2_set_file_info(struct inode *inode, const char *full_path,
82 FILE_BASIC_INFO *buf, const unsigned int xid);
83extern 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);
87extern 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);
90extern 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);
93extern int smb2_rmdir(const unsigned int xid, struct cifs_tcon *tcon,
94 const char *name, struct cifs_sb_info *cifs_sb);
95extern int smb2_unlink(const unsigned int xid, struct cifs_tcon *tcon,
96 const char *name, struct cifs_sb_info *cifs_sb,
97 struct dentry *dentry);
98int smb2_rename_path(const unsigned int xid,
99 struct cifs_tcon *tcon,
100 struct dentry *source_dentry,
101 const char *from_name, const char *to_name,
102 struct cifs_sb_info *cifs_sb);
103int smb2_create_hardlink(const unsigned int xid,
104 struct cifs_tcon *tcon,
105 struct dentry *source_dentry,
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);
115int smb2_parse_symlink_response(struct cifs_sb_info *cifs_sb, const struct kvec *iov, char **path);
116int smb2_open_file(const unsigned int xid, struct cifs_open_parms *oparms, __u32 *oplock,
117 void *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);
128extern void smb2_set_replay(struct TCP_Server_Info *server,
129 struct smb_rqst *rqst);
130extern bool smb2_should_replay(struct cifs_tcon *tcon,
131 int *pretries,
132 int *pcur_sleep);
133
134/*
135 * SMB2 Worker functions - most of protocol specific implementation details
136 * are contained within these calls.
137 */
138extern int SMB2_negotiate(const unsigned int xid,
139 struct cifs_ses *ses,
140 struct TCP_Server_Info *server);
141extern int SMB2_sess_setup(const unsigned int xid, struct cifs_ses *ses,
142 struct TCP_Server_Info *server,
143 const struct nls_table *nls_cp);
144extern int SMB2_logoff(const unsigned int xid, struct cifs_ses *ses);
145extern int SMB2_tcon(const unsigned int xid, struct cifs_ses *ses,
146 const char *tree, struct cifs_tcon *tcon,
147 const struct nls_table *);
148extern int SMB2_tdis(const unsigned int xid, struct cifs_tcon *tcon);
149extern int SMB2_open(const unsigned int xid, struct cifs_open_parms *oparms,
150 __le16 *path, __u8 *oplock,
151 struct smb2_file_all_info *buf,
152 struct create_posix_rsp *posix,
153 struct kvec *err_iov, int *resp_buftype);
154extern int SMB2_open_init(struct cifs_tcon *tcon,
155 struct TCP_Server_Info *server,
156 struct smb_rqst *rqst,
157 __u8 *oplock, struct cifs_open_parms *oparms,
158 __le16 *path);
159extern void SMB2_open_free(struct smb_rqst *rqst);
160extern int SMB2_ioctl(const unsigned int xid, struct cifs_tcon *tcon,
161 u64 persistent_fid, u64 volatile_fid, u32 opcode,
162 char *in_data, u32 indatalen, u32 maxoutlen,
163 char **out_data, u32 *plen /* returned data len */);
164extern int SMB2_ioctl_init(struct cifs_tcon *tcon,
165 struct TCP_Server_Info *server,
166 struct smb_rqst *rqst,
167 u64 persistent_fid, u64 volatile_fid, u32 opcode,
168 char *in_data, u32 indatalen,
169 __u32 max_response_size);
170extern void SMB2_ioctl_free(struct smb_rqst *rqst);
171extern int SMB2_change_notify(const unsigned int xid, struct cifs_tcon *tcon,
172 u64 persistent_fid, u64 volatile_fid, bool watch_tree,
173 u32 completion_filter, u32 max_out_data_len,
174 char **out_data, u32 *plen /* returned data len */);
175
176extern int __SMB2_close(const unsigned int xid, struct cifs_tcon *tcon,
177 u64 persistent_fid, u64 volatile_fid,
178 struct smb2_file_network_open_info *pbuf);
179extern int SMB2_close(const unsigned int xid, struct cifs_tcon *tcon,
180 u64 persistent_file_id, u64 volatile_file_id);
181extern int SMB2_close_init(struct cifs_tcon *tcon,
182 struct TCP_Server_Info *server,
183 struct smb_rqst *rqst,
184 u64 persistent_fid, u64 volatile_fid,
185 bool query_attrs);
186extern void SMB2_close_free(struct smb_rqst *rqst);
187extern int SMB2_flush(const unsigned int xid, struct cifs_tcon *tcon,
188 u64 persistent_file_id, u64 volatile_file_id);
189extern int SMB2_flush_init(const unsigned int xid, struct smb_rqst *rqst,
190 struct cifs_tcon *tcon,
191 struct TCP_Server_Info *server,
192 u64 persistent_file_id, u64 volatile_file_id);
193extern void SMB2_flush_free(struct smb_rqst *rqst);
194extern int SMB311_posix_query_info(const unsigned int xid, struct cifs_tcon *tcon,
195 u64 persistent_fid, u64 volatile_fid, struct smb311_posix_qinfo *data, u32 *plen);
196extern int SMB2_query_info(const unsigned int xid, struct cifs_tcon *tcon,
197 u64 persistent_file_id, u64 volatile_file_id,
198 struct smb2_file_all_info *data);
199extern int SMB2_query_info_init(struct cifs_tcon *tcon,
200 struct TCP_Server_Info *server,
201 struct smb_rqst *rqst,
202 u64 persistent_fid, u64 volatile_fid,
203 u8 info_class, u8 info_type,
204 u32 additional_info, size_t output_len,
205 size_t input_len, void *input);
206extern void SMB2_query_info_free(struct smb_rqst *rqst);
207extern int SMB2_query_acl(const unsigned int xid, struct cifs_tcon *tcon,
208 u64 persistent_file_id, u64 volatile_file_id,
209 void **data, unsigned int *plen, u32 info);
210extern int SMB2_get_srv_num(const unsigned int xid, struct cifs_tcon *tcon,
211 u64 persistent_fid, u64 volatile_fid,
212 __le64 *uniqueid);
213extern int smb2_async_readv(struct cifs_io_subrequest *rdata);
214extern int SMB2_read(const unsigned int xid, struct cifs_io_parms *io_parms,
215 unsigned int *nbytes, char **buf, int *buf_type);
216extern void smb2_async_writev(struct cifs_io_subrequest *wdata);
217extern int SMB2_write(const unsigned int xid, struct cifs_io_parms *io_parms,
218 unsigned int *nbytes, struct kvec *iov, int n_vec);
219extern int SMB2_echo(struct TCP_Server_Info *server);
220extern int SMB2_query_directory(const unsigned int xid, struct cifs_tcon *tcon,
221 u64 persistent_fid, u64 volatile_fid, int index,
222 struct cifs_search_info *srch_inf);
223extern int SMB2_query_directory_init(unsigned int xid, struct cifs_tcon *tcon,
224 struct TCP_Server_Info *server,
225 struct smb_rqst *rqst,
226 u64 persistent_fid, u64 volatile_fid,
227 int index, int info_level);
228extern void SMB2_query_directory_free(struct smb_rqst *rqst);
229extern int SMB2_set_eof(const unsigned int xid, struct cifs_tcon *tcon,
230 u64 persistent_fid, u64 volatile_fid, u32 pid,
231 loff_t new_eof);
232extern int SMB2_set_info_init(struct cifs_tcon *tcon,
233 struct TCP_Server_Info *server,
234 struct smb_rqst *rqst,
235 u64 persistent_fid, u64 volatile_fid, u32 pid,
236 u8 info_class, u8 info_type, u32 additional_info,
237 void **data, unsigned int *size);
238extern void SMB2_set_info_free(struct smb_rqst *rqst);
239extern int SMB2_set_acl(const unsigned int xid, struct cifs_tcon *tcon,
240 u64 persistent_fid, u64 volatile_fid,
241 struct cifs_ntsd *pnntsd, int pacllen, int aclflag);
242extern int SMB2_set_ea(const unsigned int xid, struct cifs_tcon *tcon,
243 u64 persistent_fid, u64 volatile_fid,
244 struct smb2_file_full_ea_info *buf, int len);
245extern int SMB2_set_compression(const unsigned int xid, struct cifs_tcon *tcon,
246 u64 persistent_fid, u64 volatile_fid);
247extern int SMB2_oplock_break(const unsigned int xid, struct cifs_tcon *tcon,
248 const u64 persistent_fid, const u64 volatile_fid,
249 const __u8 oplock_level);
250extern int smb2_handle_cancelled_close(struct cifs_tcon *tcon,
251 __u64 persistent_fid,
252 __u64 volatile_fid);
253extern int smb2_handle_cancelled_mid(struct mid_q_entry *mid, struct TCP_Server_Info *server);
254void smb2_cancelled_close_fid(struct work_struct *work);
255extern int SMB2_QFS_info(const unsigned int xid, struct cifs_tcon *tcon,
256 u64 persistent_file_id, u64 volatile_file_id,
257 struct kstatfs *FSData);
258extern int SMB311_posix_qfs_info(const unsigned int xid, struct cifs_tcon *tcon,
259 u64 persistent_file_id, u64 volatile_file_id,
260 struct kstatfs *FSData);
261extern int SMB2_QFS_attr(const unsigned int xid, struct cifs_tcon *tcon,
262 u64 persistent_file_id, u64 volatile_file_id, int lvl);
263extern int SMB2_lock(const unsigned int xid, struct cifs_tcon *tcon,
264 const __u64 persist_fid, const __u64 volatile_fid,
265 const __u32 pid, const __u64 length, const __u64 offset,
266 const __u32 lockFlags, const bool wait);
267extern int smb2_lockv(const unsigned int xid, struct cifs_tcon *tcon,
268 const __u64 persist_fid, const __u64 volatile_fid,
269 const __u32 pid, const __u32 num_lock,
270 struct smb2_lock_element *buf);
271extern int SMB2_lease_break(const unsigned int xid, struct cifs_tcon *tcon,
272 __u8 *lease_key, const __le32 lease_state);
273extern int smb3_validate_negotiate(const unsigned int, struct cifs_tcon *);
274
275extern enum securityEnum smb2_select_sectype(struct TCP_Server_Info *,
276 enum securityEnum);
277int smb2_parse_contexts(struct TCP_Server_Info *server,
278 struct kvec *rsp_iov,
279 unsigned int *epoch,
280 char *lease_key, __u8 *oplock,
281 struct smb2_file_all_info *buf,
282 struct create_posix_rsp *posix);
283
284extern int smb3_encryption_required(const struct cifs_tcon *tcon);
285extern int smb2_validate_iov(unsigned int offset, unsigned int buffer_length,
286 struct kvec *iov, unsigned int min_buf_size);
287extern int smb2_validate_and_copy_iov(unsigned int offset,
288 unsigned int buffer_length,
289 struct kvec *iov,
290 unsigned int minbufsize, char *data);
291extern void smb2_copy_fs_info_to_kstatfs(
292 struct smb2_fs_full_size_info *pfs_inf,
293 struct kstatfs *kst);
294extern int smb311_crypto_shash_allocate(struct TCP_Server_Info *server);
295extern int smb311_update_preauth_hash(struct cifs_ses *ses,
296 struct TCP_Server_Info *server,
297 struct kvec *iov, int nvec);
298extern int smb2_query_info_compound(const unsigned int xid,
299 struct cifs_tcon *tcon,
300 const char *path, u32 desired_access,
301 u32 class, u32 type, u32 output_len,
302 struct kvec *rsp, int *buftype,
303 struct cifs_sb_info *cifs_sb);
304/* query path info from the server using SMB311 POSIX extensions*/
305int smb311_posix_query_path_info(const unsigned int xid,
306 struct cifs_tcon *tcon,
307 struct cifs_sb_info *cifs_sb,
308 const char *full_path,
309 struct cifs_open_info_data *data);
310int posix_info_parse(const void *beg, const void *end,
311 struct smb2_posix_info_parsed *out);
312int posix_info_sid_size(const void *beg, const void *end);
313int smb2_create_reparse_symlink(const unsigned int xid, struct inode *inode,
314 struct dentry *dentry, struct cifs_tcon *tcon,
315 const char *full_path, const char *symname);
316int smb2_make_nfs_node(unsigned int xid, struct inode *inode,
317 struct dentry *dentry, struct cifs_tcon *tcon,
318 const char *full_path, umode_t mode, dev_t dev);
319
320#endif /* _SMB2PROTO_H */