Struct Gnupg 

pub struct Gnupg {
    program: PathBuf,
    home: Option<PathBuf>,
}

GnuPG, as Sioul runs it on your press: the gpg program, and the home it reads (none: GnuPG’s own, GNUPGHOME or ~/.gnupg; a throwaway one in tests).

Fields

program: PathBuf

home: Option<PathBuf>

Implementations

impl Gnupg

pub fn find() -> Result<Gnupg, GnupgProblem>

GnuPG here: gpg on the path, else where its installers put it (a window started from the desktop may not have them on its path).

pub fn with_home(program: &Path, home: &Path) -> Gnupg

This gpg with its home in home (--homedir): tests, never yours.

fn run(&self, args: &[&str]) -> Result<Vec<u8>, GnupgProblem>

gpg run with args, in batch mode, nothing on its input; its output, or why not. GnuPG’s own pinentry may ask for a PIN meanwhile.

fn run_watching( &self, args: &[&str], watch: Option<&(dyn Fn(GnupgStep) + Sync)>, ) -> Result<Vec<u8>, GnupgProblem>

The same, saying where it is as it goes (watch: its status read as it comes): the pinentry open, then the key that may wait for a touch. A security key that waited in vain is said as such.

pub fn export(&self, fingerprint: &str) -> Result<Vec<u8>, GnupgProblem>

The certificate of the key fingerprint, armored, as GnuPG keeps it (gpg --export --armor): public parts only.

pub fn holds_secret(&self, fingerprint: &str) -> bool

Whether GnuPG holds the secret part of fingerprint, or knows the card that does: then it can renew the key.

pub fn renew( &self, fingerprint: &str, period: &str, watch: &(dyn Fn(GnupgStep) + Sync), ) -> Result<(), GnupgProblem>

The key fingerprint renewed for period (“2y”), then its subkeys: gpg --quick-set-expire, twice, GnuPG’s own pinentry asking the PIN (a security key’s: and a touch) each time it needs it. Its subkeys are named one by one, expired ones included: GnuPG’s “*” sets only those not yet expired, and a subkey expired since long stayed so. watch is told where it is: GnuPG’s pinentry open, then the key that may wait for a touch. Meanwhile Sioul’s own looks at the keys wait (may_look); at the end, done or not, GnuPG lets the security key go (Gnupg::release), so that Sioul can read it next.

pub fn subkeys(&self, fingerprint: &str) -> Vec<String>

The subkeys of fingerprint that are not revoked, expired ones included, as GnuPG lists them; none when it does not list them.

pub fn release(&self) -> Released

GnuPG’s smart card daemon stopped, after Sioul’s own GnuPG used the security key: it holds the key for itself (unless pcsc-shared is in scdaemon.conf) and Sioul could not read it next. gpg starts it again when it needs the key. GnuPG’s settings stay as they are.

Trait Implementations

impl Clone for Gnupg

fn clone(&self) -> Gnupg

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Gnupg

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

Formats the value using the given formatter.