secrets-go

README

[][godoc] [][circle-ci] [][goreportcard] [][latest-version] [][discord]

secrets-go provides a client for various Secrets APIs.

Usage

You can install secrets-go with:

go get github.com/rossmerr/secrets-go

Or install a specific version with:

go get github.com/rossmerr/secrets-go@vX.Y.Z

Then, import it using:

import (
    "github.com/rossmerr/secrets-go/pkg/secrethub"
)

Note: only packages inside the /pkg directory should be considered library code that you can use in your projects. All other code is not guaranteed to be backwards compatible and may change in the future.

Examples

For details on all functionality of this library, see the [GoDoc][godoc] documentation.

Below are a few simple examples:

Read Secrets

package main

import (
    "fmt"

    "github.com/rossmerr/secrets-go/pkg/secrethub"
)

func main() {
    client, _ := secrethub.NewClient()
    secret, _ := client.Secrets().ReadString("path/to/db/pass")
    fmt.Println(secret)
    // Output: wFc16W#96N1$
}

Write Secrets

package main

import (
    "fmt"

    "github.com/rossmerr/secrets-go/pkg/secrethub"
)

func main() {
    client, _ := secrethub.NewClient()
    _, _ = client.Secrets().Write("path/to/secret", []byte("password123"))
}

Generate Secrets

package main

import (
    "fmt"

    "github.com/rossmerr/secrets-go/pkg/randchar"
    "github.com/rossmerr/secrets-go/pkg/secrethub"
)

func main() {
    client, _ := secrethub.NewClient()
    data, _ := randchar.Generate(30)
    _, _ = client.Secrets().Write("path/to/secret", data)
}

Run tests for one package:

go test ./pkg/secrethub

Run a single test:

go test ./pkg/secrethub -run TestSignup

Attributions

["gopher.png"][original-gopher] by [Takuya Ueda][tenntenn] is licensed under CC BY 3.0