secretstorage

README

Secret Storage

A library for storing and retrieving secrets.

Prerequisites

• Go >= 1.21

Install

go get go.nhat.io/secretstorage

Usage

package main

import (
    "fmt"

    "go.nhat.io/secretstorage"
)

func main() {
    ss := secretstorage.NewKeyringStorage[string]()

    err := ss.Set("service", "key", "value")
    if err != nil {
        panic(err)
    }

    value, err := ss.Get("service", "key")
    if err != nil {
        panic(err)
    }

    fmt.Println(value)
}

Donation

If this project help you reduce time to develop, you can give me a cup of coffee :)

Paypal donation

       or scan this

Documentation

Overview

Package secretstorage provides a generic interface for storing and retrieving data from a secret storage.

Index

• Variables
• type KeyringStorage
  • func NewKeyringStorage[V any](opts ...KeyringStorageOption) *KeyringStorage[V]
  • func (ss *KeyringStorage[V]) Delete(service string, key string) error
  • func (ss *KeyringStorage[V]) Get(service string, key string) (V, error)
  • func (ss *KeyringStorage[V]) Set(service string, key string, value V) error
• type KeyringStorageOption
  • func WithKeyring(k keyring.Keyring) KeyringStorageOption
• type Storage

Variables

var (
	// ErrNotFound is a not found error.
	ErrNotFound = keyring.ErrNotFound
	// ErrUnsupportedType is an unsupported type error.
	ErrUnsupportedType = errors.New("unsupported type")
)

Types

type KeyringStorage

type KeyringStorage[V any] struct {
	// contains filtered or unexported fields
}

KeyringStorage is a storage implementation that uses the OS keyring.

func NewKeyringStorage

func NewKeyringStorage[V any](opts ...KeyringStorageOption) *KeyringStorage[V]

NewKeyringStorage creates a new KeyringStorage that uses the OS keyring.

func (*KeyringStorage[V]) Delete

func (ss *KeyringStorage[V]) Delete(service string, key string) error

Delete deletes the value for the given key.

func (*KeyringStorage[V]) Get

func (ss *KeyringStorage[V]) Get(service string, key string) (V, error)

Get gets the value for the given key.

func (*KeyringStorage[V]) Set

func (ss *KeyringStorage[V]) Set(service string, key string, value V) error

Set sets the value for the given key.

type KeyringStorageOption

type KeyringStorageOption interface {
	// contains filtered or unexported methods
}

KeyringStorageOption is an option to configure KeyringStorage.

func WithKeyring

func WithKeyring(k keyring.Keyring) KeyringStorageOption

WithKeyring sets the keyring to use.

type Storage

type Storage[V any] interface {
	Set(service string, key string, value V) error
	Get(service string, key string) (V, error)
	Delete(service string, key string) error
}

Storage is a generic interface for storing and retrieving data.