server

Documentation

Overview

Package server provides helpers for building and running a sansshell server.

Index

• func BuildServer(opts ...Option) (*grpc.Server, error)
• func Serve(hostport string, opts ...Option) error
• type Option
  • func WithAuthzHook(hook rpcauth.RPCAuthzHook) Option
  • func WithCredentials(c credentials.TransportCredentials) Option
  • func WithLogger(l logr.Logger) Option
  • func WithParsedPolicy(policy *opa.AuthzPolicy) Option
  • func WithPolicy(policy string) Option
  • func WithRawServerOption(s func(*grpc.Server)) Option
  • func WithStatsHandler(h stats.Handler) Option
  • func WithStreamInterceptor(stream grpc.StreamServerInterceptor) Option
  • func WithUnaryInterceptor(unary grpc.UnaryServerInterceptor) Option

Functions

func BuildServer

func BuildServer(opts ...Option) (*grpc.Server, error)

BuildServer creates a gRPC server, attaches the OPA policy interceptor with supplied args and then registers all of the imported SansShell modules. Separating this from Serve primarily facilitates testing.

func Serve

func Serve(hostport string, opts ...Option) error

Serve wraps up BuildServer in a succinct API for callers passing along various parameters. It will automatically add an authz hook for HostNet based on the listener address. Additional hooks are passed along after this one.

Types

type Option

type Option interface {
	// contains filtered or unexported methods
}

func WithAuthzHook

func WithAuthzHook(hook rpcauth.RPCAuthzHook) Option

WithAuthzHook adds an authz hook which is checked by the installed authorizer.

func WithCredentials

func WithCredentials(c credentials.TransportCredentials) Option

WithCredentials applies credentials to be used by the RPC server.

func WithLogger

func WithLogger(l logr.Logger) Option

WithLogger applies a logger that is used for all logging. A discard one is used if none is supplied.

func WithParsedPolicy

func WithParsedPolicy(policy *opa.AuthzPolicy) Option

WithParsedPolicy applies an already-parsed OPA policy used against incoming RPC requests.

func WithPolicy

func WithPolicy(policy string) Option

WithPolicy applies an OPA policy used against incoming RPC requests.

func WithRawServerOption

func WithRawServerOption(s func(*grpc.Server)) Option

WithRawServerOption allows one access to the RPC Server object. Generally this is done to add additional registration functions for RPC services to be done before starting the server.

func WithStatsHandler

func WithStatsHandler(h stats.Handler) Option

WithStatsHandler adds a stats handler for telemetry.

func WithStreamInterceptor

func WithStreamInterceptor(stream grpc.StreamServerInterceptor) Option

WithStreamInterceptor adds an additional stream interceptor installed after telemetry and authz.

func WithUnaryInterceptor

func WithUnaryInterceptor(unary grpc.UnaryServerInterceptor) Option

WithUnaryInterceptor adds an additional unary interceptor installed after telemetry and authz.