aries_cloudagent.protocols.credentials package

Subpackages

• aries_cloudagent.protocols.credentials.handlers package
  • Submodules
  • aries_cloudagent.protocols.credentials.handlers.credential_issue_handler module
  • aries_cloudagent.protocols.credentials.handlers.credential_offer_handler module
  • aries_cloudagent.protocols.credentials.handlers.credential_request_handler module
  • aries_cloudagent.protocols.credentials.handlers.credential_stored_handler module
• aries_cloudagent.protocols.credentials.messages package
  • Submodules
  • aries_cloudagent.protocols.credentials.messages.credential_issue module
  • aries_cloudagent.protocols.credentials.messages.credential_offer module
  • aries_cloudagent.protocols.credentials.messages.credential_request module
  • aries_cloudagent.protocols.credentials.messages.credential_stored module
• aries_cloudagent.protocols.credentials.models package
  • Submodules
  • aries_cloudagent.protocols.credentials.models.credential_exchange module

Submodules

aries_cloudagent.protocols.credentials.manager module

Classes to manage credentials.

class aries_cloudagent.protocols.credentials.manager.CredentialManager(context: aries_cloudagent.config.injection_context.InjectionContext)

Bases: object

Class for managing credentials.

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)

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.protocols.credentials.models.credential_exchange.CredentialExchange, connection_record: aries_cloudagent.connections.models.connection_record.ConnectionRecord)

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.protocols.credentials.messages.credential_stored.CredentialStored)

Receive confirmation that holder stored credential.

Parameters:credential_message – credential to store

issue_credential(credential_exchange_record: aries_cloudagent.protocols.credentials.models.credential_exchange.CredentialExchange)

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

receive_credential(credential_message: aries_cloudagent.protocols.credentials.messages.credential_issue.CredentialIssue)

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.protocols.credentials.messages.credential_offer.CredentialOffer, connection_id: str)

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.protocols.credentials.messages.credential_request.CredentialRequest)

Receive a credential request.

Parameters:credential_request_message – Credential request to receive

store_credential(credential_exchange_record: aries_cloudagent.protocols.credentials.models.credential_exchange.CredentialExchange, credential_id: str = None)

Store a credential in the wallet.

Parameters:

• credential_message – credential to store
• credential_id – string to use as id for record in wallet

exception aries_cloudagent.protocols.credentials.manager.CredentialManagerError(*args, error_code: str = None, **kwargs)

Bases: aries_cloudagent.core.error.BaseError

Credential error.

aries_cloudagent.protocols.credentials.message_types module

Message type identifiers for credentials.

aries_cloudagent.protocols.credentials.routes module

Credential handling admin routes.

class aries_cloudagent.protocols.credentials.routes.CredentialExchangeListSchema(*, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)

Bases: marshmallow.schema.Schema

Result schema for a credential exchange query.

opts = <marshmallow.schema.SchemaOpts object>

class aries_cloudagent.protocols.credentials.routes.CredentialIssueRequestSchema(*, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)

Bases: marshmallow.schema.Schema

Request schema for sending a credential issue admin message.

opts = <marshmallow.schema.SchemaOpts object>

class aries_cloudagent.protocols.credentials.routes.CredentialIssueResultSchema(*, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)

Bases: marshmallow.schema.Schema

Result schema for sending a credential issue admin message.

opts = <marshmallow.schema.SchemaOpts object>

class aries_cloudagent.protocols.credentials.routes.CredentialListSchema(*, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)

Bases: marshmallow.schema.Schema

Result schema for a credential query.

opts = <marshmallow.schema.SchemaOpts object>

class aries_cloudagent.protocols.credentials.routes.CredentialOfferRequestSchema(*, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)

Bases: marshmallow.schema.Schema

Request schema for sending a credential offer admin message.

opts = <marshmallow.schema.SchemaOpts object>

class aries_cloudagent.protocols.credentials.routes.CredentialOfferResultSchema(*, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)

Bases: marshmallow.schema.Schema

Result schema for sending a credential offer admin message.

opts = <marshmallow.schema.SchemaOpts object>

class aries_cloudagent.protocols.credentials.routes.CredentialProblemReportRequestSchema(*, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)

Bases: marshmallow.schema.Schema

Request schema for sending a problem report.

opts = <marshmallow.schema.SchemaOpts object>

class aries_cloudagent.protocols.credentials.routes.CredentialRequestResultSchema(*, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)

Bases: marshmallow.schema.Schema

Result schema for sending a credential request admin message.

opts = <marshmallow.schema.SchemaOpts object>

class aries_cloudagent.protocols.credentials.routes.CredentialSchema(*, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)

Bases: marshmallow.schema.Schema

Result schema for a credential query.

opts = <marshmallow.schema.SchemaOpts object>

class aries_cloudagent.protocols.credentials.routes.CredentialSendRequestSchema(*, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)

Bases: marshmallow.schema.Schema

Request schema for sending a credential offer admin message.

opts = <marshmallow.schema.SchemaOpts object>

class aries_cloudagent.protocols.credentials.routes.CredentialSendResultSchema(*, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)

Bases: marshmallow.schema.Schema

Result schema for sending a credential offer admin message.

opts = <marshmallow.schema.SchemaOpts object>

class aries_cloudagent.protocols.credentials.routes.CredentialStoreRequestSchema(*, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)

Bases: marshmallow.schema.Schema

Request schema for sending a credential store admin message.

opts = <marshmallow.schema.SchemaOpts object>

class aries_cloudagent.protocols.credentials.routes.RawEncCredAttrSchema(*, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)

Bases: marshmallow.schema.Schema

Credential attribute schema.

opts = <marshmallow.schema.SchemaOpts object>

class aries_cloudagent.protocols.credentials.routes.RevRegSchema(*, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)

Bases: marshmallow.schema.Schema

Revocation registry schema.

opts = <marshmallow.schema.SchemaOpts object>

class aries_cloudagent.protocols.credentials.routes.WitnessSchema(*, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)

Bases: marshmallow.schema.Schema

Witness schema.

opts = <marshmallow.schema.SchemaOpts object>

aries_cloudagent.protocols.credentials.routes.credential_exchange_issue(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7faf69849c50>)

Request handler for sending a credential.

Parameters:request – aiohttp request object Returns:The credential details.

aries_cloudagent.protocols.credentials.routes.credential_exchange_list(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7faf69849c50>)

Request handler for searching credential exchange records.

Parameters:request – aiohttp request object Returns:The credential exchange list response

aries_cloudagent.protocols.credentials.routes.credential_exchange_problem_report(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7faf69849c50>)

Request handler for sending a problem report.

Parameters:request – aiohttp request object

aries_cloudagent.protocols.credentials.routes.credential_exchange_remove(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7faf69849c50>)

Request handler for removing a credential exchange record.

Parameters:request – aiohttp request object

aries_cloudagent.protocols.credentials.routes.credential_exchange_retrieve(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7faf69849c50>)

Request handler for fetching a single credential exchange record.

Parameters:request – aiohttp request object Returns:The credential exchange record response

aries_cloudagent.protocols.credentials.routes.credential_exchange_send(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7faf69849c50>)

Request handler for sending a credential.

Parameters:request – aiohttp request object Returns:The credential offer details.

aries_cloudagent.protocols.credentials.routes.credential_exchange_send_offer(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7faf69849c50>)

Request handler for sending a credential offer.

Parameters:request – aiohttp request object Returns:The credential offer details.

aries_cloudagent.protocols.credentials.routes.credential_exchange_send_request(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7faf69849c50>)

Request handler for sending a credential request.

Parameters:request – aiohttp request object Returns:The credential request details.

aries_cloudagent.protocols.credentials.routes.credential_exchange_store(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7faf69849c50>)

Request handler for storing a credential request.

Parameters:request – aiohttp request object Returns:The credential request details.

aries_cloudagent.protocols.credentials.routes.credentials_get(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7faf69849c50>)

Request handler for retrieving a credential.

Parameters:request – aiohttp request object Returns:The credential response

aries_cloudagent.protocols.credentials.routes.credentials_list(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7faf69849c50>)

Request handler for searching credential records.

Parameters:request – aiohttp request object Returns:The credential list response

aries_cloudagent.protocols.credentials.routes.credentials_remove(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7faf69849c50>)

Request handler for searching connection records.

Parameters:request – aiohttp request object Returns:The connection list response

aries_cloudagent.protocols.credentials.routes.register(app: <sphinx.ext.autodoc.importer._MockObject object at 0x7faf69849c50>)

Register routes.