Struct selenite::crypto::SphincsKeypair

pub struct SphincsKeypair {
    pub algorithm: String,
    pub public_key: String,
    pub private_key: String,
}

SPHINCS+ (SHAKE256) Keypair

When using this keypair or looking at its documentation, please look at its implemented trait Keypairs for its methods.

use selenite::crypto::*;
 
fn main() {
    // Generates The Respected Keypair
    let keypair = SphincsKeypair::new();
 
    // Signs The Message as a UTF-8 Encoded String
    let mut sig = keypair.sign("message_to_sign");
     
    // Returns a boolean representing whether the signature is valid or not
    let is_verified = sig.verify();
}

Fields

algorithm: String

public_key: String

private_key: String

Trait Implementations

impl Clone for SphincsKeypair

fn clone(&self) -> SphincsKeypair

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SphincsKeypair

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

Formats the value using the given formatter.

impl Default for SphincsKeypair

fn default() -> SphincsKeypair

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for SphincsKeypair

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

Deserialize this value from the given Serde deserializer.

impl Hash for SphincsKeypair

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Keypairs for SphincsKeypair

const VERSION: &'static str

Version Returns The Version

const ALGORITHM: &'static str

Algorithm Shows the Algorithm For The Keypair Being Used

const PUBLIC_KEY_SIZE: usize

const SECRET_KEY_SIZE: usize

const SIGNATURE_SIZE: usize

fn new() -> Self

Generate A New Keypair Creates A New Keypair From Respected Struct Being Called.

fn export(&self) -> String

Serializes To YAML This will serialize the contents of the keypair to YAML Format, which can be read with the import function.

fn import(yaml: &str) -> Self

Construct Keypair From YAML This function will deserialize the keypair into its respected struct.

fn as_bytes(&self) -> (Vec<u8>, Vec<u8>)

Deprecated

Return As Bytes

fn public_key_as_bytes(&self) -> Vec<u8>

fn secret_key_as_bytes(&self) -> Vec<u8>

fn sign(&self, message: &str) -> Signature

Keypair Signing Allows Signing of an Input Using The Keyholder's Secret Key and Returns The Struct Signature.

impl PartialEq<SphincsKeypair> for SphincsKeypair

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<SphincsKeypair> for SphincsKeypair

fn partial_cmp(&self, other: &SphincsKeypair) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &SphincsKeypair) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &SphincsKeypair) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &SphincsKeypair) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &SphincsKeypair) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for SphincsKeypair

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SphincsKeypair