admin

package
v1.9.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 19, 2024 License: MIT Imports: 10 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	DirectoryAdministration_Review_FullMethodName = "/gds.admin.v1.DirectoryAdministration/Review"
	DirectoryAdministration_Resend_FullMethodName = "/gds.admin.v1.DirectoryAdministration/Resend"
	DirectoryAdministration_Status_FullMethodName = "/gds.admin.v1.DirectoryAdministration/Status"
)

Variables

View Source 
var (
	ResendRequest_ResendType_name = map[int32]string{
		0: "UNKNOWN",
		1: "VERIFY_CONTACT",
		2: "REVIEW",
		3: "DELIVER_CERTS",
		4: "REJECTION",
	}
	ResendRequest_ResendType_value = map[string]int32{
		"UNKNOWN":        0,
		"VERIFY_CONTACT": 1,
		"REVIEW":         2,
		"DELIVER_CERTS":  3,
		"REJECTION":      4,
	}
)

Enum value maps for ResendRequest_ResendType.

View Source 
var DirectoryAdministration_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "gds.admin.v1.DirectoryAdministration",
	HandlerType: (*DirectoryAdministrationServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Review",
			Handler:    _DirectoryAdministration_Review_Handler,
		},
		{
			MethodName: "Resend",
			Handler:    _DirectoryAdministration_Resend_Handler,
		},
		{
			MethodName: "Status",
			Handler:    _DirectoryAdministration_Status_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "gds/admin/v1/admin.proto",
}

DirectoryAdministration_ServiceDesc is the grpc.ServiceDesc for DirectoryAdministration service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source 
var File_gds_admin_v1_admin_proto protoreflect.FileDescriptor

Functions

func RegisterDirectoryAdministrationServer 

func RegisterDirectoryAdministrationServer(s grpc.ServiceRegistrar, srv DirectoryAdministrationServer)

Types

type DirectoryAdministrationClient 

type DirectoryAdministrationClient interface {
	Review(ctx context.Context, in *ReviewRequest, opts ...grpc.CallOption) (*ReviewReply, error)
	Resend(ctx context.Context, in *ResendRequest, opts ...grpc.CallOption) (*ResendReply, error)
	Status(ctx context.Context, in *StatusRequest, opts ...grpc.CallOption) (*StatusReply, error)
}

DirectoryAdministrationClient is the client API for DirectoryAdministration 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.

An administrative service that is implemented side-by-side with most directory services to review registration requests and perform remote certificate management. Because this endpoint necessarily must be authenticated, it is deliberately lightweight for the MVP implementation.

func NewDirectoryAdministrationClient 

func NewDirectoryAdministrationClient(cc grpc.ClientConnInterface) DirectoryAdministrationClient

type DirectoryAdministrationServer 

type DirectoryAdministrationServer interface {
	Review(context.Context, *ReviewRequest) (*ReviewReply, error)
	Resend(context.Context, *ResendRequest) (*ResendReply, error)
	Status(context.Context, *StatusRequest) (*StatusReply, error)
	// contains filtered or unexported methods
}

DirectoryAdministrationServer is the server API for DirectoryAdministration service. All implementations must embed UnimplementedDirectoryAdministrationServer for forward compatibility

An administrative service that is implemented side-by-side with most directory services to review registration requests and perform remote certificate management. Because this endpoint necessarily must be authenticated, it is deliberately lightweight for the MVP implementation.

type ResendReply 

type ResendReply struct {
	Sent    int64  `protobuf:"varint,1,opt,name=sent,proto3" json:"sent,omitempty"`      // The number of emails sent
	Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"` // Any message from the server about status
	// contains filtered or unexported fields
}

func (*ResendReply) Descriptor deprecated 

func (*ResendReply) Descriptor() ([]byte, []int)

Deprecated: Use ResendReply.ProtoReflect.Descriptor instead.

func (*ResendReply) GetMessage 

func (x *ResendReply) GetMessage() string

func (*ResendReply) GetSent 

func (x *ResendReply) GetSent() int64

func (*ResendReply) ProtoMessage 

func (*ResendReply) ProtoMessage()

func (*ResendReply) ProtoReflect 

func (x *ResendReply) ProtoReflect() protoreflect.Message

func (*ResendReply) Reset 

func (x *ResendReply) Reset()

func (*ResendReply) String 

func (x *ResendReply) String() string

type ResendRequest 

type ResendRequest struct {
	Id     string                   `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`                                                 // The ID of the VASP to resend emails for
	Type   ResendRequest_ResendType `protobuf:"varint,2,opt,name=type,proto3,enum=gds.admin.v1.ResendRequest_ResendType" json:"type,omitempty"` // The type of message to attempt to resend
	Reason string                   `protobuf:"bytes,3,opt,name=reason,proto3" json:"reason,omitempty"`                                         // If a rejection email, supply the reason for the rejection.
	// contains filtered or unexported fields
}

Resend requests allow extra attempts to resend emails to be made if they were not delivered or recieved the first time. This is a routine action that may need to be carried out from time to time.

func (*ResendRequest) Descriptor deprecated 

func (*ResendRequest) Descriptor() ([]byte, []int)

Deprecated: Use ResendRequest.ProtoReflect.Descriptor instead.

func (*ResendRequest) GetId 

func (x *ResendRequest) GetId() string

func (*ResendRequest) GetReason 

func (x *ResendRequest) GetReason() string

func (*ResendRequest) GetType 

func (x *ResendRequest) GetType() ResendRequest_ResendType

func (*ResendRequest) ProtoMessage 

func (*ResendRequest) ProtoMessage()

func (*ResendRequest) ProtoReflect 

func (x *ResendRequest) ProtoReflect() protoreflect.Message

func (*ResendRequest) Reset 

func (x *ResendRequest) Reset()

func (*ResendRequest) String 

func (x *ResendRequest) String() string

type ResendRequest_ResendType 

type ResendRequest_ResendType int32
const (
	ResendRequest_UNKNOWN        ResendRequest_ResendType = 0
	ResendRequest_VERIFY_CONTACT ResendRequest_ResendType = 1
	ResendRequest_REVIEW         ResendRequest_ResendType = 2
	ResendRequest_DELIVER_CERTS  ResendRequest_ResendType = 3
	ResendRequest_REJECTION      ResendRequest_ResendType = 4
)

func (ResendRequest_ResendType) Descriptor 

func (ResendRequest_ResendType) Descriptor() protoreflect.EnumDescriptor

func (ResendRequest_ResendType) Enum 

func (x ResendRequest_ResendType) Enum() *ResendRequest_ResendType

func (ResendRequest_ResendType) EnumDescriptor deprecated 

func (ResendRequest_ResendType) EnumDescriptor() ([]byte, []int)

Deprecated: Use ResendRequest_ResendType.Descriptor instead.

func (ResendRequest_ResendType) Number 

func (x ResendRequest_ResendType) Number() protoreflect.EnumNumber

func (ResendRequest_ResendType) String 

func (x ResendRequest_ResendType) String() string

func (ResendRequest_ResendType) Type 

func (ResendRequest_ResendType) Type() protoreflect.EnumType

type ReviewReply 

type ReviewReply struct {

	// If no error is specified, the verify email request was successful
	Error *v1beta1.Error `protobuf:"bytes,1,opt,name=error,proto3" json:"error,omitempty"`
	// The verification status of the VASP entity.
	Status  v1beta11.VerificationState `protobuf:"varint,2,opt,name=status,proto3,enum=trisa.gds.models.v1beta1.VerificationState" json:"status,omitempty"`
	Message string                     `protobuf:"bytes,3,opt,name=message,proto3" json:"message,omitempty"`
	// contains filtered or unexported fields
}

func (*ReviewReply) Descriptor deprecated 

func (*ReviewReply) Descriptor() ([]byte, []int)

Deprecated: Use ReviewReply.ProtoReflect.Descriptor instead.

func (*ReviewReply) GetError 

func (x *ReviewReply) GetError() *v1beta1.Error

func (*ReviewReply) GetMessage 

func (x *ReviewReply) GetMessage() string

func (*ReviewReply) GetStatus 

func (x *ReviewReply) GetStatus() v1beta11.VerificationState

func (*ReviewReply) ProtoMessage 

func (*ReviewReply) ProtoMessage()

func (*ReviewReply) ProtoReflect 

func (x *ReviewReply) ProtoReflect() protoreflect.Message

func (*ReviewReply) Reset 

func (x *ReviewReply) Reset()

func (*ReviewReply) String 

func (x *ReviewReply) String() string

type ReviewRequest 

type ReviewRequest struct {

	// The ID of the VASP to perform the review for.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// The verification token sent in the review email.
	// This token provides lightweight authentication but should be replaced with a more
	// robust authentication and authorization scheme.
	AdminVerificationToken string `` /* 129-byte string literal not displayed */
	// If accept is false then the request will be rejected and a reject reason must be
	// specified. If it is true, then the certificate issuance process will begin.
	Accept       bool   `protobuf:"varint,3,opt,name=accept,proto3" json:"accept,omitempty"`
	RejectReason string `protobuf:"bytes,4,opt,name=reject_reason,json=rejectReason,proto3" json:"reject_reason,omitempty"`
	// contains filtered or unexported fields
}

Registration review requests are sent via email to the TRISA admin email address with a lightweight token for review. This endpoint allows administrators to submit a review determination back to the directory server.

func (*ReviewRequest) Descriptor deprecated 

func (*ReviewRequest) Descriptor() ([]byte, []int)

Deprecated: Use ReviewRequest.ProtoReflect.Descriptor instead.

func (*ReviewRequest) GetAccept 

func (x *ReviewRequest) GetAccept() bool

func (*ReviewRequest) GetAdminVerificationToken 

func (x *ReviewRequest) GetAdminVerificationToken() string

func (*ReviewRequest) GetId 

func (x *ReviewRequest) GetId() string

func (*ReviewRequest) GetRejectReason 

func (x *ReviewRequest) GetRejectReason() string

func (*ReviewRequest) ProtoMessage 

func (*ReviewRequest) ProtoMessage()

func (*ReviewRequest) ProtoReflect 

func (x *ReviewRequest) ProtoReflect() protoreflect.Message

func (*ReviewRequest) Reset 

func (x *ReviewRequest) Reset()

func (*ReviewRequest) String 

func (x *ReviewRequest) String() string

type StatusReply 

type StatusReply struct {
	Registrations       map[string]int64 `` /* 168-byte string literal not displayed */
	CertificateRequests map[string]int64 `` /* 207-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*StatusReply) Descriptor deprecated 

func (*StatusReply) Descriptor() ([]byte, []int)

Deprecated: Use StatusReply.ProtoReflect.Descriptor instead.

func (*StatusReply) GetCertificateRequests 

func (x *StatusReply) GetCertificateRequests() map[string]int64

func (*StatusReply) GetRegistrations 

func (x *StatusReply) GetRegistrations() map[string]int64

func (*StatusReply) ProtoMessage 

func (*StatusReply) ProtoMessage()

func (*StatusReply) ProtoReflect 

func (x *StatusReply) ProtoReflect() protoreflect.Message

func (*StatusReply) Reset 

func (x *StatusReply) Reset()

func (*StatusReply) String 

func (x *StatusReply) String() string

type StatusRequest 

type StatusRequest struct {
	NoRegistrations       bool `protobuf:"varint,1,opt,name=no_registrations,json=noRegistrations,proto3" json:"no_registrations,omitempty"` // Ignore counting the registration statuses
	NoCertificateRequests bool ``                                                                                                            // Ignore counting certificate request statuses
	/* 127-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*StatusRequest) Descriptor deprecated 

func (*StatusRequest) Descriptor() ([]byte, []int)

Deprecated: Use StatusRequest.ProtoReflect.Descriptor instead.

func (*StatusRequest) GetNoCertificateRequests 

func (x *StatusRequest) GetNoCertificateRequests() bool

func (*StatusRequest) GetNoRegistrations 

func (x *StatusRequest) GetNoRegistrations() bool

func (*StatusRequest) ProtoMessage 

func (*StatusRequest) ProtoMessage()

func (*StatusRequest) ProtoReflect 

func (x *StatusRequest) ProtoReflect() protoreflect.Message

func (*StatusRequest) Reset 

func (x *StatusRequest) Reset()

func (*StatusRequest) String 

func (x *StatusRequest) String() string

type UnimplementedDirectoryAdministrationServer 

type UnimplementedDirectoryAdministrationServer struct {
}

UnimplementedDirectoryAdministrationServer must be embedded to have forward compatible implementations.

func (UnimplementedDirectoryAdministrationServer) Resend 

func (UnimplementedDirectoryAdministrationServer) Resend(context.Context, *ResendRequest) (*ResendReply, error)

func (UnimplementedDirectoryAdministrationServer) Review 

func (UnimplementedDirectoryAdministrationServer) Review(context.Context, *ReviewRequest) (*ReviewReply, error)

func (UnimplementedDirectoryAdministrationServer) Status 

func (UnimplementedDirectoryAdministrationServer) Status(context.Context, *StatusRequest) (*StatusReply, error)

type UnsafeDirectoryAdministrationServer 

type UnsafeDirectoryAdministrationServer interface {
	// contains filtered or unexported methods
}

UnsafeDirectoryAdministrationServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to DirectoryAdministrationServer will result in compilation errors.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.