Skip to content

docs: link backup & recovery docs #354

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
paolodamico wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: link backup & recovery docs #354

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion bedrock/src/backup/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
//! World App's "Backup & Recovery" (client-side primitives).
//!
//! This module owns the backup file format, manifest computation, sealing/unsealing,
//! and the Turnkey stamping helpers shared across iOS and Android.
//!
//! For the architecture, factor model, flows, and threat model, see the central docs:
//! <https://docs.toolsforhumanity.com/world-app/backup>.

mod backup_format;
mod client_events;
mod manifest;
Expand Down Expand Up @@ -252,7 +260,7 @@ impl BackupManager {
}

/// Adds new factor by re-encrypting the backup keypair (not the backup itself!)
/// with a new factor secret.
/// with a new factor secret. (See BF-3 Adding a Main Faactor)
///
/// * `encrypted_backup_key_with_existing_factor_secret` - is the backup keypair that was
/// encrypted with the existing factor secret. Hex encoded.
Expand Down Expand Up @@ -637,6 +645,8 @@ impl<'de> Deserialize<'de> for BackupFileDesignator {
}

/// Errors that can occur when working with backups and manifests.
///
/// Further error documentation: <https://docs.toolsforhumanity.com/world-app/backup/components#what-the-service-rejects>
#[crate::bedrock_error]
pub enum BackupError {
#[error("Failed to decode factor secret as hex")]
Expand Down
2 changes: 0 additions & 2 deletions bedrock/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,6 @@ pub mod transactions;
/// Introduces low level primitives for the crypto wallet, including logging functionality.
pub mod primitives;

/// Tools for storing, retrieving, encrypting and decrypting backup data and metadata.
/// See `backup::BackupManager` for the high-level API.
pub mod backup;

/// Introduces low level operations for interacting with a Nitro Enclave.
Expand Down
Loading