siwe

package

v1.2.3 Latest Latest Go to latest Published: Apr 10, 2024 License: LGPL-3.0 Imports: 13 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/Argus-Labs/world-engine

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func ValidateSignature(ctx context.Context, nk runtime.NakamaModule, ...) error
type GenerateResult
- func GenerateNewSIWEMessage(signerAddress string) (*GenerateResult, error)

Constants ¶

View Source

const (
	// TODO: This static domain and URI should be configurable via an environment variable.
	// See: https://linear.app/arguslabs/issue/WORLD-995/make-domain-and-uri-configurable-for-siwe-authentication
	DefaultDomain = "example.com"
	DefaultURI    = "https://example.com/v2/account/authenticate/custom"

	// DefaultTimeout is the length of time between the issue time and the expiration time. If the current time
	// is not between the issue time and expiration time of a message, the signature will be rejected.
	DefaultTimeout   = 5 * time.Minute
	DefaultStatement = "Log in to Nakama using SIWE."
)

Variables ¶

View Source

var (
	ErrMissingSignerAddress = errors.New("missing signer address")
	ErrMissingMessage       = errors.New("message field is required")
	ErrMissingSignature     = errors.New("signature field is required")
)

Functions ¶

func ValidateSignature ¶

func ValidateSignature(ctx context.Context, nk runtime.NakamaModule, signerAddress, message, signature string) error

ValidateSignature ensures the given message is valid and the given signature is actually a signature for the message.

Types ¶

type GenerateResult ¶

type GenerateResult struct {
	SIWEMessage string `json:"siwe_message"`
}

GenerateResult will be serialized to JSON and sent back to a client. The client must sign the message in the SIWEMessage field, and resubmit their authentication request.

func GenerateNewSIWEMessage ¶

func GenerateNewSIWEMessage(signerAddress string) (*GenerateResult, error)

GenerateNewSIWEMessage generates an SIWE Message that can be signed and used to authenticate a user.

Source Files ¶

View all Source files

siwe.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL