21ecba97fed04cfbb2458205f958f0e600a27577
[platform/upstream/cryptsetup.git] / lib / tcrypt / tcrypt.h
1 /*
2  * TCRYPT (TrueCrypt-compatible)  header defitinion
3  *
4  * Copyright (C) 2012, Red Hat, Inc. All rights reserved.
5  * Copyright (C) 2012-2014, Milan Broz
6  *
7  * This file is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * This file is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with this file; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20  */
21
22 #include "libcryptsetup.h"
23
24 #ifndef _CRYPTSETUP_TCRYPT_H
25 #define _CRYPTSETUP_TCRYPT_H
26
27 #define TCRYPT_HDR_SALT_LEN 64
28 #define TCRYPT_HDR_IV_LEN   16
29 #define TCRYPT_HDR_LEN     448
30 #define TCRYPT_HDR_KEY_LEN 192
31 #define TCRYPT_HDR_MAGIC "TRUE"
32 #define VCRYPT_HDR_MAGIC "VERA"
33 #define TCRYPT_HDR_MAGIC_LEN 4
34
35 #define TCRYPT_HDR_HIDDEN_OFFSET_OLD -1536
36 #define TCRYPT_HDR_HIDDEN_OFFSET 65536
37
38 #define TCRYPT_HDR_HIDDEN_OFFSET_BCK -65536
39 #define TCRYPT_HDR_OFFSET_BCK -131072
40
41 #define TCRYPT_HDR_SYSTEM_OFFSET 31744
42
43 #define TCRYPT_LRW_IKEY_LEN 16
44 #define TCRYPT_KEY_POOL_LEN 64
45 #define TCRYPT_KEYFILE_LEN  1048576
46
47 #define TCRYPT_HDR_FLAG_SYSTEM    (1 << 0)
48 #define TCRYPT_HDR_FLAG_NONSYSTEM (1 << 1)
49
50 struct tcrypt_phdr {
51         char salt[TCRYPT_HDR_SALT_LEN];
52
53         /* encrypted part, TCRYPT_HDR_LEN bytes */
54         union {
55         struct __attribute__((__packed__)) {
56                 char     magic[TCRYPT_HDR_MAGIC_LEN];
57                 uint16_t version;
58                 uint16_t version_tc;
59                 uint32_t keys_crc32;
60                 uint64_t _reserved1[2]; /* data/header ctime */
61                 uint64_t hidden_volume_size;
62                 uint64_t volume_size;
63                 uint64_t mk_offset;
64                 uint64_t mk_size;
65                 uint32_t flags;
66                 uint32_t sector_size;
67                 uint8_t  _reserved2[120];
68                 uint32_t header_crc32;
69                 char     keys[256];
70         } d;
71         char e[TCRYPT_HDR_LEN];
72         };
73 } __attribute__((__packed__));
74
75 struct crypt_dm_active_device;
76 struct volume_key;
77 struct device;
78
79 int TCRYPT_read_phdr(struct crypt_device *cd,
80                      struct tcrypt_phdr *hdr,
81                      struct crypt_params_tcrypt *params);
82
83 int TCRYPT_init_by_name(struct crypt_device *cd, const char *name,
84                         const struct crypt_dm_active_device *dmd,
85                         struct device **device,
86                         struct crypt_params_tcrypt *tcrypt_params,
87                         struct tcrypt_phdr *tcrypt_hdr);
88
89 int TCRYPT_activate(struct crypt_device *cd,
90                      const char *name,
91                      struct tcrypt_phdr *hdr,
92                      struct crypt_params_tcrypt *params,
93                      uint32_t flags);
94
95 int TCRYPT_deactivate(struct crypt_device *cd,
96                       const char *name);
97
98 uint64_t TCRYPT_get_data_offset(struct crypt_device *cd,
99                                 struct tcrypt_phdr *hdr,
100                                 struct crypt_params_tcrypt *params);
101
102 uint64_t TCRYPT_get_iv_offset(struct crypt_device *cd,
103                               struct tcrypt_phdr *hdr,
104                               struct crypt_params_tcrypt *params);
105
106 int TCRYPT_get_volume_key(struct crypt_device *cd,
107                           struct tcrypt_phdr *hdr,
108                           struct crypt_params_tcrypt *params,
109                           struct volume_key **vk);
110
111 int TCRYPT_dump(struct crypt_device *cd,
112                 struct tcrypt_phdr *hdr,
113                 struct crypt_params_tcrypt *params);
114
115 #endif