secret

Documentation

Overview

Package secret contains a struct to store secrets in that won't accidentally let them be logged.

Index

• type String
  • func (s String) GoString() string
  • func (s String) MarshalJSON() ([]byte, error)
  • func (s String) Raw() string
  • func (s String) String() string
  • func (s String) Value() (driver.Value, error)

Types

type String

type String string

func (String) GoString

func (s String) GoString() string

GoString implements fmt.GoStringer and redacts the sensitive value.

func (String) MarshalJSON

func (s String) MarshalJSON() ([]byte, error)

func (String) Raw

func (s String) Raw() string

Raw returns the sensitive value as a string.

func (String) String

func (s String) String() string

String implements fmt.Stringer and redacts the sensitive value.

func (String) Value

func (s String) Value() (driver.Value, error)

Value returns the sensitive value as a string for database (https://github.com/jackc/pgx) use.

Deprecated: this exists for automatic database integration with secret values. Use Raw instead for general purpose secret handling.