dsf-core 0.2.0

DSF core object definitions
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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161

#[cfg(feature = "alloc")]
use alloc::prelude::v1::*;

use crate::base::{Body, PrivateOptions};
use crate::crypto;
use crate::error::Error;
use crate::options::Options;
use crate::types::*;

use super::Service;

/// Service builder to assist in the construction of service instances
pub struct ServiceBuilder {
    id: Option<Id>,
    public_key: Option<PublicKey>,

    kind: PageKind,
    application_id: u16,
    body: Body,

    private_key: Option<PrivateKey>,
    secret_key: Option<SecretKey>,
    encrypted: bool,

    public_options: Vec<Options>,
    private_options: Vec<Options>,
}

impl Default for ServiceBuilder {
    /// Create a default service builder instance
    fn default() -> Self {
        Self {
            id: None,
            public_key: None,

            application_id: 0,
            kind: PageKind::Generic,
            body: Body::None,

            private_key: None,
            secret_key: None,
            encrypted: false,

            public_options: vec![],
            private_options: vec![],
        }
    }
}

/// ServiceBuilder provides helpers for constructing service instances
impl ServiceBuilder {
    /// Setup a peer service.
    /// This is equivalent to .kind(Kind::Peer)
    pub fn peer() -> Self {
        Self {
            kind: PageKind::Peer,
            ..Default::default()
        }
    }

    /// Setup a generic service.
    /// This is equivalent to .kind(Kind::Generic)
    pub fn generic() -> Self {
        Self {
            kind: PageKind::Generic,
            ..Default::default()
        }
    }

    /// Setup a private service.
    /// This is equivalent to .kind(Kind::Private)
    pub fn private() -> Self {
        Self {
            kind: PageKind::Private,
            ..Default::default()
        }
    }

    /// Set the ID and public key for the service
    pub fn id(mut self, id: Id, public_key: PublicKey) -> Self {
        self.id = Some(id);
        self.public_key = Some(public_key);
        self
    }

    pub fn kind(mut self, kind: PageKind) -> Self {
        self.kind = kind;
        self
    }

    pub fn body(mut self, body: Body) -> Self {
        self.body = body;
        self
    }

    pub fn private_key(mut self, private_key: PrivateKey) -> Self {
        self.private_key = Some(private_key);
        self
    }

    pub fn secret_key(mut self, secret_key: SecretKey) -> Self {
        self.secret_key = Some(secret_key);
        self
    }

    pub fn application_id(mut self, application_id: u16) -> Self {
        self.application_id = application_id;
        self
    }

    /// Enable service encryption
    /// this is equivalent to .secret_key(crypto::new_sk().unwrap()).encrypted(true);
    pub fn encrypt(mut self) -> Self {
        let secret_key = crypto::new_sk().unwrap();
        self.secret_key = Some(secret_key);
        self.encrypted = true;
        self
    }

    pub fn public_options(mut self, o: Vec<Options>) -> Self {
        self.public_options = o;
        self
    }

    pub fn private_options(mut self, o: Vec<Options>) -> Self {
        self.private_options = o;
        self
    }

    pub fn build(self) -> Result<Service, Error> {
        // TODO: perform any validation (no private options without secret key etc.)

        // Generate new keys if required
        let (id, public_key, private_key) = match (self.id, self.public_key, self.private_key) {
            (Some(id), Some(public_key), private_key) => (id, public_key, private_key),
            (None, None, None) => {
                let (public_key, private_key) = crypto::new_pk().unwrap();
                let id = crypto::hash(&public_key).unwrap();
                (id, public_key, Some(private_key))
            }
            _ => panic!("Invalid service builder configuration"),
        };

        // Build service
        Ok(Service {
            id,
            application_id: self.application_id,
            kind: self.kind,
            version: 0,
            data_index: 0,
            body: self.body,
            public_options: self.public_options,
            private_options: PrivateOptions::Cleartext(self.private_options),
            public_key,
            private_key,
            encrypted: self.encrypted,
            secret_key: self.secret_key,
            last_sig: None,
        })
    }
}