nym-sphinx 1.20.4

Top-level crate for sphinx packets as used by the Nym mixnet
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

// Copyright 2022 - Nym Technologies SA <contact@nymtech.net>
// SPDX-License-Identifier: Apache-2.0

use nym_crypto::aes::cipher::{KeyIvInit, StreamCipher};
use nym_crypto::asymmetric::x25519;
use nym_crypto::shared_key::new_ephemeral_shared_key;
use nym_crypto::symmetric::stream_cipher;
use nym_crypto::symmetric::stream_cipher::CipherKey;
use nym_sphinx_acknowledgements::surb_ack::{SurbAck, SurbAckRecoveryError};
use nym_sphinx_anonymous_replies::SurbEncryptionKey;
use nym_sphinx_chunking::fragment::Fragment;
use nym_sphinx_params::{
    PacketEncryptionAlgorithm, PacketHkdfAlgorithm, ReplySurbEncryptionAlgorithm,
};
use rand::{CryptoRng, RngCore};

pub struct NymPayloadBuilder {
    fragment: Fragment,
    surb_ack: SurbAck,
}

impl NymPayloadBuilder {
    pub fn new(fragment: Fragment, surb_ack: SurbAck) -> Self {
        NymPayloadBuilder { fragment, surb_ack }
    }

    fn build<C>(
        self,
        packet_encryption_key: &CipherKey<C>,
        variant_data: impl IntoIterator<Item = u8>,
    ) -> Result<NymPayload, SurbAckRecoveryError>
    where
        C: StreamCipher + KeyIvInit,
    {
        let (_, surb_ack_bytes) = self.surb_ack.prepare_for_sending()?;

        let mut fragment_data = self.fragment.into_bytes();
        stream_cipher::encrypt_in_place::<C>(
            packet_encryption_key,
            &stream_cipher::zero_iv::<C>(),
            &mut fragment_data,
        );

        // combines all the data as follows:
        // SURB_ACK || VARIANT_SPECIFIC_DATA || CHUNK_DATA
        // where variant-specific data is as follows:
        // for replies it would be the digest of the encryption key used
        // for 'regular' messages it would be the public component used in DH later used in the KDF

        Ok(NymPayload(
            surb_ack_bytes
                .into_iter()
                .chain(variant_data)
                .chain(fragment_data)
                .collect(),
        ))
    }

    pub fn build_reply(
        self,
        packet_encryption_key: &SurbEncryptionKey,
    ) -> Result<NymPayload, SurbAckRecoveryError> {
        let key_digest = packet_encryption_key.compute_digest();
        self.build::<ReplySurbEncryptionAlgorithm>(packet_encryption_key.inner(), key_digest)
    }

    pub fn build_regular<R>(
        self,
        rng: &mut R,
        recipient_encryption_key: &x25519::PublicKey,
    ) -> Result<NymPayload, SurbAckRecoveryError>
    where
        R: RngCore + CryptoRng,
    {
        // create keys for 'payload' encryption
        let (ephemeral_keypair, shared_key) = new_ephemeral_shared_key::<
            PacketEncryptionAlgorithm,
            PacketHkdfAlgorithm,
            _,
        >(rng, recipient_encryption_key);

        self.build::<PacketEncryptionAlgorithm>(
            &shared_key,
            ephemeral_keypair.public_key().to_bytes(),
        )
    }
}

// the actual byte data that will be put into the sphinx packet paylaod.
// no more transformations are going to happen to it
// TODO: use that fact for some better compile time assertions
pub struct NymPayload(Vec<u8>);

impl AsRef<[u8]> for NymPayload {
    fn as_ref(&self) -> &[u8] {
        &self.0
    }
}