acapy_agent.revocation.models package

Submodules

acapy_agent.revocation.models.indy module

Indy utilities for revocation.

class acapy_agent.revocation.models.indy.NonRevocationInterval(fro: int | None = None, to: int | None = None, **kwargs)

Bases: BaseModel

Indy non-revocation interval.

class Meta

Bases: object

NonRevocationInterval metadata.

schema_class = 'NonRevocationIntervalSchema'

covers(timestamp: int | None = None) → bool

Whether input timestamp (default now) lies within non-revocation interval.

Parameters:

timestamp – time of interest

Returns:

whether input time satisfies non-revocation interval

timestamp() → bool

Return a timestamp that the non-revocation interval covers.

class acapy_agent.revocation.models.indy.NonRevocationIntervalSchema(*args: Any, **kwargs: Any)

Bases: BaseModelSchema

Schema to allow serialization/deserialization of non-revocation intervals.

class Meta

Bases: object

NonRevocationIntervalSchema metadata.

model_class

alias of NonRevocationInterval

acapy_agent.revocation.models.issuer_cred_rev_record module

Issuer credential revocation information.

class acapy_agent.revocation.models.issuer_cred_rev_record.IssuerCredRevRecord(*, record_id: str | None = None, state: str | None = None, cred_ex_id: str | None = None, rev_reg_id: str | None = None, cred_rev_id: str | None = None, cred_def_id: str | None = None, cred_ex_version: str | None = None, **kwargs)

Bases: BaseRecord

Represents credential revocation information to retain post-issue.

class Meta

Bases: object

IssuerCredRevRecord metadata.

schema_class = 'IssuerCredRevRecordSchema'

RECORD_ID_NAME = 'record_id'

RECORD_TOPIC: str | None = 'issuer_cred_rev'

RECORD_TYPE = 'issuer_cred_rev'

STATE_ISSUED = 'issued'

STATE_REVOKED = 'revoked'

TAG_NAMES = {'cred_def_id', 'cred_ex_id', 'cred_ex_version', 'cred_rev_id', 'rev_reg_id', 'state'}

VERSION_1 = '1'

VERSION_2 = '2'

async classmethod query_by_ids(session: ProfileSession, *, cred_def_id: str | None = None, rev_reg_id: str | None = None, state: str | None = None) → Sequence[IssuerCredRevRecord]

Retrieve issuer cred rev records by cred def id and/or rev reg id.

Parameters:

• session – the profile session to use

• cred_def_id – the cred def id by which to filter

• rev_reg_id – the rev reg id by which to filter

• state – a state value by which to filter

property record_id: str

Accessor for the ID associated with this exchange.

async classmethod retrieve_by_cred_ex_id(session: ProfileSession, cred_ex_id: str) → IssuerCredRevRecord

Retrieve an issuer cred rev record by rev reg id and cred rev id.

async classmethod retrieve_by_ids(session: ProfileSession, rev_reg_id: str, cred_rev_id: str, *, for_update: bool = False) → IssuerCredRevRecord

Retrieve an issuer cred rev record by rev reg id and cred rev id.

async set_state(session: ProfileSession, state: str | None = None)

Change the issuer cred rev record state (default issued).

class acapy_agent.revocation.models.issuer_cred_rev_record.IssuerCredRevRecordSchema(*args: Any, **kwargs: Any)

Bases: BaseRecordSchema

Schema to allow de/serialization of credential revocation records.

class Meta

Bases: object

IssuerCredRevRecordSchema metadata.

model_class

alias of IssuerCredRevRecord

acapy_agent.revocation.models.issuer_rev_reg_record module

acapy_agent.revocation.models.revocation_registry module

Classes for managing a revocation registry.

class acapy_agent.revocation.models.revocation_registry.RevocationRegistry(registry_id: str | None = None, *, cred_def_id: str | None = None, issuer_did: str | None = None, max_creds: int | None = None, reg_def_type: str | None = None, tag: str | None = None, tails_local_path: str | None = None, tails_public_uri: str | None = None, tails_hash: str | None = None, reg_def: dict | None = None)

Bases: object

Manage a revocation registry and tails file.

MAX_SIZE = 32768

MIN_SIZE = 4

property cred_def_id: str

Accessor for the credential definition ID.

classmethod from_definition(revoc_reg_def: dict, public_def: bool) → RevocationRegistry

Initialize a revocation registry instance from a definition.

async get_or_fetch_local_tails_path()

Get the local tails path, retrieving from the remote if necessary.

get_receiving_tails_local_path()

Make the local path to the tails file we download from remote URI.

has_local_tails_file() → bool

Test if the tails file exists locally.

property issuer_did: str

Accessor for the issuer DID.

property max_creds: int

Accessor for the maximum number of issued credentials.

property reg_def: dict

Accessor for the revocation registry definition.

property reg_def_type: str

Accessor for the revocation registry type.

property registry_id: str

Accessor for the revocation registry ID.

async retrieve_tails()

Fetch the tails file from the public URI.

property tag: str

Accessor for the tag part of the revoc. reg. ID.

property tails_hash: str

Accessor for the tails file hash.

property tails_local_path: str

Accessor for the tails file local path.

property tails_public_uri: str

Accessor for the tails file public URI.