discharger

Documentation

Overview

Package discharger defines an interface for obtaining discharges for third-party caveats.

Index

• Variables
• func ErrorfNotAThirdPartyCaveat(ctx *context.T, format string, c security.Caveat) error
• func MessageNotAThirdPartyCaveat(ctx *context.T, message string, c security.Caveat) error
• func NewErrNotAThirdPartyCaveat(ctx *context.T, c security.Caveat) error
• func ParamsErrNotAThirdPartyCaveat(argumentError error) (verrorComponent string, verrorOperation string, c security.Caveat, ...)
• type DischargerClientMethods
• type DischargerClientStub
  • func DischargerClient(name string) DischargerClientStub
• type DischargerServerMethods
• type DischargerServerStub
  • func DischargerServer(impl DischargerServerMethods) DischargerServerStub
• type DischargerServerStubMethods

Variables

var DischargerDesc rpc.InterfaceDesc = descDischarger

DischargerDesc describes the Discharger interface.

var (

	// Indicates that the Caveat does not require a discharge
	ErrNotAThirdPartyCaveat = verror.NewIDAction("v.io/x/ref/services/discharger.NotAThirdPartyCaveat", verror.NoRetry)
)

Functions

func ErrorfNotAThirdPartyCaveat

func ErrorfNotAThirdPartyCaveat(ctx *context.T, format string, c security.Caveat) error

ErrorfNotAThirdPartyCaveat calls ErrNotAThirdPartyCaveat.Errorf with the supplied arguments.

func MessageNotAThirdPartyCaveat

func MessageNotAThirdPartyCaveat(ctx *context.T, message string, c security.Caveat) error

MessageNotAThirdPartyCaveat calls ErrNotAThirdPartyCaveat.Message with the supplied arguments.

func NewErrNotAThirdPartyCaveat

func NewErrNotAThirdPartyCaveat(ctx *context.T, c security.Caveat) error

NewErrNotAThirdPartyCaveat returns an error with the ErrNotAThirdPartyCaveat ID. Deprecated: this function will be removed in the future, use ErrorfNotAThirdPartyCaveat or MessageNotAThirdPartyCaveat instead.

func ParamsErrNotAThirdPartyCaveat

func ParamsErrNotAThirdPartyCaveat(argumentError error) (verrorComponent string, verrorOperation string, c security.Caveat, returnErr error)

ParamsErrNotAThirdPartyCaveat extracts the expected parameters from the error's ParameterList.

Types

type DischargerClientMethods

type DischargerClientMethods interface {
	// Discharge is called by a principal that holds a blessing with a third
	// party caveat and seeks to get a discharge that proves the fulfillment of
	// this caveat.
	Discharge(_ *context.T, Caveat security.Caveat, Impetus security.DischargeImpetus, _ ...rpc.CallOpt) (Discharge security.Discharge, _ error)
}

DischargerClientMethods is the client interface containing Discharger methods.

Discharger is the interface for obtaining discharges for ThirdPartyCaveats.

type DischargerClientStub

type DischargerClientStub interface {
	DischargerClientMethods
}

DischargerClientStub embeds DischargerClientMethods and is a placeholder for additional management operations.

func DischargerClient

func DischargerClient(name string) DischargerClientStub

DischargerClient returns a client stub for Discharger.

type DischargerServerMethods

type DischargerServerMethods interface {
	// Discharge is called by a principal that holds a blessing with a third
	// party caveat and seeks to get a discharge that proves the fulfillment of
	// this caveat.
	Discharge(_ *context.T, _ rpc.ServerCall, Caveat security.Caveat, Impetus security.DischargeImpetus) (Discharge security.Discharge, _ error)
}

DischargerServerMethods is the interface a server writer implements for Discharger.

Discharger is the interface for obtaining discharges for ThirdPartyCaveats.

type DischargerServerStub

type DischargerServerStub interface {
	DischargerServerStubMethods
	// DescribeInterfaces the Discharger interfaces.
	Describe__() []rpc.InterfaceDesc
}

DischargerServerStub adds universal methods to DischargerServerStubMethods.

func DischargerServer

func DischargerServer(impl DischargerServerMethods) DischargerServerStub

DischargerServer returns a server stub for Discharger. It converts an implementation of DischargerServerMethods into an object that may be used by rpc.Server.

type DischargerServerStubMethods

type DischargerServerStubMethods DischargerServerMethods

DischargerServerStubMethods is the server interface containing Discharger methods, as expected by rpc.Server. There is no difference between this interface and DischargerServerMethods since there are no streaming methods.