scp-platform 0.1.0-beta.1

Platform abstraction traits for SCP (Shared Context Protocol)
Documentation 
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

//! Platform abstraction layer for SCP.
//!
//! This crate defines the four platform abstraction traits that every SCP
//! component depends on for device-specific capabilities:
//!
//! - [`KeyCustody`] — Cryptographic key management (generation, signing, ECDH,
//!   pseudonym derivation). Production: Secure Enclave (iOS), Android Keystore.
//! - [`DeviceAttestation`] — Device attestation tokens (App Attest, Play Integrity).
//! - [`Push`] — Push notification registration and handling (APNs, FCM).
//! - [`Storage`] — Persistent key-value byte storage (Keychain, encrypted `SQLite`).
//!
//! All traits are `Send + Sync` with async methods, designed for injection
//! through initializers. Production implementations use hardware security;
//! testing implementations (in-memory, see ADR-006) provide identical API
//! surfaces with no external dependencies.
//!
//! # Architecture
//!
//! See ADR-006 ("In-Memory Platform Adapter") in `.docs/adrs/phase-1.md` for
//! the full design rationale. The trait definitions in this crate are the
//! authoritative source for all platform adapter contracts.
//!
//! # Usage
//!
//! Components accept platform traits as generic parameters or trait objects:
//!
//! ```rust,ignore
//! async fn create_identity<K: scp_platform::KeyCustody>(custody: &K) {
//!     let handle = custody.generate_keypair(scp_platform::KeyType::Ed25519).await?;
//!     // ...
//! }
//! ```

#![forbid(unsafe_code)]

pub mod encrypted;
#[cfg(feature = "encrypting")]
pub mod encrypting_adapter;
pub mod error;
// In-memory platform adapters — gated by the `testing` feature, NOT by
// `software_platform`. This ensures production mobile builds can enable
// `software_platform` (for crypto primitives) without compiling in insecure
// in-memory key storage. See GitHub issue #88 and ADR-006.
#[cfg(feature = "testing")]
pub mod testing;
// `software` is an alias for `testing` that matches the historical path. New
// code should prefer `scp_platform::testing::*`; `software::*` paths remain
// valid for backwards compatibility.
#[cfg(feature = "testing")]
pub use testing as software;
#[cfg(target_os = "android")]
pub mod android;
#[cfg(feature = "apple")]
pub mod apple;
#[cfg(feature = "file")]
pub mod file;
#[cfg(feature = "filesystem")]
pub mod filesystem;
#[cfg(feature = "sqlite")]
pub mod sqlite;
#[cfg(feature = "sync")]
pub mod syncable;
pub mod traits;

// Re-export all public types for ergonomic access.
pub use encrypted::EncryptedStorage;
pub use error::PlatformError;
pub use traits::{
    CustodyType, DeviceAttestation, DeviceAttestationToken, KeyCustody, KeyHandle, KeyType,
    PseudonymKeypair, PublicKey, Push, PushToken, SharedSecret, Signature, Storage, WakeSignal,
};