blob: 05287b01f5961c57ae0730558328424a4ee32aef [file] [log] [blame]
Steve Frenchddfbefb2011-03-15 02:08:48 +00001/*
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 -070029struct smb_rqst;
Steve Frenchddfbefb2011-03-15 02:08:48 +000030
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 -060037extern int smb2_check_message(char *buf, unsigned int length,
38 struct TCP_Server_Info *server);
Pavel Shilovskyd324f08d2012-09-18 16:20:33 -070039extern unsigned int smb2_calc_size(void *buf);
Pavel Shilovskyec2e4522011-12-27 16:12:43 +040040extern char *smb2_get_data_area_len(int *off, int *len, struct smb2_hdr *hdr);
Pavel Shilovsky2503a0d2011-12-26 22:58:46 +040041extern __le16 *cifs_convert_path_to_utf16(const char *from,
42 struct cifs_sb_info *cifs_sb);
Steve Frenchddfbefb2011-03-15 02:08:48 +000043
Jeff Layton0b688cf2012-09-18 16:20:34 -070044extern int smb2_verify_signature(struct smb_rqst *, struct TCP_Server_Info *);
Pavel Shilovsky2dc7e1c2011-12-26 22:53:34 +040045extern int smb2_check_receive(struct mid_q_entry *mid,
46 struct TCP_Server_Info *server, bool log_error);
Jeff Laytonfec344e2012-09-18 16:20:35 -070047extern struct mid_q_entry *smb2_setup_request(struct cifs_ses *ses,
48 struct smb_rqst *rqst);
49extern struct mid_q_entry *smb2_setup_async_request(
50 struct TCP_Server_Info *server, struct smb_rqst *rqst);
Sachin Prabhu38bd4902017-03-03 15:41:38 -080051extern struct cifs_ses *smb2_find_smb_ses(struct TCP_Server_Info *server,
52 __u64 ses_id);
53extern struct cifs_tcon *smb2_find_smb_tcon(struct TCP_Server_Info *server,
54 __u64 ses_id, __u32 tid);
Steve French38107d42012-12-08 22:08:06 -060055extern int smb2_calc_signature(struct smb_rqst *rqst,
56 struct TCP_Server_Info *server);
57extern int smb3_calc_signature(struct smb_rqst *rqst,
58 struct TCP_Server_Info *server);
Pavel Shilovskyc95b8ee2012-07-11 14:45:28 +040059extern void smb2_echo_request(struct work_struct *work);
Pavel Shilovsky0822f512012-09-19 06:22:45 -070060extern __le32 smb2_get_lease_state(struct cifsInodeInfo *cinode);
Pavel Shilovsky983c88a2012-09-18 16:20:33 -070061extern bool smb2_is_valid_oplock_break(char *buffer,
62 struct TCP_Server_Info *srv);
Pavel Shilovsky026e93d2016-11-03 16:47:37 -070063extern struct cifs_ses *smb2_find_smb_ses(struct TCP_Server_Info *server,
64 __u64 ses_id);
Pavel Shilovsky4326ed22016-11-17 15:24:46 -080065extern int smb3_handle_read_data(struct TCP_Server_Info *server,
66 struct mid_q_entry *mid);
Pavel Shilovsky2dc7e1c2011-12-26 22:53:34 +040067
Pavel Shilovskyf0df7372012-09-18 16:20:26 -070068extern void move_smb2_info_to_cifs(FILE_ALL_INFO *dst,
69 struct smb2_file_all_info *src);
Pavel Shilovskybe4cb9e2011-12-29 17:06:33 +040070extern int smb2_query_path_info(const unsigned int xid, struct cifs_tcon *tcon,
71 struct cifs_sb_info *cifs_sb,
72 const char *full_path, FILE_ALL_INFO *data,
Pavel Shilovskyeb85d94b2013-10-23 17:49:47 +040073 bool *adjust_tz, bool *symlink);
Pavel Shilovskyc839ff22012-09-18 16:20:32 -070074extern int smb2_set_path_size(const unsigned int xid, struct cifs_tcon *tcon,
75 const char *full_path, __u64 size,
76 struct cifs_sb_info *cifs_sb, bool set_alloc);
Pavel Shilovsky1feeaac2012-09-18 16:20:32 -070077extern int smb2_set_file_info(struct inode *inode, const char *full_path,
78 FILE_BASIC_INFO *buf, const unsigned int xid);
Pavel Shilovskya0e73182011-07-19 12:56:37 +040079extern int smb2_mkdir(const unsigned int xid, struct cifs_tcon *tcon,
80 const char *name, struct cifs_sb_info *cifs_sb);
81extern void smb2_mkdir_setinfo(struct inode *inode, const char *full_path,
82 struct cifs_sb_info *cifs_sb,
83 struct cifs_tcon *tcon, const unsigned int xid);
Pavel Shilovsky1a500f02012-07-10 16:14:38 +040084extern int smb2_rmdir(const unsigned int xid, struct cifs_tcon *tcon,
85 const char *name, struct cifs_sb_info *cifs_sb);
Pavel Shilovskycbe6f432012-09-18 16:20:25 -070086extern int smb2_unlink(const unsigned int xid, struct cifs_tcon *tcon,
87 const char *name, struct cifs_sb_info *cifs_sb);
Pavel Shilovsky35143eb2012-09-18 16:20:31 -070088extern int smb2_rename_path(const unsigned int xid, struct cifs_tcon *tcon,
89 const char *from_name, const char *to_name,
90 struct cifs_sb_info *cifs_sb);
Pavel Shilovsky568798c2012-09-18 16:20:31 -070091extern int smb2_create_hardlink(const unsigned int xid, struct cifs_tcon *tcon,
92 const char *from_name, const char *to_name,
93 struct cifs_sb_info *cifs_sb);
Steve French5ab97572014-09-15 04:49:28 -050094extern int smb3_create_mf_symlink(unsigned int xid, struct cifs_tcon *tcon,
95 struct cifs_sb_info *cifs_sb, const unsigned char *path,
96 char *pbuf, unsigned int *pbytes_written);
Steve Frenchc22870e2014-09-16 07:18:19 -050097extern int smb3_query_mf_symlink(unsigned int xid, struct cifs_tcon *tcon,
98 struct cifs_sb_info *cifs_sb,
99 const unsigned char *path, char *pbuf,
100 unsigned int *pbytes_read);
Pavel Shilovsky226730b2013-07-05 12:00:30 +0400101extern int smb2_open_file(const unsigned int xid,
102 struct cifs_open_parms *oparms,
103 __u32 *oplock, FILE_ALL_INFO *buf);
Pavel Shilovskyf7ba7fe2012-09-19 06:22:43 -0700104extern int smb2_unlock_range(struct cifsFileInfo *cfile,
105 struct file_lock *flock, const unsigned int xid);
Pavel Shilovskyb1407992012-09-19 06:22:44 -0700106extern int smb2_push_mandatory_locks(struct cifsFileInfo *cfile);
Pavel Shilovsky53e0e112016-11-04 11:50:31 -0700107extern void smb2_reconnect_server(struct work_struct *work);
Pavel Shilovsky026e93d2016-11-03 16:47:37 -0700108extern int smb3_crypto_aead_allocate(struct TCP_Server_Info *server);
Pavel Shilovskyf0df7372012-09-18 16:20:26 -0700109
Pavel Shilovskyec2e4522011-12-27 16:12:43 +0400110/*
111 * SMB2 Worker functions - most of protocol specific implementation details
112 * are contained within these calls.
113 */
114extern int SMB2_negotiate(const unsigned int xid, struct cifs_ses *ses);
Pavel Shilovsky5478f9b2011-12-27 16:22:00 +0400115extern int SMB2_sess_setup(const unsigned int xid, struct cifs_ses *ses,
116 const struct nls_table *nls_cp);
117extern int SMB2_logoff(const unsigned int xid, struct cifs_ses *ses);
Pavel Shilovskyfaaf9462011-12-27 16:04:00 +0400118extern int SMB2_tcon(const unsigned int xid, struct cifs_ses *ses,
119 const char *tree, struct cifs_tcon *tcon,
120 const struct nls_table *);
121extern int SMB2_tdis(const unsigned int xid, struct cifs_tcon *tcon);
Pavel Shilovsky064f6042013-07-09 18:20:30 +0400122extern int SMB2_open(const unsigned int xid, struct cifs_open_parms *oparms,
123 __le16 *path, __u8 *oplock,
Pavel Shilovskyb42bf882013-08-14 19:25:21 +0400124 struct smb2_file_all_info *buf,
125 struct smb2_err_rsp **err_buf);
Steve French4a72daf2013-06-25 00:20:49 -0500126extern int SMB2_ioctl(const unsigned int xid, struct cifs_tcon *tcon,
127 u64 persistent_fid, u64 volatile_fid, u32 opcode,
Aurelien Aptel63a83b82018-01-24 13:46:11 +0100128 bool is_fsctl, char *in_data, u32 indatalen,
Steve French4a72daf2013-06-25 00:20:49 -0500129 char **out_data, u32 *plen /* returned data len */);
Pavel Shilovsky2503a0d2011-12-26 22:58:46 +0400130extern int SMB2_close(const unsigned int xid, struct cifs_tcon *tcon,
131 u64 persistent_file_id, u64 volatile_file_id);
Pavel Shilovsky7a5cfb12012-09-18 16:20:28 -0700132extern int SMB2_flush(const unsigned int xid, struct cifs_tcon *tcon,
133 u64 persistent_file_id, u64 volatile_file_id);
Ronnie Sahlberg95907fe2017-08-24 11:24:55 +1000134extern int SMB2_query_eas(const unsigned int xid, struct cifs_tcon *tcon,
135 u64 persistent_file_id, u64 volatile_file_id,
Ronnie Sahlberg7cb3def2017-09-28 09:39:58 +1000136 int ea_buf_size,
Ronnie Sahlberg95907fe2017-08-24 11:24:55 +1000137 struct smb2_file_full_ea_info *data);
Pavel Shilovskybe4cb9e2011-12-29 17:06:33 +0400138extern int SMB2_query_info(const unsigned int xid, struct cifs_tcon *tcon,
139 u64 persistent_file_id, u64 volatile_file_id,
140 struct smb2_file_all_info *data);
Shirish Pargaonkar42c493c2017-06-22 22:51:31 -0500141extern int SMB2_query_acl(const unsigned int xid, struct cifs_tcon *tcon,
142 u64 persistent_file_id, u64 volatile_file_id,
143 void **data, unsigned int *plen);
Pavel Shilovskyf0df7372012-09-18 16:20:26 -0700144extern int SMB2_get_srv_num(const unsigned int xid, struct cifs_tcon *tcon,
145 u64 persistent_fid, u64 volatile_fid,
146 __le64 *uniqueid);
Pavel Shilovsky09a47072012-09-18 16:20:29 -0700147extern int smb2_async_readv(struct cifs_readdata *rdata);
Pavel Shilovskyd8e05032012-09-18 16:20:30 -0700148extern int SMB2_read(const unsigned int xid, struct cifs_io_parms *io_parms,
149 unsigned int *nbytes, char **buf, int *buf_type);
Steve French4a5c80d2014-02-07 20:45:12 -0600150extern int smb2_async_writev(struct cifs_writedata *wdata,
151 void (*release)(struct kref *kref));
Pavel Shilovsky009d3442012-09-18 16:20:30 -0700152extern int SMB2_write(const unsigned int xid, struct cifs_io_parms *io_parms,
153 unsigned int *nbytes, struct kvec *iov, int n_vec);
Pavel Shilovsky9094fad2012-07-12 18:30:44 +0400154extern int SMB2_echo(struct TCP_Server_Info *server);
Pavel Shilovskyd324f08d2012-09-18 16:20:33 -0700155extern int SMB2_query_directory(const unsigned int xid, struct cifs_tcon *tcon,
156 u64 persistent_fid, u64 volatile_fid, int index,
157 struct cifs_search_info *srch_inf);
Pavel Shilovsky35143eb2012-09-18 16:20:31 -0700158extern int SMB2_rename(const unsigned int xid, struct cifs_tcon *tcon,
159 u64 persistent_fid, u64 volatile_fid,
160 __le16 *target_file);
Steve French897fba12016-05-12 21:20:36 -0500161extern int SMB2_rmdir(const unsigned int xid, struct cifs_tcon *tcon,
162 u64 persistent_fid, u64 volatile_fid);
Pavel Shilovsky568798c2012-09-18 16:20:31 -0700163extern int SMB2_set_hardlink(const unsigned int xid, struct cifs_tcon *tcon,
164 u64 persistent_fid, u64 volatile_fid,
165 __le16 *target_file);
Pavel Shilovskyc839ff22012-09-18 16:20:32 -0700166extern int SMB2_set_eof(const unsigned int xid, struct cifs_tcon *tcon,
167 u64 persistent_fid, u64 volatile_fid, u32 pid,
Steve Frenchf29ebb42014-07-19 21:44:58 -0500168 __le64 *eof, bool is_fallocate);
Pavel Shilovsky1feeaac2012-09-18 16:20:32 -0700169extern int SMB2_set_info(const unsigned int xid, struct cifs_tcon *tcon,
170 u64 persistent_fid, u64 volatile_fid,
171 FILE_BASIC_INFO *buf);
Shirish Pargaonkardac95342017-06-28 22:37:00 -0500172extern int SMB2_set_acl(const unsigned int xid, struct cifs_tcon *tcon,
173 u64 persistent_fid, u64 volatile_fid,
174 struct cifs_ntsd *pnntsd, int pacllen, int aclflag);
Ronnie Sahlberg55175542017-08-24 11:24:56 +1000175extern int SMB2_set_ea(const unsigned int xid, struct cifs_tcon *tcon,
176 u64 persistent_fid, u64 volatile_fid,
177 struct smb2_file_full_ea_info *buf, int len);
Steve French64a5cfa2013-10-14 15:31:32 -0500178extern int SMB2_set_compression(const unsigned int xid, struct cifs_tcon *tcon,
179 u64 persistent_fid, u64 volatile_fid);
Pavel Shilovsky983c88a2012-09-18 16:20:33 -0700180extern int SMB2_oplock_break(const unsigned int xid, struct cifs_tcon *tcon,
181 const u64 persistent_fid, const u64 volatile_fid,
182 const __u8 oplock_level);
Sachin Prabhu38bd4902017-03-03 15:41:38 -0800183extern int smb2_handle_cancelled_mid(char *buffer,
184 struct TCP_Server_Info *server);
185void smb2_cancelled_close_fid(struct work_struct *work);
Pavel Shilovsky6fc05c22012-09-18 16:20:34 -0700186extern int SMB2_QFS_info(const unsigned int xid, struct cifs_tcon *tcon,
187 u64 persistent_file_id, u64 volatile_file_id,
188 struct kstatfs *FSData);
Steve French34f62642013-10-09 02:07:00 -0500189extern int SMB2_QFS_attr(const unsigned int xid, struct cifs_tcon *tcon,
Steven French21671142013-10-09 13:36:35 -0500190 u64 persistent_file_id, u64 volatile_file_id, int lvl);
Pavel Shilovskyf7ba7fe2012-09-19 06:22:43 -0700191extern int SMB2_lock(const unsigned int xid, struct cifs_tcon *tcon,
192 const __u64 persist_fid, const __u64 volatile_fid,
193 const __u32 pid, const __u64 length, const __u64 offset,
194 const __u32 lockFlags, const bool wait);
195extern int smb2_lockv(const unsigned int xid, struct cifs_tcon *tcon,
196 const __u64 persist_fid, const __u64 volatile_fid,
197 const __u32 pid, const __u32 num_lock,
198 struct smb2_lock_element *buf);
Pavel Shilovsky0822f512012-09-19 06:22:45 -0700199extern int SMB2_lease_break(const unsigned int xid, struct cifs_tcon *tcon,
200 __u8 *lease_key, const __le32 lease_state);
Steve Frenchff1c0382013-11-19 23:44:46 -0600201extern int smb3_validate_negotiate(const unsigned int, struct cifs_tcon *);
Pavel Shilovskyec2e4522011-12-27 16:12:43 +0400202
Sachin Prabhuef65aae2017-01-18 15:35:57 +0530203extern enum securityEnum smb2_select_sectype(struct TCP_Server_Info *,
204 enum securityEnum);
Steve Frenchddfbefb2011-03-15 02:08:48 +0000205#endif /* _SMB2PROTO_H */