Skip to content

Instantly share code, notes, and snippets.

@ferki
Last active September 30, 2020 05:35
Show Gist options
  • Save ferki/40162adeae40886d6a7e3dccfec67ade to your computer and use it in GitHub Desktop.
Save ferki/40162adeae40886d6a7e3dccfec67ade to your computer and use it in GitHub Desktop.
Secret::Store POD preview

NAME

Secret::Store - A module to interact with secret stores

VERSION

version v0.1.0

SYNOPSIS

use Secret::Store;

my $store  = Secret::Store->new( backend => $backend );
my $secret = $store->get($secret_id);

DESCRIPTION

Secret::Store is providing an interface for various secret management systems.

The idea is to have a unified interface for common operations, and also a specialized one that follows the native interface of a given backend more closely.

WARNING: This is an experimental module, so there might be even breaking changes in the API before reaching v1.0.0.

ATTRIBUTES

backend

Secret store backend to use.

METHODS

get($secret_id)

Retrieve the secret identified as $secret_id in the secret store.

DIAGNOSTICS

This module does not do any error checking (yet).

CONFIGURATION AND ENVIRONMENT

This module does not require any configuration, nor does it use any environment variables.

DEPENDENCIES

See the included cpanfile.

INCOMPATIBILITIES

There are no known incompatibilities with other modules.

BUGS AND LIMITATIONS

There are no known bugs. Make sure they are reported.

AUTHOR

Ferenc Erki <erkiferenc@gmail.com>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2020 by Ferenc Erki.

This is free software, licensed under:

The GNU Lesser General Public License, Version 3, June 2007

This software is also a sponsorware that is made available exclusively to my GitHub sponsors under the terms above in the initial development phase. It will be open sourced as soon as a goal of 8 sponsors is reached.

Until then however, you are kindly asked to don't distribute it beyond what is necessary for your own use cases, as it would render the model pointless. Instead, you are encouraged to convince others to sponsor this work further in order to re-release it to a wider audience as soon as possible.

You are contributing towards a more sustainable open source ecosystem, and I'm grateful beyond measure for that. Thank you for your support!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment