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