2 * fs/cifs/smb2transport.c
4 * Copyright (C) International Business Machines Corp., 2002, 2011
6 * Author(s): Steve French (sfrench@us.ibm.com)
7 * Jeremy Allison (jra@samba.org) 2006
8 * Pavel Shilovsky (pshilovsky@samba.org) 2012
10 * This library is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU Lesser General Public License as published
12 * by the Free Software Foundation; either version 2.1 of the License, or
13 * (at your option) any later version.
15 * This library is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
18 * the GNU Lesser General Public License for more details.
20 * You should have received a copy of the GNU Lesser General Public License
21 * along with this library; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
26 #include <linux/list.h>
27 #include <linux/wait.h>
28 #include <linux/net.h>
29 #include <linux/delay.h>
30 #include <linux/uaccess.h>
31 #include <asm/processor.h>
32 #include <linux/mempool.h>
33 #include <linux/highmem.h>
34 #include <crypto/aead.h>
37 #include "cifsproto.h"
38 #include "smb2proto.h"
39 #include "cifs_debug.h"
40 #include "smb2status.h"
44 smb2_crypto_shash_allocate(struct TCP_Server_Info *server)
46 return cifs_alloc_hash("hmac(sha256)",
47 &server->secmech.hmacsha256,
48 &server->secmech.sdeschmacsha256);
52 smb3_crypto_shash_allocate(struct TCP_Server_Info *server)
54 struct cifs_secmech *p = &server->secmech;
57 rc = cifs_alloc_hash("hmac(sha256)",
63 rc = cifs_alloc_hash("cmac(aes)", &p->cmacaes, &p->sdesccmacaes);
69 cifs_free_hash(&p->hmacsha256, &p->sdeschmacsha256);
74 smb311_crypto_shash_allocate(struct TCP_Server_Info *server)
76 struct cifs_secmech *p = &server->secmech;
79 rc = cifs_alloc_hash("hmac(sha256)",
85 rc = cifs_alloc_hash("cmac(aes)", &p->cmacaes, &p->sdesccmacaes);
89 rc = cifs_alloc_hash("sha512", &p->sha512, &p->sdescsha512);
96 cifs_free_hash(&p->cmacaes, &p->sdesccmacaes);
97 cifs_free_hash(&p->hmacsha256, &p->sdeschmacsha256);
101 static struct cifs_ses *
102 smb2_find_smb_ses_unlocked(struct TCP_Server_Info *server, __u64 ses_id)
104 struct cifs_ses *ses;
106 list_for_each_entry(ses, &server->smb_ses_list, smb_ses_list) {
107 if (ses->Suid != ses_id)
116 smb2_find_smb_ses(struct TCP_Server_Info *server, __u64 ses_id)
118 struct cifs_ses *ses;
120 spin_lock(&cifs_tcp_ses_lock);
121 ses = smb2_find_smb_ses_unlocked(server, ses_id);
122 spin_unlock(&cifs_tcp_ses_lock);
127 static struct cifs_tcon *
128 smb2_find_smb_sess_tcon_unlocked(struct cifs_ses *ses, __u32 tid)
130 struct cifs_tcon *tcon;
132 list_for_each_entry(tcon, &ses->tcon_list, tcon_list) {
133 if (tcon->tid != tid)
143 * Obtain tcon corresponding to the tid in the given
148 smb2_find_smb_tcon(struct TCP_Server_Info *server, __u64 ses_id, __u32 tid)
150 struct cifs_ses *ses;
151 struct cifs_tcon *tcon;
153 spin_lock(&cifs_tcp_ses_lock);
154 ses = smb2_find_smb_ses_unlocked(server, ses_id);
156 spin_unlock(&cifs_tcp_ses_lock);
159 tcon = smb2_find_smb_sess_tcon_unlocked(ses, tid);
160 spin_unlock(&cifs_tcp_ses_lock);
166 smb2_calc_signature(struct smb_rqst *rqst, struct TCP_Server_Info *server)
169 unsigned char smb2_signature[SMB2_HMACSHA256_SIZE];
170 unsigned char *sigptr = smb2_signature;
171 struct kvec *iov = rqst->rq_iov;
172 struct smb2_sync_hdr *shdr = (struct smb2_sync_hdr *)iov[0].iov_base;
173 struct cifs_ses *ses;
174 struct shash_desc *shash;
175 struct smb_rqst drqst;
177 ses = smb2_find_smb_ses(server, shdr->SessionId);
179 cifs_server_dbg(VFS, "%s: Could not find session\n", __func__);
183 memset(smb2_signature, 0x0, SMB2_HMACSHA256_SIZE);
184 memset(shdr->Signature, 0x0, SMB2_SIGNATURE_SIZE);
186 rc = smb2_crypto_shash_allocate(server);
188 cifs_server_dbg(VFS, "%s: sha256 alloc failed\n", __func__);
192 rc = crypto_shash_setkey(server->secmech.hmacsha256,
193 ses->auth_key.response, SMB2_NTLMV2_SESSKEY_SIZE);
195 cifs_server_dbg(VFS, "%s: Could not update with response\n", __func__);
199 shash = &server->secmech.sdeschmacsha256->shash;
200 rc = crypto_shash_init(shash);
202 cifs_server_dbg(VFS, "%s: Could not init sha256", __func__);
207 * For SMB2+, __cifs_calc_signature() expects to sign only the actual
208 * data, that is, iov[0] should not contain a rfc1002 length.
210 * Sign the rfc1002 length prior to passing the data (iov[1-N]) down to
211 * __cifs_calc_signature().
214 if (drqst.rq_nvec >= 2 && iov[0].iov_len == 4) {
215 rc = crypto_shash_update(shash, iov[0].iov_base,
218 cifs_server_dbg(VFS, "%s: Could not update with payload\n",
226 rc = __cifs_calc_signature(&drqst, server, sigptr, shash);
228 memcpy(shdr->Signature, sigptr, SMB2_SIGNATURE_SIZE);
233 static int generate_key(struct cifs_ses *ses, struct kvec label,
234 struct kvec context, __u8 *key, unsigned int key_size)
236 unsigned char zero = 0x0;
237 __u8 i[4] = {0, 0, 0, 1};
238 __u8 L[4] = {0, 0, 0, 128};
240 unsigned char prfhash[SMB2_HMACSHA256_SIZE];
241 unsigned char *hashptr = prfhash;
242 struct TCP_Server_Info *server = ses->server;
244 memset(prfhash, 0x0, SMB2_HMACSHA256_SIZE);
245 memset(key, 0x0, key_size);
247 rc = smb3_crypto_shash_allocate(server);
249 cifs_server_dbg(VFS, "%s: crypto alloc failed\n", __func__);
250 goto smb3signkey_ret;
253 rc = crypto_shash_setkey(server->secmech.hmacsha256,
254 ses->auth_key.response, SMB2_NTLMV2_SESSKEY_SIZE);
256 cifs_server_dbg(VFS, "%s: Could not set with session key\n", __func__);
257 goto smb3signkey_ret;
260 rc = crypto_shash_init(&server->secmech.sdeschmacsha256->shash);
262 cifs_server_dbg(VFS, "%s: Could not init sign hmac\n", __func__);
263 goto smb3signkey_ret;
266 rc = crypto_shash_update(&server->secmech.sdeschmacsha256->shash,
269 cifs_server_dbg(VFS, "%s: Could not update with n\n", __func__);
270 goto smb3signkey_ret;
273 rc = crypto_shash_update(&server->secmech.sdeschmacsha256->shash,
274 label.iov_base, label.iov_len);
276 cifs_server_dbg(VFS, "%s: Could not update with label\n", __func__);
277 goto smb3signkey_ret;
280 rc = crypto_shash_update(&server->secmech.sdeschmacsha256->shash,
283 cifs_server_dbg(VFS, "%s: Could not update with zero\n", __func__);
284 goto smb3signkey_ret;
287 rc = crypto_shash_update(&server->secmech.sdeschmacsha256->shash,
288 context.iov_base, context.iov_len);
290 cifs_server_dbg(VFS, "%s: Could not update with context\n", __func__);
291 goto smb3signkey_ret;
294 rc = crypto_shash_update(&server->secmech.sdeschmacsha256->shash,
297 cifs_server_dbg(VFS, "%s: Could not update with L\n", __func__);
298 goto smb3signkey_ret;
301 rc = crypto_shash_final(&server->secmech.sdeschmacsha256->shash,
304 cifs_server_dbg(VFS, "%s: Could not generate sha256 hash\n", __func__);
305 goto smb3signkey_ret;
308 memcpy(key, hashptr, key_size);
319 struct derivation_triplet {
320 struct derivation signing;
321 struct derivation encryption;
322 struct derivation decryption;
326 generate_smb3signingkey(struct cifs_ses *ses,
327 const struct derivation_triplet *ptriplet)
331 rc = generate_key(ses, ptriplet->signing.label,
332 ptriplet->signing.context, ses->smb3signingkey,
337 rc = generate_key(ses, ptriplet->encryption.label,
338 ptriplet->encryption.context, ses->smb3encryptionkey,
343 rc = generate_key(ses, ptriplet->decryption.label,
344 ptriplet->decryption.context,
345 ses->smb3decryptionkey, SMB3_SIGN_KEY_SIZE);
350 #ifdef CONFIG_CIFS_DEBUG_DUMP_KEYS
351 cifs_dbg(VFS, "%s: dumping generated AES session keys\n", __func__);
353 * The session id is opaque in terms of endianness, so we can't
354 * print it as a long long. we dump it as we got it on the wire
356 cifs_dbg(VFS, "Session Id %*ph\n", (int)sizeof(ses->Suid),
358 cifs_dbg(VFS, "Session Key %*ph\n",
359 SMB2_NTLMV2_SESSKEY_SIZE, ses->auth_key.response);
360 cifs_dbg(VFS, "Signing Key %*ph\n",
361 SMB3_SIGN_KEY_SIZE, ses->smb3signingkey);
362 cifs_dbg(VFS, "ServerIn Key %*ph\n",
363 SMB3_SIGN_KEY_SIZE, ses->smb3encryptionkey);
364 cifs_dbg(VFS, "ServerOut Key %*ph\n",
365 SMB3_SIGN_KEY_SIZE, ses->smb3decryptionkey);
371 generate_smb30signingkey(struct cifs_ses *ses)
374 struct derivation_triplet triplet;
375 struct derivation *d;
377 d = &triplet.signing;
378 d->label.iov_base = "SMB2AESCMAC";
379 d->label.iov_len = 12;
380 d->context.iov_base = "SmbSign";
381 d->context.iov_len = 8;
383 d = &triplet.encryption;
384 d->label.iov_base = "SMB2AESCCM";
385 d->label.iov_len = 11;
386 d->context.iov_base = "ServerIn ";
387 d->context.iov_len = 10;
389 d = &triplet.decryption;
390 d->label.iov_base = "SMB2AESCCM";
391 d->label.iov_len = 11;
392 d->context.iov_base = "ServerOut";
393 d->context.iov_len = 10;
395 return generate_smb3signingkey(ses, &triplet);
399 generate_smb311signingkey(struct cifs_ses *ses)
402 struct derivation_triplet triplet;
403 struct derivation *d;
405 d = &triplet.signing;
406 d->label.iov_base = "SMBSigningKey";
407 d->label.iov_len = 14;
408 d->context.iov_base = ses->preauth_sha_hash;
409 d->context.iov_len = 64;
411 d = &triplet.encryption;
412 d->label.iov_base = "SMBC2SCipherKey";
413 d->label.iov_len = 16;
414 d->context.iov_base = ses->preauth_sha_hash;
415 d->context.iov_len = 64;
417 d = &triplet.decryption;
418 d->label.iov_base = "SMBS2CCipherKey";
419 d->label.iov_len = 16;
420 d->context.iov_base = ses->preauth_sha_hash;
421 d->context.iov_len = 64;
423 return generate_smb3signingkey(ses, &triplet);
427 smb3_calc_signature(struct smb_rqst *rqst, struct TCP_Server_Info *server)
430 unsigned char smb3_signature[SMB2_CMACAES_SIZE];
431 unsigned char *sigptr = smb3_signature;
432 struct kvec *iov = rqst->rq_iov;
433 struct smb2_sync_hdr *shdr = (struct smb2_sync_hdr *)iov[0].iov_base;
434 struct cifs_ses *ses;
435 struct shash_desc *shash = &server->secmech.sdesccmacaes->shash;
436 struct smb_rqst drqst;
438 ses = smb2_find_smb_ses(server, shdr->SessionId);
440 cifs_server_dbg(VFS, "%s: Could not find session\n", __func__);
444 memset(smb3_signature, 0x0, SMB2_CMACAES_SIZE);
445 memset(shdr->Signature, 0x0, SMB2_SIGNATURE_SIZE);
447 rc = crypto_shash_setkey(server->secmech.cmacaes,
448 ses->smb3signingkey, SMB2_CMACAES_SIZE);
450 cifs_server_dbg(VFS, "%s: Could not set key for cmac aes\n", __func__);
455 * we already allocate sdesccmacaes when we init smb3 signing key,
456 * so unlike smb2 case we do not have to check here if secmech are
459 rc = crypto_shash_init(shash);
461 cifs_server_dbg(VFS, "%s: Could not init cmac aes\n", __func__);
466 * For SMB2+, __cifs_calc_signature() expects to sign only the actual
467 * data, that is, iov[0] should not contain a rfc1002 length.
469 * Sign the rfc1002 length prior to passing the data (iov[1-N]) down to
470 * __cifs_calc_signature().
473 if (drqst.rq_nvec >= 2 && iov[0].iov_len == 4) {
474 rc = crypto_shash_update(shash, iov[0].iov_base,
477 cifs_server_dbg(VFS, "%s: Could not update with payload\n",
485 rc = __cifs_calc_signature(&drqst, server, sigptr, shash);
487 memcpy(shdr->Signature, sigptr, SMB2_SIGNATURE_SIZE);
492 /* must be called with server->srv_mutex held */
494 smb2_sign_rqst(struct smb_rqst *rqst, struct TCP_Server_Info *server)
497 struct smb2_sync_hdr *shdr =
498 (struct smb2_sync_hdr *)rqst->rq_iov[0].iov_base;
500 if (!(shdr->Flags & SMB2_FLAGS_SIGNED) ||
501 server->tcpStatus == CifsNeedNegotiate)
504 if (!server->session_estab) {
505 strncpy(shdr->Signature, "BSRSPYL", 8);
509 rc = server->ops->calc_signature(rqst, server);
515 smb2_verify_signature(struct smb_rqst *rqst, struct TCP_Server_Info *server)
518 char server_response_sig[16];
519 struct smb2_sync_hdr *shdr =
520 (struct smb2_sync_hdr *)rqst->rq_iov[0].iov_base;
522 if ((shdr->Command == SMB2_NEGOTIATE) ||
523 (shdr->Command == SMB2_SESSION_SETUP) ||
524 (shdr->Command == SMB2_OPLOCK_BREAK) ||
525 server->ignore_signature ||
526 (!server->session_estab))
530 * BB what if signatures are supposed to be on for session but
531 * server does not send one? BB
534 /* Do not need to verify session setups with signature "BSRSPYL " */
535 if (memcmp(shdr->Signature, "BSRSPYL ", 8) == 0)
536 cifs_dbg(FYI, "dummy signature received for smb command 0x%x\n",
540 * Save off the origiginal signature so we can modify the smb and check
541 * our calculated signature against what the server sent.
543 memcpy(server_response_sig, shdr->Signature, SMB2_SIGNATURE_SIZE);
545 memset(shdr->Signature, 0, SMB2_SIGNATURE_SIZE);
547 mutex_lock(&server->srv_mutex);
548 rc = server->ops->calc_signature(rqst, server);
549 mutex_unlock(&server->srv_mutex);
554 if (memcmp(server_response_sig, shdr->Signature, SMB2_SIGNATURE_SIZE))
561 * Set message id for the request. Should be called after wait_for_free_request
562 * and when srv_mutex is held.
565 smb2_seq_num_into_buf(struct TCP_Server_Info *server,
566 struct smb2_sync_hdr *shdr)
568 unsigned int i, num = le16_to_cpu(shdr->CreditCharge);
570 shdr->MessageId = get_next_mid64(server);
571 /* skip message numbers according to CreditCharge field */
572 for (i = 1; i < num; i++)
573 get_next_mid(server);
576 static struct mid_q_entry *
577 smb2_mid_entry_alloc(const struct smb2_sync_hdr *shdr,
578 struct TCP_Server_Info *server)
580 struct mid_q_entry *temp;
581 unsigned int credits = le16_to_cpu(shdr->CreditCharge);
583 if (server == NULL) {
584 cifs_dbg(VFS, "Null TCP session in smb2_mid_entry_alloc\n");
588 temp = mempool_alloc(cifs_mid_poolp, GFP_NOFS);
589 memset(temp, 0, sizeof(struct mid_q_entry));
590 kref_init(&temp->refcount);
591 temp->mid = le64_to_cpu(shdr->MessageId);
592 temp->credits = credits > 0 ? credits : 1;
593 temp->pid = current->pid;
594 temp->command = shdr->Command; /* Always LE */
595 temp->when_alloc = jiffies;
596 temp->server = server;
599 * The default is for the mid to be synchronous, so the
600 * default callback just wakes up the current task.
602 get_task_struct(current);
603 temp->creator = current;
604 temp->callback = cifs_wake_up_task;
605 temp->callback_data = current;
607 atomic_inc(&midCount);
608 temp->mid_state = MID_REQUEST_ALLOCATED;
609 trace_smb3_cmd_enter(shdr->TreeId, shdr->SessionId,
610 le16_to_cpu(shdr->Command), temp->mid);
615 smb2_get_mid_entry(struct cifs_ses *ses, struct smb2_sync_hdr *shdr,
616 struct mid_q_entry **mid)
618 if (ses->server->tcpStatus == CifsExiting)
621 if (ses->server->tcpStatus == CifsNeedReconnect) {
622 cifs_dbg(FYI, "tcp session dead - return to caller to retry\n");
626 if (ses->server->tcpStatus == CifsNeedNegotiate &&
627 shdr->Command != SMB2_NEGOTIATE)
630 if (ses->status == CifsNew) {
631 if ((shdr->Command != SMB2_SESSION_SETUP) &&
632 (shdr->Command != SMB2_NEGOTIATE))
634 /* else ok - we are setting up session */
637 if (ses->status == CifsExiting) {
638 if (shdr->Command != SMB2_LOGOFF)
640 /* else ok - we are shutting down the session */
643 *mid = smb2_mid_entry_alloc(shdr, ses->server);
646 spin_lock(&GlobalMid_Lock);
647 list_add_tail(&(*mid)->qhead, &ses->server->pending_mid_q);
648 spin_unlock(&GlobalMid_Lock);
654 smb2_check_receive(struct mid_q_entry *mid, struct TCP_Server_Info *server,
657 unsigned int len = mid->resp_buf_size;
659 struct smb_rqst rqst = { .rq_iov = iov,
662 iov[0].iov_base = (char *)mid->resp_buf;
663 iov[0].iov_len = len;
665 dump_smb(mid->resp_buf, min_t(u32, 80, len));
666 /* convert the length into a more usable form */
667 if (len > 24 && server->sign && !mid->decrypted) {
670 rc = smb2_verify_signature(&rqst, server);
672 cifs_server_dbg(VFS, "SMB signature verification returned error = %d\n",
676 return map_smb2_to_linux_error(mid->resp_buf, log_error);
680 smb2_setup_request(struct cifs_ses *ses, struct smb_rqst *rqst)
683 struct smb2_sync_hdr *shdr =
684 (struct smb2_sync_hdr *)rqst->rq_iov[0].iov_base;
685 struct mid_q_entry *mid;
687 smb2_seq_num_into_buf(ses->server, shdr);
689 rc = smb2_get_mid_entry(ses, shdr, &mid);
691 revert_current_mid_from_hdr(ses->server, shdr);
695 rc = smb2_sign_rqst(rqst, ses->server);
697 revert_current_mid_from_hdr(ses->server, shdr);
698 cifs_delete_mid(mid);
706 smb2_setup_async_request(struct TCP_Server_Info *server, struct smb_rqst *rqst)
709 struct smb2_sync_hdr *shdr =
710 (struct smb2_sync_hdr *)rqst->rq_iov[0].iov_base;
711 struct mid_q_entry *mid;
713 if (server->tcpStatus == CifsNeedNegotiate &&
714 shdr->Command != SMB2_NEGOTIATE)
715 return ERR_PTR(-EAGAIN);
717 smb2_seq_num_into_buf(server, shdr);
719 mid = smb2_mid_entry_alloc(shdr, server);
721 revert_current_mid_from_hdr(server, shdr);
722 return ERR_PTR(-ENOMEM);
725 rc = smb2_sign_rqst(rqst, server);
727 revert_current_mid_from_hdr(server, shdr);
728 DeleteMidQEntry(mid);
736 smb3_crypto_aead_allocate(struct TCP_Server_Info *server)
738 struct crypto_aead *tfm;
740 if (!server->secmech.ccmaesencrypt) {
741 if (server->cipher_type == SMB2_ENCRYPTION_AES128_GCM)
742 tfm = crypto_alloc_aead("gcm(aes)", 0, 0);
744 tfm = crypto_alloc_aead("ccm(aes)", 0, 0);
746 cifs_server_dbg(VFS, "%s: Failed to alloc encrypt aead\n",
750 server->secmech.ccmaesencrypt = tfm;
753 if (!server->secmech.ccmaesdecrypt) {
754 if (server->cipher_type == SMB2_ENCRYPTION_AES128_GCM)
755 tfm = crypto_alloc_aead("gcm(aes)", 0, 0);
757 tfm = crypto_alloc_aead("ccm(aes)", 0, 0);
759 crypto_free_aead(server->secmech.ccmaesencrypt);
760 server->secmech.ccmaesencrypt = NULL;
761 cifs_server_dbg(VFS, "%s: Failed to alloc decrypt aead\n",
765 server->secmech.ccmaesdecrypt = tfm;