Documentation
¶
Index ¶
- Variables
- func RegisterAuthServiceServer(s grpc.ServiceRegistrar, srv AuthServiceServer)
- type AuthServiceClient
- type AuthServiceServer
- type GetChallengeInfoRequest
- func (*GetChallengeInfoRequest) Descriptor() ([]byte, []int)deprecated
- func (x *GetChallengeInfoRequest) GetId() string
- func (*GetChallengeInfoRequest) ProtoMessage()
- func (x *GetChallengeInfoRequest) ProtoReflect() protoreflect.Message
- func (x *GetChallengeInfoRequest) Reset()
- func (x *GetChallengeInfoRequest) String() string
- type GetChallengeInfoResponse
- func (*GetChallengeInfoResponse) Descriptor() ([]byte, []int)deprecated
- func (x *GetChallengeInfoResponse) GetEnv() map[string]string
- func (x *GetChallengeInfoResponse) GetUsername() string
- func (*GetChallengeInfoResponse) ProtoMessage()
- func (x *GetChallengeInfoResponse) ProtoReflect() protoreflect.Message
- func (x *GetChallengeInfoResponse) Reset()
- func (x *GetChallengeInfoResponse) String() string
- type IssueChallengeRequest
- func (*IssueChallengeRequest) Descriptor() ([]byte, []int)deprecated
- func (x *IssueChallengeRequest) GetUsername() string
- func (*IssueChallengeRequest) ProtoMessage()
- func (x *IssueChallengeRequest) ProtoReflect() protoreflect.Message
- func (x *IssueChallengeRequest) Reset()
- func (x *IssueChallengeRequest) String() string
- type IssueChallengeResponse
- func (*IssueChallengeResponse) Descriptor() ([]byte, []int)deprecated
- func (x *IssueChallengeResponse) GetId() string
- func (x *IssueChallengeResponse) GetUrl() string
- func (*IssueChallengeResponse) ProtoMessage()
- func (x *IssueChallengeResponse) ProtoReflect() protoreflect.Message
- func (x *IssueChallengeResponse) Reset()
- func (x *IssueChallengeResponse) String() string
- type UnimplementedAuthServiceServer
- func (UnimplementedAuthServiceServer) GetChallengeInfo(context.Context, *GetChallengeInfoRequest) (*GetChallengeInfoResponse, error)
- func (UnimplementedAuthServiceServer) IssueChallenge(context.Context, *IssueChallengeRequest) (*IssueChallengeResponse, error)
- func (UnimplementedAuthServiceServer) VerifyChallenge(context.Context, *VerifyChallengeRequest) (*VerifyChallengeResponse, error)
- type UnsafeAuthServiceServer
- type VerifyChallengeRequest
- func (*VerifyChallengeRequest) Descriptor() ([]byte, []int)deprecated
- func (x *VerifyChallengeRequest) GetId() string
- func (x *VerifyChallengeRequest) GetVerificationCode() string
- func (*VerifyChallengeRequest) ProtoMessage()
- func (x *VerifyChallengeRequest) ProtoReflect() protoreflect.Message
- func (x *VerifyChallengeRequest) Reset()
- func (x *VerifyChallengeRequest) String() string
- type VerifyChallengeResponse
- func (*VerifyChallengeResponse) Descriptor() ([]byte, []int)deprecated
- func (x *VerifyChallengeResponse) GetVerified() bool
- func (*VerifyChallengeResponse) ProtoMessage()
- func (x *VerifyChallengeResponse) ProtoReflect() protoreflect.Message
- func (x *VerifyChallengeResponse) Reset()
- func (x *VerifyChallengeResponse) String() string
Constants ¶
This section is empty.
Variables ¶
var AuthService_ServiceDesc = grpc.ServiceDesc{ ServiceName: "AuthService", HandlerType: (*AuthServiceServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "IssueChallenge", Handler: _AuthService_IssueChallenge_Handler, }, { MethodName: "VerifyChallenge", Handler: _AuthService_VerifyChallenge_Handler, }, { MethodName: "GetChallengeInfo", Handler: _AuthService_GetChallengeInfo_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "api/grpc.proto", }
AuthService_ServiceDesc is the grpc.ServiceDesc for AuthService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
var File_api_grpc_proto protoreflect.FileDescriptor
Functions ¶
func RegisterAuthServiceServer ¶
func RegisterAuthServiceServer(s grpc.ServiceRegistrar, srv AuthServiceServer)
Types ¶
type AuthServiceClient ¶
type AuthServiceClient interface {
// Issue a challenge for the user to verify its identity
IssueChallenge(ctx context.Context, in *IssueChallengeRequest, opts ...grpc.CallOption) (*IssueChallengeResponse, error)
// Verify a challenge
VerifyChallenge(ctx context.Context, in *VerifyChallengeRequest, opts ...grpc.CallOption) (*VerifyChallengeResponse, error)
// Get challenge information
GetChallengeInfo(ctx context.Context, in *GetChallengeInfoRequest, opts ...grpc.CallOption) (*GetChallengeInfoResponse, error)
}
AuthServiceClient is the client API for AuthService 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 NewAuthServiceClient ¶
func NewAuthServiceClient(cc grpc.ClientConnInterface) AuthServiceClient
type AuthServiceServer ¶
type AuthServiceServer interface {
// Issue a challenge for the user to verify its identity
IssueChallenge(context.Context, *IssueChallengeRequest) (*IssueChallengeResponse, error)
// Verify a challenge
VerifyChallenge(context.Context, *VerifyChallengeRequest) (*VerifyChallengeResponse, error)
// Get challenge information
GetChallengeInfo(context.Context, *GetChallengeInfoRequest) (*GetChallengeInfoResponse, error)
// contains filtered or unexported methods
}
AuthServiceServer is the server API for AuthService service. All implementations must embed UnimplementedAuthServiceServer for forward compatibility
type GetChallengeInfoRequest ¶
type GetChallengeInfoRequest struct {
// Identifier of the challenge to get info for
Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
// contains filtered or unexported fields
}
Request message for GetChallengeInfo method
func (*GetChallengeInfoRequest) Descriptor
deprecated
func (*GetChallengeInfoRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetChallengeInfoRequest.ProtoReflect.Descriptor instead.
func (*GetChallengeInfoRequest) GetId ¶
func (x *GetChallengeInfoRequest) GetId() string
func (*GetChallengeInfoRequest) ProtoMessage ¶
func (*GetChallengeInfoRequest) ProtoMessage()
func (*GetChallengeInfoRequest) ProtoReflect ¶
func (x *GetChallengeInfoRequest) ProtoReflect() protoreflect.Message
func (*GetChallengeInfoRequest) Reset ¶
func (x *GetChallengeInfoRequest) Reset()
func (*GetChallengeInfoRequest) String ¶
func (x *GetChallengeInfoRequest) String() string
type GetChallengeInfoResponse ¶
type GetChallengeInfoResponse struct {
// Environment variables for the challenge
Env map[string]string `` /* 147-byte string literal not displayed */
// Username of the user the challenge is for
Username string `protobuf:"bytes,2,opt,name=username,proto3" json:"username,omitempty"`
// contains filtered or unexported fields
}
Response message for GetChallengeInfo method
func (*GetChallengeInfoResponse) Descriptor
deprecated
func (*GetChallengeInfoResponse) Descriptor() ([]byte, []int)
Deprecated: Use GetChallengeInfoResponse.ProtoReflect.Descriptor instead.
func (*GetChallengeInfoResponse) GetEnv ¶
func (x *GetChallengeInfoResponse) GetEnv() map[string]string
func (*GetChallengeInfoResponse) GetUsername ¶
func (x *GetChallengeInfoResponse) GetUsername() string
func (*GetChallengeInfoResponse) ProtoMessage ¶
func (*GetChallengeInfoResponse) ProtoMessage()
func (*GetChallengeInfoResponse) ProtoReflect ¶
func (x *GetChallengeInfoResponse) ProtoReflect() protoreflect.Message
func (*GetChallengeInfoResponse) Reset ¶
func (x *GetChallengeInfoResponse) Reset()
func (*GetChallengeInfoResponse) String ¶
func (x *GetChallengeInfoResponse) String() string
type IssueChallengeRequest ¶
type IssueChallengeRequest struct {
// Username of the user the challenge is being issued for
Username string `protobuf:"bytes,1,opt,name=username,proto3" json:"username,omitempty"`
// contains filtered or unexported fields
}
Request message for IssueChallenge method
func (*IssueChallengeRequest) Descriptor
deprecated
func (*IssueChallengeRequest) Descriptor() ([]byte, []int)
Deprecated: Use IssueChallengeRequest.ProtoReflect.Descriptor instead.
func (*IssueChallengeRequest) GetUsername ¶
func (x *IssueChallengeRequest) GetUsername() string
func (*IssueChallengeRequest) ProtoMessage ¶
func (*IssueChallengeRequest) ProtoMessage()
func (*IssueChallengeRequest) ProtoReflect ¶
func (x *IssueChallengeRequest) ProtoReflect() protoreflect.Message
func (*IssueChallengeRequest) Reset ¶
func (x *IssueChallengeRequest) Reset()
func (*IssueChallengeRequest) String ¶
func (x *IssueChallengeRequest) String() string
type IssueChallengeResponse ¶
type IssueChallengeResponse struct {
// Arbitrary identifier for the challenge
Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
// The challenge URL
Url string `protobuf:"bytes,2,opt,name=url,proto3" json:"url,omitempty"`
// contains filtered or unexported fields
}
Response message for IssueChallenge method
func (*IssueChallengeResponse) Descriptor
deprecated
func (*IssueChallengeResponse) Descriptor() ([]byte, []int)
Deprecated: Use IssueChallengeResponse.ProtoReflect.Descriptor instead.
func (*IssueChallengeResponse) GetId ¶
func (x *IssueChallengeResponse) GetId() string
func (*IssueChallengeResponse) GetUrl ¶
func (x *IssueChallengeResponse) GetUrl() string
func (*IssueChallengeResponse) ProtoMessage ¶
func (*IssueChallengeResponse) ProtoMessage()
func (*IssueChallengeResponse) ProtoReflect ¶
func (x *IssueChallengeResponse) ProtoReflect() protoreflect.Message
func (*IssueChallengeResponse) Reset ¶
func (x *IssueChallengeResponse) Reset()
func (*IssueChallengeResponse) String ¶
func (x *IssueChallengeResponse) String() string
type UnimplementedAuthServiceServer ¶
type UnimplementedAuthServiceServer struct {
}
UnimplementedAuthServiceServer must be embedded to have forward compatible implementations.
func (UnimplementedAuthServiceServer) GetChallengeInfo ¶
func (UnimplementedAuthServiceServer) GetChallengeInfo(context.Context, *GetChallengeInfoRequest) (*GetChallengeInfoResponse, error)
func (UnimplementedAuthServiceServer) IssueChallenge ¶
func (UnimplementedAuthServiceServer) IssueChallenge(context.Context, *IssueChallengeRequest) (*IssueChallengeResponse, error)
func (UnimplementedAuthServiceServer) VerifyChallenge ¶
func (UnimplementedAuthServiceServer) VerifyChallenge(context.Context, *VerifyChallengeRequest) (*VerifyChallengeResponse, error)
type UnsafeAuthServiceServer ¶
type UnsafeAuthServiceServer interface {
// contains filtered or unexported methods
}
UnsafeAuthServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to AuthServiceServer will result in compilation errors.
type VerifyChallengeRequest ¶
type VerifyChallengeRequest struct {
// Identifier of the challenge to verify
Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
// Verification code sent to the user after completing the OAuth flow to verify the user
// attempting to login via the PAM module is the same user that completed the OAuth flow
VerificationCode string `protobuf:"bytes,2,opt,name=verificationCode,proto3" json:"verificationCode,omitempty"`
// contains filtered or unexported fields
}
Request message for VerifyChallenge method
func (*VerifyChallengeRequest) Descriptor
deprecated
func (*VerifyChallengeRequest) Descriptor() ([]byte, []int)
Deprecated: Use VerifyChallengeRequest.ProtoReflect.Descriptor instead.
func (*VerifyChallengeRequest) GetId ¶
func (x *VerifyChallengeRequest) GetId() string
func (*VerifyChallengeRequest) GetVerificationCode ¶
func (x *VerifyChallengeRequest) GetVerificationCode() string
func (*VerifyChallengeRequest) ProtoMessage ¶
func (*VerifyChallengeRequest) ProtoMessage()
func (*VerifyChallengeRequest) ProtoReflect ¶
func (x *VerifyChallengeRequest) ProtoReflect() protoreflect.Message
func (*VerifyChallengeRequest) Reset ¶
func (x *VerifyChallengeRequest) Reset()
func (*VerifyChallengeRequest) String ¶
func (x *VerifyChallengeRequest) String() string
type VerifyChallengeResponse ¶
type VerifyChallengeResponse struct {
// Whether the challenge was verified successfully
Verified bool `protobuf:"varint,1,opt,name=verified,proto3" json:"verified,omitempty"`
// contains filtered or unexported fields
}
Response message for VerifyChallenge method
func (*VerifyChallengeResponse) Descriptor
deprecated
func (*VerifyChallengeResponse) Descriptor() ([]byte, []int)
Deprecated: Use VerifyChallengeResponse.ProtoReflect.Descriptor instead.
func (*VerifyChallengeResponse) GetVerified ¶
func (x *VerifyChallengeResponse) GetVerified() bool
func (*VerifyChallengeResponse) ProtoMessage ¶
func (*VerifyChallengeResponse) ProtoMessage()
func (*VerifyChallengeResponse) ProtoReflect ¶
func (x *VerifyChallengeResponse) ProtoReflect() protoreflect.Message
func (*VerifyChallengeResponse) Reset ¶
func (x *VerifyChallengeResponse) Reset()
func (*VerifyChallengeResponse) String ¶
func (x *VerifyChallengeResponse) String() string