auth

Documentation

Overview

Package auth provides authentication.

Index

• func Authenticate(auths map[string]Authentication, obj *frame.HandshakeFrame) (metadata.M, bool)
• func Register(authentication Authentication)
• type Authentication
  • func GetAuth(name string) (Authentication, bool)
• type Credential
  • func NewCredential(payload string) *Credential
  • func (c *Credential) Name() string
  • func (c *Credential) Payload() string

Functions

func Authenticate

func Authenticate(auths map[string]Authentication, obj *frame.HandshakeFrame) (metadata.M, bool)

Authenticate finds an authentication way in `auths` and authenticates the Object.

If `auths` is nil or empty, It returns true, It think that authentication is not required.

func Register

func Register(authentication Authentication)

Register register authentication

Types

type Authentication

type Authentication interface {
	// Init authentication initialize arguments
	Init(args ...string)
	// Authenticate authentication client's credential
	Authenticate(payload string) (metadata.M, bool)
	// Name authentication name
	Name() string
}

Authentication for server

func GetAuth

func GetAuth(name string) (Authentication, bool)

GetAuth get authentication by name

type Credential

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

Credential client credential

func NewCredential

func NewCredential(payload string) *Credential

NewCredential create client credential

func (*Credential) Name

func (c *Credential) Name() string

Name client credential name

func (*Credential) Payload

func (c *Credential) Payload() string

Payload client credential payload