misc

Documentation

Index

• Constants
• Variables
• func ConvertInterfaceArrayToStringArray(toConvert []interface{}) []string
• func CountUniqueCharacters(str string) int
• func ExtractClaimsTokenFromRequest(secret string, r *http.Request) (jwt.MapClaims, error)
• func GenerateSalt() string
• func GenerateToken(secret string, data jwt.MapClaims) (string, error)
• func GetChangePasswordToken(secret, username, redirectTo string) string
• func GetEmailConfirmationToken(secret, username, challenge string) string
• func GetEncryptedPassword(secretKey, password, salt string) string
• func GetJSONStr(toEncode interface{}) string
• func ParseToken(tokenString, secret string) (jwt.MapClaims, error)
• func UnmarshalChangePasswordToken(claims jwt.MapClaims) (string, string, error)
• func UnmarshalEmailConfirmationToken(claims jwt.MapClaims) (username, challenge string)
• func UnmarshalPayloadFromRequest(p IPayload, r *http.Request) error
• func ValidatePassword(password, username, email string) error
• func VerifyEmail(email string) error
• type BasePage
  • func (p *BasePage) SetHTML(html template.HTML)
• type GrantScope
• type GrantScopes
  • func (gss GrantScopes) GetScopeListFromGrantScopeMap() []string
• type IPage
• type IPayload

Constants

const (
	// PasswordMinChar is the minimum number of characters the password should have
	PasswordMinChar = 12

	// PasswordMaxChar is the maximum number of characters the password should have
	PasswordMaxChar = 30

	// PasswordMinUniqueChar is the minimum number of unique characters the password should have
	PasswordMinUniqueChar = 7
)

Variables

var PasswordTooltip = fmt.Sprintf(passwordTooltipTemplate, PasswordMinChar, PasswordMaxChar, PasswordMinUniqueChar)

PasswordTooltip is an explanation snippet of the rules to a valid password

Functions

func ConvertInterfaceArrayToStringArray

func ConvertInterfaceArrayToStringArray(toConvert []interface{}) []string

ConvertInterfaceArrayToStringArray a helper method to perform conversions between []interface{} and []string

func CountUniqueCharacters

func CountUniqueCharacters(str string) int

CountUniqueCharacters counts the unique characters in a string

func ExtractClaimsTokenFromRequest

func ExtractClaimsTokenFromRequest(secret string, r *http.Request) (jwt.MapClaims, error)

ExtractClaimsTokenFromRequest extract a jwt token from a given request

func GenerateSalt

func GenerateSalt() string

GenerateSalt a salt string with 16 bytes of crypto/rand data.

func GenerateToken

func GenerateToken(secret string, data jwt.MapClaims) (string, error)

GenerateToken generates a jwt token

func GetChangePasswordToken

func GetChangePasswordToken(secret, username, redirectTo string) string

GetEmailConfirmationToken builds a token for changing password

func GetEmailConfirmationToken

func GetEmailConfirmationToken(secret, username, challenge string) string

GetEmailConfirmationToken builds a token for email confirmation

func GetEncryptedPassword

func GetEncryptedPassword(secretKey, password, salt string) string

GetEncryptedPassword builds an encrypted password with hmac(sha512)

func GetJSONStr

func GetJSONStr(toEncode interface{}) string

GetJSONStr gets the full json string from the toEncode structure

func ParseToken

func ParseToken(tokenString, secret string) (jwt.MapClaims, error)

ParseToken extract the claims from a token string

func UnmarshalChangePasswordToken

func UnmarshalChangePasswordToken(claims jwt.MapClaims) (string, string, error)

UnmarshalChangePasswordToken verify it is an change password token and extract the extras information

func UnmarshalEmailConfirmationToken

func UnmarshalEmailConfirmationToken(claims jwt.MapClaims) (username, challenge string)

UnmarshalEmailConfirmationToken verify it is an email confirmation token and extract the extras information

func UnmarshalPayloadFromRequest

func UnmarshalPayloadFromRequest(p IPayload, r *http.Request) error

UnmarshalPayloadFromRequest initializes payload from an http request form and triggers the check function of the payload

func ValidatePassword

func ValidatePassword(password, username, email string) error

ValidatePassword verify if a password is valid

func VerifyEmail

func VerifyEmail(email string) error

VerifyEmail verify if the string is actually an email

Types

type BasePage

type BasePage struct {
	HTML template.HTML // a page should have an HTML
}

BasePage holds the basic information from a page

func (*BasePage) SetHTML

func (p *BasePage) SetHTML(html template.HTML)

SetHTML exposes the attribute HTML

type GrantScope

type GrantScope struct {
	Description string
	Details     string
	Scope       string
}

GrantScope defines the structure of a grant scope

type GrantScopes

type GrantScopes map[string]GrantScope

GrantScopes defines a map of grant scopes

func (GrantScopes) GetScopeListFromGrantScopeMap

func (gss GrantScopes) GetScopeListFromGrantScopeMap() []string

GetScopeListFromGrantScopeMap builds a list of scopes from a grant scope map

type IPage

type IPage interface {
	SetHTML(html template.HTML)
}

IPage defines what a page should expose

type IPayload

type IPayload interface {
	Check() error
}

IPayload defines what should a payload expose