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(const uint8_t *inbuf
)
53 /* Ignore non-session messages or non 0xFF'E' messages. */
55 || (smb_len(inbuf
) < 8)
56 || !(inbuf
[4] == 0xFF && inbuf
[5] == 'E')) {
60 status
= get_enc_ctx_num(inbuf
, &enc_num
);
61 if (!NT_STATUS_IS_OK(status
)) {
65 /* Encrypted messages are 0xFF'E'<ctx> */
66 if (srv_trans_enc_ctx
&& enc_num
== srv_enc_ctx(srv_trans_enc_ctx
)) {
72 /******************************************************************************
73 Create an gensec_security and ensure pointer copy is correct.
74 ******************************************************************************/
76 static NTSTATUS
make_auth_gensec(const struct tsocket_address
*remote_address
,
77 struct smb_trans_enc_state
*es
)
81 status
= auth_generic_prepare(es
, remote_address
,
82 &es
->gensec_security
);
83 if (!NT_STATUS_IS_OK(status
)) {
84 return nt_status_squash(status
);
87 gensec_want_feature(es
->gensec_security
, GENSEC_FEATURE_SEAL
);
90 * We could be accessing the secrets.tdb or krb5.keytab file here.
91 * ensure we have permissions to do so.
95 status
= gensec_start_mech_by_oid(es
->gensec_security
, GENSEC_OID_SPNEGO
);
99 if (!NT_STATUS_IS_OK(status
)) {
100 return nt_status_squash(status
);
106 /******************************************************************************
107 Create a server encryption context.
108 ******************************************************************************/
110 static NTSTATUS
make_srv_encryption_context(const struct tsocket_address
*remote_address
,
111 struct smb_trans_enc_state
**pp_es
)
114 struct smb_trans_enc_state
*es
;
118 ZERO_STRUCTP(partial_srv_trans_enc_ctx
);
119 es
= talloc_zero(NULL
, struct smb_trans_enc_state
);
121 return NT_STATUS_NO_MEMORY
;
123 status
= make_auth_gensec(remote_address
,
125 if (!NT_STATUS_IS_OK(status
)) {
133 /******************************************************************************
134 Free an encryption-allocated buffer.
135 ******************************************************************************/
137 void srv_free_enc_buffer(struct smbXsrv_connection
*xconn
, char *buf
)
139 /* We know this is an smb buffer, and we
140 * didn't malloc, only copy, for a keepalive,
141 * so ignore non-session messages. */
147 if (srv_trans_enc_ctx
) {
148 common_free_enc_buffer(srv_trans_enc_ctx
, buf
);
152 /******************************************************************************
153 Decrypt an incoming buffer.
154 ******************************************************************************/
156 NTSTATUS
srv_decrypt_buffer(struct smbXsrv_connection
*xconn
, char *buf
)
158 /* Ignore non-session messages. */
163 if (srv_trans_enc_ctx
) {
164 return common_decrypt_buffer(srv_trans_enc_ctx
, buf
);
170 /******************************************************************************
171 Encrypt an outgoing buffer. Return the encrypted pointer in buf_out.
172 ******************************************************************************/
174 NTSTATUS
srv_encrypt_buffer(struct smbXsrv_connection
*xconn
, char *buf
,
179 /* Ignore non-session messages. */
184 if (srv_trans_enc_ctx
) {
185 return common_encrypt_buffer(srv_trans_enc_ctx
, buf
, buf_out
);
187 /* Not encrypting. */
191 /******************************************************************************
192 Do the SPNEGO encryption negotiation. Parameters are in/out.
193 ******************************************************************************/
195 NTSTATUS
srv_request_encryption_setup(connection_struct
*conn
,
196 unsigned char **ppdata
,
198 unsigned char **pparam
,
199 size_t *p_param_size
)
202 DATA_BLOB blob
= data_blob_const(*ppdata
, *p_data_size
);
203 DATA_BLOB response
= data_blob_null
;
204 struct smb_trans_enc_state
*es
;
209 if (!partial_srv_trans_enc_ctx
) {
210 /* This is the initial step. */
211 status
= make_srv_encryption_context(conn
->sconn
->remote_address
,
212 &partial_srv_trans_enc_ctx
);
213 if (!NT_STATUS_IS_OK(status
)) {
218 es
= partial_srv_trans_enc_ctx
;
219 if (!es
|| es
->gensec_security
== NULL
) {
220 TALLOC_FREE(partial_srv_trans_enc_ctx
);
221 return NT_STATUS_INVALID_PARAMETER
;
226 status
= gensec_update(es
->gensec_security
,
230 if (!NT_STATUS_EQUAL(status
, NT_STATUS_MORE_PROCESSING_REQUIRED
) &&
231 !NT_STATUS_IS_OK(status
)) {
232 TALLOC_FREE(partial_srv_trans_enc_ctx
);
233 return nt_status_squash(status
);
236 if (NT_STATUS_IS_OK(status
)) {
237 /* Return the context we're using for this encryption state. */
238 if (!(*pparam
= SMB_MALLOC_ARRAY(unsigned char, 2))) {
239 return NT_STATUS_NO_MEMORY
;
241 SSVAL(*pparam
, 0, es
->enc_ctx_num
);
245 /* Return the raw blob. */
247 *ppdata
= (unsigned char *)smb_memdup(response
.data
, response
.length
);
248 if ((*ppdata
) == NULL
&& response
.length
> 0)
249 return NT_STATUS_NO_MEMORY
;
250 *p_data_size
= response
.length
;
251 data_blob_free(&response
);
255 /******************************************************************************
256 Negotiation was successful - turn on server-side encryption.
257 ******************************************************************************/
259 static NTSTATUS
check_enc_good(struct smb_trans_enc_state
*es
)
262 return NT_STATUS_LOGON_FAILURE
;
265 if (!gensec_have_feature(es
->gensec_security
, GENSEC_FEATURE_SIGN
)) {
266 return NT_STATUS_INVALID_PARAMETER
;
269 if (!gensec_have_feature(es
->gensec_security
, GENSEC_FEATURE_SEAL
)) {
270 return NT_STATUS_INVALID_PARAMETER
;
275 /******************************************************************************
276 Negotiation was successful - turn on server-side encryption.
277 ******************************************************************************/
279 NTSTATUS
srv_encryption_start(connection_struct
*conn
)
283 /* Check that we are really doing sign+seal. */
284 status
= check_enc_good(partial_srv_trans_enc_ctx
);
285 if (!NT_STATUS_IS_OK(status
)) {
288 /* Throw away the context we're using currently (if any). */
289 TALLOC_FREE(srv_trans_enc_ctx
);
291 /* Steal the partial pointer. Deliberate shallow copy. */
292 srv_trans_enc_ctx
= partial_srv_trans_enc_ctx
;
293 srv_trans_enc_ctx
->enc_on
= true;
295 partial_srv_trans_enc_ctx
= NULL
;
297 DEBUG(1,("srv_encryption_start: context negotiated\n"));
301 /******************************************************************************
302 Shutdown all server contexts.
303 ******************************************************************************/
305 void server_encryption_shutdown(struct smbXsrv_connection
*xconn
)
307 TALLOC_FREE(partial_srv_trans_enc_ctx
);
308 TALLOC_FREE(srv_trans_enc_ctx
);