aries_cloudagent.indy package
Subpackages
- aries_cloudagent.indy.credx package
- aries_cloudagent.indy.models package
- Submodules
- aries_cloudagent.indy.models.cred module
- aries_cloudagent.indy.models.cred_abstract module
- aries_cloudagent.indy.models.cred_def module
- aries_cloudagent.indy.models.cred_precis module
- aries_cloudagent.indy.models.cred_request module
- aries_cloudagent.indy.models.non_rev_interval module
- aries_cloudagent.indy.models.predicate module
- aries_cloudagent.indy.models.pres_preview module
- aries_cloudagent.indy.models.proof module
IndyEQProof
IndyEQProofSchema
IndyGEProof
IndyGEProofPred
IndyGEProofPredSchema
IndyGEProofSchema
IndyNonRevocProof
IndyNonRevocProofSchema
IndyPresSpecSchema
IndyPrimaryProof
IndyPrimaryProofSchema
IndyProof
IndyProofIdentifier
IndyProofIdentifierSchema
IndyProofProof
IndyProofProofAggregatedProof
IndyProofProofAggregatedProofSchema
IndyProofProofProofsProof
IndyProofProofProofsProofSchema
IndyProofProofSchema
IndyProofRequestedProof
IndyProofRequestedProofPredicate
IndyProofRequestedProofPredicateSchema
IndyProofRequestedProofRevealedAttr
IndyProofRequestedProofRevealedAttrGroup
IndyProofRequestedProofRevealedAttrGroupSchema
IndyProofRequestedProofRevealedAttrSchema
IndyProofRequestedProofSchema
IndyProofSchema
RawEncoded
RawEncodedSchema
- aries_cloudagent.indy.models.proof_request module
- aries_cloudagent.indy.models.requested_creds module
- aries_cloudagent.indy.models.revocation module
IndyRevRegDef
IndyRevRegDefSchema
IndyRevRegDefValue
IndyRevRegDefValuePublicKeys
IndyRevRegDefValuePublicKeysAccumKey
IndyRevRegDefValuePublicKeysAccumKeySchema
IndyRevRegDefValuePublicKeysSchema
IndyRevRegDefValueSchema
IndyRevRegEntry
IndyRevRegEntrySchema
IndyRevRegEntryValue
IndyRevRegEntryValueSchema
- aries_cloudagent.indy.models.schema module
- aries_cloudagent.indy.models.xform module
- aries_cloudagent.indy.sdk package
- Submodules
- aries_cloudagent.indy.sdk.error module
- aries_cloudagent.indy.sdk.holder module
IndySdkHolder
IndySdkHolder.create_credential_request()
IndySdkHolder.create_presentation()
IndySdkHolder.create_revocation_state()
IndySdkHolder.credential_revoked()
IndySdkHolder.delete_credential()
IndySdkHolder.get_credential()
IndySdkHolder.get_credentials()
IndySdkHolder.get_credentials_for_presentation_request_by_referent()
IndySdkHolder.get_mime_type()
IndySdkHolder.store_credential()
- aries_cloudagent.indy.sdk.issuer module
- aries_cloudagent.indy.sdk.profile module
- aries_cloudagent.indy.sdk.util module
- aries_cloudagent.indy.sdk.verifier module
- aries_cloudagent.indy.sdk.wallet_plugin module
- aries_cloudagent.indy.sdk.wallet_setup module
IndyOpenWallet
IndyWalletConfig
IndyWalletConfig.DEFAULT_FRESHNESS
IndyWalletConfig.DEFAULT_KEY
IndyWalletConfig.DEFAULT_KEY_DERIVATION
IndyWalletConfig.DEFAULT_STORAGE_TYPE
IndyWalletConfig.KEY_DERIVATION_ARGON2I_INT
IndyWalletConfig.KEY_DERIVATION_ARGON2I_MOD
IndyWalletConfig.KEY_DERIVATION_RAW
IndyWalletConfig.create_wallet()
IndyWalletConfig.open_wallet()
IndyWalletConfig.remove_wallet()
IndyWalletConfig.wallet_access
IndyWalletConfig.wallet_config
Submodules
aries_cloudagent.indy.holder module
Base Indy Holder class.
- class aries_cloudagent.indy.holder.IndyHolder[source]
Bases:
ABC
Base class for holder.
- CHUNK = 256
- RECORD_TYPE_MIME_TYPES = 'attribute-mime-types'
- abstract async create_credential_request(credential_offer: dict, credential_definition: dict, holder_did: str) Tuple[str, str] [source]
Create a credential request for the given credential offer.
- Parameters
credential_offer – The credential offer to create request for
credential_definition – The credential definition to create an offer for
holder_did – the DID of the agent making the request
- Returns
A tuple of the credential request and credential request metadata
- abstract async create_presentation(presentation_request: dict, requested_credentials: dict, schemas: dict, credential_definitions: dict, rev_states: Optional[dict] = None) str [source]
Get credentials stored in the wallet.
- Parameters
presentation_request – Valid indy format presentation request
requested_credentials – Indy format requested credentials
schemas – Indy formatted schemas JSON
credential_definitions – Indy formatted credential definitions JSON
rev_states – Indy format revocation states JSON
- abstract async create_revocation_state(cred_rev_id: str, rev_reg_def: dict, rev_reg_delta: dict, timestamp: int, tails_file_path: str) str [source]
Create current revocation state for a received credential.
- Parameters
cred_rev_id – credential revocation id in revocation registry
rev_reg_def – revocation registry definition
rev_reg_delta – revocation delta
timestamp – delta timestamp
- Returns
the revocation state
- abstract async credential_revoked(ledger: BaseLedger, credential_id: str, fro: Optional[int] = None, to: Optional[int] = None) bool [source]
Check ledger for revocation status of credential by cred id.
- Parameters
credential_id – Credential id to check
- abstract async delete_credential(credential_id: str)[source]
Remove a credential stored in the wallet.
- Parameters
credential_id – Credential id to remove
- abstract async get_credential(credential_id: str) str [source]
Get a credential stored in the wallet.
- Parameters
credential_id – Credential id to retrieve
- abstract async get_mime_type(credential_id: str, attr: Optional[str] = None) Union[dict, str] [source]
Get MIME type per attribute (or for all attributes).
- Parameters
credential_id – credential id
attr – attribute of interest or omit for all
- Returns: Attribute MIME type or dict mapping attribute names to MIME types
attr_meta_json = all_meta.tags.get(attr)
- abstract async store_credential(credential_definition: dict, credential_data: dict, credential_request_metadata: dict, credential_attr_mime_types=None, credential_id: Optional[str] = None, rev_reg_def: Optional[dict] = None)[source]
Store a credential in the wallet.
- Parameters
credential_definition – Credential definition for this credential
credential_data – Credential data generated by the issuer
credential_request_metadata – credential request metadata generated by the issuer
credential_attr_mime_types – dict mapping attribute names to (optional) MIME types to store as non-secret record, if specified
credential_id – optionally override the stored credential id
rev_reg_def – revocation registry definition in json
- Returns
the ID of the stored credential
aries_cloudagent.indy.issuer module
Base Indy Issuer class.
- class aries_cloudagent.indy.issuer.IndyIssuer[source]
Bases:
ABC
Base class for Indy Issuer.
- abstract async create_and_store_credential_definition(origin_did: str, schema: dict, signature_type: Optional[str] = None, tag: Optional[str] = None, support_revocation: bool = False) Tuple[str, str] [source]
Create a new credential definition and store it in the wallet.
- Parameters
origin_did – the DID issuing the credential definition
schema_json – the schema used as a basis
signature_type – the credential definition signature type (default ‘CL’)
tag – the credential definition tag
support_revocation – whether to enable revocation for this credential def
- Returns
A tuple of the credential definition ID and JSON
- abstract async create_and_store_revocation_registry(origin_did: str, cred_def_id: str, revoc_def_type: str, tag: str, max_cred_num: int, tails_base_path: str) Tuple[str, str, str] [source]
Create a new revocation registry and store it in the wallet.
- Parameters
origin_did – the DID issuing the revocation registry
cred_def_id – the identifier of the related credential definition
revoc_def_type – the revocation registry type (default CL_ACCUM)
tag – the unique revocation registry tag
max_cred_num – the number of credentials supported in the registry
tails_base_path – where to store the tails file
- Returns
A tuple of the revocation registry ID, JSON, and entry JSON
- abstract async create_credential(schema: dict, credential_offer: dict, credential_request: dict, credential_values: dict, revoc_reg_id: Optional[str] = None, tails_file_path: Optional[str] = None) Tuple[str, str] [source]
Create a credential.
- Parameters
schema – Schema to create credential for
credential_offer – Credential Offer to create credential for
credential_request – Credential request to create credential for
credential_values – Values to go in credential
revoc_reg_id – ID of the revocation registry
tails_file_path – The location of the tails file
- Returns
A tuple of created credential and revocation id
- abstract async create_credential_offer(credential_definition_id) str [source]
Create a credential offer for the given credential definition id.
- Parameters
credential_definition_id – The credential definition to create an offer for
- Returns
The created credential offer
- abstract async create_schema(origin_did: str, schema_name: str, schema_version: str, attribute_names: Sequence[str]) Tuple[str, str] [source]
Create a new credential schema and store it in the wallet.
- Parameters
origin_did – the DID issuing the credential definition
schema_name – the schema name
schema_version – the schema version
attribute_names – a sequence of schema attribute names
- Returns
A tuple of the schema ID and JSON
- abstract async credential_definition_in_wallet(credential_definition_id: str) bool [source]
Check whether a given credential definition ID is present in the wallet.
- Parameters
credential_definition_id – The credential definition ID to check
- make_credential_definition_id(origin_did: str, schema: dict, signature_type: Optional[str] = None, tag: Optional[str] = None) str [source]
Derive the ID for a credential definition.
- make_schema_id(origin_did: str, schema_name: str, schema_version: str) str [source]
Derive the ID for a schema.
- abstract async merge_revocation_registry_deltas(fro_delta: str, to_delta: str) str [source]
Merge revocation registry deltas.
- Parameters
fro_delta – original delta in JSON format
to_delta – incoming delta in JSON format
- Returns
Merged delta in JSON format
- abstract async revoke_credentials(cred_def_id: str, revoc_reg_id: str, tails_file_path: str, cred_rev_ids: Sequence[str]) Tuple[str, Sequence[str]] [source]
Revoke a set of credentials in a revocation registry.
- Parameters
cred_def_id – ID of the credential definition
revoc_reg_id – ID of the revocation registry
tails_file_path – path to the local tails file
cred_rev_ids – sequences of credential indexes in the revocation registry
- Returns
Tuple with the combined revocation delta, list of cred rev ids not revoked
- exception aries_cloudagent.indy.issuer.IndyIssuerError(*args, error_code: Optional[str] = None, **kwargs)[source]
Bases:
BaseError
Generic issuer error.
- exception aries_cloudagent.indy.issuer.IndyIssuerRevocationRegistryFullError(*args, error_code: Optional[str] = None, **kwargs)[source]
Bases:
IndyIssuerError
Revocation registry is full when issuing a new credential.
aries_cloudagent.indy.util module
Utilities for dealing with Indy conventions.