Documentation ¶
Index ¶
- Constants
- Variables
- func AddContact(vasp *pb.VASP, kind string, contact *pb.Contact) error
- func AppendAuditLog(vasp *pb.VASP, entry *AuditLogEntry) (err error)
- func AppendCertID(vasp *pb.VASP, certID string) (err error)
- func AppendCertReqID(vasp *pb.VASP, certreqID string) (err error)
- func AppendEmailLog(contact *pb.Contact, reason string, subject string) (err error)
- func ContactFromType(contacts *pb.Contacts, kind string) *pb.Contact
- func ContactHasEmail(contact *pb.Contact) bool
- func ContactIsVerified(contact *pb.Contact) (verified bool, err error)
- func ContactKindIsValid(kind string) bool
- func ContactVerifications(vasp *pb.VASP) (contacts map[string]bool, errs *multierror.Error)
- func DeleteCertReqID(vasp *pb.VASP, certreqID string) (err error)
- func DeleteContact(vasp *pb.VASP, kind string) error
- func DeleteReviewNote(vasp *pb.VASP, id string) (err error)
- func GetAdminVerificationToken(vasp *pb.VASP) (_ string, err error)
- func GetCertIDs(vasp *pb.VASP) (_ []string, err error)
- func GetCertReqIDs(vasp *pb.VASP) (_ []string, err error)
- func GetContactVerification(contact *pb.Contact) (_ string, _ bool, err error)
- func GetReviewNotes(vasp *pb.VASP) (_ map[string]*ReviewNote, err error)
- func IsTraveler(vasp *pb.VASP) bool
- func SetAdminVerificationToken(vasp *pb.VASP, token string) (err error)
- func SetContactVerification(contact *pb.Contact, token string, verified bool) (err error)
- func UpdateCertificateRequestStatus(request *CertificateRequest, state CertificateRequestState, description string, ...) (err error)
- func UpdateVerificationStatus(vasp *pb.VASP, state pb.VerificationState, description string, source string) error
- func VerifiedContacts(vasp *pb.VASP) (contacts map[string]string)
- type AuditLogEntry
- func (*AuditLogEntry) Descriptor() ([]byte, []int)deprecated
- func (x *AuditLogEntry) GetCurrentState() v1beta1.VerificationState
- func (x *AuditLogEntry) GetDescription() string
- func (x *AuditLogEntry) GetPreviousState() v1beta1.VerificationState
- func (x *AuditLogEntry) GetSource() string
- func (x *AuditLogEntry) GetTimestamp() string
- func (*AuditLogEntry) ProtoMessage()
- func (x *AuditLogEntry) ProtoReflect() protoreflect.Message
- func (x *AuditLogEntry) Reset()
- func (x *AuditLogEntry) String() string
- type Certificate
- func (*Certificate) Descriptor() ([]byte, []int)deprecated
- func (x *Certificate) GetDetails() *v1beta1.Certificate
- func (x *Certificate) GetId() string
- func (x *Certificate) GetRequest() string
- func (x *Certificate) GetStatus() CertificateState
- func (x *Certificate) GetVasp() string
- func (*Certificate) ProtoMessage()
- func (x *Certificate) ProtoReflect() protoreflect.Message
- func (x *Certificate) Reset()
- func (x *Certificate) String() string
- type CertificateRequest
- func (*CertificateRequest) Descriptor() ([]byte, []int)deprecated
- func (x *CertificateRequest) GetAuditLog() []*CertificateRequestLogEntry
- func (x *CertificateRequest) GetAuthorityId() int64
- func (x *CertificateRequest) GetBatchId() int64
- func (x *CertificateRequest) GetBatchName() string
- func (x *CertificateRequest) GetBatchStatus() string
- func (x *CertificateRequest) GetCertificate() string
- func (x *CertificateRequest) GetCommonName() string
- func (x *CertificateRequest) GetCreated() string
- func (x *CertificateRequest) GetCreationDate() string
- func (x *CertificateRequest) GetId() string
- func (x *CertificateRequest) GetModified() string
- func (x *CertificateRequest) GetOrderNumber() int64
- func (x *CertificateRequest) GetParams() map[string]string
- func (x *CertificateRequest) GetProfile() string
- func (x *CertificateRequest) GetRejectReason() string
- func (x *CertificateRequest) GetStatus() CertificateRequestState
- func (x *CertificateRequest) GetVasp() string
- func (*CertificateRequest) ProtoMessage()
- func (x *CertificateRequest) ProtoReflect() protoreflect.Message
- func (x *CertificateRequest) Reset()
- func (x *CertificateRequest) String() string
- type CertificateRequestLogEntry
- func (*CertificateRequestLogEntry) Descriptor() ([]byte, []int)deprecated
- func (x *CertificateRequestLogEntry) GetCurrentState() CertificateRequestState
- func (x *CertificateRequestLogEntry) GetDescription() string
- func (x *CertificateRequestLogEntry) GetPreviousState() CertificateRequestState
- func (x *CertificateRequestLogEntry) GetSource() string
- func (x *CertificateRequestLogEntry) GetTimestamp() string
- func (*CertificateRequestLogEntry) ProtoMessage()
- func (x *CertificateRequestLogEntry) ProtoReflect() protoreflect.Message
- func (x *CertificateRequestLogEntry) Reset()
- func (x *CertificateRequestLogEntry) String() string
- type CertificateRequestState
- func (CertificateRequestState) Descriptor() protoreflect.EnumDescriptor
- func (x CertificateRequestState) Enum() *CertificateRequestState
- func (CertificateRequestState) EnumDescriptor() ([]byte, []int)deprecated
- func (x CertificateRequestState) Number() protoreflect.EnumNumber
- func (x CertificateRequestState) String() string
- func (CertificateRequestState) Type() protoreflect.EnumType
- type CertificateState
- func (CertificateState) Descriptor() protoreflect.EnumDescriptor
- func (x CertificateState) Enum() *CertificateState
- func (CertificateState) EnumDescriptor() ([]byte, []int)deprecated
- func (x CertificateState) Number() protoreflect.EnumNumber
- func (x CertificateState) String() string
- func (CertificateState) Type() protoreflect.EnumType
- type ContactIterator
- type EmailLogEntry
- func (*EmailLogEntry) Descriptor() ([]byte, []int)deprecated
- func (x *EmailLogEntry) GetReason() string
- func (x *EmailLogEntry) GetSubject() string
- func (x *EmailLogEntry) GetTimestamp() string
- func (*EmailLogEntry) ProtoMessage()
- func (x *EmailLogEntry) ProtoReflect() protoreflect.Message
- func (x *EmailLogEntry) Reset()
- func (x *EmailLogEntry) String() string
- type GDSContactExtraData
- func (*GDSContactExtraData) Descriptor() ([]byte, []int)deprecated
- func (x *GDSContactExtraData) GetEmailLog() []*EmailLogEntry
- func (x *GDSContactExtraData) GetToken() string
- func (x *GDSContactExtraData) GetVerified() bool
- func (*GDSContactExtraData) ProtoMessage()
- func (x *GDSContactExtraData) ProtoReflect() protoreflect.Message
- func (x *GDSContactExtraData) Reset()
- func (x *GDSContactExtraData) String() string
- type GDSExtraData
- func (*GDSExtraData) Descriptor() ([]byte, []int)deprecated
- func (x *GDSExtraData) GetAdminVerificationToken() string
- func (x *GDSExtraData) GetAuditLog() []*AuditLogEntry
- func (x *GDSExtraData) GetCertificateRequests() []string
- func (x *GDSExtraData) GetCertificates() []string
- func (x *GDSExtraData) GetReviewNotes() map[string]*ReviewNote
- func (*GDSExtraData) ProtoMessage()
- func (x *GDSExtraData) ProtoReflect() protoreflect.Message
- func (x *GDSExtraData) Reset()
- func (x *GDSExtraData) String() string
- type PageCursor
- func (*PageCursor) Descriptor() ([]byte, []int)deprecated
- func (pc *PageCursor) Dump() (token string, err error)
- func (x *PageCursor) GetNextVasp() string
- func (x *PageCursor) GetPageSize() int32
- func (pc *PageCursor) Load(token string) (err error)
- func (*PageCursor) ProtoMessage()
- func (x *PageCursor) ProtoReflect() protoreflect.Message
- func (x *PageCursor) Reset()
- func (x *PageCursor) String() string
- type ReviewNote
- func (*ReviewNote) Descriptor() ([]byte, []int)deprecated
- func (x *ReviewNote) GetAuthor() string
- func (x *ReviewNote) GetCreated() string
- func (x *ReviewNote) GetEditor() string
- func (x *ReviewNote) GetId() string
- func (x *ReviewNote) GetModified() string
- func (x *ReviewNote) GetText() string
- func (*ReviewNote) ProtoMessage()
- func (x *ReviewNote) ProtoReflect() protoreflect.Message
- func (x *ReviewNote) Reset()
- func (x *ReviewNote) String() string
Constants ¶
const ( TechnicalContact = "technical" AdministrativeContact = "administrative" LegalContact = "legal" BillingContact = "billing" VerificationTokenLength = 48 )
Variables ¶
var ( ErrorAlreadyExists = errors.New("already exists") ErrorNotFound = errors.New("not found") )
var ( CertificateState_name = map[int32]string{ 0: "ISSUED", 1: "EXPIRED", 2: "REVOKED", } CertificateState_value = map[string]int32{ "ISSUED": 0, "EXPIRED": 1, "REVOKED": 2, } )
Enum value maps for CertificateState.
var ( CertificateRequestState_name = map[int32]string{ 0: "INITIALIZED", 1: "READY_TO_SUBMIT", 2: "PROCESSING", 3: "DOWNLOADING", 4: "DOWNLOADED", 5: "COMPLETED", 6: "CR_REJECTED", 7: "CR_ERRORED", } CertificateRequestState_value = map[string]int32{ "INITIALIZED": 0, "READY_TO_SUBMIT": 1, "PROCESSING": 2, "DOWNLOADING": 3, "DOWNLOADED": 4, "COMPLETED": 5, "CR_REJECTED": 6, "CR_ERRORED": 7, } )
Enum value maps for CertificateRequestState.
var File_gds_models_v1_models_proto protoreflect.FileDescriptor
Functions ¶
func AddContact ¶ added in v1.3.1
Adds a contact on the VASP object.
func AppendAuditLog ¶
func AppendAuditLog(vasp *pb.VASP, entry *AuditLogEntry) (err error)
Append an AuditLogEntry to the extra data on the VASP record.
func AppendCertID ¶ added in v1.5.0
AppendCertID adds the certificate ID to the VASP if it's not already added.
func AppendCertReqID ¶
AppendCertReqID adds the certificate request ID to the VASP if its not already added.
func AppendEmailLog ¶
Create and add a new entry to the EmailLog on the extra data on the Contact record.
func ContactFromType ¶ added in v1.3.1
Returns the corresponding contact object for the given contact type.
func ContactHasEmail ¶ added in v1.3.1
Returns True if a Contact is not nil and has an email address.
func ContactIsVerified ¶ added in v1.3.1
Returns True if a Contact is verified.
func ContactKindIsValid ¶ added in v1.3.1
Returns True if the contact kind is one of the recognized strings.
func ContactVerifications ¶
ContactVerifications returns a map of contact type to verified status, omitting any contacts that do not exist.
func DeleteCertReqID ¶ added in v1.5.0
DeleteCertReqID removes the certificate request ID from the VASP if it exists.
func DeleteContact ¶ added in v1.3.1
Deletes a contact on the VASP object by setting it to nil.
func DeleteReviewNote ¶
DeleteReviewNote deletes a specified note on the VASP.
func GetAdminVerificationToken ¶
GetAdminVerificationToken from the extra data on the VASP record.
func GetCertIDs ¶ added in v1.5.0
GetCertIDs returns the list of associated Certificate IDs for the VASP record.
func GetCertReqIDs ¶
GetCertReqIDs returns the list of associated CertificateRequest IDs for the VASP record.
func GetContactVerification ¶
GetContactVerification token and verified status from the extra data field on the Contact.
func GetReviewNotes ¶
func GetReviewNotes(vasp *pb.VASP) (_ map[string]*ReviewNote, err error)
GetReviewNotes returns all of the review notes for a VASP as a map.
func IsTraveler ¶
IsTraveler returns true if the VASP common name ends in traveler.ciphertrace.com
func SetAdminVerificationToken ¶
SetAdminVerificationToken on the extra data on the VASP record.
func SetContactVerification ¶
SetContactVerification token and verified status on the Contact record.
func UpdateCertificateRequestStatus ¶
func UpdateCertificateRequestStatus(request *CertificateRequest, state CertificateRequestState, description string, source string) (err error)
UpdateCertificateRequestStatus changes the status of a CertificateRequest and appends an entry to the audit log.
func UpdateVerificationStatus ¶
func UpdateVerificationStatus(vasp *pb.VASP, state pb.VerificationState, description string, source string) error
UpdateVerificationStatus changes the verification state of a VASP and appends a new entry to the audit log on the extra.
Types ¶
type AuditLogEntry ¶
type AuditLogEntry struct { // RFC3339 timestamp Timestamp string `protobuf:"bytes,1,opt,name=timestamp,proto3" json:"timestamp,omitempty"` // Previous verification state (handled internally) and current verification state PreviousState v1beta1.VerificationState `` /* 149-byte string literal not displayed */ CurrentState v1beta1.VerificationState `` /* 146-byte string literal not displayed */ // Description which can be supplied by the Admin when making a state change // (e.g., "resent emails") Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"` // Email address of the Admin who made the state change, "automated" if the state // change happened automatically Source string `protobuf:"bytes,5,opt,name=source,proto3" json:"source,omitempty"` // contains filtered or unexported fields }
AuditLogEntry contains information about an event relevant to a VASP (e.g., verification state changes).
func GetAuditLog ¶
func GetAuditLog(vasp *pb.VASP) (_ []*AuditLogEntry, err error)
GetAuditLog from the extra data on the VASP record.
func (*AuditLogEntry) Descriptor
deprecated
func (*AuditLogEntry) Descriptor() ([]byte, []int)
Deprecated: Use AuditLogEntry.ProtoReflect.Descriptor instead.
func (*AuditLogEntry) GetCurrentState ¶
func (x *AuditLogEntry) GetCurrentState() v1beta1.VerificationState
func (*AuditLogEntry) GetDescription ¶
func (x *AuditLogEntry) GetDescription() string
func (*AuditLogEntry) GetPreviousState ¶
func (x *AuditLogEntry) GetPreviousState() v1beta1.VerificationState
func (*AuditLogEntry) GetSource ¶
func (x *AuditLogEntry) GetSource() string
func (*AuditLogEntry) GetTimestamp ¶
func (x *AuditLogEntry) GetTimestamp() string
func (*AuditLogEntry) ProtoMessage ¶
func (*AuditLogEntry) ProtoMessage()
func (*AuditLogEntry) ProtoReflect ¶
func (x *AuditLogEntry) ProtoReflect() protoreflect.Message
func (*AuditLogEntry) Reset ¶
func (x *AuditLogEntry) Reset()
func (*AuditLogEntry) String ¶
func (x *AuditLogEntry) String() string
type Certificate ¶ added in v1.5.0
type Certificate struct { // A unique identifier generated by the directory service for storage Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` // CertificateRequest that this certificate is associated with Request string `protobuf:"bytes,2,opt,name=request,proto3" json:"request,omitempty"` // VASP that this certificate belongs to Vasp string `protobuf:"bytes,3,opt,name=vasp,proto3" json:"vasp,omitempty"` // Current status of the certificate Status CertificateState `protobuf:"varint,4,opt,name=status,proto3,enum=gds.models.v1.CertificateState" json:"status,omitempty"` // Certificate details Details *v1beta1.Certificate `protobuf:"bytes,5,opt,name=details,proto3" json:"details,omitempty"` // contains filtered or unexported fields }
Certificate embeds a TRISA Certificate into a record that can be stored in the database for certificate management.
func NewCertificate ¶ added in v1.5.0
func NewCertificate(vasp *pb.VASP, certRequest *CertificateRequest, data *pb.Certificate) (cert *Certificate, err error)
NewCertificate creates and returns a certificate associated with a VASP.
func (*Certificate) Descriptor
deprecated
added in
v1.5.0
func (*Certificate) Descriptor() ([]byte, []int)
Deprecated: Use Certificate.ProtoReflect.Descriptor instead.
func (*Certificate) GetDetails ¶ added in v1.5.0
func (x *Certificate) GetDetails() *v1beta1.Certificate
func (*Certificate) GetId ¶ added in v1.5.0
func (x *Certificate) GetId() string
func (*Certificate) GetRequest ¶ added in v1.5.0
func (x *Certificate) GetRequest() string
func (*Certificate) GetStatus ¶ added in v1.5.0
func (x *Certificate) GetStatus() CertificateState
func (*Certificate) GetVasp ¶ added in v1.5.0
func (x *Certificate) GetVasp() string
func (*Certificate) ProtoMessage ¶ added in v1.5.0
func (*Certificate) ProtoMessage()
func (*Certificate) ProtoReflect ¶ added in v1.5.0
func (x *Certificate) ProtoReflect() protoreflect.Message
func (*Certificate) Reset ¶ added in v1.5.0
func (x *Certificate) Reset()
func (*Certificate) String ¶ added in v1.5.0
func (x *Certificate) String() string
type CertificateRequest ¶
type CertificateRequest struct { // A unique identifier generated by the directory service, should be a globally // unique identifier generated by the replica specified in requesting_replica. Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` // VASP information for the request Vasp string `protobuf:"bytes,2,opt,name=vasp,proto3" json:"vasp,omitempty"` CommonName string `protobuf:"bytes,3,opt,name=common_name,json=commonName,proto3" json:"common_name,omitempty"` // Request pipeline status Status CertificateRequestState `protobuf:"varint,4,opt,name=status,proto3,enum=gds.models.v1.CertificateRequestState" json:"status,omitempty"` // Sectigo create single certificate batch metadata AuthorityId int64 `protobuf:"varint,5,opt,name=authority_id,json=authorityId,proto3" json:"authority_id,omitempty"` BatchId int64 `protobuf:"varint,6,opt,name=batch_id,json=batchId,proto3" json:"batch_id,omitempty"` BatchName string `protobuf:"bytes,7,opt,name=batch_name,json=batchName,proto3" json:"batch_name,omitempty"` BatchStatus string `protobuf:"bytes,8,opt,name=batch_status,json=batchStatus,proto3" json:"batch_status,omitempty"` OrderNumber int64 `protobuf:"varint,9,opt,name=order_number,json=orderNumber,proto3" json:"order_number,omitempty"` CreationDate string `protobuf:"bytes,10,opt,name=creation_date,json=creationDate,proto3" json:"creation_date,omitempty"` Profile string `protobuf:"bytes,11,opt,name=profile,proto3" json:"profile,omitempty"` RejectReason string `protobuf:"bytes,12,opt,name=reject_reason,json=rejectReason,proto3" json:"reject_reason,omitempty"` // Generic parameters used for making requests to certificate issuing services Params map[string]string `` /* 154-byte string literal not displayed */ // Logging information timestamps Created string `protobuf:"bytes,15,opt,name=created,proto3" json:"created,omitempty"` Modified string `protobuf:"bytes,16,opt,name=modified,proto3" json:"modified,omitempty"` // Log of historical request states AuditLog []*CertificateRequestLogEntry `protobuf:"bytes,17,rep,name=audit_log,json=auditLog,proto3" json:"audit_log,omitempty"` // The certificate ID downloaded from the request, if completed successfully Certificate string `protobuf:"bytes,18,opt,name=certificate,proto3" json:"certificate,omitempty"` // contains filtered or unexported fields }
Certificate requests are maintained separately from the VASP record since they should not be replicated. E.g. every directory process is responsible for certificate issuance and only public keys and certificate metadata should be exchanged between directories.
func NewCertificateRequest ¶ added in v1.3.1
func NewCertificateRequest(vasp *pb.VASP) (certRequest *CertificateRequest, err error)
NewCertificateRequest creates and returns a new certificate request to be associated with a VASP.
func (*CertificateRequest) Descriptor
deprecated
func (*CertificateRequest) Descriptor() ([]byte, []int)
Deprecated: Use CertificateRequest.ProtoReflect.Descriptor instead.
func (*CertificateRequest) GetAuditLog ¶
func (x *CertificateRequest) GetAuditLog() []*CertificateRequestLogEntry
func (*CertificateRequest) GetAuthorityId ¶
func (x *CertificateRequest) GetAuthorityId() int64
func (*CertificateRequest) GetBatchId ¶
func (x *CertificateRequest) GetBatchId() int64
func (*CertificateRequest) GetBatchName ¶
func (x *CertificateRequest) GetBatchName() string
func (*CertificateRequest) GetBatchStatus ¶
func (x *CertificateRequest) GetBatchStatus() string
func (*CertificateRequest) GetCertificate ¶ added in v1.5.0
func (x *CertificateRequest) GetCertificate() string
func (*CertificateRequest) GetCommonName ¶
func (x *CertificateRequest) GetCommonName() string
func (*CertificateRequest) GetCreated ¶
func (x *CertificateRequest) GetCreated() string
func (*CertificateRequest) GetCreationDate ¶
func (x *CertificateRequest) GetCreationDate() string
func (*CertificateRequest) GetId ¶
func (x *CertificateRequest) GetId() string
func (*CertificateRequest) GetModified ¶
func (x *CertificateRequest) GetModified() string
func (*CertificateRequest) GetOrderNumber ¶
func (x *CertificateRequest) GetOrderNumber() int64
func (*CertificateRequest) GetParams ¶ added in v1.3.1
func (x *CertificateRequest) GetParams() map[string]string
func (*CertificateRequest) GetProfile ¶
func (x *CertificateRequest) GetProfile() string
func (*CertificateRequest) GetRejectReason ¶
func (x *CertificateRequest) GetRejectReason() string
func (*CertificateRequest) GetStatus ¶
func (x *CertificateRequest) GetStatus() CertificateRequestState
func (*CertificateRequest) GetVasp ¶
func (x *CertificateRequest) GetVasp() string
func (*CertificateRequest) ProtoMessage ¶
func (*CertificateRequest) ProtoMessage()
func (*CertificateRequest) ProtoReflect ¶
func (x *CertificateRequest) ProtoReflect() protoreflect.Message
func (*CertificateRequest) Reset ¶
func (x *CertificateRequest) Reset()
func (*CertificateRequest) String ¶
func (x *CertificateRequest) String() string
type CertificateRequestLogEntry ¶
type CertificateRequestLogEntry struct { // RFC3339 timestamp Timestamp string `protobuf:"bytes,1,opt,name=timestamp,proto3" json:"timestamp,omitempty"` // Previous request state (handled internally) and current request state PreviousState CertificateRequestState `` /* 144-byte string literal not displayed */ CurrentState CertificateRequestState `` /* 141-byte string literal not displayed */ // Description of the current state of the certificate request Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"` // Email address of the Admin who made the state change, "automated" if the state // change happened automatically Source string `protobuf:"bytes,5,opt,name=source,proto3" json:"source,omitempty"` // contains filtered or unexported fields }
CertificateRequestLogEntry contains information about the state of a certificate request.
func (*CertificateRequestLogEntry) Descriptor
deprecated
func (*CertificateRequestLogEntry) Descriptor() ([]byte, []int)
Deprecated: Use CertificateRequestLogEntry.ProtoReflect.Descriptor instead.
func (*CertificateRequestLogEntry) GetCurrentState ¶
func (x *CertificateRequestLogEntry) GetCurrentState() CertificateRequestState
func (*CertificateRequestLogEntry) GetDescription ¶
func (x *CertificateRequestLogEntry) GetDescription() string
func (*CertificateRequestLogEntry) GetPreviousState ¶
func (x *CertificateRequestLogEntry) GetPreviousState() CertificateRequestState
func (*CertificateRequestLogEntry) GetSource ¶
func (x *CertificateRequestLogEntry) GetSource() string
func (*CertificateRequestLogEntry) GetTimestamp ¶
func (x *CertificateRequestLogEntry) GetTimestamp() string
func (*CertificateRequestLogEntry) ProtoMessage ¶
func (*CertificateRequestLogEntry) ProtoMessage()
func (*CertificateRequestLogEntry) ProtoReflect ¶
func (x *CertificateRequestLogEntry) ProtoReflect() protoreflect.Message
func (*CertificateRequestLogEntry) Reset ¶
func (x *CertificateRequestLogEntry) Reset()
func (*CertificateRequestLogEntry) String ¶
func (x *CertificateRequestLogEntry) String() string
type CertificateRequestState ¶
type CertificateRequestState int32
const ( CertificateRequestState_INITIALIZED CertificateRequestState = 0 CertificateRequestState_READY_TO_SUBMIT CertificateRequestState = 1 CertificateRequestState_PROCESSING CertificateRequestState = 2 CertificateRequestState_DOWNLOADING CertificateRequestState = 3 CertificateRequestState_DOWNLOADED CertificateRequestState = 4 CertificateRequestState_COMPLETED CertificateRequestState = 5 CertificateRequestState_CR_REJECTED CertificateRequestState = 6 CertificateRequestState_CR_ERRORED CertificateRequestState = 7 )
func (CertificateRequestState) Descriptor ¶
func (CertificateRequestState) Descriptor() protoreflect.EnumDescriptor
func (CertificateRequestState) Enum ¶
func (x CertificateRequestState) Enum() *CertificateRequestState
func (CertificateRequestState) EnumDescriptor
deprecated
func (CertificateRequestState) EnumDescriptor() ([]byte, []int)
Deprecated: Use CertificateRequestState.Descriptor instead.
func (CertificateRequestState) Number ¶
func (x CertificateRequestState) Number() protoreflect.EnumNumber
func (CertificateRequestState) String ¶
func (x CertificateRequestState) String() string
func (CertificateRequestState) Type ¶
func (CertificateRequestState) Type() protoreflect.EnumType
type CertificateState ¶ added in v1.5.0
type CertificateState int32
const ( CertificateState_ISSUED CertificateState = 0 CertificateState_EXPIRED CertificateState = 1 CertificateState_REVOKED CertificateState = 2 )
func (CertificateState) Descriptor ¶ added in v1.5.0
func (CertificateState) Descriptor() protoreflect.EnumDescriptor
func (CertificateState) Enum ¶ added in v1.5.0
func (x CertificateState) Enum() *CertificateState
func (CertificateState) EnumDescriptor
deprecated
added in
v1.5.0
func (CertificateState) EnumDescriptor() ([]byte, []int)
Deprecated: Use CertificateState.Descriptor instead.
func (CertificateState) Number ¶ added in v1.5.0
func (x CertificateState) Number() protoreflect.EnumNumber
func (CertificateState) String ¶ added in v1.5.0
func (x CertificateState) String() string
func (CertificateState) Type ¶ added in v1.5.0
func (CertificateState) Type() protoreflect.EnumType
type ContactIterator ¶ added in v1.3.1
type ContactIterator struct {
// contains filtered or unexported fields
}
func NewContactIterator ¶ added in v1.3.1
func NewContactIterator(contacts *pb.Contacts, requireEmail bool, requireVerified bool) *ContactIterator
Returns a new ContactIterator which has Next() and Value() methods that can be used to iterate over contacts in a Contacts object.
func (*ContactIterator) Error ¶ added in v1.3.1
func (i *ContactIterator) Error() (err error)
Error returns a multi-error that describes any errors that occurred during iteration for any contact. This will allow us to log all errors once.
func (*ContactIterator) Next ¶ added in v1.3.1
func (i *ContactIterator) Next() bool
Moves the ContactIterator to the next existing contact and returns true if there is one, false if the iteration is complete.
type EmailLogEntry ¶
type EmailLogEntry struct { // RFC3339 timestamp Timestamp string `protobuf:"bytes,1,opt,name=timestamp,proto3" json:"timestamp,omitempty"` // Reason why the email was sent Reason string `protobuf:"bytes,2,opt,name=reason,proto3" json:"reason,omitempty"` // Subject line of the email Subject string `protobuf:"bytes,3,opt,name=subject,proto3" json:"subject,omitempty"` // contains filtered or unexported fields }
EmailLogEntry contains information about a single email message that was sent.
func GetEmailLog ¶
func GetEmailLog(contact *pb.Contact) (_ []*EmailLogEntry, err error)
GetEmailLog from the extra data on the Contact record.
func (*EmailLogEntry) Descriptor
deprecated
func (*EmailLogEntry) Descriptor() ([]byte, []int)
Deprecated: Use EmailLogEntry.ProtoReflect.Descriptor instead.
func (*EmailLogEntry) GetReason ¶
func (x *EmailLogEntry) GetReason() string
func (*EmailLogEntry) GetSubject ¶
func (x *EmailLogEntry) GetSubject() string
func (*EmailLogEntry) GetTimestamp ¶
func (x *EmailLogEntry) GetTimestamp() string
func (*EmailLogEntry) ProtoMessage ¶
func (*EmailLogEntry) ProtoMessage()
func (*EmailLogEntry) ProtoReflect ¶
func (x *EmailLogEntry) ProtoReflect() protoreflect.Message
func (*EmailLogEntry) Reset ¶
func (x *EmailLogEntry) Reset()
func (*EmailLogEntry) String ¶
func (x *EmailLogEntry) String() string
type GDSContactExtraData ¶
type GDSContactExtraData struct { // Token for email verification Verified bool `protobuf:"varint,1,opt,name=verified,proto3" json:"verified,omitempty"` Token string `protobuf:"bytes,2,opt,name=token,proto3" json:"token,omitempty"` // Email audit log EmailLog []*EmailLogEntry `protobuf:"bytes,3,rep,name=email_log,json=emailLog,proto3" json:"email_log,omitempty"` // contains filtered or unexported fields }
GDSContactExtraData contains all GDS-specific extra data for a Contact record.
func (*GDSContactExtraData) Descriptor
deprecated
func (*GDSContactExtraData) Descriptor() ([]byte, []int)
Deprecated: Use GDSContactExtraData.ProtoReflect.Descriptor instead.
func (*GDSContactExtraData) GetEmailLog ¶
func (x *GDSContactExtraData) GetEmailLog() []*EmailLogEntry
func (*GDSContactExtraData) GetToken ¶
func (x *GDSContactExtraData) GetToken() string
func (*GDSContactExtraData) GetVerified ¶
func (x *GDSContactExtraData) GetVerified() bool
func (*GDSContactExtraData) ProtoMessage ¶
func (*GDSContactExtraData) ProtoMessage()
func (*GDSContactExtraData) ProtoReflect ¶
func (x *GDSContactExtraData) ProtoReflect() protoreflect.Message
func (*GDSContactExtraData) Reset ¶
func (x *GDSContactExtraData) Reset()
func (*GDSContactExtraData) String ¶
func (x *GDSContactExtraData) String() string
type GDSExtraData ¶
type GDSExtraData struct { // Temporary: verification token for light weight authentication for verification // TODO: replace with admin API that uses authentication AdminVerificationToken string `` /* 129-byte string literal not displayed */ // Audit log which records events relevant to a VASP AuditLog []*AuditLogEntry `protobuf:"bytes,2,rep,name=audit_log,json=auditLog,proto3" json:"audit_log,omitempty"` // Record of all the review notes associated with this VASP ReviewNotes map[string]*ReviewNote `` /* 182-byte string literal not displayed */ // Certificate requests associated with this VASP CertificateRequests []string `protobuf:"bytes,4,rep,name=certificate_requests,json=certificateRequests,proto3" json:"certificate_requests,omitempty"` // Certificate IDs associated with this VASP Certificates []string `protobuf:"bytes,5,rep,name=certificates,proto3" json:"certificates,omitempty"` // contains filtered or unexported fields }
GDSExtraData contains all GDS-specific extra data for a VASP record.
func (*GDSExtraData) Descriptor
deprecated
func (*GDSExtraData) Descriptor() ([]byte, []int)
Deprecated: Use GDSExtraData.ProtoReflect.Descriptor instead.
func (*GDSExtraData) GetAdminVerificationToken ¶
func (x *GDSExtraData) GetAdminVerificationToken() string
func (*GDSExtraData) GetAuditLog ¶
func (x *GDSExtraData) GetAuditLog() []*AuditLogEntry
func (*GDSExtraData) GetCertificateRequests ¶
func (x *GDSExtraData) GetCertificateRequests() []string
func (*GDSExtraData) GetCertificates ¶ added in v1.5.0
func (x *GDSExtraData) GetCertificates() []string
func (*GDSExtraData) GetReviewNotes ¶
func (x *GDSExtraData) GetReviewNotes() map[string]*ReviewNote
func (*GDSExtraData) ProtoMessage ¶
func (*GDSExtraData) ProtoMessage()
func (*GDSExtraData) ProtoReflect ¶
func (x *GDSExtraData) ProtoReflect() protoreflect.Message
func (*GDSExtraData) Reset ¶
func (x *GDSExtraData) Reset()
func (*GDSExtraData) String ¶
func (x *GDSExtraData) String() string
type PageCursor ¶
type PageCursor struct { PageSize int32 `protobuf:"varint,1,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"` // the number of results returned on each iteration. NextVasp string `protobuf:"bytes,2,opt,name=next_vasp,json=nextVasp,proto3" json:"next_vasp,omitempty"` // the VASP id to start the iteration from // contains filtered or unexported fields }
Implements a protocol buffer struct for state managed pagination. This struct will be marshaled into a url-safe base64 encoded string and sent to the user as the next_page_token. The server should decode this struct to determine where to continue iteration for the next page. Note that the server should check to make sure the page size in the cursor matches the page size in the request. See https://cloud.google.com/apis/design/design_patterns#list_pagination for more.
func (*PageCursor) Descriptor
deprecated
func (*PageCursor) Descriptor() ([]byte, []int)
Deprecated: Use PageCursor.ProtoReflect.Descriptor instead.
func (*PageCursor) Dump ¶
func (pc *PageCursor) Dump() (token string, err error)
Dump a PageCursor into a page_token string. This is very similar code to trtl.internal but decoupled so Trtl and GDS aren't dependent on each other.
func (*PageCursor) GetNextVasp ¶
func (x *PageCursor) GetNextVasp() string
func (*PageCursor) GetPageSize ¶
func (x *PageCursor) GetPageSize() int32
func (*PageCursor) Load ¶
func (pc *PageCursor) Load(token string) (err error)
Load a PageCursor from a page_token string. This is very similar code to trtl.internal but decoupled so Trtl and GDS aren't dependent on each other.
func (*PageCursor) ProtoMessage ¶
func (*PageCursor) ProtoMessage()
func (*PageCursor) ProtoReflect ¶
func (x *PageCursor) ProtoReflect() protoreflect.Message
func (*PageCursor) Reset ¶
func (x *PageCursor) Reset()
func (*PageCursor) String ¶
func (x *PageCursor) String() string
type ReviewNote ¶
type ReviewNote struct { // Unique identifier of the note Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` // RFC3339 timestamps representing when the note was created, modified Created string `protobuf:"bytes,2,opt,name=created,proto3" json:"created,omitempty"` Modified string `protobuf:"bytes,3,opt,name=modified,proto3" json:"modified,omitempty"` // Email address of the author and the last editor Author string `protobuf:"bytes,4,opt,name=author,proto3" json:"author,omitempty"` Editor string `protobuf:"bytes,5,opt,name=editor,proto3" json:"editor,omitempty"` // Actual text in the note Text string `protobuf:"bytes,6,opt,name=text,proto3" json:"text,omitempty"` // contains filtered or unexported fields }
func CreateReviewNote ¶
func CreateReviewNote(vasp *pb.VASP, id string, author string, text string) (note *ReviewNote, err error)
CreateReviewNote creates a note on the VASP given the specified note id.
func UpdateReviewNote ¶
func UpdateReviewNote(vasp *pb.VASP, id string, editor string, text string) (note *ReviewNote, err error)
UpdateReviewNote updates a specified note on the VASP.
func (*ReviewNote) Descriptor
deprecated
func (*ReviewNote) Descriptor() ([]byte, []int)
Deprecated: Use ReviewNote.ProtoReflect.Descriptor instead.
func (*ReviewNote) GetAuthor ¶
func (x *ReviewNote) GetAuthor() string
func (*ReviewNote) GetCreated ¶
func (x *ReviewNote) GetCreated() string
func (*ReviewNote) GetEditor ¶
func (x *ReviewNote) GetEditor() string
func (*ReviewNote) GetId ¶
func (x *ReviewNote) GetId() string
func (*ReviewNote) GetModified ¶
func (x *ReviewNote) GetModified() string
func (*ReviewNote) GetText ¶
func (x *ReviewNote) GetText() string
func (*ReviewNote) ProtoMessage ¶
func (*ReviewNote) ProtoMessage()
func (*ReviewNote) ProtoReflect ¶
func (x *ReviewNote) ProtoReflect() protoreflect.Message
func (*ReviewNote) Reset ¶
func (x *ReviewNote) Reset()
func (*ReviewNote) String ¶
func (x *ReviewNote) String() string