Back to godoc.org
github.com/secrethub/secrethub-go

Directory github.com/secrethub/secrethub-go

v0.31.0
Latest Go to latest

The highest tagged major version is .

Published: Sep 7, 2020 | License: Apache-2.0 | Module: github.com/secrethub/secrethub-go

README

SecretHub

Go Client

GoDoc CircleCI Go Report Card Version Discord

secrethub-go provides a client for various SecretHub APIs.

SecretHub is a secrets management tool that works for every engineer. Securely provision passwords and keys throughout your entire stack with just a few lines of code.

Gopher

Usage

You can install secrethub-go with:

go get github.com/secrethub/secrethub-go

Or install a specific version with:

go get github.com/secrethub/secrethub-go@vX.Y.Z

Then, import it using:

import (
    "github.com/secrethub/secrethub-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 documentation.

Below are a few simple examples:

Read Secrets

package main

import (
    "fmt"

    "github.com/secrethub/secrethub-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/secrethub/secrethub-go/pkg/secrethub"
)

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

Generate Secrets

package main

import (
    "fmt"

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

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

Credential

To use the SecretHub Go client, you need to provide a credential for your SecretHub account. You can create a free developer account by signing up through the CLI.

After signup, the credential is located at $HOME/.secrethub/credential by default. secrethub.NewClient() automatically uses this credential.

Development

Pull requests from the community are welcome. If you’d like to contribute, please checkout the contributing guidelines.

Testing

Run all tests:

make test

Run tests for one package:

go test ./pkg/secrethub

Run a single test:

go test ./pkg/secrethub -run TestSignup

For any requests, bug or comments, please open an issue or submit a pull request.

Getting help

If you get stuck or just want advice, come chat with the engineers on Discord or send an email to support@secrethub.io

Attributions

“gopher.png” by Takuya Ueda is licensed under CC BY 3.0

Source: github.com/secrethub/secrethub-go@v0.31.0/README.md