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
use anyhow::{bail, Context, Result};
use hotshot_types::traits::signature_key::SignatureKey;
use libp2p::kad::Record;
use serde::{Deserialize, Serialize};
use tracing::warn;
/// A (signed or unsigned) record value to be stored (serialized) in the DHT.
/// This is a wrapper around a value that includes a possible signature.
#[derive(Serialize, Deserialize, Clone, PartialEq, Eq, Debug)]
pub enum RecordValue<K: SignatureKey + 'static> {
/// A signed record value
Signed(Vec<u8>, K::PureAssembledSignatureType),
/// An unsigned record value
Unsigned(Vec<u8>),
}
/// The namespace of a record. This is included with the key
/// and allows for multiple types of records to be stored in the DHT.
#[repr(u8)]
#[derive(Serialize, Deserialize, Clone, Copy, Eq, PartialEq)]
pub enum Namespace {
/// A namespace for looking up P2P identities
Lookup = 0,
/// An authenticated namespace useful for testing
#[cfg(test)]
Testing = 254,
/// An unauthenticated namespace useful for testing
#[cfg(test)]
TestingUnauthenticated = 255,
}
/// Require certain namespaces to be authenticated
fn requires_authentication(namespace: Namespace) -> bool {
match namespace {
Namespace::Lookup => true,
#[cfg(test)]
Namespace::Testing => true,
#[cfg(test)]
Namespace::TestingUnauthenticated => false,
}
}
/// Allow fallible conversion from a byte to a namespace
impl TryFrom<u8> for Namespace {
type Error = anyhow::Error;
fn try_from(value: u8) -> Result<Self> {
match value {
0 => Ok(Self::Lookup),
#[cfg(test)]
254 => Ok(Self::Testing),
#[cfg(test)]
255 => Ok(Self::TestingUnauthenticated),
_ => bail!("Unknown namespace"),
}
}
}
/// A record's key. This is a concatenation of the namespace and the key.
#[derive(Clone)]
pub struct RecordKey {
/// The namespace of the record key
pub namespace: Namespace,
/// The actual key
pub key: Vec<u8>,
}
impl RecordKey {
#[must_use]
/// Create and return a new record key in the given namespace
pub fn new(namespace: Namespace, key: Vec<u8>) -> Self {
Self { namespace, key }
}
/// Convert the record key to a byte vector
#[must_use]
pub fn to_bytes(&self) -> Vec<u8> {
// Concatenate the namespace and the key
let mut bytes = vec![self.namespace as u8];
bytes.extend_from_slice(&self.key);
bytes
}
/// Try to convert a byte vector to a record key
///
/// # Errors
/// If the provided array is empty
pub fn try_from_bytes(bytes: &[u8]) -> Result<Self> {
// Check if the bytes are empty
if bytes.is_empty() {
bail!("Empty record key bytes")
}
// The first byte is the namespace
let namespace = Namespace::try_from(bytes[0])?;
// Return the record key
Ok(Self {
namespace,
key: bytes[1..].to_vec(),
})
}
}
impl<K: SignatureKey + 'static> RecordValue<K> {
/// Creates and returns a new signed record by signing the key and value
/// with the private key
///
/// # Errors
/// - If we fail to sign the value
/// - If we fail to serialize the signature
pub fn new_signed(
record_key: &RecordKey,
value: Vec<u8>,
private_key: &K::PrivateKey,
) -> Result<Self> {
// The value to sign should be the record key concatenated with the value
let mut value_to_sign = record_key.to_bytes();
value_to_sign.extend_from_slice(&value);
let signature =
K::sign(private_key, &value_to_sign).with_context(|| "Failed to sign record")?;
// Return the signed record
Ok(Self::Signed(value, signature))
}
/// Creates and returns a new unsigned record
#[must_use]
pub fn new(value: Vec<u8>) -> Self {
Self::Unsigned(value)
}
/// If the message requires authentication, validate the record by verifying the signature with the
/// given key
pub fn validate(&self, record_key: &RecordKey) -> bool {
// If the record requires authentication, validate the signature
if !requires_authentication(record_key.namespace) {
return true;
}
// The record must be signed
let Self::Signed(value, signature) = self else {
warn!("Record should be signed but is not");
return false;
};
// If the request is "signed", the public key is the record's key
let Ok(public_key) = K::from_bytes(record_key.key.as_slice()) else {
warn!("Failed to deserialize signer's public key");
return false;
};
// The value to sign should be the record key concatenated with the value
let mut signed_value = record_key.to_bytes();
signed_value.extend_from_slice(value);
// Validate the signature
public_key.validate(signature, &signed_value)
}
/// Get the underlying value of the record
pub fn value(&self) -> &[u8] {
match self {
Self::Unsigned(value) | Self::Signed(value, _) => value,
}
}
}
impl<K: SignatureKey + 'static> TryFrom<Record> for RecordValue<K> {
type Error = anyhow::Error;
fn try_from(record: Record) -> Result<Self> {
// Deserialize the record value
let record: RecordValue<K> = bincode::deserialize(&record.value)
.with_context(|| "Failed to deserialize record value")?;
// Return the record
Ok(record)
}
}
#[cfg(test)]
mod test {
use hotshot_types::signature_key::BLSPubKey;
use super::*;
/// Test that namespace serialization and deserialization is consistent
#[test]
fn test_namespace_serialization_parity() {
// Serialize the namespace
let namespace = Namespace::Lookup;
let bytes = namespace as u8;
// Deserialize the namespace
let namespace = Namespace::try_from(bytes).expect("Failed to deserialize namespace");
assert!(namespace == Namespace::Lookup, "Wrong namespace");
}
/// Test that record key serialization and deserialization is consistent
#[test]
fn test_record_key_serialization_parity() {
// Create a new record key
let namespace = Namespace::Lookup;
let key = vec![1, 2, 3, 4];
let record_key = RecordKey::new(namespace, key.clone());
// Serialize it
let bytes = record_key.to_bytes();
// Deserialize it
let record_key =
RecordKey::try_from_bytes(&bytes).expect("Failed to deserialize record key");
// Make sure the deserialized record key is the same as the original
assert!(record_key.namespace == namespace, "Namespace mismatch");
assert!(record_key.key == key, "Key mismatch");
}
/// Test that the validity of a valid, signed record is correct
#[test]
fn test_valid_signature() {
// Generate a staking keypair
let (public_key, private_key) = BLSPubKey::generated_from_seed_indexed([1; 32], 1337);
// Create a value. The key is the public key
let value = vec![5, 6, 7, 8];
// Create a record key (as we need to sign both the key and the value)
let record_key = RecordKey::new(Namespace::Lookup, public_key.to_bytes());
// Sign the record and value with the private key
let record_value: RecordValue<BLSPubKey> =
RecordValue::new_signed(&record_key, value.clone(), &private_key).unwrap();
// Validate the signed record
assert!(
record_value.validate(&record_key),
"Failed to validate signed record"
);
}
/// Test that altering the namespace byte causes a validation failure
#[test]
fn test_invalid_namespace() {
// Generate a staking keypair
let (public_key, private_key) = BLSPubKey::generated_from_seed_indexed([1; 32], 1337);
// Create a value. The key is the public key
let value = vec![5, 6, 7, 8];
// Create a record key (as we need to sign both the key and the value)
let mut record_key = RecordKey::new(Namespace::Lookup, public_key.to_bytes());
// Sign the record and value with the private key
let record_value: RecordValue<BLSPubKey> =
RecordValue::new_signed(&record_key, value.clone(), &private_key).unwrap();
// Alter the namespace
record_key.namespace = Namespace::Testing;
// Validate the signed record
assert!(
!record_value.validate(&record_key),
"Failed to detect invalid namespace"
);
}
/// Test that altering the contents of the record key causes a validation failure
#[test]
fn test_invalid_key() {
// Generate a staking keypair
let (public_key, private_key) = BLSPubKey::generated_from_seed_indexed([1; 32], 1337);
// Create a value. The key is the public key
let value = vec![5, 6, 7, 8];
// Create a record key (as we need to sign both the key and the value)
let mut record_key = RecordKey::new(Namespace::Lookup, public_key.to_bytes());
// Sign the record and value with the private key
let record_value: RecordValue<BLSPubKey> =
RecordValue::new_signed(&record_key, value.clone(), &private_key).unwrap();
// Set the key to a different one
record_key.key = BLSPubKey::generated_from_seed_indexed([1; 32], 1338)
.0
.to_bytes();
// Validate the signed record
assert!(
!record_value.validate(&record_key),
"Failed to detect invalid record key"
);
}
/// Test that unsigned records are always valid
#[test]
fn test_unsigned_record_is_valid() {
// Create a value
let value = vec![5, 6, 7, 8];
// Create a record key
let record_key = RecordKey::new(Namespace::TestingUnauthenticated, vec![1, 2, 3, 4]);
// Create an unsigned record
let record_value: RecordValue<BLSPubKey> = RecordValue::new(value.clone());
// Validate the unsigned record
assert!(
record_value.validate(&record_key),
"Failed to validate unsigned record"
);
}
/// Test that unauthenticated namespaces do not require validation for unsigned records
#[test]
fn test_unauthenticated_namespace() {
// Generate a staking keypair
let (public_key, _) = BLSPubKey::generated_from_seed_indexed([1; 32], 1337);
// Create a record key (as we need to sign both the key and the value)
let record_key = RecordKey::new(Namespace::TestingUnauthenticated, public_key.to_bytes());
// Created an unsigned record
let record_value: RecordValue<BLSPubKey> = RecordValue::new(vec![5, 6, 7, 8]);
// Validate it
assert!(
record_value.validate(&record_key),
"Failed to validate unsigned record in unauthenticated namespace"
);
}
/// Test that authenticated namespaces do require validation for unsigned records
#[test]
fn test_authenticated_namespace() {
// Generate a staking keypair
let (public_key, _) = BLSPubKey::generated_from_seed_indexed([1; 32], 1337);
// Create a record key (as we need to sign both the key and the value)
let record_key = RecordKey::new(Namespace::Lookup, public_key.to_bytes());
// Created an unsigned record
let record_value: RecordValue<BLSPubKey> = RecordValue::new(vec![5, 6, 7, 8]);
// Validate it
assert!(
!record_value.validate(&record_key),
"Failed to detect invalid unsigned record"
);
}
}