auth

Documentation

Overview

Package auth provides simple token based, stream authorization functions.

Index

• Variables
• func ClientInterceptor(token Token) grpc.UnaryClientInterceptor
• func ServerInterceptor(token Token) grpc.UnaryServerInterceptor
• func Write(s io.Writer, token Token) error
• type Token
  • func GenToken() Token

Variables

var (

	// ErrInvalidToken is returned by Check when the auth-token was not as
	// expected.
	ErrInvalidToken = fmt.Errorf("Invalid auth-token code")

	// NoAuth is the token used for authenticationless connections.
	NoAuth = Token("")
)

Functions

func ClientInterceptor

func ClientInterceptor(token Token) grpc.UnaryClientInterceptor

ClientInterceptor returns a grpc.UnaryClientInterceptor that adds the given auth token to outgoing RPC calls.

func ServerInterceptor

func ServerInterceptor(token Token) grpc.UnaryServerInterceptor

ServerInterceptor returns a grpc.UnaryServerInterceptor that checks incoming RPC calls for the given auth token.

func Write

func Write(s io.Writer, token Token) error

Write writes the authorization token to s.

Types

type Token

type Token string

Token is a secret password that must be sent on connection.

func GenToken

func GenToken() Token

GenToken returns a 8 character random token.