cryptfs.h revision 7f7dbaa2784c10fd2989fb303e5edfb8136d53dc
18f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall/* 28f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall * Copyright (C) 2010 The Android Open Source Project 38f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall * 48f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall * Licensed under the Apache License, Version 2.0 (the "License"); 58f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall * you may not use this file except in compliance with the License. 68f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall * You may obtain a copy of the License at 78f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall * 88f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall * http://www.apache.org/licenses/LICENSE-2.0 98f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall * 108f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall * Unless required by applicable law or agreed to in writing, software 118f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall * distributed under the License is distributed on an "AS IS" BASIS, 128f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 138f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall * See the License for the specific language governing permissions and 148f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall * limitations under the License. 158f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall */ 168f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall 178f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall/* This structure starts 16,384 bytes before the end of a hardware 188f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall * partition that is encrypted. 198f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall * Immediately following this structure is the encrypted key. 20e87440703663f5ee326326f6438f3b00ea315623Ken Sumrall * The keysize field tells how long the key is, in bytes. 21e87440703663f5ee326326f6438f3b00ea315623Ken Sumrall * Then there is 32 bytes of padding, 22e87440703663f5ee326326f6438f3b00ea315623Ken Sumrall * Finally there is the salt used with the user password. 23e87440703663f5ee326326f6438f3b00ea315623Ken Sumrall * The salt is fixed at 16 bytes long. 248f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall * Obviously, the filesystem does not include the last 16 kbytes 258f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall * of the partition. 268f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall */ 278f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall 288f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall#define CRYPT_FOOTER_OFFSET 0x4000 298f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall 308f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall#define MAX_CRYPTO_TYPE_NAME_LEN 64 318f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall 32e87440703663f5ee326326f6438f3b00ea315623Ken Sumrall#define SALT_LEN 16 33e87440703663f5ee326326f6438f3b00ea315623Ken Sumrall#define KEY_TO_SALT_PADDING 32 34e87440703663f5ee326326f6438f3b00ea315623Ken Sumrall 358f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall/* definitions of flags in the structure below */ 368f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall#define CRYPT_MNT_KEY_UNENCRYPTED 0x1 /* The key for the partition is not encrypted. */ 37d33d417e3a057fffad22c23f5f002177531db2a5Ken Sumrall#define CRYPT_ENCRYPTION_IN_PROGRESS 0x2 /* Set when starting encryption, 38d33d417e3a057fffad22c23f5f002177531db2a5Ken Sumrall * clear when done before rebooting */ 398f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall 408f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall#define CRYPT_MNT_MAGIC 0xD0B5B1C4 418f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall 428f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall#define __le32 unsigned int 438f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall#define __le16 unsigned short int 448f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall 458f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrallstruct crypt_mnt_ftr { 468f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall __le32 magic; /* See above */ 478f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall __le16 major_version; 488f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall __le16 minor_version; 498f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall __le32 ftr_size; /* in bytes, not including key following */ 508f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall __le32 flags; /* See above */ 518f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall __le32 keysize; /* in bytes */ 528f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall __le32 spare1; /* ignored */ 538f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall __le64 fs_size; /* Size of the encrypted fs, in 512 byte sectors */ 548f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall __le32 failed_decrypt_count; /* count of # of failed attempts to decrypt and 558f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall mount, set to 0 on successful mount */ 568f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall unsigned char crypto_type_name[MAX_CRYPTO_TYPE_NAME_LEN]; /* The type of encryption 578f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall needed to decrypt this 588f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall partition, null terminated */ 598f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall}; 608f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall 618f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall#ifdef __cplusplus 628f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrallextern "C" { 638f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall#endif 647f7dbaa2784c10fd2989fb303e5edfb8136d53dcKen Sumrall int cryptfs_crypto_complete(void); 658f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall int cryptfs_check_passwd(char *pw); 666864b7ec94a57b73c300457955d86dc604aeddf5Ken Sumrall int cryptfs_restart(void); 678f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall int cryptfs_enable(char *flag, char *passwd); 6870a4b3fd7a84a84bbe6e9d6d4ca3ee2098259fd9Jason parks int cryptfs_changepw(char *newpw); 698f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall#ifdef __cplusplus 708f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall} 718f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall#endif 728f869aa1bc685b505c58e97b4e11a9c7491a16f9Ken Sumrall 73