auth

Documentation

Overview

Package auth manages the authentication process with the relay server.

Key Components:

Validator: The Validator interface defines the Validate method. Any type that provides this method can be used as a Validator.

Methods:

Validate(func() hash.Hash, any): This method is defined in the Validator interface and is used to validate the authentication.

Usage:

To create a new AllowAllAuth validator, simply instantiate it:

validator := &allow.Auth{}

To validate the authentication, use the Validate method:

err := validator.Validate(sha256.New, any)

This package provides a simple and effective way to manage authentication with the relay server, ensuring that the peers are authenticated properly.

Index

• type TimedHMACValidator
  • func NewTimedHMACValidator(secret []byte, duration time.Duration) *TimedHMACValidator
  • func (a *TimedHMACValidator) Validate(credentials any) error
  • func (a *TimedHMACValidator) ValidateHelloMsgType(credentials any) error
• type Validator

Types

type TimedHMACValidator

type TimedHMACValidator struct {
	// contains filtered or unexported fields
}

func NewTimedHMACValidator

func NewTimedHMACValidator(secret []byte, duration time.Duration) *TimedHMACValidator

func (*TimedHMACValidator) Validate

func (a *TimedHMACValidator) Validate(credentials any) error

func (*TimedHMACValidator) ValidateHelloMsgType

func (a *TimedHMACValidator) ValidateHelloMsgType(credentials any) error

type Validator

type Validator interface {
	Validate(any) error
	// Deprecated: Use Validate instead.
	ValidateHelloMsgType(any) error
}

Validator is an interface that defines the Validate method.