Documentation ¶
Overview ¶
Package v1 is a reverse proxy.
It translates gRPC into RESTful JSON APIs.
Index ¶
- Variables
- func RegisterServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
- func RegisterServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client ServiceClient) error
- func RegisterServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
- func RegisterServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server ServiceServer) error
- func RegisterServiceServer(s grpc.ServiceRegistrar, srv ServiceServer)
- type AccessToken
- func (*AccessToken) Descriptor() ([]byte, []int)deprecated
- func (x *AccessToken) GetBearer() string
- func (x *AccessToken) GetPassword() *Password
- func (*AccessToken) ProtoMessage()
- func (x *AccessToken) ProtoReflect() protoreflect.Message
- func (x *AccessToken) Reset()
- func (x *AccessToken) String() string
- type GenerateAccessTokenRequest
- func (*GenerateAccessTokenRequest) Descriptor() ([]byte, []int)deprecated
- func (x *GenerateAccessTokenRequest) GetMeta() map[string]*anypb.Any
- func (*GenerateAccessTokenRequest) ProtoMessage()
- func (x *GenerateAccessTokenRequest) ProtoReflect() protoreflect.Message
- func (x *GenerateAccessTokenRequest) Reset()
- func (x *GenerateAccessTokenRequest) String() string
- type GenerateAccessTokenResponse
- func (*GenerateAccessTokenResponse) Descriptor() ([]byte, []int)deprecated
- func (x *GenerateAccessTokenResponse) GetMeta() map[string]*anypb.Any
- func (x *GenerateAccessTokenResponse) GetToken() *AccessToken
- func (*GenerateAccessTokenResponse) ProtoMessage()
- func (x *GenerateAccessTokenResponse) ProtoReflect() protoreflect.Message
- func (x *GenerateAccessTokenResponse) Reset()
- func (x *GenerateAccessTokenResponse) String() string
- type GenerateKeyRequest
- func (*GenerateKeyRequest) Descriptor() ([]byte, []int)deprecated
- func (x *GenerateKeyRequest) GetMeta() map[string]*anypb.Any
- func (*GenerateKeyRequest) ProtoMessage()
- func (x *GenerateKeyRequest) ProtoReflect() protoreflect.Message
- func (x *GenerateKeyRequest) Reset()
- func (x *GenerateKeyRequest) String() string
- type GenerateKeyResponse
- func (*GenerateKeyResponse) Descriptor() ([]byte, []int)deprecated
- func (x *GenerateKeyResponse) GetKey() *Key
- func (x *GenerateKeyResponse) GetMeta() map[string]*anypb.Any
- func (*GenerateKeyResponse) ProtoMessage()
- func (x *GenerateKeyResponse) ProtoReflect() protoreflect.Message
- func (x *GenerateKeyResponse) Reset()
- func (x *GenerateKeyResponse) String() string
- type GeneratePasswordRequest
- func (*GeneratePasswordRequest) Descriptor() ([]byte, []int)deprecated
- func (x *GeneratePasswordRequest) GetMeta() map[string]*anypb.Any
- func (*GeneratePasswordRequest) ProtoMessage()
- func (x *GeneratePasswordRequest) ProtoReflect() protoreflect.Message
- func (x *GeneratePasswordRequest) Reset()
- func (x *GeneratePasswordRequest) String() string
- type GeneratePasswordResponse
- func (*GeneratePasswordResponse) Descriptor() ([]byte, []int)deprecated
- func (x *GeneratePasswordResponse) GetMeta() map[string]*anypb.Any
- func (x *GeneratePasswordResponse) GetPassword() *Password
- func (*GeneratePasswordResponse) ProtoMessage()
- func (x *GeneratePasswordResponse) ProtoReflect() protoreflect.Message
- func (x *GeneratePasswordResponse) Reset()
- func (x *GeneratePasswordResponse) String() string
- type Key
- type Password
- type ServiceClient
- type ServiceServer
- type UnimplementedServiceServer
- func (UnimplementedServiceServer) GenerateAccessToken(context.Context, *GenerateAccessTokenRequest) (*GenerateAccessTokenResponse, error)
- func (UnimplementedServiceServer) GenerateKey(context.Context, *GenerateKeyRequest) (*GenerateKeyResponse, error)
- func (UnimplementedServiceServer) GeneratePassword(context.Context, *GeneratePasswordRequest) (*GeneratePasswordResponse, error)
- type UnsafeServiceServer
Constants ¶
This section is empty.
Variables ¶
var File_auth_v1_service_proto protoreflect.FileDescriptor
var Service_ServiceDesc = grpc.ServiceDesc{ ServiceName: "auth.v1.Service", HandlerType: (*ServiceServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "GeneratePassword", Handler: _Service_GeneratePassword_Handler, }, { MethodName: "GenerateKey", Handler: _Service_GenerateKey_Handler, }, { MethodName: "GenerateAccessToken", Handler: _Service_GenerateAccessToken_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "auth/v1/service.proto", }
Service_ServiceDesc is the grpc.ServiceDesc for Service service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterServiceHandler ¶
func RegisterServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
RegisterServiceHandler registers the http handlers for service Service to "mux". The handlers forward requests to the grpc endpoint over "conn".
func RegisterServiceHandlerClient ¶
func RegisterServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client ServiceClient) error
RegisterServiceHandlerClient registers the http handlers for service Service to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "ServiceClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "ServiceClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "ServiceClient" to call the correct interceptors.
func RegisterServiceHandlerFromEndpoint ¶
func RegisterServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)
RegisterServiceHandlerFromEndpoint is same as RegisterServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterServiceHandlerServer ¶
func RegisterServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server ServiceServer) error
RegisterServiceHandlerServer registers the http handlers for service Service to "mux". UnaryRPC :call ServiceServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterServiceHandlerFromEndpoint instead.
func RegisterServiceServer ¶
func RegisterServiceServer(s grpc.ServiceRegistrar, srv ServiceServer)
Types ¶
type AccessToken ¶ added in v1.5.0
type AccessToken struct { Bearer string `protobuf:"bytes,1,opt,name=bearer,proto3" json:"bearer,omitempty"` Password *Password `protobuf:"bytes,2,opt,name=password,proto3" json:"password,omitempty"` // contains filtered or unexported fields }
AccessToken with bearer and password.
func (*AccessToken) Descriptor
deprecated
added in
v1.5.0
func (*AccessToken) Descriptor() ([]byte, []int)
Deprecated: Use AccessToken.ProtoReflect.Descriptor instead.
func (*AccessToken) GetBearer ¶ added in v1.5.0
func (x *AccessToken) GetBearer() string
func (*AccessToken) GetPassword ¶ added in v1.5.0
func (x *AccessToken) GetPassword() *Password
func (*AccessToken) ProtoMessage ¶ added in v1.5.0
func (*AccessToken) ProtoMessage()
func (*AccessToken) ProtoReflect ¶ added in v1.5.0
func (x *AccessToken) ProtoReflect() protoreflect.Message
func (*AccessToken) Reset ¶ added in v1.5.0
func (x *AccessToken) Reset()
func (*AccessToken) String ¶ added in v1.5.0
func (x *AccessToken) String() string
type GenerateAccessTokenRequest ¶ added in v1.5.0
type GenerateAccessTokenRequest struct { Meta map[string]*anypb.Any `` /* 149-byte string literal not displayed */ // contains filtered or unexported fields }
GenerateAccessTokenRequest with meta.
func (*GenerateAccessTokenRequest) Descriptor
deprecated
added in
v1.5.0
func (*GenerateAccessTokenRequest) Descriptor() ([]byte, []int)
Deprecated: Use GenerateAccessTokenRequest.ProtoReflect.Descriptor instead.
func (*GenerateAccessTokenRequest) GetMeta ¶ added in v1.5.0
func (x *GenerateAccessTokenRequest) GetMeta() map[string]*anypb.Any
func (*GenerateAccessTokenRequest) ProtoMessage ¶ added in v1.5.0
func (*GenerateAccessTokenRequest) ProtoMessage()
func (*GenerateAccessTokenRequest) ProtoReflect ¶ added in v1.5.0
func (x *GenerateAccessTokenRequest) ProtoReflect() protoreflect.Message
func (*GenerateAccessTokenRequest) Reset ¶ added in v1.5.0
func (x *GenerateAccessTokenRequest) Reset()
func (*GenerateAccessTokenRequest) String ¶ added in v1.5.0
func (x *GenerateAccessTokenRequest) String() string
type GenerateAccessTokenResponse ¶ added in v1.5.0
type GenerateAccessTokenResponse struct { Meta map[string]*anypb.Any `` /* 149-byte string literal not displayed */ Token *AccessToken `protobuf:"bytes,2,opt,name=token,proto3" json:"token,omitempty"` // contains filtered or unexported fields }
GenerateAccessTokenResponse with meta and token.
func (*GenerateAccessTokenResponse) Descriptor
deprecated
added in
v1.5.0
func (*GenerateAccessTokenResponse) Descriptor() ([]byte, []int)
Deprecated: Use GenerateAccessTokenResponse.ProtoReflect.Descriptor instead.
func (*GenerateAccessTokenResponse) GetMeta ¶ added in v1.5.0
func (x *GenerateAccessTokenResponse) GetMeta() map[string]*anypb.Any
func (*GenerateAccessTokenResponse) GetToken ¶ added in v1.5.0
func (x *GenerateAccessTokenResponse) GetToken() *AccessToken
func (*GenerateAccessTokenResponse) ProtoMessage ¶ added in v1.5.0
func (*GenerateAccessTokenResponse) ProtoMessage()
func (*GenerateAccessTokenResponse) ProtoReflect ¶ added in v1.5.0
func (x *GenerateAccessTokenResponse) ProtoReflect() protoreflect.Message
func (*GenerateAccessTokenResponse) Reset ¶ added in v1.5.0
func (x *GenerateAccessTokenResponse) Reset()
func (*GenerateAccessTokenResponse) String ¶ added in v1.5.0
func (x *GenerateAccessTokenResponse) String() string
type GenerateKeyRequest ¶ added in v1.4.0
type GenerateKeyRequest struct { Meta map[string]*anypb.Any `` /* 149-byte string literal not displayed */ // contains filtered or unexported fields }
GenerateKeyRequest with meta.
func (*GenerateKeyRequest) Descriptor
deprecated
added in
v1.4.0
func (*GenerateKeyRequest) Descriptor() ([]byte, []int)
Deprecated: Use GenerateKeyRequest.ProtoReflect.Descriptor instead.
func (*GenerateKeyRequest) GetMeta ¶ added in v1.4.0
func (x *GenerateKeyRequest) GetMeta() map[string]*anypb.Any
func (*GenerateKeyRequest) ProtoMessage ¶ added in v1.4.0
func (*GenerateKeyRequest) ProtoMessage()
func (*GenerateKeyRequest) ProtoReflect ¶ added in v1.4.0
func (x *GenerateKeyRequest) ProtoReflect() protoreflect.Message
func (*GenerateKeyRequest) Reset ¶ added in v1.4.0
func (x *GenerateKeyRequest) Reset()
func (*GenerateKeyRequest) String ¶ added in v1.4.0
func (x *GenerateKeyRequest) String() string
type GenerateKeyResponse ¶ added in v1.4.0
type GenerateKeyResponse struct { Meta map[string]*anypb.Any `` /* 149-byte string literal not displayed */ Key *Key `protobuf:"bytes,2,opt,name=key,proto3" json:"key,omitempty"` // contains filtered or unexported fields }
GenerateKeyResponse with meta and key.
func (*GenerateKeyResponse) Descriptor
deprecated
added in
v1.4.0
func (*GenerateKeyResponse) Descriptor() ([]byte, []int)
Deprecated: Use GenerateKeyResponse.ProtoReflect.Descriptor instead.
func (*GenerateKeyResponse) GetKey ¶ added in v1.4.0
func (x *GenerateKeyResponse) GetKey() *Key
func (*GenerateKeyResponse) GetMeta ¶ added in v1.4.0
func (x *GenerateKeyResponse) GetMeta() map[string]*anypb.Any
func (*GenerateKeyResponse) ProtoMessage ¶ added in v1.4.0
func (*GenerateKeyResponse) ProtoMessage()
func (*GenerateKeyResponse) ProtoReflect ¶ added in v1.4.0
func (x *GenerateKeyResponse) ProtoReflect() protoreflect.Message
func (*GenerateKeyResponse) Reset ¶ added in v1.4.0
func (x *GenerateKeyResponse) Reset()
func (*GenerateKeyResponse) String ¶ added in v1.4.0
func (x *GenerateKeyResponse) String() string
type GeneratePasswordRequest ¶
type GeneratePasswordRequest struct { Meta map[string]*anypb.Any `` /* 149-byte string literal not displayed */ // contains filtered or unexported fields }
GeneratePasswordRequest with meta.
func (*GeneratePasswordRequest) Descriptor
deprecated
func (*GeneratePasswordRequest) Descriptor() ([]byte, []int)
Deprecated: Use GeneratePasswordRequest.ProtoReflect.Descriptor instead.
func (*GeneratePasswordRequest) GetMeta ¶
func (x *GeneratePasswordRequest) GetMeta() map[string]*anypb.Any
func (*GeneratePasswordRequest) ProtoMessage ¶
func (*GeneratePasswordRequest) ProtoMessage()
func (*GeneratePasswordRequest) ProtoReflect ¶
func (x *GeneratePasswordRequest) ProtoReflect() protoreflect.Message
func (*GeneratePasswordRequest) Reset ¶
func (x *GeneratePasswordRequest) Reset()
func (*GeneratePasswordRequest) String ¶
func (x *GeneratePasswordRequest) String() string
type GeneratePasswordResponse ¶
type GeneratePasswordResponse struct { Meta map[string]*anypb.Any `` /* 149-byte string literal not displayed */ Password *Password `protobuf:"bytes,2,opt,name=password,proto3" json:"password,omitempty"` // contains filtered or unexported fields }
GeneratePasswordResponse with meta and password.
func (*GeneratePasswordResponse) Descriptor
deprecated
func (*GeneratePasswordResponse) Descriptor() ([]byte, []int)
Deprecated: Use GeneratePasswordResponse.ProtoReflect.Descriptor instead.
func (*GeneratePasswordResponse) GetMeta ¶
func (x *GeneratePasswordResponse) GetMeta() map[string]*anypb.Any
func (*GeneratePasswordResponse) GetPassword ¶
func (x *GeneratePasswordResponse) GetPassword() *Password
func (*GeneratePasswordResponse) ProtoMessage ¶
func (*GeneratePasswordResponse) ProtoMessage()
func (*GeneratePasswordResponse) ProtoReflect ¶
func (x *GeneratePasswordResponse) ProtoReflect() protoreflect.Message
func (*GeneratePasswordResponse) Reset ¶
func (x *GeneratePasswordResponse) Reset()
func (*GeneratePasswordResponse) String ¶
func (x *GeneratePasswordResponse) String() string
type Key ¶ added in v1.4.0
type Key struct { Public string `protobuf:"bytes,1,opt,name=public,proto3" json:"public,omitempty"` Private string `protobuf:"bytes,2,opt,name=private,proto3" json:"private,omitempty"` // contains filtered or unexported fields }
Key with public and private.
func (*Key) Descriptor
deprecated
added in
v1.4.0
func (*Key) GetPrivate ¶ added in v1.4.0
func (*Key) ProtoMessage ¶ added in v1.4.0
func (*Key) ProtoMessage()
func (*Key) ProtoReflect ¶ added in v1.4.0
func (x *Key) ProtoReflect() protoreflect.Message
type Password ¶
type Password struct { Plain string `protobuf:"bytes,1,opt,name=plain,proto3" json:"plain,omitempty"` Hash string `protobuf:"bytes,2,opt,name=hash,proto3" json:"hash,omitempty"` // contains filtered or unexported fields }
Password with plain and hash.
func (*Password) Descriptor
deprecated
func (*Password) ProtoMessage ¶
func (*Password) ProtoMessage()
func (*Password) ProtoReflect ¶
func (x *Password) ProtoReflect() protoreflect.Message
type ServiceClient ¶
type ServiceClient interface { // GeneratePassword from meta. GeneratePassword(ctx context.Context, in *GeneratePasswordRequest, opts ...grpc.CallOption) (*GeneratePasswordResponse, error) // GeneratePassword from meta. GenerateKey(ctx context.Context, in *GenerateKeyRequest, opts ...grpc.CallOption) (*GenerateKeyResponse, error) // GenerateAccessToken from meta. GenerateAccessToken(ctx context.Context, in *GenerateAccessTokenRequest, opts ...grpc.CallOption) (*GenerateAccessTokenResponse, error) }
ServiceClient is the client API for Service service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewServiceClient ¶
func NewServiceClient(cc grpc.ClientConnInterface) ServiceClient
type ServiceServer ¶
type ServiceServer interface { // GeneratePassword from meta. GeneratePassword(context.Context, *GeneratePasswordRequest) (*GeneratePasswordResponse, error) // GeneratePassword from meta. GenerateKey(context.Context, *GenerateKeyRequest) (*GenerateKeyResponse, error) // GenerateAccessToken from meta. GenerateAccessToken(context.Context, *GenerateAccessTokenRequest) (*GenerateAccessTokenResponse, error) // contains filtered or unexported methods }
ServiceServer is the server API for Service service. All implementations must embed UnimplementedServiceServer for forward compatibility
type UnimplementedServiceServer ¶
type UnimplementedServiceServer struct { }
UnimplementedServiceServer must be embedded to have forward compatible implementations.
func (UnimplementedServiceServer) GenerateAccessToken ¶ added in v1.5.0
func (UnimplementedServiceServer) GenerateAccessToken(context.Context, *GenerateAccessTokenRequest) (*GenerateAccessTokenResponse, error)
func (UnimplementedServiceServer) GenerateKey ¶ added in v1.4.0
func (UnimplementedServiceServer) GenerateKey(context.Context, *GenerateKeyRequest) (*GenerateKeyResponse, error)
func (UnimplementedServiceServer) GeneratePassword ¶
func (UnimplementedServiceServer) GeneratePassword(context.Context, *GeneratePasswordRequest) (*GeneratePasswordResponse, error)
type UnsafeServiceServer ¶
type UnsafeServiceServer interface {
// contains filtered or unexported methods
}
UnsafeServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ServiceServer will result in compilation errors.