Struct IdentityKey 

pub struct IdentityKey<CS: CipherSuite> { /* private fields */ }

The Device Identity Key.

Implementations

impl<CS: CipherSuite> IdentityKey<CS>

pub fn new<R: Csprng>(rng: &mut R) -> Self

Creates a random IdentityKey

impl<CS: CipherSuite> IdentityKey<CS>

pub fn id(&self) -> Result<DeviceId, IdError>

Uniquely identifies the IdentityKey Two keys with the same ID are the same key.

pub fn public(&self) -> Result<IdentityVerifyingKey<CS>, PkError>

Returns the public half of the key.

impl<CS: CipherSuite> IdentityKey<CS>

pub fn sign(&self, msg: &[u8], context: &[u8]) -> Result<Signature<CS>, Error>

Creates a signature over msg bound to some context.

msg must NOT be pre-hashed.

Example

use aranya_crypto::{
    IdentityKey, Rng,
    default::{DefaultCipherSuite, DefaultEngine},
};

let sk = IdentityKey::<DefaultCipherSuite>::new(&mut Rng);

const MESSAGE: &[u8] = b"hello, world!";
const CONTEXT: &[u8] = b"doc test";
let sig = sk.sign(MESSAGE, CONTEXT).expect("should not fail");

sk.public()
    .expect("identity key should be valid")
    .verify(MESSAGE, CONTEXT, &sig)
    .expect("should not fail");

sk.public()
    .expect("identity key should be valid")
    .verify(MESSAGE, b"wrong context", &sig)
    .expect_err("should fail");

let wrong_sig = sk
    .sign(b"different", b"signature")
    .expect("should not fail");
sk.public()
    .expect("identity key should be valid")
    .verify(MESSAGE, CONTEXT, &wrong_sig)
    .expect_err("should fail");

Trait Implementations

impl<CS: CipherSuite> Clone for IdentityKey<CS>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<CS: CipherSuite> ConstantTimeEq for IdentityKey<CS>

fn ct_eq(&self, other: &Self) -> Choice

Determine if two items are equal.

fn ct_ne(&self, other: &Self) -> Choice

Determine if two items are NOT equal.

impl<CS: CipherSuite> Debug for IdentityKey<CS>

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

Formats the value using the given formatter.

impl<CS: CipherSuite> Display for IdentityKey<CS>

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

Formats the value using the given formatter.

impl<CS: CipherSuite> Identified for IdentityKey<CS>

type Id = Id<DeviceIdTag>

Uniquely identifies the object.

fn id(&self) -> Result<Self::Id, IdError>

Uniquely identifies the object.

impl<CS: CipherSuite> UnwrappedKey<CS> for IdentityKey<CS>

const ID: AlgId

The key’s algorithm identifier.

fn into_secret(self) -> Secret<CS>

Converts itself into the underlying Secret.

fn try_from_secret(key: UnwrappedSecret<CS>) -> Result<Self, WrongKeyType>

Converts itself from a UnwrappedSecret.

impl<CS: CipherSuite> ZeroizeOnDrop for IdentityKey<CS>