aries_cloudagent.revocation package

Subpackages

• aries_cloudagent.revocation.models package
  • Submodules
  • aries_cloudagent.revocation.models.indy module
    • NonRevocationInterval
      • NonRevocationInterval.Meta
      • NonRevocationInterval.covers()
      • NonRevocationInterval.timestamp()
    • NonRevocationIntervalSchema
      • NonRevocationIntervalSchema.Meta
  • aries_cloudagent.revocation.models.issuer_cred_rev_record module
    • IssuerCredRevRecord
      • IssuerCredRevRecord.Meta
      • IssuerCredRevRecord.RECORD_ID_NAME
      • IssuerCredRevRecord.RECORD_TOPIC
      • IssuerCredRevRecord.RECORD_TYPE
      • IssuerCredRevRecord.STATE_ISSUED
      • IssuerCredRevRecord.STATE_REVOKED
      • IssuerCredRevRecord.TAG_NAMES
      • IssuerCredRevRecord.VERSION_1
      • IssuerCredRevRecord.VERSION_2
      • IssuerCredRevRecord.query_by_ids()
      • IssuerCredRevRecord.record_id
      • IssuerCredRevRecord.retrieve_by_cred_ex_id()
      • IssuerCredRevRecord.retrieve_by_ids()
      • IssuerCredRevRecord.set_state()
    • IssuerCredRevRecordSchema
      • IssuerCredRevRecordSchema.Meta
  • aries_cloudagent.revocation.models.issuer_rev_reg_record module
  • aries_cloudagent.revocation.models.revocation_registry module
    • RevocationRegistry
      • RevocationRegistry.MAX_SIZE
      • RevocationRegistry.MIN_SIZE
      • RevocationRegistry.cred_def_id
      • RevocationRegistry.from_definition()
      • RevocationRegistry.get_or_fetch_local_tails_path()
      • RevocationRegistry.get_receiving_tails_local_path()
      • RevocationRegistry.has_local_tails_file()
      • RevocationRegistry.issuer_did
      • RevocationRegistry.max_creds
      • RevocationRegistry.reg_def
      • RevocationRegistry.reg_def_type
      • RevocationRegistry.registry_id
      • RevocationRegistry.retrieve_tails()
      • RevocationRegistry.tag
      • RevocationRegistry.tails_hash
      • RevocationRegistry.tails_local_path
      • RevocationRegistry.tails_public_uri

Submodules

aries_cloudagent.revocation.error module

Revocation error classes.

exception aries_cloudagent.revocation.error.RevocationError(*args, error_code: Optional[str] = None, **kwargs)

Bases: BaseError

Base exception for revocation-related errors.

exception aries_cloudagent.revocation.error.RevocationInvalidStateValueError(*args, error_code: Optional[str] = None, **kwargs)

Bases: RevocationError

Invalid Revocation Registry State value.

exception aries_cloudagent.revocation.error.RevocationNotSupportedError(*args, error_code: Optional[str] = None, **kwargs)

Bases: RevocationError

Attempted to perform revocation-related operation where inapplicable.

exception aries_cloudagent.revocation.error.RevocationRegistryBadSizeError(*args, error_code: Optional[str] = None, **kwargs)

Bases: RevocationError

Attempted to create registry with maximum credentials too large or too small.

aries_cloudagent.revocation.indy module

aries_cloudagent.revocation.manager module

aries_cloudagent.revocation.recover module

Recover a revocation registry.

aries_cloudagent.revocation.recover.LOGGER = <Logger aries_cloudagent.revocation.recover (WARNING)>

This module calculates a new ledger accumulator, based on the revocation status on the ledger vs revocations recorded in the wallet. The calculated transaction can be written to the ledger to get the ledger back in sync with the wallet. This function can be used if there were previous revocation errors (i.e. the credential revocation was successfully written to the wallet but the ledger write failed.)

exception aries_cloudagent.revocation.recover.RevocRecoveryException

Bases: Exception

Raise exception generating the recovery transaction.

async aries_cloudagent.revocation.recover.fetch_txns(genesis_txns, registry_id)

Fetch tails file and revocation registry information.

async aries_cloudagent.revocation.recover.generate_ledger_rrrecovery_txn(genesis_txns, registry_id, set_revoked, cred_def, rev_reg_def_private)

Generate a new ledger accum entry, based on wallet vs ledger revocation state.

aries_cloudagent.revocation.routes module

aries_cloudagent.revocation.util module

Revocation utilities.

async aries_cloudagent.revocation.util.notify_pending_cleared_event(profile: Profile, rev_reg_id: str)

Send notification of credential revoked as issuer.

async aries_cloudagent.revocation.util.notify_revocation_entry_endorsed_event(profile: Profile, rev_reg_id: str, meta_data: dict, revoked: list)

Send notification for a revocation registry entry endorsement event.

async aries_cloudagent.revocation.util.notify_revocation_entry_event(profile: Profile, issuer_rev_id: str, meta_data: dict)

Send notification for a revocation registry entry event.

async aries_cloudagent.revocation.util.notify_revocation_published_event(profile: Profile, rev_reg_id: str, crids: Sequence[str])

Send notification of credential revoked as issuer.

async aries_cloudagent.revocation.util.notify_revocation_reg_endorsed_event(profile: Profile, rev_reg_id: str, meta_data: dict)

Send notification for a revocation registry endorsement event.

async aries_cloudagent.revocation.util.notify_revocation_reg_init_event(profile: Profile, issuer_rev_id: str, create_pending_rev_reg: bool = False, endorser_connection_id: Optional[str] = None)

Send notification for a revocation registry init event.