vaultpki

package module

v0.2.0 Latest Latest Go to latest Published: Mar 24, 2020 License: Apache-2.0 Imports: 6 Imported by: 6

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/giantswarm/vaultpki

Links

Open Source Insights

README ¶

vaultpki

Package vaultpki provides primitives to more easily work with Vault PKI backends.

Documentation ¶

Index ¶

Constants
func IsExecutionFailed(err error) bool
func IsInvalidConfig(err error) bool
func IsNoVaultHandlerDefined(err error) bool
func IsNotFound(err error) bool
type CertificateAuthority
- func DefaultCertificateAuthority() CertificateAuthority
type Config
- func DefaultConfig() Config
type Interface
type VaultPKI
- func New(config Config) (*VaultPKI, error)

Constants ¶

View Source

const (
	// MountType is the mount type used to mount a PKI backend in Vault.
	MountType = "pki"
)

Variables ¶

This section is empty.

Functions ¶

func IsExecutionFailed ¶

func IsExecutionFailed(err error) bool

IsExecutionFailed asserts executionFailedError.

func IsInvalidConfig ¶

func IsInvalidConfig(err error) bool

IsInvalidConfig asserts invalidConfigError.

func IsNoVaultHandlerDefined ¶

func IsNoVaultHandlerDefined(err error) bool

IsNoVaultHandlerDefined asserts a dirty string matching against the error message provided by err. This is necessary due to the poor error handling design of the Vault library we are using.

func IsNotFound ¶

func IsNotFound(err error) bool

IsNotFound asserts notFoundError.

Types ¶

type CertificateAuthority ¶ added in v0.1.3

type CertificateAuthority struct {
	Certificate string
	PrivateKey  string
}

func DefaultCertificateAuthority ¶ added in v0.1.3

func DefaultCertificateAuthority() CertificateAuthority

type Config ¶

type Config struct {
	Logger      micrologger.Logger
	VaultClient *vaultapi.Client

	CATTL            string
	CommonNameFormat string
}

func DefaultConfig ¶

func DefaultConfig() Config

type Interface ¶

type Interface interface {
	BackendExists(ID string) (bool, error)
	CAExists(ID string) (bool, error)
	CreateBackend(ID string) error
	CreateCA(ID string) (CertificateAuthority, error)
	CreateCAWithPrivateKey(ID string) (CertificateAuthority, error)
	DeleteBackend(ID string) error
	GetBackend(ID string) (*vaultapi.MountOutput, error)
	GetCACertificate(ID string) (CertificateAuthority, error)
	ListBackends() (map[string]*vaultapi.MountOutput, error)
}

type VaultPKI ¶

type VaultPKI struct {
	// contains filtered or unexported fields
}

func New ¶

func New(config Config) (*VaultPKI, error)

func (*VaultPKI) BackendExists ¶

func (p *VaultPKI) BackendExists(ID string) (bool, error)

func (*VaultPKI) CAExists ¶

func (p *VaultPKI) CAExists(ID string) (bool, error)

func (*VaultPKI) CreateBackend ¶

func (p *VaultPKI) CreateBackend(ID string) error

func (*VaultPKI) CreateCA ¶

func (p *VaultPKI) CreateCA(ID string) (CertificateAuthority, error)

func (*VaultPKI) CreateCAWithPrivateKey ¶ added in v0.1.3

func (p *VaultPKI) CreateCAWithPrivateKey(ID string) (CertificateAuthority, error)

func (*VaultPKI) DeleteBackend ¶

func (p *VaultPKI) DeleteBackend(ID string) error

func (*VaultPKI) GetBackend ¶

func (p *VaultPKI) GetBackend(ID string) (*vaultapi.MountOutput, error)

func (*VaultPKI) GetCACertificate ¶

func (p *VaultPKI) GetCACertificate(ID string) (CertificateAuthority, error)

GetCACertificate returns the public key of the root CA of the PKI backend associated to the given ID, if any.

func (*VaultPKI) ListBackends ¶

func (p *VaultPKI) ListBackends() (map[string]*vaultapi.MountOutput, error)

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
key
vaultpkitest

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL