apikey

Documentation

Overview

Package apikey is a generated protocol buffer package.

It is generated from these files:

mixer/template/apikey/template_instance.proto

It has these top-level messages:

Type
InstanceParam

Index

• Constants
• Variables
• type Handler
• type HandlerBuilder
• type Instance
• type InstanceParam
  • func (*InstanceParam) Descriptor() ([]byte, []int)
  • func (this *InstanceParam) Equal(that interface{}) bool
  • func (m *InstanceParam) GetApi() string
  • func (m *InstanceParam) GetApiKey() string
  • func (m *InstanceParam) GetApiOperation() string
  • func (m *InstanceParam) GetApiVersion() string
  • func (m *InstanceParam) GetTimestamp() string
  • func (this *InstanceParam) GoString() string
  • func (m *InstanceParam) Marshal() (dAtA []byte, err error)
  • func (m *InstanceParam) MarshalTo(dAtA []byte) (int, error)
  • func (*InstanceParam) ProtoMessage()
  • func (m *InstanceParam) Reset()
  • func (m *InstanceParam) Size() (n int)
  • func (this *InstanceParam) String() string
  • func (m *InstanceParam) Unmarshal(dAtA []byte) error
• type Type
  • func (*Type) Descriptor() ([]byte, []int)
  • func (this *Type) Equal(that interface{}) bool
  • func (this *Type) GoString() string
  • func (m *Type) Marshal() (dAtA []byte, err error)
  • func (m *Type) MarshalTo(dAtA []byte) (int, error)
  • func (*Type) ProtoMessage()
  • func (m *Type) Reset()
  • func (m *Type) Size() (n int)
  • func (this *Type) String() string
  • func (m *Type) Unmarshal(dAtA []byte) error

Constants

const TemplateName = "apikey"

Fully qualified name of the template

Variables

var (
	ErrInvalidLengthTemplateInstance = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowTemplateInstance   = fmt.Errorf("proto: integer overflow")
)

Types

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.

Sample 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

```

type InstanceParam

type InstanceParam struct {
	Api          string `protobuf:"bytes,1,opt,name=api,proto3" json:"api,omitempty"`
	ApiVersion   string `protobuf:"bytes,2,opt,name=api_version,json=apiVersion,proto3" json:"api_version,omitempty"`
	ApiOperation string `protobuf:"bytes,3,opt,name=api_operation,json=apiOperation,proto3" json:"api_operation,omitempty"`
	ApiKey       string `protobuf:"bytes,4,opt,name=api_key,json=apiKey,proto3" json:"api_key,omitempty"`
	Timestamp    string `protobuf:"bytes,5,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
}

func (*InstanceParam) Descriptor

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

func (*InstanceParam) Equal

func (this *InstanceParam) Equal(that interface{}) bool

func (*InstanceParam) GetApi

func (m *InstanceParam) GetApi() string

func (*InstanceParam) GetApiKey

func (m *InstanceParam) GetApiKey() string

func (*InstanceParam) GetApiOperation

func (m *InstanceParam) GetApiOperation() string

func (*InstanceParam) GetApiVersion

func (m *InstanceParam) GetApiVersion() string

func (*InstanceParam) GetTimestamp

func (m *InstanceParam) GetTimestamp() string

func (*InstanceParam) GoString

func (this *InstanceParam) GoString() string

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 {
}

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

Sample 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

```

func (*Type) Descriptor

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

func (*Type) Equal

func (this *Type) Equal(that interface{}) bool

func (*Type) GoString

func (this *Type) GoString() string

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