self_sdk 0.1.0

An SDK for interacting with the self network
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
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
use crate::error::SelfError;
use crate::keypair::{KeyPair, KeyPairType};
use std::collections::BTreeMap;
use std::time::Duration;

use serde::{Deserialize, Deserializer, Serialize, Serializer};
use serde_json::Value;
use uuid::Builder;

#[derive(Serialize, Deserialize, Clone)]
pub struct Message {
    #[serde(serialize_with = "as_base64", deserialize_with = "from_base64")]
    payload: BTreeMap<String, serde_json::Value>,
    #[serde(
        default,
        serialize_with = "as_base64",
        deserialize_with = "protected_optional_from_base64",
        skip_serializing_if = "Option::is_none"
    )]
    protected: Option<BTreeMap<String, serde_json::Value>>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    signature: Option<String>,
    signatures: Vec<Signature>,
}

#[derive(Serialize, Deserialize, Clone)]
pub struct Signature {
    #[serde(
        default,
        serialize_with = "as_base64",
        deserialize_with = "protected_from_base64"
    )]
    pub protected: BTreeMap<String, serde_json::Value>,
    pub signature: String,
}

fn as_base64<T, S>(buffer: &T, serializer: S) -> Result<S::Ok, S::Error>
where
    T: Serialize,
    S: Serializer,
{
    let json = serde_json::to_string(buffer).unwrap();
    let encoded_json = base64::encode_config(&json, base64::URL_SAFE_NO_PAD);
    serializer.serialize_str(&encoded_json)
}

fn from_base64<'de, D>(deserializer: D) -> Result<BTreeMap<String, serde_json::Value>, D::Error>
where
    D: Deserializer<'de>,
{
    use serde::de::Error;
    String::deserialize(deserializer).and_then(|string| {
        let decoded_json = match base64::decode_config(string, base64::URL_SAFE_NO_PAD) {
            Ok(decoded_json) => decoded_json,
            Err(err) => return Err(Error::custom(err.to_string())),
        };
        serde_json::from_slice(&decoded_json).map_err(|err| Error::custom(err.to_string()))
    })
}

fn protected_from_base64<'de, D>(
    deserializer: D,
) -> Result<BTreeMap<String, serde_json::Value>, D::Error>
where
    D: Deserializer<'de>,
{
    use serde::de::Error;
    String::deserialize(deserializer).and_then(|string| {
        let decoded_json = match base64::decode_config(string, base64::URL_SAFE_NO_PAD) {
            Ok(decoded_json) => decoded_json,
            Err(err) => return Err(Error::custom(err.to_string())),
        };
        serde_json::from_slice(&decoded_json).map_err(|err| Error::custom(err.to_string()))
    })
}

fn protected_optional_from_base64<'de, D>(
    deserializer: D,
) -> Result<Option<BTreeMap<String, serde_json::Value>>, D::Error>
where
    D: Deserializer<'de>,
{
    use serde::de::Error;
    String::deserialize(deserializer).and_then(|string| {
        let decoded_json = match base64::decode_config(string, base64::URL_SAFE_NO_PAD) {
            Ok(decoded_json) => decoded_json,
            Err(err) => return Err(Error::custom(err.to_string())),
        };
        serde_json::from_slice(&decoded_json).map_err(|err| Error::custom(err.to_string()))
    })
}

impl Message {
    pub fn new(typ: &str, iss: &str, sub: &str, exp: Option<Duration>, unix: bool) -> Message {
        let mut m = Message {
            payload: BTreeMap::new(),
            protected: None,
            signature: None,
            signatures: Vec::new(),
        };

        let mut rng_bytes: [u8; 16] = [0; 16];
        dryoc::rng::copy_randombytes(&mut rng_bytes);

        let jti = Builder::from_random_bytes(rng_bytes)
            .into_uuid()
            .to_string();

        // add default fields
        m.payload
            .insert(String::from("typ"), Value::from(String::from(typ)));
        m.payload
            .insert(String::from("iss"), Value::from(String::from(iss)));
        m.payload
            .insert(String::from("sub"), Value::from(String::from(sub)));
        m.payload
            .insert(String::from("typ"), Value::from(String::from(typ)));
        m.payload
            .insert(String::from("jti"), Value::from(String::from(jti)));

        let now = crate::time::now();

        if unix {
            m.payload
                .insert(String::from("iat"), Value::from(now.timestamp()));
            if exp.is_some() {
                let exp = (now + chrono::Duration::from_std(exp.unwrap()).unwrap()).timestamp();
                m.payload.insert(String::from("exp"), Value::from(exp));
            }
        } else {
            m.payload
                .insert(String::from("iat"), Value::from(now.to_rfc3339()));
            if exp.is_some() {
                let exp = (now + chrono::Duration::from_std(exp.unwrap()).unwrap()).to_rfc3339();
                m.payload.insert(String::from("exp"), Value::from(exp));
            }
        }

        return m;
    }

    pub fn new_without_defaults() -> Message {
        return Message {
            payload: BTreeMap::new(),
            protected: None,
            signature: None,
            signatures: Vec::new(),
        };
    }

    pub fn new_from_payload<T: Serialize>(custom_payload: &T) -> Result<Message, SelfError> {
        // TODO this is not the right way to do this, but
        // the most convenient/fastest way for now.
        // Investigate if generic payload is possible,
        // with a default of BTreeMap<String, Value>

        let encoded_custom_payload = match serde_json::to_vec(custom_payload) {
            Ok(encoded_custom_payload) => encoded_custom_payload,
            Err(_) => return Err(SelfError::MessageEncodingInvalid),
        };

        let payload: BTreeMap<String, Value> = match serde_json::from_slice(&encoded_custom_payload)
        {
            Ok(payload) => payload,
            Err(_) => return Err(SelfError::MessageDecodingInvalid),
        };

        return Ok(Message {
            payload: payload,
            protected: None,
            signature: None,
            signatures: Vec::new(),
        });
    }

    pub fn to_custom_payload<T>(&self) -> Result<T, SelfError>
    where
        T: for<'a> Deserialize<'a>,
    {
        let encoded_payload = match serde_json::to_vec(&self.payload) {
            Ok(encoded_payload) => encoded_payload,
            Err(_) => return Err(SelfError::MessageEncodingInvalid),
        };

        let decoded_payload: T = match serde_json::from_slice(&encoded_payload) {
            Ok(decoded_payload) => decoded_payload,
            Err(_) => return Err(SelfError::MessageDecodingInvalid),
        };

        return Ok(decoded_payload);
    }

    pub fn from_bytes(data: &[u8]) -> Result<Message, SelfError> {
        let m: Message = match serde_json::from_slice(data) {
            Ok(m) => m,
            Err(err) => {
                println!("json error: {}", err);
                return Err(SelfError::MessageDecodingInvalid);
            }
        };

        if m.signatures.len() < 1 {
            if m.protected.is_none() {
                return Err(SelfError::MessageNoProtected);
            }

            if m.signature.is_none() {
                return Err(SelfError::MessageNoSignature);
            }
        }

        return Ok(m);
    }

    pub fn add_field_int(&mut self, key: &str, value: i32) {
        self.payload.insert(String::from(key), Value::from(value));
    }

    pub fn add_field_string(&mut self, key: &str, value: &str) {
        self.payload
            .insert(String::from(key), Value::from(String::from(value)));
    }

    pub fn add_field_object(&mut self, key: &str, value: Value) {
        self.payload.insert(String::from(key), value);
    }

    pub fn add_field_raw_json(&mut self, key: &str, value: &[u8]) -> Result<(), SelfError> {
        let decoded_value: Value = match serde_json::from_slice(value) {
            Ok(decoded_value) => decoded_value,
            Err(_) => return Err(SelfError::MessageDecodingInvalid),
        };

        self.payload.insert(String::from(key), decoded_value);

        return Ok(());
    }

    pub fn get_field(&self, key: &str) -> Option<&Value> {
        return self.payload.get(key);
    }

    pub fn sign(&mut self, signing_key: &KeyPair) -> Result<(), SelfError> {
        if signing_key.keypair_type() != KeyPairType::Ed25519 {
            return Err(SelfError::MessageSigningKeyInvalid);
        }

        let mut protected = BTreeMap::new();
        protected.insert(String::from("kid"), Value::String(signing_key.id()));
        protected.insert(String::from("alg"), Value::String(String::from("EdDSA")));

        let payload = match serde_json::to_string(&self.payload) {
            Ok(payload) => payload,
            Err(_) => return Err(SelfError::MessageEncodingInvalid),
        };

        let encoded_payload = base64::encode_config(payload, base64::URL_SAFE_NO_PAD);
        let encoded_protected = base64::encode_config(
            serde_json::to_vec(&protected).unwrap(),
            base64::URL_SAFE_NO_PAD,
        );

        let message = format!("{}.{}", encoded_protected, encoded_payload);

        let signature = match signing_key.sign(message.as_bytes()) {
            Ok(signature) => signature,
            Err(err) => return Err(err),
        };

        let encoded_signature = base64::encode_config(signature, base64::URL_SAFE_NO_PAD);

        self.signatures.push(Signature {
            protected: protected,
            signature: encoded_signature,
        });

        return Ok(());
    }

    pub fn verify(&self, signing_key: &KeyPair) -> Result<(), SelfError> {
        if signing_key.keypair_type() != KeyPairType::Ed25519 {
            return Err(SelfError::MessageSigningKeyInvalid);
        }

        if self.protected.is_some() {
            let protected = self.protected.as_ref().unwrap();
            if protected["kid"] != signing_key.id() {
                return Err(SelfError::MessageSignatureKeypairMismatch);
            }

            let encoded_signature = self.signature.as_ref().unwrap();

            let decoded_signature =
                match base64::decode_config(encoded_signature, base64::URL_SAFE_NO_PAD) {
                    Ok(decoded_signature) => decoded_signature,
                    Err(_) => return Err(SelfError::MessageSignatureEncodingInvalid),
                };

            let payload = serde_json::to_string(&self.payload).unwrap();
            let protected = serde_json::to_string(&self.protected).unwrap();

            let encoded_payload = base64::encode_config(payload, base64::URL_SAFE_NO_PAD);
            let encoded_protected = base64::encode_config(protected, base64::URL_SAFE_NO_PAD);
            let message = format!("{}.{}", encoded_protected, encoded_payload);

            if !signing_key.verify(message.as_bytes(), &decoded_signature) {
                return Err(SelfError::MessageSignatureInvalid);
            }

            return Ok(());
        }

        for s in &self.signatures {
            if s.protected["kid"] != signing_key.id() {
                continue;
            }

            let decoded_signature =
                match base64::decode_config(&s.signature, base64::URL_SAFE_NO_PAD) {
                    Ok(decoded_signature) => decoded_signature,
                    Err(_) => return Err(SelfError::MessageSignatureEncodingInvalid),
                };

            let payload = serde_json::to_string(&self.payload).unwrap();
            let protected = serde_json::to_string(&s.protected).unwrap();

            let encoded_payload = base64::encode_config(payload, base64::URL_SAFE_NO_PAD);
            let encoded_protected = base64::encode_config(protected, base64::URL_SAFE_NO_PAD);
            let message = format!("{}.{}", encoded_protected, encoded_payload);

            if !signing_key.verify(message.as_bytes(), &decoded_signature) {
                return Err(SelfError::MessageSignatureInvalid);
            }

            return Ok(());
        }

        return Err(SelfError::MessageSignatureKeypairMismatch);
    }

    pub fn signing_key_ids(&self) -> Option<Vec<String>> {
        let mut kids = Vec::new();

        if self.protected.is_some() {
            let kid = &self.protected.as_ref().unwrap()["kid"];

            if kid.is_string() {
                kids.push(String::from(kid.as_str().unwrap()));
            }
        }

        for sig in &self.signatures {
            let kid = &sig.protected["kid"];

            if kid.is_string() {
                kids.push(String::from(kid.as_str().unwrap()));
            }
        }

        if kids.len() < 1 {
            return None;
        }

        return Some(kids);
    }

    pub fn signatures(&self) -> Vec<Signature> {
        if self.protected.is_some() && self.signature.is_some() {
            return vec![Signature {
                protected: self.protected.as_ref().unwrap().clone(),
                signature: self.signature.as_ref().unwrap().clone(),
            }];
        }

        return self.signatures.clone();
    }

    pub fn to_jws(&mut self) -> Result<String, SelfError> {
        if self.signatures.len() < 1 {
            return Err(SelfError::MessageNoSignature);
        }

        let json = match serde_json::to_string(self) {
            Ok(json) => json,
            Err(_) => return Err(SelfError::MessageEncodingInvalid),
        };

        return Ok(json);
    }

    pub fn to_jwt(&self) -> Result<String, SelfError> {
        if self.signatures.len() < 1 {
            return Err(SelfError::MessageNoSignature);
        }

        let payload = match serde_json::to_string(&self.payload) {
            Ok(payload) => payload,
            Err(_) => return Err(SelfError::MessageEncodingInvalid),
        };

        let protected = serde_json::to_vec(&self.signatures[0].protected).unwrap();

        let encoded_payload = base64::encode_config(payload, base64::URL_SAFE_NO_PAD);
        let encoded_protected = base64::encode_config(protected, base64::URL_SAFE_NO_PAD);

        return Ok(format!(
            "{}.{}.{}",
            encoded_protected, encoded_payload, self.signatures[0].signature
        ));
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn to_jws() {
        let mut m = Message::new("auth.token", "me", "me", None, true);

        // try to encode with no signatures
        assert!(m.to_jws().is_err());

        // attempt to sign with an encryption key
        let kp = KeyPair::new(KeyPairType::Curve25519);
        assert!(m.sign(&kp).is_err());

        // add a valid signature
        let kp = KeyPair::new(KeyPairType::Ed25519);
        assert!(m.sign(&kp).is_ok());

        // encode to jws
        let jws = m.to_jws().unwrap();

        // decode from jws
        let bytes = jws.as_bytes();

        let m = Message::from_bytes(bytes).unwrap();
        m.verify(&kp).unwrap();
        assert_eq!(m.signing_key_ids().unwrap().len(), 1);
    }

    #[test]
    fn to_jwt() {
        let mut m = Message::new("auth.token", "me", "me", None, true);

        // try to encode with no signatures
        assert!(m.to_jws().is_err());

        // attempt to sign with an encryption key
        let kp = KeyPair::new(KeyPairType::Curve25519);
        assert!(m.sign(&kp).is_err());

        // add a valid signature
        let kp = KeyPair::new(KeyPairType::Ed25519);
        assert!(m.sign(&kp).is_ok());

        // encode to jwt
        let jwt = m.to_jws();
        assert!(jwt.is_ok());
    }
}