Struct Key

Source

pub struct Key {
    pub fingerprint: String,
    pub name: String,
    pub mail: String,
    pub password: Option<String>,
}

Expand description

A struct representing a public key.

Fields§

§fingerprint: String

The fingerprint of the key.

§name: String

The name associated with the key.

§mail: String

The email address associated with the key.

§password: Option<String>

The password the key is protected with

Implementations§

Source §

impl Key

Source

pub fn new( name: &str, mail: &str, password: Option<&str>, gpg: &GnuPG, ) -> Result<Self, GPGError>

Creates a new GPG key with the given name and email address.

§Parameters

name: the name of the key
mail: the email address associated with the key
password: an optional password to use for the key
gpg: a reference to GnuPG struct

§Returns

If the key is successfully created, returns an instance of Key wrapped in an Ok variant. If the key creation fails, returns an instance of GPGError wrapped in an Err variant.

Source

pub fn get_by_name(name: &str, gpg: &GnuPG) -> Option<Self>

Retrieves a GPG key by its name.

§Parameters

name: the name of the key to retrieve
gpg: a reference to GnuPG struct

§Returns

If a key with the given name is found, returns an instance of Key. If no key with the given name is found, returns None.

Source

pub fn get_by_mail(mail: &str, gpg: &GnuPG) -> Option<Self>

Retrieves a GPG key by its email address.

§Parameters

mail: the email address associated with the key to retrieve
gpg: a reference to GnuPG struct

§Returns

If a key with the given email address is found, returns an instance of Key. If no key with the given email address is found, returns None.

Source

pub fn get_by_fingerprint(fingerprint: &str, gpg: &GnuPG) -> Option<Self>

Retrieves a GPG key by its fingerprint.

§Parameters

fingerprint: the fingerprint associated with the key to retrieve
gpg: a reference to GnuPG struct

§Returns

If a key with the given fingerprint is found, returns an instance of Key. If no key with the given fingerprint is found, returns None.

Source

pub fn unlock(&self, pw: &str) -> Self

Adds information to unlock a GPG key with the given password.

§Parameters

pw: the password to use to unlock the key

§Returns

Returns a new Key object, with the password set to the given value.

§Example

use gnupg::*;
let gnupg = GnuPG::new().unwrap();
let encrypted = "-----BEGIN PGP MESSAGE-----
                ...
                -----END PGP MESSAGE-----";
let key = Key::get_by_name("Arisu", &gnupg).unwrap();
let plain = gnupg.decrypt(&key.unlock("pass"), encrypted);
println!("Plain Text: {:?}", plain);