Documentation ¶
Overview ¶
Package oidc is a reverse proxy.
It translates gRPC into RESTful JSON APIs.
Index ¶
- Constants
- Variables
- func RegisterOIDCServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
- func RegisterOIDCServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client OIDCServiceClient) error
- func RegisterOIDCServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
- func RegisterOIDCServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server OIDCServiceServer) error
- func RegisterOIDCServiceServer(s grpc.ServiceRegistrar, srv OIDCServiceServer)
- type AuthenticateRequest
- func (*AuthenticateRequest) Descriptor() ([]byte, []int)deprecated
- func (this *AuthenticateRequest) EqualMessageVT(thatMsg proto.Message) bool
- func (this *AuthenticateRequest) EqualVT(that *AuthenticateRequest) bool
- func (x *AuthenticateRequest) GetAuthRequestId() string
- func (m *AuthenticateRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error)
- func (m *AuthenticateRequest) MarshalToVT(dAtA []byte) (int, error)
- func (m *AuthenticateRequest) MarshalVT() (dAtA []byte, err error)
- func (*AuthenticateRequest) ProtoMessage()
- func (x *AuthenticateRequest) ProtoReflect() protoreflect.Message
- func (x *AuthenticateRequest) Reset()
- func (m *AuthenticateRequest) SizeVT() (n int)
- func (x *AuthenticateRequest) String() string
- func (m *AuthenticateRequest) UnmarshalVT(dAtA []byte) error
- type AuthenticateResponse
- func (*AuthenticateResponse) Descriptor() ([]byte, []int)deprecated
- func (this *AuthenticateResponse) EqualMessageVT(thatMsg proto.Message) bool
- func (this *AuthenticateResponse) EqualVT(that *AuthenticateResponse) bool
- func (x *AuthenticateResponse) GetRedirectUrl() string
- func (m *AuthenticateResponse) MarshalToSizedBufferVT(dAtA []byte) (int, error)
- func (m *AuthenticateResponse) MarshalToVT(dAtA []byte) (int, error)
- func (m *AuthenticateResponse) MarshalVT() (dAtA []byte, err error)
- func (*AuthenticateResponse) ProtoMessage()
- func (x *AuthenticateResponse) ProtoReflect() protoreflect.Message
- func (x *AuthenticateResponse) Reset()
- func (m *AuthenticateResponse) SizeVT() (n int)
- func (x *AuthenticateResponse) String() string
- func (m *AuthenticateResponse) UnmarshalVT(dAtA []byte) error
- type OIDCServiceClient
- type OIDCServiceServer
- type UnimplementedOIDCServiceServer
- type UnsafeOIDCServiceServer
Constants ¶
const (
OIDCService_Authenticate_FullMethodName = "/oidc.OIDCService/Authenticate"
)
Variables ¶
var ( ErrInvalidLength = fmt.Errorf("proto: negative length found during unmarshaling") ErrIntOverflow = fmt.Errorf("proto: integer overflow") ErrUnexpectedEndOfGroup = fmt.Errorf("proto: unexpected end of group") )
var File_omni_oidc_oidc_proto protoreflect.FileDescriptor
var OIDCService_ServiceDesc = grpc.ServiceDesc{ ServiceName: "oidc.OIDCService", HandlerType: (*OIDCServiceServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "Authenticate", Handler: _OIDCService_Authenticate_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "omni/oidc/oidc.proto", }
OIDCService_ServiceDesc is the grpc.ServiceDesc for OIDCService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterOIDCServiceHandler ¶
func RegisterOIDCServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
RegisterOIDCServiceHandler registers the http handlers for service OIDCService to "mux". The handlers forward requests to the grpc endpoint over "conn".
func RegisterOIDCServiceHandlerClient ¶
func RegisterOIDCServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client OIDCServiceClient) error
RegisterOIDCServiceHandlerClient registers the http handlers for service OIDCService to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "OIDCServiceClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "OIDCServiceClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "OIDCServiceClient" to call the correct interceptors.
func RegisterOIDCServiceHandlerFromEndpoint ¶
func RegisterOIDCServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)
RegisterOIDCServiceHandlerFromEndpoint is same as RegisterOIDCServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterOIDCServiceHandlerServer ¶
func RegisterOIDCServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server OIDCServiceServer) error
RegisterOIDCServiceHandlerServer registers the http handlers for service OIDCService to "mux". UnaryRPC :call OIDCServiceServer 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 RegisterOIDCServiceHandlerFromEndpoint instead.
func RegisterOIDCServiceServer ¶
func RegisterOIDCServiceServer(s grpc.ServiceRegistrar, srv OIDCServiceServer)
Types ¶
type AuthenticateRequest ¶
type AuthenticateRequest struct { // Auth Request ID. AuthRequestId string `protobuf:"bytes,1,opt,name=auth_request_id,json=authRequestId,proto3" json:"auth_request_id,omitempty"` // contains filtered or unexported fields }
func (*AuthenticateRequest) Descriptor
deprecated
func (*AuthenticateRequest) Descriptor() ([]byte, []int)
Deprecated: Use AuthenticateRequest.ProtoReflect.Descriptor instead.
func (*AuthenticateRequest) EqualMessageVT ¶
func (this *AuthenticateRequest) EqualMessageVT(thatMsg proto.Message) bool
func (*AuthenticateRequest) EqualVT ¶
func (this *AuthenticateRequest) EqualVT(that *AuthenticateRequest) bool
func (*AuthenticateRequest) GetAuthRequestId ¶
func (x *AuthenticateRequest) GetAuthRequestId() string
func (*AuthenticateRequest) MarshalToSizedBufferVT ¶
func (m *AuthenticateRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error)
func (*AuthenticateRequest) MarshalToVT ¶
func (m *AuthenticateRequest) MarshalToVT(dAtA []byte) (int, error)
func (*AuthenticateRequest) MarshalVT ¶
func (m *AuthenticateRequest) MarshalVT() (dAtA []byte, err error)
func (*AuthenticateRequest) ProtoMessage ¶
func (*AuthenticateRequest) ProtoMessage()
func (*AuthenticateRequest) ProtoReflect ¶
func (x *AuthenticateRequest) ProtoReflect() protoreflect.Message
func (*AuthenticateRequest) Reset ¶
func (x *AuthenticateRequest) Reset()
func (*AuthenticateRequest) SizeVT ¶
func (m *AuthenticateRequest) SizeVT() (n int)
func (*AuthenticateRequest) String ¶
func (x *AuthenticateRequest) String() string
func (*AuthenticateRequest) UnmarshalVT ¶
func (m *AuthenticateRequest) UnmarshalVT(dAtA []byte) error
type AuthenticateResponse ¶
type AuthenticateResponse struct { // URL to redirect the user to. RedirectUrl string `protobuf:"bytes,1,opt,name=redirect_url,json=redirectUrl,proto3" json:"redirect_url,omitempty"` // contains filtered or unexported fields }
func (*AuthenticateResponse) Descriptor
deprecated
func (*AuthenticateResponse) Descriptor() ([]byte, []int)
Deprecated: Use AuthenticateResponse.ProtoReflect.Descriptor instead.
func (*AuthenticateResponse) EqualMessageVT ¶
func (this *AuthenticateResponse) EqualMessageVT(thatMsg proto.Message) bool
func (*AuthenticateResponse) EqualVT ¶
func (this *AuthenticateResponse) EqualVT(that *AuthenticateResponse) bool
func (*AuthenticateResponse) GetRedirectUrl ¶
func (x *AuthenticateResponse) GetRedirectUrl() string
func (*AuthenticateResponse) MarshalToSizedBufferVT ¶
func (m *AuthenticateResponse) MarshalToSizedBufferVT(dAtA []byte) (int, error)
func (*AuthenticateResponse) MarshalToVT ¶
func (m *AuthenticateResponse) MarshalToVT(dAtA []byte) (int, error)
func (*AuthenticateResponse) MarshalVT ¶
func (m *AuthenticateResponse) MarshalVT() (dAtA []byte, err error)
func (*AuthenticateResponse) ProtoMessage ¶
func (*AuthenticateResponse) ProtoMessage()
func (*AuthenticateResponse) ProtoReflect ¶
func (x *AuthenticateResponse) ProtoReflect() protoreflect.Message
func (*AuthenticateResponse) Reset ¶
func (x *AuthenticateResponse) Reset()
func (*AuthenticateResponse) SizeVT ¶
func (m *AuthenticateResponse) SizeVT() (n int)
func (*AuthenticateResponse) String ¶
func (x *AuthenticateResponse) String() string
func (*AuthenticateResponse) UnmarshalVT ¶
func (m *AuthenticateResponse) UnmarshalVT(dAtA []byte) error
type OIDCServiceClient ¶
type OIDCServiceClient interface { // Authenticate an OIDC auth request by ID. Authenticate(ctx context.Context, in *AuthenticateRequest, opts ...grpc.CallOption) (*AuthenticateResponse, error) }
OIDCServiceClient is the client API for OIDCService 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 NewOIDCServiceClient ¶
func NewOIDCServiceClient(cc grpc.ClientConnInterface) OIDCServiceClient
type OIDCServiceServer ¶
type OIDCServiceServer interface { // Authenticate an OIDC auth request by ID. Authenticate(context.Context, *AuthenticateRequest) (*AuthenticateResponse, error) // contains filtered or unexported methods }
OIDCServiceServer is the server API for OIDCService service. All implementations must embed UnimplementedOIDCServiceServer for forward compatibility
type UnimplementedOIDCServiceServer ¶
type UnimplementedOIDCServiceServer struct { }
UnimplementedOIDCServiceServer must be embedded to have forward compatible implementations.
func (UnimplementedOIDCServiceServer) Authenticate ¶
func (UnimplementedOIDCServiceServer) Authenticate(context.Context, *AuthenticateRequest) (*AuthenticateResponse, error)
type UnsafeOIDCServiceServer ¶
type UnsafeOIDCServiceServer interface {
// contains filtered or unexported methods
}
UnsafeOIDCServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to OIDCServiceServer will result in compilation errors.