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
// Copyright (C) 2019-2021 Aleo Systems Inc.
// This file is part of the snarkVM library.
// The snarkVM library is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// The snarkVM library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
// You should have received a copy of the GNU General Public License
// along with the snarkVM library. If not, see <https://www.gnu.org/licenses/>.
use crate::{Bech32Locator, DecryptionKey, Network, RecordError, ViewKey};
use snarkvm_algorithms::traits::{EncryptionScheme, CRH};
use snarkvm_utilities::{
io::{Cursor, Result as IoResult},
to_bytes_le,
FromBytes,
Read,
ToBytes,
Write,
};
use anyhow::{anyhow, Result};
#[derive(Derivative)]
#[derivative(
Clone(bound = "N: Network"),
Debug(bound = "N: Network"),
PartialEq(bound = "N: Network"),
Eq(bound = "N: Network"),
Hash(bound = "N: Network")
)]
pub struct Ciphertext<N: Network> {
commitment: N::Commitment,
randomizer: N::RecordRandomizer,
record_view_key_commitment: N::RecordViewKeyCommitment,
record_bytes: Vec<u8>,
}
impl<N: Network> Ciphertext<N> {
/// Returns the record ciphertext object.
pub fn from(
randomizer: N::RecordRandomizer,
record_view_key_commitment: N::RecordViewKeyCommitment,
record_bytes: Vec<u8>,
) -> Result<Self, RecordError> {
// Compute the commitment.
let commitment = N::commitment_scheme()
.hash(&to_bytes_le![randomizer, record_view_key_commitment, record_bytes]?)?
.into();
Ok(Self {
commitment,
randomizer,
record_view_key_commitment,
record_bytes,
})
}
/// Returns `true` if this ciphertext belongs to the given account view key.
pub fn is_owner(&self, account_view_key: &ViewKey<N>) -> bool {
// Compute the record view key.
let candidate_record_view_key =
match N::account_encryption_scheme().generate_symmetric_key(account_view_key, *self.randomizer) {
Some(symmetric_key) => symmetric_key,
None => return false,
};
// Compute the record view key commitment.
let candidate_record_view_key_commitment =
N::account_encryption_scheme().generate_symmetric_key_commitment(&candidate_record_view_key);
// Check if the computed record view key commitment matches.
*self.record_view_key_commitment == candidate_record_view_key_commitment
}
/// Returns the record commitment.
pub fn commitment(&self) -> N::Commitment {
self.commitment
}
/// Returns the ciphertext randomizer.
pub fn randomizer(&self) -> N::RecordRandomizer {
self.randomizer
}
/// Returns the record view key commitment.
pub fn record_view_key_commitment(&self) -> &N::RecordViewKeyCommitment {
&self.record_view_key_commitment
}
/// Returns the plaintext and record view key corresponding to the record ciphertext.
pub fn to_plaintext(&self, decryption_key: &DecryptionKey<N>) -> Result<(Vec<u8>, N::RecordViewKey)> {
let record_view_key = match decryption_key {
DecryptionKey::AccountViewKey(account_view_key) => {
// Compute the candidate record view key.
match N::account_encryption_scheme().generate_symmetric_key(account_view_key, *self.randomizer) {
Some(candidate_record_view_key) => candidate_record_view_key.into(),
None => {
return Err(anyhow!(
"The given account view key does not correspond to this ciphertext"
));
}
}
}
DecryptionKey::RecordViewKey(record_view_key) => record_view_key.clone(),
};
// Compute the record view key commitment.
let candidate_record_view_key_commitment =
N::account_encryption_scheme().generate_symmetric_key_commitment(&record_view_key);
// Check if the computed record view key commitment matches.
match *self.record_view_key_commitment == candidate_record_view_key_commitment {
// Decrypt the record ciphertext.
true => {
let plaintext = N::account_encryption_scheme().decrypt(&record_view_key, &self.record_bytes)?;
Ok((plaintext, record_view_key))
}
false => Err(anyhow!(
"The given record view key does not correspond to this ciphertext"
)),
}
}
}
impl<N: Network> FromBytes for Ciphertext<N> {
/// Decode the ciphertext into the ciphertext randomizer, record view key commitment, and record ciphertext.
#[inline]
fn read_le<R: Read>(mut reader: R) -> IoResult<Self> {
let mut ciphertext = vec![0u8; N::RECORD_CIPHERTEXT_SIZE_IN_BYTES];
reader.read_exact(&mut ciphertext)?;
// Decode the ciphertext bytes.
let mut cursor = Cursor::new(ciphertext);
let ciphertext_randomizer = N::RecordRandomizer::read_le(&mut cursor)?;
let record_view_key_commitment = N::RecordViewKeyCommitment::read_le(&mut cursor)?;
let mut record_bytes = vec![
0u8;
N::RECORD_CIPHERTEXT_SIZE_IN_BYTES
- N::RecordRandomizer::data_size_in_bytes()
- N::RecordViewKeyCommitment::data_size_in_bytes()
];
cursor.read_exact(&mut record_bytes)?;
Ok(Self::from(
ciphertext_randomizer,
record_view_key_commitment,
record_bytes,
)?)
}
}
impl<N: Network> ToBytes for Ciphertext<N> {
#[inline]
fn write_le<W: Write>(&self, mut writer: W) -> IoResult<()> {
self.randomizer.write_le(&mut writer)?;
self.record_view_key_commitment.write_le(&mut writer)?;
self.record_bytes.write_le(&mut writer)
}
}
// #[cfg(test)]
// mod tests {
// use super::*;
// use crate::testnet2::Testnet2;
// use snarkvm_utilities::UniformRand;
//
// use rand::thread_rng;
//
// #[test]
// fn test_serde_json() {
// let rng = &mut thread_rng();
//
// let expected_ciphertext = RecordCiphertext::<Testnet2>::from(
// (0..Testnet2::RECORD_CIPHERTEXT_SIZE_IN_BYTES)
// .map(|_| u8::rand(rng))
// .collect::<Vec<u8>>(),
// );
//
// // Serialize
// let expected_string = &expected_ciphertext.to_string();
// let candidate_string = serde_json::to_string(&expected_ciphertext).unwrap();
// assert_eq!(
// expected_string,
// serde_json::Value::from_str(&candidate_string)
// .unwrap()
// .as_str()
// .unwrap()
// );
//
// // Deserialize
// assert_eq!(
// expected_ciphertext,
// RecordCiphertext::from_str(&expected_string).unwrap()
// );
// assert_eq!(expected_ciphertext, serde_json::from_str(&candidate_string).unwrap());
// }
//
// #[test]
// fn test_bincode() {
// let rng = &mut thread_rng();
//
// let expected_ciphertext = RecordCiphertext::<Testnet2>::from_vec(
// (0..Testnet2::RECORD_CIPHERTEXT_SIZE_IN_BYTES)
// .map(|_| u8::rand(rng))
// .collect::<Vec<u8>>(),
// );
//
// // Serialize
// let expected_bytes = expected_ciphertext.to_bytes_le().unwrap();
// assert_eq!(
// &expected_bytes[..],
// &bincode::serialize(&expected_ciphertext).unwrap()[..]
// );
//
// // Deserialize
// assert_eq!(
// expected_ciphertext,
// RecordCiphertext::read_le(&expected_bytes[..]).unwrap()
// );
// assert_eq!(expected_ciphertext, bincode::deserialize(&expected_bytes[..]).unwrap());
// }
// }