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
#![allow(unused_variables)]
use super::Result;
use crate::repository::backend::common::sync_backend::*;
use crate::repository::backend::*;
use asuran_core::repository::backend::flatfile::*;
use rmp_serde as rmps;
use std::collections::HashMap;
use std::fs::{File, OpenOptions};
use std::io::{BufReader, BufWriter, Seek, SeekFrom};
use std::path::{Path, PathBuf};
const MAGIC_NUMBER: [u8; 8] = *b"ASURAN_F";
#[derive(Debug)]
pub struct FlatFile {
read: BufReader<File>,
write: BufWriter<File>,
index: HashMap<ChunkID, SegmentDescriptor>,
manifest: Vec<StoredArchive>,
header: Header,
path: PathBuf,
past_header: u64,
}
impl FlatFile {
pub fn new_raw(
repository_path: impl AsRef<Path>,
settings: Option<ChunkSettings>,
enc_key: Option<EncryptedKey>,
) -> Result<FlatFile> {
let mut read;
let mut write;
let header;
let past_header;
if Path::exists(repository_path.as_ref()) {
read = BufReader::new(File::open(repository_path.as_ref())?);
write = BufWriter::new(
OpenOptions::new()
.write(true)
.open(repository_path.as_ref())?,
);
header = Header::deserialize(&mut read).map_err(|_| {
BackendError::ManifestError("Failed to load flatfile header".to_string())
})?;
past_header = read.seek(SeekFrom::Current(0))?;
} else {
if let Some(enc_key) = enc_key {
if let Some(settings) = settings {
write = BufWriter::new(
OpenOptions::new()
.write(true)
.create(true)
.open(repository_path.as_ref())?,
);
read = BufReader::new(File::open(repository_path.as_ref())?);
header = Header {
magic_number: MAGIC_NUMBER,
implementation_uuid: *crate::IMPLEMENTATION_UUID.as_bytes(),
semver_major: crate::VERSION_PIECES[0],
semver_minor: crate::VERSION_PIECES[1],
semver_patch: crate::VERSION_PIECES[2],
configuration: Configuration {
key: enc_key,
chunk_settings: settings,
},
};
header.serialize(&mut write).map_err(|_| {
BackendError::ManifestError("Unable to write flatfile header".to_string())
})?;
past_header = write.seek(SeekFrom::Current(0))?;
} else {
return Err(BackendError::Unknown(
"Attempted to create a new flatfile, but did not provide chunk settings"
.to_string(),
));
}
} else {
return Err(BackendError::Unknown(
"Attempted to create a new flatfile, but did not provide a key".to_string(),
));
}
}
let mut index: HashMap<ChunkID, SegmentDescriptor> = HashMap::new();
let mut manifest: Vec<StoredArchive> = Vec::new();
let mut start = read.seek(SeekFrom::Start(past_header))?;
while let Ok(tx) = rmps::decode::from_read(&mut read) {
match tx {
FlatFileTransaction::Insert { id, chunk } => {
let segment_descriptor = SegmentDescriptor {
segment_id: 0,
start,
};
index.insert(id, segment_descriptor);
}
FlatFileTransaction::Delete { id } => {
index.remove(&id);
}
FlatFileTransaction::ManifestInsert {
id,
name,
timestamp,
} => {
manifest.push(StoredArchive {
id,
name,
timestamp,
});
}
}
start = read.seek(SeekFrom::Current(0))?;
}
Ok(FlatFile {
read,
write,
header,
index,
manifest,
past_header,
path: repository_path.as_ref().to_path_buf(),
})
}
pub fn new(
repository_path: impl AsRef<Path>,
settings: Option<ChunkSettings>,
enc_key: Option<EncryptedKey>,
) -> Result<BackendHandle<FlatFile>> {
let flatfile = FlatFile::new_raw(repository_path, settings, enc_key)?;
Ok(BackendHandle::new(flatfile))
}
pub fn load_encrypted_key(repository_path: impl AsRef<Path>) -> Result<EncryptedKey> {
let mut read = File::open(repository_path)?;
let header = Header::deserialize(&mut read)
.map_err(|_| BackendError::Unknown("Invalid repository header".to_string()))?;
Ok(header.configuration.key)
}
}
impl SyncManifest for FlatFile {
type Iterator = std::vec::IntoIter<StoredArchive>;
fn last_modification(&mut self) -> Result<DateTime<FixedOffset>> {
if self.manifest.is_empty() {
Err(BackendError::ManifestError(
"No archives/timestamps present".to_string(),
))
} else {
let archive = &self.manifest[self.manifest.len() - 1];
Ok(archive.timestamp())
}
}
fn chunk_settings(&mut self) -> ChunkSettings {
self.header.configuration.chunk_settings
}
fn archive_iterator(&mut self) -> Self::Iterator {
self.manifest.clone().into_iter()
}
fn write_chunk_settings(&mut self, settings: ChunkSettings) -> Result<()> {
Err(BackendError::ManifestError("Changing the default chunk settings with the flat file backend is currently unsupported".to_string()))
}
fn write_archive(&mut self, archive: StoredArchive) -> Result<()> {
self.manifest.push(archive.clone());
self.write.seek(SeekFrom::End(0))?;
rmps::encode::write(
&mut self.write,
&FlatFileTransaction::ManifestInsert {
id: archive.id,
name: archive.name,
timestamp: archive.timestamp,
},
)?;
Ok(())
}
fn touch(&mut self) -> Result<()> {
Ok(())
}
}
impl SyncIndex for FlatFile {
fn lookup_chunk(&mut self, id: ChunkID) -> Option<SegmentDescriptor> {
self.index.get(&id).copied()
}
fn set_chunk(&mut self, id: ChunkID, location: SegmentDescriptor) -> Result<()> {
self.index.insert(id, location);
Ok(())
}
fn known_chunks(&mut self) -> HashSet<ChunkID> {
self.index.keys().copied().collect::<HashSet<_>>()
}
fn commit_index(&mut self) -> Result<()> {
Ok(())
}
fn chunk_count(&mut self) -> usize {
self.index.len()
}
}
impl SyncBackend for FlatFile {
type SyncManifest = Self;
type SyncIndex = Self;
fn get_index(&mut self) -> &mut Self::SyncIndex {
self
}
fn get_manifest(&mut self) -> &mut Self::SyncManifest {
self
}
fn write_key(&mut self, key: EncryptedKey) -> Result<()> {
Err(BackendError::Unknown(
"Changing the key of a flat file repository is not supported at this time.".to_string(),
))
}
fn read_key(&mut self) -> Result<EncryptedKey> {
Ok(self.header.configuration.key.clone())
}
fn read_chunk(&mut self, location: SegmentDescriptor) -> Result<Chunk> {
self.read.seek(SeekFrom::Start(location.start))?;
let tx: FlatFileTransaction = rmps::decode::from_read(&mut self.read)?;
if let FlatFileTransaction::Insert { chunk, .. } = tx {
Ok(chunk)
} else {
Err(BackendError::SegmentError(
"Invalid data pointer!".to_string(),
))
}
}
fn write_chunk(&mut self, chunk: Chunk) -> Result<SegmentDescriptor> {
let start = self.write.seek(SeekFrom::End(0))?;
let id = chunk.get_id();
let tx = FlatFileTransaction::Insert { chunk, id };
rmps::encode::write(&mut self.write, &tx)?;
Ok(SegmentDescriptor {
segment_id: 0,
start,
})
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::repository::{Encryption, Key};
use tempfile::tempdir;
fn setup() -> (Key, EncryptedKey, ChunkSettings) {
let key = Key::random(32);
let pass = b"A Very strong password";
let enc_key = EncryptedKey::encrypt(&key, 512, 1, Encryption::new_aes256ctr(), pass);
(key, enc_key, ChunkSettings::lightweight())
}
#[tokio::test(threaded_scheduler)]
async fn key_store_load() {
let (key, enc_key, settings) = setup();
let directory = tempdir().unwrap();
let file = directory.path().join("temp.asuran");
let mut flatfile = FlatFile::new(&file, Some(settings), Some(enc_key)).unwrap();
flatfile.close().await;
let flatfile = FlatFile::new(&file, None, None).unwrap();
let new_key = flatfile
.read_key()
.await
.expect("Could not read key")
.decrypt(b"A Very strong password")
.expect("Could not decrypt key");
assert_eq!(key, new_key);
}
}