sensitive

README

sensitive

Documentation

Overview

package sensitive provides a way to create sensitive data types

Index

• type Email
  • func NewEmail(s string) Email
  • func NewEmailWithMask(s string, mask MaskFunc) Email
• type MaskFunc
• type Password
  • func NewPassword(s string) Password
  • func NewPasswordWithMask(s string, mask MaskFunc) Password
• type Phone
  • func NewPhone(s string) Phone
  • func NewPhoneWithMask(s string, mask MaskFunc) Phone

Examples

• NewPasswordWithMask
• Password

Types

type Email

type Email struct {
	masked.MaskedText
}

Email represents a sensitive email address.

func NewEmail

func NewEmail(s string) Email

NewEmail creates a new Email instance with the default email masking function.

func NewEmailWithMask

func NewEmailWithMask(s string, mask MaskFunc) Email

NewEmailWithMask creates a new Email instance with a custom masking function.

type MaskFunc

type MaskFunc func(string) string

MaskFunc is a function type that takes a string as input and returns a masked string. It is used to define custom masking functions for sensitive data.

type Password

type Password struct {
	masked.MaskedText
}

Password represents a sensitive password value.

Example

package main

import (
	"fmt"

	"github.com/pedrolemes/sensitive"
)

func main() {
	p := sensitive.NewPassword("my-password")
	fmt.Println(p)
}

Output:

****

func NewPassword

func NewPassword(s string) Password

NewPassword creates a new Password instance with a default mask.

func NewPasswordWithMask

func NewPasswordWithMask(s string, mask MaskFunc) Password

NewPasswordWithMask creates a new Password instance with a custom mask.

Example

package main

import (
	"fmt"

	"github.com/pedrolemes/sensitive"
)

func main() {
	p := sensitive.NewPasswordWithMask("my-password", func(s string) string {
		return "---"
	})

	fmt.Println(p)
}

Output:

---

type Phone

type Phone struct {
	masked.MaskedText
}

Phone represents a sensitive phone number.

func NewPhone

func NewPhone(s string) Phone

NewPhone creates a new Phone instance with the default mask.

func NewPhoneWithMask

func NewPhoneWithMask(s string, mask MaskFunc) Phone

NewPhoneWithMask creates a new Phone instance with a custom mask.