aries_cloudagent.indy.sdk package
Submodules
aries_cloudagent.indy.sdk.error module
Indy error handling.
aries_cloudagent.indy.sdk.holder module
Indy SDK holder implementation.
- class aries_cloudagent.indy.sdk.holder.IndySdkHolder(wallet: IndyOpenWallet)[source]
Bases:
IndyHolder
Indy-SDK holder implementation.
- 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
- 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
- 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
- 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
- async delete_credential(credential_id: str)[source]
Remove a credential stored in the wallet.
- Parameters
credential_id – Credential id to remove
- async get_credential(credential_id: str) str [source]
Get a credential stored in the wallet.
- Parameters
credential_id – Credential id to retrieve
- async get_credentials(start: int, count: int, wql: dict)[source]
Get credentials stored in the wallet.
- Parameters
start – Starting index
count – Number of records to return
wql – wql query dict
- async get_credentials_for_presentation_request_by_referent(presentation_request: dict, referents: Sequence[str], start: int, count: int, extra_query: Optional[dict] = None)[source]
Get credentials stored in the wallet.
- Parameters
presentation_request – Valid presentation request from issuer
referents – Presentation request referents to use to search for creds
start – Starting index
count – Maximum number of records to return
extra_query – wql query dict
- 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)
- 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) str [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.sdk.issuer module
aries_cloudagent.indy.sdk.profile module
aries_cloudagent.indy.sdk.util module
Indy utilities.
aries_cloudagent.indy.sdk.verifier module
aries_cloudagent.indy.sdk.wallet_plugin module
Utility for loading Postgres wallet plug-in.
aries_cloudagent.indy.sdk.wallet_setup module
Indy-SDK wallet setup and configuration.
- class aries_cloudagent.indy.sdk.wallet_setup.IndyOpenWallet(config: IndyWalletConfig, created, handle, master_secret_id: str)[source]
Bases:
object
Handle and metadata for an opened Indy wallet.
- class aries_cloudagent.indy.sdk.wallet_setup.IndyWalletConfig(config: Optional[Mapping[str, Any]] = None)[source]
Bases:
object
A helper class for handling Indy-SDK wallet configuration.
- DEFAULT_FRESHNESS = False
- DEFAULT_KEY = ''
- DEFAULT_KEY_DERIVATION = 'ARGON2I_MOD'
- DEFAULT_STORAGE_TYPE = None
- KEY_DERIVATION_ARGON2I_INT = 'ARGON2I_INT'
- KEY_DERIVATION_ARGON2I_MOD = 'ARGON2I_MOD'
- KEY_DERIVATION_RAW = 'RAW'
- async create_wallet() IndyOpenWallet [source]
Create a new wallet.
- Raises
ProfileDuplicateError – If there was an existing wallet with the same name
ProfileError – If there was a problem removing the wallet
ProfileError – If there was another libindy error
- async open_wallet(created: bool = False) IndyOpenWallet [source]
Open wallet, removing and/or creating it if so configured.
- Raises
ProfileError – If wallet not found after creation
ProfileNotFoundError – If the wallet is not found
ProfileError – If the wallet is already open
ProfileError – If there is another libindy error