noisegate_keys (noisegate v1.0.0)

View Source

Summary

Types

The secret is only reachable through secret/1, so that printing or logging a key_info() cannot leak it.

Types

key_info/0

-opaque key_info()

node_name/0

-type node_name() :: atom() | binary() | string().

opts/0

-type opts() ::
          #{dir => file:filename(),
            generate => boolean(),
            authorized_dirs => [file:filename()] | string(),
            keygen => fun(() -> {binary(), binary()}),
            node_name => node_name(),
            comment => binary() | string()}.

peer_entry/0

-type peer_entry() ::
          #{name := binary(),
            key := binary(),
            fingerprint := string(),
            comment := binary(),
            file := file:filename(),
            dir := file:filename()}.

skipped/0

-type skipped() :: #{file := file:filename(), reason := term()}.

The secret is only reachable through secret/1, so that printing or logging a key_info() cannot leak it.

Functions

add_peer(Name, PublicKey, Opts)

-spec add_peer(binary(), binary(), opts()) -> {ok, file:filename()} | {error, term()}.

authorized_dirs(NodeName, Opts)

-spec authorized_dirs(node_name(), opts()) -> [file:filename()].

authorized_line(NodeName, PublicKey)

-spec authorized_line(node_name(), binary()) -> binary().

check_peer(Name, PublicKey, Opts)

-spec check_peer(binary(), binary(), opts()) -> allowed | denied | unknown_name.

ensure_dirs(NodeName, Opts)

-spec ensure_dirs(node_name(), opts()) -> ok | {error, term()}.

fingerprint(PublicKey)

-spec fingerprint(binary() | key_info()) -> binary().

generated(_)

-spec generated(key_info()) -> boolean().

list_peers(Opts)

-spec list_peers(opts()) -> {ok, [peer_entry()], [skipped()]} | {error, term()}.

load_or_generate(NodeName, Opts)

-spec load_or_generate(node_name(), opts()) -> {ok, key_info()} | {error, term()}.

node_key_dir(NodeName, Opts)

-spec node_key_dir(node_name(), opts()) -> file:filename().

public(_)

-spec public(key_info()) -> binary().

remove_peer(Name, Fingerprint, Opts)

-spec remove_peer(binary(), string() | binary(), opts()) -> ok | {error, term()}.

secret(_)

-spec secret(key_info()) -> binary().

valid_node_name(Name)

-spec valid_node_name(term()) -> boolean().