• Stars
    star
    25
  • Rank 925,438 (Top 19 %)
  • Language
    Go
  • License
    MIT License
  • Created over 2 years ago
  • Updated about 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Prevent your secrets from leaking into logs, std* etc.

GoDev Build Status Go Report Card

secret v2

What secret is?

  • It provides simple Go types like secret.Text to encapsulate your secret. Example:
type Login struct {
    User string
    Password secret.Text
}
  • The encapsulated secret remains inaccessible to operations like printing, logging, JSON serializtion etc. A (customizable) redact hint like ***** is returned instead.
  • The only way to access the actual secret value is by asking explicitly via the .Value() method.
  • See godev reference for usage examples.

What secret is not?

  • It is not a secret management service or your local password manager.
  • It is not a Go client to facilitate communication with secret managers like Hashicorp Vault, AWS secret Manager etc. Checkout teller if that is what you are looking for.

Installation

go get github.com/rsjethani/secret/v2

NOTE: v1 is deprecated now.