security

package

v1.0.1 Latest Latest Go to latest Published: Nov 26, 2024 License: GPL-3.0 Imports: 4 Imported by: 0

Details

This section is empty.

This section is empty.

func Decode(encoded string) ([]byte, error)

Decode decodes encoded data, to get it's original value.

func Encode(data []byte) string

Encode encodes data for security purpose. For example, to send via HTTP.

func GenerateJWT(value any, secretKey string, ttl time.Duration, algorithm string) (string, error)

GenerateJWT creates a new Json Web Token, based on provided data.

value - any value to store in JWT payload;

secretKey - is a secret, on base of which will be checked, if JWT can be trusted;

ttl - time JWT is appropriate and after which will be expired;

algorithm - JWT hashing algorithm like HS256 and so on.

func Hash(value string, hashCost int) (string, error)

Hash hashes data for security purpose. For example, not to store raw unprotected data on database.

func ParseJWT(tokenString, secretKey string) (any, error)

ParseJWT decodes a Json Web Token payload.

tokenString - a JWT, which will be parsed;

secretKey - is a secret, on base of which will be checked, if JWT can be trusted;.

func ValidateHash(value, hashedValue string) bool

ValidateHash checks if hashed data is equal to raw data.

type Config struct {
	HashCost int
	JWT      JWTConfig
}

Config is common security config.

type InvalidJWTError struct {
	Message string
}

InvalidJWTError is an error, which represents, that JWT expired or something else went wrong via parsing it.

func (e InvalidJWTError) Error() string

type JWTClaimsError struct {
	Message string
}

JWTClaimsError is an error, which represents, that failed to retrieve JWT payload.

func (e JWTClaimsError) Error() string

type JWTConfig struct {
	SecretKey       string
	Algorithm       string
	RefreshTokenTTL time.Duration
	AccessTokenTTL  time.Duration
}

JWTConfig is a config for creating and parsing Json Web Tokens.