1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
use crate::{
config::{CompressionConfig, DatabaseConfig, InnerCipherConfig, KdfConfig, OuterCipherConfig},
crypt::calculate_sha256,
db::{Database, Entry, Group, Node, NodeRefMut, Value},
error::{DatabaseIntegrityError, DatabaseKeyError, DatabaseOpenError},
format::DatabaseVersion,
};
use byteorder::{ByteOrder, LittleEndian};
use cipher::generic_array::GenericArray;
use std::{collections::HashMap, convert::TryInto, str};
#[derive(Debug)]
struct KDBHeader {
pub flags: u32,
pub subversion: u32,
pub master_seed: Vec<u8>, pub encryption_iv: Vec<u8>, pub num_groups: u32,
pub num_entries: u32,
pub contents_hash: Vec<u8>, pub transform_seed: Vec<u8>, pub transform_rounds: u32,
}
const HEADER_SIZE: usize = 4 + 4 + 4 + 4 + 16 + 16 + 4 + 4 + 32 + 32 + 4; fn parse_header(data: &[u8]) -> Result<KDBHeader, DatabaseIntegrityError> {
if data.len() < HEADER_SIZE {
return Err(DatabaseIntegrityError::InvalidFixedHeader { size: data.len() }.into());
}
Ok(KDBHeader {
flags: LittleEndian::read_u32(&data[8..]),
subversion: LittleEndian::read_u32(&data[12..]),
master_seed: data[16..32].to_vec(),
encryption_iv: data[32..48].to_vec(),
num_groups: LittleEndian::read_u32(&data[48..]),
num_entries: LittleEndian::read_u32(&data[52..]),
contents_hash: data[56..88].to_vec(),
transform_seed: data[88..120].to_vec(),
transform_rounds: LittleEndian::read_u32(&data[120..]),
})
}
fn from_utf8(data: &[u8]) -> String {
String::from_utf8_lossy(data)
.trim_end_matches('\0')
.to_owned()
}
fn ensure_length(
field_type: u16,
field_size: u32,
expected_field_size: u32,
) -> Result<(), DatabaseIntegrityError> {
if field_size != expected_field_size {
Err(DatabaseIntegrityError::InvalidKDBFieldLength {
field_type,
field_size,
expected_field_size,
}
.into())
} else {
Ok(())
}
}
fn entry_name(field_type: u16) -> &'static str {
match field_type {
0x0004 => "Title",
0x0005 => "URL",
0x0006 => "UserName",
0x0008 => "Additional",
0x000d => "BinaryDesc",
_ => {
panic!("Unsupported field type!");
}
}
}
fn collapse_tail_groups(branch: &mut Vec<Group>, level: usize, root: &mut Group) {
while level < branch.len() {
let leaf = branch.pop().unwrap(); let parent = match branch.last_mut() {
Some(parent) => parent,
None => root,
};
parent.children.push(Node::Group(leaf));
}
}
type GidMap = HashMap<u32, Vec<String>>;
fn parse_groups(
root: &mut Group,
header_num_groups: u32,
data: &mut &[u8],
) -> Result<GidMap, DatabaseIntegrityError> {
let mut gid_map: HashMap<u32, Vec<String>> = HashMap::new(); let mut branch: Vec<Group> = Vec::new(); let mut group: Group = Default::default(); let mut level: Option<u16> = None; let mut gid: Option<u32> = None; let mut group_path: Vec<String> = Vec::new(); let mut num_groups = 0; while num_groups < header_num_groups as usize {
let field_type = LittleEndian::read_u16(&data[0..]);
let field_size = LittleEndian::read_u32(&data[2..]);
let field_value = &data[6..6 + field_size as usize];
match field_type {
0x0000 => {} 0x0001 => {
ensure_length(field_type, field_size, 4)?;
gid = Some(LittleEndian::read_u32(field_value));
}
0x0002 => group.name = from_utf8(field_value), 0x0003..=0x0006 => {
ensure_length(field_type, field_size, 5)?;
}
0x0007 => {
ensure_length(field_type, field_size, 4)?;
}
0x0008 => {
ensure_length(field_type, field_size, 2)?;
level = Some(LittleEndian::read_u16(field_value));
}
0x0009 => {
ensure_length(field_type, field_size, 4)?;
}
0xffff => {
ensure_length(field_type, field_size, 0)?;
let level =
level.ok_or_else(|| DatabaseIntegrityError::MissingKDBGroupLevel)? as usize;
if level < branch.len() {
group_path.truncate(level);
collapse_tail_groups(&mut branch, level, root);
}
if level == branch.len() {
group_path.push(group.name.clone());
branch.push(group);
} else {
return Err(DatabaseIntegrityError::InvalidKDBGroupLevel {
group_level: level as u16,
current_level: branch.len() as u16,
}
.into());
}
let group_id = gid.ok_or_else(|| DatabaseIntegrityError::MissingKDBGroupId)?;
gid_map.insert(group_id, group_path.clone());
group = Default::default();
gid = None;
num_groups += 1;
}
_ => {
return Err(DatabaseIntegrityError::InvalidKDBGroupFieldType { field_type }.into());
}
}
*data = &data[6 + field_size as usize..];
}
if gid != None {
return Err(DatabaseIntegrityError::IncompleteKDBGroup);
}
collapse_tail_groups(&mut branch, 0, root);
Ok(gid_map)
}
fn parse_entries(
root: &mut Group,
gid_map: GidMap,
header_num_entries: u32,
data: &mut &[u8],
) -> Result<(), DatabaseIntegrityError> {
let mut entry: Entry = Default::default(); let mut gid: Option<u32> = None; let mut num_entries = 0;
while num_entries < header_num_entries {
let field_type = LittleEndian::read_u16(&data[0..]);
let field_size = LittleEndian::read_u32(&data[2..]);
let field_value = &data[6..6 + field_size as usize];
match field_type {
0x0000 => {} 0x0001 => {
ensure_length(field_type, field_size, 16)?;
}
0x0002 => {
ensure_length(field_type, field_size, 4)?;
gid = Some(LittleEndian::read_u32(field_value));
}
0x0003 => {
ensure_length(field_type, field_size, 4)?;
}
0x0004 | 0x0005 | 0x0006 | 0x0008 | 0x000d => {
entry.fields.insert(
String::from(entry_name(field_type)),
Value::Unprotected(from_utf8(field_value)),
);
}
0x0007 => {
entry.fields.insert(
String::from("Password"),
Value::Protected(from_utf8(field_value).into()),
);
}
0x0009..=0x000c => {
ensure_length(field_type, field_size, 5)?;
}
0x000e => {
entry.fields.insert(
String::from("BinaryData"),
Value::Bytes(field_value.to_vec()),
);
}
0xffff => {
ensure_length(field_type, field_size, 0)?;
let group_id = gid.ok_or_else(|| DatabaseIntegrityError::MissingKDBGroupId)?;
let group_path: Vec<&str> = gid_map
.get(&group_id)
.ok_or_else(|| DatabaseIntegrityError::InvalidKDBGroupId { group_id })?
.into_iter()
.map(|v| v.as_str())
.collect();
let group = root.get_mut(group_path.as_slice());
let group = if let Some(NodeRefMut::Group(g)) = group {
g
} else {
panic!("Follow group_path")
};
group.children.push(Node::Entry(entry));
entry = Default::default();
gid = None;
num_entries += 1;
}
_ => {
return Err(DatabaseIntegrityError::InvalidKDBEntryFieldType { field_type }.into());
}
}
*data = &data[6 + field_size as usize..];
}
if gid != None {
return Err(DatabaseIntegrityError::IncompleteKDBEntry.into());
}
Ok(())
}
fn parse_db(header: &KDBHeader, data: &[u8]) -> Result<Group, DatabaseIntegrityError> {
let mut root = Group {
name: "Root".to_owned(),
..Default::default()
};
let mut pos = &data[..];
let gid_map = parse_groups(&mut root, header.num_groups, &mut pos)?;
parse_entries(&mut root, gid_map, header.num_entries, &mut pos)?;
Ok(root)
}
pub(crate) fn parse_kdb(
data: &[u8],
key_elements: &[Vec<u8>],
) -> Result<Database, DatabaseOpenError> {
let header = parse_header(data)?;
let version = DatabaseVersion::KDB(header.subversion as u16);
let payload_encrypted = &data[HEADER_SIZE..];
let key_elements: Vec<&[u8]> = key_elements.iter().map(|v| &v[..]).collect();
let composite_key = if key_elements.len() == 1 {
let key_element: [u8; 32] = key_elements[0].try_into().unwrap();
GenericArray::from(key_element) } else {
calculate_sha256(&key_elements)? };
let kdf_config = KdfConfig::Aes {
rounds: header.transform_rounds as u64,
};
let transformed_key = kdf_config
.get_kdf_seeded(&header.transform_seed)
.transform_key(&composite_key)?;
let master_key = calculate_sha256(&[&header.master_seed, &transformed_key])?;
let outer_cipher_config = if header.flags & 2 != 0 {
OuterCipherConfig::AES256
} else if header.flags & 8 != 0 {
OuterCipherConfig::Twofish
} else {
return Err(DatabaseIntegrityError::InvalidFixedCipherID { cid: header.flags }.into());
};
let payload_padded = outer_cipher_config
.get_cipher(&master_key, header.encryption_iv.as_ref())?
.decrypt(payload_encrypted)?;
let padlen = payload_padded[payload_padded.len() - 1] as usize;
let payload = &payload_padded[..payload_padded.len() - padlen];
let hash = calculate_sha256(&[&payload])?;
if header.contents_hash != hash.as_slice() {
return Err(DatabaseKeyError::IncorrectKey.into());
}
let root_group = parse_db(&header, &payload)?;
let config = DatabaseConfig {
version,
outer_cipher_config,
compression_config: CompressionConfig::None,
inner_cipher_config: InnerCipherConfig::Plain,
kdf_config,
};
Ok(Database {
config,
header_attachments: Default::default(),
root: root_group,
deleted_objects: Default::default(),
meta: Default::default(),
})
}