Struct SoftCard 

pub struct SoftCard {
    pub info: CardInfo,
    signer: Option<KeyPair>,
    decryptor: Option<KeyPair>,
    pin: Vec<u8>,
    x25519: Option<fn(&[u8; 32], &[u8; 32]) -> [u8; 32]>,
    verified_sign: bool,
    verified_decrypt: bool,
    pub fault: Option<CardError>,
    pub operations: usize,
    pub touch_delay: Duration,
}

A security key made of software keys, behind the same traits as a real one, for tests: Sioul itself never makes one. It counts its PIN tries, forgets a verified PIN when closed, asks the PIN again after each signature when told to, and can fail as a real key does (SoftCard::fault).

Fields

info: CardInfo

What it says.

signer: Option<KeyPair>

decryptor: Option<KeyPair>

pin: Vec<u8>

x25519: Option<fn(&[u8; 32], &[u8; 32]) -> [u8; 32]>

X25519 for its Curve25519 key: Sequoia keeps its own private, so a test lends one.

verified_sign: bool

verified_decrypt: bool

fault: Option<CardError>

What its next signature or opening does instead of working: a touch missed, the key pulled out.

operations: usize

Signatures and openings it made.

touch_delay: Duration

How long a person takes to touch it, when a key asks for a touch: none in tests; a few seconds in the demo, so that “Touch your security key” shows.

Implementations

impl SoftCard

pub fn new(ident: &str, cert: &Cert, pin: &str) -> SoftCard

A key named ident holding the secret keys of cert (its first signing key and its first encryption key), with pin.

pub fn generate( ident: &str, userids: &[&str], pin: &str, ) -> Result<(SoftCard, Vec<u8>), String>

A new key for tests (Curve25519: its primary key signs, a subkey decrypts), named by userids, on a software key ident with pin; and its certificate, armored, public parts only. For the crates that do not use Sequoia themselves.

pub fn with_x25519( self, x25519: fn(&[u8; 32], &[u8; 32]) -> [u8; 32], ) -> SoftCard

Lends it X25519, for its Curve25519 decryption key.

fn close(&mut self)

Closed: a real key is reset, and its PIN must be given again.

Trait Implementations

impl Card for SoftCard

fn info(&mut self) -> Result<CardInfo, CardError>

What it says without its PIN.

fn verify(&mut self, pin: &Password, mode: PinMode) -> Result<(), CardError>

Gives it its PIN; a wrong one costs a try.

fn sign(&mut self, input: ToSign<'_>) -> Result<Vec<u8>, CardError>

Signs with its signing key: r ‖ s for EdDSA and ECDSA, s for RSA.

fn decipher(&mut self, input: ToDecipher<'_>) -> Result<Protected, CardError>

Opens with its decryption key.