Gitiles
Code Review Sign In
review.shift-gmbh.com / SHIFTPHONES / kernel / common / 22442179a5bb8c62c978cdb686cfb3a8f6d110d8 / . / fs / cifs / smb2proto.h
blob: 07ca72486cfac50f7207487085f68036c4e635c6 [file] [log] [blame]
Steve Frenchddfbefb2011-03-15 02:08:48 +0000[diff] [blame]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;
Jeff Layton0b688cf2012-09-18 16:20:34 -0700[diff] [blame]29struct smb_rqst;
Steve Frenchddfbefb2011-03-15 02:08:48 +0000[diff] [blame]30
31/*
32 *****************************************************************
33 * All Prototypes
34 *****************************************************************
35 */
36extern int map_smb2_to_linux_error(char *buf, bool log_err);
Steve French373512e2015-12-18 13:05:30 -0600[diff] [blame]37extern int smb2_check_message(char *buf, unsigned int length,
38 struct TCP_Server_Info *server);
Ronnie Sahlberg9ec672b2018-04-22 15:30:12 -0600[diff] [blame]39extern unsigned int smb2_calc_size(void *buf, struct TCP_Server_Info *server);
Ronnie Sahlberge4dc31f2018-06-01 10:53:05 +1000[diff] [blame]40extern char *smb2_get_data_area_len(int *off, int *len,
41 struct smb2_sync_hdr *shdr);
Pavel Shilovsky2503a0d2011-12-26 22:58:46 +0400[diff] [blame]42extern __le16 *cifs_convert_path_to_utf16(const char *from,
43 struct cifs_sb_info *cifs_sb);
Steve Frenchddfbefb2011-03-15 02:08:48 +0000[diff] [blame]44
Jeff Layton0b688cf2012-09-18 16:20:34 -0700[diff] [blame]45extern int smb2_verify_signature(struct smb_rqst *, struct TCP_Server_Info *);
Pavel Shilovsky2dc7e1c2011-12-26 22:53:34 +0400[diff] [blame]46extern int smb2_check_receive(struct mid_q_entry *mid,
47 struct TCP_Server_Info *server, bool log_error);
Jeff Laytonfec344e2012-09-18 16:20:35 -0700[diff] [blame]48extern struct mid_q_entry *smb2_setup_request(struct cifs_ses *ses,
49 struct smb_rqst *rqst);
50extern struct mid_q_entry *smb2_setup_async_request(
51 struct TCP_Server_Info *server, struct smb_rqst *rqst);
Sachin Prabhu38bd4902017-03-03 15:41:38 -0800[diff] [blame]52extern struct cifs_ses *smb2_find_smb_ses(struct TCP_Server_Info *server,
53 __u64 ses_id);
54extern struct cifs_tcon *smb2_find_smb_tcon(struct TCP_Server_Info *server,
55 __u64 ses_id, __u32 tid);
Steve French38107d42012-12-08 22:08:06 -0600[diff] [blame]56extern int smb2_calc_signature(struct smb_rqst *rqst,
57 struct TCP_Server_Info *server);
58extern int smb3_calc_signature(struct smb_rqst *rqst,
59 struct TCP_Server_Info *server);
Pavel Shilovskyc95b8ee2012-07-11 14:45:28 +0400[diff] [blame]60extern void smb2_echo_request(struct work_struct *work);
Pavel Shilovsky0822f512012-09-19 06:22:45 -0700[diff] [blame]61extern __le32 smb2_get_lease_state(struct cifsInodeInfo *cinode);
Pavel Shilovsky983c88a2012-09-18 16:20:33 -0700[diff] [blame]62extern bool smb2_is_valid_oplock_break(char *buffer,
63 struct TCP_Server_Info *srv);
Pavel Shilovsky026e93d2016-11-03 16:47:37 -0700[diff] [blame]64extern struct cifs_ses *smb2_find_smb_ses(struct TCP_Server_Info *server,
65 __u64 ses_id);
Pavel Shilovsky4326ed22016-11-17 15:24:46 -0800[diff] [blame]66extern int smb3_handle_read_data(struct TCP_Server_Info *server,
67 struct mid_q_entry *mid);
Pavel Shilovsky2dc7e1c2011-12-26 22:53:34 +0400[diff] [blame]68
Steve French3d4ef9a2018-04-25 22:19:09 -0500[diff] [blame]69extern int open_shroot(unsigned int xid, struct cifs_tcon *tcon,
70 struct cifs_fid *pfid);
Ronnie Sahlberg9da6ec72018-07-31 08:48:22 +1000[diff] [blame]71extern void close_shroot(struct cached_fid *cfid);
Pavel Shilovskyf0df7372012-09-18 16:20:26 -0700[diff] [blame]72extern void move_smb2_info_to_cifs(FILE_ALL_INFO *dst,
73 struct smb2_file_all_info *src);
Pavel Shilovskybe4cb9e2011-12-29 17:06:33 +0400[diff] [blame]74extern int smb2_query_path_info(const unsigned int xid, struct cifs_tcon *tcon,
75 struct cifs_sb_info *cifs_sb,
76 const char *full_path, FILE_ALL_INFO *data,
Pavel Shilovskyeb85d94b2013-10-23 17:49:47 +0400[diff] [blame]77 bool *adjust_tz, bool *symlink);
Pavel Shilovskyc839ff22012-09-18 16:20:32 -0700[diff] [blame]78extern int smb2_set_path_size(const unsigned int xid, struct cifs_tcon *tcon,
79 const char *full_path, __u64 size,
80 struct cifs_sb_info *cifs_sb, bool set_alloc);
Pavel Shilovsky1feeaac2012-09-18 16:20:32 -0700[diff] [blame]81extern int smb2_set_file_info(struct inode *inode, const char *full_path,
82 FILE_BASIC_INFO *buf, const unsigned int xid);
Steve Frenchbea851b2018-06-14 21:56:32 -0500[diff] [blame]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);
Pavel Shilovskya0e73182011-07-19 12:56:37 +0400[diff] [blame]87extern int smb2_mkdir(const unsigned int xid, struct cifs_tcon *tcon,
88 const char *name, struct cifs_sb_info *cifs_sb);
89extern void smb2_mkdir_setinfo(struct inode *inode, const char *full_path,
90 struct cifs_sb_info *cifs_sb,
91 struct cifs_tcon *tcon, const unsigned int xid);
Pavel Shilovsky1a500f02012-07-10 16:14:38 +0400[diff] [blame]92extern int smb2_rmdir(const unsigned int xid, struct cifs_tcon *tcon,
93 const char *name, struct cifs_sb_info *cifs_sb);
Pavel Shilovskycbe6f432012-09-18 16:20:25 -0700[diff] [blame]94extern int smb2_unlink(const unsigned int xid, struct cifs_tcon *tcon,
95 const char *name, struct cifs_sb_info *cifs_sb);
Pavel Shilovsky35143eb2012-09-18 16:20:31 -0700[diff] [blame]96extern int smb2_rename_path(const unsigned int xid, struct cifs_tcon *tcon,
97 const char *from_name, const char *to_name,
98 struct cifs_sb_info *cifs_sb);
Pavel Shilovsky568798c2012-09-18 16:20:31 -0700[diff] [blame]99extern int smb2_create_hardlink(const unsigned int xid, struct cifs_tcon *tcon,
100 const char *from_name, const char *to_name,
101 struct cifs_sb_info *cifs_sb);
Steve French5ab97572014-09-15 04:49:28 -0500[diff] [blame]102extern int smb3_create_mf_symlink(unsigned int xid, struct cifs_tcon *tcon,
103 struct cifs_sb_info *cifs_sb, const unsigned char *path,
104 char *pbuf, unsigned int *pbytes_written);
Steve Frenchc22870e2014-09-16 07:18:19 -0500[diff] [blame]105extern int smb3_query_mf_symlink(unsigned int xid, struct cifs_tcon *tcon,
106 struct cifs_sb_info *cifs_sb,
107 const unsigned char *path, char *pbuf,
108 unsigned int *pbytes_read);
Pavel Shilovsky226730b2013-07-05 12:00:30 +0400[diff] [blame]109extern int smb2_open_file(const unsigned int xid,
110 struct cifs_open_parms *oparms,
111 __u32 *oplock, FILE_ALL_INFO *buf);
Pavel Shilovskyf7ba7fe2012-09-19 06:22:43 -0700[diff] [blame]112extern int smb2_unlock_range(struct cifsFileInfo *cfile,
113 struct file_lock *flock, const unsigned int xid);
Pavel Shilovskyb1407992012-09-19 06:22:44 -0700[diff] [blame]114extern int smb2_push_mandatory_locks(struct cifsFileInfo *cfile);
Pavel Shilovsky53e0e112016-11-04 11:50:31 -0700[diff] [blame]115extern void smb2_reconnect_server(struct work_struct *work);
Pavel Shilovsky026e93d2016-11-03 16:47:37 -0700[diff] [blame]116extern int smb3_crypto_aead_allocate(struct TCP_Server_Info *server);
Ronnie Sahlberg81f39f92018-06-28 10:47:14 +1000[diff] [blame]117extern unsigned long smb_rqst_len(struct TCP_Server_Info *server,
118 struct smb_rqst *rqst);
Ronnie Sahlberge77fe732018-12-31 13:43:40 +1000[diff] [blame]119extern void smb2_set_next_command(struct cifs_tcon *tcon,
120 struct smb_rqst *rqst);
Ronnie Sahlbergc5a5f382018-09-03 13:33:41 +1000[diff] [blame]121extern void smb2_set_related(struct smb_rqst *rqst);
Pavel Shilovskyf0df7372012-09-18 16:20:26 -0700[diff] [blame]122
Pavel Shilovskyec2e4522011-12-27 16:12:43 +0400[diff] [blame]123/*
124 * SMB2 Worker functions - most of protocol specific implementation details
125 * are contained within these calls.
126 */
127extern int SMB2_negotiate(const unsigned int xid, struct cifs_ses *ses);
Pavel Shilovsky5478f9b2011-12-27 16:22:00 +0400[diff] [blame]128extern int SMB2_sess_setup(const unsigned int xid, struct cifs_ses *ses,
129 const struct nls_table *nls_cp);
130extern int SMB2_logoff(const unsigned int xid, struct cifs_ses *ses);
Pavel Shilovskyfaaf9462011-12-27 16:04:00 +0400[diff] [blame]131extern int SMB2_tcon(const unsigned int xid, struct cifs_ses *ses,
132 const char *tree, struct cifs_tcon *tcon,
133 const struct nls_table *);
134extern int SMB2_tdis(const unsigned int xid, struct cifs_tcon *tcon);
Pavel Shilovsky064f6042013-07-09 18:20:30 +0400[diff] [blame]135extern int SMB2_open(const unsigned int xid, struct cifs_open_parms *oparms,
136 __le16 *path, __u8 *oplock,
Pavel Shilovskyb42bf882013-08-14 19:25:21 +0400[diff] [blame]137 struct smb2_file_all_info *buf,
Ronnie Sahlberg9d874c32018-06-08 13:21:18 +1000[diff] [blame]138 struct kvec *err_iov, int *resp_buftype);
Ronnie Sahlberg1eb9fb52018-08-08 15:07:46 +1000[diff] [blame]139extern int SMB2_open_init(struct cifs_tcon *tcon, struct smb_rqst *rqst,
140 __u8 *oplock, struct cifs_open_parms *oparms,
141 __le16 *path);
142extern void SMB2_open_free(struct smb_rqst *rqst);
Steve French4a72daf2013-06-25 00:20:49 -0500[diff] [blame]143extern int SMB2_ioctl(const unsigned int xid, struct cifs_tcon *tcon,
144 u64 persistent_fid, u64 volatile_fid, u32 opcode,
Steve French153322f2019-03-28 22:32:49 -0500[diff] [blame]145 bool is_fsctl, char *in_data, u32 indatalen, u32 maxoutlen,
Steve French4a72daf2013-06-25 00:20:49 -0500[diff] [blame]146 char **out_data, u32 *plen /* returned data len */);
Ronnie Sahlbergccdc77a2019-03-13 14:37:48 +1000[diff] [blame]147extern int SMB2_ioctl_init(struct cifs_tcon *tcon, struct smb_rqst *rqst,
148 u64 persistent_fid, u64 volatile_fid, u32 opcode,
Steve French153322f2019-03-28 22:32:49 -0500[diff] [blame]149 bool is_fsctl, char *in_data, u32 indatalen,
150 __u32 max_response_size);
Ronnie Sahlbergccdc77a2019-03-13 14:37:48 +1000[diff] [blame]151extern void SMB2_ioctl_free(struct smb_rqst *rqst);
Pavel Shilovsky2503a0d2011-12-26 22:58:46 +0400[diff] [blame]152extern int SMB2_close(const unsigned int xid, struct cifs_tcon *tcon,
153 u64 persistent_file_id, u64 volatile_file_id);
Ronnie Sahlberg97ca1762018-04-26 08:50:49 -0600[diff] [blame]154extern int SMB2_close_flags(const unsigned int xid, struct cifs_tcon *tcon,
155 u64 persistent_fid, u64 volatile_fid, int flags);
Ronnie Sahlberg8eb4ecf2018-08-01 09:26:16 +1000[diff] [blame]156extern int SMB2_close_init(struct cifs_tcon *tcon, struct smb_rqst *rqst,
157 u64 persistent_file_id, u64 volatile_file_id);
158extern void SMB2_close_free(struct smb_rqst *rqst);
Pavel Shilovsky7a5cfb12012-09-18 16:20:28 -0700[diff] [blame]159extern int SMB2_flush(const unsigned int xid, struct cifs_tcon *tcon,
160 u64 persistent_file_id, u64 volatile_file_id);
Pavel Shilovskybe4cb9e2011-12-29 17:06:33 +0400[diff] [blame]161extern int SMB2_query_info(const unsigned int xid, struct cifs_tcon *tcon,
162 u64 persistent_file_id, u64 volatile_file_id,
163 struct smb2_file_all_info *data);
Ronnie Sahlberg296ecba2018-08-01 09:26:17 +1000[diff] [blame]164extern int SMB2_query_info_init(struct cifs_tcon *tcon, struct smb_rqst *rqst,
165 u64 persistent_fid, u64 volatile_fid,
166 u8 info_class, u8 info_type,
Ronnie Sahlbergf5b05d62018-10-07 19:19:58 -0500[diff] [blame]167 u32 additional_info, size_t output_len,
168 size_t input_len, void *input);
Ronnie Sahlberg296ecba2018-08-01 09:26:17 +1000[diff] [blame]169extern void SMB2_query_info_free(struct smb_rqst *rqst);
Shirish Pargaonkar42c493c2017-06-22 22:51:31 -0500[diff] [blame]170extern int SMB2_query_acl(const unsigned int xid, struct cifs_tcon *tcon,
171 u64 persistent_file_id, u64 volatile_file_id,
172 void **data, unsigned int *plen);
Pavel Shilovskyf0df7372012-09-18 16:20:26 -0700[diff] [blame]173extern int SMB2_get_srv_num(const unsigned int xid, struct cifs_tcon *tcon,
174 u64 persistent_fid, u64 volatile_fid,
175 __le64 *uniqueid);
Pavel Shilovsky09a47072012-09-18 16:20:29 -0700[diff] [blame]176extern int smb2_async_readv(struct cifs_readdata *rdata);
Pavel Shilovskyd8e05032012-09-18 16:20:30 -0700[diff] [blame]177extern int SMB2_read(const unsigned int xid, struct cifs_io_parms *io_parms,
178 unsigned int *nbytes, char **buf, int *buf_type);
Steve French4a5c80d2014-02-07 20:45:12 -0600[diff] [blame]179extern int smb2_async_writev(struct cifs_writedata *wdata,
180 void (*release)(struct kref *kref));
Pavel Shilovsky009d3442012-09-18 16:20:30 -0700[diff] [blame]181extern int SMB2_write(const unsigned int xid, struct cifs_io_parms *io_parms,
182 unsigned int *nbytes, struct kvec *iov, int n_vec);
Pavel Shilovsky9094fad2012-07-12 18:30:44 +0400[diff] [blame]183extern int SMB2_echo(struct TCP_Server_Info *server);
Pavel Shilovskyd324f08d2012-09-18 16:20:33 -0700[diff] [blame]184extern int SMB2_query_directory(const unsigned int xid, struct cifs_tcon *tcon,
185 u64 persistent_fid, u64 volatile_fid, int index,
186 struct cifs_search_info *srch_inf);
Pavel Shilovskyc839ff22012-09-18 16:20:32 -0700[diff] [blame]187extern int SMB2_set_eof(const unsigned int xid, struct cifs_tcon *tcon,
188 u64 persistent_fid, u64 volatile_fid, u32 pid,
Ronnie Sahlberg3764cbd2018-09-03 13:33:47 +1000[diff] [blame]189 __le64 *eof);
Ronnie Sahlbergba8ca112018-09-03 13:33:44 +1000[diff] [blame]190extern int SMB2_set_info_init(struct cifs_tcon *tcon, struct smb_rqst *rqst,
191 u64 persistent_fid, u64 volatile_fid, u32 pid,
192 u8 info_class, u8 info_type, u32 additional_info,
193 void **data, unsigned int *size);
194extern void SMB2_set_info_free(struct smb_rqst *rqst);
Shirish Pargaonkardac95342017-06-28 22:37:00 -0500[diff] [blame]195extern int SMB2_set_acl(const unsigned int xid, struct cifs_tcon *tcon,
196 u64 persistent_fid, u64 volatile_fid,
197 struct cifs_ntsd *pnntsd, int pacllen, int aclflag);
Ronnie Sahlberg55175542017-08-24 11:24:56 +1000[diff] [blame]198extern int SMB2_set_ea(const unsigned int xid, struct cifs_tcon *tcon,
199 u64 persistent_fid, u64 volatile_fid,
200 struct smb2_file_full_ea_info *buf, int len);
Steve French64a5cfa2013-10-14 15:31:32 -0500[diff] [blame]201extern int SMB2_set_compression(const unsigned int xid, struct cifs_tcon *tcon,
202 u64 persistent_fid, u64 volatile_fid);
Pavel Shilovsky983c88a2012-09-18 16:20:33 -0700[diff] [blame]203extern int SMB2_oplock_break(const unsigned int xid, struct cifs_tcon *tcon,
204 const u64 persistent_fid, const u64 volatile_fid,
205 const __u8 oplock_level);
Sachin Prabhu38bd4902017-03-03 15:41:38 -0800[diff] [blame]206extern int smb2_handle_cancelled_mid(char *buffer,
207 struct TCP_Server_Info *server);
208void smb2_cancelled_close_fid(struct work_struct *work);
Pavel Shilovsky6fc05c22012-09-18 16:20:34 -0700[diff] [blame]209extern int SMB2_QFS_info(const unsigned int xid, struct cifs_tcon *tcon,
210 u64 persistent_file_id, u64 volatile_file_id,
211 struct kstatfs *FSData);
Steve French2d304212018-06-24 23:28:12 -0500[diff] [blame]212extern int SMB311_posix_qfs_info(const unsigned int xid, struct cifs_tcon *tcon,
213 u64 persistent_file_id, u64 volatile_file_id,
214 struct kstatfs *FSData);
Steve French34f62642013-10-09 02:07:00 -0500[diff] [blame]215extern int SMB2_QFS_attr(const unsigned int xid, struct cifs_tcon *tcon,
Steven French21671142013-10-09 13:36:35 -0500[diff] [blame]216 u64 persistent_file_id, u64 volatile_file_id, int lvl);
Pavel Shilovskyf7ba7fe2012-09-19 06:22:43 -0700[diff] [blame]217extern int SMB2_lock(const unsigned int xid, struct cifs_tcon *tcon,
218 const __u64 persist_fid, const __u64 volatile_fid,
219 const __u32 pid, const __u64 length, const __u64 offset,
220 const __u32 lockFlags, const bool wait);
221extern int smb2_lockv(const unsigned int xid, struct cifs_tcon *tcon,
222 const __u64 persist_fid, const __u64 volatile_fid,
223 const __u32 pid, const __u32 num_lock,
224 struct smb2_lock_element *buf);
Pavel Shilovsky0822f512012-09-19 06:22:45 -0700[diff] [blame]225extern int SMB2_lease_break(const unsigned int xid, struct cifs_tcon *tcon,
226 __u8 *lease_key, const __le32 lease_state);
Steve Frenchff1c0382013-11-19 23:44:46 -0600[diff] [blame]227extern int smb3_validate_negotiate(const unsigned int, struct cifs_tcon *);
Pavel Shilovskyec2e4522011-12-27 16:12:43 +0400[diff] [blame]228
Sachin Prabhuef65aae2017-01-18 15:35:57 +0530[diff] [blame]229extern enum securityEnum smb2_select_sectype(struct TCP_Server_Info *,
230 enum securityEnum);
Steve French89a5bfa2019-07-18 17:22:18 -0500[diff] [blame]231extern void smb2_parse_contexts(struct TCP_Server_Info *server,
232 struct smb2_create_rsp *rsp,
233 unsigned int *epoch, char *lease_key,
234 __u8 *oplock, struct smb2_file_all_info *buf);
Ronnie Sahlberg730928c2018-08-08 15:07:49 +1000[diff] [blame]235extern int smb3_encryption_required(const struct cifs_tcon *tcon);
236extern int smb2_validate_iov(unsigned int offset, unsigned int buffer_length,
237 struct kvec *iov, unsigned int min_buf_size);
Ronnie Sahlbergc5a5f382018-09-03 13:33:41 +1000[diff] [blame]238extern int smb2_validate_and_copy_iov(unsigned int offset,
239 unsigned int buffer_length,
240 struct kvec *iov,
241 unsigned int minbufsize, char *data);
Ronnie Sahlberg730928c2018-08-08 15:07:49 +1000[diff] [blame]242extern void smb2_copy_fs_info_to_kstatfs(
243 struct smb2_fs_full_size_info *pfs_inf,
244 struct kstatfs *kst);
Aurelien Aptel5fcd7f32018-02-16 19:19:28 +0100[diff] [blame]245extern int smb311_crypto_shash_allocate(struct TCP_Server_Info *server);
Aurelien Aptel8bd68c62018-02-16 19:19:29 +0100[diff] [blame]246extern int smb311_update_preauth_hash(struct cifs_ses *ses,
247 struct kvec *iov, int nvec);
Ronnie Sahlbergf9793b62018-11-27 09:52:04 +1000[diff] [blame]248extern int smb2_query_info_compound(const unsigned int xid,
249 struct cifs_tcon *tcon,
250 __le16 *utf16_path, u32 desired_access,
251 u32 class, u32 type, u32 output_len,
252 struct kvec *rsp, int *buftype,
253 struct cifs_sb_info *cifs_sb);
Steve Frenchddfbefb2011-03-15 02:08:48 +0000[diff] [blame]254#endif /* _SMB2PROTO_H */