git.infradead.org Git - nvme.git/blob - fs/smb/client/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 extern 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);

59 struct 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 *iov);

65 int smb2_query_reparse_point(const unsigned int xid,

66 struct cifs_tcon *tcon,

67 struct cifs_sb_info *cifs_sb,

68 const char *full_path,

69 u32 *tag, struct kvec *rsp,

70 int *rsp_buftype);

71 int smb2_query_path_info(const unsigned int xid,

72 struct cifs_tcon *tcon,

73 struct cifs_sb_info *cifs_sb,

74 const char *full_path,

75 struct cifs_open_info_data *data);

76 extern int smb2_set_path_size(const unsigned int xid, struct cifs_tcon *tcon,

77 const char *full_path, __u64 size,

78 struct cifs_sb_info *cifs_sb, bool set_alloc);

79 extern int smb2_set_file_info(struct inode *inode, const char *full_path,

80 FILE_BASIC_INFO *buf, const unsigned int xid);

81 extern int smb311_posix_mkdir(const unsigned int xid, struct inode *inode,

82 umode_t mode, struct cifs_tcon *tcon,

83 const char *full_path,

84 struct cifs_sb_info *cifs_sb);

85 extern int smb2_mkdir(const unsigned int xid, struct inode *inode,

86 umode_t mode, struct cifs_tcon *tcon,

87 const char *name, struct cifs_sb_info *cifs_sb);

88 extern void smb2_mkdir_setinfo(struct inode *inode, const char *full_path,

89 struct cifs_sb_info *cifs_sb,

90 struct cifs_tcon *tcon, const unsigned int xid);

91 extern int smb2_rmdir(const unsigned int xid, struct cifs_tcon *tcon,

92 const char *name, struct cifs_sb_info *cifs_sb);

93 extern int smb2_unlink(const unsigned int xid, struct cifs_tcon *tcon,

94 const char *name, struct cifs_sb_info *cifs_sb);

95 int smb2_rename_path(const unsigned int xid,

96 struct cifs_tcon *tcon,

97 struct dentry *source_dentry,

98 const char *from_name, const char *to_name,

99 struct cifs_sb_info *cifs_sb);

100 int smb2_create_hardlink(const unsigned int xid,

101 struct cifs_tcon *tcon,

102 struct dentry *source_dentry,

103 const char *from_name, const char *to_name,

104 struct cifs_sb_info *cifs_sb);

105 extern int smb3_create_mf_symlink(unsigned int xid, struct cifs_tcon *tcon,

106 struct cifs_sb_info *cifs_sb, const unsigned char *path,

107 char *pbuf, unsigned int *pbytes_written);

108 extern int smb3_query_mf_symlink(unsigned int xid, struct cifs_tcon *tcon,

109 struct cifs_sb_info *cifs_sb,

110 const unsigned char *path, char *pbuf,

111 unsigned int *pbytes_read);

112 int smb2_parse_symlink_response(struct cifs_sb_info *cifs_sb, const struct kvec *iov, char **path);

113 int smb2_open_file(const unsigned int xid, struct cifs_open_parms *oparms, __u32 *oplock,

114 void *buf);

115 extern int smb2_unlock_range(struct cifsFileInfo *cfile,

116 struct file_lock *flock, const unsigned int xid);

117 extern int smb2_push_mandatory_locks(struct cifsFileInfo *cfile);

118 extern void smb2_reconnect_server(struct work_struct *work);

119 extern int smb3_crypto_aead_allocate(struct TCP_Server_Info *server);

120 extern unsigned long smb_rqst_len(struct TCP_Server_Info *server,

121 struct smb_rqst *rqst);

122 extern void smb2_set_next_command(struct cifs_tcon *tcon,

123 struct smb_rqst *rqst);

124 extern void smb2_set_related(struct smb_rqst *rqst);

125

126 /*

127 * SMB2 Worker functions - most of protocol specific implementation details

128 * are contained within these calls.

129 */

130 extern int SMB2_negotiate(const unsigned int xid,

131 struct cifs_ses *ses,

132 struct TCP_Server_Info *server);

133 extern int SMB2_sess_setup(const unsigned int xid, struct cifs_ses *ses,

134 struct TCP_Server_Info *server,

135 const struct nls_table *nls_cp);

136 extern int SMB2_logoff(const unsigned int xid, struct cifs_ses *ses);

137 extern int SMB2_tcon(const unsigned int xid, struct cifs_ses *ses,

138 const char *tree, struct cifs_tcon *tcon,

139 const struct nls_table *);

140 extern int SMB2_tdis(const unsigned int xid, struct cifs_tcon *tcon);

141 extern 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);

146 extern 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);

151 extern void SMB2_open_free(struct smb_rqst *rqst);

152 extern int SMB2_ioctl(const unsigned int xid, struct cifs_tcon *tcon,

153 u64 persistent_fid, u64 volatile_fid, u32 opcode,

154 char *in_data, u32 indatalen, u32 maxoutlen,

155 char **out_data, u32 *plen /* returned data len */);

156 extern 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 char *in_data, u32 indatalen,

161 __u32 max_response_size);

162 extern void SMB2_ioctl_free(struct smb_rqst *rqst);

163 extern 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, u32 max_out_data_len,

166 char **out_data, u32 *plen /* returned data len */);

167

168 extern int __SMB2_close(const unsigned int xid, struct cifs_tcon *tcon,

169 u64 persistent_fid, u64 volatile_fid,

170 struct smb2_file_network_open_info *pbuf);

171 extern int SMB2_close(const unsigned int xid, struct cifs_tcon *tcon,

172 u64 persistent_file_id, u64 volatile_file_id);

173 extern int SMB2_close_init(struct cifs_tcon *tcon,

174 struct TCP_Server_Info *server,

175 struct smb_rqst *rqst,

176 u64 persistent_fid, u64 volatile_fid,

177 bool query_attrs);

178 extern void SMB2_close_free(struct smb_rqst *rqst);

179 extern int SMB2_flush(const unsigned int xid, struct cifs_tcon *tcon,

180 u64 persistent_file_id, u64 volatile_file_id);

181 extern int SMB2_flush_init(const unsigned int xid, struct smb_rqst *rqst,

182 struct cifs_tcon *tcon,

183 struct TCP_Server_Info *server,

184 u64 persistent_file_id, u64 volatile_file_id);

185 extern void SMB2_flush_free(struct smb_rqst *rqst);

186 extern int SMB311_posix_query_info(const unsigned int xid, struct cifs_tcon *tcon,

187 u64 persistent_fid, u64 volatile_fid, struct smb311_posix_qinfo *data, u32 *plen);

188 extern int SMB2_query_info(const unsigned int xid, struct cifs_tcon *tcon,

189 u64 persistent_file_id, u64 volatile_file_id,

190 struct smb2_file_all_info *data);

191 extern int SMB2_query_info_init(struct cifs_tcon *tcon,

192 struct TCP_Server_Info *server,

193 struct smb_rqst *rqst,

194 u64 persistent_fid, u64 volatile_fid,

195 u8 info_class, u8 info_type,

196 u32 additional_info, size_t output_len,

197 size_t input_len, void *input);

198 extern void SMB2_query_info_free(struct smb_rqst *rqst);

199 extern int SMB2_query_acl(const unsigned int xid, struct cifs_tcon *tcon,

200 u64 persistent_file_id, u64 volatile_file_id,

201 void **data, unsigned int *plen, u32 info);

202 extern int SMB2_get_srv_num(const unsigned int xid, struct cifs_tcon *tcon,

203 u64 persistent_fid, u64 volatile_fid,

204 __le64 *uniqueid);

205 extern int smb2_async_readv(struct cifs_readdata *rdata);

206 extern int SMB2_read(const unsigned int xid, struct cifs_io_parms *io_parms,

207 unsigned int *nbytes, char **buf, int *buf_type);

208 extern int smb2_async_writev(struct cifs_writedata *wdata,

209 void (*release)(struct kref *kref));

210 extern int SMB2_write(const unsigned int xid, struct cifs_io_parms *io_parms,

211 unsigned int *nbytes, struct kvec *iov, int n_vec);

212 extern int SMB2_echo(struct TCP_Server_Info *server);

213 extern int SMB2_query_directory(const unsigned int xid, struct cifs_tcon *tcon,

214 u64 persistent_fid, u64 volatile_fid, int index,

215 struct cifs_search_info *srch_inf);

216 extern int SMB2_query_directory_init(unsigned int xid, struct cifs_tcon *tcon,

217 struct TCP_Server_Info *server,

218 struct smb_rqst *rqst,

219 u64 persistent_fid, u64 volatile_fid,

220 int index, int info_level);

221 extern void SMB2_query_directory_free(struct smb_rqst *rqst);

222 extern int SMB2_set_eof(const unsigned int xid, struct cifs_tcon *tcon,

223 u64 persistent_fid, u64 volatile_fid, u32 pid,

224 loff_t new_eof);

225 extern int SMB2_set_info_init(struct cifs_tcon *tcon,

226 struct TCP_Server_Info *server,

227 struct smb_rqst *rqst,

228 u64 persistent_fid, u64 volatile_fid, u32 pid,

229 u8 info_class, u8 info_type, u32 additional_info,

230 void **data, unsigned int *size);

231 extern void SMB2_set_info_free(struct smb_rqst *rqst);

232 extern int SMB2_set_acl(const unsigned int xid, struct cifs_tcon *tcon,

233 u64 persistent_fid, u64 volatile_fid,

234 struct cifs_ntsd *pnntsd, int pacllen, int aclflag);

235 extern int SMB2_set_ea(const unsigned int xid, struct cifs_tcon *tcon,

236 u64 persistent_fid, u64 volatile_fid,

237 struct smb2_file_full_ea_info *buf, int len);

238 extern int SMB2_set_compression(const unsigned int xid, struct cifs_tcon *tcon,

239 u64 persistent_fid, u64 volatile_fid);

240 extern int SMB2_oplock_break(const unsigned int xid, struct cifs_tcon *tcon,

241 const u64 persistent_fid, const u64 volatile_fid,

242 const __u8 oplock_level);

243 extern int smb2_handle_cancelled_close(struct cifs_tcon *tcon,

244 __u64 persistent_fid,

245 __u64 volatile_fid);

246 extern int smb2_handle_cancelled_mid(struct mid_q_entry *mid, struct TCP_Server_Info *server);

247 void smb2_cancelled_close_fid(struct work_struct *work);

248 extern 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);

251 extern 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);

254 extern int SMB2_QFS_attr(const unsigned int xid, struct cifs_tcon *tcon,

255 u64 persistent_file_id, u64 volatile_file_id, int lvl);

256 extern 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);

260 extern 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);

264 extern int SMB2_lease_break(const unsigned int xid, struct cifs_tcon *tcon,

265 __u8 *lease_key, const __le32 lease_state);

266 extern int smb3_validate_negotiate(const unsigned int, struct cifs_tcon *);

267

268 extern enum securityEnum smb2_select_sectype(struct TCP_Server_Info *,

269 enum securityEnum);

270 int smb2_parse_contexts(struct TCP_Server_Info *server,

271 struct kvec *rsp_iov,

272 unsigned int *epoch,

273 char *lease_key, __u8 *oplock,

274 struct smb2_file_all_info *buf,

275 struct create_posix_rsp *posix);

276

277 extern int smb3_encryption_required(const struct cifs_tcon *tcon);

278 extern int smb2_validate_iov(unsigned int offset, unsigned int buffer_length,

279 struct kvec *iov, unsigned int min_buf_size);

280 extern int smb2_validate_and_copy_iov(unsigned int offset,

281 unsigned int buffer_length,

282 struct kvec *iov,

283 unsigned int minbufsize, char *data);

284 extern void smb2_copy_fs_info_to_kstatfs(

285 struct smb2_fs_full_size_info *pfs_inf,

286 struct kstatfs *kst);

287 extern int smb311_crypto_shash_allocate(struct TCP_Server_Info *server);

288 extern int smb311_update_preauth_hash(struct cifs_ses *ses,

289 struct TCP_Server_Info *server,

290 struct kvec *iov, int nvec);

291 extern int smb2_query_info_compound(const unsigned int xid,

292 struct cifs_tcon *tcon,

293 const char *path, u32 desired_access,

294 u32 class, u32 type, u32 output_len,

295 struct kvec *rsp, int *buftype,

296 struct cifs_sb_info *cifs_sb);

297 /* query path info from the server using SMB311 POSIX extensions*/

298 int smb311_posix_query_path_info(const unsigned int xid,

299 struct cifs_tcon *tcon,

300 struct cifs_sb_info *cifs_sb,

301 const char *full_path,

302 struct cifs_open_info_data *data);

303 int posix_info_parse(const void *beg, const void *end,

304 struct smb2_posix_info_parsed *out);

305 int posix_info_sid_size(const void *beg, const void *end);

306

307 #endif /* _SMB2PROTO_H */