Overview ¶

mattress provides a secure way to handle sensitive data within Go applications. It leverages the memguard library to create encrypted enclaves for sensitive information, ensuring that data is protected both in memory and during runtime. This package is designed to mitigate accidental leaks of sensitive data through improper memory handling or exposure via runtime panics.

Note: While this package offers enhanced security for sensitive data, it is important to acknowledge that no method is entirely foolproof. Users are encouraged to employ this package in conjunction with other security best practices for more comprehensive protection.

Warning: This package utilizes runtime finalizers to ensure cleanup of sensitive data. Due to the nature of Go's runtime, which does not guarantee immediate execution of finalizers, sensitive data may reside in memory longer than anticipated. Users should proceed with caution and ensure they fully comprehend the potential implications.

Example Usage:

import m "github.com/garrettladley/mattress"

type User struct {
  Username string
  Password *m.Secret[string]
}

func main() {
  password, err := m.NewSecret("password")
  if err != nil {
    // handle error
  }

  user := User{
    Username: "username",
    Password: password,
  }

  fmt.Println(user.Password) // Output: memory address
  fmt.Println(user.Password.String()) // Output: "[SECRET]"
  fmt.Println(user.Password.Expose()) // Output: "password"
}