cluster

Documentation

Overview

Package cluster contains cluster authentication-related utilities.

Index

• Variables
• func Authorized(ctx context.Context) error
• func NewContext(ctx context.Context, err error) context.Context
• func VerifySource(ctx context.Context, validKeys [][]byte) context.Context

Examples

• Authorized

Variables

var (
	// AuthType used to identify components.
	AuthType = "ClusterKey"
)

Functions

func Authorized

func Authorized(ctx context.Context) error

Authorized returns whether the context has been identified as a cluster call. It panics if it does not inherit from `NewContext`.

Example

package main

import (
	"context"

	"github.com/aureliar8/ttn-fork/pkg/auth/cluster"
)

func main() {
	var ( // Assume this comes from a hypothetical inter-cluster RPC call.
		ctx context.Context
	)

	if err := cluster.Authorized(ctx); err != nil {
		// return err
	}
}

func NewContext

func NewContext(ctx context.Context, err error) context.Context

NewContext returns a context containing the cluster authentication result.

func VerifySource

func VerifySource(ctx context.Context, validKeys [][]byte) context.Context

VerifySource inspects whether the context contains one of the passed cluster keys, and returns a context containing the result.