Class BBSBlindedCredentialRequestBuilder

Creates a request for a blinded credential, i.e. where some of the attributes are not known to the signer

Hierarchy (view full)

BlindedCredentialRequestBuilder<BBSSignatureParams>
- BBSBlindedCredentialRequestBuilder

Index

Constructors

Properties

_schema? _statusToBlind? _subjectToBlind? _topLevelAttributesToBlind _version attributeEqualities attributeInequalities boundedPseudonyms bounds circomPredicates presentationBuilder sigParams? verifEnc VERSION

Accessors

schema subjectToBlind version

Constructors

constructor

new BBSBlindedCredentialRequestBuilder(): BBSBlindedCredentialRequestBuilder
Returns BBSBlindedCredentialRequestBuilder
Inherited from BlindedCredentialRequestBuilder.constructor
- Defined in anonymous-credentials/blinded-credential-request-builder.ts:132

Properties

`Optional`_schema

_schema?: CredentialSchema

The schema of the whole (unblinded credential). This should include all attributes, i.e. blinded and unblinded

`Optional`_statusToBlind

_statusToBlind?: object

The credential status if blinded

`Optional`_subjectToBlind

_subjectToBlind?: object | object[]

The attributes of the credential subject that will be blinded (hidden from the issuer)

_topLevelAttributesToBlind

_topLevelAttributesToBlind: Map<string, unknown>

Any top level attributes to blind

_version

_version: string

attributeEqualities

attributeEqualities: BlindedAttributeEquality[]

Equalities between blinded and credential attributes

attributeInequalities

attributeInequalities: Map<string, [IPresentedAttributeInequality, Uint8Array][]>

Attributes proved inequal to a public value in zero knowledge. An attribute can be proven inequal to any number of values

boundedPseudonyms

boundedPseudonyms: IProverBoundedPseudonymInBlindedCredReq[]

Pseudonyms on blinded and credential attributes

bounds

bounds: Map<string, IPresentedAttributeBound[]>

Bounds on blinded attributes

circomPredicates

circomPredicates: IProverCircomPredicate[]

Circom predicates on blinded attributes

presentationBuilder

presentationBuilder: PresentationBuilder

A blinded credential request will contain a presentation that will prove predicates about the credential attributes and blinded attributes.

`Protected` `Optional`sigParams

sigParams?: SignatureParams

verifEnc

verifEnc: Map<string, IPresentedAttributeVE[]>

Encryption of blinded attributes

`Static`VERSION

VERSION: string = '0.5.0'

Follows semver and must be updated accordingly when the logic of this class changes or the underlying crypto changes.

Accessors

schema

get schema(): undefined | CredentialSchema
Returns undefined | CredentialSchema
Inherited from BlindedCredentialRequestBuilder.schema
- Defined in anonymous-credentials/blinded-credential-request-builder.ts:158
set schema(schema): void
Parameters
- schema: CredentialSchema
Returns void
Inherited from BlindedCredentialRequestBuilder.schema
- Defined in anonymous-credentials/blinded-credential-request-builder.ts:153

subjectToBlind

get subjectToBlind(): undefined | object | object[]
Returns undefined | object | object[]
Inherited from BlindedCredentialRequestBuilder.subjectToBlind
- Defined in anonymous-credentials/blinded-credential-request-builder.ts:149
set subjectToBlind(subject): void
Parameters
- subject: object | object[]
Returns void
Inherited from BlindedCredentialRequestBuilder.subjectToBlind
- Defined in anonymous-credentials/blinded-credential-request-builder.ts:144

version

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

Methods

addAccumInfoForCredStatus

addAccumInfoForCredStatus(credIdx, accumWitness, accumulated, accumPublicKey, extra?): void
Parameters
- credIdx: number
- accumWitness: AccumulatorWitnessType
- accumulated: Uint8Array
- accumPublicKey: AccumulatorPublicKey
- extra: object = {}
Returns void
Inherited from BlindedCredentialRequestBuilder.addAccumInfoForCredStatus
- Defined in anonymous-credentials/blinded-credential-request-builder.ts:248

addCredentialToPresentation

addCredentialToPresentation(credential, pk?): number
Parameters
- credential: Credential
- Optionalpk: PublicKey
Returns number
Inherited from BlindedCredentialRequestBuilder.addCredentialToPresentation
- Defined in anonymous-credentials/blinded-credential-request-builder.ts:227

addPseudonymToCredentialAndBlindedAttributes

addPseudonymToCredentialAndBlindedAttributes(basesForAttributes, credentialAttributeNames, blindedAttributeNames, baseForSecretKey?, secretKey?): void
Add a pseudonym which is bound to 0 or more credential attributes and 0 or more blinded attributes
Parameters
- basesForAttributes: Uint8Array[]
  The bases at the beginning of array will be used for credential attributes and then in the end for blinded attributes.
- credentialAttributeNames: Map<number, string[]>
  Map with key as the credential index and value as an array of attribute to use in pseudonym.
- blindedAttributeNames: string[]
  Array of blinded attribute to use in pseudonym
- OptionalbaseForSecretKey: Uint8Array
- OptionalsecretKey: Uint8Array
Returns void
Inherited from BlindedCredentialRequestBuilder.addPseudonymToCredentialAndBlindedAttributes
- Defined in anonymous-credentials/blinded-credential-request-builder.ts:482

addPseudonymToCredentialAttributes

addPseudonymToCredentialAttributes(basesForAttribute, attributeNames, baseForSecretKey?, secretKey?): number
Add a pseudonym to only credential attributes
Parameters
- basesForAttribute: Uint8Array[]
- attributeNames: Map<number, string[]>
- OptionalbaseForSecretKey: Uint8Array
- OptionalsecretKey: Uint8Array
Returns number
Inherited from BlindedCredentialRequestBuilder.addPseudonymToCredentialAttributes
- Defined in anonymous-credentials/blinded-credential-request-builder.ts:361

addUnboundedPseudonym

addUnboundedPseudonym(baseForSecretKey, secretKey): number
Parameters
- baseForSecretKey: Uint8Array
- secretKey: Uint8Array
Returns number
Inherited from BlindedCredentialRequestBuilder.addUnboundedPseudonym
- Defined in anonymous-credentials/blinded-credential-request-builder.ts:349

computeCommitment

computeCommitment(encodedSubject, totalAttributes, labelOrParams?): Uint8Array
Create a commitment to the blinded attributes.
Parameters
- encodedSubject: Map<number, Uint8Array>
  The blinded attributes in encoded (as a field element) form. The key of the map is the index of the attributes in the flattened attributes list
- totalAttributes: number
  Total number of attributes (blinded and unblinded) in the credential
- labelOrParams: Uint8Array | BBSSignatureParams = BBS_SIGNATURE_PARAMS_LABEL_BYTES
  Signature params or the label to generate them.
Returns Uint8Array
Overrides BlindedCredentialRequestBuilder.computeCommitment
- Defined in anonymous-credentials/blinded-credential-request-builder.ts:585

`Protected`createPresentation

createPresentation(sigParams?): Presentation
Parameters
- OptionalsigParams: Uint8Array | BBSSignatureParams
Returns Presentation
Inherited from BlindedCredentialRequestBuilder.createPresentation
- Defined in anonymous-credentials/blinded-credential-request-builder.ts:513

enforceBoundsOnBlindedAttribute

enforceBoundsOnBlindedAttribute(attributeName, min, max, paramId?, param?): void
Parameters
- attributeName: string
  Nested attribute names use the "dot" separator
- min: BoundType
- max: BoundType
- OptionalparamId: string
- Optionalparam: BoundCheckParamType
Returns void
Inherited from BlindedCredentialRequestBuilder.enforceBoundsOnBlindedAttribute
- Defined in anonymous-credentials/blinded-credential-request-builder.ts:409

enforceBoundsOnCredentialAttribute

enforceBoundsOnCredentialAttribute(credIdx, attributeName, min, max, paramId?, param?): void
Parameters
- credIdx: number
- attributeName: string
- min: BoundType
- max: BoundType
- OptionalparamId: string
- Optionalparam: BoundCheckParamType
Returns void
Inherited from BlindedCredentialRequestBuilder.enforceBoundsOnCredentialAttribute
- Defined in anonymous-credentials/blinded-credential-request-builder.ts:268

enforceCircomPredicateAcrossMultipleCredentials

enforceCircomPredicateAcrossMultipleCredentials(circuitPrivateVars, circuitPublicVars, circuitId, provingKeyId, r1cs?, wasmBytes?, provingKey?): void
Parameters
- circuitPrivateVars: [string, [number, string] | [number, string][]][]
- circuitPublicVars: [string, Uint8Array | Uint8Array[]][]
- circuitId: string
- provingKeyId: string
- Optionalr1cs: R1CS | ParsedR1CSFile
- OptionalwasmBytes: Uint8Array
- OptionalprovingKey: LegoProvingKeyUncompressed | LegoProvingKey
Returns void
Inherited from BlindedCredentialRequestBuilder.enforceCircomPredicateAcrossMultipleCredentials
- Defined in anonymous-credentials/blinded-credential-request-builder.ts:327

enforceCircomPredicateOnBlindedAttribute

enforceCircomPredicateOnBlindedAttribute(circuitPrivateVars, circuitPublicVars, circuitId, provingKeyId, r1cs?, wasmBytes?, provingKey?): void
Parameters
- circuitPrivateVars: [string, string | string[]][]
- circuitPublicVars: [string, Uint8Array | Uint8Array[]][]
- circuitId: string
- provingKeyId: string
- Optionalr1cs: R1CS | ParsedR1CSFile
- OptionalwasmBytes: Uint8Array
- OptionalprovingKey: LegoProvingKeyUncompressed | LegoProvingKey
Returns void
Inherited from BlindedCredentialRequestBuilder.enforceCircomPredicateOnBlindedAttribute
- Defined in anonymous-credentials/blinded-credential-request-builder.ts:446

enforceCircomPredicateOnCredentialAttribute

enforceCircomPredicateOnCredentialAttribute(credIdx, circuitPrivateVars, circuitPublicVars, circuitId, provingKeyId, r1cs?, wasmBytes?, provingKey?): void
Parameters
- credIdx: number
- circuitPrivateVars: [string, string | string[]][]
- circuitPublicVars: [string, Uint8Array | Uint8Array[]][]
- circuitId: string
- provingKeyId: string
- Optionalr1cs: R1CS | ParsedR1CSFile
- OptionalwasmBytes: Uint8Array
- OptionalprovingKey: LegoProvingKeyUncompressed | LegoProvingKey
Returns void
Inherited from BlindedCredentialRequestBuilder.enforceCircomPredicateOnCredentialAttribute
- Defined in anonymous-credentials/blinded-credential-request-builder.ts:303

enforceCredentialAttributesEqual

enforceCredentialAttributesEqual(...equality): void
Enforce equality on attributes of the presented credential
Parameters
- Rest...equality: AttributeEquality
Returns void
Inherited from BlindedCredentialRequestBuilder.enforceCredentialAttributesEqual
- Defined in anonymous-credentials/blinded-credential-request-builder.ts:244

enforceEqualityOnBlindedAttribute

enforceEqualityOnBlindedAttribute(equality): void
Enforce that a blinded attribute is equal to one or more credential attributes
Parameters
- equality: BlindedAttributeEquality
Returns void
Inherited from BlindedCredentialRequestBuilder.enforceEqualityOnBlindedAttribute
- Defined in anonymous-credentials/blinded-credential-request-builder.ts:374

enforceInequalityOnBlindedAttribute

enforceInequalityOnBlindedAttribute(attributeName, inEqualTo, paramId?, param?): void
Enforce that the blinded attribute attributeName is inequal to the public value inEqualTo
Parameters
- attributeName: string
- inEqualTo: any
- OptionalparamId: string
- Optionalparam: PederCommKeyUncompressed | PederCommKey
Returns void
Inherited from BlindedCredentialRequestBuilder.enforceInequalityOnBlindedAttribute
- Defined in anonymous-credentials/blinded-credential-request-builder.ts:385

enforceInequalityOnCredentialAttribute

enforceInequalityOnCredentialAttribute(credIdx, attributeName, inEqualTo, paramId?, param?): void
Parameters
- credIdx: number
- attributeName: string
- inEqualTo: any
- OptionalparamId: string
- Optionalparam: PederCommKeyUncompressed | PederCommKey
Returns void
Inherited from BlindedCredentialRequestBuilder.enforceInequalityOnCredentialAttribute
- Defined in anonymous-credentials/blinded-credential-request-builder.ts:258

finalize

finalize(sigParams?): BBSBlindedCredentialRequest
Create the request to be sent to the signer
Parameters
- sigParams: Uint8Array | BBSSignatureParams = BBS_SIGNATURE_PARAMS_LABEL_BYTES
Returns BBSBlindedCredentialRequest
- Defined in anonymous-credentials/blinded-credential-request-builder.ts:600

getBlinding

getBlinding(): undefined
BBS does not use blinding so return undefined

Returns undefined
Overrides BlindedCredentialRequestBuilder.getBlinding
- Defined in anonymous-credentials/blinded-credential-request-builder.ts:608

markCredentialAttributesRevealed

markCredentialAttributesRevealed(credIdx, attributeNames): void
Reveal attributes of the presented credential
Parameters
- credIdx: number
- attributeNames: Set<string>
Returns void
Inherited from BlindedCredentialRequestBuilder.markCredentialAttributesRevealed
- Defined in anonymous-credentials/blinded-credential-request-builder.ts:236

statusToBlind

statusToBlind(registryId, revCheck, memberValue, revType?): void
Blind some of the credential status values
Parameters
- registryId: string
  this won't be blinded
- revCheck: string
  this won't be blinded
- memberValue: unknown
  Only this will be blinded.
- revType: RevocationStatusProtocol = RevocationStatusProtocol.Vb22
Returns void
Inherited from BlindedCredentialRequestBuilder.statusToBlind
- Defined in anonymous-credentials/blinded-credential-request-builder.ts:169

topLevelAttributesToBlind

topLevelAttributesToBlind(name, value): void
Blind top level fields. The issuer should not set these blinded fields at all, not even nested.
Parameters
- name: string
- value: unknown
Returns void
Inherited from BlindedCredentialRequestBuilder.topLevelAttributesToBlind
- Defined in anonymous-credentials/blinded-credential-request-builder.ts:202

verifiablyEncryptBlindedAttribute

verifiablyEncryptBlindedAttribute(attributeName, chunkBitSize, commKeyId, encryptionKeyId, snarkPkId, commKey?, encryptionKey?, snarkPk?): void
Parameters
- attributeName: string
- chunkBitSize: number
- commKeyId: string
- encryptionKeyId: string
- snarkPkId: string
- OptionalcommKey: SaverChunkedCommitmentKeyUncompressed | SaverChunkedCommitmentKey
- OptionalencryptionKey: SaverEncryptionKeyUncompressed | SaverEncryptionKey
- OptionalsnarkPk: SaverProvingKeyUncompressed | SaverProvingKey
Returns void
Inherited from BlindedCredentialRequestBuilder.verifiablyEncryptBlindedAttribute
- Defined in anonymous-credentials/blinded-credential-request-builder.ts:419

verifiablyEncryptCredentialAttribute

verifiablyEncryptCredentialAttribute(credIdx, attributeName, chunkBitSize, commKeyId, encryptionKeyId, snarkPkId, commKey?, encryptionKey?, snarkPk?): void
Parameters
- credIdx: number
- attributeName: string
- chunkBitSize: number
- commKeyId: string
- encryptionKeyId: string
- snarkPkId: string
- OptionalcommKey: SaverChunkedCommitmentKeyUncompressed | SaverChunkedCommitmentKey
- OptionalencryptionKey: SaverEncryptionKeyUncompressed | SaverEncryptionKey
- OptionalsnarkPk: SaverProvingKeyUncompressed | SaverProvingKey
Returns void
Inherited from BlindedCredentialRequestBuilder.verifiablyEncryptCredentialAttribute
- Defined in anonymous-credentials/blinded-credential-request-builder.ts:279

`Static`getSigType

getSigType(): BlindSignatureType
Returns BlindSignatureType
Overrides BlindedCredentialRequestBuilder.getSigType
- Defined in anonymous-credentials/blinded-credential-request-builder.ts:612

Class BBSBlindedCredentialRequestBuilder

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns BBSBlindedCredentialRequestBuilder

Properties

Optional_schema

Optional_statusToBlind

Optional_subjectToBlind

_topLevelAttributesToBlind

_version

attributeEqualities

attributeInequalities

boundedPseudonyms

bounds

circomPredicates

presentationBuilder

Protected OptionalsigParams

verifEnc

StaticVERSION

Accessors

schema

Returns undefined | CredentialSchema

Parameters

Returns void

subjectToBlind

Returns undefined | object | object[]

Parameters

Returns void

version

Returns string

Parameters

Returns void

Methods

addAccumInfoForCredStatus

Parameters

Returns void

addCredentialToPresentation

Parameters

Returns number

addPseudonymToCredentialAndBlindedAttributes

Parameters

Returns void

addPseudonymToCredentialAttributes

Parameters

Returns number

addUnboundedPseudonym

Parameters

Returns number

computeCommitment

Parameters

Returns Uint8Array

ProtectedcreatePresentation

Parameters

Returns Presentation

enforceBoundsOnBlindedAttribute

Parameters

Returns void

enforceBoundsOnCredentialAttribute

Parameters

Returns void

enforceCircomPredicateAcrossMultipleCredentials

Parameters

Returns void

enforceCircomPredicateOnBlindedAttribute

Parameters

Returns void

enforceCircomPredicateOnCredentialAttribute

Parameters

Returns void

enforceCredentialAttributesEqual

Parameters

Returns void

enforceEqualityOnBlindedAttribute

Parameters

`Optional`_schema

`Optional`_statusToBlind

`Optional`_subjectToBlind

`Protected` `Optional`sigParams

`Static`VERSION

`Protected`createPresentation

`Static`getSigType