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 2 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, write to the Free Software
18 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23 /******************************************************************************
24 Server side encryption.
25 ******************************************************************************/
27 /******************************************************************************
29 ******************************************************************************/
31 struct smb_srv_trans_enc_ctx {
32 struct smb_trans_enc_state *es;
33 AUTH_NTLMSSP_STATE *auth_ntlmssp_state; /* Must be kept in sync with pointer in ec->ntlmssp_state. */
36 static struct smb_srv_trans_enc_ctx *partial_srv_trans_enc_ctx;
37 static struct smb_srv_trans_enc_ctx *srv_trans_enc_ctx;
39 /******************************************************************************
40 Is server encryption on ?
41 ******************************************************************************/
43 BOOL srv_encryption_on(void)
45 if (srv_trans_enc_ctx) {
46 return common_encryption_on(srv_trans_enc_ctx->es);
51 /******************************************************************************
52 Create an auth_ntlmssp_state and ensure pointer copy is correct.
53 ******************************************************************************/
55 static NTSTATUS make_auth_ntlmssp(struct smb_srv_trans_enc_ctx *ec)
57 NTSTATUS status = auth_ntlmssp_start(&ec->auth_ntlmssp_state);
58 if (!NT_STATUS_IS_OK(status)) {
59 return nt_status_squash(status);
63 * We must remember to update the pointer copy for the common
64 * functions after any auth_ntlmssp_start/auth_ntlmssp_end.
66 ec->es->s.ntlmssp_state = ec->auth_ntlmssp_state->ntlmssp_state;
70 /******************************************************************************
71 Destroy an auth_ntlmssp_state and ensure pointer copy is correct.
72 ******************************************************************************/
74 static void destroy_auth_ntlmssp(struct smb_srv_trans_enc_ctx *ec)
77 * We must remember to update the pointer copy for the common
78 * functions after any auth_ntlmssp_start/auth_ntlmssp_end.
81 if (ec->auth_ntlmssp_state) {
82 auth_ntlmssp_end(&ec->auth_ntlmssp_state);
83 /* The auth_ntlmssp_end killed this already. */
84 ec->es->s.ntlmssp_state = NULL;
88 #if defined(HAVE_GSSAPI) && defined(HAVE_KRB5)
90 /******************************************************************************
92 ******************************************************************************/
94 static NTSTATUS get_srv_gss_creds(const char *service,
96 gss_cred_usage_t cred_type,
97 gss_cred_id_t *p_srv_cred)
102 gss_buffer_desc input_name;
103 char *host_princ_s = NULL;
104 NTSTATUS status = NT_STATUS_OK;
106 gss_OID_desc nt_hostbased_service =
107 {10, CONST_DISCARD(char *,"\x2a\x86\x48\x86\xf7\x12\x01\x02\x01\x04")};
109 asprintf(&host_princ_s, "%s@%s", service, name);
110 if (host_princ_s == NULL) {
111 return NT_STATUS_NO_MEMORY;
114 input_name.value = host_princ_s;
115 input_name.length = strlen(host_princ_s) + 1;
117 ret = gss_import_name(&min,
119 &nt_hostbased_service,
122 DEBUG(10,("get_srv_gss_creds: imported name %s\n",
125 if (ret != GSS_S_COMPLETE) {
126 SAFE_FREE(host_princ_s);
127 return map_nt_error_from_gss(ret, min);
130 ret = gss_acquire_cred(&min,
139 if (ret != GSS_S_COMPLETE) {
140 ADS_STATUS adss = ADS_ERROR_GSS(ret, min);
141 DEBUG(10,("get_srv_gss_creds: gss_acquire_cred failed with %s\n",
143 status = map_nt_error_from_gss(ret, min);
146 SAFE_FREE(host_princ_s);
147 gss_release_name(&min, &srv_name);
151 /******************************************************************************
153 Try and get the cifs/server@realm principal first, then fall back to
155 ******************************************************************************/
157 static NTSTATUS make_auth_gss(struct smb_srv_trans_enc_ctx *ec)
160 gss_cred_id_t srv_cred;
163 name_to_fqdn(fqdn, global_myname());
166 status = get_srv_gss_creds("cifs", fqdn, GSS_C_ACCEPT, &srv_cred);
167 if (!NT_STATUS_IS_OK(status)) {
168 status = get_srv_gss_creds("host", fqdn, GSS_C_ACCEPT, &srv_cred);
169 if (!NT_STATUS_IS_OK(status)) {
170 return nt_status_squash(status);
174 ec->es->s.gss_state = SMB_MALLOC_P(struct smb_tran_enc_state_gss);
175 if (!ec->es->s.gss_state) {
177 gss_release_cred(&min, &srv_cred);
178 return NT_STATUS_NO_MEMORY;
180 ZERO_STRUCTP(ec->es->s.gss_state);
181 ec->es->s.gss_state->creds = srv_cred;
183 /* No context yet. */
184 ec->es->s.gss_state->gss_ctx = GSS_C_NO_CONTEXT;
190 /******************************************************************************
191 Shutdown a server encryption context.
192 ******************************************************************************/
194 static void srv_free_encryption_context(struct smb_srv_trans_enc_ctx **pp_ec)
196 struct smb_srv_trans_enc_ctx *ec = *pp_ec;
203 switch (ec->es->smb_enc_type) {
204 case SMB_TRANS_ENC_NTLM:
205 destroy_auth_ntlmssp(ec);
207 #if defined(HAVE_GSSAPI) && defined(HAVE_KRB5)
208 case SMB_TRANS_ENC_GSS:
212 common_free_encryption_state(&ec->es);
219 /******************************************************************************
220 Create a server encryption context.
221 ******************************************************************************/
223 static NTSTATUS make_srv_encryption_context(enum smb_trans_enc_type smb_enc_type, struct smb_srv_trans_enc_ctx **pp_ec)
225 struct smb_srv_trans_enc_ctx *ec;
229 ec = SMB_MALLOC_P(struct smb_srv_trans_enc_ctx);
231 return NT_STATUS_NO_MEMORY;
233 ZERO_STRUCTP(partial_srv_trans_enc_ctx);
234 ec->es = SMB_MALLOC_P(struct smb_trans_enc_state);
237 return NT_STATUS_NO_MEMORY;
239 ZERO_STRUCTP(ec->es);
240 ec->es->smb_enc_type = smb_enc_type;
241 switch (smb_enc_type) {
242 case SMB_TRANS_ENC_NTLM:
244 NTSTATUS status = make_auth_ntlmssp(ec);
245 if (!NT_STATUS_IS_OK(status)) {
246 srv_free_encryption_context(&ec);
252 #if defined(HAVE_GSSAPI) && defined(HAVE_KRB5)
253 case SMB_TRANS_ENC_GSS:
254 /* Acquire our credentials by calling gss_acquire_cred here. */
256 NTSTATUS status = make_auth_gss(ec);
257 if (!NT_STATUS_IS_OK(status)) {
258 srv_free_encryption_context(&ec);
265 srv_free_encryption_context(&ec);
266 return NT_STATUS_INVALID_PARAMETER;
272 /******************************************************************************
273 Free an encryption-allocated buffer.
274 ******************************************************************************/
276 void srv_free_enc_buffer(char *buf)
278 /* We know this is an smb buffer, and we
279 * didn't malloc, only copy, for a keepalive,
280 * so ignore session keepalives. */
282 if(CVAL(buf,0) == SMBkeepalive) {
286 if (srv_trans_enc_ctx) {
287 common_free_enc_buffer(srv_trans_enc_ctx->es, buf);
291 /******************************************************************************
292 Decrypt an incoming buffer.
293 ******************************************************************************/
295 NTSTATUS srv_decrypt_buffer(char *buf)
297 /* Ignore session keepalives. */
298 if(CVAL(buf,0) == SMBkeepalive) {
302 if (srv_trans_enc_ctx) {
303 return common_decrypt_buffer(srv_trans_enc_ctx->es, buf);
309 /******************************************************************************
310 Encrypt an outgoing buffer. Return the encrypted pointer in buf_out.
311 ******************************************************************************/
313 NTSTATUS srv_encrypt_buffer(char *buf, char **buf_out)
317 /* Ignore session keepalives. */
318 if(CVAL(buf,0) == SMBkeepalive) {
322 if (srv_trans_enc_ctx) {
323 return common_encrypt_buffer(srv_trans_enc_ctx->es, buf, buf_out);
325 /* Not encrypting. */
329 /******************************************************************************
330 Do the gss encryption negotiation. Parameters are in/out.
331 Until success we do everything on the partial enc ctx.
332 ******************************************************************************/
334 #if defined(HAVE_GSSAPI) && defined(HAVE_KRB5)
335 static NTSTATUS srv_enc_spnego_gss_negotiate(unsigned char **ppdata, size_t *p_data_size, DATA_BLOB secblob)
340 gss_buffer_desc in_buf, out_buf;
341 struct smb_tran_enc_state_gss *gss_state;
342 DATA_BLOB auth_reply = data_blob(NULL,0);
343 DATA_BLOB response = data_blob(NULL,0);
346 if (!partial_srv_trans_enc_ctx) {
347 status = make_srv_encryption_context(SMB_TRANS_ENC_GSS, &partial_srv_trans_enc_ctx);
348 if (!NT_STATUS_IS_OK(status)) {
353 gss_state = partial_srv_trans_enc_ctx->es->s.gss_state;
355 in_buf.value = secblob.data;
356 in_buf.length = secblob.length;
358 out_buf.value = NULL;
361 ret = gss_accept_sec_context(&min,
365 GSS_C_NO_CHANNEL_BINDINGS,
367 NULL, /* Ignore oids. */
368 &out_buf, /* To return. */
370 NULL, /* Ingore time. */
371 NULL); /* Ignore delegated creds. */
373 status = gss_err_to_ntstatus(ret, min);
374 if (ret != GSS_S_COMPLETE && ret != GSS_S_CONTINUE_NEEDED) {
378 /* Ensure we've got sign+seal available. */
379 if (ret == GSS_S_COMPLETE) {
380 if ((flags & (GSS_C_INTEG_FLAG|GSS_C_CONF_FLAG|GSS_C_REPLAY_FLAG|GSS_C_SEQUENCE_FLAG)) !=
381 (GSS_C_INTEG_FLAG|GSS_C_CONF_FLAG|GSS_C_REPLAY_FLAG|GSS_C_SEQUENCE_FLAG)) {
382 DEBUG(0,("srv_enc_spnego_gss_negotiate: quality of service not good enough "
383 "for SMB sealing.\n"));
384 gss_release_buffer(&min, &out_buf);
385 return NT_STATUS_ACCESS_DENIED;
389 auth_reply = data_blob(out_buf.value, out_buf.length);
390 gss_release_buffer(&min, &out_buf);
392 /* Wrap in SPNEGO. */
393 response = spnego_gen_auth_response(&auth_reply, status, OID_KERBEROS5);
394 data_blob_free(&auth_reply);
397 *ppdata = response.data;
398 *p_data_size = response.length;
404 /******************************************************************************
405 Do the NTLM SPNEGO (or raw) encryption negotiation. Parameters are in/out.
406 Until success we do everything on the partial enc ctx.
407 ******************************************************************************/
409 static NTSTATUS srv_enc_ntlm_negotiate(unsigned char **ppdata, size_t *p_data_size, DATA_BLOB secblob, BOOL spnego_wrap)
412 DATA_BLOB chal = data_blob(NULL, 0);
413 DATA_BLOB response = data_blob(NULL, 0);
415 status = make_srv_encryption_context(SMB_TRANS_ENC_NTLM, &partial_srv_trans_enc_ctx);
416 if (!NT_STATUS_IS_OK(status)) {
420 status = auth_ntlmssp_update(partial_srv_trans_enc_ctx->auth_ntlmssp_state, secblob, &chal);
422 /* status here should be NT_STATUS_MORE_PROCESSING_REQUIRED
426 response = spnego_gen_auth_response(&chal, status, OID_NTLMSSP);
427 data_blob_free(&chal);
429 /* Return the raw blob. */
434 *ppdata = response.data;
435 *p_data_size = response.length;
439 /******************************************************************************
440 Do the SPNEGO encryption negotiation. Parameters are in/out.
441 Based off code in smbd/sesssionsetup.c
442 Until success we do everything on the partial enc ctx.
443 ******************************************************************************/
445 static NTSTATUS srv_enc_spnego_negotiate(connection_struct *conn,
446 unsigned char **ppdata,
448 unsigned char **pparam,
449 size_t *p_param_size)
452 DATA_BLOB blob = data_blob(NULL,0);
453 DATA_BLOB secblob = data_blob(NULL, 0);
454 BOOL got_kerberos_mechanism = False;
456 blob = data_blob_const(*ppdata, *p_data_size);
458 status = parse_spnego_mechanisms(blob, &secblob, &got_kerberos_mechanism);
459 if (!NT_STATUS_IS_OK(status)) {
460 return nt_status_squash(status);
463 /* We should have no partial context at this point. */
465 srv_free_encryption_context(&partial_srv_trans_enc_ctx);
467 #if defined(HAVE_GSSAPI) && defined(HAVE_KRB5)
468 if (got_kerberos_mechanism && lp_use_kerberos_keytab() ) {
469 status = srv_enc_spnego_gss_negotiate(ppdata, p_data_size, secblob);
473 status = srv_enc_ntlm_negotiate(ppdata, p_data_size, secblob, True);
476 data_blob_free(&secblob);
478 if (!NT_STATUS_EQUAL(status,NT_STATUS_MORE_PROCESSING_REQUIRED) && !NT_STATUS_IS_OK(status)) {
479 srv_free_encryption_context(&partial_srv_trans_enc_ctx);
480 return nt_status_squash(status);
483 if (NT_STATUS_IS_OK(status)) {
484 /* Return the context we're using for this encryption state. */
485 *pparam = SMB_MALLOC(2);
487 return NT_STATUS_NO_MEMORY;
489 SSVAL(*pparam,0,partial_srv_trans_enc_ctx->es->enc_ctx_num);
496 /******************************************************************************
497 Complete a SPNEGO encryption negotiation. Parameters are in/out.
498 We only get this for a NTLM auth second stage.
499 ******************************************************************************/
501 static NTSTATUS srv_enc_spnego_ntlm_auth(connection_struct *conn,
502 unsigned char **ppdata,
504 unsigned char **pparam,
505 size_t *p_param_size)
508 DATA_BLOB blob = data_blob(NULL,0);
509 DATA_BLOB auth = data_blob(NULL,0);
510 DATA_BLOB auth_reply = data_blob(NULL,0);
511 DATA_BLOB response = data_blob(NULL,0);
512 struct smb_srv_trans_enc_ctx *ec = partial_srv_trans_enc_ctx;
514 /* We must have a partial context here. */
516 if (!ec || !ec->es || ec->auth_ntlmssp_state == NULL || ec->es->smb_enc_type != SMB_TRANS_ENC_NTLM) {
517 srv_free_encryption_context(&partial_srv_trans_enc_ctx);
518 return NT_STATUS_INVALID_PARAMETER;
521 blob = data_blob_const(*ppdata, *p_data_size);
522 if (!spnego_parse_auth(blob, &auth)) {
523 srv_free_encryption_context(&partial_srv_trans_enc_ctx);
524 return NT_STATUS_INVALID_PARAMETER;
527 status = auth_ntlmssp_update(ec->auth_ntlmssp_state, auth, &auth_reply);
528 data_blob_free(&auth);
530 response = spnego_gen_auth_response(&auth_reply, status, OID_NTLMSSP);
531 data_blob_free(&auth_reply);
533 if (NT_STATUS_IS_OK(status)) {
534 /* Return the context we're using for this encryption state. */
535 *pparam = SMB_MALLOC(2);
537 return NT_STATUS_NO_MEMORY;
539 SSVAL(*pparam,0,ec->es->enc_ctx_num);
544 *ppdata = response.data;
545 *p_data_size = response.length;
549 /******************************************************************************
550 Raw NTLM encryption negotiation. Parameters are in/out.
551 This function does both steps.
552 ******************************************************************************/
554 static NTSTATUS srv_enc_raw_ntlm_auth(connection_struct *conn,
555 unsigned char **ppdata,
557 unsigned char **pparam,
558 size_t *p_param_size)
561 DATA_BLOB blob = data_blob_const(*ppdata, *p_data_size);
562 DATA_BLOB response = data_blob(NULL,0);
563 struct smb_srv_trans_enc_ctx *ec;
565 if (!partial_srv_trans_enc_ctx) {
566 /* This is the initial step. */
567 status = srv_enc_ntlm_negotiate(ppdata, p_data_size, blob, False);
568 if (!NT_STATUS_EQUAL(status,NT_STATUS_MORE_PROCESSING_REQUIRED) && !NT_STATUS_IS_OK(status)) {
569 srv_free_encryption_context(&partial_srv_trans_enc_ctx);
570 return nt_status_squash(status);
575 ec = partial_srv_trans_enc_ctx;
576 if (!ec || !ec->es || ec->auth_ntlmssp_state == NULL || ec->es->smb_enc_type != SMB_TRANS_ENC_NTLM) {
577 srv_free_encryption_context(&partial_srv_trans_enc_ctx);
578 return NT_STATUS_INVALID_PARAMETER;
582 status = auth_ntlmssp_update(partial_srv_trans_enc_ctx->auth_ntlmssp_state, blob, &response);
584 if (NT_STATUS_IS_OK(status)) {
585 /* Return the context we're using for this encryption state. */
586 *pparam = SMB_MALLOC(2);
588 return NT_STATUS_NO_MEMORY;
590 SSVAL(*pparam,0,ec->es->enc_ctx_num);
594 /* Return the raw blob. */
596 *ppdata = response.data;
597 *p_data_size = response.length;
601 /******************************************************************************
602 Do the SPNEGO encryption negotiation. Parameters are in/out.
603 ******************************************************************************/
605 NTSTATUS srv_request_encryption_setup(connection_struct *conn,
606 unsigned char **ppdata,
608 unsigned char **pparam,
609 size_t *p_param_size)
611 unsigned char *pdata = *ppdata;
616 if (*p_data_size < 1) {
617 return NT_STATUS_INVALID_PARAMETER;
620 if (pdata[0] == ASN1_APPLICATION(0)) {
621 /* its a negTokenTarg packet */
622 return srv_enc_spnego_negotiate(conn, ppdata, p_data_size, pparam, p_param_size);
625 if (pdata[0] == ASN1_CONTEXT(1)) {
626 /* It's an auth packet */
627 return srv_enc_spnego_ntlm_auth(conn, ppdata, p_data_size, pparam, p_param_size);
630 /* Maybe it's a raw unwrapped auth ? */
631 if (*p_data_size < 7) {
632 return NT_STATUS_INVALID_PARAMETER;
635 if (strncmp((char *)pdata, "NTLMSSP", 7) == 0) {
636 return srv_enc_raw_ntlm_auth(conn, ppdata, p_data_size, pparam, p_param_size);
639 DEBUG(1,("srv_request_encryption_setup: Unknown packet\n"));
641 return NT_STATUS_LOGON_FAILURE;
644 /******************************************************************************
645 Negotiation was successful - turn on server-side encryption.
646 ******************************************************************************/
648 static NTSTATUS check_enc_good(struct smb_srv_trans_enc_ctx *ec)
650 if (!ec || !ec->es) {
651 return NT_STATUS_LOGON_FAILURE;
654 if (ec->es->smb_enc_type == SMB_TRANS_ENC_NTLM) {
655 if ((ec->es->s.ntlmssp_state->neg_flags & (NTLMSSP_NEGOTIATE_SIGN|NTLMSSP_NEGOTIATE_SEAL)) !=
656 (NTLMSSP_NEGOTIATE_SIGN|NTLMSSP_NEGOTIATE_SEAL)) {
657 return NT_STATUS_INVALID_PARAMETER;
660 /* Todo - check gssapi case. */
665 /******************************************************************************
666 Negotiation was successful - turn on server-side encryption.
667 ******************************************************************************/
669 NTSTATUS srv_encryption_start(connection_struct *conn)
673 /* Check that we are really doing sign+seal. */
674 status = check_enc_good(partial_srv_trans_enc_ctx);
675 if (!NT_STATUS_IS_OK(status)) {
678 /* Throw away the context we're using currently (if any). */
679 srv_free_encryption_context(&srv_trans_enc_ctx);
681 /* Steal the partial pointer. Deliberate shallow copy. */
682 srv_trans_enc_ctx = partial_srv_trans_enc_ctx;
683 srv_trans_enc_ctx->es->enc_on = True;
685 partial_srv_trans_enc_ctx = NULL;
689 /******************************************************************************
690 Shutdown all server contexts.
691 ******************************************************************************/
693 void server_encryption_shutdown(void)
695 srv_free_encryption_context(&partial_srv_trans_enc_ctx);
696 srv_free_encryption_context(&srv_trans_enc_ctx);