altcha

Documentation

Index

• Constants
• func AddSecretsRotationCallback(callback func())
• func BanSignature(signature string)
• func GetSecrets() (current, previous string)
• func IsSignatureBanned(signature string) bool
• func NewChallengeEncoded() string
• func RotateSecrets()
• func SetSecretsRotationInterval(interval time.Duration)
• func Sign(algo algorithm.Algorithm, text string) string
• func SolveChallenge(challenge string, maximumComplexity int) (response string, ok bool)
• func ValidateResponse(encoded string, preventReplay bool) (ok bool, err error)
• func VerifySignature(algo algorithm.Algorithm, text string, signature string) (valid bool)
• type Message
  • func DecodeChallenge(encoded string) (msg Message, err error)
  • func DecodeJSON(encoded []byte) (msg Message, err error)
  • func DecodeResponse(encoded string) (msg Message, err error)
  • func DecodeText(encoded string) (msg Message, err error)
  • func NewChallenge() (msg Message)
  • func NewChallengeWithParams(params Parameters) (msg Message)
  • func (message Message) Encode() string
  • func (message Message) EncodeWithBase64() string
  • func (message Message) IsValidResponse() bool
  • func (message Message) Solve(maximumComplexity int) (number int, ok bool)
  • func (message Message) String() string
• type Parameters
  • func (params *Parameters) Populate()

Constants

const MinimumComplexity = 10000

MinimumComplexity is the minimum complexity allowed. @see https://altcha.org/docs/complexity

const TextPrefix = "PoWCHA "

TextPrefix is the prefix used for the text encoding of the message.

Functions

func AddSecretsRotationCallback

func AddSecretsRotationCallback(callback func())

AddSecretsRotationCallback adds a callback function which is called when the secrets are rotated. It is run in a separate goroutine, so that the mutex is not held or locked when the callback is run.

func BanSignature

func BanSignature(signature string)

BanSignature adds the given signature to the list of banned signatures.

func GetSecrets

func GetSecrets() (current, previous string)

GetSecrets returns the current and previous secrets used for the hmac.

func IsSignatureBanned

func IsSignatureBanned(signature string) bool

IsSignatureBanned checks if the given signature is banned.

func NewChallengeEncoded

func NewChallengeEncoded() string

NewChallengeEncoded creates a new challenge with default parameters and encoded for the client.

func RotateSecrets

func RotateSecrets()

RotateSecrets immediately generates a new secret and replaces the previous secret with the current secret. This is concurrency safe and will block until complete.

func SetSecretsRotationInterval

func SetSecretsRotationInterval(interval time.Duration)

SetSecretsRotationInterval sets the interval at which secrets are automatically rotated. Setting the interval to 0 will disable automatic rotation.

func Sign

func Sign(algo algorithm.Algorithm, text string) string

Sign generates a signature for the given text.

func SolveChallenge

func SolveChallenge(challenge string, maximumComplexity int) (response string, ok bool)

SolveChallenge is a convenience function which decodes the challenge, solves it, and returns the response.

func ValidateResponse

func ValidateResponse(encoded string, preventReplay bool) (ok bool, err error)

ValidateResponse decodes and validates the response from the client.

func VerifySignature

func VerifySignature(algo algorithm.Algorithm, text string, signature string) (valid bool)

VerifySignature checks if the given signature is valid for the given text.

Types

type Message

type Message struct {
	// Algorithm is the hashing algorithm used to generate the challenge.
	// Supported algorithms are SHA-256, SHA-384, and SHA-512.
	Algorithm string `json:"algorithm"`

	// Salt is a random string used to generate the challenge.
	// The minimum length is 10 characters.
	Salt string `json:"salt"`

	// Number is the secret number which the client must solve for.
	Number int `json:"number,omitempty"`

	// Challenge is the hash which the client must solve for.
	// The minimum length is 40 characters.
	Challenge string `json:"challenge"`

	// Signature is the signature of the challenge.
	Signature string `json:"signature"`
}

Message represents the messages between the client and server.

func DecodeChallenge

func DecodeChallenge(encoded string) (msg Message, err error)

DecodeChallenge decodes output from NewChallengeEncoded.

func DecodeJSON

func DecodeJSON(encoded []byte) (msg Message, err error)

DecodeJSON decodes a Message stored in JSON format.

func DecodeResponse

func DecodeResponse(encoded string) (msg Message, err error)

DecodeResponse decodes the response Message from the client.

func DecodeText

func DecodeText(encoded string) (msg Message, err error)

DecodeText decodes the output from message.String().

func NewChallenge

func NewChallenge() (msg Message)

NewChallenge creates a new challenge with default parameters.

func NewChallengeWithParams

func NewChallengeWithParams(params Parameters) (msg Message)

NewChallengeWithParams creates a new challenge with the given parameters.

func (Message) Encode

func (message Message) Encode() string

Encode returns the message ready to be sent to the client. The client is expecting the message in raw JSON format.

func (Message) EncodeWithBase64

func (message Message) EncodeWithBase64() string

EncodeWithBase64 returns the message ready to be sent back to the server. The server is expecting the message to be JSON wrapped in base64 encoding.

func (Message) IsValidResponse

func (message Message) IsValidResponse() bool

IsValidResponse is used to validate a decoded response from the client.

func (Message) Solve

func (message Message) Solve(maximumComplexity int) (number int, ok bool)

Solve attempts to solve the challenge within the given maximum complexity.

func (Message) String

func (message Message) String() string

String returns a textual representation of the message in the format defined in the M2M Altcha specification. It is used for both server and client. @see https://altcha.org/docs/m2m-altcha

type Parameters

type Parameters struct {
	// Algorithm is the hashing algorithm used to generate the challenge.
	// Supported algorithms are SHA-256, SHA-384, and SHA-512.
	Algorithm string `json:"algorithm"`

	// Salt is a random string used to generate the challenge.
	// The minimum length is 10 characters.
	Salt string `json:"salt"`

	// Complexity is the number of iterations used to generate the challenge.
	// This is only considered when Number is not provided.
	Complexity int `json:"complexity,omitempty"`

	// Number is the secret number which the client must solve for.
	Number int `json:"number,omitempty"`
}

Parameters are the parameters used to generate a challenge. If any of the parameters are missing, they will be generated.

func (*Parameters) Populate

func (params *Parameters) Populate()

Populate generates any missing parameters.