Documentation
¶
Index ¶
- Constants
- Variables
- func RegisterAuthServer(s grpc.ServiceRegistrar, srv AuthServer)
- type AuthClient
- type AuthResponse
- type AuthServer
- type CheckUserAndKeyboardInteractiveRequest
- func (*CheckUserAndKeyboardInteractiveRequest) Descriptor() ([]byte, []int)deprecated
- func (x *CheckUserAndKeyboardInteractiveRequest) GetIp() string
- func (x *CheckUserAndKeyboardInteractiveRequest) GetProtocol() string
- func (x *CheckUserAndKeyboardInteractiveRequest) GetUser() []byte
- func (x *CheckUserAndKeyboardInteractiveRequest) GetUsername() string
- func (*CheckUserAndKeyboardInteractiveRequest) ProtoMessage()
- func (x *CheckUserAndKeyboardInteractiveRequest) ProtoReflect() protoreflect.Message
- func (x *CheckUserAndKeyboardInteractiveRequest) Reset()
- func (x *CheckUserAndKeyboardInteractiveRequest) String() string
- type CheckUserAndPassRequest
- func (*CheckUserAndPassRequest) Descriptor() ([]byte, []int)deprecated
- func (x *CheckUserAndPassRequest) GetIp() string
- func (x *CheckUserAndPassRequest) GetPassword() string
- func (x *CheckUserAndPassRequest) GetProtocol() string
- func (x *CheckUserAndPassRequest) GetUser() []byte
- func (x *CheckUserAndPassRequest) GetUsername() string
- func (*CheckUserAndPassRequest) ProtoMessage()
- func (x *CheckUserAndPassRequest) ProtoReflect() protoreflect.Message
- func (x *CheckUserAndPassRequest) Reset()
- func (x *CheckUserAndPassRequest) String() string
- type CheckUserAndPublicKeyRequest
- func (*CheckUserAndPublicKeyRequest) Descriptor() ([]byte, []int)deprecated
- func (x *CheckUserAndPublicKeyRequest) GetIp() string
- func (x *CheckUserAndPublicKeyRequest) GetProtocol() string
- func (x *CheckUserAndPublicKeyRequest) GetPubKey() string
- func (x *CheckUserAndPublicKeyRequest) GetUser() []byte
- func (x *CheckUserAndPublicKeyRequest) GetUsername() string
- func (*CheckUserAndPublicKeyRequest) ProtoMessage()
- func (x *CheckUserAndPublicKeyRequest) ProtoReflect() protoreflect.Message
- func (x *CheckUserAndPublicKeyRequest) Reset()
- func (x *CheckUserAndPublicKeyRequest) String() string
- type CheckUserAndTLSCertRequest
- func (*CheckUserAndTLSCertRequest) Descriptor() ([]byte, []int)deprecated
- func (x *CheckUserAndTLSCertRequest) GetIp() string
- func (x *CheckUserAndTLSCertRequest) GetProtocol() string
- func (x *CheckUserAndTLSCertRequest) GetTlsCert() string
- func (x *CheckUserAndTLSCertRequest) GetUser() []byte
- func (x *CheckUserAndTLSCertRequest) GetUsername() string
- func (*CheckUserAndTLSCertRequest) ProtoMessage()
- func (x *CheckUserAndTLSCertRequest) ProtoReflect() protoreflect.Message
- func (x *CheckUserAndTLSCertRequest) Reset()
- func (x *CheckUserAndTLSCertRequest) String() string
- type KeyboardAuthRequest
- func (*KeyboardAuthRequest) Descriptor() ([]byte, []int)deprecated
- func (x *KeyboardAuthRequest) GetAnswers() []string
- func (x *KeyboardAuthRequest) GetIp() string
- func (x *KeyboardAuthRequest) GetPassword() string
- func (x *KeyboardAuthRequest) GetQuestions() []string
- func (x *KeyboardAuthRequest) GetRequestID() string
- func (x *KeyboardAuthRequest) GetStep() int32
- func (x *KeyboardAuthRequest) GetUsername() string
- func (*KeyboardAuthRequest) ProtoMessage()
- func (x *KeyboardAuthRequest) ProtoReflect() protoreflect.Message
- func (x *KeyboardAuthRequest) Reset()
- func (x *KeyboardAuthRequest) String() string
- type KeyboardAuthResponse
- func (*KeyboardAuthResponse) Descriptor() ([]byte, []int)deprecated
- func (x *KeyboardAuthResponse) GetAuthResult() int32
- func (x *KeyboardAuthResponse) GetCheckPassword() int32
- func (x *KeyboardAuthResponse) GetEchos() []bool
- func (x *KeyboardAuthResponse) GetInstructions() string
- func (x *KeyboardAuthResponse) GetQuestions() []string
- func (*KeyboardAuthResponse) ProtoMessage()
- func (x *KeyboardAuthResponse) ProtoReflect() protoreflect.Message
- func (x *KeyboardAuthResponse) Reset()
- func (x *KeyboardAuthResponse) String() string
- type UnimplementedAuthServer
- func (UnimplementedAuthServer) CheckUserAndKeyboardInteractive(context.Context, *CheckUserAndKeyboardInteractiveRequest) (*AuthResponse, error)
- func (UnimplementedAuthServer) CheckUserAndPass(context.Context, *CheckUserAndPassRequest) (*AuthResponse, error)
- func (UnimplementedAuthServer) CheckUserAndPublicKey(context.Context, *CheckUserAndPublicKeyRequest) (*AuthResponse, error)
- func (UnimplementedAuthServer) CheckUserAndTLSCert(context.Context, *CheckUserAndTLSCertRequest) (*AuthResponse, error)
- func (UnimplementedAuthServer) SendKeyboardAuthRequest(context.Context, *KeyboardAuthRequest) (*KeyboardAuthResponse, error)
- type UnsafeAuthServer
Constants ¶
const ( Auth_CheckUserAndPass_FullMethodName = "/proto.Auth/CheckUserAndPass" Auth_CheckUserAndTLSCert_FullMethodName = "/proto.Auth/CheckUserAndTLSCert" Auth_CheckUserAndPublicKey_FullMethodName = "/proto.Auth/CheckUserAndPublicKey" Auth_CheckUserAndKeyboardInteractive_FullMethodName = "/proto.Auth/CheckUserAndKeyboardInteractive" Auth_SendKeyboardAuthRequest_FullMethodName = "/proto.Auth/SendKeyboardAuthRequest" )
Variables ¶
var Auth_ServiceDesc = grpc.ServiceDesc{ ServiceName: "proto.Auth", HandlerType: (*AuthServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "CheckUserAndPass", Handler: _Auth_CheckUserAndPass_Handler, }, { MethodName: "CheckUserAndTLSCert", Handler: _Auth_CheckUserAndTLSCert_Handler, }, { MethodName: "CheckUserAndPublicKey", Handler: _Auth_CheckUserAndPublicKey_Handler, }, { MethodName: "CheckUserAndKeyboardInteractive", Handler: _Auth_CheckUserAndKeyboardInteractive_Handler, }, { MethodName: "SendKeyboardAuthRequest", Handler: _Auth_SendKeyboardAuthRequest_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "proto/auth.proto", }
Auth_ServiceDesc is the grpc.ServiceDesc for Auth service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
var File_proto_auth_proto protoreflect.FileDescriptor
Functions ¶
func RegisterAuthServer ¶
func RegisterAuthServer(s grpc.ServiceRegistrar, srv AuthServer)
Types ¶
type AuthClient ¶
type AuthClient interface {
CheckUserAndPass(ctx context.Context, in *CheckUserAndPassRequest, opts ...grpc.CallOption) (*AuthResponse, error)
CheckUserAndTLSCert(ctx context.Context, in *CheckUserAndTLSCertRequest, opts ...grpc.CallOption) (*AuthResponse, error)
CheckUserAndPublicKey(ctx context.Context, in *CheckUserAndPublicKeyRequest, opts ...grpc.CallOption) (*AuthResponse, error)
CheckUserAndKeyboardInteractive(ctx context.Context, in *CheckUserAndKeyboardInteractiveRequest, opts ...grpc.CallOption) (*AuthResponse, error)
SendKeyboardAuthRequest(ctx context.Context, in *KeyboardAuthRequest, opts ...grpc.CallOption) (*KeyboardAuthResponse, error)
}
AuthClient is the client API for Auth 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 NewAuthClient ¶
func NewAuthClient(cc grpc.ClientConnInterface) AuthClient
type AuthResponse ¶
type AuthResponse struct {
User []byte `protobuf:"bytes,1,opt,name=user,proto3" json:"user,omitempty"` // SFTPGo user JSON serialized
// contains filtered or unexported fields
}
func (*AuthResponse) Descriptor
deprecated
func (*AuthResponse) Descriptor() ([]byte, []int)
Deprecated: Use AuthResponse.ProtoReflect.Descriptor instead.
func (*AuthResponse) GetUser ¶
func (x *AuthResponse) GetUser() []byte
func (*AuthResponse) ProtoMessage ¶
func (*AuthResponse) ProtoMessage()
func (*AuthResponse) ProtoReflect ¶
func (x *AuthResponse) ProtoReflect() protoreflect.Message
func (*AuthResponse) Reset ¶
func (x *AuthResponse) Reset()
func (*AuthResponse) String ¶
func (x *AuthResponse) String() string
type AuthServer ¶
type AuthServer interface {
CheckUserAndPass(context.Context, *CheckUserAndPassRequest) (*AuthResponse, error)
CheckUserAndTLSCert(context.Context, *CheckUserAndTLSCertRequest) (*AuthResponse, error)
CheckUserAndPublicKey(context.Context, *CheckUserAndPublicKeyRequest) (*AuthResponse, error)
CheckUserAndKeyboardInteractive(context.Context, *CheckUserAndKeyboardInteractiveRequest) (*AuthResponse, error)
SendKeyboardAuthRequest(context.Context, *KeyboardAuthRequest) (*KeyboardAuthResponse, error)
}
AuthServer is the server API for Auth service. All implementations should embed UnimplementedAuthServer for forward compatibility
type CheckUserAndKeyboardInteractiveRequest ¶
type CheckUserAndKeyboardInteractiveRequest struct {
Username string `protobuf:"bytes,1,opt,name=username,proto3" json:"username,omitempty"`
Ip string `protobuf:"bytes,2,opt,name=ip,proto3" json:"ip,omitempty"`
Protocol string `protobuf:"bytes,3,opt,name=protocol,proto3" json:"protocol,omitempty"`
User []byte `protobuf:"bytes,4,opt,name=user,proto3" json:"user,omitempty"` // SFTPGo user JSON serialized
// contains filtered or unexported fields
}
func (*CheckUserAndKeyboardInteractiveRequest) Descriptor
deprecated
func (*CheckUserAndKeyboardInteractiveRequest) Descriptor() ([]byte, []int)
Deprecated: Use CheckUserAndKeyboardInteractiveRequest.ProtoReflect.Descriptor instead.
func (*CheckUserAndKeyboardInteractiveRequest) GetIp ¶
func (x *CheckUserAndKeyboardInteractiveRequest) GetIp() string
func (*CheckUserAndKeyboardInteractiveRequest) GetProtocol ¶
func (x *CheckUserAndKeyboardInteractiveRequest) GetProtocol() string
func (*CheckUserAndKeyboardInteractiveRequest) GetUser ¶
func (x *CheckUserAndKeyboardInteractiveRequest) GetUser() []byte
func (*CheckUserAndKeyboardInteractiveRequest) GetUsername ¶
func (x *CheckUserAndKeyboardInteractiveRequest) GetUsername() string
func (*CheckUserAndKeyboardInteractiveRequest) ProtoMessage ¶
func (*CheckUserAndKeyboardInteractiveRequest) ProtoMessage()
func (*CheckUserAndKeyboardInteractiveRequest) ProtoReflect ¶
func (x *CheckUserAndKeyboardInteractiveRequest) ProtoReflect() protoreflect.Message
func (*CheckUserAndKeyboardInteractiveRequest) Reset ¶
func (x *CheckUserAndKeyboardInteractiveRequest) Reset()
func (*CheckUserAndKeyboardInteractiveRequest) String ¶
func (x *CheckUserAndKeyboardInteractiveRequest) String() string
type CheckUserAndPassRequest ¶
type CheckUserAndPassRequest struct {
Username string `protobuf:"bytes,1,opt,name=username,proto3" json:"username,omitempty"`
Password string `protobuf:"bytes,2,opt,name=password,proto3" json:"password,omitempty"`
Ip string `protobuf:"bytes,3,opt,name=ip,proto3" json:"ip,omitempty"`
Protocol string `protobuf:"bytes,4,opt,name=protocol,proto3" json:"protocol,omitempty"`
User []byte `protobuf:"bytes,5,opt,name=user,proto3" json:"user,omitempty"` // SFTPGo user JSON serialized
// contains filtered or unexported fields
}
func (*CheckUserAndPassRequest) Descriptor
deprecated
func (*CheckUserAndPassRequest) Descriptor() ([]byte, []int)
Deprecated: Use CheckUserAndPassRequest.ProtoReflect.Descriptor instead.
func (*CheckUserAndPassRequest) GetIp ¶
func (x *CheckUserAndPassRequest) GetIp() string
func (*CheckUserAndPassRequest) GetPassword ¶
func (x *CheckUserAndPassRequest) GetPassword() string
func (*CheckUserAndPassRequest) GetProtocol ¶
func (x *CheckUserAndPassRequest) GetProtocol() string
func (*CheckUserAndPassRequest) GetUser ¶
func (x *CheckUserAndPassRequest) GetUser() []byte
func (*CheckUserAndPassRequest) GetUsername ¶
func (x *CheckUserAndPassRequest) GetUsername() string
func (*CheckUserAndPassRequest) ProtoMessage ¶
func (*CheckUserAndPassRequest) ProtoMessage()
func (*CheckUserAndPassRequest) ProtoReflect ¶
func (x *CheckUserAndPassRequest) ProtoReflect() protoreflect.Message
func (*CheckUserAndPassRequest) Reset ¶
func (x *CheckUserAndPassRequest) Reset()
func (*CheckUserAndPassRequest) String ¶
func (x *CheckUserAndPassRequest) String() string
type CheckUserAndPublicKeyRequest ¶
type CheckUserAndPublicKeyRequest struct {
Username string `protobuf:"bytes,1,opt,name=username,proto3" json:"username,omitempty"`
PubKey string `protobuf:"bytes,2,opt,name=pubKey,proto3" json:"pubKey,omitempty"`
Ip string `protobuf:"bytes,3,opt,name=ip,proto3" json:"ip,omitempty"`
Protocol string `protobuf:"bytes,4,opt,name=protocol,proto3" json:"protocol,omitempty"`
User []byte `protobuf:"bytes,5,opt,name=user,proto3" json:"user,omitempty"` // SFTPGo user JSON serialized
// contains filtered or unexported fields
}
func (*CheckUserAndPublicKeyRequest) Descriptor
deprecated
func (*CheckUserAndPublicKeyRequest) Descriptor() ([]byte, []int)
Deprecated: Use CheckUserAndPublicKeyRequest.ProtoReflect.Descriptor instead.
func (*CheckUserAndPublicKeyRequest) GetIp ¶
func (x *CheckUserAndPublicKeyRequest) GetIp() string
func (*CheckUserAndPublicKeyRequest) GetProtocol ¶
func (x *CheckUserAndPublicKeyRequest) GetProtocol() string
func (*CheckUserAndPublicKeyRequest) GetPubKey ¶
func (x *CheckUserAndPublicKeyRequest) GetPubKey() string
func (*CheckUserAndPublicKeyRequest) GetUser ¶
func (x *CheckUserAndPublicKeyRequest) GetUser() []byte
func (*CheckUserAndPublicKeyRequest) GetUsername ¶
func (x *CheckUserAndPublicKeyRequest) GetUsername() string
func (*CheckUserAndPublicKeyRequest) ProtoMessage ¶
func (*CheckUserAndPublicKeyRequest) ProtoMessage()
func (*CheckUserAndPublicKeyRequest) ProtoReflect ¶
func (x *CheckUserAndPublicKeyRequest) ProtoReflect() protoreflect.Message
func (*CheckUserAndPublicKeyRequest) Reset ¶
func (x *CheckUserAndPublicKeyRequest) Reset()
func (*CheckUserAndPublicKeyRequest) String ¶
func (x *CheckUserAndPublicKeyRequest) String() string
type CheckUserAndTLSCertRequest ¶
type CheckUserAndTLSCertRequest struct {
Username string `protobuf:"bytes,1,opt,name=username,proto3" json:"username,omitempty"`
TlsCert string `protobuf:"bytes,2,opt,name=tlsCert,proto3" json:"tlsCert,omitempty"` // tls certificate pem encoded
Ip string `protobuf:"bytes,3,opt,name=ip,proto3" json:"ip,omitempty"`
Protocol string `protobuf:"bytes,4,opt,name=protocol,proto3" json:"protocol,omitempty"`
User []byte `protobuf:"bytes,5,opt,name=user,proto3" json:"user,omitempty"` // SFTPGo user JSON serialized
// contains filtered or unexported fields
}
func (*CheckUserAndTLSCertRequest) Descriptor
deprecated
func (*CheckUserAndTLSCertRequest) Descriptor() ([]byte, []int)
Deprecated: Use CheckUserAndTLSCertRequest.ProtoReflect.Descriptor instead.
func (*CheckUserAndTLSCertRequest) GetIp ¶
func (x *CheckUserAndTLSCertRequest) GetIp() string
func (*CheckUserAndTLSCertRequest) GetProtocol ¶
func (x *CheckUserAndTLSCertRequest) GetProtocol() string
func (*CheckUserAndTLSCertRequest) GetTlsCert ¶
func (x *CheckUserAndTLSCertRequest) GetTlsCert() string
func (*CheckUserAndTLSCertRequest) GetUser ¶
func (x *CheckUserAndTLSCertRequest) GetUser() []byte
func (*CheckUserAndTLSCertRequest) GetUsername ¶
func (x *CheckUserAndTLSCertRequest) GetUsername() string
func (*CheckUserAndTLSCertRequest) ProtoMessage ¶
func (*CheckUserAndTLSCertRequest) ProtoMessage()
func (*CheckUserAndTLSCertRequest) ProtoReflect ¶
func (x *CheckUserAndTLSCertRequest) ProtoReflect() protoreflect.Message
func (*CheckUserAndTLSCertRequest) Reset ¶
func (x *CheckUserAndTLSCertRequest) Reset()
func (*CheckUserAndTLSCertRequest) String ¶
func (x *CheckUserAndTLSCertRequest) String() string
type KeyboardAuthRequest ¶
type KeyboardAuthRequest struct {
RequestID string `protobuf:"bytes,1,opt,name=requestID,proto3" json:"requestID,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"`
Ip string `protobuf:"bytes,4,opt,name=ip,proto3" json:"ip,omitempty"`
Answers []string `protobuf:"bytes,5,rep,name=answers,proto3" json:"answers,omitempty"`
Questions []string `protobuf:"bytes,6,rep,name=questions,proto3" json:"questions,omitempty"`
Step int32 `protobuf:"varint,7,opt,name=step,proto3" json:"step,omitempty"`
// contains filtered or unexported fields
}
func (*KeyboardAuthRequest) Descriptor
deprecated
func (*KeyboardAuthRequest) Descriptor() ([]byte, []int)
Deprecated: Use KeyboardAuthRequest.ProtoReflect.Descriptor instead.
func (*KeyboardAuthRequest) GetAnswers ¶
func (x *KeyboardAuthRequest) GetAnswers() []string
func (*KeyboardAuthRequest) GetIp ¶
func (x *KeyboardAuthRequest) GetIp() string
func (*KeyboardAuthRequest) GetPassword ¶
func (x *KeyboardAuthRequest) GetPassword() string
func (*KeyboardAuthRequest) GetQuestions ¶
func (x *KeyboardAuthRequest) GetQuestions() []string
func (*KeyboardAuthRequest) GetRequestID ¶
func (x *KeyboardAuthRequest) GetRequestID() string
func (*KeyboardAuthRequest) GetStep ¶
func (x *KeyboardAuthRequest) GetStep() int32
func (*KeyboardAuthRequest) GetUsername ¶
func (x *KeyboardAuthRequest) GetUsername() string
func (*KeyboardAuthRequest) ProtoMessage ¶
func (*KeyboardAuthRequest) ProtoMessage()
func (*KeyboardAuthRequest) ProtoReflect ¶
func (x *KeyboardAuthRequest) ProtoReflect() protoreflect.Message
func (*KeyboardAuthRequest) Reset ¶
func (x *KeyboardAuthRequest) Reset()
func (*KeyboardAuthRequest) String ¶
func (x *KeyboardAuthRequest) String() string
type KeyboardAuthResponse ¶
type KeyboardAuthResponse struct {
Instructions string `protobuf:"bytes,1,opt,name=instructions,proto3" json:"instructions,omitempty"`
Questions []string `protobuf:"bytes,2,rep,name=questions,proto3" json:"questions,omitempty"`
Echos []bool `protobuf:"varint,3,rep,packed,name=echos,proto3" json:"echos,omitempty"`
AuthResult int32 `protobuf:"varint,4,opt,name=auth_result,json=authResult,proto3" json:"auth_result,omitempty"`
CheckPassword int32 `protobuf:"varint,5,opt,name=check_password,json=checkPassword,proto3" json:"check_password,omitempty"`
// contains filtered or unexported fields
}
func (*KeyboardAuthResponse) Descriptor
deprecated
func (*KeyboardAuthResponse) Descriptor() ([]byte, []int)
Deprecated: Use KeyboardAuthResponse.ProtoReflect.Descriptor instead.
func (*KeyboardAuthResponse) GetAuthResult ¶
func (x *KeyboardAuthResponse) GetAuthResult() int32
func (*KeyboardAuthResponse) GetCheckPassword ¶
func (x *KeyboardAuthResponse) GetCheckPassword() int32
func (*KeyboardAuthResponse) GetEchos ¶
func (x *KeyboardAuthResponse) GetEchos() []bool
func (*KeyboardAuthResponse) GetInstructions ¶
func (x *KeyboardAuthResponse) GetInstructions() string
func (*KeyboardAuthResponse) GetQuestions ¶
func (x *KeyboardAuthResponse) GetQuestions() []string
func (*KeyboardAuthResponse) ProtoMessage ¶
func (*KeyboardAuthResponse) ProtoMessage()
func (*KeyboardAuthResponse) ProtoReflect ¶
func (x *KeyboardAuthResponse) ProtoReflect() protoreflect.Message
func (*KeyboardAuthResponse) Reset ¶
func (x *KeyboardAuthResponse) Reset()
func (*KeyboardAuthResponse) String ¶
func (x *KeyboardAuthResponse) String() string
type UnimplementedAuthServer ¶
type UnimplementedAuthServer struct {
}
UnimplementedAuthServer should be embedded to have forward compatible implementations.
func (UnimplementedAuthServer) CheckUserAndKeyboardInteractive ¶
func (UnimplementedAuthServer) CheckUserAndKeyboardInteractive(context.Context, *CheckUserAndKeyboardInteractiveRequest) (*AuthResponse, error)
func (UnimplementedAuthServer) CheckUserAndPass ¶
func (UnimplementedAuthServer) CheckUserAndPass(context.Context, *CheckUserAndPassRequest) (*AuthResponse, error)
func (UnimplementedAuthServer) CheckUserAndPublicKey ¶
func (UnimplementedAuthServer) CheckUserAndPublicKey(context.Context, *CheckUserAndPublicKeyRequest) (*AuthResponse, error)
func (UnimplementedAuthServer) CheckUserAndTLSCert ¶
func (UnimplementedAuthServer) CheckUserAndTLSCert(context.Context, *CheckUserAndTLSCertRequest) (*AuthResponse, error)
func (UnimplementedAuthServer) SendKeyboardAuthRequest ¶
func (UnimplementedAuthServer) SendKeyboardAuthRequest(context.Context, *KeyboardAuthRequest) (*KeyboardAuthResponse, error)
type UnsafeAuthServer ¶ added in v0.1.3
type UnsafeAuthServer interface {
// contains filtered or unexported methods
}
UnsafeAuthServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to AuthServer will result in compilation errors.