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/>.
22 /******************************************************************************
23 Server side encryption.
24 ******************************************************************************/
26 /******************************************************************************
28 ******************************************************************************/
30 struct smb_srv_trans_enc_ctx
{
31 struct smb_trans_enc_state
*es
;
32 AUTH_NTLMSSP_STATE
*auth_ntlmssp_state
; /* Must be kept in sync with pointer in ec->ntlmssp_state. */
35 static struct smb_srv_trans_enc_ctx
*partial_srv_trans_enc_ctx
;
36 static struct smb_srv_trans_enc_ctx
*srv_trans_enc_ctx
;
38 /******************************************************************************
39 Return global enc context - this must change if we ever do multiple contexts.
40 ******************************************************************************/
42 uint16_t srv_enc_ctx(void)
44 return srv_trans_enc_ctx
->es
->enc_ctx_num
;
47 /******************************************************************************
48 Is this an incoming encrypted packet ?
49 ******************************************************************************/
51 bool is_encrypted_packet(const uint8_t *inbuf
)
56 /* Ignore non-session messages or non 0xFF'E' messages. */
57 if(CVAL(inbuf
,0) || !(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()) {
73 /******************************************************************************
74 Create an auth_ntlmssp_state and ensure pointer copy is correct.
75 ******************************************************************************/
77 static NTSTATUS
make_auth_ntlmssp(struct smb_srv_trans_enc_ctx
*ec
)
79 NTSTATUS status
= auth_ntlmssp_start(&ec
->auth_ntlmssp_state
);
80 if (!NT_STATUS_IS_OK(status
)) {
81 return nt_status_squash(status
);
85 * We must remember to update the pointer copy for the common
86 * functions after any auth_ntlmssp_start/auth_ntlmssp_end.
88 ec
->es
->s
.ntlmssp_state
= ec
->auth_ntlmssp_state
->ntlmssp_state
;
92 /******************************************************************************
93 Destroy an auth_ntlmssp_state and ensure pointer copy is correct.
94 ******************************************************************************/
96 static void destroy_auth_ntlmssp(struct smb_srv_trans_enc_ctx
*ec
)
99 * We must remember to update the pointer copy for the common
100 * functions after any auth_ntlmssp_start/auth_ntlmssp_end.
103 if (ec
->auth_ntlmssp_state
) {
104 auth_ntlmssp_end(&ec
->auth_ntlmssp_state
);
105 /* The auth_ntlmssp_end killed this already. */
106 ec
->es
->s
.ntlmssp_state
= NULL
;
110 #if defined(HAVE_GSSAPI) && defined(HAVE_KRB5)
112 /******************************************************************************
114 ******************************************************************************/
116 static NTSTATUS
get_srv_gss_creds(const char *service
,
118 gss_cred_usage_t cred_type
,
119 gss_cred_id_t
*p_srv_cred
)
124 gss_buffer_desc input_name
;
125 char *host_princ_s
= NULL
;
126 NTSTATUS status
= NT_STATUS_OK
;
128 gss_OID_desc nt_hostbased_service
=
129 {10, CONST_DISCARD(char *,"\x2a\x86\x48\x86\xf7\x12\x01\x02\x01\x04")};
131 if (asprintf(&host_princ_s
, "%s@%s", service
, name
) == -1) {
132 return NT_STATUS_NO_MEMORY
;
135 input_name
.value
= host_princ_s
;
136 input_name
.length
= strlen(host_princ_s
) + 1;
138 ret
= gss_import_name(&min
,
140 &nt_hostbased_service
,
143 DEBUG(10,("get_srv_gss_creds: imported name %s\n",
146 if (ret
!= GSS_S_COMPLETE
) {
147 SAFE_FREE(host_princ_s
);
148 return map_nt_error_from_gss(ret
, min
);
152 * We're accessing the krb5.keytab file here.
153 * ensure we have permissions to do so.
157 ret
= gss_acquire_cred(&min
,
167 if (ret
!= GSS_S_COMPLETE
) {
168 ADS_STATUS adss
= ADS_ERROR_GSS(ret
, min
);
169 DEBUG(10,("get_srv_gss_creds: gss_acquire_cred failed with %s\n",
171 status
= map_nt_error_from_gss(ret
, min
);
174 SAFE_FREE(host_princ_s
);
175 gss_release_name(&min
, &srv_name
);
179 /******************************************************************************
181 Try and get the cifs/server@realm principal first, then fall back to
183 ******************************************************************************/
185 static NTSTATUS
make_auth_gss(struct smb_srv_trans_enc_ctx
*ec
)
188 gss_cred_id_t srv_cred
;
191 name_to_fqdn(fqdn
, global_myname());
194 status
= get_srv_gss_creds("cifs", fqdn
, GSS_C_ACCEPT
, &srv_cred
);
195 if (!NT_STATUS_IS_OK(status
)) {
196 status
= get_srv_gss_creds("host", fqdn
, GSS_C_ACCEPT
, &srv_cred
);
197 if (!NT_STATUS_IS_OK(status
)) {
198 return nt_status_squash(status
);
202 ec
->es
->s
.gss_state
= SMB_MALLOC_P(struct smb_tran_enc_state_gss
);
203 if (!ec
->es
->s
.gss_state
) {
205 gss_release_cred(&min
, &srv_cred
);
206 return NT_STATUS_NO_MEMORY
;
208 ZERO_STRUCTP(ec
->es
->s
.gss_state
);
209 ec
->es
->s
.gss_state
->creds
= srv_cred
;
211 /* No context yet. */
212 ec
->es
->s
.gss_state
->gss_ctx
= GSS_C_NO_CONTEXT
;
218 /******************************************************************************
219 Shutdown a server encryption context.
220 ******************************************************************************/
222 static void srv_free_encryption_context(struct smb_srv_trans_enc_ctx
**pp_ec
)
224 struct smb_srv_trans_enc_ctx
*ec
= *pp_ec
;
231 switch (ec
->es
->smb_enc_type
) {
232 case SMB_TRANS_ENC_NTLM
:
233 destroy_auth_ntlmssp(ec
);
235 #if defined(HAVE_GSSAPI) && defined(HAVE_KRB5)
236 case SMB_TRANS_ENC_GSS
:
240 common_free_encryption_state(&ec
->es
);
247 /******************************************************************************
248 Create a server encryption context.
249 ******************************************************************************/
251 static NTSTATUS
make_srv_encryption_context(enum smb_trans_enc_type smb_enc_type
, struct smb_srv_trans_enc_ctx
**pp_ec
)
253 struct smb_srv_trans_enc_ctx
*ec
;
257 ec
= SMB_MALLOC_P(struct smb_srv_trans_enc_ctx
);
259 return NT_STATUS_NO_MEMORY
;
261 ZERO_STRUCTP(partial_srv_trans_enc_ctx
);
262 ec
->es
= SMB_MALLOC_P(struct smb_trans_enc_state
);
265 return NT_STATUS_NO_MEMORY
;
267 ZERO_STRUCTP(ec
->es
);
268 ec
->es
->smb_enc_type
= smb_enc_type
;
269 switch (smb_enc_type
) {
270 case SMB_TRANS_ENC_NTLM
:
272 NTSTATUS status
= make_auth_ntlmssp(ec
);
273 if (!NT_STATUS_IS_OK(status
)) {
274 srv_free_encryption_context(&ec
);
280 #if defined(HAVE_GSSAPI) && defined(HAVE_KRB5)
281 case SMB_TRANS_ENC_GSS
:
282 /* Acquire our credentials by calling gss_acquire_cred here. */
284 NTSTATUS status
= make_auth_gss(ec
);
285 if (!NT_STATUS_IS_OK(status
)) {
286 srv_free_encryption_context(&ec
);
293 srv_free_encryption_context(&ec
);
294 return NT_STATUS_INVALID_PARAMETER
;
300 /******************************************************************************
301 Free an encryption-allocated buffer.
302 ******************************************************************************/
304 void srv_free_enc_buffer(char *buf
)
306 /* We know this is an smb buffer, and we
307 * didn't malloc, only copy, for a keepalive,
308 * so ignore non-session messages. */
314 if (srv_trans_enc_ctx
) {
315 common_free_enc_buffer(srv_trans_enc_ctx
->es
, buf
);
319 /******************************************************************************
320 Decrypt an incoming buffer.
321 ******************************************************************************/
323 NTSTATUS
srv_decrypt_buffer(char *buf
)
325 /* Ignore non-session messages. */
330 if (srv_trans_enc_ctx
) {
331 return common_decrypt_buffer(srv_trans_enc_ctx
->es
, buf
);
337 /******************************************************************************
338 Encrypt an outgoing buffer. Return the encrypted pointer in buf_out.
339 ******************************************************************************/
341 NTSTATUS
srv_encrypt_buffer(char *buf
, char **buf_out
)
345 /* Ignore non-session messages. */
350 if (srv_trans_enc_ctx
) {
351 return common_encrypt_buffer(srv_trans_enc_ctx
->es
, buf
, buf_out
);
353 /* Not encrypting. */
357 /******************************************************************************
358 Do the gss encryption negotiation. Parameters are in/out.
359 Until success we do everything on the partial enc ctx.
360 ******************************************************************************/
362 #if defined(HAVE_GSSAPI) && defined(HAVE_KRB5)
363 static NTSTATUS
srv_enc_spnego_gss_negotiate(unsigned char **ppdata
, size_t *p_data_size
, DATA_BLOB secblob
)
368 gss_buffer_desc in_buf
, out_buf
;
369 struct smb_tran_enc_state_gss
*gss_state
;
370 DATA_BLOB auth_reply
= data_blob_null
;
371 DATA_BLOB response
= data_blob_null
;
374 if (!partial_srv_trans_enc_ctx
) {
375 status
= make_srv_encryption_context(SMB_TRANS_ENC_GSS
, &partial_srv_trans_enc_ctx
);
376 if (!NT_STATUS_IS_OK(status
)) {
381 gss_state
= partial_srv_trans_enc_ctx
->es
->s
.gss_state
;
383 in_buf
.value
= secblob
.data
;
384 in_buf
.length
= secblob
.length
;
386 out_buf
.value
= NULL
;
391 ret
= gss_accept_sec_context(&min
,
395 GSS_C_NO_CHANNEL_BINDINGS
,
397 NULL
, /* Ignore oids. */
398 &out_buf
, /* To return. */
400 NULL
, /* Ingore time. */
401 NULL
); /* Ignore delegated creds. */
404 status
= gss_err_to_ntstatus(ret
, min
);
405 if (ret
!= GSS_S_COMPLETE
&& ret
!= GSS_S_CONTINUE_NEEDED
) {
409 /* Ensure we've got sign+seal available. */
410 if (ret
== GSS_S_COMPLETE
) {
411 if ((flags
& (GSS_C_INTEG_FLAG
|GSS_C_CONF_FLAG
|GSS_C_REPLAY_FLAG
|GSS_C_SEQUENCE_FLAG
)) !=
412 (GSS_C_INTEG_FLAG
|GSS_C_CONF_FLAG
|GSS_C_REPLAY_FLAG
|GSS_C_SEQUENCE_FLAG
)) {
413 DEBUG(0,("srv_enc_spnego_gss_negotiate: quality of service not good enough "
414 "for SMB sealing.\n"));
415 gss_release_buffer(&min
, &out_buf
);
416 return NT_STATUS_ACCESS_DENIED
;
420 auth_reply
= data_blob(out_buf
.value
, out_buf
.length
);
421 gss_release_buffer(&min
, &out_buf
);
423 /* Wrap in SPNEGO. */
424 response
= spnego_gen_auth_response(&auth_reply
, status
, OID_KERBEROS5
);
425 data_blob_free(&auth_reply
);
428 *ppdata
= response
.data
;
429 *p_data_size
= response
.length
;
435 /******************************************************************************
436 Do the NTLM SPNEGO (or raw) encryption negotiation. Parameters are in/out.
437 Until success we do everything on the partial enc ctx.
438 ******************************************************************************/
440 static NTSTATUS
srv_enc_ntlm_negotiate(unsigned char **ppdata
, size_t *p_data_size
, DATA_BLOB secblob
, bool spnego_wrap
)
443 DATA_BLOB chal
= data_blob_null
;
444 DATA_BLOB response
= data_blob_null
;
446 status
= make_srv_encryption_context(SMB_TRANS_ENC_NTLM
, &partial_srv_trans_enc_ctx
);
447 if (!NT_STATUS_IS_OK(status
)) {
451 status
= auth_ntlmssp_update(partial_srv_trans_enc_ctx
->auth_ntlmssp_state
, secblob
, &chal
);
453 /* status here should be NT_STATUS_MORE_PROCESSING_REQUIRED
457 response
= spnego_gen_auth_response(&chal
, status
, OID_NTLMSSP
);
458 data_blob_free(&chal
);
460 /* Return the raw blob. */
465 *ppdata
= response
.data
;
466 *p_data_size
= response
.length
;
470 /******************************************************************************
471 Do the SPNEGO encryption negotiation. Parameters are in/out.
472 Based off code in smbd/sesssionsetup.c
473 Until success we do everything on the partial enc ctx.
474 ******************************************************************************/
476 static NTSTATUS
srv_enc_spnego_negotiate(connection_struct
*conn
,
477 unsigned char **ppdata
,
479 unsigned char **pparam
,
480 size_t *p_param_size
)
483 DATA_BLOB blob
= data_blob_null
;
484 DATA_BLOB secblob
= data_blob_null
;
485 char *kerb_mech
= NULL
;
487 blob
= data_blob_const(*ppdata
, *p_data_size
);
489 status
= parse_spnego_mechanisms(blob
, &secblob
, &kerb_mech
);
490 if (!NT_STATUS_IS_OK(status
)) {
491 return nt_status_squash(status
);
494 /* We should have no partial context at this point. */
496 srv_free_encryption_context(&partial_srv_trans_enc_ctx
);
499 SAFE_FREE(kerb_mech
);
501 #if defined(HAVE_GSSAPI) && defined(HAVE_KRB5)
502 status
= srv_enc_spnego_gss_negotiate(ppdata
, p_data_size
, secblob
);
504 /* Currently we don't SPNEGO negotiate
505 * back to NTLMSSP as we do in sessionsetupX. We should... */
506 return NT_STATUS_LOGON_FAILURE
;
509 status
= srv_enc_ntlm_negotiate(ppdata
, p_data_size
, secblob
, true);
512 data_blob_free(&secblob
);
514 if (!NT_STATUS_EQUAL(status
,NT_STATUS_MORE_PROCESSING_REQUIRED
) && !NT_STATUS_IS_OK(status
)) {
515 srv_free_encryption_context(&partial_srv_trans_enc_ctx
);
516 return nt_status_squash(status
);
519 if (NT_STATUS_IS_OK(status
)) {
520 /* Return the context we're using for this encryption state. */
521 if (!(*pparam
= SMB_MALLOC_ARRAY(unsigned char, 2))) {
522 return NT_STATUS_NO_MEMORY
;
524 SSVAL(*pparam
,0,partial_srv_trans_enc_ctx
->es
->enc_ctx_num
);
531 /******************************************************************************
532 Complete a SPNEGO encryption negotiation. Parameters are in/out.
533 We only get this for a NTLM auth second stage.
534 ******************************************************************************/
536 static NTSTATUS
srv_enc_spnego_ntlm_auth(connection_struct
*conn
,
537 unsigned char **ppdata
,
539 unsigned char **pparam
,
540 size_t *p_param_size
)
543 DATA_BLOB blob
= data_blob_null
;
544 DATA_BLOB auth
= data_blob_null
;
545 DATA_BLOB auth_reply
= data_blob_null
;
546 DATA_BLOB response
= data_blob_null
;
547 struct smb_srv_trans_enc_ctx
*ec
= partial_srv_trans_enc_ctx
;
549 /* We must have a partial context here. */
551 if (!ec
|| !ec
->es
|| ec
->auth_ntlmssp_state
== NULL
|| ec
->es
->smb_enc_type
!= SMB_TRANS_ENC_NTLM
) {
552 srv_free_encryption_context(&partial_srv_trans_enc_ctx
);
553 return NT_STATUS_INVALID_PARAMETER
;
556 blob
= data_blob_const(*ppdata
, *p_data_size
);
557 if (!spnego_parse_auth(blob
, &auth
)) {
558 srv_free_encryption_context(&partial_srv_trans_enc_ctx
);
559 return NT_STATUS_INVALID_PARAMETER
;
562 status
= auth_ntlmssp_update(ec
->auth_ntlmssp_state
, auth
, &auth_reply
);
563 data_blob_free(&auth
);
569 * This field SHALL only be present in the first reply from the
571 * So set mechOID to NULL here.
574 response
= spnego_gen_auth_response(&auth_reply
, status
, NULL
);
575 data_blob_free(&auth_reply
);
577 if (NT_STATUS_IS_OK(status
)) {
578 /* Return the context we're using for this encryption state. */
579 if (!(*pparam
= SMB_MALLOC_ARRAY(unsigned char, 2))) {
580 return NT_STATUS_NO_MEMORY
;
582 SSVAL(*pparam
,0,ec
->es
->enc_ctx_num
);
587 *ppdata
= response
.data
;
588 *p_data_size
= response
.length
;
592 /******************************************************************************
593 Raw NTLM encryption negotiation. Parameters are in/out.
594 This function does both steps.
595 ******************************************************************************/
597 static NTSTATUS
srv_enc_raw_ntlm_auth(connection_struct
*conn
,
598 unsigned char **ppdata
,
600 unsigned char **pparam
,
601 size_t *p_param_size
)
604 DATA_BLOB blob
= data_blob_const(*ppdata
, *p_data_size
);
605 DATA_BLOB response
= data_blob_null
;
606 struct smb_srv_trans_enc_ctx
*ec
;
608 if (!partial_srv_trans_enc_ctx
) {
609 /* This is the initial step. */
610 status
= srv_enc_ntlm_negotiate(ppdata
, p_data_size
, blob
, false);
611 if (!NT_STATUS_EQUAL(status
,NT_STATUS_MORE_PROCESSING_REQUIRED
) && !NT_STATUS_IS_OK(status
)) {
612 srv_free_encryption_context(&partial_srv_trans_enc_ctx
);
613 return nt_status_squash(status
);
618 ec
= partial_srv_trans_enc_ctx
;
619 if (!ec
|| !ec
->es
|| ec
->auth_ntlmssp_state
== NULL
|| ec
->es
->smb_enc_type
!= SMB_TRANS_ENC_NTLM
) {
620 srv_free_encryption_context(&partial_srv_trans_enc_ctx
);
621 return NT_STATUS_INVALID_PARAMETER
;
625 status
= auth_ntlmssp_update(partial_srv_trans_enc_ctx
->auth_ntlmssp_state
, blob
, &response
);
627 if (NT_STATUS_IS_OK(status
)) {
628 /* Return the context we're using for this encryption state. */
629 if (!(*pparam
= SMB_MALLOC_ARRAY(unsigned char, 2))) {
630 return NT_STATUS_NO_MEMORY
;
632 SSVAL(*pparam
,0,ec
->es
->enc_ctx_num
);
636 /* Return the raw blob. */
638 *ppdata
= response
.data
;
639 *p_data_size
= response
.length
;
643 /******************************************************************************
644 Do the SPNEGO encryption negotiation. Parameters are in/out.
645 ******************************************************************************/
647 NTSTATUS
srv_request_encryption_setup(connection_struct
*conn
,
648 unsigned char **ppdata
,
650 unsigned char **pparam
,
651 size_t *p_param_size
)
653 unsigned char *pdata
= *ppdata
;
658 if (*p_data_size
< 1) {
659 return NT_STATUS_INVALID_PARAMETER
;
662 if (pdata
[0] == ASN1_APPLICATION(0)) {
663 /* its a negTokenTarg packet */
664 return srv_enc_spnego_negotiate(conn
, ppdata
, p_data_size
, pparam
, p_param_size
);
667 if (pdata
[0] == ASN1_CONTEXT(1)) {
668 /* It's an auth packet */
669 return srv_enc_spnego_ntlm_auth(conn
, ppdata
, p_data_size
, pparam
, p_param_size
);
672 /* Maybe it's a raw unwrapped auth ? */
673 if (*p_data_size
< 7) {
674 return NT_STATUS_INVALID_PARAMETER
;
677 if (strncmp((char *)pdata
, "NTLMSSP", 7) == 0) {
678 return srv_enc_raw_ntlm_auth(conn
, ppdata
, p_data_size
, pparam
, p_param_size
);
681 DEBUG(1,("srv_request_encryption_setup: Unknown packet\n"));
683 return NT_STATUS_LOGON_FAILURE
;
686 /******************************************************************************
687 Negotiation was successful - turn on server-side encryption.
688 ******************************************************************************/
690 static NTSTATUS
check_enc_good(struct smb_srv_trans_enc_ctx
*ec
)
692 if (!ec
|| !ec
->es
) {
693 return NT_STATUS_LOGON_FAILURE
;
696 if (ec
->es
->smb_enc_type
== SMB_TRANS_ENC_NTLM
) {
697 if ((ec
->es
->s
.ntlmssp_state
->neg_flags
& (NTLMSSP_NEGOTIATE_SIGN
|NTLMSSP_NEGOTIATE_SEAL
)) !=
698 (NTLMSSP_NEGOTIATE_SIGN
|NTLMSSP_NEGOTIATE_SEAL
)) {
699 return NT_STATUS_INVALID_PARAMETER
;
702 /* Todo - check gssapi case. */
707 /******************************************************************************
708 Negotiation was successful - turn on server-side encryption.
709 ******************************************************************************/
711 NTSTATUS
srv_encryption_start(connection_struct
*conn
)
715 /* Check that we are really doing sign+seal. */
716 status
= check_enc_good(partial_srv_trans_enc_ctx
);
717 if (!NT_STATUS_IS_OK(status
)) {
720 /* Throw away the context we're using currently (if any). */
721 srv_free_encryption_context(&srv_trans_enc_ctx
);
723 /* Steal the partial pointer. Deliberate shallow copy. */
724 srv_trans_enc_ctx
= partial_srv_trans_enc_ctx
;
725 srv_trans_enc_ctx
->es
->enc_on
= true;
727 partial_srv_trans_enc_ctx
= NULL
;
729 DEBUG(1,("srv_encryption_start: context negotiated\n"));
733 /******************************************************************************
734 Shutdown all server contexts.
735 ******************************************************************************/
737 void server_encryption_shutdown(void)
739 srv_free_encryption_context(&partial_srv_trans_enc_ctx
);
740 srv_free_encryption_context(&srv_trans_enc_ctx
);