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
use std::fmt::Display;

use crate::{address::Address, error::ModelsError};
use massa_hash::Hash;
use massa_serialization::{Deserializer, SerializeError, Serializer};
use massa_signature::{
    KeyPair, PublicKey, PublicKeyDeserializer, Signature, SignatureDeserializer,
};
use nom::{
    error::{context, ContextError, ParseError},
    sequence::tuple,
    IResult,
};
use serde::{Deserialize, Serialize};

/// Packages type T such that it can be securely sent and received in a trust-free network
///
/// If the internal content is mutated, then it must be re-wrapped, as the assosciated
/// signature, serialized data, etc. would no longer be in sync
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
pub struct SecureShare<T, ID>
where
    T: Display + SecureShareContent,
    ID: Id,
{
    /// Reference contents. Not required for the the security protocols.
    ///
    /// Use the Lightweight equivilant structures when you need verifiable
    /// serialized data, but do not need to read the values directly (such as when sending)
    pub content: T,
    #[serde(skip)]
    /// Content in sharable, deserializable form. Is used in the secure verification protocols.
    pub serialized_data: Vec<u8>,

    /// A cryptographically generated value using `serialized_data` and a public key.
    pub signature: Signature,
    /// The public-key component used in the generation of the signature
    pub content_creator_pub_key: PublicKey,
    /// Derived from the same public key used to generate the signature
    pub content_creator_address: Address,
    /// A secure hash of the data. See also [massa_hash::Hash]
    pub id: ID,
}

/// Used by signed structure
/// TODO: Make this trait use versions
pub trait Id {
    /// New id from hash
    fn new(hash: Hash) -> Self;
    /// Get a reference to the underlying hash
    fn get_hash(&self) -> &Hash;
}

/// Trait that define a structure that can be signed for secure sharing.
pub trait SecureShareContent
where
    Self: Sized + Display,
{
    /// Sign the SecureShare given the content
    fn sign(&self, keypair: &KeyPair, content_hash: &Hash) -> Result<Signature, ModelsError> {
        Ok(keypair.sign(&self.compute_signed_hash(&keypair.get_public_key(), content_hash))?)
    }

    /// verify signature
    fn verify_signature(
        &self,
        public_key: &PublicKey,
        content_hash: &Hash,
        signature: &Signature,
    ) -> Result<(), ModelsError> {
        Ok(public_key.verify_signature(
            &self.compute_signed_hash(public_key, content_hash),
            signature,
        )?)
    }

    /// Using the provided key-pair, applies a cryptographic signature, and packages
    /// the data required to share and verify the data in a trust-free network of peers.
    fn new_verifiable<Ser: Serializer<Self>, ID: Id>(
        self,
        content_serializer: Ser,
        keypair: &KeyPair,
        chain_id: u64,
    ) -> Result<SecureShare<Self, ID>, ModelsError> {
        let mut content_serialized = Vec::new();
        content_serializer.serialize(&self, &mut content_serialized)?;
        let public_key = keypair.get_public_key();
        let hash = Self::compute_hash(&self, &content_serialized, &public_key, chain_id);
        let creator_address = Address::from_public_key(&public_key);
        Ok(SecureShare {
            signature: self.sign(keypair, &hash)?,
            content_creator_pub_key: public_key,
            content_creator_address: creator_address,
            content: self,
            serialized_data: content_serialized,
            id: ID::new(hash),
        })
    }

    /// Compute hash
    fn compute_hash(
        &self,
        content_serialized: &[u8],
        content_creator_pub_key: &PublicKey,
        _chain_id: u64,
    ) -> Hash {
        let mut hash_data = Vec::new();
        hash_data.extend(content_creator_pub_key.to_bytes());
        hash_data.extend(content_serialized);
        Hash::compute_from(&hash_data)
    }

    /// Compute hash used for signature
    fn compute_signed_hash(&self, _public_key: &PublicKey, content_hash: &Hash) -> Hash {
        *content_hash
    }

    /// Serialize the secured structure
    fn serialize(
        signature: &Signature,
        creator_public_key: &PublicKey,
        serialized_content: &[u8],
        buffer: &mut Vec<u8>,
    ) -> Result<(), SerializeError> {
        buffer.extend(signature.to_bytes());
        buffer.extend(creator_public_key.to_bytes());
        buffer.extend(serialized_content);
        Ok(())
    }

    /// Deserialize the secured structure
    fn deserialize<
        'a,
        E: ParseError<&'a [u8]> + ContextError<&'a [u8]>,
        Deser: Deserializer<Self>,
        ID: Id,
    >(
        content_serializer: Option<&dyn Serializer<Self>>,
        signature_deserializer: &SignatureDeserializer,
        creator_public_key_deserializer: &PublicKeyDeserializer,
        content_deserializer: &Deser,
        buffer: &'a [u8],
        chain_id: u64,
    ) -> IResult<&'a [u8], SecureShare<Self, ID>, E> {
        let (serialized_data, (signature, creator_public_key)) = context(
            "Failed SecureShare deserialization",
            tuple((
                context("Failed signature deserialization", |input| {
                    signature_deserializer.deserialize(input)
                }),
                context("Failed public_key deserialization", |input| {
                    creator_public_key_deserializer.deserialize(input)
                }),
            )),
        )(buffer)?;
        let (rest, content) = content_deserializer.deserialize(serialized_data)?;
        let content_serialized = if let Some(content_serializer) = content_serializer {
            let mut content_buffer = Vec::new();
            content_serializer
                .serialize(&content, &mut content_buffer)
                .map_err(|_| {
                    nom::Err::Error(ParseError::from_error_kind(
                        rest,
                        nom::error::ErrorKind::Fail,
                    ))
                })?;
            content_buffer
        } else {
            // Avoid getting the rest of the data in the serialized data
            serialized_data[..serialized_data.len() - rest.len()].to_vec()
        };
        let creator_address = Address::from_public_key(&creator_public_key);
        let hash = Self::compute_hash(&content, &content_serialized, &creator_public_key, chain_id);

        Ok((
            rest,
            SecureShare {
                content,
                signature,
                content_creator_pub_key: creator_public_key,
                content_creator_address: creator_address,
                serialized_data: content_serialized.to_vec(),
                id: ID::new(hash),
            },
        ))
    }
}

impl<T, ID> Display for SecureShare<T, ID>
where
    T: Display + SecureShareContent,
    ID: Id,
{
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        writeln!(f, "Signature: {}", self.signature)?;
        writeln!(f, "Creator pubkey: {}", self.content_creator_pub_key)?;
        writeln!(f, "Creator address: {}", self.content_creator_address)?;
        writeln!(f, "Id: {}", self.id.get_hash())?;
        writeln!(f, "{}", self.content)?;
        Ok(())
    }
}

impl<T, ID> SecureShare<T, ID>
where
    T: Display + SecureShareContent,
    ID: Id,
{
    /// Sign the SecureShare given the content
    pub fn sign(
        keypair: &KeyPair,
        content_hash: &Hash,
        _content: &T,
    ) -> Result<Signature, ModelsError> {
        Ok(keypair.sign(content_hash)?)
    }

    /// check if self has been signed by public key
    pub fn verify_signature(&self) -> Result<(), ModelsError> {
        self.content.verify_signature(
            &self.content_creator_pub_key,
            self.id.get_hash(),
            &self.signature,
        )
    }

    /// Compute the signed hash
    pub fn compute_signed_hash(&self) -> Hash {
        self.content
            .compute_signed_hash(&self.content_creator_pub_key, self.id.get_hash())
    }

    /// get full serialized size
    pub fn serialized_size(&self) -> usize {
        self.serialized_data
            .len()
            .saturating_add(self.signature.get_ser_len())
            .saturating_add(self.content_creator_pub_key.get_ser_len())
    }
}

// NOTE FOR EXPLICATION: No content serializer because serialized data is already here.
/// Serializer for `SecureShare` structure
#[derive(Default, Clone)]
pub struct SecureShareSerializer;

impl SecureShareSerializer {
    /// Creates a new `SecureShareSerializer`
    pub const fn new() -> Self {
        Self
    }

    /// This method is used to serialize a `SecureShare` structure and use a custom serializer instead of
    /// using the serialized form of the content stored in `serialized_data`.
    /// This is useful when the content need to be serialized in a lighter form in specific cases.
    ///
    /// # Arguments:
    /// * `content_serializer`: Custom serializer to be used instead of the data in `serialized_data`
    /// * `value`: SecureShare structure to be serialized
    /// * `buffer`: buffer of serialized data to be extend
    pub fn serialize_with<Ser, T, ID>(
        &self,
        content_serializer: &Ser,
        value: &SecureShare<T, ID>,
        buffer: &mut Vec<u8>,
    ) -> Result<(), SerializeError>
    where
        Ser: Serializer<T>,
        T: Display + SecureShareContent,
        ID: Id,
    {
        let mut content_buffer = Vec::new();
        content_serializer.serialize(&value.content, &mut content_buffer)?;
        T::serialize(
            &value.signature,
            &value.content_creator_pub_key,
            &content_buffer,
            buffer,
        )
    }
}

impl<T, ID> Serializer<SecureShare<T, ID>> for SecureShareSerializer
where
    T: Display + SecureShareContent,
    ID: Id,
{
    fn serialize(
        &self,
        value: &SecureShare<T, ID>,
        buffer: &mut Vec<u8>,
    ) -> Result<(), SerializeError> {
        T::serialize(
            &value.signature,
            &value.content_creator_pub_key,
            &value.serialized_data,
            buffer,
        )
    }
}

/// Deserializer for SecureShare structure
pub struct SecureShareDeserializer<T, Deser>
where
    T: Display + SecureShareContent,
    Deser: Deserializer<T>,
{
    signature_deserializer: SignatureDeserializer,
    public_key_deserializer: PublicKeyDeserializer,
    content_deserializer: Deser,
    chain_id: u64,
    marker_t: std::marker::PhantomData<T>,
}

impl<T, Deser> SecureShareDeserializer<T, Deser>
where
    T: Display + SecureShareContent,
    Deser: Deserializer<T>,
{
    /// Creates a new `SecureShareDeserializer`
    ///
    /// # Arguments
    /// * `content_deserializer` - Deserializer for the content
    pub const fn new(content_deserializer: Deser, chain_id: u64) -> Self {
        Self {
            signature_deserializer: SignatureDeserializer::new(),
            public_key_deserializer: PublicKeyDeserializer::new(),
            content_deserializer,
            chain_id,
            marker_t: std::marker::PhantomData,
        }
    }

    /// This method is used to deserialize data that has been serialized in a lightweight form.
    /// The buffer doesn't have the whole content serialized and so
    /// this serialized data isn't coherent with the full structure and can't be used to calculate id and signature.
    /// We pass a serializer to serialize the full structure and retrieve a coherent `serialized_data`
    /// that can be use for the id and signature computing.
    ///
    /// # Arguments:
    /// * `content_serializer`: Serializer use to compute the `serialized_data` from the content
    /// * `buffer`: buffer of serialized data to be deserialized
    ///
    /// # Returns:
    /// A rest (data left over from deserialization), an instance of `T`, and the data enabling signature verification
    pub fn deserialize_with<
        'a,
        E: ParseError<&'a [u8]> + ContextError<&'a [u8]>,
        ID: Id,
        Ser: Serializer<T>,
    >(
        &self,
        content_serializer: &Ser,
        buffer: &'a [u8],
    ) -> IResult<&'a [u8], SecureShare<T, ID>, E> {
        T::deserialize(
            Some(content_serializer),
            &self.signature_deserializer,
            &self.public_key_deserializer,
            &self.content_deserializer,
            buffer,
            self.chain_id,
        )
    }
}

impl<T, ID, Deser> Deserializer<SecureShare<T, ID>> for SecureShareDeserializer<T, Deser>
where
    T: Display + SecureShareContent,
    ID: Id,
    Deser: Deserializer<T>,
{
    /// ```
    /// # use massa_models::{endorsement::{Endorsement, EndorsementSerializer, EndorsementDeserializer}, slot::Slot, secure_share::{SecureShare, SecureShareSerializer, SecureShareDeserializer, SecureShareContent}};
    /// use massa_models::block_id::BlockId;
    /// # use massa_serialization::{Deserializer, Serializer, DeserializeError, U16VarIntSerializer, U16VarIntDeserializer};
    /// # use massa_signature::KeyPair;
    /// # use std::ops::Bound::Included;
    /// # use massa_hash::Hash;
    /// use massa_models::config::CHAINID;
    ///
    /// let content = Endorsement {
    ///    slot: Slot::new(10, 1),
    ///    index: 0,
    ///    endorsed_block: BlockId::generate_from_hash(Hash::compute_from("blk".as_bytes())),
    /// };
    /// let keypair = KeyPair::generate(0).unwrap();
    /// let secured: SecureShare<Endorsement, BlockId> = Endorsement::new_verifiable(
    ///    content,
    ///    EndorsementSerializer::new(),
    ///    &keypair,
    ///    *CHAINID
    /// ).unwrap();
    /// let mut serialized_data = Vec::new();
    /// let serialized = SecureShareSerializer::new().serialize(&secured, &mut serialized_data).unwrap();
    /// let deserializer = SecureShareDeserializer::new(EndorsementDeserializer::new(32, 1), 77);
    /// let (rest, deserialized): (&[u8], SecureShare<Endorsement, BlockId>) = deserializer.deserialize::<DeserializeError>(&serialized_data).unwrap();
    /// assert!(rest.is_empty());
    /// assert_eq!(secured.id, deserialized.id);
    /// ```
    fn deserialize<'a, E: ParseError<&'a [u8]> + ContextError<&'a [u8]>>(
        &self,
        buffer: &'a [u8],
    ) -> IResult<&'a [u8], SecureShare<T, ID>, E> {
        T::deserialize(
            None,
            &self.signature_deserializer,
            &self.public_key_deserializer,
            &self.content_deserializer,
            buffer,
            self.chain_id,
        )
    }
}