2 * eCryptfs: Linux filesystem encryption layer
3 * In-kernel key management code. Includes functions to parse and
4 * write authentication token-related packets with the underlying
7 * Copyright (C) 2004-2006 International Business Machines Corp.
8 * Author(s): Michael A. Halcrow <mhalcrow@us.ibm.com>
9 * Michael C. Thompson <mcthomps@us.ibm.com>
10 * Trevor S. Highland <trevor.highland@gmail.com>
12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License as
14 * published by the Free Software Foundation; either version 2 of the
15 * License, or (at your option) any later version.
17 * This program is distributed in the hope that it will be useful, but
18 * WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 * General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
28 #include <linux/string.h>
29 #include <linux/syscalls.h>
30 #include <linux/pagemap.h>
31 #include <linux/key.h>
32 #include <linux/random.h>
33 #include <linux/crypto.h>
34 #include <linux/scatterlist.h>
35 #include "ecryptfs_kernel.h"
38 * request_key returned an error instead of a valid key address;
39 * determine the type of error, make appropriate log entries, and
40 * return an error code.
42 static int process_request_key_err(long err_code)
48 ecryptfs_printk(KERN_WARNING, "No key\n");
52 ecryptfs_printk(KERN_WARNING, "Key expired\n");
56 ecryptfs_printk(KERN_WARNING, "Key revoked\n");
60 ecryptfs_printk(KERN_WARNING, "Unknown error code: "
61 "[0x%.16x]\n", err_code);
69 * @data: Pointer to memory containing length at offset
70 * @size: This function writes the decoded size to this memory
71 * address; zero on error
72 * @length_size: The number of bytes occupied by the encoded length
74 * Returns zero on success; non-zero on error
76 static int parse_packet_length(unsigned char *data, size_t *size,
85 (*size) = (unsigned char)data[0];
87 } else if (data[0] < 224) {
89 (*size) = (((unsigned char)(data[0]) - 192) * 256);
90 (*size) += ((unsigned char)(data[1]) + 192);
92 } else if (data[0] == 255) {
93 /* Five-byte length; we're not supposed to see this */
94 ecryptfs_printk(KERN_ERR, "Five-byte packet length not "
99 ecryptfs_printk(KERN_ERR, "Error parsing packet length\n");
108 * write_packet_length
109 * @dest: The byte array target into which to write the length. Must
110 * have at least 5 bytes allocated.
111 * @size: The length to write.
112 * @packet_size_length: The number of bytes used to encode the packet
113 * length is written to this address.
115 * Returns zero on success; non-zero on error.
117 static int write_packet_length(char *dest, size_t size,
118 size_t *packet_size_length)
124 (*packet_size_length) = 1;
125 } else if (size < 65536) {
126 dest[0] = (((size - 192) / 256) + 192);
127 dest[1] = ((size - 192) % 256);
128 (*packet_size_length) = 2;
131 ecryptfs_printk(KERN_WARNING,
132 "Unsupported packet size: [%d]\n", size);
138 write_tag_64_packet(char *signature, struct ecryptfs_session_key *session_key,
139 char **packet, size_t *packet_len)
143 size_t packet_size_len;
148 * ***** TAG 64 Packet Format *****
149 * | Content Type | 1 byte |
150 * | Key Identifier Size | 1 or 2 bytes |
151 * | Key Identifier | arbitrary |
152 * | Encrypted File Encryption Key Size | 1 or 2 bytes |
153 * | Encrypted File Encryption Key | arbitrary |
155 data_len = (5 + ECRYPTFS_SIG_SIZE_HEX
156 + session_key->encrypted_key_size);
157 *packet = kmalloc(data_len, GFP_KERNEL);
160 ecryptfs_printk(KERN_ERR, "Unable to allocate memory\n");
164 message[i++] = ECRYPTFS_TAG_64_PACKET_TYPE;
165 rc = write_packet_length(&message[i], ECRYPTFS_SIG_SIZE_HEX,
168 ecryptfs_printk(KERN_ERR, "Error generating tag 64 packet "
169 "header; cannot generate packet length\n");
172 i += packet_size_len;
173 memcpy(&message[i], signature, ECRYPTFS_SIG_SIZE_HEX);
174 i += ECRYPTFS_SIG_SIZE_HEX;
175 rc = write_packet_length(&message[i], session_key->encrypted_key_size,
178 ecryptfs_printk(KERN_ERR, "Error generating tag 64 packet "
179 "header; cannot generate packet length\n");
182 i += packet_size_len;
183 memcpy(&message[i], session_key->encrypted_key,
184 session_key->encrypted_key_size);
185 i += session_key->encrypted_key_size;
192 parse_tag_65_packet(struct ecryptfs_session_key *session_key, u16 *cipher_code,
193 struct ecryptfs_message *msg)
201 u16 expected_checksum = 0;
205 * ***** TAG 65 Packet Format *****
206 * | Content Type | 1 byte |
207 * | Status Indicator | 1 byte |
208 * | File Encryption Key Size | 1 or 2 bytes |
209 * | File Encryption Key | arbitrary |
211 message_len = msg->data_len;
213 if (message_len < 4) {
217 if (data[i++] != ECRYPTFS_TAG_65_PACKET_TYPE) {
218 ecryptfs_printk(KERN_ERR, "Type should be ECRYPTFS_TAG_65\n");
223 ecryptfs_printk(KERN_ERR, "Status indicator has non-zero value "
224 "[%d]\n", data[i-1]);
228 rc = parse_packet_length(&data[i], &m_size, &data_len);
230 ecryptfs_printk(KERN_WARNING, "Error parsing packet length; "
235 if (message_len < (i + m_size)) {
236 ecryptfs_printk(KERN_ERR, "The received netlink message is "
237 "shorter than expected\n");
242 ecryptfs_printk(KERN_ERR,
243 "The decrypted key is not long enough to "
244 "include a cipher code and checksum\n");
248 *cipher_code = data[i++];
249 /* The decrypted key includes 1 byte cipher code and 2 byte checksum */
250 session_key->decrypted_key_size = m_size - 3;
251 if (session_key->decrypted_key_size > ECRYPTFS_MAX_KEY_BYTES) {
252 ecryptfs_printk(KERN_ERR, "key_size [%d] larger than "
253 "the maximum key size [%d]\n",
254 session_key->decrypted_key_size,
255 ECRYPTFS_MAX_ENCRYPTED_KEY_BYTES);
259 memcpy(session_key->decrypted_key, &data[i],
260 session_key->decrypted_key_size);
261 i += session_key->decrypted_key_size;
262 expected_checksum += (unsigned char)(data[i++]) << 8;
263 expected_checksum += (unsigned char)(data[i++]);
264 for (i = 0; i < session_key->decrypted_key_size; i++)
265 checksum += session_key->decrypted_key[i];
266 if (expected_checksum != checksum) {
267 ecryptfs_printk(KERN_ERR, "Invalid checksum for file "
268 "encryption key; expected [%x]; calculated "
269 "[%x]\n", expected_checksum, checksum);
278 write_tag_66_packet(char *signature, size_t cipher_code,
279 struct ecryptfs_crypt_stat *crypt_stat, char **packet,
286 size_t packet_size_len;
291 * ***** TAG 66 Packet Format *****
292 * | Content Type | 1 byte |
293 * | Key Identifier Size | 1 or 2 bytes |
294 * | Key Identifier | arbitrary |
295 * | File Encryption Key Size | 1 or 2 bytes |
296 * | File Encryption Key | arbitrary |
298 data_len = (5 + ECRYPTFS_SIG_SIZE_HEX + crypt_stat->key_size);
299 *packet = kmalloc(data_len, GFP_KERNEL);
302 ecryptfs_printk(KERN_ERR, "Unable to allocate memory\n");
306 message[i++] = ECRYPTFS_TAG_66_PACKET_TYPE;
307 rc = write_packet_length(&message[i], ECRYPTFS_SIG_SIZE_HEX,
310 ecryptfs_printk(KERN_ERR, "Error generating tag 66 packet "
311 "header; cannot generate packet length\n");
314 i += packet_size_len;
315 memcpy(&message[i], signature, ECRYPTFS_SIG_SIZE_HEX);
316 i += ECRYPTFS_SIG_SIZE_HEX;
317 /* The encrypted key includes 1 byte cipher code and 2 byte checksum */
318 rc = write_packet_length(&message[i], crypt_stat->key_size + 3,
321 ecryptfs_printk(KERN_ERR, "Error generating tag 66 packet "
322 "header; cannot generate packet length\n");
325 i += packet_size_len;
326 message[i++] = cipher_code;
327 memcpy(&message[i], crypt_stat->key, crypt_stat->key_size);
328 i += crypt_stat->key_size;
329 for (j = 0; j < crypt_stat->key_size; j++)
330 checksum += crypt_stat->key[j];
331 message[i++] = (checksum / 256) % 256;
332 message[i++] = (checksum % 256);
339 parse_tag_67_packet(struct ecryptfs_key_record *key_rec,
340 struct ecryptfs_message *msg)
349 * ***** TAG 65 Packet Format *****
350 * | Content Type | 1 byte |
351 * | Status Indicator | 1 byte |
352 * | Encrypted File Encryption Key Size | 1 or 2 bytes |
353 * | Encrypted File Encryption Key | arbitrary |
355 message_len = msg->data_len;
357 /* verify that everything through the encrypted FEK size is present */
358 if (message_len < 4) {
362 if (data[i++] != ECRYPTFS_TAG_67_PACKET_TYPE) {
363 ecryptfs_printk(KERN_ERR, "Type should be ECRYPTFS_TAG_67\n");
368 ecryptfs_printk(KERN_ERR, "Status indicator has non zero value"
369 " [%d]\n", data[i-1]);
373 rc = parse_packet_length(&data[i], &key_rec->enc_key_size, &data_len);
375 ecryptfs_printk(KERN_WARNING, "Error parsing packet length; "
380 if (message_len < (i + key_rec->enc_key_size)) {
381 ecryptfs_printk(KERN_ERR, "message_len [%d]; max len is [%d]\n",
382 message_len, (i + key_rec->enc_key_size));
386 if (key_rec->enc_key_size > ECRYPTFS_MAX_ENCRYPTED_KEY_BYTES) {
387 ecryptfs_printk(KERN_ERR, "Encrypted key_size [%d] larger than "
388 "the maximum key size [%d]\n",
389 key_rec->enc_key_size,
390 ECRYPTFS_MAX_ENCRYPTED_KEY_BYTES);
394 memcpy(key_rec->enc_key, &data[i], key_rec->enc_key_size);
400 ecryptfs_get_auth_tok_sig(char **sig, struct ecryptfs_auth_tok *auth_tok)
405 switch (auth_tok->token_type) {
406 case ECRYPTFS_PASSWORD:
407 (*sig) = auth_tok->token.password.signature;
409 case ECRYPTFS_PRIVATE_KEY:
410 (*sig) = auth_tok->token.private_key.signature;
413 printk(KERN_ERR "Cannot get sig for auth_tok of type [%d]\n",
414 auth_tok->token_type);
421 * decrypt_pki_encrypted_session_key - Decrypt the session key with the given auth_tok.
422 * @auth_tok: The key authentication token used to decrypt the session key
423 * @crypt_stat: The cryptographic context
425 * Returns zero on success; non-zero error otherwise.
428 decrypt_pki_encrypted_session_key(struct ecryptfs_auth_tok *auth_tok,
429 struct ecryptfs_crypt_stat *crypt_stat)
432 struct ecryptfs_msg_ctx *msg_ctx;
433 struct ecryptfs_message *msg = NULL;
435 char *netlink_message;
436 size_t netlink_message_length;
439 rc = ecryptfs_get_auth_tok_sig(&auth_tok_sig, auth_tok);
441 printk(KERN_ERR "Unrecognized auth tok type: [%d]\n",
442 auth_tok->token_type);
445 rc = write_tag_64_packet(auth_tok_sig, &(auth_tok->session_key),
446 &netlink_message, &netlink_message_length);
448 ecryptfs_printk(KERN_ERR, "Failed to write tag 64 packet");
451 rc = ecryptfs_send_message(ecryptfs_transport, netlink_message,
452 netlink_message_length, &msg_ctx);
454 ecryptfs_printk(KERN_ERR, "Error sending netlink message\n");
457 rc = ecryptfs_wait_for_response(msg_ctx, &msg);
459 ecryptfs_printk(KERN_ERR, "Failed to receive tag 65 packet "
460 "from the user space daemon\n");
464 rc = parse_tag_65_packet(&(auth_tok->session_key),
467 printk(KERN_ERR "Failed to parse tag 65 packet; rc = [%d]\n",
471 auth_tok->session_key.flags |= ECRYPTFS_CONTAINS_DECRYPTED_KEY;
472 memcpy(crypt_stat->key, auth_tok->session_key.decrypted_key,
473 auth_tok->session_key.decrypted_key_size);
474 crypt_stat->key_size = auth_tok->session_key.decrypted_key_size;
475 rc = ecryptfs_cipher_code_to_string(crypt_stat->cipher, cipher_code);
477 ecryptfs_printk(KERN_ERR, "Cipher code [%d] is invalid\n",
481 crypt_stat->flags |= ECRYPTFS_KEY_VALID;
482 if (ecryptfs_verbosity > 0) {
483 ecryptfs_printk(KERN_DEBUG, "Decrypted session key:\n");
484 ecryptfs_dump_hex(crypt_stat->key,
485 crypt_stat->key_size);
493 static void wipe_auth_tok_list(struct list_head *auth_tok_list_head)
495 struct ecryptfs_auth_tok_list_item *auth_tok_list_item;
496 struct ecryptfs_auth_tok_list_item *auth_tok_list_item_tmp;
498 list_for_each_entry_safe(auth_tok_list_item, auth_tok_list_item_tmp,
499 auth_tok_list_head, list) {
500 list_del(&auth_tok_list_item->list);
501 kmem_cache_free(ecryptfs_auth_tok_list_item_cache,
506 struct kmem_cache *ecryptfs_auth_tok_list_item_cache;
510 * @crypt_stat: The cryptographic context to modify based on packet contents
511 * @data: The raw bytes of the packet.
512 * @auth_tok_list: eCryptfs parses packets into authentication tokens;
513 * a new authentication token will be placed at the
514 * end of this list for this packet.
515 * @new_auth_tok: Pointer to a pointer to memory that this function
516 * allocates; sets the memory address of the pointer to
517 * NULL on error. This object is added to the
519 * @packet_size: This function writes the size of the parsed packet
520 * into this memory location; zero on error.
521 * @max_packet_size: The maximum allowable packet size
523 * Returns zero on success; non-zero on error.
526 parse_tag_1_packet(struct ecryptfs_crypt_stat *crypt_stat,
527 unsigned char *data, struct list_head *auth_tok_list,
528 struct ecryptfs_auth_tok **new_auth_tok,
529 size_t *packet_size, size_t max_packet_size)
532 struct ecryptfs_auth_tok_list_item *auth_tok_list_item;
537 (*new_auth_tok) = NULL;
539 * This format is inspired by OpenPGP; see RFC 2440
542 * Tag 1 identifier (1 byte)
543 * Max Tag 1 packet size (max 3 bytes)
545 * Key identifier (8 bytes; ECRYPTFS_SIG_SIZE)
546 * Cipher identifier (1 byte)
547 * Encrypted key size (arbitrary)
549 * 12 bytes minimum packet size
551 if (unlikely(max_packet_size < 12)) {
552 printk(KERN_ERR "Invalid max packet size; must be >=12\n");
556 if (data[(*packet_size)++] != ECRYPTFS_TAG_1_PACKET_TYPE) {
557 printk(KERN_ERR "Enter w/ first byte != 0x%.2x\n",
558 ECRYPTFS_TAG_1_PACKET_TYPE);
562 /* Released: wipe_auth_tok_list called in ecryptfs_parse_packet_set or
563 * at end of function upon failure */
565 kmem_cache_zalloc(ecryptfs_auth_tok_list_item_cache,
567 if (!auth_tok_list_item) {
568 printk(KERN_ERR "Unable to allocate memory\n");
572 (*new_auth_tok) = &auth_tok_list_item->auth_tok;
573 rc = parse_packet_length(&data[(*packet_size)], &body_size,
576 printk(KERN_WARNING "Error parsing packet length; "
580 if (unlikely(body_size < (ECRYPTFS_SIG_SIZE + 2))) {
581 printk(KERN_WARNING "Invalid body size ([%td])\n", body_size);
585 (*packet_size) += length_size;
586 if (unlikely((*packet_size) + body_size > max_packet_size)) {
587 printk(KERN_WARNING "Packet size exceeds max\n");
591 if (unlikely(data[(*packet_size)++] != 0x03)) {
592 printk(KERN_WARNING "Unknown version number [%d]\n",
593 data[(*packet_size) - 1]);
597 ecryptfs_to_hex((*new_auth_tok)->token.private_key.signature,
598 &data[(*packet_size)], ECRYPTFS_SIG_SIZE);
599 *packet_size += ECRYPTFS_SIG_SIZE;
600 /* This byte is skipped because the kernel does not need to
601 * know which public key encryption algorithm was used */
603 (*new_auth_tok)->session_key.encrypted_key_size =
604 body_size - (ECRYPTFS_SIG_SIZE + 2);
605 if ((*new_auth_tok)->session_key.encrypted_key_size
606 > ECRYPTFS_MAX_ENCRYPTED_KEY_BYTES) {
607 printk(KERN_WARNING "Tag 1 packet contains key larger "
608 "than ECRYPTFS_MAX_ENCRYPTED_KEY_BYTES");
612 memcpy((*new_auth_tok)->session_key.encrypted_key,
613 &data[(*packet_size)], (body_size - (ECRYPTFS_SIG_SIZE + 2)));
614 (*packet_size) += (*new_auth_tok)->session_key.encrypted_key_size;
615 (*new_auth_tok)->session_key.flags &=
616 ~ECRYPTFS_CONTAINS_DECRYPTED_KEY;
617 (*new_auth_tok)->session_key.flags |=
618 ECRYPTFS_CONTAINS_ENCRYPTED_KEY;
619 (*new_auth_tok)->token_type = ECRYPTFS_PRIVATE_KEY;
620 (*new_auth_tok)->flags = 0;
621 (*new_auth_tok)->session_key.flags &=
622 ~(ECRYPTFS_USERSPACE_SHOULD_TRY_TO_DECRYPT);
623 (*new_auth_tok)->session_key.flags &=
624 ~(ECRYPTFS_USERSPACE_SHOULD_TRY_TO_ENCRYPT);
625 list_add(&auth_tok_list_item->list, auth_tok_list);
628 (*new_auth_tok) = NULL;
629 memset(auth_tok_list_item, 0,
630 sizeof(struct ecryptfs_auth_tok_list_item));
631 kmem_cache_free(ecryptfs_auth_tok_list_item_cache,
641 * @crypt_stat: The cryptographic context to modify based on packet
643 * @data: The raw bytes of the packet.
644 * @auth_tok_list: eCryptfs parses packets into authentication tokens;
645 * a new authentication token will be placed at the end
646 * of this list for this packet.
647 * @new_auth_tok: Pointer to a pointer to memory that this function
648 * allocates; sets the memory address of the pointer to
649 * NULL on error. This object is added to the
651 * @packet_size: This function writes the size of the parsed packet
652 * into this memory location; zero on error.
653 * @max_packet_size: maximum number of bytes to parse
655 * Returns zero on success; non-zero on error.
658 parse_tag_3_packet(struct ecryptfs_crypt_stat *crypt_stat,
659 unsigned char *data, struct list_head *auth_tok_list,
660 struct ecryptfs_auth_tok **new_auth_tok,
661 size_t *packet_size, size_t max_packet_size)
664 struct ecryptfs_auth_tok_list_item *auth_tok_list_item;
669 (*new_auth_tok) = NULL;
671 *This format is inspired by OpenPGP; see RFC 2440
674 * Tag 3 identifier (1 byte)
675 * Max Tag 3 packet size (max 3 bytes)
677 * Cipher code (1 byte)
678 * S2K specifier (1 byte)
679 * Hash identifier (1 byte)
680 * Salt (ECRYPTFS_SALT_SIZE)
681 * Hash iterations (1 byte)
682 * Encrypted key (arbitrary)
684 * (ECRYPTFS_SALT_SIZE + 7) minimum packet size
686 if (max_packet_size < (ECRYPTFS_SALT_SIZE + 7)) {
687 printk(KERN_ERR "Max packet size too large\n");
691 if (data[(*packet_size)++] != ECRYPTFS_TAG_3_PACKET_TYPE) {
692 printk(KERN_ERR "First byte != 0x%.2x; invalid packet\n",
693 ECRYPTFS_TAG_3_PACKET_TYPE);
697 /* Released: wipe_auth_tok_list called in ecryptfs_parse_packet_set or
698 * at end of function upon failure */
700 kmem_cache_zalloc(ecryptfs_auth_tok_list_item_cache, GFP_KERNEL);
701 if (!auth_tok_list_item) {
702 printk(KERN_ERR "Unable to allocate memory\n");
706 (*new_auth_tok) = &auth_tok_list_item->auth_tok;
707 rc = parse_packet_length(&data[(*packet_size)], &body_size,
710 printk(KERN_WARNING "Error parsing packet length; rc = [%d]\n",
714 if (unlikely(body_size < (ECRYPTFS_SALT_SIZE + 5))) {
715 printk(KERN_WARNING "Invalid body size ([%td])\n", body_size);
719 (*packet_size) += length_size;
720 if (unlikely((*packet_size) + body_size > max_packet_size)) {
721 printk(KERN_ERR "Packet size exceeds max\n");
725 (*new_auth_tok)->session_key.encrypted_key_size =
726 (body_size - (ECRYPTFS_SALT_SIZE + 5));
727 if (unlikely(data[(*packet_size)++] != 0x04)) {
728 printk(KERN_WARNING "Unknown version number [%d]\n",
729 data[(*packet_size) - 1]);
733 ecryptfs_cipher_code_to_string(crypt_stat->cipher,
734 (u16)data[(*packet_size)]);
735 /* A little extra work to differentiate among the AES key
736 * sizes; see RFC2440 */
737 switch(data[(*packet_size)++]) {
738 case RFC2440_CIPHER_AES_192:
739 crypt_stat->key_size = 24;
742 crypt_stat->key_size =
743 (*new_auth_tok)->session_key.encrypted_key_size;
745 ecryptfs_init_crypt_ctx(crypt_stat);
746 if (unlikely(data[(*packet_size)++] != 0x03)) {
747 printk(KERN_WARNING "Only S2K ID 3 is currently supported\n");
751 /* TODO: finish the hash mapping */
752 switch (data[(*packet_size)++]) {
753 case 0x01: /* See RFC2440 for these numbers and their mappings */
755 memcpy((*new_auth_tok)->token.password.salt,
756 &data[(*packet_size)], ECRYPTFS_SALT_SIZE);
757 (*packet_size) += ECRYPTFS_SALT_SIZE;
758 /* This conversion was taken straight from RFC2440 */
759 (*new_auth_tok)->token.password.hash_iterations =
760 ((u32) 16 + (data[(*packet_size)] & 15))
761 << ((data[(*packet_size)] >> 4) + 6);
763 /* Friendly reminder:
764 * (*new_auth_tok)->session_key.encrypted_key_size =
765 * (body_size - (ECRYPTFS_SALT_SIZE + 5)); */
766 memcpy((*new_auth_tok)->session_key.encrypted_key,
767 &data[(*packet_size)],
768 (*new_auth_tok)->session_key.encrypted_key_size);
770 (*new_auth_tok)->session_key.encrypted_key_size;
771 (*new_auth_tok)->session_key.flags &=
772 ~ECRYPTFS_CONTAINS_DECRYPTED_KEY;
773 (*new_auth_tok)->session_key.flags |=
774 ECRYPTFS_CONTAINS_ENCRYPTED_KEY;
775 (*new_auth_tok)->token.password.hash_algo = 0x01; /* MD5 */
778 ecryptfs_printk(KERN_ERR, "Unsupported hash algorithm: "
779 "[%d]\n", data[(*packet_size) - 1]);
783 (*new_auth_tok)->token_type = ECRYPTFS_PASSWORD;
784 /* TODO: Parametarize; we might actually want userspace to
785 * decrypt the session key. */
786 (*new_auth_tok)->session_key.flags &=
787 ~(ECRYPTFS_USERSPACE_SHOULD_TRY_TO_DECRYPT);
788 (*new_auth_tok)->session_key.flags &=
789 ~(ECRYPTFS_USERSPACE_SHOULD_TRY_TO_ENCRYPT);
790 list_add(&auth_tok_list_item->list, auth_tok_list);
793 (*new_auth_tok) = NULL;
794 memset(auth_tok_list_item, 0,
795 sizeof(struct ecryptfs_auth_tok_list_item));
796 kmem_cache_free(ecryptfs_auth_tok_list_item_cache,
805 * parse_tag_11_packet
806 * @data: The raw bytes of the packet
807 * @contents: This function writes the data contents of the literal
808 * packet into this memory location
809 * @max_contents_bytes: The maximum number of bytes that this function
810 * is allowed to write into contents
811 * @tag_11_contents_size: This function writes the size of the parsed
812 * contents into this memory location; zero on
814 * @packet_size: This function writes the size of the parsed packet
815 * into this memory location; zero on error
816 * @max_packet_size: maximum number of bytes to parse
818 * Returns zero on success; non-zero on error.
821 parse_tag_11_packet(unsigned char *data, unsigned char *contents,
822 size_t max_contents_bytes, size_t *tag_11_contents_size,
823 size_t *packet_size, size_t max_packet_size)
830 (*tag_11_contents_size) = 0;
831 /* This format is inspired by OpenPGP; see RFC 2440
834 * Tag 11 identifier (1 byte)
835 * Max Tag 11 packet size (max 3 bytes)
836 * Binary format specifier (1 byte)
837 * Filename length (1 byte)
838 * Filename ("_CONSOLE") (8 bytes)
839 * Modification date (4 bytes)
840 * Literal data (arbitrary)
842 * We need at least 16 bytes of data for the packet to even be
845 if (max_packet_size < 16) {
846 printk(KERN_ERR "Maximum packet size too small\n");
850 if (data[(*packet_size)++] != ECRYPTFS_TAG_11_PACKET_TYPE) {
851 printk(KERN_WARNING "Invalid tag 11 packet format\n");
855 rc = parse_packet_length(&data[(*packet_size)], &body_size,
858 printk(KERN_WARNING "Invalid tag 11 packet format\n");
861 if (body_size < 14) {
862 printk(KERN_WARNING "Invalid body size ([%td])\n", body_size);
866 (*packet_size) += length_size;
867 (*tag_11_contents_size) = (body_size - 14);
868 if (unlikely((*packet_size) + body_size + 1 > max_packet_size)) {
869 printk(KERN_ERR "Packet size exceeds max\n");
873 if (data[(*packet_size)++] != 0x62) {
874 printk(KERN_WARNING "Unrecognizable packet\n");
878 if (data[(*packet_size)++] != 0x08) {
879 printk(KERN_WARNING "Unrecognizable packet\n");
883 (*packet_size) += 12; /* Ignore filename and modification date */
884 memcpy(contents, &data[(*packet_size)], (*tag_11_contents_size));
885 (*packet_size) += (*tag_11_contents_size);
889 (*tag_11_contents_size) = 0;
895 ecryptfs_find_global_auth_tok_for_sig(
896 struct ecryptfs_global_auth_tok **global_auth_tok,
897 struct ecryptfs_mount_crypt_stat *mount_crypt_stat, char *sig)
899 struct ecryptfs_global_auth_tok *walker;
902 (*global_auth_tok) = NULL;
903 mutex_lock(&mount_crypt_stat->global_auth_tok_list_mutex);
904 list_for_each_entry(walker,
905 &mount_crypt_stat->global_auth_tok_list,
906 mount_crypt_stat_list) {
907 if (memcmp(walker->sig, sig, ECRYPTFS_SIG_SIZE_HEX) == 0) {
908 (*global_auth_tok) = walker;
914 mutex_unlock(&mount_crypt_stat->global_auth_tok_list_mutex);
919 * ecryptfs_verify_version
920 * @version: The version number to confirm
922 * Returns zero on good version; non-zero otherwise
924 static int ecryptfs_verify_version(u16 version)
930 major = ((version >> 8) & 0xFF);
931 minor = (version & 0xFF);
932 if (major != ECRYPTFS_VERSION_MAJOR) {
933 ecryptfs_printk(KERN_ERR, "Major version number mismatch. "
934 "Expected [%d]; got [%d]\n",
935 ECRYPTFS_VERSION_MAJOR, major);
939 if (minor != ECRYPTFS_VERSION_MINOR) {
940 ecryptfs_printk(KERN_ERR, "Minor version number mismatch. "
941 "Expected [%d]; got [%d]\n",
942 ECRYPTFS_VERSION_MINOR, minor);
950 int ecryptfs_keyring_auth_tok_for_sig(struct key **auth_tok_key,
951 struct ecryptfs_auth_tok **auth_tok,
956 (*auth_tok_key) = request_key(&key_type_user, sig, NULL);
957 if (!(*auth_tok_key) || IS_ERR(*auth_tok_key)) {
958 printk(KERN_ERR "Could not find key with description: [%s]\n",
960 process_request_key_err(PTR_ERR(*auth_tok_key));
964 (*auth_tok) = ecryptfs_get_key_payload_data(*auth_tok_key);
965 if (ecryptfs_verify_version((*auth_tok)->version)) {
967 "Data structure version mismatch. "
968 "Userspace tools must match eCryptfs "
969 "kernel module with major version [%d] "
970 "and minor version [%d]\n",
971 ECRYPTFS_VERSION_MAJOR,
972 ECRYPTFS_VERSION_MINOR);
976 if ((*auth_tok)->token_type != ECRYPTFS_PASSWORD
977 && (*auth_tok)->token_type != ECRYPTFS_PRIVATE_KEY) {
978 printk(KERN_ERR "Invalid auth_tok structure "
979 "returned from key query\n");
988 * ecryptfs_find_auth_tok_for_sig
989 * @auth_tok: Set to the matching auth_tok; NULL if not found
990 * @crypt_stat: inode crypt_stat crypto context
991 * @sig: Sig of auth_tok to find
993 * For now, this function simply looks at the registered auth_tok's
994 * linked off the mount_crypt_stat, so all the auth_toks that can be
995 * used must be registered at mount time. This function could
996 * potentially try a lot harder to find auth_tok's (e.g., by calling
997 * out to ecryptfsd to dynamically retrieve an auth_tok object) so
998 * that static registration of auth_tok's will no longer be necessary.
1000 * Returns zero on no error; non-zero on error
1003 ecryptfs_find_auth_tok_for_sig(
1004 struct ecryptfs_auth_tok **auth_tok,
1005 struct ecryptfs_crypt_stat *crypt_stat, char *sig)
1007 struct ecryptfs_mount_crypt_stat *mount_crypt_stat =
1008 crypt_stat->mount_crypt_stat;
1009 struct ecryptfs_global_auth_tok *global_auth_tok;
1013 if (ecryptfs_find_global_auth_tok_for_sig(&global_auth_tok,
1014 mount_crypt_stat, sig)) {
1015 struct key *auth_tok_key;
1017 rc = ecryptfs_keyring_auth_tok_for_sig(&auth_tok_key, auth_tok,
1020 (*auth_tok) = global_auth_tok->global_auth_tok;
1025 * decrypt_passphrase_encrypted_session_key - Decrypt the session key with the given auth_tok.
1026 * @auth_tok: The passphrase authentication token to use to encrypt the FEK
1027 * @crypt_stat: The cryptographic context
1029 * Returns zero on success; non-zero error otherwise
1032 decrypt_passphrase_encrypted_session_key(struct ecryptfs_auth_tok *auth_tok,
1033 struct ecryptfs_crypt_stat *crypt_stat)
1035 struct scatterlist dst_sg;
1036 struct scatterlist src_sg;
1037 struct mutex *tfm_mutex;
1038 struct blkcipher_desc desc = {
1039 .flags = CRYPTO_TFM_REQ_MAY_SLEEP
1043 if (unlikely(ecryptfs_verbosity > 0)) {
1045 KERN_DEBUG, "Session key encryption key (size [%d]):\n",
1046 auth_tok->token.password.session_key_encryption_key_bytes);
1048 auth_tok->token.password.session_key_encryption_key,
1049 auth_tok->token.password.session_key_encryption_key_bytes);
1051 rc = ecryptfs_get_tfm_and_mutex_for_cipher_name(&desc.tfm, &tfm_mutex,
1052 crypt_stat->cipher);
1054 printk(KERN_ERR "Internal error whilst attempting to get "
1055 "tfm and mutex for cipher name [%s]; rc = [%d]\n",
1056 crypt_stat->cipher, rc);
1059 rc = virt_to_scatterlist(auth_tok->session_key.encrypted_key,
1060 auth_tok->session_key.encrypted_key_size,
1063 printk(KERN_ERR "Internal error whilst attempting to convert "
1064 "auth_tok->session_key.encrypted_key to scatterlist; "
1065 "expected rc = 1; got rc = [%d]. "
1066 "auth_tok->session_key.encrypted_key_size = [%d]\n", rc,
1067 auth_tok->session_key.encrypted_key_size);
1070 auth_tok->session_key.decrypted_key_size =
1071 auth_tok->session_key.encrypted_key_size;
1072 rc = virt_to_scatterlist(auth_tok->session_key.decrypted_key,
1073 auth_tok->session_key.decrypted_key_size,
1076 printk(KERN_ERR "Internal error whilst attempting to convert "
1077 "auth_tok->session_key.decrypted_key to scatterlist; "
1078 "expected rc = 1; got rc = [%d]\n", rc);
1081 mutex_lock(tfm_mutex);
1082 rc = crypto_blkcipher_setkey(
1083 desc.tfm, auth_tok->token.password.session_key_encryption_key,
1084 crypt_stat->key_size);
1085 if (unlikely(rc < 0)) {
1086 mutex_unlock(tfm_mutex);
1087 printk(KERN_ERR "Error setting key for crypto context\n");
1091 rc = crypto_blkcipher_decrypt(&desc, &dst_sg, &src_sg,
1092 auth_tok->session_key.encrypted_key_size);
1093 mutex_unlock(tfm_mutex);
1095 printk(KERN_ERR "Error decrypting; rc = [%d]\n", rc);
1098 auth_tok->session_key.flags |= ECRYPTFS_CONTAINS_DECRYPTED_KEY;
1099 memcpy(crypt_stat->key, auth_tok->session_key.decrypted_key,
1100 auth_tok->session_key.decrypted_key_size);
1101 crypt_stat->flags |= ECRYPTFS_KEY_VALID;
1102 if (unlikely(ecryptfs_verbosity > 0)) {
1103 ecryptfs_printk(KERN_DEBUG, "FEK of size [%d]:\n",
1104 crypt_stat->key_size);
1105 ecryptfs_dump_hex(crypt_stat->key,
1106 crypt_stat->key_size);
1113 * ecryptfs_parse_packet_set
1114 * @crypt_stat: The cryptographic context
1115 * @src: Virtual address of region of memory containing the packets
1116 * @ecryptfs_dentry: The eCryptfs dentry associated with the packet set
1118 * Get crypt_stat to have the file's session key if the requisite key
1119 * is available to decrypt the session key.
1121 * Returns Zero if a valid authentication token was retrieved and
1122 * processed; negative value for file not encrypted or for error
1125 int ecryptfs_parse_packet_set(struct ecryptfs_crypt_stat *crypt_stat,
1127 struct dentry *ecryptfs_dentry)
1130 size_t found_auth_tok;
1131 size_t next_packet_is_auth_tok_packet;
1132 struct list_head auth_tok_list;
1133 struct ecryptfs_auth_tok *matching_auth_tok;
1134 struct ecryptfs_auth_tok *candidate_auth_tok;
1135 char *candidate_auth_tok_sig;
1137 struct ecryptfs_auth_tok *new_auth_tok;
1138 unsigned char sig_tmp_space[ECRYPTFS_SIG_SIZE];
1139 struct ecryptfs_auth_tok_list_item *auth_tok_list_item;
1140 size_t tag_11_contents_size;
1141 size_t tag_11_packet_size;
1144 INIT_LIST_HEAD(&auth_tok_list);
1145 /* Parse the header to find as many packets as we can; these will be
1146 * added the our &auth_tok_list */
1147 next_packet_is_auth_tok_packet = 1;
1148 while (next_packet_is_auth_tok_packet) {
1149 size_t max_packet_size = ((PAGE_CACHE_SIZE - 8) - i);
1152 case ECRYPTFS_TAG_3_PACKET_TYPE:
1153 rc = parse_tag_3_packet(crypt_stat,
1154 (unsigned char *)&src[i],
1155 &auth_tok_list, &new_auth_tok,
1156 &packet_size, max_packet_size);
1158 ecryptfs_printk(KERN_ERR, "Error parsing "
1164 rc = parse_tag_11_packet((unsigned char *)&src[i],
1167 &tag_11_contents_size,
1168 &tag_11_packet_size,
1171 ecryptfs_printk(KERN_ERR, "No valid "
1172 "(ecryptfs-specific) literal "
1173 "packet containing "
1174 "authentication token "
1175 "signature found after "
1180 i += tag_11_packet_size;
1181 if (ECRYPTFS_SIG_SIZE != tag_11_contents_size) {
1182 ecryptfs_printk(KERN_ERR, "Expected "
1183 "signature of size [%d]; "
1186 tag_11_contents_size);
1190 ecryptfs_to_hex(new_auth_tok->token.password.signature,
1191 sig_tmp_space, tag_11_contents_size);
1192 new_auth_tok->token.password.signature[
1193 ECRYPTFS_PASSWORD_SIG_SIZE] = '\0';
1194 crypt_stat->flags |= ECRYPTFS_ENCRYPTED;
1196 case ECRYPTFS_TAG_1_PACKET_TYPE:
1197 rc = parse_tag_1_packet(crypt_stat,
1198 (unsigned char *)&src[i],
1199 &auth_tok_list, &new_auth_tok,
1200 &packet_size, max_packet_size);
1202 ecryptfs_printk(KERN_ERR, "Error parsing "
1208 crypt_stat->flags |= ECRYPTFS_ENCRYPTED;
1210 case ECRYPTFS_TAG_11_PACKET_TYPE:
1211 ecryptfs_printk(KERN_WARNING, "Invalid packet set "
1212 "(Tag 11 not allowed by itself)\n");
1217 ecryptfs_printk(KERN_DEBUG, "No packet at offset "
1218 "[%d] of the file header; hex value of "
1219 "character is [0x%.2x]\n", i, src[i]);
1220 next_packet_is_auth_tok_packet = 0;
1223 if (list_empty(&auth_tok_list)) {
1224 printk(KERN_ERR "The lower file appears to be a non-encrypted "
1225 "eCryptfs file; this is not supported in this version "
1226 "of the eCryptfs kernel module\n");
1230 /* auth_tok_list contains the set of authentication tokens
1231 * parsed from the metadata. We need to find a matching
1232 * authentication token that has the secret component(s)
1233 * necessary to decrypt the EFEK in the auth_tok parsed from
1234 * the metadata. There may be several potential matches, but
1235 * just one will be sufficient to decrypt to get the FEK. */
1236 find_next_matching_auth_tok:
1238 list_for_each_entry(auth_tok_list_item, &auth_tok_list, list) {
1239 candidate_auth_tok = &auth_tok_list_item->auth_tok;
1240 if (unlikely(ecryptfs_verbosity > 0)) {
1241 ecryptfs_printk(KERN_DEBUG,
1242 "Considering cadidate auth tok:\n");
1243 ecryptfs_dump_auth_tok(candidate_auth_tok);
1245 rc = ecryptfs_get_auth_tok_sig(&candidate_auth_tok_sig,
1246 candidate_auth_tok);
1249 "Unrecognized candidate auth tok type: [%d]\n",
1250 candidate_auth_tok->token_type);
1254 ecryptfs_find_auth_tok_for_sig(&matching_auth_tok, crypt_stat,
1255 candidate_auth_tok_sig);
1256 if (matching_auth_tok) {
1258 goto found_matching_auth_tok;
1261 if (!found_auth_tok) {
1262 ecryptfs_printk(KERN_ERR, "Could not find a usable "
1263 "authentication token\n");
1267 found_matching_auth_tok:
1268 if (candidate_auth_tok->token_type == ECRYPTFS_PRIVATE_KEY) {
1269 memcpy(&(candidate_auth_tok->token.private_key),
1270 &(matching_auth_tok->token.private_key),
1271 sizeof(struct ecryptfs_private_key));
1272 rc = decrypt_pki_encrypted_session_key(candidate_auth_tok,
1274 } else if (candidate_auth_tok->token_type == ECRYPTFS_PASSWORD) {
1275 memcpy(&(candidate_auth_tok->token.password),
1276 &(matching_auth_tok->token.password),
1277 sizeof(struct ecryptfs_password));
1278 rc = decrypt_passphrase_encrypted_session_key(
1279 candidate_auth_tok, crypt_stat);
1282 struct ecryptfs_auth_tok_list_item *auth_tok_list_item_tmp;
1284 ecryptfs_printk(KERN_WARNING, "Error decrypting the "
1285 "session key for authentication token with sig "
1286 "[%.*s]; rc = [%d]. Removing auth tok "
1287 "candidate from the list and searching for "
1288 "the next match.\n", candidate_auth_tok_sig,
1289 ECRYPTFS_SIG_SIZE_HEX, rc);
1290 list_for_each_entry_safe(auth_tok_list_item,
1291 auth_tok_list_item_tmp,
1292 &auth_tok_list, list) {
1293 if (candidate_auth_tok
1294 == &auth_tok_list_item->auth_tok) {
1295 list_del(&auth_tok_list_item->list);
1297 ecryptfs_auth_tok_list_item_cache,
1298 auth_tok_list_item);
1299 goto find_next_matching_auth_tok;
1304 rc = ecryptfs_compute_root_iv(crypt_stat);
1306 ecryptfs_printk(KERN_ERR, "Error computing "
1310 rc = ecryptfs_init_crypt_ctx(crypt_stat);
1312 ecryptfs_printk(KERN_ERR, "Error initializing crypto "
1313 "context for cipher [%s]; rc = [%d]\n",
1314 crypt_stat->cipher, rc);
1317 wipe_auth_tok_list(&auth_tok_list);
1323 pki_encrypt_session_key(struct ecryptfs_auth_tok *auth_tok,
1324 struct ecryptfs_crypt_stat *crypt_stat,
1325 struct ecryptfs_key_record *key_rec)
1327 struct ecryptfs_msg_ctx *msg_ctx = NULL;
1328 char *netlink_payload;
1329 size_t netlink_payload_length;
1330 struct ecryptfs_message *msg;
1333 rc = write_tag_66_packet(auth_tok->token.private_key.signature,
1334 ecryptfs_code_for_cipher_string(crypt_stat),
1335 crypt_stat, &netlink_payload,
1336 &netlink_payload_length);
1338 ecryptfs_printk(KERN_ERR, "Error generating tag 66 packet\n");
1341 rc = ecryptfs_send_message(ecryptfs_transport, netlink_payload,
1342 netlink_payload_length, &msg_ctx);
1344 ecryptfs_printk(KERN_ERR, "Error sending netlink message\n");
1347 rc = ecryptfs_wait_for_response(msg_ctx, &msg);
1349 ecryptfs_printk(KERN_ERR, "Failed to receive tag 67 packet "
1350 "from the user space daemon\n");
1354 rc = parse_tag_67_packet(key_rec, msg);
1356 ecryptfs_printk(KERN_ERR, "Error parsing tag 67 packet\n");
1359 if (netlink_payload)
1360 kfree(netlink_payload);
1364 * write_tag_1_packet - Write an RFC2440-compatible tag 1 (public key) packet
1365 * @dest: Buffer into which to write the packet
1366 * @remaining_bytes: Maximum number of bytes that can be writtn
1367 * @auth_tok: The authentication token used for generating the tag 1 packet
1368 * @crypt_stat: The cryptographic context
1369 * @key_rec: The key record struct for the tag 1 packet
1370 * @packet_size: This function will write the number of bytes that end
1371 * up constituting the packet; set to zero on error
1373 * Returns zero on success; non-zero on error.
1376 write_tag_1_packet(char *dest, size_t *remaining_bytes,
1377 struct ecryptfs_auth_tok *auth_tok,
1378 struct ecryptfs_crypt_stat *crypt_stat,
1379 struct ecryptfs_key_record *key_rec, size_t *packet_size)
1382 size_t encrypted_session_key_valid = 0;
1383 size_t packet_size_length;
1384 size_t max_packet_size;
1388 ecryptfs_from_hex(key_rec->sig, auth_tok->token.private_key.signature,
1390 encrypted_session_key_valid = 0;
1391 for (i = 0; i < crypt_stat->key_size; i++)
1392 encrypted_session_key_valid |=
1393 auth_tok->session_key.encrypted_key[i];
1394 if (encrypted_session_key_valid) {
1395 memcpy(key_rec->enc_key,
1396 auth_tok->session_key.encrypted_key,
1397 auth_tok->session_key.encrypted_key_size);
1398 goto encrypted_session_key_set;
1400 if (auth_tok->session_key.encrypted_key_size == 0)
1401 auth_tok->session_key.encrypted_key_size =
1402 auth_tok->token.private_key.key_size;
1403 rc = pki_encrypt_session_key(auth_tok, crypt_stat, key_rec);
1405 ecryptfs_printk(KERN_ERR, "Failed to encrypt session key "
1409 if (ecryptfs_verbosity > 0) {
1410 ecryptfs_printk(KERN_DEBUG, "Encrypted key:\n");
1411 ecryptfs_dump_hex(key_rec->enc_key, key_rec->enc_key_size);
1413 encrypted_session_key_set:
1414 /* This format is inspired by OpenPGP; see RFC 2440
1416 max_packet_size = (1 /* Tag 1 identifier */
1417 + 3 /* Max Tag 1 packet size */
1419 + ECRYPTFS_SIG_SIZE /* Key identifier */
1420 + 1 /* Cipher identifier */
1421 + key_rec->enc_key_size); /* Encrypted key size */
1422 if (max_packet_size > (*remaining_bytes)) {
1423 printk(KERN_ERR "Packet length larger than maximum allowable; "
1424 "need up to [%td] bytes, but there are only [%td] "
1425 "available\n", max_packet_size, (*remaining_bytes));
1429 dest[(*packet_size)++] = ECRYPTFS_TAG_1_PACKET_TYPE;
1430 rc = write_packet_length(&dest[(*packet_size)], (max_packet_size - 4),
1431 &packet_size_length);
1433 ecryptfs_printk(KERN_ERR, "Error generating tag 1 packet "
1434 "header; cannot generate packet length\n");
1437 (*packet_size) += packet_size_length;
1438 dest[(*packet_size)++] = 0x03; /* version 3 */
1439 memcpy(&dest[(*packet_size)], key_rec->sig, ECRYPTFS_SIG_SIZE);
1440 (*packet_size) += ECRYPTFS_SIG_SIZE;
1441 dest[(*packet_size)++] = RFC2440_CIPHER_RSA;
1442 memcpy(&dest[(*packet_size)], key_rec->enc_key,
1443 key_rec->enc_key_size);
1444 (*packet_size) += key_rec->enc_key_size;
1449 (*remaining_bytes) -= (*packet_size);
1454 * write_tag_11_packet
1455 * @dest: Target into which Tag 11 packet is to be written
1456 * @remaining_bytes: Maximum packet length
1457 * @contents: Byte array of contents to copy in
1458 * @contents_length: Number of bytes in contents
1459 * @packet_length: Length of the Tag 11 packet written; zero on error
1461 * Returns zero on success; non-zero on error.
1464 write_tag_11_packet(char *dest, size_t *remaining_bytes, char *contents,
1465 size_t contents_length, size_t *packet_length)
1467 size_t packet_size_length;
1468 size_t max_packet_size;
1471 (*packet_length) = 0;
1472 /* This format is inspired by OpenPGP; see RFC 2440
1474 max_packet_size = (1 /* Tag 11 identifier */
1475 + 3 /* Max Tag 11 packet size */
1476 + 1 /* Binary format specifier */
1477 + 1 /* Filename length */
1478 + 8 /* Filename ("_CONSOLE") */
1479 + 4 /* Modification date */
1480 + contents_length); /* Literal data */
1481 if (max_packet_size > (*remaining_bytes)) {
1482 printk(KERN_ERR "Packet length larger than maximum allowable; "
1483 "need up to [%td] bytes, but there are only [%td] "
1484 "available\n", max_packet_size, (*remaining_bytes));
1488 dest[(*packet_length)++] = ECRYPTFS_TAG_11_PACKET_TYPE;
1489 rc = write_packet_length(&dest[(*packet_length)],
1490 (max_packet_size - 4), &packet_size_length);
1492 printk(KERN_ERR "Error generating tag 11 packet header; cannot "
1493 "generate packet length. rc = [%d]\n", rc);
1496 (*packet_length) += packet_size_length;
1497 dest[(*packet_length)++] = 0x62; /* binary data format specifier */
1498 dest[(*packet_length)++] = 8;
1499 memcpy(&dest[(*packet_length)], "_CONSOLE", 8);
1500 (*packet_length) += 8;
1501 memset(&dest[(*packet_length)], 0x00, 4);
1502 (*packet_length) += 4;
1503 memcpy(&dest[(*packet_length)], contents, contents_length);
1504 (*packet_length) += contents_length;
1507 (*packet_length) = 0;
1509 (*remaining_bytes) -= (*packet_length);
1514 * write_tag_3_packet
1515 * @dest: Buffer into which to write the packet
1516 * @remaining_bytes: Maximum number of bytes that can be written
1517 * @auth_tok: Authentication token
1518 * @crypt_stat: The cryptographic context
1519 * @key_rec: encrypted key
1520 * @packet_size: This function will write the number of bytes that end
1521 * up constituting the packet; set to zero on error
1523 * Returns zero on success; non-zero on error.
1526 write_tag_3_packet(char *dest, size_t *remaining_bytes,
1527 struct ecryptfs_auth_tok *auth_tok,
1528 struct ecryptfs_crypt_stat *crypt_stat,
1529 struct ecryptfs_key_record *key_rec, size_t *packet_size)
1532 size_t encrypted_session_key_valid = 0;
1533 char session_key_encryption_key[ECRYPTFS_MAX_KEY_BYTES];
1534 struct scatterlist dst_sg;
1535 struct scatterlist src_sg;
1536 struct mutex *tfm_mutex = NULL;
1538 size_t packet_size_length;
1539 size_t max_packet_size;
1540 struct ecryptfs_mount_crypt_stat *mount_crypt_stat =
1541 crypt_stat->mount_crypt_stat;
1542 struct blkcipher_desc desc = {
1544 .flags = CRYPTO_TFM_REQ_MAY_SLEEP
1549 ecryptfs_from_hex(key_rec->sig, auth_tok->token.password.signature,
1551 rc = ecryptfs_get_tfm_and_mutex_for_cipher_name(&desc.tfm, &tfm_mutex,
1552 crypt_stat->cipher);
1554 printk(KERN_ERR "Internal error whilst attempting to get "
1555 "tfm and mutex for cipher name [%s]; rc = [%d]\n",
1556 crypt_stat->cipher, rc);
1559 if (mount_crypt_stat->global_default_cipher_key_size == 0) {
1560 struct blkcipher_alg *alg = crypto_blkcipher_alg(desc.tfm);
1562 printk(KERN_WARNING "No key size specified at mount; "
1563 "defaulting to [%d]\n", alg->max_keysize);
1564 mount_crypt_stat->global_default_cipher_key_size =
1567 if (crypt_stat->key_size == 0)
1568 crypt_stat->key_size =
1569 mount_crypt_stat->global_default_cipher_key_size;
1570 if (auth_tok->session_key.encrypted_key_size == 0)
1571 auth_tok->session_key.encrypted_key_size =
1572 crypt_stat->key_size;
1573 if (crypt_stat->key_size == 24
1574 && strcmp("aes", crypt_stat->cipher) == 0) {
1575 memset((crypt_stat->key + 24), 0, 8);
1576 auth_tok->session_key.encrypted_key_size = 32;
1578 auth_tok->session_key.encrypted_key_size = crypt_stat->key_size;
1579 key_rec->enc_key_size =
1580 auth_tok->session_key.encrypted_key_size;
1581 encrypted_session_key_valid = 0;
1582 for (i = 0; i < auth_tok->session_key.encrypted_key_size; i++)
1583 encrypted_session_key_valid |=
1584 auth_tok->session_key.encrypted_key[i];
1585 if (encrypted_session_key_valid) {
1586 ecryptfs_printk(KERN_DEBUG, "encrypted_session_key_valid != 0; "
1587 "using auth_tok->session_key.encrypted_key, "
1588 "where key_rec->enc_key_size = [%d]\n",
1589 key_rec->enc_key_size);
1590 memcpy(key_rec->enc_key,
1591 auth_tok->session_key.encrypted_key,
1592 key_rec->enc_key_size);
1593 goto encrypted_session_key_set;
1595 if (auth_tok->token.password.flags &
1596 ECRYPTFS_SESSION_KEY_ENCRYPTION_KEY_SET) {
1597 ecryptfs_printk(KERN_DEBUG, "Using previously generated "
1598 "session key encryption key of size [%d]\n",
1599 auth_tok->token.password.
1600 session_key_encryption_key_bytes);
1601 memcpy(session_key_encryption_key,
1602 auth_tok->token.password.session_key_encryption_key,
1603 crypt_stat->key_size);
1604 ecryptfs_printk(KERN_DEBUG,
1605 "Cached session key " "encryption key: \n");
1606 if (ecryptfs_verbosity > 0)
1607 ecryptfs_dump_hex(session_key_encryption_key, 16);
1609 if (unlikely(ecryptfs_verbosity > 0)) {
1610 ecryptfs_printk(KERN_DEBUG, "Session key encryption key:\n");
1611 ecryptfs_dump_hex(session_key_encryption_key, 16);
1613 rc = virt_to_scatterlist(crypt_stat->key, key_rec->enc_key_size,
1616 ecryptfs_printk(KERN_ERR, "Error generating scatterlist "
1617 "for crypt_stat session key; expected rc = 1; "
1618 "got rc = [%d]. key_rec->enc_key_size = [%d]\n",
1619 rc, key_rec->enc_key_size);
1623 rc = virt_to_scatterlist(key_rec->enc_key, key_rec->enc_key_size,
1626 ecryptfs_printk(KERN_ERR, "Error generating scatterlist "
1627 "for crypt_stat encrypted session key; "
1628 "expected rc = 1; got rc = [%d]. "
1629 "key_rec->enc_key_size = [%d]\n", rc,
1630 key_rec->enc_key_size);
1634 mutex_lock(tfm_mutex);
1635 rc = crypto_blkcipher_setkey(desc.tfm, session_key_encryption_key,
1636 crypt_stat->key_size);
1638 mutex_unlock(tfm_mutex);
1639 ecryptfs_printk(KERN_ERR, "Error setting key for crypto "
1640 "context; rc = [%d]\n", rc);
1644 ecryptfs_printk(KERN_DEBUG, "Encrypting [%d] bytes of the key\n",
1645 crypt_stat->key_size);
1646 rc = crypto_blkcipher_encrypt(&desc, &dst_sg, &src_sg,
1647 (*key_rec).enc_key_size);
1648 mutex_unlock(tfm_mutex);
1650 printk(KERN_ERR "Error encrypting; rc = [%d]\n", rc);
1653 ecryptfs_printk(KERN_DEBUG, "This should be the encrypted key:\n");
1654 if (ecryptfs_verbosity > 0) {
1655 ecryptfs_printk(KERN_DEBUG, "EFEK of size [%d]:\n",
1656 key_rec->enc_key_size);
1657 ecryptfs_dump_hex(key_rec->enc_key,
1658 key_rec->enc_key_size);
1660 encrypted_session_key_set:
1661 /* This format is inspired by OpenPGP; see RFC 2440
1663 max_packet_size = (1 /* Tag 3 identifier */
1664 + 3 /* Max Tag 3 packet size */
1666 + 1 /* Cipher code */
1667 + 1 /* S2K specifier */
1668 + 1 /* Hash identifier */
1669 + ECRYPTFS_SALT_SIZE /* Salt */
1670 + 1 /* Hash iterations */
1671 + key_rec->enc_key_size); /* Encrypted key size */
1672 if (max_packet_size > (*remaining_bytes)) {
1673 printk(KERN_ERR "Packet too large; need up to [%td] bytes, but "
1674 "there are only [%td] available\n", max_packet_size,
1675 (*remaining_bytes));
1679 dest[(*packet_size)++] = ECRYPTFS_TAG_3_PACKET_TYPE;
1680 /* Chop off the Tag 3 identifier(1) and Tag 3 packet size(3)
1681 * to get the number of octets in the actual Tag 3 packet */
1682 rc = write_packet_length(&dest[(*packet_size)], (max_packet_size - 4),
1683 &packet_size_length);
1685 printk(KERN_ERR "Error generating tag 3 packet header; cannot "
1686 "generate packet length. rc = [%d]\n", rc);
1689 (*packet_size) += packet_size_length;
1690 dest[(*packet_size)++] = 0x04; /* version 4 */
1691 /* TODO: Break from RFC2440 so that arbitrary ciphers can be
1692 * specified with strings */
1693 cipher_code = ecryptfs_code_for_cipher_string(crypt_stat);
1694 if (cipher_code == 0) {
1695 ecryptfs_printk(KERN_WARNING, "Unable to generate code for "
1696 "cipher [%s]\n", crypt_stat->cipher);
1700 dest[(*packet_size)++] = cipher_code;
1701 dest[(*packet_size)++] = 0x03; /* S2K */
1702 dest[(*packet_size)++] = 0x01; /* MD5 (TODO: parameterize) */
1703 memcpy(&dest[(*packet_size)], auth_tok->token.password.salt,
1704 ECRYPTFS_SALT_SIZE);
1705 (*packet_size) += ECRYPTFS_SALT_SIZE; /* salt */
1706 dest[(*packet_size)++] = 0x60; /* hash iterations (65536) */
1707 memcpy(&dest[(*packet_size)], key_rec->enc_key,
1708 key_rec->enc_key_size);
1709 (*packet_size) += key_rec->enc_key_size;
1714 (*remaining_bytes) -= (*packet_size);
1718 struct kmem_cache *ecryptfs_key_record_cache;
1721 * ecryptfs_generate_key_packet_set
1722 * @dest_base: Virtual address from which to write the key record set
1723 * @crypt_stat: The cryptographic context from which the
1724 * authentication tokens will be retrieved
1725 * @ecryptfs_dentry: The dentry, used to retrieve the mount crypt stat
1726 * for the global parameters
1727 * @len: The amount written
1728 * @max: The maximum amount of data allowed to be written
1730 * Generates a key packet set and writes it to the virtual address
1733 * Returns zero on success; non-zero on error.
1736 ecryptfs_generate_key_packet_set(char *dest_base,
1737 struct ecryptfs_crypt_stat *crypt_stat,
1738 struct dentry *ecryptfs_dentry, size_t *len,
1741 struct ecryptfs_auth_tok *auth_tok;
1742 struct ecryptfs_global_auth_tok *global_auth_tok;
1743 struct ecryptfs_mount_crypt_stat *mount_crypt_stat =
1744 &ecryptfs_superblock_to_private(
1745 ecryptfs_dentry->d_sb)->mount_crypt_stat;
1747 struct ecryptfs_key_record *key_rec;
1748 struct ecryptfs_key_sig *key_sig;
1752 mutex_lock(&crypt_stat->keysig_list_mutex);
1753 key_rec = kmem_cache_alloc(ecryptfs_key_record_cache, GFP_KERNEL);
1758 list_for_each_entry(key_sig, &crypt_stat->keysig_list,
1760 memset(key_rec, 0, sizeof(*key_rec));
1761 rc = ecryptfs_find_global_auth_tok_for_sig(&global_auth_tok,
1765 printk(KERN_ERR "Error attempting to get the global "
1766 "auth_tok; rc = [%d]\n", rc);
1769 if (global_auth_tok->flags & ECRYPTFS_AUTH_TOK_INVALID) {
1771 "Skipping invalid auth tok with sig = [%s]\n",
1772 global_auth_tok->sig);
1775 auth_tok = global_auth_tok->global_auth_tok;
1776 if (auth_tok->token_type == ECRYPTFS_PASSWORD) {
1777 rc = write_tag_3_packet((dest_base + (*len)),
1779 crypt_stat, key_rec,
1782 ecryptfs_printk(KERN_WARNING, "Error "
1783 "writing tag 3 packet\n");
1787 /* Write auth tok signature packet */
1788 rc = write_tag_11_packet((dest_base + (*len)), &max,
1790 ECRYPTFS_SIG_SIZE, &written);
1792 ecryptfs_printk(KERN_ERR, "Error writing "
1793 "auth tok signature packet\n");
1797 } else if (auth_tok->token_type == ECRYPTFS_PRIVATE_KEY) {
1798 rc = write_tag_1_packet(dest_base + (*len),
1800 crypt_stat, key_rec, &written);
1802 ecryptfs_printk(KERN_WARNING, "Error "
1803 "writing tag 1 packet\n");
1808 ecryptfs_printk(KERN_WARNING, "Unsupported "
1809 "authentication token type\n");
1814 if (likely(max > 0)) {
1815 dest_base[(*len)] = 0x00;
1817 ecryptfs_printk(KERN_ERR, "Error writing boundary byte\n");
1821 kmem_cache_free(ecryptfs_key_record_cache, key_rec);
1825 mutex_unlock(&crypt_stat->keysig_list_mutex);
1829 struct kmem_cache *ecryptfs_key_sig_cache;
1831 int ecryptfs_add_keysig(struct ecryptfs_crypt_stat *crypt_stat, char *sig)
1833 struct ecryptfs_key_sig *new_key_sig;
1836 new_key_sig = kmem_cache_alloc(ecryptfs_key_sig_cache, GFP_KERNEL);
1840 "Error allocating from ecryptfs_key_sig_cache\n");
1843 memcpy(new_key_sig->keysig, sig, ECRYPTFS_SIG_SIZE_HEX);
1844 mutex_lock(&crypt_stat->keysig_list_mutex);
1845 list_add(&new_key_sig->crypt_stat_list, &crypt_stat->keysig_list);
1846 mutex_unlock(&crypt_stat->keysig_list_mutex);
1851 struct kmem_cache *ecryptfs_global_auth_tok_cache;
1854 ecryptfs_add_global_auth_tok(struct ecryptfs_mount_crypt_stat *mount_crypt_stat,
1857 struct ecryptfs_global_auth_tok *new_auth_tok;
1860 new_auth_tok = kmem_cache_alloc(ecryptfs_global_auth_tok_cache,
1862 if (!new_auth_tok) {
1864 printk(KERN_ERR "Error allocating from "
1865 "ecryptfs_global_auth_tok_cache\n");
1868 memcpy(new_auth_tok->sig, sig, ECRYPTFS_SIG_SIZE_HEX);
1869 new_auth_tok->sig[ECRYPTFS_SIG_SIZE_HEX] = '\0';
1870 mutex_lock(&mount_crypt_stat->global_auth_tok_list_mutex);
1871 list_add(&new_auth_tok->mount_crypt_stat_list,
1872 &mount_crypt_stat->global_auth_tok_list);
1873 mount_crypt_stat->num_global_auth_toks++;
1874 mutex_unlock(&mount_crypt_stat->global_auth_tok_list_mutex);