security

Documentation

Index

• Constants
• func CheckPasswordConfirm(password, confirm []byte) bool
• func GenerateOTPCode(opts GenerateOptions) (string, int64, error)
• func UnsecureSHA1(text string) []byte
• type GenerateOptions
• type OTPError
  • func (e OTPError) Error() string

Constants

const (

	// DefaultLength is the default length of the generated OTP code.
	DefaultLength = 6
	// DefaultTimePeriod is the default time period for the TOTP.
	DefaultTimePeriod = 30
)

Functions

func CheckPasswordConfirm

func CheckPasswordConfirm(password, confirm []byte) bool

CheckPasswordConfirm checks two byte array if the content is the same.

func GenerateOTPCode

func GenerateOTPCode(opts GenerateOptions) (string, int64, error)

GenerateOTPCode generates an N digit TOTP from the secret Token.

func UnsecureSHA1

func UnsecureSHA1(text string) []byte

UnsecureSHA1 is not secure, but makes a fixed length password. With v2, I'm planning to move away from it, but that would break all existing vaults, so I have to be careful and make sure a proper migration script/function exists.

Types

type GenerateOptions

type GenerateOptions struct {
	Token      string
	When       time.Time
	Length     uint
	Algorithm  algo.Algorithm
	TimePeriod int64
}

GenerateOptions is the option list for the GenerateOTPCode function.

type OTPError

type OTPError struct {
	Message string
}

OTPError is an error describing an error during generation.

func (OTPError) Error

func (e OTPError) Error() string