Skip to main content

KeyCheckValue

Struct KeyCheckValue 

Source
pub struct KeyCheckValue(/* private fields */);
Expand description

What a symmetric key answers to, in place of a public key.

AES-CMAC over a 16-byte zero block under the key, leftmost three bytes, as specified for AES keys in ANSI X9.24-1 Annex A and used by TR-31. It is what an HSM displays and what custodians read back, so a transcript carrying it records the value the room checked rather than a parallel one only Rite can compute.

Three bytes, not a digest of the key. A full-length hash of a secret is what rite#126 removed from the transcript, and a reader cannot tell by looking whether such a value came from a 256-bit key or a 4-digit PIN. The truncation here is the part that makes it evident.

Renders as cmac-aes:763cbc. The method is in the string because the older convention of encrypting a zero block in ECB is still in use and gives a different answer for the same key.

use rite_sdk::KeyCheckValue;

// A backend computes the CMAC; this keeps the leftmost bytes of it.
let cmac = [0x76, 0x3c, 0xbc, 0xde, 0x81, 0xdf, 0x91, 0x31];
let kcv = KeyCheckValue::from_cmac(&cmac)?;

assert_eq!(kcv.to_string(), "cmac-aes:763cbc");
assert_eq!(kcv.as_bytes(), &[0x76, 0x3c, 0xbc]);

// It round-trips through the string a transcript records.
assert_eq!("cmac-aes:763cbc".parse::<KeyCheckValue>()?, kcv);
// Uppercase hex is a different string for the same bytes, so it is not one.
assert!("cmac-aes:763CBC".parse::<KeyCheckValue>().is_err());

Implementations§

Source§

impl KeyCheckValue

Source

pub const LEN: usize = 3

Bytes kept from the CMAC output.

Source

pub const METHOD: &'static str = "cmac-aes"

The name this construction goes by, and the string’s prefix.

Source

pub fn from_cmac(cmac: &[u8]) -> Result<Self, ParseError>

Keep the leftmost bytes of a CMAC output.

§Errors

If cmac is shorter than Self::LEN, which no AES-CMAC is.

Source

pub fn as_bytes(&self) -> &[u8; 3]

The kept bytes.

Trait Implementations§

Source§

impl Clone for KeyCheckValue

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for KeyCheckValue

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for KeyCheckValue

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for KeyCheckValue

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Eq for KeyCheckValue

Source§

impl From<KeyCheckValue> for String

Source§

fn from(kcv: KeyCheckValue) -> String

Converts to this type from the input type.
Source§

impl FromStr for KeyCheckValue

Source§

type Err = ParseError

The associated error which can be returned from parsing.
Source§

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type. Read more
Source§

impl PartialEq for KeyCheckValue

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for KeyCheckValue

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for KeyCheckValue

Source§

impl TryFrom<String> for KeyCheckValue

Source§

type Error = ParseError

The type returned in the event of a conversion error.
Source§

fn try_from(s: String) -> Result<Self, Self::Error>

Performs the conversion.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.