Documentation
¶
Index ¶
- Variables
- func RegisterAuthNServer(s *grpc.Server, srv AuthNServer)
- type AuthNClient
- type AuthNServer
- type ClientInfo
- func (*ClientInfo) Descriptor() ([]byte, []int)deprecated
- func (x *ClientInfo) GetDeviceInfo() *proto.DeviceInfo
- func (x *ClientInfo) GetRemoteZone() string
- func (x *ClientInfo) GetUnknown() bool
- func (*ClientInfo) ProtoMessage()
- func (x *ClientInfo) ProtoReflect() protoreflect.Message
- func (x *ClientInfo) Reset()
- func (x *ClientInfo) String() string
- type Log
- func (*Log) Descriptor() ([]byte, []int)deprecated
- func (x *Log) GetAuthenticatorId() *proto.AuthenticatorID
- func (x *Log) GetClientInfo() *ClientInfo
- func (x *Log) GetMechanism() Mechanism
- func (x *Log) GetService() string
- func (x *Log) GetSessionId() string
- func (x *Log) GetUserId() string
- func (x *Log) GetUsername() string
- func (*Log) ProtoMessage()
- func (x *Log) ProtoReflect() protoreflect.Message
- func (x *Log) Reset()
- func (x *Log) String() string
- type Mechanism
- type Request
- func (*Request) Descriptor() ([]byte, []int)deprecated
- func (x *Request) GetDeviceInfo() *proto.DeviceInfo
- func (x *Request) GetMechanism() Mechanism
- func (x *Request) GetOtp() string
- func (x *Request) GetPassword() string
- func (x *Request) GetRemoteAddr() string
- func (x *Request) GetService() string
- func (x *Request) GetSessionId() string
- func (x *Request) GetUsername() string
- func (r *Request) GetWebAuthnAssertion() (*protocol.ParsedCredentialAssertionData, error)
- func (x *Request) GetWebauthnEncodedAssertion() string
- func (x *Request) GetWebauthnSessionId() string
- func (*Request) ProtoMessage()
- func (x *Request) ProtoReflect() protoreflect.Message
- func (x *Request) Reset()
- func (x *Request) String() string
- type Response
- func (*Response) Descriptor() ([]byte, []int)deprecated
- func (x *Response) GetAuthenticatorId() *proto.AuthenticatorID
- func (x *Response) GetAvailableMechanisms() []Mechanism
- func (x *Response) GetForcedWorkflows() []string
- func (x *Response) GetMechanism() Mechanism
- func (x *Response) GetStatus() Response_Status
- func (x *Response) GetUserId() string
- func (x *Response) GetUserInfo() *proto.UserInfo
- func (x *Response) GetWebauthnEncodedAssertion() string
- func (x *Response) GetWebauthnSessionId() string
- func (*Response) ProtoMessage()
- func (x *Response) ProtoReflect() protoreflect.Message
- func (x *Response) Reset()
- func (x *Response) String() string
- func (r *Response) WithWebAuthnAssertion(assertionData *protocol.CredentialAssertion) *Response
- type Response_Status
- func (Response_Status) Descriptor() protoreflect.EnumDescriptor
- func (x Response_Status) Enum() *Response_Status
- func (Response_Status) EnumDescriptor() ([]byte, []int)deprecated
- func (x Response_Status) Number() protoreflect.EnumNumber
- func (x Response_Status) String() string
- func (Response_Status) Type() protoreflect.EnumType
- type UnimplementedAuthNServer
- type UnsafeAuthNServer
Constants ¶
This section is empty.
Variables ¶
var ( Mechanism_name = map[int32]string{ 0: "UNKNOWN_MECHANISM", 1: "PASSWORD", 2: "OTP", 3: "WEBAUTHN", 4: "RECOVERY_TOKEN", } Mechanism_value = map[string]int32{ "UNKNOWN_MECHANISM": 0, "PASSWORD": 1, "OTP": 2, "WEBAUTHN": 3, "RECOVERY_TOKEN": 4, } )
Enum value maps for Mechanism.
var ( Response_Status_name = map[int32]string{ 0: "STATUS_UNKNOWN", 1: "STATUS_ERROR", 2: "STATUS_INSUFFICIENT_CREDENTIALS", 3: "STATUS_OK", } Response_Status_value = map[string]int32{ "STATUS_UNKNOWN": 0, "STATUS_ERROR": 1, "STATUS_INSUFFICIENT_CREDENTIALS": 2, "STATUS_OK": 3, } )
Enum value maps for Response_Status.
var File_authn_proto_authn_proto protoreflect.FileDescriptor
Functions ¶
func RegisterAuthNServer ¶
func RegisterAuthNServer(s *grpc.Server, srv AuthNServer)
Types ¶
type AuthNClient ¶
type AuthNClient interface {
Authenticate(ctx context.Context, in *Request, opts ...grpc.CallOption) (*Response, error)
}
AuthNClient is the client API for AuthN 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 NewAuthNClient ¶
func NewAuthNClient(cc grpc.ClientConnInterface) AuthNClient
type AuthNServer ¶
type AuthNServer interface { Authenticate(context.Context, *Request) (*Response, error) // contains filtered or unexported methods }
AuthNServer is the server API for AuthN service. All implementations must embed UnimplementedAuthNServer for forward compatibility
type ClientInfo ¶
type ClientInfo struct { DeviceInfo *proto.DeviceInfo `protobuf:"bytes,1,opt,name=device_info,json=deviceInfo,proto3" json:"device_info,omitempty"` RemoteZone string `protobuf:"bytes,2,opt,name=remote_zone,json=remoteZone,proto3" json:"remote_zone,omitempty"` Unknown bool `protobuf:"varint,3,opt,name=unknown,proto3" json:"unknown,omitempty"` // contains filtered or unexported fields }
func (*ClientInfo) Descriptor
deprecated
func (*ClientInfo) Descriptor() ([]byte, []int)
Deprecated: Use ClientInfo.ProtoReflect.Descriptor instead.
func (*ClientInfo) GetDeviceInfo ¶
func (x *ClientInfo) GetDeviceInfo() *proto.DeviceInfo
func (*ClientInfo) GetRemoteZone ¶
func (x *ClientInfo) GetRemoteZone() string
func (*ClientInfo) GetUnknown ¶
func (x *ClientInfo) GetUnknown() bool
func (*ClientInfo) ProtoMessage ¶
func (*ClientInfo) ProtoMessage()
func (*ClientInfo) ProtoReflect ¶
func (x *ClientInfo) ProtoReflect() protoreflect.Message
func (*ClientInfo) Reset ¶
func (x *ClientInfo) Reset()
func (*ClientInfo) String ¶
func (x *ClientInfo) String() string
type Log ¶
type Log struct { UserId string `protobuf:"bytes,1,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"` Username string `protobuf:"bytes,2,opt,name=username,proto3" json:"username,omitempty"` Service string `protobuf:"bytes,3,opt,name=service,proto3" json:"service,omitempty"` SessionId string `protobuf:"bytes,4,opt,name=session_id,json=sessionId,proto3" json:"session_id,omitempty"` Mechanism Mechanism `protobuf:"varint,5,opt,name=mechanism,proto3,enum=authn.Mechanism" json:"mechanism,omitempty"` AuthenticatorId *proto.AuthenticatorID `protobuf:"bytes,6,opt,name=authenticator_id,json=authenticatorId,proto3" json:"authenticator_id,omitempty"` ClientInfo *ClientInfo `protobuf:"bytes,7,opt,name=client_info,json=clientInfo,proto3" json:"client_info,omitempty"` // contains filtered or unexported fields }
func (*Log) GetAuthenticatorId ¶
func (x *Log) GetAuthenticatorId() *proto.AuthenticatorID
func (*Log) GetClientInfo ¶
func (x *Log) GetClientInfo() *ClientInfo
func (*Log) ProtoReflect ¶
func (x *Log) ProtoReflect() protoreflect.Message
type Mechanism ¶
type Mechanism int32
func (Mechanism) Descriptor ¶
func (Mechanism) Descriptor() protoreflect.EnumDescriptor
func (Mechanism) Number ¶
func (x Mechanism) Number() protoreflect.EnumNumber
func (Mechanism) Type ¶
func (Mechanism) Type() protoreflect.EnumType
type Request ¶
type Request struct { Service string `protobuf:"bytes,1,opt,name=service,proto3" json:"service,omitempty"` Username string `protobuf:"bytes,2,opt,name=username,proto3" json:"username,omitempty"` Password string `protobuf:"bytes,3,opt,name=password,proto3" json:"password,omitempty"` Mechanism Mechanism `protobuf:"varint,4,opt,name=mechanism,proto3,enum=authn.Mechanism" json:"mechanism,omitempty"` Otp string `protobuf:"bytes,6,opt,name=otp,proto3" json:"otp,omitempty"` WebauthnSessionId string `protobuf:"bytes,7,opt,name=webauthn_session_id,json=webauthnSessionId,proto3" json:"webauthn_session_id,omitempty"` WebauthnEncodedAssertion string `` /* 135-byte string literal not displayed */ DeviceInfo *proto.DeviceInfo `protobuf:"bytes,9,opt,name=device_info,json=deviceInfo,proto3" json:"device_info,omitempty"` RemoteAddr string `protobuf:"bytes,10,opt,name=remote_addr,json=remoteAddr,proto3" json:"remote_addr,omitempty"` SessionId string `protobuf:"bytes,11,opt,name=session_id,json=sessionId,proto3" json:"session_id,omitempty"` // contains filtered or unexported fields }
func (*Request) GetDeviceInfo ¶
func (x *Request) GetDeviceInfo() *proto.DeviceInfo
func (*Request) GetWebAuthnAssertion ¶
func (r *Request) GetWebAuthnAssertion() (*protocol.ParsedCredentialAssertionData, error)
func (*Request) GetWebauthnEncodedAssertion ¶
func (*Request) ProtoReflect ¶
func (x *Request) ProtoReflect() protoreflect.Message
type Response ¶
type Response struct { Status Response_Status `protobuf:"varint,1,opt,name=status,proto3,enum=authn.Response_Status" json:"status,omitempty"` // Only set on STATUS_INSUFFICIENT_CREDENTIALS. AvailableMechanisms []Mechanism `` /* 147-byte string literal not displayed */ // Only set on STATUS_INSUFFICIENT_CREDENTIALS. WebauthnSessionId string `protobuf:"bytes,3,opt,name=webauthn_session_id,json=webauthnSessionId,proto3" json:"webauthn_session_id,omitempty"` WebauthnEncodedAssertion string `` /* 135-byte string literal not displayed */ // Only set on STATUS_OK. Mechanism Mechanism `protobuf:"varint,5,opt,name=mechanism,proto3,enum=authn.Mechanism" json:"mechanism,omitempty"` AuthenticatorId *proto.AuthenticatorID `protobuf:"bytes,6,opt,name=authenticator_id,json=authenticatorId,proto3" json:"authenticator_id,omitempty"` UserId string `protobuf:"bytes,7,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"` UserInfo *proto.UserInfo `protobuf:"bytes,8,opt,name=user_info,json=userInfo,proto3" json:"user_info,omitempty"` ForcedWorkflows []string `protobuf:"bytes,9,rep,name=forced_workflows,json=forcedWorkflows,proto3" json:"forced_workflows,omitempty"` // contains filtered or unexported fields }
func (*Response) GetAuthenticatorId ¶
func (x *Response) GetAuthenticatorId() *proto.AuthenticatorID
func (*Response) GetStatus ¶
func (x *Response) GetStatus() Response_Status
func (*Response) GetWebauthnEncodedAssertion ¶
func (*Response) ProtoReflect ¶
func (x *Response) ProtoReflect() protoreflect.Message
func (*Response) WithWebAuthnAssertion ¶
func (r *Response) WithWebAuthnAssertion(assertionData *protocol.CredentialAssertion) *Response
type Response_Status ¶
type Response_Status int32
const ( Response_STATUS_UNKNOWN Response_Status = 0 Response_STATUS_ERROR Response_Status = 1 Response_STATUS_INSUFFICIENT_CREDENTIALS Response_Status = 2 Response_STATUS_OK Response_Status = 3 )
func (Response_Status) Descriptor ¶
func (Response_Status) Descriptor() protoreflect.EnumDescriptor
func (Response_Status) Enum ¶
func (x Response_Status) Enum() *Response_Status
func (Response_Status) EnumDescriptor
deprecated
func (Response_Status) EnumDescriptor() ([]byte, []int)
Deprecated: Use Response_Status.Descriptor instead.
func (Response_Status) Number ¶
func (x Response_Status) Number() protoreflect.EnumNumber
func (Response_Status) String ¶
func (x Response_Status) String() string
func (Response_Status) Type ¶
func (Response_Status) Type() protoreflect.EnumType
type UnimplementedAuthNServer ¶
type UnimplementedAuthNServer struct { }
UnimplementedAuthNServer must be embedded to have forward compatible implementations.
type UnsafeAuthNServer ¶
type UnsafeAuthNServer interface {
// contains filtered or unexported methods
}
UnsafeAuthNServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to AuthNServer will result in compilation errors.