xref: /illumos-gate/usr/src/uts/common/smbsrv/smb2_kproto.h (revision 8119dad84d6416f13557b0ba8e2aaf9064cbcfd3)
1 /*
2  * This file and its contents are supplied under the terms of the
3  * Common Development and Distribution License ("CDDL"), version 1.0.
4  * You may only use this file in accordance with the terms of version
5  * 1.0 of the CDDL.
6  *
7  * A full copy of the text of the CDDL should have accompanied this
8  * source.  A copy of the CDDL is also available via the Internet at
9  * http://www.illumos.org/license/CDDL.
10  */
11 
12 /*
13  * Copyright 2014-2021 Tintri by DDN, Inc. All rights reserved.
14  * Copyright 2020-2024 RackTop Systems, Inc.
15  */
16 
17 #ifndef _SMB2_KPROTO_H_
18 #define	_SMB2_KPROTO_H_
19 
20 #include <smbsrv/smb_kproto.h>
21 #include <smbsrv/smb2.h>
22 
23 #ifdef	__cplusplus
24 extern "C" {
25 #endif
26 
27 extern uint32_t smb2_tcp_rcvbuf;
28 extern uint32_t smb2_max_rwsize;
29 extern uint32_t smb2_max_trans;
30 
31 extern int smb2_aapl_use_file_ids;
32 extern uint32_t smb2_dh_def_timeout;
33 extern uint32_t smb2_dh_max_timeout;
34 extern uint32_t smb2_res_def_timeout;
35 extern uint32_t smb2_res_max_timeout;
36 extern uint32_t smb2_persist_timeout;
37 extern int smb2_enable_dh;
38 
39 #define	SMB3_CLIENT_ENCRYPTS(sr) \
40 	((sr->session->capabilities & SMB2_CAP_ENCRYPTION) != 0)
41 
42 void	smb2_dispatch_stats_init(smb_server_t *);
43 void	smb2_dispatch_stats_fini(smb_server_t *);
44 void	smb2_dispatch_stats_update(smb_server_t *,
45 		smb_kstat_req_t *, int, int);
46 
47 int	smb2sr_newrq(smb_request_t *);
48 void	smb2sr_work(smb_request_t *);
49 uint32_t smb2sr_go_async(smb_request_t *);
50 void smb2sr_append_postwork(smb_request_t *, smb_request_t *);
51 
52 int smb2_decode_header(smb_request_t *);
53 int smb2_encode_header(smb_request_t *, boolean_t);
54 
55 void smb2_send_reply(smb_request_t *);
56 void smb2sr_put_error(smb_request_t *, uint32_t);
57 void smb2sr_put_error_data(smb_request_t *, uint32_t, mbuf_chain_t *);
58 void smb2sr_put_error_ctx(smb_request_t *, uint32_t, uint32_t, mbuf_chain_t *);
59 void smb2sr_put_error_ctx0(smb_request_t *, uint32_t, mbuf_chain_t *);
60 void smb2sr_put_errno(struct smb_request *, int);
61 uint32_t smb2sr_lookup_fid(smb_request_t *, smb2fid_t *);
62 
63 /* SMB2 signing routines - smb2_signing.c */
64 int smb2_sign_check_request(smb_request_t *);
65 void smb2_sign_reply(smb_request_t *);
66 void smb2_sign_init_mech(smb_session_t *);
67 void smb31_preauth_init_mech(smb_session_t *);
68 void smb31_preauth_fini(smb_session_t *s);
69 int smb31_preauth_sha512_calc(smb_request_t *, struct mbuf_chain *,
70     uint8_t *, uint8_t *);
71 
72 int smb3_encrypt_sr(smb_request_t *, struct mbuf_chain *, struct mbuf_chain *);
73 int smb3_decrypt_sr(smb_request_t *, struct mbuf_chain *, struct mbuf_chain *);
74 int smb3_encrypt_init_mech(smb_session_t *s);
75 
76 uint32_t smb2_fsctl_fs(smb_request_t *, smb_fsctl_t *);
77 uint32_t smb2_fsctl_netfs(smb_request_t *, smb_fsctl_t *);
78 uint32_t smb2_fsctl_copychunk(smb_request_t *, smb_fsctl_t *);
79 uint32_t smb2_fsctl_odx_read(smb_request_t *, smb_fsctl_t *);
80 uint32_t smb2_fsctl_odx_write(smb_request_t *, smb_fsctl_t *);
81 uint32_t smb2_fsctl_set_resilient(smb_request_t *, smb_fsctl_t *);
82 
83 /* smb2_fsctl_sparse.c */
84 uint32_t smb2_fsctl_set_sparse(smb_request_t *, smb_fsctl_t *);
85 uint32_t smb2_fsctl_set_zero_data(smb_request_t *, smb_fsctl_t *);
86 uint32_t smb2_fsctl_query_alloc_ranges(smb_request_t *, smb_fsctl_t *);
87 uint32_t smb2_fsctl_query_file_regions(smb_request_t *, smb_fsctl_t *);
88 uint32_t smb2_sparse_copy(smb_request_t *sr,
89     smb_ofile_t *src_ofile, smb_ofile_t *dst_ofile,
90     off64_t src_off, off64_t dst_off, uint32_t *residp,
91     void *buffer, size_t bufsize);
92 
93 uint32_t smb2_nego_validate(smb_request_t *, smb_fsctl_t *);
94 
95 smb_sdrc_t smb2_negotiate(smb_request_t *);
96 smb_sdrc_t smb2_session_setup(smb_request_t *);
97 smb_sdrc_t smb2_logoff(smb_request_t *);
98 smb_sdrc_t smb2_tree_connect(smb_request_t *);
99 smb_sdrc_t smb2_tree_disconn(smb_request_t *);
100 smb_sdrc_t smb2_create(smb_request_t *);
101 smb_sdrc_t smb2_close(smb_request_t *);
102 smb_sdrc_t smb2_flush(smb_request_t *);
103 smb_sdrc_t smb2_read(smb_request_t *);
104 smb_sdrc_t smb2_write(smb_request_t *);
105 smb_sdrc_t smb2_lock(smb_request_t *);
106 smb_sdrc_t smb2_ioctl(smb_request_t *);
107 smb_sdrc_t smb2_cancel(smb_request_t *);
108 smb_sdrc_t smb2_echo(smb_request_t *);
109 smb_sdrc_t smb2_query_dir(smb_request_t *);
110 smb_sdrc_t smb2_change_notify(smb_request_t *);
111 smb_sdrc_t smb2_query_info(smb_request_t *);
112 smb_sdrc_t smb2_set_info(smb_request_t *);
113 smb_sdrc_t smb2_oplock_break_ack(smb_request_t *);
114 smb_sdrc_t smb2_lease_break_ack(smb_request_t *);
115 
116 int smb2_newrq_negotiate(smb_request_t *);
117 int smb2_newrq_cancel(smb_request_t *);
118 
119 uint32_t smb2_aapl_crctx(smb_request_t *,
120 	mbuf_chain_t *, mbuf_chain_t *);
121 
122 uint32_t smb2_ofile_getattr(smb_request_t *, smb_ofile_t *, smb_attr_t *);
123 uint32_t smb2_ofile_getstd(smb_ofile_t *, smb_queryinfo_t *);
124 uint32_t smb2_ofile_getname(smb_ofile_t *, smb_queryinfo_t *);
125 
126 uint32_t smb2_qinfo_file(smb_request_t *, smb_queryinfo_t *);
127 uint32_t smb2_qinfo_fs(smb_request_t *, smb_queryinfo_t *);
128 uint32_t smb2_qinfo_sec(smb_request_t *, smb_queryinfo_t *);
129 uint32_t smb2_qinfo_quota(smb_request_t *, smb_queryinfo_t *);
130 uint32_t smb2_qinfo_stream(smb_request_t *, smb_queryinfo_t *);
131 
132 uint32_t smb2_setinfo_file(smb_request_t *, smb_setinfo_t *, int);
133 uint32_t smb2_setinfo_fs(smb_request_t *, smb_setinfo_t *, int);
134 uint32_t smb2_setinfo_sec(smb_request_t *, smb_setinfo_t *, uint32_t);
135 uint32_t smb2_setinfo_quota(smb_request_t *, smb_setinfo_t *);
136 
137 void smb2_oplock_acquire(smb_request_t *sr);
138 void smb2_oplock_reconnect(smb_request_t *sr);
139 void smb2_lease_acquire(smb_request_t *sr);
140 uint32_t smb2_lease_create(smb_request_t *sr, uint8_t *);
141 void smb2_lease_rele(smb_lease_t *);
142 void smb2_lease_init(void);
143 void smb2_lease_fini(void);
144 void smb2_lease_ofile_close(smb_ofile_t *);
145 
146 void smb2_durable_timers(smb_server_t *);
147 
148 uint32_t smb2_dh_reconnect(smb_request_t *);
149 boolean_t smb_dh_should_save(smb_ofile_t *);
150 extern void smb2_dh_shutdown(smb_server_t *);
151 int smb2_dh_new_ca_share(smb_server_t *, smb_kshare_t *);
152 void smb2_dh_close_persistent(smb_ofile_t *);
153 void smb2_dh_close_my_orphans(smb_request_t *, smb_ofile_t *);
154 boolean_t smb_dh_create_allowed(smb_request_t *, smb_ofile_t *);
155 int smb2_dh_make_persistent(smb_request_t *, smb_ofile_t *);
156 void smb2_dh_setdoc_persistent(smb_ofile_t *);
157 void smb2_dh_update_nvfile(smb_request_t *);
158 void smb2_dh_update_oplock(smb_request_t *, smb_ofile_t *);
159 void smb2_dh_update_locks(smb_request_t *, smb_ofile_t *);
160 void smb2_dh_update_times(smb_request_t *, smb_ofile_t *, smb_attr_t *);
161 
162 #ifdef	__cplusplus
163 }
164 #endif
165 
166 #endif /* _SMB2_KPROTO_H_ */
167