sos_database/
db.rs

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
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
use crate::Result;
use async_sqlite::{
    rusqlite::{CachedStatement, Error as SqlError, Transaction},
    Client,
};
use futures::{pin_mut, StreamExt};
use sos_sdk::prelude::{
    AuditLogFile,
    AuditEvent,
    AccountEventLog, DeviceEventLog, 
    decode, encode, vfs, CommitHash,
    Error as SdkError, EventLogExt, EventRecord,
    FolderEventLog, Identity, Paths, PublicIdentity, SecretId, Vault,
    VaultCommit, VaultEntry,
    FormatStreamIterator,
    VaultId,
};
use sos_core::{Origin, ExternalFile};
use std::{collections::HashMap, path::Path};

#[cfg(feature = "files")]
use {
    crate::storage::files::list_external_files,
    sos_sdk::events::FileEventLog,
};

/// Create global values in the database.
pub(crate) async fn import_globals(
    client: &mut Client,
    paths: &Paths,
) -> Result<()> {
    let global_preferences =
        Paths::new_global(paths.documents_dir().to_owned())
            .preferences_file();
    let global_preferences = if vfs::try_exists(&global_preferences)
        .await
        .map_err(SdkError::from)?
    {
        Some(
            vfs::read_to_string(global_preferences)
                .await
                .map_err(SdkError::from)?,
        )
    } else {
        None
    };

    let mut audit_events = Vec::new();
    if vfs::try_exists(paths.audit_file()).await.map_err(SdkError::from)? {
        let log_file = AuditLogFile::new(paths.audit_file()).await?;
        let mut file = vfs::File::open(paths.audit_file()).await.map_err(SdkError::from)?;
        let mut it = log_file.iter(false).await?;
        while let Some(record) = it.next().await? {
            let event = log_file.read_event(&mut file, &record).await?;
            let data = if let Some(data) = event.data() {
                Some(serde_json::to_string(data).map_err(SdkError::from)?)
            } else { None };
            audit_events.push((event.time().to_rfc3339()?, event, data));
        }
    }

    client
        .conn_mut(move |conn| {
            let mut tx = conn.transaction()?;
            futures::executor::block_on(async {
                create_audit_logs(&mut tx, audit_events).await?;
                if let Some(json_data) = global_preferences {
                    create_preferences(&mut tx, None, json_data).await?;
                }
                Ok::<_, SqlError>(())
            })?;
            tx.commit()?;
            Ok(())
        }).await?;
    
    Ok(())

}

/// Create an account in the database.
pub(crate) async fn import_account(
    client: &mut Client,
    paths: &Paths,
    account: &PublicIdentity,
) -> Result<()> {
    let account_identifier = account.address().to_string();
    let account_name = account.label().to_owned();

    // Identity folder
    let buffer = vfs::read(paths.identity_vault())
        .await
        .map_err(SdkError::from)?;
    let identity_vault: Vault = decode(&buffer).await?;
    let identity_rows = collect_vault_rows(&identity_vault).await?;
    let identity_events =
        collect_folder_events(paths.identity_events()).await?;

    // Account events
    let account_events =
        collect_account_events(paths.account_events()).await?;

    // Device vault
    let buffer = vfs::read(paths.device_file())
        .await
        .map_err(SdkError::from)?;
    let device_vault: Vault = decode(&buffer).await?;
    let device_rows = collect_vault_rows(&device_vault).await?;

    // Device events
    let device_events = collect_device_events(paths.device_events()).await?;

    // File events
    #[cfg(feature = "files")]
    let file_events = collect_file_events(paths.file_events()).await?;

    // User folders
    let mut folders = Vec::new();
    let user_folders = Identity::list_local_folders(paths).await?;
    for (summary, path) in user_folders {
        let buffer = vfs::read(path).await.map_err(SdkError::from)?;
        let vault: Vault = decode(&buffer).await?;
        let rows = collect_vault_rows(&vault).await?;
        let events =
            collect_folder_events(paths.event_log_path(summary.id())).await?;
        folders.push((vault, rows, events));
    }
    
    let mut user_files = Vec::new();
    #[cfg(feature = "files")]
    {
        let files = list_external_files(&paths).await?;
        for file in files {
            let path = paths.file_location(
                file.vault_id(),
                file.secret_id(),
                file.file_name().to_string(),
            );
            let buffer = vfs::read(path).await.map_err(SdkError::from)?;
            user_files.push((file, buffer));
        }
    }

    let account_preferences = if vfs::try_exists(paths.preferences_file())
        .await
        .map_err(SdkError::from)?
    {
        Some(
            vfs::read_to_string(paths.preferences_file())
                .await
                .map_err(SdkError::from)?,
        )
    } else {
        None
    };

    let remote_servers = if vfs::try_exists(paths.remote_origins())
        .await
        .map_err(SdkError::from)?
    {
        let buffer = vfs::read(paths.remote_origins())
                .await
                .map_err(SdkError::from)?;
        Some(serde_json::from_slice::<Vec<Origin>>(&buffer).map_err(SdkError::from)?)
    } else {
        None
    };

    client
        .conn_mut(move |conn| {
            let mut tx = conn.transaction()?;

            futures::executor::block_on(async {
                    
                // Create the account
                let account_id = {
                    tx.execute(
                        r#"
                          INSERT INTO accounts (identifier, name)
                          VALUES (?1, ?2)
                        "#,
                        (&account_identifier, &account_name),
                    )?;
                    tx.last_insert_rowid()
                };

                // Create the identity folder
                let (identity_folder_id, _) = create_folder(
                    &mut tx,
                    account_id,
                    identity_vault,
                    identity_rows,
                    Some(identity_events),
                )
                .await?;
                // Create the join entry for the account login folder
                tx.execute(
                    r#"
                      INSERT INTO account_login_folder (account_id, folder_id) 
                      VALUES (?1, ?2)
                    "#,
                    (&account_id, &identity_folder_id),
                )?;

                // Create the device folder without events
                // as it is configured for SYSTEM | DEVICE | NO_SYNC
                let (device_folder_id, _) = create_folder(
                    &mut tx,
                    account_id,
                    device_vault,
                    device_rows,
                    None,
                )
                .await?;
                // Create the join entry for the device folder
                tx.execute(
                    r#"
                      INSERT INTO account_device_folder (account_id, folder_id) 
                      VALUES (?1, ?2)
                    "#,
                    (&account_id, &device_folder_id),
                )?;

                // Create the account events
                create_account_events(&mut tx, account_id, account_events)
                    .await?;

                // Create the device events
                create_device_events(&mut tx, account_id, device_events)
                    .await?;

                // Create the file events
                #[cfg(feature = "files")]
                create_file_events(&mut tx, account_id, file_events).await?;

                // Create user folders
                let mut folder_ids = HashMap::new();
                for (vault, rows, events) in folders {
                    let id = *vault.id();
                    let folder_id = create_folder(
                      &mut tx,
                      account_id,
                      vault,
                      rows,
                      Some(events),
                    )
                    .await?;
                    folder_ids.insert(id, folder_id);
                }

                create_files(&mut tx, &folder_ids, user_files).await?;

                if let Some(json_data) = account_preferences {
                    create_preferences(&mut tx, Some(account_id), json_data).await?;
                }

                if let Some(servers) = remote_servers {
                    create_servers(&mut tx, account_id, servers).await?;
                }

                Ok::<_, SqlError>(())
            })?;

            tx.commit()?;
            Ok(())
        })
        .await?;

    Ok(())
}

async fn collect_vault_rows(
    vault: &Vault,
) -> Result<Vec<(SecretId, CommitHash, Vec<u8>, Vec<u8>)>> {
    let mut rows = Vec::new();
    for (identifier, commit) in vault.iter() {
        let VaultCommit(hash, entry) = commit;
        let VaultEntry(meta, secret) = entry;
        let meta = encode(meta).await?;
        let secret = encode(secret).await?;
        rows.push((*identifier, *hash, meta, secret));
    }
    Ok(rows)
}

async fn collect_account_events(
    path: impl AsRef<Path>,
) -> Result<Vec<(String, CommitHash, EventRecord)>> {
    let mut events = Vec::new();
    let event_log = AccountEventLog::new_account(path).await?;
    let stream = event_log.stream(false).await;
    pin_mut!(stream);
    while let Some(record) = stream.next().await {
        events.push(convert_event_row(record?.0)?);
    }
    Ok(events)
}

async fn collect_folder_events(
    path: impl AsRef<Path>,
) -> Result<Vec<(String, CommitHash, EventRecord)>> {
    let mut events = Vec::new();
    let event_log = FolderEventLog::new(path).await?;
    let stream = event_log.stream(false).await;
    pin_mut!(stream);
    while let Some(record) = stream.next().await {
        events.push(convert_event_row(record?.0)?);
    }
    Ok(events)
}

async fn collect_device_events(
    path: impl AsRef<Path>,
) -> Result<Vec<(String, CommitHash, EventRecord)>> {
    let mut events = Vec::new();
    let event_log = DeviceEventLog::new_device(path).await?;
    let stream = event_log.stream(false).await;
    pin_mut!(stream);
    while let Some(record) = stream.next().await {
        events.push(convert_event_row(record?.0)?);
    }
    Ok(events)
}

#[cfg(feature = "files")]
async fn collect_file_events(
    path: impl AsRef<Path>,
) -> Result<Vec<(String, CommitHash, EventRecord)>> {
    let mut events = Vec::new();
    let event_log = FileEventLog::new_file(path).await?;
    let stream = event_log.stream(false).await;
    pin_mut!(stream);
    while let Some(record) = stream.next().await {
        events.push(convert_event_row(record?.0)?);
    }
    Ok(events)
}

fn convert_event_row(
    record: EventRecord,
) -> Result<(String, CommitHash, EventRecord)> {
    Ok((record.time().to_rfc3339()?, *record.commit(), record))
}

async fn create_folder(
    tx: &mut Transaction<'_>,
    account_id: i64,
    vault: Vault,
    rows: Vec<(SecretId, CommitHash, Vec<u8>, Vec<u8>)>,
    events: Option<Vec<(String, CommitHash, EventRecord)>>,
) -> std::result::Result<(i64, HashMap<SecretId, i64>), SqlError> {
    // Insert folder meta data and get folder_id
    let folder_id = {
        let identifier = vault.id().to_string();
        let name = vault.name().to_string();
        let version = vault.summary().version();
        let cipher = vault.summary().cipher().to_string();
        let kdf = vault.summary().kdf().to_string();
        let flags = vault.summary().flags().bits().to_le_bytes();

        let mut stmt = tx.prepare_cached(
            r#"
              INSERT INTO folders
                (account_id, identifier, name, version, cipher, kdf, flags)
                VALUES (?1, ?2, ?3, ?4, ?5, ?6, ?7)
            "#,
        )?;
        stmt.execute((
            &account_id,
            &identifier,
            &name,
            &version,
            &cipher,
            &kdf,
            &flags,
        ))?;

        tx.last_insert_rowid()
    };

    // Insert the vault secret rows
    let mut secret_ids = HashMap::new();
    {
        let mut stmt = tx.prepare_cached(
            r#"
              INSERT INTO folder_secrets
                (folder_id, identifier, commit_hash, meta, secret)
                VALUES (?1, ?2, ?3, ?4, ?5)
            "#,
        )?;
        for (identifier, commit_hash, meta, secret) in rows {
            stmt.execute((
                &folder_id,
                &identifier.to_string(),
                commit_hash.to_string(),
                &meta,
                &secret,
            ))?;
            secret_ids.insert(identifier, tx.last_insert_rowid());
        }
    }

    // Insert the event rows
    if let Some(events) = events {
        let stmt = tx.prepare_cached(
            r#"
              INSERT INTO folder_events
              (folder_id, created_at, commit_hash, event)
              VALUES (?1, ?2, ?3, ?4)"#,
        )?;
        create_events(stmt, folder_id, events).await?;
    }

    Ok((folder_id, secret_ids))
}

async fn create_account_events(
    tx: &mut Transaction<'_>,
    account_id: i64,
    events: Vec<(String, CommitHash, EventRecord)>,
) -> std::result::Result<(), SqlError> {
    let stmt = tx.prepare_cached(
        r#"
          INSERT INTO account_events
            (account_id, created_at, commit_hash, event)
            VALUES (?1, ?2, ?3, ?4)
        "#,
    )?;
    create_events(stmt, account_id, events).await
}

async fn create_device_events(
    tx: &mut Transaction<'_>,
    account_id: i64,
    events: Vec<(String, CommitHash, EventRecord)>,
) -> std::result::Result<(), SqlError> {
    let stmt = tx.prepare_cached(
        r#"
          INSERT INTO device_events
            (account_id, created_at, commit_hash, event)
            VALUES (?1, ?2, ?3, ?4)
        "#,
    )?;
    create_events(stmt, account_id, events).await
}

async fn create_file_events(
    tx: &mut Transaction<'_>,
    account_id: i64,
    events: Vec<(String, CommitHash, EventRecord)>,
) -> std::result::Result<(), SqlError> {
    let stmt = tx.prepare_cached(
        r#"
          INSERT INTO file_events
            (account_id, created_at, commit_hash, event)
            VALUES (?1, ?2, ?3, ?4)
        "#,
    )?;
    create_events(stmt, account_id, events).await
}

async fn create_events(
    mut stmt: CachedStatement<'_>,
    id: i64,
    events: Vec<(String, CommitHash, EventRecord)>,
) -> std::result::Result<(), SqlError> {
    for (time, commit, record) in events {
        stmt.execute((&id, time, commit.to_string(), record.event_bytes()))?;
    }
    Ok(())
}

async fn create_files(
    tx: &mut Transaction<'_>,
    folder_ids: &HashMap<VaultId, (i64, HashMap<SecretId, i64>)>,
    user_files: Vec<(ExternalFile, Vec<u8>)>,
) -> std::result::Result<(), SqlError> {
    for (file, contents) in user_files {
        if let Some((folder_id, secret_ids)) =
            folder_ids.iter().find_map(|(k, v)| {
                if k == file.vault_id() {
                    Some(v)
                } else {
                    None
                }
            })
        {
            if let Some(secret_id) = secret_ids.get(file.secret_id()) {
                let mut stmt = tx.prepare_cached(
                    r#"
                      INSERT INTO folder_files
                        (folder_id, secret_id, checksum, contents)
                        VALUES (?1, ?2, ?3, ?4)
                    "#,
                )?;
                stmt.execute((
                    folder_id,
                    secret_id,
                    file.file_name().to_string(),
                    contents,
                ))?;
            } else {
                tracing::warn!(
                    file = %file,
                    "db::import::no_secret_for_file",
                );
            }
        } else {
            tracing::warn!(
                file = %file,
                "db::import::no_folder_for_file",
            );
        }
    }
    Ok(())
}

async fn create_preferences(
    tx: &mut Transaction<'_>,
    account_id: Option<i64>,
    json_data: String,
) -> std::result::Result<(), SqlError> {
    let mut stmt = tx.prepare_cached(
        r#"
          INSERT INTO preferences
            (account_id, json_data)
            VALUES (?1, ?2)
        "#,
    )?;
    stmt.execute((account_id, json_data))?;
    Ok(())
}

async fn create_servers(
    tx: &mut Transaction<'_>,
    account_id: i64,
    servers: Vec<Origin>,
) -> std::result::Result<(), SqlError> {
    let mut stmt = tx.prepare_cached(
        r#"
          INSERT INTO servers
            (account_id, name, url)
            VALUES (?1, ?2, ?3)
        "#,
    )?;
        
    for server in servers {
        stmt.execute((account_id, server.name(), server.url().to_string()))?;
    }

    Ok(())
}

async fn create_audit_logs(
    tx: &mut Transaction<'_>,
    events: Vec<(String, AuditEvent, Option<String>)>,
) -> std::result::Result<(), SqlError> {
    let mut stmt = tx.prepare_cached(
        r#"
          INSERT INTO audit_logs
            (created_at, account_identifier, event_kind, event_data)
            VALUES (?1, ?2, ?3, ?4)
        "#,
    )?;
    for (time, event, data) in events {
        stmt.execute((time, event.address().to_string(), event.event_kind().to_string(), data))?;
    }
    Ok(())
}