2 Unix SMB/CIFS implementation.
3 SMB Transport encryption (sealing) code - server code.
4 Copyright (C) Jeremy Allison 2007.
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program. If not, see <http://www.gnu.org/licenses/>.
21 #include "smbd/smbd.h"
22 #include "smbd/globals.h"
23 #include "../libcli/auth/spnego.h"
24 #include "../libcli/smb/smb_seal.h"
25 #include "../lib/util/asn1.h"
27 #include "libsmb/libsmb.h"
28 #include "../lib/tsocket/tsocket.h"
29 #include "auth/gensec/gensec.h"
31 /******************************************************************************
32 Server side encryption.
33 ******************************************************************************/
35 /******************************************************************************
36 Return global enc context - this must change if we ever do multiple contexts.
37 ******************************************************************************/
39 static uint16_t srv_enc_ctx(const struct smb_trans_enc_state
*es
)
41 return es
->enc_ctx_num
;
44 /******************************************************************************
45 Is this an incoming encrypted packet ?
46 ******************************************************************************/
48 bool is_encrypted_packet(struct smbd_server_connection
*sconn
,
54 /* Ignore non-session messages or non 0xFF'E' messages. */
56 || (smb_len(inbuf
) < 8)
57 || !(inbuf
[4] == 0xFF && inbuf
[5] == 'E')) {
61 status
= get_enc_ctx_num(inbuf
, &enc_num
);
62 if (!NT_STATUS_IS_OK(status
)) {
66 /* Encrypted messages are 0xFF'E'<ctx> */
67 if (srv_trans_enc_ctx
&& enc_num
== srv_enc_ctx(srv_trans_enc_ctx
)) {
73 /******************************************************************************
74 Create an gensec_security and ensure pointer copy is correct.
75 ******************************************************************************/
77 static NTSTATUS
make_auth_gensec(const struct tsocket_address
*remote_address
,
78 struct smb_trans_enc_state
*es
)
80 struct gensec_security
*gensec_security
;
83 status
= auth_generic_prepare(NULL
, remote_address
,
85 if (!NT_STATUS_IS_OK(status
)) {
86 return nt_status_squash(status
);
89 gensec_want_feature(gensec_security
, GENSEC_FEATURE_SEAL
);
92 * We could be accessing the secrets.tdb or krb5.keytab file here.
93 * ensure we have permissions to do so.
97 status
= gensec_start_mech_by_oid(gensec_security
, GENSEC_OID_SPNEGO
);
101 if (!NT_STATUS_IS_OK(status
)) {
102 TALLOC_FREE(gensec_security
);
103 return nt_status_squash(status
);
106 es
->gensec_security
= gensec_security
;
111 /******************************************************************************
112 Shutdown a server encryption context.
113 ******************************************************************************/
115 static void srv_free_encryption_context(struct smb_trans_enc_state
**pp_es
)
117 struct smb_trans_enc_state
*es
= *pp_es
;
123 common_free_encryption_state(&es
);
129 /******************************************************************************
130 Create a server encryption context.
131 ******************************************************************************/
133 static NTSTATUS
make_srv_encryption_context(const struct tsocket_address
*remote_address
,
134 struct smb_trans_enc_state
**pp_es
)
137 struct smb_trans_enc_state
*es
;
141 ZERO_STRUCTP(partial_srv_trans_enc_ctx
);
142 es
= SMB_MALLOC_P(struct smb_trans_enc_state
);
144 return NT_STATUS_NO_MEMORY
;
147 status
= make_auth_gensec(remote_address
,
149 if (!NT_STATUS_IS_OK(status
)) {
150 srv_free_encryption_context(&es
);
157 /******************************************************************************
158 Free an encryption-allocated buffer.
159 ******************************************************************************/
161 void srv_free_enc_buffer(struct smbd_server_connection
*sconn
, char *buf
)
163 /* We know this is an smb buffer, and we
164 * didn't malloc, only copy, for a keepalive,
165 * so ignore non-session messages. */
171 if (srv_trans_enc_ctx
) {
172 common_free_enc_buffer(srv_trans_enc_ctx
, buf
);
176 /******************************************************************************
177 Decrypt an incoming buffer.
178 ******************************************************************************/
180 NTSTATUS
srv_decrypt_buffer(struct smbd_server_connection
*sconn
, char *buf
)
182 /* Ignore non-session messages. */
187 if (srv_trans_enc_ctx
) {
188 return common_decrypt_buffer(srv_trans_enc_ctx
, buf
);
194 /******************************************************************************
195 Encrypt an outgoing buffer. Return the encrypted pointer in buf_out.
196 ******************************************************************************/
198 NTSTATUS
srv_encrypt_buffer(struct smbd_server_connection
*sconn
, char *buf
,
203 /* Ignore non-session messages. */
208 if (srv_trans_enc_ctx
) {
209 return common_encrypt_buffer(srv_trans_enc_ctx
, buf
, buf_out
);
211 /* Not encrypting. */
215 /******************************************************************************
216 Do the SPNEGO encryption negotiation. Parameters are in/out.
217 ******************************************************************************/
219 NTSTATUS
srv_request_encryption_setup(connection_struct
*conn
,
220 unsigned char **ppdata
,
222 unsigned char **pparam
,
223 size_t *p_param_size
)
226 DATA_BLOB blob
= data_blob_const(*ppdata
, *p_data_size
);
227 DATA_BLOB response
= data_blob_null
;
228 struct smb_trans_enc_state
*es
;
233 if (!partial_srv_trans_enc_ctx
) {
234 /* This is the initial step. */
235 status
= make_srv_encryption_context(conn
->sconn
->remote_address
,
236 &partial_srv_trans_enc_ctx
);
237 if (!NT_STATUS_IS_OK(status
)) {
242 es
= partial_srv_trans_enc_ctx
;
243 if (!es
|| es
->gensec_security
== NULL
) {
244 srv_free_encryption_context(&partial_srv_trans_enc_ctx
);
245 return NT_STATUS_INVALID_PARAMETER
;
250 status
= gensec_update(es
->gensec_security
,
254 if (!NT_STATUS_EQUAL(status
, NT_STATUS_MORE_PROCESSING_REQUIRED
) &&
255 !NT_STATUS_IS_OK(status
)) {
256 srv_free_encryption_context(&partial_srv_trans_enc_ctx
);
257 return nt_status_squash(status
);
260 if (NT_STATUS_IS_OK(status
)) {
261 /* Return the context we're using for this encryption state. */
262 if (!(*pparam
= SMB_MALLOC_ARRAY(unsigned char, 2))) {
263 return NT_STATUS_NO_MEMORY
;
265 SSVAL(*pparam
, 0, es
->enc_ctx_num
);
269 /* Return the raw blob. */
271 *ppdata
= (unsigned char *)memdup(response
.data
, response
.length
);
272 if ((*ppdata
) == NULL
&& response
.length
> 0)
273 return NT_STATUS_NO_MEMORY
;
274 *p_data_size
= response
.length
;
275 data_blob_free(&response
);
279 /******************************************************************************
280 Negotiation was successful - turn on server-side encryption.
281 ******************************************************************************/
283 static NTSTATUS
check_enc_good(struct smb_trans_enc_state
*es
)
286 return NT_STATUS_LOGON_FAILURE
;
289 if (!gensec_have_feature(es
->gensec_security
, GENSEC_FEATURE_SIGN
)) {
290 return NT_STATUS_INVALID_PARAMETER
;
293 if (!gensec_have_feature(es
->gensec_security
, GENSEC_FEATURE_SEAL
)) {
294 return NT_STATUS_INVALID_PARAMETER
;
299 /******************************************************************************
300 Negotiation was successful - turn on server-side encryption.
301 ******************************************************************************/
303 NTSTATUS
srv_encryption_start(connection_struct
*conn
)
307 /* Check that we are really doing sign+seal. */
308 status
= check_enc_good(partial_srv_trans_enc_ctx
);
309 if (!NT_STATUS_IS_OK(status
)) {
312 /* Throw away the context we're using currently (if any). */
313 srv_free_encryption_context(&srv_trans_enc_ctx
);
315 /* Steal the partial pointer. Deliberate shallow copy. */
316 srv_trans_enc_ctx
= partial_srv_trans_enc_ctx
;
317 srv_trans_enc_ctx
->enc_on
= true;
319 partial_srv_trans_enc_ctx
= NULL
;
321 DEBUG(1,("srv_encryption_start: context negotiated\n"));
325 /******************************************************************************
326 Shutdown all server contexts.
327 ******************************************************************************/
329 void server_encryption_shutdown(struct smbd_server_connection
*sconn
)
331 srv_free_encryption_context(&partial_srv_trans_enc_ctx
);
332 srv_free_encryption_context(&srv_trans_enc_ctx
);