Class BBDT16Credential

Hierarchy (view full)

Credential<undefined, BBDT16Mac, BBDT16MacParams>
- BBDT16Credential

Constructors

constructor

new BBDT16Credential(version, schema, subject, topLevelFields, sig, credStatus?): BBDT16Credential
Parameters
- version: string
- schema: CredentialSchema
- subject: object
- topLevelFields: Map<string, unknown>
- sig: BBDT16Mac
- OptionalcredStatus: object
Returns BBDT16Credential
Inherited from Credential.constructor
- Defined in anonymous-credentials/credential-common.ts:19

Properties

_version

_version: string

`Optional` `Readonly`credentialStatus

credentialStatus?: object

`Readonly`schema

schema: CredentialSchema

Each credential references the schema which is included as an attribute

`Readonly`signature

signature: BBDT16Mac

`Readonly`subject

subject: object | object[]

`Readonly`topLevelFields

topLevelFields: Map<string, unknown>

Accessors

version

get version(): string
Returns string
Inherited from Credential.version
- Defined in anonymous-credentials/versioned.ts:11
set version(version): void
Parameters
- version: string
Returns void
Inherited from Credential.version
- Defined in anonymous-credentials/versioned.ts:15

Methods

getTopLevelField

getTopLevelField(name): unknown
Parameters
- name: string
Returns unknown
Inherited from Credential.getTopLevelField
- Defined in anonymous-credentials/credential-common.ts:35

proofOfValidity

proofOfValidity(secretKey, publicKey, signatureParams?): BBDT16MacProofOfValidity
Since these cannot be directly verified using the public key, issuer creates a proof of validity and gives to the holder who can then verify it without using the secret key
Parameters
- secretKey: BBDT16MacSecretKey
- publicKey: BBDT16MacPublicKeyG1
- OptionalsignatureParams: BBDT16MacParams
Returns BBDT16MacProofOfValidity
- Defined in anonymous-credentials/credential.ts:237

serializeForSigning

serializeForSigning(): object
Returns object
Inherited from Credential.serializeForSigning
- Defined in anonymous-credentials/credential.ts:35

toJSON

toJSON(): object
Returns object
Inherited from Credential.toJSON
- Defined in anonymous-credentials/credential-common.ts:43

toJSONWithJsonLdContext

toJSONWithJsonLdContext(): object
Returns object
Inherited from Credential.toJSONWithJsonLdContext
- Defined in anonymous-credentials/credential.ts:58

verify

verify(publicKey, signatureParams?): VerifyResult
Parameters
- publicKey: undefined
- OptionalsignatureParams: BBDT16MacParams
Returns VerifyResult
Overrides Credential.verify
- Defined in anonymous-credentials/credential.ts:226

verifyUsingSecretKey

verifyUsingSecretKey(secretKey, signatureParams?): VerifyResult
This is just done for testing. In practice a credential holder will never have the secret key
Parameters
- secretKey: BBDT16MacSecretKey
- OptionalsignatureParams: BBDT16MacParams
Returns VerifyResult
- Defined in anonymous-credentials/credential.ts:251

verifyUsingValidityProof

verifyUsingValidityProof(proof, publicKey, signatureParams?): VerifyResult
Parameters
- proof: BBDT16MacProofOfValidity
- publicKey: BBDT16MacPublicKeyG1
- OptionalsignatureParams: BBDT16MacParams
Returns VerifyResult
- Defined in anonymous-credentials/credential.ts:261

`Static`applyDefaultProofMetadataIfNeeded

applyDefaultProofMetadataIfNeeded(s): void
A credential will have at least some proof metadata like the type or purpose. This adds those defaults to the given object.
Parameters
- s: object
Returns void
Overrides Credential.applyDefaultProofMetadataIfNeeded
- Defined in anonymous-credentials/credential.ts:281

`Static`fromJSON

fromJSON(j, proofValue?): BBDT16Credential
Parameters
- j: object
- OptionalproofValue: string
Returns BBDT16Credential
- Defined in anonymous-credentials/credential.ts:289

`Static`getSigType

getSigType(): SignatureType
Returns SignatureType
Overrides Credential.getSigType
- Defined in anonymous-credentials/credential.ts:305

`Protected` `Static`parseJSON

parseJSON(j, proofValue?): [string, CredentialSchema, object, Map<string, unknown>, Uint8Array, object]
Parameters
- j: object
- OptionalproofValue: string
Returns [string, CredentialSchema, object, Map<string, unknown>, Uint8Array, object]
Inherited from Credential.parseJSON
- Defined in anonymous-credentials/credential-common.ts:61

`Protected` `Static`validateProofType

validateProofType(typ): void
Protected
Ensure proof type is correct
Parameters
- typ: string
Returns void
Inherited from Credential.validateProofType
- Defined in anonymous-credentials/credential.ts:78

Class BBDT16Credential

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns BBDT16Credential

Properties

_version

Optional ReadonlycredentialStatus

Readonlyschema

Readonlysignature

Readonlysubject

ReadonlytopLevelFields

Accessors

version

Returns string

Parameters

Returns void

Methods

getTopLevelField

Parameters

Returns unknown

proofOfValidity

Parameters

Returns BBDT16MacProofOfValidity

serializeForSigning

Returns object

toJSON

Returns object

toJSONWithJsonLdContext

Returns object

verify

Parameters

Returns VerifyResult

verifyUsingSecretKey

Parameters

Returns VerifyResult

verifyUsingValidityProof

Parameters

Returns VerifyResult

StaticapplyDefaultProofMetadataIfNeeded

Parameters

Returns void

StaticfromJSON

Parameters

Returns BBDT16Credential

StaticgetSigType

Returns SignatureType

Protected StaticparseJSON

Parameters

Returns [string, CredentialSchema, object, Map<string, unknown>, Uint8Array, object]

Protected StaticvalidateProofType

Parameters

Returns void

Settings

On This Page

`Optional` `Readonly`credentialStatus

`Readonly`schema

`Readonly`signature

`Readonly`subject

`Readonly`topLevelFields

`Static`applyDefaultProofMetadataIfNeeded

`Static`fromJSON

`Static`getSigType

`Protected` `Static`parseJSON

`Protected` `Static`validateProofType