Struct XKey

pub struct XKey { /* private fields */ }

The main interface used for reading and writing nkey-encoded curve key pairs.

Implementations

impl XKey

pub fn new() -> Self

Creates a new xkey.

NOTE: This is not available if using on a wasm32-unknown-unknown target due to the lack of rand support. Use new_from_raw instead

pub fn new_with_rand(rand: &mut (impl CryptoRng + RngCore)) -> Self

Create a new xkey pair from a random generator

NOTE: These generator should be a cryptographically secure random source.

NOTE: This is not available if using on a wasm32-unknown-unknown target due to the lack of rand support. Use new_from_raw instead

pub fn new_from_raw(random_bytes: [u8; 32]) -> Self

Create a new xkey pair using a pre-existing set of random bytes.

NOTE: These bytes should be generated from a cryptographically secure random source.

pub fn from_public_key(source: &str) -> Result<Self, Error>

Attempts to produce a public-only xkey from the given encoded public key string

pub fn from_seed(source: &str) -> Result<Self, Error>

Attempts to produce a full xkey pair from the given encoded seed string

pub fn seed(&self) -> Result<String, Error>

Attempts to return the encoded, human-readable string for this key pair’s seed. Remember that this value should be treated as a secret. Do not store it for any longer than necessary

pub fn public_key(&self) -> String

Returns the encoded, human-readable public key of this key pair

pub fn private_key(&self) -> Result<String, Error>

pub fn key_pair_type(&self) -> KeyPairType

Returns the type of this key pair.

pub fn open(&self, input: &[u8], sender: &Self) -> Result<Vec<u8>, Error>

pub fn seal(&self, input: &[u8], recipient: &Self) -> Result<Vec<u8>, Error>

Seal is compatible with nacl.Box.Seal() and can be used in similar situations for small messages. We generate the nonce from crypto rand by default.

NOTE: This is not available if using on a wasm32-unknown-unknown target due to the lack of rand support. Use seal_with_nonce instead

pub fn seal_with_rand( &self, input: &[u8], recipient: &Self, rand: impl CryptoRng + RngCore, ) -> Result<Vec<u8>, Error>

NOTE: This is not available if using on a wasm32-unknown-unknown target due to the lack of rand support. Use seal_with_nonce instead

pub fn seal_with_nonce( &self, input: &[u8], recipient: &Self, nonce: Nonce, ) -> Result<Vec<u8>, Error>

NOTE: Nonce bytes should be generated from a cryptographically secure random source, and only be used once.

Trait Implementations

impl Clone for XKey

fn clone(&self) -> XKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for XKey

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

Formats the value using the given formatter.

impl Default for XKey

fn default() -> Self

Returns the “default value” for a type.