Skip to content

pimalaya/io-secret

Repository files navigation

I/O Secret Documentation Matrix

Set of I/O-free Rust coroutines to retrieve secrets from different sources, based on io-process and io-keyring.

This library allows you to retrieve secrets from different sources using an I/O-agnostic approach, based on 3 concepts:

Coroutine

A coroutine is an I/O-free, resumable and composable state machine that emits I/O requests. A coroutine is considered terminated when it does not emit I/O requests anymore.

See available coroutines at ./src/coroutines.

Runtime

A runtime contains all the I/O logic, and is responsible for processing I/O requests emitted by coroutines.

See available runtimes at io-process and io-keyring.

Loop

The loop is the glue between coroutines and runtimes. It makes the coroutine progress while allowing runtime to process I/O.

Examples

Read secret synchronously

use io_keyring::{runtimes::std::handle as handle_keyring};
use io_process::{runtimes::std::handle as handle_process};
use io_secret::{Io, Secret};

let secret: Secret;

let mut arg = None;
let mut read = Read::new(secret);

let secret = loop {
    match read.resume(arg) {
        Ok(secret) => break secret,
        Err(Io::Keyring(io)) => arg = Some(Io::Keyring(handle_keyring(io).unwrap())),
        Err(Io::Command(io)) => arg = Some(Io::Command(handle_process(io).unwrap())),
        Err(Io::Error(err)) => panic!("{err}"),
    }
}

See complete example at ./examples/read.

More examples

Have a look at projects built on the top of this library:

  • TODO

Sponsoring

nlnet

Special thanks to the NLnet foundation and the European Commission that helped the project to receive financial support from various programs:

If you appreciate the project, feel free to donate using one of the following providers:

GitHub Ko-fi Buy Me a Coffee Liberapay thanks.dev PayPal

About

Set of I/O-free Rust coroutines to retrieve secrets from different sources

Topics

Resources

License

Contributing

Stars

Watchers

Forks