aries_cloudagent.messaging.credentials package

Submodules

aries_cloudagent.messaging.credentials.manager module

Classes to manage credentials.

class aries_cloudagent.messaging.credentials.manager.CredentialManager(context: aries_cloudagent.config.injection_context.InjectionContext)[source]

Bases: object

Class for managing credentials.

cache_credential_exchange(credential_exchange_record: aries_cloudagent.messaging.credentials.models.credential_exchange.CredentialExchange)[source]

Cache a credential exchange to avoid redundant credential requests.

context

Accessor for the current injection context.

Returns:The injection context for this credential manager
create_offer(credential_definition_id: str, connection_id: str, auto_issue: bool = None, credential_values: dict = None)[source]

Create a new credential exchange representing an offer.

Parameters:
  • credential_definition_id – Credential definition id for offer
  • connection_id – Connection to create offer for
Returns:

A new credential exchange record
create_request(credential_exchange_record: aries_cloudagent.messaging.credentials.models.credential_exchange.CredentialExchange, connection_record: aries_cloudagent.messaging.connections.models.connection_record.ConnectionRecord)[source]

Create a credential request.

Parameters:
  • credential_exchange_record – Credential exchange to create request for
  • connection_record – Connection to create the request for
Returns:

A tuple (credential_exchange_record, credential_request_message)
credential_stored(credential_stored_message: aries_cloudagent.messaging.credentials.messages.credential_stored.CredentialStored)[source]

Receive confirmation that holder stored credential.

Parameters:credential_message – credential to store
issue_credential(credential_exchange_record: aries_cloudagent.messaging.credentials.models.credential_exchange.CredentialExchange)[source]

Issue a credential.

Parameters:credential_exchange_record – The credential exchange we are issuing a credential for
Returns:(Updated credential exchange record, credential message obj)
Return type:Tuple
offer_credential(credential_exchange: aries_cloudagent.messaging.credentials.models.credential_exchange.CredentialExchange)[source]

Offer a credential.

Parameters:credential_exchange_record – The credential exchange we are creating the credential offer for
Returns:(Updated credential exchange record, credential offer message)
Return type:Tuple
perform_send(credential_exchange: aries_cloudagent.messaging.credentials.models.credential_exchange.CredentialExchange, outbound_handler)[source]

Send the first message in a credential exchange.

prepare_send(credential_definition_id: str, connection_id: str, credential_values: dict) → aries_cloudagent.messaging.credentials.models.credential_exchange.CredentialExchange[source]

Set up a new credential exchange for an automated send.

Parameters:
  • credential_definition_id – Credential definition id for offer
  • connection_id – Connection to create offer for
  • credential_values – The credential values to use if auto_issue is enabled
Returns:

A new CredentialExchange record
receive_credential(credential_message: aries_cloudagent.messaging.credentials.messages.credential_issue.CredentialIssue)[source]

Receive a credential a credential from an issuer.

Hold in storage to be potentially processed by controller before storing.

Parameters:credential_message – credential to store
receive_offer(credential_offer_message: aries_cloudagent.messaging.credentials.messages.credential_offer.CredentialOffer, connection_id: str)[source]

Receive a credential offer.

Parameters:
  • credential_offer – Credential offer to receive
  • connection_id – Connection to receive offer on
Returns:

The credential_exchange_record
receive_request(credential_request_message: aries_cloudagent.messaging.credentials.messages.credential_request.CredentialRequest)[source]

Receive a credential request.

Parameters:credential_request_message – Credential request to receive
store_credential(credential_exchange_record: aries_cloudagent.messaging.credentials.models.credential_exchange.CredentialExchange)[source]

Store a credential in the wallet.

Parameters:credential_message – credential to store
exception aries_cloudagent.messaging.credentials.manager.CredentialManagerError(*args, error_code: str = None, **kwargs)[source]

Bases: aries_cloudagent.error.BaseError

Credential error.

aries_cloudagent.messaging.credentials.message_types module

Message type identifiers for Connections.

aries_cloudagent.messaging.credentials.routes module

Connection handling admin routes.

class aries_cloudagent.messaging.credentials.routes.CredentialExchangeListSchema(*args, **kwargs)[source]

Bases: sphinx.ext.autodoc.importer._MockObject

Result schema for a credential exchange query.

results

Used by autodoc_mock_imports.

class aries_cloudagent.messaging.credentials.routes.CredentialIssueRequestSchema(*args, **kwargs)[source]

Bases: sphinx.ext.autodoc.importer._MockObject

Request schema for sending a credential issue admin message.

credential_values

Used by autodoc_mock_imports.

class aries_cloudagent.messaging.credentials.routes.CredentialIssueResultSchema(*args, **kwargs)[source]

Bases: sphinx.ext.autodoc.importer._MockObject

Result schema for sending a credential issue admin message.

credential_id

Used by autodoc_mock_imports.

class aries_cloudagent.messaging.credentials.routes.CredentialListSchema(*args, **kwargs)[source]

Bases: sphinx.ext.autodoc.importer._MockObject

Result schema for a credential query.

results

Used by autodoc_mock_imports.

class aries_cloudagent.messaging.credentials.routes.CredentialOfferRequestSchema(*args, **kwargs)[source]

Bases: sphinx.ext.autodoc.importer._MockObject

Request schema for sending a credential offer admin message.

connection_id

Used by autodoc_mock_imports.

credential_definition_id

Used by autodoc_mock_imports.

class aries_cloudagent.messaging.credentials.routes.CredentialOfferResultSchema(*args, **kwargs)[source]

Bases: sphinx.ext.autodoc.importer._MockObject

Result schema for sending a credential offer admin message.

credential_id

Used by autodoc_mock_imports.

class aries_cloudagent.messaging.credentials.routes.CredentialProblemReportRequestSchema(*args, **kwargs)[source]

Bases: sphinx.ext.autodoc.importer._MockObject

Request schema for sending a problem report.

explain_ltxt

Used by autodoc_mock_imports.

class aries_cloudagent.messaging.credentials.routes.CredentialRequestResultSchema(*args, **kwargs)[source]

Bases: sphinx.ext.autodoc.importer._MockObject

Result schema for sending a credential request admin message.

credential_id

Used by autodoc_mock_imports.

class aries_cloudagent.messaging.credentials.routes.CredentialSchema(*args, **kwargs)[source]

Bases: sphinx.ext.autodoc.importer._MockObject

Result schema for a credential query.

class aries_cloudagent.messaging.credentials.routes.CredentialSendRequestSchema(*args, **kwargs)[source]

Bases: sphinx.ext.autodoc.importer._MockObject

Request schema for sending a credential offer admin message.

connection_id

Used by autodoc_mock_imports.

credential_definition_id

Used by autodoc_mock_imports.

credential_values

Used by autodoc_mock_imports.

class aries_cloudagent.messaging.credentials.routes.CredentialSendResultSchema(*args, **kwargs)[source]

Bases: sphinx.ext.autodoc.importer._MockObject

Result schema for sending a credential offer admin message.

credential_id

Used by autodoc_mock_imports.

aries_cloudagent.messaging.credentials.routes.credential_exchange_issue(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7fd6621b2cf8>)[source]

Request handler for sending a credential.

Parameters:request – aiohttp request object
Returns:The credential details.
aries_cloudagent.messaging.credentials.routes.credential_exchange_list(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7fd6621b2cf8>)[source]

Request handler for searching credential exchange records.

Parameters:request – aiohttp request object
Returns:The credential exchange list response
aries_cloudagent.messaging.credentials.routes.credential_exchange_problem_report(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7fd6621b2cf8>)[source]

Request handler for sending a problem report.

Parameters:request – aiohttp request object
aries_cloudagent.messaging.credentials.routes.credential_exchange_remove(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7fd6621b2cf8>)[source]

Request handler for removing a credential exchange record.

Parameters:request – aiohttp request object
aries_cloudagent.messaging.credentials.routes.credential_exchange_retrieve(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7fd6621b2cf8>)[source]

Request handler for fetching a single credential exchange record.

Parameters:request – aiohttp request object
Returns:The credential exchange record response
aries_cloudagent.messaging.credentials.routes.credential_exchange_send(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7fd6621b2cf8>)[source]

Request handler for sending a credential.

Parameters:request – aiohttp request object
Returns:The credential offer details.
aries_cloudagent.messaging.credentials.routes.credential_exchange_send_offer(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7fd6621b2cf8>)[source]

Request handler for sending a credential offer.

Parameters:request – aiohttp request object
Returns:The credential offer details.
aries_cloudagent.messaging.credentials.routes.credential_exchange_send_request(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7fd6621b2cf8>)[source]

Request handler for sending a credential request.

Parameters:request – aiohttp request object
Returns:The credential request details.
aries_cloudagent.messaging.credentials.routes.credential_exchange_store(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7fd6621b2cf8>)[source]

Request handler for storing a credential request.

Parameters:request – aiohttp request object
Returns:The credential request details.
aries_cloudagent.messaging.credentials.routes.credentials_get(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7fd6621b2cf8>)[source]

Request handler for retrieving a credential.

Parameters:request – aiohttp request object
Returns:The credential response
aries_cloudagent.messaging.credentials.routes.credentials_list(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7fd6621b2cf8>)[source]

Request handler for searching credential records.

Parameters:request – aiohttp request object
Returns:The credential list response
aries_cloudagent.messaging.credentials.routes.credentials_remove(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7fd6621b2cf8>)[source]

Request handler for searching connection records.

Parameters:request – aiohttp request object
Returns:The connection list response
aries_cloudagent.messaging.credentials.routes.register(app: <sphinx.ext.autodoc.importer._MockObject object at 0x7fd6621b2cf8>)[source]

Register routes.