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);
73 #ifdef CONFIG_CIFS_SMB311
75 smb311_crypto_shash_allocate(struct TCP_Server_Info *server)
77 struct cifs_secmech *p = &server->secmech;
80 rc = cifs_alloc_hash("hmac(sha256)",
86 rc = cifs_alloc_hash("cmac(aes)", &p->cmacaes, &p->sdesccmacaes);
90 rc = cifs_alloc_hash("sha512", &p->sha512, &p->sdescsha512);
97 cifs_free_hash(&p->cmacaes, &p->sdesccmacaes);
98 cifs_free_hash(&p->hmacsha256, &p->sdeschmacsha256);
103 static struct cifs_ses *
104 smb2_find_smb_ses_unlocked(struct TCP_Server_Info *server, __u64 ses_id)
106 struct cifs_ses *ses;
108 list_for_each_entry(ses, &server->smb_ses_list, smb_ses_list) {
109 if (ses->Suid != ses_id)
118 smb2_find_smb_ses(struct TCP_Server_Info *server, __u64 ses_id)
120 struct cifs_ses *ses;
122 spin_lock(&cifs_tcp_ses_lock);
123 ses = smb2_find_smb_ses_unlocked(server, ses_id);
124 spin_unlock(&cifs_tcp_ses_lock);
129 static struct cifs_tcon *
130 smb2_find_smb_sess_tcon_unlocked(struct cifs_ses *ses, __u32 tid)
132 struct cifs_tcon *tcon;
134 list_for_each_entry(tcon, &ses->tcon_list, tcon_list) {
135 if (tcon->tid != tid)
145 * Obtain tcon corresponding to the tid in the given
150 smb2_find_smb_tcon(struct TCP_Server_Info *server, __u64 ses_id, __u32 tid)
152 struct cifs_ses *ses;
153 struct cifs_tcon *tcon;
155 spin_lock(&cifs_tcp_ses_lock);
156 ses = smb2_find_smb_ses_unlocked(server, ses_id);
158 spin_unlock(&cifs_tcp_ses_lock);
161 tcon = smb2_find_smb_sess_tcon_unlocked(ses, tid);
162 spin_unlock(&cifs_tcp_ses_lock);
168 smb2_calc_signature(struct smb_rqst *rqst, struct TCP_Server_Info *server)
171 unsigned char smb2_signature[SMB2_HMACSHA256_SIZE];
172 unsigned char *sigptr = smb2_signature;
173 struct kvec *iov = rqst->rq_iov;
174 struct smb2_sync_hdr *shdr = (struct smb2_sync_hdr *)iov[0].iov_base;
175 struct cifs_ses *ses;
176 struct shash_desc *shash = &server->secmech.sdeschmacsha256->shash;
177 struct smb_rqst drqst;
179 ses = smb2_find_smb_ses(server, shdr->SessionId);
181 cifs_dbg(VFS, "%s: Could not find session\n", __func__);
185 memset(smb2_signature, 0x0, SMB2_HMACSHA256_SIZE);
186 memset(shdr->Signature, 0x0, SMB2_SIGNATURE_SIZE);
188 rc = smb2_crypto_shash_allocate(server);
190 cifs_dbg(VFS, "%s: shah256 alloc failed\n", __func__);
194 rc = crypto_shash_setkey(server->secmech.hmacsha256,
195 ses->auth_key.response, SMB2_NTLMV2_SESSKEY_SIZE);
197 cifs_dbg(VFS, "%s: Could not update with response\n", __func__);
201 rc = crypto_shash_init(shash);
203 cifs_dbg(VFS, "%s: Could not init sha256", __func__);
208 * For SMB2+, __cifs_calc_signature() expects to sign only the actual
209 * data, that is, iov[0] should not contain a rfc1002 length.
211 * Sign the rfc1002 length prior to passing the data (iov[1-N]) down to
212 * __cifs_calc_signature().
215 if (drqst.rq_nvec >= 2 && iov[0].iov_len == 4) {
216 rc = crypto_shash_update(shash, iov[0].iov_base,
219 cifs_dbg(VFS, "%s: Could not update with payload\n",
227 rc = __cifs_calc_signature(&drqst, server, sigptr, shash);
229 memcpy(shdr->Signature, sigptr, SMB2_SIGNATURE_SIZE);
234 static int generate_key(struct cifs_ses *ses, struct kvec label,
235 struct kvec context, __u8 *key, unsigned int key_size)
237 unsigned char zero = 0x0;
238 __u8 i[4] = {0, 0, 0, 1};
239 __u8 L[4] = {0, 0, 0, 128};
241 unsigned char prfhash[SMB2_HMACSHA256_SIZE];
242 unsigned char *hashptr = prfhash;
244 memset(prfhash, 0x0, SMB2_HMACSHA256_SIZE);
245 memset(key, 0x0, key_size);
247 rc = smb3_crypto_shash_allocate(ses->server);
249 cifs_dbg(VFS, "%s: crypto alloc failed\n", __func__);
250 goto smb3signkey_ret;
253 rc = crypto_shash_setkey(ses->server->secmech.hmacsha256,
254 ses->auth_key.response, SMB2_NTLMV2_SESSKEY_SIZE);
256 cifs_dbg(VFS, "%s: Could not set with session key\n", __func__);
257 goto smb3signkey_ret;
260 rc = crypto_shash_init(&ses->server->secmech.sdeschmacsha256->shash);
262 cifs_dbg(VFS, "%s: Could not init sign hmac\n", __func__);
263 goto smb3signkey_ret;
266 rc = crypto_shash_update(&ses->server->secmech.sdeschmacsha256->shash,
269 cifs_dbg(VFS, "%s: Could not update with n\n", __func__);
270 goto smb3signkey_ret;
273 rc = crypto_shash_update(&ses->server->secmech.sdeschmacsha256->shash,
274 label.iov_base, label.iov_len);
276 cifs_dbg(VFS, "%s: Could not update with label\n", __func__);
277 goto smb3signkey_ret;
280 rc = crypto_shash_update(&ses->server->secmech.sdeschmacsha256->shash,
283 cifs_dbg(VFS, "%s: Could not update with zero\n", __func__);
284 goto smb3signkey_ret;
287 rc = crypto_shash_update(&ses->server->secmech.sdeschmacsha256->shash,
288 context.iov_base, context.iov_len);
290 cifs_dbg(VFS, "%s: Could not update with context\n", __func__);
291 goto smb3signkey_ret;
294 rc = crypto_shash_update(&ses->server->secmech.sdeschmacsha256->shash,
297 cifs_dbg(VFS, "%s: Could not update with L\n", __func__);
298 goto smb3signkey_ret;
301 rc = crypto_shash_final(&ses->server->secmech.sdeschmacsha256->shash,
304 cifs_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);
398 #ifdef CONFIG_CIFS_SMB311
400 generate_smb311signingkey(struct cifs_ses *ses)
403 struct derivation_triplet triplet;
404 struct derivation *d;
406 d = &triplet.signing;
407 d->label.iov_base = "SMBSigningKey";
408 d->label.iov_len = 14;
409 d->context.iov_base = ses->preauth_sha_hash;
410 d->context.iov_len = 64;
412 d = &triplet.encryption;
413 d->label.iov_base = "SMBC2SCipherKey";
414 d->label.iov_len = 16;
415 d->context.iov_base = ses->preauth_sha_hash;
416 d->context.iov_len = 64;
418 d = &triplet.decryption;
419 d->label.iov_base = "SMBS2CCipherKey";
420 d->label.iov_len = 16;
421 d->context.iov_base = ses->preauth_sha_hash;
422 d->context.iov_len = 64;
424 return generate_smb3signingkey(ses, &triplet);
429 smb3_calc_signature(struct smb_rqst *rqst, struct TCP_Server_Info *server)
432 unsigned char smb3_signature[SMB2_CMACAES_SIZE];
433 unsigned char *sigptr = smb3_signature;
434 struct kvec *iov = rqst->rq_iov;
435 struct smb2_sync_hdr *shdr = (struct smb2_sync_hdr *)iov[0].iov_base;
436 struct cifs_ses *ses;
437 struct shash_desc *shash = &server->secmech.sdesccmacaes->shash;
438 struct smb_rqst drqst;
440 ses = smb2_find_smb_ses(server, shdr->SessionId);
442 cifs_dbg(VFS, "%s: Could not find session\n", __func__);
446 memset(smb3_signature, 0x0, SMB2_CMACAES_SIZE);
447 memset(shdr->Signature, 0x0, SMB2_SIGNATURE_SIZE);
449 rc = crypto_shash_setkey(server->secmech.cmacaes,
450 ses->smb3signingkey, SMB2_CMACAES_SIZE);
452 cifs_dbg(VFS, "%s: Could not set key for cmac aes\n", __func__);
457 * we already allocate sdesccmacaes when we init smb3 signing key,
458 * so unlike smb2 case we do not have to check here if secmech are
461 rc = crypto_shash_init(shash);
463 cifs_dbg(VFS, "%s: Could not init cmac aes\n", __func__);
468 * For SMB2+, __cifs_calc_signature() expects to sign only the actual
469 * data, that is, iov[0] should not contain a rfc1002 length.
471 * Sign the rfc1002 length prior to passing the data (iov[1-N]) down to
472 * __cifs_calc_signature().
475 if (drqst.rq_nvec >= 2 && iov[0].iov_len == 4) {
476 rc = crypto_shash_update(shash, iov[0].iov_base,
479 cifs_dbg(VFS, "%s: Could not update with payload\n",
487 rc = __cifs_calc_signature(&drqst, server, sigptr, shash);
489 memcpy(shdr->Signature, sigptr, SMB2_SIGNATURE_SIZE);
494 /* must be called with server->srv_mutex held */
496 smb2_sign_rqst(struct smb_rqst *rqst, struct TCP_Server_Info *server)
499 struct smb2_sync_hdr *shdr =
500 (struct smb2_sync_hdr *)rqst->rq_iov[0].iov_base;
502 if (!(shdr->Flags & SMB2_FLAGS_SIGNED) ||
503 server->tcpStatus == CifsNeedNegotiate)
506 if (!server->session_estab) {
507 strncpy(shdr->Signature, "BSRSPYL", 8);
511 rc = server->ops->calc_signature(rqst, server);
517 smb2_verify_signature(struct smb_rqst *rqst, struct TCP_Server_Info *server)
520 char server_response_sig[16];
521 struct smb2_sync_hdr *shdr =
522 (struct smb2_sync_hdr *)rqst->rq_iov[0].iov_base;
524 if ((shdr->Command == SMB2_NEGOTIATE) ||
525 (shdr->Command == SMB2_SESSION_SETUP) ||
526 (shdr->Command == SMB2_OPLOCK_BREAK) ||
527 (!server->session_estab))
531 * BB what if signatures are supposed to be on for session but
532 * server does not send one? BB
535 /* Do not need to verify session setups with signature "BSRSPYL " */
536 if (memcmp(shdr->Signature, "BSRSPYL ", 8) == 0)
537 cifs_dbg(FYI, "dummy signature received for smb command 0x%x\n",
541 * Save off the origiginal signature so we can modify the smb and check
542 * our calculated signature against what the server sent.
544 memcpy(server_response_sig, shdr->Signature, SMB2_SIGNATURE_SIZE);
546 memset(shdr->Signature, 0, SMB2_SIGNATURE_SIZE);
548 mutex_lock(&server->srv_mutex);
549 rc = server->ops->calc_signature(rqst, server);
550 mutex_unlock(&server->srv_mutex);
555 if (memcmp(server_response_sig, shdr->Signature, SMB2_SIGNATURE_SIZE))
562 * Set message id for the request. Should be called after wait_for_free_request
563 * and when srv_mutex is held.
566 smb2_seq_num_into_buf(struct TCP_Server_Info *server,
567 struct smb2_sync_hdr *shdr)
569 unsigned int i, num = le16_to_cpu(shdr->CreditCharge);
571 shdr->MessageId = get_next_mid64(server);
572 /* skip message numbers according to CreditCharge field */
573 for (i = 1; i < num; i++)
574 get_next_mid(server);
577 static struct mid_q_entry *
578 smb2_mid_entry_alloc(const struct smb2_sync_hdr *shdr,
579 struct TCP_Server_Info *server)
581 struct mid_q_entry *temp;
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->pid = current->pid;
593 temp->command = shdr->Command; /* Always LE */
594 temp->when_alloc = jiffies;
595 temp->server = server;
598 * The default is for the mid to be synchronous, so the
599 * default callback just wakes up the current task.
601 temp->callback = cifs_wake_up_task;
602 temp->callback_data = current;
604 atomic_inc(&midCount);
605 temp->mid_state = MID_REQUEST_ALLOCATED;
610 smb2_get_mid_entry(struct cifs_ses *ses, struct smb2_sync_hdr *shdr,
611 struct mid_q_entry **mid)
613 if (ses->server->tcpStatus == CifsExiting)
616 if (ses->server->tcpStatus == CifsNeedReconnect) {
617 cifs_dbg(FYI, "tcp session dead - return to caller to retry\n");
621 if (ses->status == CifsNew) {
622 if ((shdr->Command != SMB2_SESSION_SETUP) &&
623 (shdr->Command != SMB2_NEGOTIATE))
625 /* else ok - we are setting up session */
628 if (ses->status == CifsExiting) {
629 if (shdr->Command != SMB2_LOGOFF)
631 /* else ok - we are shutting down the session */
634 *mid = smb2_mid_entry_alloc(shdr, ses->server);
637 spin_lock(&GlobalMid_Lock);
638 list_add_tail(&(*mid)->qhead, &ses->server->pending_mid_q);
639 spin_unlock(&GlobalMid_Lock);
644 smb2_check_receive(struct mid_q_entry *mid, struct TCP_Server_Info *server,
647 unsigned int len = mid->resp_buf_size;
649 struct smb_rqst rqst = { .rq_iov = iov,
652 iov[0].iov_base = (char *)mid->resp_buf;
653 iov[0].iov_len = len;
655 dump_smb(mid->resp_buf, min_t(u32, 80, len));
656 /* convert the length into a more usable form */
657 if (len > 24 && server->sign && !mid->decrypted) {
660 rc = smb2_verify_signature(&rqst, server);
662 cifs_dbg(VFS, "SMB signature verification returned error = %d\n",
666 return map_smb2_to_linux_error(mid->resp_buf, log_error);
670 smb2_setup_request(struct cifs_ses *ses, struct smb_rqst *rqst)
673 struct smb2_sync_hdr *shdr =
674 (struct smb2_sync_hdr *)rqst->rq_iov[0].iov_base;
675 struct mid_q_entry *mid;
677 smb2_seq_num_into_buf(ses->server, shdr);
679 rc = smb2_get_mid_entry(ses, shdr, &mid);
682 rc = smb2_sign_rqst(rqst, ses->server);
684 cifs_delete_mid(mid);
691 smb2_setup_async_request(struct TCP_Server_Info *server, struct smb_rqst *rqst)
694 struct smb2_sync_hdr *shdr =
695 (struct smb2_sync_hdr *)rqst->rq_iov[0].iov_base;
696 struct mid_q_entry *mid;
698 smb2_seq_num_into_buf(server, shdr);
700 mid = smb2_mid_entry_alloc(shdr, server);
702 return ERR_PTR(-ENOMEM);
704 rc = smb2_sign_rqst(rqst, server);
706 DeleteMidQEntry(mid);
714 smb3_crypto_aead_allocate(struct TCP_Server_Info *server)
716 struct crypto_aead *tfm;
718 if (!server->secmech.ccmaesencrypt) {
719 tfm = crypto_alloc_aead("ccm(aes)", 0, 0);
721 cifs_dbg(VFS, "%s: Failed to alloc encrypt aead\n",
725 server->secmech.ccmaesencrypt = tfm;
728 if (!server->secmech.ccmaesdecrypt) {
729 tfm = crypto_alloc_aead("ccm(aes)", 0, 0);
731 crypto_free_aead(server->secmech.ccmaesencrypt);
732 server->secmech.ccmaesencrypt = NULL;
733 cifs_dbg(VFS, "%s: Failed to alloc decrypt aead\n",
737 server->secmech.ccmaesdecrypt = tfm;