api

package
v1.4.1 Latest Latest
Warning

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

 Go to latest Published: Sep 9, 2024 License: MIT Imports: 13 Imported by: 9

Documentation

Index

Constants

View Source 
const (
	TRISADirectory_Lookup_FullMethodName        = "/trisa.gds.api.v1beta1.TRISADirectory/Lookup"
	TRISADirectory_Search_FullMethodName        = "/trisa.gds.api.v1beta1.TRISADirectory/Search"
	TRISADirectory_Register_FullMethodName      = "/trisa.gds.api.v1beta1.TRISADirectory/Register"
	TRISADirectory_VerifyContact_FullMethodName = "/trisa.gds.api.v1beta1.TRISADirectory/VerifyContact"
	TRISADirectory_Verification_FullMethodName  = "/trisa.gds.api.v1beta1.TRISADirectory/Verification"
	TRISADirectory_Status_FullMethodName        = "/trisa.gds.api.v1beta1.TRISADirectory/Status"
)
View Source 
const (
	ServiceStatusUnknown     = ServiceState_UNKNOWN
	ServiceStatusHealthy     = ServiceState_HEALTHY
	ServiceStatusUnhealthy   = ServiceState_UNHEALTHY
	ServiceStatusDanger      = ServiceState_DANGER
	ServiceStatusOffline     = ServiceState_OFFLINE
	ServiceStatusMaintenance = ServiceState_MAINTENANCE
)

Variables

View Source 
var (
	ServiceState_Status_name = map[int32]string{
		0: "UNKNOWN",
		1: "HEALTHY",
		2: "UNHEALTHY",
		3: "DANGER",
		4: "OFFLINE",
		5: "MAINTENANCE",
	}
	ServiceState_Status_value = map[string]int32{
		"UNKNOWN":     0,
		"HEALTHY":     1,
		"UNHEALTHY":   2,
		"DANGER":      3,
		"OFFLINE":     4,
		"MAINTENANCE": 5,
	}
)

Enum value maps for ServiceState_Status.

View Source 
var (
	ErrUnknownServiceState = errors.New("could not parse service state from input")
)
View Source 
var File_trisa_gds_api_v1beta1_api_proto protoreflect.FileDescriptor
View Source 
var TRISADirectory_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "trisa.gds.api.v1beta1.TRISADirectory",
	HandlerType: (*TRISADirectoryServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Lookup",
			Handler:    _TRISADirectory_Lookup_Handler,
		},
		{
			MethodName: "Search",
			Handler:    _TRISADirectory_Search_Handler,
		},
		{
			MethodName: "Register",
			Handler:    _TRISADirectory_Register_Handler,
		},
		{
			MethodName: "VerifyContact",
			Handler:    _TRISADirectory_VerifyContact_Handler,
		},
		{
			MethodName: "Verification",
			Handler:    _TRISADirectory_Verification_Handler,
		},
		{
			MethodName: "Status",
			Handler:    _TRISADirectory_Status_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "trisa/gds/api/v1beta1/api.proto",
}

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

Functions

func RegisterTRISADirectoryServer 

func RegisterTRISADirectoryServer(s grpc.ServiceRegistrar, srv TRISADirectoryServer)

Types

type Error 

type Error struct {
	Code    int32  `protobuf:"varint,1,opt,name=code,proto3" json:"code,omitempty"`
	Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
	// contains filtered or unexported fields
}

func (*Error) Descriptor deprecated 

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

Deprecated: Use Error.ProtoReflect.Descriptor instead.

func (*Error) Error 

func (e *Error) Error() string

Error ensures that protocol buffer errors implement error

func (*Error) GetCode 

func (x *Error) GetCode() int32

func (*Error) GetMessage 

func (x *Error) GetMessage() string

func (*Error) ProtoMessage 

func (*Error) ProtoMessage()

func (*Error) ProtoReflect 

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

func (*Error) Reset 

func (x *Error) Reset()

func (*Error) String 

func (x *Error) String() string

type HealthCheck added in v0.2.0 

type HealthCheck struct {

	// The number of failed health checks that proceeded the current check.
	Attempts uint32 `protobuf:"varint,1,opt,name=attempts,proto3" json:"attempts,omitempty"`
	// The timestamp of the last health check, successful or otherwise.
	LastCheckedAt string `protobuf:"bytes,2,opt,name=last_checked_at,json=lastCheckedAt,proto3" json:"last_checked_at,omitempty"`
	// contains filtered or unexported fields
}

func (*HealthCheck) Descriptor deprecated added in v0.2.0 

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

Deprecated: Use HealthCheck.ProtoReflect.Descriptor instead.

func (*HealthCheck) GetAttempts added in v0.2.0 

func (x *HealthCheck) GetAttempts() uint32

func (*HealthCheck) GetLastCheckedAt added in v0.2.0 

func (x *HealthCheck) GetLastCheckedAt() string

func (*HealthCheck) ProtoMessage added in v0.2.0 

func (*HealthCheck) ProtoMessage()

func (*HealthCheck) ProtoReflect added in v0.2.0 

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

func (*HealthCheck) Reset added in v0.2.0 

func (x *HealthCheck) Reset()

func (*HealthCheck) String added in v0.2.0 

func (x *HealthCheck) String() string

type LookupReply 

type LookupReply struct {

	// If no error is specified, the lookup was successful
	Error *Error `protobuf:"bytes,1,opt,name=error,proto3" json:"error,omitempty"`
	// The uniquely identifying components of the VASP in the directory service
	Id                  string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
	RegisteredDirectory string `protobuf:"bytes,3,opt,name=registered_directory,json=registeredDirectory,proto3" json:"registered_directory,omitempty"`
	CommonName          string `protobuf:"bytes,4,opt,name=common_name,json=commonName,proto3" json:"common_name,omitempty"`
	// The endpoint to connect to for the TRISA P2P protocol (addr:port)
	Endpoint string `protobuf:"bytes,5,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
	// Certificate information if the VASP is available and verified. The identity
	// certificate is used to establish mTLS connections, the signing certificate is
	// used on a per-transaction basis.
	IdentityCertificate *v1beta1.Certificate `protobuf:"bytes,6,opt,name=identity_certificate,json=identityCertificate,proto3" json:"identity_certificate,omitempty"`
	SigningCertificate  *v1beta1.Certificate `protobuf:"bytes,7,opt,name=signing_certificate,json=signingCertificate,proto3" json:"signing_certificate,omitempty"`
	// Other VASP information that faciliates P2P exchanges
	Name       string `protobuf:"bytes,8,opt,name=name,proto3" json:"name,omitempty"`
	Country    string `protobuf:"bytes,9,opt,name=country,proto3" json:"country,omitempty"`
	VerifiedOn string `protobuf:"bytes,10,opt,name=verified_on,json=verifiedOn,proto3" json:"verified_on,omitempty"`
	// contains filtered or unexported fields
}

Summary information is given in return for VASP lookups as lookups are primarily intended to facilitate P2P verification and public key exchange. NOTE: only verified VASPs are returned using the lookup RPC.

func (*LookupReply) Descriptor deprecated 

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

Deprecated: Use LookupReply.ProtoReflect.Descriptor instead.

func (*LookupReply) GetCommonName 

func (x *LookupReply) GetCommonName() string

func (*LookupReply) GetCountry 

func (x *LookupReply) GetCountry() string

func (*LookupReply) GetEndpoint 

func (x *LookupReply) GetEndpoint() string

func (*LookupReply) GetError 

func (x *LookupReply) GetError() *Error

func (*LookupReply) GetId 

func (x *LookupReply) GetId() string

func (*LookupReply) GetIdentityCertificate 

func (x *LookupReply) GetIdentityCertificate() *v1beta1.Certificate

func (*LookupReply) GetName 

func (x *LookupReply) GetName() string

func (*LookupReply) GetRegisteredDirectory 

func (x *LookupReply) GetRegisteredDirectory() string

func (*LookupReply) GetSigningCertificate 

func (x *LookupReply) GetSigningCertificate() *v1beta1.Certificate

func (*LookupReply) GetVerifiedOn 

func (x *LookupReply) GetVerifiedOn() string

func (*LookupReply) ProtoMessage 

func (*LookupReply) ProtoMessage()

func (*LookupReply) ProtoReflect 

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

func (*LookupReply) Reset 

func (x *LookupReply) Reset()

func (*LookupReply) String 

func (x *LookupReply) String() string

type LookupRequest 

type LookupRequest struct {

	// Unique identifier generated by the directory service, most common lookup field.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// The URL of the directory that registered the VASP. If ommitted, it is assumed
	// that the directory being queried is the registering VASP.
	RegisteredDirectory string `protobuf:"bytes,2,opt,name=registered_directory,json=registeredDirectory,proto3" json:"registered_directory,omitempty"`
	// The common name of the certificate, e.g. the domain name of the TRISA endpoint.
	// To use other name fields such as the legal business name, you must use search.
	CommonName string `protobuf:"bytes,3,opt,name=common_name,json=commonName,proto3" json:"common_name,omitempty"`
	// contains filtered or unexported fields
}

Lookup VASP certification information either by their unique ID or by the domain of the TRISA implementation endpoint, which should be the common name of the certificate. Note that if both id and common name are supplied, ID is prioritized.

func (*LookupRequest) Descriptor deprecated 

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

Deprecated: Use LookupRequest.ProtoReflect.Descriptor instead.

func (*LookupRequest) GetCommonName 

func (x *LookupRequest) GetCommonName() string

func (*LookupRequest) GetId 

func (x *LookupRequest) GetId() string

func (*LookupRequest) GetRegisteredDirectory 

func (x *LookupRequest) GetRegisteredDirectory() string

func (*LookupRequest) ProtoMessage 

func (*LookupRequest) ProtoMessage()

func (*LookupRequest) ProtoReflect 

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

func (*LookupRequest) Reset 

func (x *LookupRequest) Reset()

func (*LookupRequest) String 

func (x *LookupRequest) String() string

type RegisterReply 

type RegisterReply struct {

	// If the registration was successful, no error will be returned
	Error *Error `protobuf:"bytes,1,opt,name=error,proto3" json:"error,omitempty"`
	// Unique identifiers for the VASP created by the registration.
	// Use these identifiers for status lookup requests and any follow-on interactions.
	Id                  string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
	RegisteredDirectory string `protobuf:"bytes,3,opt,name=registered_directory,json=registeredDirectory,proto3" json:"registered_directory,omitempty"`
	CommonName          string `protobuf:"bytes,4,opt,name=common_name,json=commonName,proto3" json:"common_name,omitempty"`
	// The verification status of the VASP entity.
	Status  v1beta1.VerificationState `protobuf:"varint,5,opt,name=status,proto3,enum=trisa.gds.models.v1beta1.VerificationState" json:"status,omitempty"`
	Message string                    `protobuf:"bytes,6,opt,name=message,proto3" json:"message,omitempty"`
	// Used to decrypt the emailed certificates in PKCS 12 format
	Pkcs12Password string `protobuf:"bytes,7,opt,name=pkcs12password,proto3" json:"pkcs12password,omitempty"`
	// contains filtered or unexported fields
}

func (*RegisterReply) Descriptor deprecated 

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

Deprecated: Use RegisterReply.ProtoReflect.Descriptor instead.

func (*RegisterReply) GetCommonName 

func (x *RegisterReply) GetCommonName() string

func (*RegisterReply) GetError 

func (x *RegisterReply) GetError() *Error

func (*RegisterReply) GetId 

func (x *RegisterReply) GetId() string

func (*RegisterReply) GetMessage 

func (x *RegisterReply) GetMessage() string

func (*RegisterReply) GetPkcs12Password added in v0.2.0 

func (x *RegisterReply) GetPkcs12Password() string

func (*RegisterReply) GetRegisteredDirectory 

func (x *RegisterReply) GetRegisteredDirectory() string

func (*RegisterReply) GetStatus 

func (x *RegisterReply) GetStatus() v1beta1.VerificationState

func (*RegisterReply) ProtoMessage 

func (*RegisterReply) ProtoMessage()

func (*RegisterReply) ProtoReflect 

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

func (*RegisterReply) Reset 

func (x *RegisterReply) Reset()

func (*RegisterReply) String 

func (x *RegisterReply) String() string

type RegisterRequest 

type RegisterRequest struct {

	// The legal entity IVMS 101 data for VASP KYC information exchange. This is the
	// IVMS 101 data that should be exchanged in the TRISA P2P protocol as the
	// Originator, Intermediate, or Beneficiary VASP fields. A complete and valid
	// identity record with country of registration is required.
	Entity *ivms101.LegalPerson `protobuf:"bytes,1,opt,name=entity,proto3" json:"entity,omitempty"`
	// Technical, legal, billing, and administrative contacts for the VASP.
	Contacts *v1beta1.Contacts `protobuf:"bytes,2,opt,name=contacts,proto3" json:"contacts,omitempty"`
	// Travel Rule Implementation Endpoint - where other TRISA peers should connect.
	// This should be an addr:port combination, e.g. trisa.vaspbot.net:443
	TrisaEndpoint string `protobuf:"bytes,3,opt,name=trisa_endpoint,json=trisaEndpoint,proto3" json:"trisa_endpoint,omitempty"`
	// Common name should be the VASP domain name to issue certificates for, which
	// should match the domain in the trisa_endpoint. If this field is omitted, the
	// common name is inferred from the trisa_endpoint.
	CommonName string `protobuf:"bytes,4,opt,name=common_name,json=commonName,proto3" json:"common_name,omitempty"`
	// Business Information
	Website          string                   `protobuf:"bytes,5,opt,name=website,proto3" json:"website,omitempty"`
	BusinessCategory v1beta1.BusinessCategory `` /* 157-byte string literal not displayed */
	VaspCategories   []string                 `protobuf:"bytes,7,rep,name=vasp_categories,json=vaspCategories,proto3" json:"vasp_categories,omitempty"`
	EstablishedOn    string                   `protobuf:"bytes,8,opt,name=established_on,json=establishedOn,proto3" json:"established_on,omitempty"` // Should be a date in YYYY-MM-DD format
	// TRIXO Questionnaire
	Trixo *v1beta1.TRIXOQuestionnaire `protobuf:"bytes,9,opt,name=trixo,proto3" json:"trixo,omitempty"`
	// contains filtered or unexported fields
}

Registration requests are validated that they contain correct information and then are sent through the verification process, creating or updating a VASP as needed.

func (*RegisterRequest) Descriptor deprecated 

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

Deprecated: Use RegisterRequest.ProtoReflect.Descriptor instead.

func (*RegisterRequest) GetBusinessCategory 

func (x *RegisterRequest) GetBusinessCategory() v1beta1.BusinessCategory

func (*RegisterRequest) GetCommonName 

func (x *RegisterRequest) GetCommonName() string

func (*RegisterRequest) GetContacts 

func (x *RegisterRequest) GetContacts() *v1beta1.Contacts

func (*RegisterRequest) GetEntity 

func (x *RegisterRequest) GetEntity() *ivms101.LegalPerson

func (*RegisterRequest) GetEstablishedOn 

func (x *RegisterRequest) GetEstablishedOn() string

func (*RegisterRequest) GetTrisaEndpoint 

func (x *RegisterRequest) GetTrisaEndpoint() string

func (*RegisterRequest) GetTrixo 

func (x *RegisterRequest) GetTrixo() *v1beta1.TRIXOQuestionnaire

func (*RegisterRequest) GetVaspCategories added in v0.2.0 

func (x *RegisterRequest) GetVaspCategories() []string

func (*RegisterRequest) GetWebsite 

func (x *RegisterRequest) GetWebsite() string

func (*RegisterRequest) ProtoMessage 

func (*RegisterRequest) ProtoMessage()

func (*RegisterRequest) ProtoReflect 

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

func (*RegisterRequest) Reset 

func (x *RegisterRequest) Reset()

func (*RegisterRequest) String 

func (x *RegisterRequest) String() string

type SearchReply 

type SearchReply struct {

	// If no error is specified, the search was successful, even if no results returned.
	Error   *Error                `protobuf:"bytes,1,opt,name=error,proto3" json:"error,omitempty"`
	Results []*SearchReply_Result `protobuf:"bytes,2,rep,name=results,proto3" json:"results,omitempty"`
	// contains filtered or unexported fields
}

func (*SearchReply) Descriptor deprecated 

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

Deprecated: Use SearchReply.ProtoReflect.Descriptor instead.

func (*SearchReply) GetError 

func (x *SearchReply) GetError() *Error

func (*SearchReply) GetResults 

func (x *SearchReply) GetResults() []*SearchReply_Result

func (*SearchReply) ProtoMessage 

func (*SearchReply) ProtoMessage()

func (*SearchReply) ProtoReflect 

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

func (*SearchReply) Reset 

func (x *SearchReply) Reset()

func (*SearchReply) String 

func (x *SearchReply) String() string

type SearchReply_Result 

type SearchReply_Result struct {

	// The uniquely identifying components of the VASP in the directory service
	Id                  string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	RegisteredDirectory string `protobuf:"bytes,2,opt,name=registered_directory,json=registeredDirectory,proto3" json:"registered_directory,omitempty"`
	CommonName          string `protobuf:"bytes,3,opt,name=common_name,json=commonName,proto3" json:"common_name,omitempty"`
	// Address to connect to the remote VASP on to perform a TRISA request
	Endpoint string `protobuf:"bytes,4,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
	// contains filtered or unexported fields
}

func (*SearchReply_Result) Descriptor deprecated 

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

Deprecated: Use SearchReply_Result.ProtoReflect.Descriptor instead.

func (*SearchReply_Result) GetCommonName 

func (x *SearchReply_Result) GetCommonName() string

func (*SearchReply_Result) GetEndpoint 

func (x *SearchReply_Result) GetEndpoint() string

func (*SearchReply_Result) GetId 

func (x *SearchReply_Result) GetId() string

func (*SearchReply_Result) GetRegisteredDirectory 

func (x *SearchReply_Result) GetRegisteredDirectory() string

func (*SearchReply_Result) ProtoMessage 

func (*SearchReply_Result) ProtoMessage()

func (*SearchReply_Result) ProtoReflect 

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

func (*SearchReply_Result) Reset 

func (x *SearchReply_Result) Reset()

func (*SearchReply_Result) String 

func (x *SearchReply_Result) String() string

type SearchRequest 

type SearchRequest struct {

	// Case insensitive search fields that use OR to perform the lookup. The name field
	// can be the legal, short, or DBA name of the VASP or the common name of
	// certificate issued to that VASP (though in this case, it is better to use the
	// Lookup RPC). The website must be a parseable URL to lookup the VASP with.
	Name    []string `protobuf:"bytes,1,rep,name=name,proto3" json:"name,omitempty"`
	Website []string `protobuf:"bytes,2,rep,name=website,proto3" json:"website,omitempty"`
	// Search filters to condition the search on. Only VASPs that are in the
	// country(ies) or category(ies) specified are returned.
	Country          []string                   `protobuf:"bytes,7,rep,name=country,proto3" json:"country,omitempty"`
	BusinessCategory []v1beta1.BusinessCategory `` /* 164-byte string literal not displayed */
	VaspCategory     []string                   `protobuf:"bytes,9,rep,name=vasp_category,json=vaspCategory,proto3" json:"vasp_category,omitempty"`
	// contains filtered or unexported fields
}

Search requests allow a more flexibly field serach to identify a VASP, these requests are primarily used to locate a beneficiary VASP in order to begin the TRISA P2P protocol. NOTE: only verified VASPs are returned using the search RPC.

func (*SearchRequest) Descriptor deprecated 

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

Deprecated: Use SearchRequest.ProtoReflect.Descriptor instead.

func (*SearchRequest) GetBusinessCategory 

func (x *SearchRequest) GetBusinessCategory() []v1beta1.BusinessCategory

func (*SearchRequest) GetCountry 

func (x *SearchRequest) GetCountry() []string

func (*SearchRequest) GetName 

func (x *SearchRequest) GetName() []string

func (*SearchRequest) GetVaspCategory 

func (x *SearchRequest) GetVaspCategory() []string

func (*SearchRequest) GetWebsite 

func (x *SearchRequest) GetWebsite() []string

func (*SearchRequest) ProtoMessage 

func (*SearchRequest) ProtoMessage()

func (*SearchRequest) ProtoReflect 

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

func (*SearchRequest) Reset 

func (x *SearchRequest) Reset()

func (*SearchRequest) String 

func (x *SearchRequest) String() string

type ServiceState added in v0.2.0 

type ServiceState struct {

	// Current service status as defined by the recieving system. The system is obliged
	// to respond with the closest matching status in a best-effort fashion. Alerts will
	// be triggered on service status changes if the system does not respond and the
	// previous system state was not unknown.
	Status ServiceState_Status `protobuf:"varint,1,opt,name=status,proto3,enum=trisa.gds.api.v1beta1.ServiceState_Status" json:"status,omitempty"`
	// Suggest to the directory service when to check the health status again.
	NotBefore string `protobuf:"bytes,2,opt,name=not_before,json=notBefore,proto3" json:"not_before,omitempty"`
	NotAfter  string `protobuf:"bytes,3,opt,name=not_after,json=notAfter,proto3" json:"not_after,omitempty"`
	// contains filtered or unexported fields
}

func (*ServiceState) Descriptor deprecated added in v0.2.0 

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

Deprecated: Use ServiceState.ProtoReflect.Descriptor instead.

func (*ServiceState) GetNotAfter added in v0.2.0 

func (x *ServiceState) GetNotAfter() string

func (*ServiceState) GetNotBefore added in v0.2.0 

func (x *ServiceState) GetNotBefore() string

func (*ServiceState) GetStatus added in v0.2.0 

func (x *ServiceState) GetStatus() ServiceState_Status

func (*ServiceState) ProtoMessage added in v0.2.0 

func (*ServiceState) ProtoMessage()

func (*ServiceState) ProtoReflect added in v0.2.0 

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

func (*ServiceState) Reset added in v0.2.0 

func (x *ServiceState) Reset()

func (*ServiceState) String added in v0.2.0 

func (x *ServiceState) String() string

type ServiceState_Status added in v0.2.0 

type ServiceState_Status int32
const (
	ServiceState_UNKNOWN     ServiceState_Status = 0
	ServiceState_HEALTHY     ServiceState_Status = 1
	ServiceState_UNHEALTHY   ServiceState_Status = 2
	ServiceState_DANGER      ServiceState_Status = 3
	ServiceState_OFFLINE     ServiceState_Status = 4
	ServiceState_MAINTENANCE ServiceState_Status = 5
)

func ParseServiceState added in v1.2.0 

func ParseServiceState(in any) (ServiceState_Status, error)

func (ServiceState_Status) Descriptor added in v0.2.0 

func (ServiceState_Status) Descriptor() protoreflect.EnumDescriptor

func (ServiceState_Status) Enum added in v0.2.0 

func (x ServiceState_Status) Enum() *ServiceState_Status

func (ServiceState_Status) EnumDescriptor deprecated added in v0.2.0 

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

Deprecated: Use ServiceState_Status.Descriptor instead.

func (ServiceState_Status) Number added in v0.2.0 

func (x ServiceState_Status) Number() protoreflect.EnumNumber

func (ServiceState_Status) String added in v0.2.0 

func (x ServiceState_Status) String() string

func (ServiceState_Status) Type added in v0.2.0 

func (ServiceState_Status) Type() protoreflect.EnumType

type TRISADirectoryClient 

type TRISADirectoryClient interface {
	// Interactions with the Directory Service during a TRISA transfer
	// These are the primary Directory Service interactions.
	Lookup(ctx context.Context, in *LookupRequest, opts ...grpc.CallOption) (*LookupReply, error)
	Search(ctx context.Context, in *SearchRequest, opts ...grpc.CallOption) (*SearchReply, error)
	// Registration workflow and contact verification.
	Register(ctx context.Context, in *RegisterRequest, opts ...grpc.CallOption) (*RegisterReply, error)
	VerifyContact(ctx context.Context, in *VerifyContactRequest, opts ...grpc.CallOption) (*VerifyContactReply, error)
	// Supplies the entity review and TRISA verification status of a VASP
	Verification(ctx context.Context, in *VerificationRequest, opts ...grpc.CallOption) (*VerificationReply, error)
	// Health check and status request that mirrors the TRISAHealth service
	Status(ctx context.Context, in *HealthCheck, opts ...grpc.CallOption) (*ServiceState, error)
}

TRISADirectoryClient is the client API for TRISADirectory 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.

The TRISADirectory service specifies how TRISA clients should interact with a directory service to facilitate P2P transfers.

func NewTRISADirectoryClient 

func NewTRISADirectoryClient(cc grpc.ClientConnInterface) TRISADirectoryClient

type TRISADirectoryServer 

type TRISADirectoryServer interface {
	// Interactions with the Directory Service during a TRISA transfer
	// These are the primary Directory Service interactions.
	Lookup(context.Context, *LookupRequest) (*LookupReply, error)
	Search(context.Context, *SearchRequest) (*SearchReply, error)
	// Registration workflow and contact verification.
	Register(context.Context, *RegisterRequest) (*RegisterReply, error)
	VerifyContact(context.Context, *VerifyContactRequest) (*VerifyContactReply, error)
	// Supplies the entity review and TRISA verification status of a VASP
	Verification(context.Context, *VerificationRequest) (*VerificationReply, error)
	// Health check and status request that mirrors the TRISAHealth service
	Status(context.Context, *HealthCheck) (*ServiceState, error)
	// contains filtered or unexported methods
}

TRISADirectoryServer is the server API for TRISADirectory service. All implementations must embed UnimplementedTRISADirectoryServer for forward compatibility

The TRISADirectory service specifies how TRISA clients should interact with a directory service to facilitate P2P transfers.

type UnimplementedTRISADirectoryServer 

type UnimplementedTRISADirectoryServer struct {
}

UnimplementedTRISADirectoryServer must be embedded to have forward compatible implementations.

func (UnimplementedTRISADirectoryServer) Lookup 

func (UnimplementedTRISADirectoryServer) Lookup(context.Context, *LookupRequest) (*LookupReply, error)

func (UnimplementedTRISADirectoryServer) Register 

func (UnimplementedTRISADirectoryServer) Register(context.Context, *RegisterRequest) (*RegisterReply, error)

func (UnimplementedTRISADirectoryServer) Search 

func (UnimplementedTRISADirectoryServer) Search(context.Context, *SearchRequest) (*SearchReply, error)

func (UnimplementedTRISADirectoryServer) Status 

func (UnimplementedTRISADirectoryServer) Status(context.Context, *HealthCheck) (*ServiceState, error)

func (UnimplementedTRISADirectoryServer) Verification added in v0.2.0 

func (UnimplementedTRISADirectoryServer) Verification(context.Context, *VerificationRequest) (*VerificationReply, error)

func (UnimplementedTRISADirectoryServer) VerifyContact added in v0.2.0 

func (UnimplementedTRISADirectoryServer) VerifyContact(context.Context, *VerifyContactRequest) (*VerifyContactReply, error)

type UnsafeTRISADirectoryServer 

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

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

type VerificationReply added in v0.2.0 

type VerificationReply struct {

	// Status information
	VerificationStatus v1beta1.VerificationState ``                                                                                               /* 164-byte string literal not displayed */
	ServiceStatus      v1beta1.ServiceState      ``                                                                                               /* 144-byte string literal not displayed */
	VerifiedOn         string                    `protobuf:"bytes,3,opt,name=verified_on,json=verifiedOn,proto3" json:"verified_on,omitempty"`    // Should be an RFC 3339 Timestamp
	FirstListed        string                    `protobuf:"bytes,4,opt,name=first_listed,json=firstListed,proto3" json:"first_listed,omitempty"` // Should be an RFC 3339 Timestamp
	LastUpdated        string                    `protobuf:"bytes,5,opt,name=last_updated,json=lastUpdated,proto3" json:"last_updated,omitempty"` // Should be an RFC 3339 Timestamp
	RevokedOn          string                    `protobuf:"bytes,6,opt,name=revoked_on,json=revokedOn,proto3" json:"revoked_on,omitempty"`       // Should be an RFC 3339 Timestamp
	// contains filtered or unexported fields
}

func (*VerificationReply) Descriptor deprecated added in v0.2.0 

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

Deprecated: Use VerificationReply.ProtoReflect.Descriptor instead.

func (*VerificationReply) GetFirstListed added in v0.2.0 

func (x *VerificationReply) GetFirstListed() string

func (*VerificationReply) GetLastUpdated added in v0.2.0 

func (x *VerificationReply) GetLastUpdated() string

func (*VerificationReply) GetRevokedOn added in v0.2.0 

func (x *VerificationReply) GetRevokedOn() string

func (*VerificationReply) GetServiceStatus added in v0.2.0 

func (x *VerificationReply) GetServiceStatus() v1beta1.ServiceState

func (*VerificationReply) GetVerificationStatus added in v0.2.0 

func (x *VerificationReply) GetVerificationStatus() v1beta1.VerificationState

func (*VerificationReply) GetVerifiedOn added in v0.2.0 

func (x *VerificationReply) GetVerifiedOn() string

func (*VerificationReply) ProtoMessage added in v0.2.0 

func (*VerificationReply) ProtoMessage()

func (*VerificationReply) ProtoReflect added in v0.2.0 

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

func (*VerificationReply) Reset added in v0.2.0 

func (x *VerificationReply) Reset()

func (*VerificationReply) String added in v0.2.0 

func (x *VerificationReply) String() string

type VerificationRequest added in v0.2.0 

type VerificationRequest struct {

	// Unique identifier generated by the directory service, most common lookup field.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// The URL of the directory that registered the VASP. If ommitted, it is assumed
	// that the directory being queried is the registering VASP.
	RegisteredDirectory string `protobuf:"bytes,2,opt,name=registered_directory,json=registeredDirectory,proto3" json:"registered_directory,omitempty"`
	// The common name of the certificate, e.g. the domain name of the TRISA endpoint.
	// To use other name fields such as the legal business name, you must use search.
	CommonName string `protobuf:"bytes,3,opt,name=common_name,json=commonName,proto3" json:"common_name,omitempty"`
	// contains filtered or unexported fields
}

Check on the status of a VASP including its verification status and the service status if the TRISA directory service performs health check monitoring. The same parameters as the Lookup RPC are sent, but note that a TRISA directory service may refuse to return all or part of the status request.

func (*VerificationRequest) Descriptor deprecated added in v0.2.0 

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

Deprecated: Use VerificationRequest.ProtoReflect.Descriptor instead.

func (*VerificationRequest) GetCommonName added in v0.2.0 

func (x *VerificationRequest) GetCommonName() string

func (*VerificationRequest) GetId added in v0.2.0 

func (x *VerificationRequest) GetId() string

func (*VerificationRequest) GetRegisteredDirectory added in v0.2.0 

func (x *VerificationRequest) GetRegisteredDirectory() string

func (*VerificationRequest) ProtoMessage added in v0.2.0 

func (*VerificationRequest) ProtoMessage()

func (*VerificationRequest) ProtoReflect added in v0.2.0 

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

func (*VerificationRequest) Reset added in v0.2.0 

func (x *VerificationRequest) Reset()

func (*VerificationRequest) String added in v0.2.0 

func (x *VerificationRequest) String() string

type VerifyContactReply added in v0.2.0 

type VerifyContactReply struct {

	// If no error is specified, the verification request was successful.
	Error *Error `protobuf:"bytes,1,opt,name=error,proto3" json:"error,omitempty"`
	// The verification status of the VASP entity.
	Status  v1beta1.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 (*VerifyContactReply) Descriptor deprecated added in v0.2.0 

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

Deprecated: Use VerifyContactReply.ProtoReflect.Descriptor instead.

func (*VerifyContactReply) GetError added in v0.2.0 

func (x *VerifyContactReply) GetError() *Error

func (*VerifyContactReply) GetMessage added in v0.2.0 

func (x *VerifyContactReply) GetMessage() string

func (*VerifyContactReply) GetStatus added in v0.2.0 

func (x *VerifyContactReply) GetStatus() v1beta1.VerificationState

func (*VerifyContactReply) ProtoMessage added in v0.2.0 

func (*VerifyContactReply) ProtoMessage()

func (*VerifyContactReply) ProtoReflect added in v0.2.0 

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

func (*VerifyContactReply) Reset added in v0.2.0 

func (x *VerifyContactReply) Reset()

func (*VerifyContactReply) String added in v0.2.0 

func (x *VerifyContactReply) String() string

type VerifyContactRequest added in v0.2.0 

type VerifyContactRequest struct {
	Id    string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	Token string `protobuf:"bytes,2,opt,name=token,proto3" json:"token,omitempty"`
	// contains filtered or unexported fields
}

func (*VerifyContactRequest) Descriptor deprecated added in v0.2.0 

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

Deprecated: Use VerifyContactRequest.ProtoReflect.Descriptor instead.

func (*VerifyContactRequest) GetId added in v0.2.0 

func (x *VerifyContactRequest) GetId() string

func (*VerifyContactRequest) GetToken added in v0.2.0 

func (x *VerifyContactRequest) GetToken() string

func (*VerifyContactRequest) ProtoMessage added in v0.2.0 

func (*VerifyContactRequest) ProtoMessage()

func (*VerifyContactRequest) ProtoReflect added in v0.2.0 

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

func (*VerifyContactRequest) Reset added in v0.2.0 

func (x *VerifyContactRequest) Reset()

func (*VerifyContactRequest) String added in v0.2.0 

func (x *VerifyContactRequest) String() string

Source Files

View all Source files

Directories

Path Synopsis

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.