deaddrop-core 2.6.0

DeadDrop protocol, crypto, identities, chunks, and object store
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
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

use crate::destination::Destination;
use crate::ids::{ContentId, ManifestId, ObjectId, PeerId};
use crate::limits::{MAX_EXTENSIONS, NONCE_LEN};
use crate::priority::Priority;
use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, Copy, PartialEq, Eq, Default, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum RoutingPolicyKind {
    Direct,
    Epidemic,
    #[default]
    SprayAndWait,
    Encounter,
    Utility,
    Adaptive,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct RoutingPolicy {
    pub kind: RoutingPolicyKind,
    pub replication_budget: u32,
    #[serde(default)]
    pub trusted_only: bool,
}

impl Default for RoutingPolicy {
    fn default() -> Self {
        Self {
            kind: RoutingPolicyKind::Adaptive,
            replication_budget: crate::limits::DEFAULT_REPLICATION_BUDGET,
            trusted_only: false,
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(tag = "kind", rename_all = "snake_case")]
pub enum PayloadDescriptor {
    Inline {
        length: u64,
        content_id: ContentId,
    },
    Blob {
        length: u64,
        content_id: ContentId,
    },
    Chunked {
        length: u64,
        manifest_id: ManifestId,
        content_id: ContentId,
    },
    Manifest {
        manifest_id: ManifestId,
    },
    /// EXPERIMENTAL: streaming manifests are not implemented in v0.2.
    StreamManifest {
        manifest_id: ManifestId,
    },
    Collection {
        members: Vec<ObjectId>,
    },
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct RecipientWrap {
    pub peer: PeerId,
    #[serde(with = "serde_bytes")]
    pub eph_pk: [u8; 32],
    #[serde(with = "serde_bytes")]
    pub nonce: [u8; NONCE_LEN],
    #[serde(with = "serde_bytes")]
    pub wrapped_key: Vec<u8>,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct SecurityDescriptor {
    pub scheme: String,
    pub public: bool,
    pub wraps: Vec<RecipientWrap>,
    #[serde(with = "serde_bytes")]
    pub content_nonce: [u8; NONCE_LEN],
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct Extension {
    pub name: String,
    pub critical: bool,
    #[serde(with = "serde_bytes")]
    pub data: Vec<u8>,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct DropEnvelope {
    pub protocol_version: u16,
    pub object_id: ObjectId,
    pub source: PeerId,
    pub destination: Destination,
    pub creation_time: u64,
    pub expiration: u64,
    pub priority: Priority,
    pub hop_limit: u8,
    pub hop_count: u8,
    pub payload_descriptor: PayloadDescriptor,
    pub routing_policy: RoutingPolicy,
    pub security_descriptor: SecurityDescriptor,
    pub application: String,
    pub topic: Option<String>,
    pub extensions: Vec<Extension>,
    #[serde(with = "serde_bytes")]
    pub author_pk: [u8; 32],
    #[serde(with = "serde_bytes")]
    pub signature: [u8; 64],
}

impl DropEnvelope {
    pub fn remaining_hops(&self) -> u8 {
        self.hop_limit.saturating_sub(self.hop_count)
    }

    pub fn is_expired(&self, now: u64) -> bool {
        now >= self.expiration
    }

    pub fn validate_extension_count(&self) -> crate::Result<()> {
        if self.extensions.len() > MAX_EXTENSIONS {
            return Err(crate::DdError::protocol(
                crate::ErrorCode::Ddp1006LimitExceeded,
                "too many extensions",
            ));
        }
        Ok(())
    }
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct PublicIdentity {
    pub version: u8,
    #[serde(with = "serde_bytes")]
    pub ed25519_pk: [u8; 32],
    #[serde(with = "serde_bytes")]
    pub x25519_pk: [u8; 32],
    #[serde(with = "serde_bytes")]
    pub signature: [u8; 64],
}