tokenstore

package
v0.2.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 8, 2018 License: MIT Imports: 5 Imported by: 0

Documentation

Overview

Package tokenstore is a generated protocol buffer package.

It is generated from these files: 

tokenstore.proto

It has these top-level messages: 

Token
Tokens
TokenMsg
TokenStatusMsg
TokenPeriodRequest
UsageTimes
UserRequest
RpcStatus
RpcRequest
Validity

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func RegisterTSDaemonServer added in v0.2.0 

func RegisterTSDaemonServer(s *grpc.Server, srv TSDaemonServer)

func RegisterTokenStoreServer 

func RegisterTokenStoreServer(s *grpc.Server, srv TokenStoreServer)

Types

type RpcRequest added in v0.2.0 

type RpcRequest struct {
	Do bool `protobuf:"varint,1,opt,name=do" json:"do,omitempty"`
}

generic rpc request

func (*RpcRequest) Descriptor added in v0.2.0 

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

func (*RpcRequest) GetDo added in v0.2.0 

func (m *RpcRequest) GetDo() bool

func (*RpcRequest) ProtoMessage added in v0.2.0 

func (*RpcRequest) ProtoMessage()

func (*RpcRequest) Reset added in v0.2.0 

func (m *RpcRequest) Reset()

func (*RpcRequest) String added in v0.2.0 

func (m *RpcRequest) String() string

type RpcStatus 

type RpcStatus struct {
	Success bool `protobuf:"varint,1,opt,name=success" json:"success,omitempty"`
}

generic rpc call status

func (*RpcStatus) Descriptor 

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

func (*RpcStatus) GetSuccess 

func (m *RpcStatus) GetSuccess() bool

func (*RpcStatus) ProtoMessage 

func (*RpcStatus) ProtoMessage()

func (*RpcStatus) Reset 

func (m *RpcStatus) Reset()

func (*RpcStatus) String 

func (m *RpcStatus) String() string

type TSDaemonClient added in v0.2.0 

type TSDaemonClient interface {
	// check if token is valid
	CheckValidity(ctx context.Context, in *Token, opts ...grpc.CallOption) (*Validity, error)
}

func NewTSDaemonClient added in v0.2.0 

func NewTSDaemonClient(cc *grpc.ClientConn) TSDaemonClient

type TSDaemonServer added in v0.2.0 

type TSDaemonServer interface {
	// check if token is valid
	CheckValidity(context.Context, *Token) (*Validity, error)
}

type Token 

type Token struct {
	Id      string `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"`
	Service string `protobuf:"bytes,2,opt,name=service" json:"service,omitempty"`
}

Token is a message containing the ID.

func (*Token) Descriptor 

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

func (*Token) GetId 

func (m *Token) GetId() string

func (*Token) GetService added in v0.2.0 

func (m *Token) GetService() string

func (*Token) ProtoMessage 

func (*Token) ProtoMessage()

func (*Token) Reset 

func (m *Token) Reset()

func (*Token) String 

func (m *Token) String() string

type TokenMsg 

type TokenMsg struct {
	Id      string `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"`
	Limit   int32  `protobuf:"varint,2,opt,name=limit" json:"limit,omitempty"`
	Usage   int32  `protobuf:"varint,3,opt,name=usage" json:"usage,omitempty"`
	User    string `protobuf:"bytes,4,opt,name=user" json:"user,omitempty"`
	Service string `protobuf:"bytes,5,opt,name=service" json:"service,omitempty"`
	Rate    int32  `protobuf:"varint,6,opt,name=rate" json:"rate,omitempty"`
}

TokenMsg contains token ID and limit.

func (*TokenMsg) Descriptor 

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

func (*TokenMsg) GetId 

func (m *TokenMsg) GetId() string

func (*TokenMsg) GetLimit 

func (m *TokenMsg) GetLimit() int32

func (*TokenMsg) GetRate added in v0.2.0 

func (m *TokenMsg) GetRate() int32

func (*TokenMsg) GetService added in v0.2.0 

func (m *TokenMsg) GetService() string

func (*TokenMsg) GetUsage 

func (m *TokenMsg) GetUsage() int32

func (*TokenMsg) GetUser added in v0.2.0 

func (m *TokenMsg) GetUser() string

func (*TokenMsg) ProtoMessage 

func (*TokenMsg) ProtoMessage()

func (*TokenMsg) Reset 

func (m *TokenMsg) Reset()

func (*TokenMsg) String 

func (m *TokenMsg) String() string

type TokenPeriodRequest added in v0.2.0 

type TokenPeriodRequest struct {
	Id    string `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"`
	Start int64  `protobuf:"varint,2,opt,name=start" json:"start,omitempty"`
	End   int64  `protobuf:"varint,3,opt,name=end" json:"end,omitempty"`
}

TokenPeriodRequest contains the start and end times for the token of interest.

func (*TokenPeriodRequest) Descriptor added in v0.2.0 

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

func (*TokenPeriodRequest) GetEnd added in v0.2.0 

func (m *TokenPeriodRequest) GetEnd() int64

func (*TokenPeriodRequest) GetId added in v0.2.0 

func (m *TokenPeriodRequest) GetId() string

func (*TokenPeriodRequest) GetStart added in v0.2.0 

func (m *TokenPeriodRequest) GetStart() int64

func (*TokenPeriodRequest) ProtoMessage added in v0.2.0 

func (*TokenPeriodRequest) ProtoMessage()

func (*TokenPeriodRequest) Reset added in v0.2.0 

func (m *TokenPeriodRequest) Reset()

func (*TokenPeriodRequest) String added in v0.2.0 

func (m *TokenPeriodRequest) String() string

type TokenStatusMsg 

type TokenStatusMsg struct {
	Id      string `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"`
	Limit   int32  `protobuf:"varint,2,opt,name=limit" json:"limit,omitempty"`
	Usage   int32  `protobuf:"varint,3,opt,name=usage" json:"usage,omitempty"`
	Allowed bool   `protobuf:"varint,4,opt,name=allowed" json:"allowed,omitempty"`
}

TokenStatusMsg contains token ID, limit, and current usage.

func (*TokenStatusMsg) Descriptor 

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

func (*TokenStatusMsg) GetAllowed 

func (m *TokenStatusMsg) GetAllowed() bool

func (*TokenStatusMsg) GetId 

func (m *TokenStatusMsg) GetId() string

func (*TokenStatusMsg) GetLimit 

func (m *TokenStatusMsg) GetLimit() int32

func (*TokenStatusMsg) GetUsage 

func (m *TokenStatusMsg) GetUsage() int32

func (*TokenStatusMsg) ProtoMessage 

func (*TokenStatusMsg) ProtoMessage()

func (*TokenStatusMsg) Reset 

func (m *TokenStatusMsg) Reset()

func (*TokenStatusMsg) String 

func (m *TokenStatusMsg) String() string

type TokenStoreClient 

type TokenStoreClient interface {
	// add token to redis
	AddToken(ctx context.Context, in *TokenMsg, opts ...grpc.CallOption) (*RpcStatus, error)
	// regenerate existing token
	RegenToken(ctx context.Context, in *TokenMsg, opts ...grpc.CallOption) (*RpcStatus, error)
	// update limit on token
	UpdateLimit(ctx context.Context, in *TokenMsg, opts ...grpc.CallOption) (*RpcStatus, error)
	// update usage on token
	UpdateUsage(ctx context.Context, in *TokenMsg, opts ...grpc.CallOption) (*RpcStatus, error)
	// token status with limit and current usage
	TokenStatus(ctx context.Context, in *Token, opts ...grpc.CallOption) (*TokenStatusMsg, error)
	// increment the token current usage
	IncUsage(ctx context.Context, in *Token, opts ...grpc.CallOption) (*RpcStatus, error)
	// delete token
	DelToken(ctx context.Context, in *TokenMsg, opts ...grpc.CallOption) (*RpcStatus, error)
	// get all tokens
	GetAllTokens(ctx context.Context, in *RpcRequest, opts ...grpc.CallOption) (*Tokens, error)
	// token usage by time
	GetUsageTimes(ctx context.Context, in *TokenPeriodRequest, opts ...grpc.CallOption) (*UsageTimes, error)
	// tokens for given user
	GetUserTokens(ctx context.Context, in *UserRequest, opts ...grpc.CallOption) (*Tokens, error)
}

func NewTokenStoreClient 

func NewTokenStoreClient(cc *grpc.ClientConn) TokenStoreClient

type TokenStoreServer 

type TokenStoreServer interface {
	// add token to redis
	AddToken(context.Context, *TokenMsg) (*RpcStatus, error)
	// regenerate existing token
	RegenToken(context.Context, *TokenMsg) (*RpcStatus, error)
	// update limit on token
	UpdateLimit(context.Context, *TokenMsg) (*RpcStatus, error)
	// update usage on token
	UpdateUsage(context.Context, *TokenMsg) (*RpcStatus, error)
	// token status with limit and current usage
	TokenStatus(context.Context, *Token) (*TokenStatusMsg, error)
	// increment the token current usage
	IncUsage(context.Context, *Token) (*RpcStatus, error)
	// delete token
	DelToken(context.Context, *TokenMsg) (*RpcStatus, error)
	// get all tokens
	GetAllTokens(context.Context, *RpcRequest) (*Tokens, error)
	// token usage by time
	GetUsageTimes(context.Context, *TokenPeriodRequest) (*UsageTimes, error)
	// tokens for given user
	GetUserTokens(context.Context, *UserRequest) (*Tokens, error)
}

type Tokens added in v0.2.0 

type Tokens struct {
	Ids      []string `protobuf:"bytes,1,rep,name=ids" json:"ids,omitempty"`
	Services []string `protobuf:"bytes,2,rep,name=services" json:"services,omitempty"`
}

Tokens is a message containing multiple IDs

func (*Tokens) Descriptor added in v0.2.0 

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

func (*Tokens) GetIds added in v0.2.0 

func (m *Tokens) GetIds() []string

func (*Tokens) GetServices added in v0.2.0 

func (m *Tokens) GetServices() []string

func (*Tokens) ProtoMessage added in v0.2.0 

func (*Tokens) ProtoMessage()

func (*Tokens) Reset added in v0.2.0 

func (m *Tokens) Reset()

func (*Tokens) String added in v0.2.0 

func (m *Tokens) String() string

type UsageTimes added in v0.2.0 

type UsageTimes struct {
	Times []int64 `protobuf:"varint,1,rep,packed,name=times" json:"times,omitempty"`
}

UsageTimes contains the Unix times of when the token was used.

func (*UsageTimes) Descriptor added in v0.2.0 

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

func (*UsageTimes) GetTimes added in v0.2.0 

func (m *UsageTimes) GetTimes() []int64

func (*UsageTimes) ProtoMessage added in v0.2.0 

func (*UsageTimes) ProtoMessage()

func (*UsageTimes) Reset added in v0.2.0 

func (m *UsageTimes) Reset()

func (*UsageTimes) String added in v0.2.0 

func (m *UsageTimes) String() string

type UserRequest added in v0.2.0 

type UserRequest struct {
	User    string `protobuf:"bytes,1,opt,name=user" json:"user,omitempty"`
	Service string `protobuf:"bytes,2,opt,name=service" json:"service,omitempty"`
}

UserRequest contains user ID and optional service name.

func (*UserRequest) Descriptor added in v0.2.0 

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

func (*UserRequest) GetService added in v0.2.0 

func (m *UserRequest) GetService() string

func (*UserRequest) GetUser added in v0.2.0 

func (m *UserRequest) GetUser() string

func (*UserRequest) ProtoMessage added in v0.2.0 

func (*UserRequest) ProtoMessage()

func (*UserRequest) Reset added in v0.2.0 

func (m *UserRequest) Reset()

func (*UserRequest) String added in v0.2.0 

func (m *UserRequest) String() string

type Validity added in v0.2.0 

type Validity struct {
	Valid bool `protobuf:"varint,1,opt,name=valid" json:"valid,omitempty"`
}

Validity will return true if token is valid, false if not

func (*Validity) Descriptor added in v0.2.0 

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

func (*Validity) GetValid added in v0.2.0 

func (m *Validity) GetValid() bool

func (*Validity) ProtoMessage added in v0.2.0 

func (*Validity) ProtoMessage()

func (*Validity) Reset added in v0.2.0 

func (m *Validity) Reset()

func (*Validity) String added in v0.2.0 

func (m *Validity) String() string

Source Files

View all Source files

Directories

Path Synopsis
Package mock_pb is a generated GoMock package.
 Package mock_pb is a generated GoMock package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.