Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/secrethub/secrethub-go
Golang SDK for the SecretHub Secrets Management API
https://github.com/secrethub/secrethub-go
devops go golang hacktoberfest secrets secrets-management security
Last synced: 3 months ago
JSON representation
Golang SDK for the SecretHub Secrets Management API
- Host: GitHub
- URL: https://github.com/secrethub/secrethub-go
- Owner: secrethub
- License: apache-2.0
- Archived: true
- Created: 2018-12-07T10:38:19.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-30T19:24:40.000Z (almost 2 years ago)
- Last Synced: 2024-06-28T02:43:34.266Z (5 months ago)
- Topics: devops, go, golang, hacktoberfest, secrets, secrets-management, security
- Language: Go
- Homepage: https://secrethub.io
- Size: 1.71 MB
- Stars: 59
- Watchers: 11
- Forks: 10
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
SecretHub has joined 1Password! Find out more on the SecretHub blog. 🎉
Go Client
[][godoc]
[][circle-ci]
[][goreportcard]
[][latest-version]
[][discord]
`secrethub-go` provides a client for various SecretHub APIs.
> [SecretHub][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.
## Usage
You can install secrethub-go with:
```sh
go get github.com/secrethub/secrethub-go
```
Or install a specific version with:
```sh
go get github.com/secrethub/[email protected]
```
Then, import it using:
``` go
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][godoc] documentation.
Below are a few simple examples:
#### Read Secrets
```go
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
```go
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
```go
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](https://secrethub.io/docs/getting-started/).
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](./CONTRIBUTING.md).
## 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][issues] or [submit a
pull request][pulls].
## Getting help
If you get stuck or just want advice, come chat with the engineers on [Discord][discord] or send an email to [[email protected]](mailto:[email protected])
## Attributions
["gopher.png"][original-gopher] by [Takuya Ueda][tenntenn] is licensed under [CC BY 3.0][creative-commons-3.0]
[original-gopher]: https://camo.githubusercontent.com/98ed65187a84ecf897273d9fa18118ce45845057/68747470733a2f2f7261772e6769746875622e636f6d2f676f6c616e672d73616d706c65732f676f706865722d766563746f722f6d61737465722f676f706865722e706e67
[creative-commons-3.0]: https://creativecommons.org/licenses/by/3.0/
[tenntenn]: https://twitter.com/tenntenn
[secrethub]: https://secrethub.io
[latest-version]: https://github.com/secrethub/secrethub-go/releases/latest
[issues]: https://github.com/secrethub/secrethub-go/issues/new
[pulls]: https://github.com/secrethub/secrethub-go/pulls
[godoc]: https://pkg.go.dev/github.com/secrethub/secrethub-go?tab=overview
[goreportcard]: https://goreportcard.com/report/github.com/secrethub/secrethub-go
[circle-ci]: https://circleci.com/gh/secrethub/secrethub-go
[discord]: https://discord.gg/EQcE87s