Documentation

Overview

Package apikey is a generated protocol buffer package.

The `apikey` template represents a single API key, which is used for authorization checks.

Example config:

```yaml apiVersion: "config.istio.io/v1alpha2" kind: apikey metadata:

name: validate-apikey
namespace: istio-system

spec:

api: api.service | ""
api_version: api.version | ""
api_operation: api.operation | ""
api_key: api.key | ""
timestamp: request.time

```

The `apikey` template represents a single API key, used to authorize API calls.

It is generated from these files:

mixer/template/apikey/template_handler_service.proto

It has these top-level messages:

HandleApiKeyRequest
InstanceMsg
Type
InstanceParam

Index

Constants

View Source
const TemplateName = "apikey"

Fully qualified name of the template

Variables

View Source
var (
	ErrInvalidLengthTemplateHandlerService = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowTemplateHandlerService   = fmt.Errorf("proto: integer overflow")
)

Functions

func RegisterHandleApiKeyServiceServer

func RegisterHandleApiKeyServiceServer(s *grpc.Server, srv HandleApiKeyServiceServer)

Types

type HandleApiKeyRequest

type HandleApiKeyRequest struct {
	// 'apikey' instance.
	Instance *InstanceMsg `protobuf:"bytes,1,opt,name=instance" json:"instance,omitempty"`
	// Adapter specific handler configuration.
	//
	// Note: Backends can also implement [InfrastructureBackend][https://istio.io/docs/reference/config/mixer/istio.mixer.adapter.model.v1beta1.html#InfrastructureBackend]
	// service and therefore opt to receive handler configuration during session creation through [InfrastructureBackend.CreateSession][TODO: Link to this fragment]
	// call. In that case, adapter_config will have type_url as 'google.protobuf.Any.type_url' and would contain string
	// value of session_id (returned from InfrastructureBackend.CreateSession).
	AdapterConfig *google_protobuf1.Any `protobuf:"bytes,2,opt,name=adapter_config,json=adapterConfig" json:"adapter_config,omitempty"`
	// Id to dedupe identical requests from Mixer.
	DedupId string `protobuf:"bytes,3,opt,name=dedup_id,json=dedupId,proto3" json:"dedup_id,omitempty"`
}

Request message for HandleApiKey method.

func (*HandleApiKeyRequest) Descriptor

func (*HandleApiKeyRequest) Descriptor() ([]byte, []int)

func (*HandleApiKeyRequest) Marshal

func (m *HandleApiKeyRequest) Marshal() (dAtA []byte, err error)

func (*HandleApiKeyRequest) MarshalTo

func (m *HandleApiKeyRequest) MarshalTo(dAtA []byte) (int, error)

func (*HandleApiKeyRequest) ProtoMessage

func (*HandleApiKeyRequest) ProtoMessage()

func (*HandleApiKeyRequest) Reset

func (m *HandleApiKeyRequest) Reset()

func (*HandleApiKeyRequest) Size

func (m *HandleApiKeyRequest) Size() (n int)

func (*HandleApiKeyRequest) String

func (this *HandleApiKeyRequest) String() string

func (*HandleApiKeyRequest) Unmarshal

func (m *HandleApiKeyRequest) Unmarshal(dAtA []byte) error

type HandleApiKeyServiceClient

type HandleApiKeyServiceClient interface {
	// HandleApiKey is called by Mixer at request-time to deliver 'apikey' instances to the backend.
	HandleApiKey(ctx context.Context, in *HandleApiKeyRequest, opts ...grpc.CallOption) (*istio_mixer_adapter_model_v1beta11.CheckResult, error)
}

func NewHandleApiKeyServiceClient

func NewHandleApiKeyServiceClient(cc *grpc.ClientConn) HandleApiKeyServiceClient

type HandleApiKeyServiceServer

type HandleApiKeyServiceServer interface {
	// HandleApiKey is called by Mixer at request-time to deliver 'apikey' instances to the backend.
	HandleApiKey(context.Context, *HandleApiKeyRequest) (*istio_mixer_adapter_model_v1beta11.CheckResult, error)
}

type Handler

type Handler interface {
	adapter.Handler

	// HandleApiKey is called by Mixer at request time to deliver instances to
	// to an adapter.
	HandleApiKey(context.Context, *Instance) (adapter.CheckResult, error)
}

Handler must be implemented by adapter code if it wants to process data associated with the 'apikey' template.

Mixer uses this interface to call into the adapter at request time in order to dispatch created instances to the adapter. Adapters take the incoming instances and do what they need to achieve their primary function.

The name of each instance can be used as a key into the Type map supplied to the adapter at configuration time via the method 'SetApiKeyTypes'. These Type associated with an instance describes the shape of the instance

type HandlerBuilder

type HandlerBuilder interface {
	adapter.HandlerBuilder

	// SetApiKeyTypes is invoked by Mixer to pass the template-specific Type information for instances that an adapter
	// may receive at runtime. The type information describes the shape of the instance.
	SetApiKeyTypes(map[string]*Type)
}

HandlerBuilder must be implemented by adapters if they want to process data associated with the 'apikey' template.

Mixer uses this interface to call into the adapter at configuration time to configure it with adapter-specific configuration as well as all template-specific type information.

type Instance

type Instance struct {
	// Name of the instance as specified in configuration.
	Name string

	// The API being called (api.service).
	Api string

	// The version of the API (api.version).
	ApiVersion string

	// The API operation is being called.
	ApiOperation string

	// API key used in API call.
	ApiKey string

	// Timestamp of API call.
	Timestamp time.Time
}

Instance is constructed by Mixer for the 'apikey' template.

The `apikey` template represents a single API key, used to authorize API calls.

type InstanceMsg

type InstanceMsg struct {
	// Name of the instance as specified in configuration.
	Name string `protobuf:"bytes,72295727,opt,name=name,proto3" json:"name,omitempty"`
	// The API being called (api.service).
	Api string `protobuf:"bytes,1,opt,name=api,proto3" json:"api,omitempty"`
	// The version of the API (api.version).
	ApiVersion string `protobuf:"bytes,2,opt,name=api_version,json=apiVersion,proto3" json:"api_version,omitempty"`
	// The API operation is being called.
	ApiOperation string `protobuf:"bytes,3,opt,name=api_operation,json=apiOperation,proto3" json:"api_operation,omitempty"`
	// API key used in API call.
	ApiKey string `protobuf:"bytes,4,opt,name=api_key,json=apiKey,proto3" json:"api_key,omitempty"`
	// Timestamp of API call.
	Timestamp *istio_policy_v1beta1.TimeStamp `protobuf:"bytes,5,opt,name=timestamp" json:"timestamp,omitempty"`
}

Contains instance payload for 'apikey' template. This is passed to infrastructure backends during request-time through HandleApiKeyService.HandleApiKey.

func (*InstanceMsg) Descriptor

func (*InstanceMsg) Descriptor() ([]byte, []int)

func (*InstanceMsg) Marshal

func (m *InstanceMsg) Marshal() (dAtA []byte, err error)

func (*InstanceMsg) MarshalTo

func (m *InstanceMsg) MarshalTo(dAtA []byte) (int, error)

func (*InstanceMsg) ProtoMessage

func (*InstanceMsg) ProtoMessage()

func (*InstanceMsg) Reset

func (m *InstanceMsg) Reset()

func (*InstanceMsg) Size

func (m *InstanceMsg) Size() (n int)

func (*InstanceMsg) String

func (this *InstanceMsg) String() string

func (*InstanceMsg) Unmarshal

func (m *InstanceMsg) Unmarshal(dAtA []byte) error

type InstanceParam

type InstanceParam struct {
	// The API being called (api.service).
	Api string `protobuf:"bytes,1,opt,name=api,proto3" json:"api,omitempty"`
	// The version of the API (api.version).
	ApiVersion string `protobuf:"bytes,2,opt,name=api_version,json=apiVersion,proto3" json:"api_version,omitempty"`
	// The API operation is being called.
	ApiOperation string `protobuf:"bytes,3,opt,name=api_operation,json=apiOperation,proto3" json:"api_operation,omitempty"`
	// API key used in API call.
	ApiKey string `protobuf:"bytes,4,opt,name=api_key,json=apiKey,proto3" json:"api_key,omitempty"`
	// Timestamp of API call.
	Timestamp string `protobuf:"bytes,5,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
}

Represents instance configuration schema for 'apikey' template.

func (*InstanceParam) Descriptor

func (*InstanceParam) Descriptor() ([]byte, []int)

func (*InstanceParam) Marshal

func (m *InstanceParam) Marshal() (dAtA []byte, err error)

func (*InstanceParam) MarshalTo

func (m *InstanceParam) MarshalTo(dAtA []byte) (int, error)

func (*InstanceParam) ProtoMessage

func (*InstanceParam) ProtoMessage()

func (*InstanceParam) Reset

func (m *InstanceParam) Reset()

func (*InstanceParam) Size

func (m *InstanceParam) Size() (n int)

func (*InstanceParam) String

func (this *InstanceParam) String() string

func (*InstanceParam) Unmarshal

func (m *InstanceParam) Unmarshal(dAtA []byte) error

type Type

type Type struct {
}

Contains inferred type information about specific instance of 'apikey' template. This is passed to infrastructure backends during configuration-time through [InfrastructureBackend.CreateSession][TODO: Link to this fragment].

func (*Type) Descriptor

func (*Type) Descriptor() ([]byte, []int)

func (*Type) Marshal

func (m *Type) Marshal() (dAtA []byte, err error)

func (*Type) MarshalTo

func (m *Type) MarshalTo(dAtA []byte) (int, error)

func (*Type) ProtoMessage

func (*Type) ProtoMessage()

func (*Type) Reset

func (m *Type) Reset()

func (*Type) Size

func (m *Type) Size() (n int)

func (*Type) String

func (this *Type) String() string

func (*Type) Unmarshal

func (m *Type) Unmarshal(dAtA []byte) error