Struct olm_rs::pk::OlmPkSigning

pub struct OlmPkSigning { /* fields omitted */ }

Signs messages using public key cryptography.

Implementations

impl OlmPkSigning

pub fn new(seed: &[u8]) -> Result<Self, OlmPkSigningError>

Create a new signing object.

Arguments

• seed - the seed to use as the private key for signing. The seed must have the same length as the seeds generated by OlmPkSigning::generate_seed(). The correct length can be checked using OlmPkSigning::seed_length() as well.

pub fn seed_length() -> usize

Get the required seed length.

pub fn generate_seed() -> Vec<u8>

Generate a random seed that can be used to initialize a OlmPkSigning object.

pub fn public_key(&self) -> &str

Get the public key of the the OlmPkSigning object.

This can be used to check the signature of a messsage that has been signed by this object.

Example

let message = "It's a secret to everyone".to_string();

let sign = OlmPkSigning::new(&OlmPkSigning::generate_seed()).unwrap();
let utility = OlmUtility::new();

let signature = sign.sign(&message);

utility.ed25519_verify(sign.public_key(), &message, signature).unwrap();

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

Sign a message using this object.

Arguments

• message - The message that should be signed with the private key of this object.

Panics

• OUTPUT_BUFFER_TOO_SMALL for the signature buffer that is provided to libolm.
• on malformed UTF-8 coding of the signature provided by libolm.

Trait Implementations

impl Drop for OlmPkSigning

fn drop(&mut self)

Executes the destructor for this type.

impl Send for OlmPkSigning