credential

package
v1.14.0 Latest Latest
Warning

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

Go to latest
Published: Mar 27, 2024 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Index

Constants

View Source
const (
	VerifiableCredential_IssueFromTemplate_FullMethodName     = "/services.verifiablecredentials.v1.VerifiableCredential/IssueFromTemplate"
	VerifiableCredential_CheckStatus_FullMethodName           = "/services.verifiablecredentials.v1.VerifiableCredential/CheckStatus"
	VerifiableCredential_UpdateStatus_FullMethodName          = "/services.verifiablecredentials.v1.VerifiableCredential/UpdateStatus"
	VerifiableCredential_CreateProof_FullMethodName           = "/services.verifiablecredentials.v1.VerifiableCredential/CreateProof"
	VerifiableCredential_VerifyProof_FullMethodName           = "/services.verifiablecredentials.v1.VerifiableCredential/VerifyProof"
	VerifiableCredential_Send_FullMethodName                  = "/services.verifiablecredentials.v1.VerifiableCredential/Send"
	VerifiableCredential_CreateCredentialOffer_FullMethodName = "/services.verifiablecredentials.v1.VerifiableCredential/CreateCredentialOffer"
	VerifiableCredential_AcceptCredential_FullMethodName      = "/services.verifiablecredentials.v1.VerifiableCredential/AcceptCredential"
	VerifiableCredential_RejectCredential_FullMethodName      = "/services.verifiablecredentials.v1.VerifiableCredential/RejectCredential"
)

Variables

View Source
var (
	SignatureType_name = map[int32]string{
		0: "UNSPECIFIED",
		1: "STANDARD",
		2: "EXPERIMENTAL",
	}
	SignatureType_value = map[string]int32{
		"UNSPECIFIED":  0,
		"STANDARD":     1,
		"EXPERIMENTAL": 2,
	}
)

Enum value maps for SignatureType.

View Source
var File_services_verifiable_credentials_v1_verifiable_credentials_proto protoreflect.FileDescriptor
View Source
var VerifiableCredential_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "services.verifiablecredentials.v1.VerifiableCredential",
	HandlerType: (*VerifiableCredentialServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "IssueFromTemplate",
			Handler:    _VerifiableCredential_IssueFromTemplate_Handler,
		},
		{
			MethodName: "CheckStatus",
			Handler:    _VerifiableCredential_CheckStatus_Handler,
		},
		{
			MethodName: "UpdateStatus",
			Handler:    _VerifiableCredential_UpdateStatus_Handler,
		},
		{
			MethodName: "CreateProof",
			Handler:    _VerifiableCredential_CreateProof_Handler,
		},
		{
			MethodName: "VerifyProof",
			Handler:    _VerifiableCredential_VerifyProof_Handler,
		},
		{
			MethodName: "Send",
			Handler:    _VerifiableCredential_Send_Handler,
		},
		{
			MethodName: "CreateCredentialOffer",
			Handler:    _VerifiableCredential_CreateCredentialOffer_Handler,
		},
		{
			MethodName: "AcceptCredential",
			Handler:    _VerifiableCredential_AcceptCredential_Handler,
		},
		{
			MethodName: "RejectCredential",
			Handler:    _VerifiableCredential_RejectCredential_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "services/verifiable-credentials/v1/verifiable-credentials.proto",
}

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

Functions

func RegisterVerifiableCredentialServer

func RegisterVerifiableCredentialServer(s grpc.ServiceRegistrar, srv VerifiableCredentialServer)

Types

type AcceptCredentialRequest added in v1.11.8

type AcceptCredentialRequest struct {

	// Types that are assignable to Offer:
	//
	//	*AcceptCredentialRequest_DocumentJson
	//	*AcceptCredentialRequest_ItemId
	Offer isAcceptCredentialRequest_Offer `protobuf_oneof:"offer"`
	// contains filtered or unexported fields
}

func (*AcceptCredentialRequest) Descriptor deprecated added in v1.11.8

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

Deprecated: Use AcceptCredentialRequest.ProtoReflect.Descriptor instead.

func (*AcceptCredentialRequest) GetDocumentJson added in v1.11.8

func (x *AcceptCredentialRequest) GetDocumentJson() string

func (*AcceptCredentialRequest) GetItemId added in v1.11.8

func (x *AcceptCredentialRequest) GetItemId() string

func (*AcceptCredentialRequest) GetOffer added in v1.11.8

func (m *AcceptCredentialRequest) GetOffer() isAcceptCredentialRequest_Offer

func (*AcceptCredentialRequest) ProtoMessage added in v1.11.8

func (*AcceptCredentialRequest) ProtoMessage()

func (*AcceptCredentialRequest) ProtoReflect added in v1.11.8

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

func (*AcceptCredentialRequest) Reset added in v1.11.8

func (x *AcceptCredentialRequest) Reset()

func (*AcceptCredentialRequest) String added in v1.11.8

func (x *AcceptCredentialRequest) String() string

type AcceptCredentialRequest_DocumentJson added in v1.11.8

type AcceptCredentialRequest_DocumentJson struct {
	// The JSON document that contains the credential offer
	DocumentJson string `protobuf:"bytes,1,opt,name=document_json,json=documentJson,proto3,oneof"`
}

type AcceptCredentialRequest_ItemId added in v1.11.8

type AcceptCredentialRequest_ItemId struct {
	// The ID of the credential offer (Parameter ID inside the JSON document)
	ItemId string `protobuf:"bytes,2,opt,name=item_id,json=itemId,proto3,oneof"`
}

type AcceptCredentialResponse added in v1.11.8

type AcceptCredentialResponse struct {

	// The ID of the item in the wallet that contains the issued credential
	ItemId string `protobuf:"bytes,1,opt,name=item_id,json=itemId,proto3" json:"item_id,omitempty"`
	// The JSON document that contains the issued credential.
	// This item is already stored in the wallet.
	DocumentJson string `protobuf:"bytes,2,opt,name=document_json,json=documentJson,proto3" json:"document_json,omitempty"`
	// contains filtered or unexported fields
}

func (*AcceptCredentialResponse) Descriptor deprecated added in v1.11.8

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

Deprecated: Use AcceptCredentialResponse.ProtoReflect.Descriptor instead.

func (*AcceptCredentialResponse) GetDocumentJson added in v1.11.8

func (x *AcceptCredentialResponse) GetDocumentJson() string

func (*AcceptCredentialResponse) GetItemId added in v1.11.8

func (x *AcceptCredentialResponse) GetItemId() string

func (*AcceptCredentialResponse) ProtoMessage added in v1.11.8

func (*AcceptCredentialResponse) ProtoMessage()

func (*AcceptCredentialResponse) ProtoReflect added in v1.11.8

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

func (*AcceptCredentialResponse) Reset added in v1.11.8

func (x *AcceptCredentialResponse) Reset()

func (*AcceptCredentialResponse) String added in v1.11.8

func (x *AcceptCredentialResponse) String() string

type CheckStatusRequest

type CheckStatusRequest struct {

	// Credential Status ID to check. This is not the same as the credential's ID.
	CredentialStatusId string `protobuf:"bytes,1,opt,name=credential_status_id,json=credentialStatusId,proto3" json:"credential_status_id,omitempty"`
	// contains filtered or unexported fields
}

Request to check a credential's revocation status

func (*CheckStatusRequest) Descriptor deprecated

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

Deprecated: Use CheckStatusRequest.ProtoReflect.Descriptor instead.

func (*CheckStatusRequest) GetCredentialStatusId

func (x *CheckStatusRequest) GetCredentialStatusId() string

func (*CheckStatusRequest) ProtoMessage

func (*CheckStatusRequest) ProtoMessage()

func (*CheckStatusRequest) ProtoReflect

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

func (*CheckStatusRequest) Reset

func (x *CheckStatusRequest) Reset()

func (*CheckStatusRequest) String

func (x *CheckStatusRequest) String() string

type CheckStatusResponse

type CheckStatusResponse struct {

	// The credential's revocation status
	Revoked bool `protobuf:"varint,1,opt,name=revoked,proto3" json:"revoked,omitempty"`
	// contains filtered or unexported fields
}

Response to `CheckStatusRequest`

func (*CheckStatusResponse) Descriptor deprecated

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

Deprecated: Use CheckStatusResponse.ProtoReflect.Descriptor instead.

func (*CheckStatusResponse) GetRevoked

func (x *CheckStatusResponse) GetRevoked() bool

func (*CheckStatusResponse) ProtoMessage

func (*CheckStatusResponse) ProtoMessage()

func (*CheckStatusResponse) ProtoReflect

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

func (*CheckStatusResponse) Reset

func (x *CheckStatusResponse) Reset()

func (*CheckStatusResponse) String

func (x *CheckStatusResponse) String() string

type CreateCredentialOfferRequest added in v1.11.8

type CreateCredentialOfferRequest struct {

	// ID of template to use
	TemplateId string `protobuf:"bytes,1,opt,name=template_id,json=templateId,proto3" json:"template_id,omitempty"`
	// JSON document string with keys corresponding to the fields of
	// the template referenced by `template_id`
	ValuesJson string `protobuf:"bytes,2,opt,name=values_json,json=valuesJson,proto3" json:"values_json,omitempty"`
	// If true, the credential will be issued with holder binding by specifying
	// the holder DID in the credential subject
	HolderBinding bool `protobuf:"varint,3,opt,name=holder_binding,json=holderBinding,proto3" json:"holder_binding,omitempty"`
	// If true, the issued credential will contain an attestation of the issuer's membership in the ecosystem's
	// Trust Registry.
	IncludeGovernance bool `protobuf:"varint,4,opt,name=include_governance,json=includeGovernance,proto3" json:"include_governance,omitempty"`
	// If true, a short URL link will be generated that can be used to share the credential offer with the holder.
	// This link will point to the credential offer in the wallet app.
	GenerateShareUrl bool `protobuf:"varint,5,opt,name=generate_share_url,json=generateShareUrl,proto3" json:"generate_share_url,omitempty"`
	// The type of signature to use when signing the credential. Defaults to `EXPERIMENTAL`.
	SignatureType SignatureType `` /* 154-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*CreateCredentialOfferRequest) Descriptor deprecated added in v1.11.8

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

Deprecated: Use CreateCredentialOfferRequest.ProtoReflect.Descriptor instead.

func (*CreateCredentialOfferRequest) GetGenerateShareUrl added in v1.11.8

func (x *CreateCredentialOfferRequest) GetGenerateShareUrl() bool

func (*CreateCredentialOfferRequest) GetHolderBinding added in v1.11.8

func (x *CreateCredentialOfferRequest) GetHolderBinding() bool

func (*CreateCredentialOfferRequest) GetIncludeGovernance added in v1.11.8

func (x *CreateCredentialOfferRequest) GetIncludeGovernance() bool

func (*CreateCredentialOfferRequest) GetSignatureType added in v1.11.8

func (x *CreateCredentialOfferRequest) GetSignatureType() SignatureType

func (*CreateCredentialOfferRequest) GetTemplateId added in v1.11.8

func (x *CreateCredentialOfferRequest) GetTemplateId() string

func (*CreateCredentialOfferRequest) GetValuesJson added in v1.11.8

func (x *CreateCredentialOfferRequest) GetValuesJson() string

func (*CreateCredentialOfferRequest) ProtoMessage added in v1.11.8

func (*CreateCredentialOfferRequest) ProtoMessage()

func (*CreateCredentialOfferRequest) ProtoReflect added in v1.11.8

func (*CreateCredentialOfferRequest) Reset added in v1.11.8

func (x *CreateCredentialOfferRequest) Reset()

func (*CreateCredentialOfferRequest) String added in v1.11.8

type CreateCredentialOfferResponse added in v1.11.8

type CreateCredentialOfferResponse struct {

	// The JSON document that contains the credential offer
	DocumentJson string `protobuf:"bytes,1,opt,name=document_json,json=documentJson,proto3" json:"document_json,omitempty"`
	// If requested, a URL that can be used to share the credential offer with the holder.
	// This is a short URL that can be used in a QR code and will redirect the
	// holder to the credential offer using the wallet app.
	ShareUrl string `protobuf:"bytes,2,opt,name=share_url,json=shareUrl,proto3" json:"share_url,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateCredentialOfferResponse) Descriptor deprecated added in v1.11.8

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

Deprecated: Use CreateCredentialOfferResponse.ProtoReflect.Descriptor instead.

func (*CreateCredentialOfferResponse) GetDocumentJson added in v1.11.8

func (x *CreateCredentialOfferResponse) GetDocumentJson() string

func (*CreateCredentialOfferResponse) GetShareUrl added in v1.11.8

func (x *CreateCredentialOfferResponse) GetShareUrl() string

func (*CreateCredentialOfferResponse) ProtoMessage added in v1.11.8

func (*CreateCredentialOfferResponse) ProtoMessage()

func (*CreateCredentialOfferResponse) ProtoReflect added in v1.11.8

func (*CreateCredentialOfferResponse) Reset added in v1.11.8

func (x *CreateCredentialOfferResponse) Reset()

func (*CreateCredentialOfferResponse) String added in v1.11.8

type CreateProofRequest

type CreateProofRequest struct {

	// Selective disclosure specification. If nothing is provided, the entire proof is returned.
	// Either a custom JSON-LD frame is provided, or a list of attributes is provided for selective disclosure
	//
	// Types that are assignable to Disclosure:
	//
	//	*CreateProofRequest_RevealDocumentJson
	//	*CreateProofRequest_RevealTemplate
	//	*CreateProofRequest_VerificationTemplateId
	Disclosure isCreateProofRequest_Disclosure `protobuf_oneof:"disclosure"`
	// Specify the input to be used to derive this proof.
	// Input can be an existing item in the wallet or an input document
	//
	// Types that are assignable to Proof:
	//
	//	*CreateProofRequest_ItemId
	//	*CreateProofRequest_DocumentJson
	Proof isCreateProofRequest_Proof `protobuf_oneof:"proof"`
	// Wrap the output in a verifiable presentation.
	// If the credential used in the proof is bound to the holder DID,
	// the output will always use a verifiable presentation and this field will be ignored.
	UseVerifiablePresentation bool `` /* 139-byte string literal not displayed */
	// Nonce value used to derive the proof. If not specified, a random nonce will be generated.
	// This value may be represented in base64 format in the proof model.
	Nonce []byte `protobuf:"bytes,10,opt,name=nonce,proto3" json:"nonce,omitempty"`
	// contains filtered or unexported fields
}

Request to create a proof for a Verifiable Credential using public key tied to caller. Either `item_id`, or `document_json` may be provided, not both.

func (*CreateProofRequest) Descriptor deprecated

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

Deprecated: Use CreateProofRequest.ProtoReflect.Descriptor instead.

func (*CreateProofRequest) GetDisclosure added in v1.9.0

func (m *CreateProofRequest) GetDisclosure() isCreateProofRequest_Disclosure

func (*CreateProofRequest) GetDocumentJson

func (x *CreateProofRequest) GetDocumentJson() string

func (*CreateProofRequest) GetItemId

func (x *CreateProofRequest) GetItemId() string

func (*CreateProofRequest) GetNonce added in v1.9.0

func (x *CreateProofRequest) GetNonce() []byte

func (*CreateProofRequest) GetProof

func (m *CreateProofRequest) GetProof() isCreateProofRequest_Proof

func (*CreateProofRequest) GetRevealDocumentJson

func (x *CreateProofRequest) GetRevealDocumentJson() string

func (*CreateProofRequest) GetRevealTemplate added in v1.9.0

func (x *CreateProofRequest) GetRevealTemplate() *RevealTemplateAttributes

func (*CreateProofRequest) GetUseVerifiablePresentation added in v1.9.1

func (x *CreateProofRequest) GetUseVerifiablePresentation() bool

func (*CreateProofRequest) GetVerificationTemplateId added in v1.11.8

func (x *CreateProofRequest) GetVerificationTemplateId() string

func (*CreateProofRequest) ProtoMessage

func (*CreateProofRequest) ProtoMessage()

func (*CreateProofRequest) ProtoReflect

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

func (*CreateProofRequest) Reset

func (x *CreateProofRequest) Reset()

func (*CreateProofRequest) String

func (x *CreateProofRequest) String() string

type CreateProofRequest_DocumentJson

type CreateProofRequest_DocumentJson struct {
	// A valid JSON-LD Verifiable Credential document string
	// with an unbound signature. The proof will be derived from this
	// document directly. The document will not be stored in the wallet.
	DocumentJson string `protobuf:"bytes,3,opt,name=document_json,json=documentJson,proto3,oneof"`
}

type CreateProofRequest_ItemId

type CreateProofRequest_ItemId struct {
	// ID of wallet item stored in a Trinsic cloud wallet
	ItemId string `protobuf:"bytes,2,opt,name=item_id,json=itemId,proto3,oneof"`
}

type CreateProofRequest_RevealDocumentJson added in v1.9.0

type CreateProofRequest_RevealDocumentJson struct {
	// A valid JSON-LD frame describing which fields should be
	// revealed in the generated proof.
	// If unspecified, all fields in the document will be revealed
	RevealDocumentJson string `protobuf:"bytes,1,opt,name=reveal_document_json,json=revealDocumentJson,proto3,oneof"`
}

type CreateProofRequest_RevealTemplate added in v1.9.0

type CreateProofRequest_RevealTemplate struct {
	// Information about what sections of the document to reveal
	RevealTemplate *RevealTemplateAttributes `protobuf:"bytes,11,opt,name=reveal_template,json=revealTemplate,proto3,oneof"`
}

type CreateProofRequest_VerificationTemplateId added in v1.11.8

type CreateProofRequest_VerificationTemplateId struct {
	// Id of verification template with which to construct the JSON-LD proof document
	VerificationTemplateId string `protobuf:"bytes,12,opt,name=verification_template_id,json=verificationTemplateId,proto3,oneof"`
}

type CreateProofResponse

type CreateProofResponse struct {

	// Valid JSON-LD proof for the specified credential
	ProofDocumentJson string `protobuf:"bytes,1,opt,name=proof_document_json,json=proofDocumentJson,proto3" json:"proof_document_json,omitempty"`
	// contains filtered or unexported fields
}

Response to `CreateProofRequest`

func (*CreateProofResponse) Descriptor deprecated

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

Deprecated: Use CreateProofResponse.ProtoReflect.Descriptor instead.

func (*CreateProofResponse) GetProofDocumentJson

func (x *CreateProofResponse) GetProofDocumentJson() string

func (*CreateProofResponse) ProtoMessage

func (*CreateProofResponse) ProtoMessage()

func (*CreateProofResponse) ProtoReflect

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

func (*CreateProofResponse) Reset

func (x *CreateProofResponse) Reset()

func (*CreateProofResponse) String

func (x *CreateProofResponse) String() string

type IssueFromTemplateRequest

type IssueFromTemplateRequest struct {

	// ID of template to use
	TemplateId string `protobuf:"bytes,1,opt,name=template_id,json=templateId,proto3" json:"template_id,omitempty"`
	// JSON document string with keys corresponding to the fields of
	// the template referenced by `template_id`
	ValuesJson string `protobuf:"bytes,2,opt,name=values_json,json=valuesJson,proto3" json:"values_json,omitempty"`
	// Save a copy of the issued credential to this user's wallet. This copy will only contain
	// the credential data, but not the secret proof value. Issuers may use this data to
	// keep track of the details for revocation status.
	SaveCopy bool `protobuf:"varint,4,opt,name=save_copy,json=saveCopy,proto3" json:"save_copy,omitempty"`
	// The ISO8601 expiration UTC date of the credential. This is a reserved field in the VC specification.
	// If specified, the issued credential will contain an expiration date.
	// https://www.w3.org/TR/vc-data-model/#expiration
	ExpirationDate string `protobuf:"bytes,5,opt,name=expiration_date,json=expirationDate,proto3" json:"expiration_date,omitempty"`
	// If true, the issued credential will contain an attestation of the issuer's membership in the ecosystem's
	// Trust Registry.
	IncludeGovernance bool `protobuf:"varint,6,opt,name=include_governance,json=includeGovernance,proto3" json:"include_governance,omitempty"`
	// The type of signature to use when signing the credential. Defaults to `EXPERIMENTAL`.
	SignatureType SignatureType `` /* 154-byte string literal not displayed */
	// contains filtered or unexported fields
}

Request to create and sign a JSON-LD Verifiable Credential from a template using public key tied to caller

func (*IssueFromTemplateRequest) Descriptor deprecated

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

Deprecated: Use IssueFromTemplateRequest.ProtoReflect.Descriptor instead.

func (*IssueFromTemplateRequest) GetExpirationDate added in v1.11.8

func (x *IssueFromTemplateRequest) GetExpirationDate() string

func (*IssueFromTemplateRequest) GetIncludeGovernance added in v1.11.8

func (x *IssueFromTemplateRequest) GetIncludeGovernance() bool

func (*IssueFromTemplateRequest) GetSaveCopy added in v1.9.0

func (x *IssueFromTemplateRequest) GetSaveCopy() bool

func (*IssueFromTemplateRequest) GetSignatureType added in v1.11.8

func (x *IssueFromTemplateRequest) GetSignatureType() SignatureType

func (*IssueFromTemplateRequest) GetTemplateId

func (x *IssueFromTemplateRequest) GetTemplateId() string

func (*IssueFromTemplateRequest) GetValuesJson

func (x *IssueFromTemplateRequest) GetValuesJson() string

func (*IssueFromTemplateRequest) ProtoMessage

func (*IssueFromTemplateRequest) ProtoMessage()

func (*IssueFromTemplateRequest) ProtoReflect

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

func (*IssueFromTemplateRequest) Reset

func (x *IssueFromTemplateRequest) Reset()

func (*IssueFromTemplateRequest) String

func (x *IssueFromTemplateRequest) String() string

type IssueFromTemplateResponse

type IssueFromTemplateResponse struct {

	// Verifiable Credential document, in JSON-LD form,
	// constructed from the specified template and values; signed
	// with public key tied to caller of `IssueFromTemplateRequest`
	DocumentJson string `protobuf:"bytes,1,opt,name=document_json,json=documentJson,proto3" json:"document_json,omitempty"`
	// contains filtered or unexported fields
}

Response to `IssueFromTemplateRequest`

func (*IssueFromTemplateResponse) Descriptor deprecated

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

Deprecated: Use IssueFromTemplateResponse.ProtoReflect.Descriptor instead.

func (*IssueFromTemplateResponse) GetDocumentJson

func (x *IssueFromTemplateResponse) GetDocumentJson() string

func (*IssueFromTemplateResponse) ProtoMessage

func (*IssueFromTemplateResponse) ProtoMessage()

func (*IssueFromTemplateResponse) ProtoReflect

func (*IssueFromTemplateResponse) Reset

func (x *IssueFromTemplateResponse) Reset()

func (*IssueFromTemplateResponse) String

func (x *IssueFromTemplateResponse) String() string

type RejectCredentialRequest added in v1.11.8

type RejectCredentialRequest struct {

	// Types that are assignable to Offer:
	//
	//	*RejectCredentialRequest_DocumentJson
	//	*RejectCredentialRequest_ItemId
	Offer isRejectCredentialRequest_Offer `protobuf_oneof:"offer"`
	// contains filtered or unexported fields
}

func (*RejectCredentialRequest) Descriptor deprecated added in v1.11.8

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

Deprecated: Use RejectCredentialRequest.ProtoReflect.Descriptor instead.

func (*RejectCredentialRequest) GetDocumentJson added in v1.11.8

func (x *RejectCredentialRequest) GetDocumentJson() string

func (*RejectCredentialRequest) GetItemId added in v1.11.8

func (x *RejectCredentialRequest) GetItemId() string

func (*RejectCredentialRequest) GetOffer added in v1.11.8

func (m *RejectCredentialRequest) GetOffer() isRejectCredentialRequest_Offer

func (*RejectCredentialRequest) ProtoMessage added in v1.11.8

func (*RejectCredentialRequest) ProtoMessage()

func (*RejectCredentialRequest) ProtoReflect added in v1.11.8

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

func (*RejectCredentialRequest) Reset added in v1.11.8

func (x *RejectCredentialRequest) Reset()

func (*RejectCredentialRequest) String added in v1.11.8

func (x *RejectCredentialRequest) String() string

type RejectCredentialRequest_DocumentJson added in v1.11.8

type RejectCredentialRequest_DocumentJson struct {
	// The JSON document that contains the credential offer
	DocumentJson string `protobuf:"bytes,1,opt,name=document_json,json=documentJson,proto3,oneof"`
}

type RejectCredentialRequest_ItemId added in v1.11.8

type RejectCredentialRequest_ItemId struct {
	// The ID of the credential offer (Parameter ID inside the JSON document)
	ItemId string `protobuf:"bytes,2,opt,name=item_id,json=itemId,proto3,oneof"`
}

type RejectCredentialResponse added in v1.11.8

type RejectCredentialResponse struct {
	// contains filtered or unexported fields
}

func (*RejectCredentialResponse) Descriptor deprecated added in v1.11.8

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

Deprecated: Use RejectCredentialResponse.ProtoReflect.Descriptor instead.

func (*RejectCredentialResponse) ProtoMessage added in v1.11.8

func (*RejectCredentialResponse) ProtoMessage()

func (*RejectCredentialResponse) ProtoReflect added in v1.11.8

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

func (*RejectCredentialResponse) Reset added in v1.11.8

func (x *RejectCredentialResponse) Reset()

func (*RejectCredentialResponse) String added in v1.11.8

func (x *RejectCredentialResponse) String() string

type RevealTemplateAttributes added in v1.9.0

type RevealTemplateAttributes struct {

	// A list of document attributes to reveal. If unset, all attributes will be returned.
	TemplateAttributes []string `protobuf:"bytes,1,rep,name=template_attributes,json=templateAttributes,proto3" json:"template_attributes,omitempty"`
	// contains filtered or unexported fields
}

func (*RevealTemplateAttributes) Descriptor deprecated added in v1.9.0

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

Deprecated: Use RevealTemplateAttributes.ProtoReflect.Descriptor instead.

func (*RevealTemplateAttributes) GetTemplateAttributes added in v1.9.0

func (x *RevealTemplateAttributes) GetTemplateAttributes() []string

func (*RevealTemplateAttributes) ProtoMessage added in v1.9.0

func (*RevealTemplateAttributes) ProtoMessage()

func (*RevealTemplateAttributes) ProtoReflect added in v1.9.0

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

func (*RevealTemplateAttributes) Reset added in v1.9.0

func (x *RevealTemplateAttributes) Reset()

func (*RevealTemplateAttributes) String added in v1.9.0

func (x *RevealTemplateAttributes) String() string

type SendRequest

type SendRequest struct {

	// Types that are assignable to DeliveryMethod:
	//
	//	*SendRequest_Email
	//	*SendRequest_WalletId
	//	*SendRequest_DidUri
	//	*SendRequest_PhoneNumber
	DeliveryMethod isSendRequest_DeliveryMethod `protobuf_oneof:"delivery_method"`
	// Send email notification that credential has been sent to a wallet
	SendNotification bool `protobuf:"varint,4,opt,name=send_notification,json=sendNotification,proto3" json:"send_notification,omitempty"`
	// JSON document to send to recipient
	DocumentJson string `protobuf:"bytes,100,opt,name=document_json,json=documentJson,proto3" json:"document_json,omitempty"`
	// contains filtered or unexported fields
}

Request to send a document to another user's wallet

func (*SendRequest) Descriptor deprecated

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

Deprecated: Use SendRequest.ProtoReflect.Descriptor instead.

func (*SendRequest) GetDeliveryMethod

func (m *SendRequest) GetDeliveryMethod() isSendRequest_DeliveryMethod

func (*SendRequest) GetDidUri

func (x *SendRequest) GetDidUri() string

func (*SendRequest) GetDocumentJson

func (x *SendRequest) GetDocumentJson() string

func (*SendRequest) GetEmail

func (x *SendRequest) GetEmail() string

func (*SendRequest) GetPhoneNumber added in v1.11.0

func (x *SendRequest) GetPhoneNumber() string

func (*SendRequest) GetSendNotification added in v1.9.0

func (x *SendRequest) GetSendNotification() bool

func (*SendRequest) GetWalletId added in v1.9.0

func (x *SendRequest) GetWalletId() string

func (*SendRequest) ProtoMessage

func (*SendRequest) ProtoMessage()

func (*SendRequest) ProtoReflect

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

func (*SendRequest) Reset

func (x *SendRequest) Reset()

func (*SendRequest) String

func (x *SendRequest) String() string

type SendRequest_DidUri

type SendRequest_DidUri struct {
	// DID URI of the recipient
	DidUri string `protobuf:"bytes,6,opt,name=did_uri,json=didUri,proto3,oneof"`
}

type SendRequest_Email

type SendRequest_Email struct {
	// Email address of user to whom you'll send the item
	Email string `protobuf:"bytes,1,opt,name=email,proto3,oneof"`
}

type SendRequest_PhoneNumber added in v1.11.0

type SendRequest_PhoneNumber struct {
	// SMS of user to whom you'll send the item
	PhoneNumber string `protobuf:"bytes,7,opt,name=phone_number,json=phoneNumber,proto3,oneof"`
}

type SendRequest_WalletId added in v1.9.0

type SendRequest_WalletId struct {
	// Wallet ID of the recipient within the ecosystem
	WalletId string `protobuf:"bytes,5,opt,name=wallet_id,json=walletId,proto3,oneof"`
}

type SendResponse

type SendResponse struct {
	// contains filtered or unexported fields
}

Response to `SendRequest`

func (*SendResponse) Descriptor deprecated

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

Deprecated: Use SendResponse.ProtoReflect.Descriptor instead.

func (*SendResponse) ProtoMessage

func (*SendResponse) ProtoMessage()

func (*SendResponse) ProtoReflect

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

func (*SendResponse) Reset

func (x *SendResponse) Reset()

func (*SendResponse) String

func (x *SendResponse) String() string

type SignatureType added in v1.11.8

type SignatureType int32
const (
	// The signature type is not specified. The experimental signature type will be used.
	SignatureType_UNSPECIFIED SignatureType = 0
	// The signature type uses EdDSA with the Ed25519 curve (NIST compliant).
	// This type of signature does not support selective disclosure of attributes.
	SignatureType_STANDARD SignatureType = 1
	// The signature type uses BBS signatures with BLS12-381 curve (experimental).
	// This type of signature allows for selective disclosure of attributes.
	SignatureType_EXPERIMENTAL SignatureType = 2
)

func (SignatureType) Descriptor added in v1.11.8

func (SignatureType) Enum added in v1.11.8

func (x SignatureType) Enum() *SignatureType

func (SignatureType) EnumDescriptor deprecated added in v1.11.8

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

Deprecated: Use SignatureType.Descriptor instead.

func (SignatureType) Number added in v1.11.8

func (SignatureType) String added in v1.11.8

func (x SignatureType) String() string

func (SignatureType) Type added in v1.11.8

type UnimplementedVerifiableCredentialServer

type UnimplementedVerifiableCredentialServer struct {
}

UnimplementedVerifiableCredentialServer must be embedded to have forward compatible implementations.

func (UnimplementedVerifiableCredentialServer) AcceptCredential added in v1.11.8

func (UnimplementedVerifiableCredentialServer) CheckStatus

func (UnimplementedVerifiableCredentialServer) CreateCredentialOffer added in v1.11.8

func (UnimplementedVerifiableCredentialServer) CreateProof

func (UnimplementedVerifiableCredentialServer) IssueFromTemplate

func (UnimplementedVerifiableCredentialServer) RejectCredential added in v1.11.8

func (UnimplementedVerifiableCredentialServer) Send

func (UnimplementedVerifiableCredentialServer) UpdateStatus

func (UnimplementedVerifiableCredentialServer) VerifyProof

type UnsafeVerifiableCredentialServer

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

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

type UpdateStatusRequest

type UpdateStatusRequest struct {

	// Credential Status ID to update. This is not the same as the credential's ID.
	CredentialStatusId string `protobuf:"bytes,1,opt,name=credential_status_id,json=credentialStatusId,proto3" json:"credential_status_id,omitempty"`
	// New revocation status of credential
	Revoked bool `protobuf:"varint,2,opt,name=revoked,proto3" json:"revoked,omitempty"`
	// contains filtered or unexported fields
}

Request to update a credential's revocation status

func (*UpdateStatusRequest) Descriptor deprecated

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

Deprecated: Use UpdateStatusRequest.ProtoReflect.Descriptor instead.

func (*UpdateStatusRequest) GetCredentialStatusId

func (x *UpdateStatusRequest) GetCredentialStatusId() string

func (*UpdateStatusRequest) GetRevoked

func (x *UpdateStatusRequest) GetRevoked() bool

func (*UpdateStatusRequest) ProtoMessage

func (*UpdateStatusRequest) ProtoMessage()

func (*UpdateStatusRequest) ProtoReflect

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

func (*UpdateStatusRequest) Reset

func (x *UpdateStatusRequest) Reset()

func (*UpdateStatusRequest) String

func (x *UpdateStatusRequest) String() string

type UpdateStatusResponse

type UpdateStatusResponse struct {
	// contains filtered or unexported fields
}

Response to `UpdateStatusRequest`

func (*UpdateStatusResponse) Descriptor deprecated

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

Deprecated: Use UpdateStatusResponse.ProtoReflect.Descriptor instead.

func (*UpdateStatusResponse) ProtoMessage

func (*UpdateStatusResponse) ProtoMessage()

func (*UpdateStatusResponse) ProtoReflect

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

func (*UpdateStatusResponse) Reset

func (x *UpdateStatusResponse) Reset()

func (*UpdateStatusResponse) String

func (x *UpdateStatusResponse) String() string

type ValidationMessage

type ValidationMessage struct {

	// Whether this validation check passed
	IsValid bool `protobuf:"varint,1,opt,name=is_valid,json=isValid,proto3" json:"is_valid,omitempty"`
	// If validation failed, contains messages explaining why
	Messages []string `protobuf:"bytes,2,rep,name=messages,proto3" json:"messages,omitempty"`
	// contains filtered or unexported fields
}

Result of a validation check on a proof

func (*ValidationMessage) Descriptor deprecated

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

Deprecated: Use ValidationMessage.ProtoReflect.Descriptor instead.

func (*ValidationMessage) GetIsValid

func (x *ValidationMessage) GetIsValid() bool

func (*ValidationMessage) GetMessages

func (x *ValidationMessage) GetMessages() []string

func (*ValidationMessage) ProtoMessage

func (*ValidationMessage) ProtoMessage()

func (*ValidationMessage) ProtoReflect

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

func (*ValidationMessage) Reset

func (x *ValidationMessage) Reset()

func (*ValidationMessage) String

func (x *ValidationMessage) String() string

type VerifiableCredentialClient

type VerifiableCredentialClient interface {
	// Sign and issue a verifiable credential from a pre-defined template.
	// This process will also add schema validation and
	// revocation registry values to the credential.
	IssueFromTemplate(ctx context.Context, in *IssueFromTemplateRequest, opts ...grpc.CallOption) (*IssueFromTemplateResponse, error)
	// Check credential status in the revocation registry
	CheckStatus(ctx context.Context, in *CheckStatusRequest, opts ...grpc.CallOption) (*CheckStatusResponse, error)
	// Update credential status by setting the revocation value
	UpdateStatus(ctx context.Context, in *UpdateStatusRequest, opts ...grpc.CallOption) (*UpdateStatusResponse, error)
	// Create a proof from a signed document that is a valid
	// verifiable credential and contains a signature from which a proof can be derived.
	CreateProof(ctx context.Context, in *CreateProofRequest, opts ...grpc.CallOption) (*CreateProofResponse, error)
	// Verifies a proof by checking the signature value, and if possible schema validation,
	// revocation status, and issuer status against a trust registry
	VerifyProof(ctx context.Context, in *VerifyProofRequest, opts ...grpc.CallOption) (*VerifyProofResponse, error)
	// Sends a document directly to a user's email within the given ecosystem
	Send(ctx context.Context, in *SendRequest, opts ...grpc.CallOption) (*SendResponse, error)
	// Create credential offer
	CreateCredentialOffer(ctx context.Context, in *CreateCredentialOfferRequest, opts ...grpc.CallOption) (*CreateCredentialOfferResponse, error)
	// Accept an offer to exchange a credential
	AcceptCredential(ctx context.Context, in *AcceptCredentialRequest, opts ...grpc.CallOption) (*AcceptCredentialResponse, error)
	// Reject an offer to exchange a credential
	RejectCredential(ctx context.Context, in *RejectCredentialRequest, opts ...grpc.CallOption) (*RejectCredentialResponse, error)
}

VerifiableCredentialClient is the client API for VerifiableCredential 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.

type VerifiableCredentialServer

type VerifiableCredentialServer interface {
	// Sign and issue a verifiable credential from a pre-defined template.
	// This process will also add schema validation and
	// revocation registry values to the credential.
	IssueFromTemplate(context.Context, *IssueFromTemplateRequest) (*IssueFromTemplateResponse, error)
	// Check credential status in the revocation registry
	CheckStatus(context.Context, *CheckStatusRequest) (*CheckStatusResponse, error)
	// Update credential status by setting the revocation value
	UpdateStatus(context.Context, *UpdateStatusRequest) (*UpdateStatusResponse, error)
	// Create a proof from a signed document that is a valid
	// verifiable credential and contains a signature from which a proof can be derived.
	CreateProof(context.Context, *CreateProofRequest) (*CreateProofResponse, error)
	// Verifies a proof by checking the signature value, and if possible schema validation,
	// revocation status, and issuer status against a trust registry
	VerifyProof(context.Context, *VerifyProofRequest) (*VerifyProofResponse, error)
	// Sends a document directly to a user's email within the given ecosystem
	Send(context.Context, *SendRequest) (*SendResponse, error)
	// Create credential offer
	CreateCredentialOffer(context.Context, *CreateCredentialOfferRequest) (*CreateCredentialOfferResponse, error)
	// Accept an offer to exchange a credential
	AcceptCredential(context.Context, *AcceptCredentialRequest) (*AcceptCredentialResponse, error)
	// Reject an offer to exchange a credential
	RejectCredential(context.Context, *RejectCredentialRequest) (*RejectCredentialResponse, error)
	// contains filtered or unexported methods
}

VerifiableCredentialServer is the server API for VerifiableCredential service. All implementations must embed UnimplementedVerifiableCredentialServer for forward compatibility

type VerifyProofRequest

type VerifyProofRequest struct {

	// JSON-LD proof document string to verify
	ProofDocumentJson string `protobuf:"bytes,1,opt,name=proof_document_json,json=proofDocumentJson,proto3" json:"proof_document_json,omitempty"`
	// contains filtered or unexported fields
}

Request to verify a proof

func (*VerifyProofRequest) Descriptor deprecated

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

Deprecated: Use VerifyProofRequest.ProtoReflect.Descriptor instead.

func (*VerifyProofRequest) GetProofDocumentJson

func (x *VerifyProofRequest) GetProofDocumentJson() string

func (*VerifyProofRequest) ProtoMessage

func (*VerifyProofRequest) ProtoMessage()

func (*VerifyProofRequest) ProtoReflect

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

func (*VerifyProofRequest) Reset

func (x *VerifyProofRequest) Reset()

func (*VerifyProofRequest) String

func (x *VerifyProofRequest) String() string

type VerifyProofResponse

type VerifyProofResponse struct {

	// Whether all validations in `validation_results` passed
	IsValid bool `protobuf:"varint,1,opt,name=is_valid,json=isValid,proto3" json:"is_valid,omitempty"`
	// Results of each validation check performed,
	// such as schema conformance, revocation status, signature, etc.
	// Detailed results are provided for failed validations.
	ValidationResults map[string]*ValidationMessage `` /* 200-byte string literal not displayed */
	// contains filtered or unexported fields
}

Response to `VerifyProofRequest`

func (*VerifyProofResponse) Descriptor deprecated

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

Deprecated: Use VerifyProofResponse.ProtoReflect.Descriptor instead.

func (*VerifyProofResponse) GetIsValid

func (x *VerifyProofResponse) GetIsValid() bool

func (*VerifyProofResponse) GetValidationResults

func (x *VerifyProofResponse) GetValidationResults() map[string]*ValidationMessage

func (*VerifyProofResponse) ProtoMessage

func (*VerifyProofResponse) ProtoMessage()

func (*VerifyProofResponse) ProtoReflect

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

func (*VerifyProofResponse) Reset

func (x *VerifyProofResponse) Reset()

func (*VerifyProofResponse) String

func (x *VerifyProofResponse) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL