auth

Documentation

Overview

Package auth contains the authentication system.

Index

• Constants
• type Error
  • func (e *Error) Error() string
• type Manager
  • func (m *Manager) Authenticate(req *Request) error
  • func (m *Manager) ReloadInternalUsers(u []conf.AuthInternalUser)
• type Protocol
• type Request

Constants

const (
	// PauseAfterError is the pause to apply after an authentication failure.
	PauseAfterError = 2 * time.Second
)

Types

type Error

type Error struct {
	Message        string
	AskCredentials bool
}

Error is a authentication error.

func (*Error) Error

func (e *Error) Error() string

Error implements the error interface.

type Manager

type Manager struct {
	Method          conf.AuthMethod
	InternalUsers   []conf.AuthInternalUser
	HTTPAddress     string
	HTTPExclude     []conf.AuthInternalUserPermission
	JWTJWKS         string
	JWTClaimKey     string
	ReadTimeout     time.Duration
	RTSPAuthMethods []auth.ValidateMethod
	// contains filtered or unexported fields
}

Manager is the authentication manager.

func (*Manager) Authenticate

func (m *Manager) Authenticate(req *Request) error

Authenticate authenticates a request.

func (*Manager) ReloadInternalUsers

func (m *Manager) ReloadInternalUsers(u []conf.AuthInternalUser)

ReloadInternalUsers reloads InternalUsers.

type Protocol

type Protocol string

Protocol is a protocol.

const (
	ProtocolRTSP   Protocol = "rtsp"
	ProtocolRTMP   Protocol = "rtmp"
	ProtocolHLS    Protocol = "hls"
	ProtocolWebRTC Protocol = "webrtc"
	ProtocolSRT    Protocol = "srt"
)

protocols.

type Request

type Request struct {
	User   string
	Pass   string
	IP     net.IP
	Action conf.AuthAction

	// only for ActionPublish, ActionRead, ActionPlayback
	Path     string
	Protocol Protocol
	ID       *uuid.UUID
	Query    string

	// RTSP only
	RTSPRequest *base.Request
	RTSPNonce   string

	// HTTP only
	HTTPRequest *http.Request
}

Request is an authentication request.