aries_cloudagent.protocols.presentations package

Submodules

aries_cloudagent.protocols.presentations.manager module

Classes to manage presentations.

class aries_cloudagent.protocols.presentations.manager.PresentationManager(context: aries_cloudagent.config.injection_context.InjectionContext)[source]

Bases: object

Class for managing presentations.

context

Accessor for the current request context.

Returns:The injection context for this presentation manager
create_presentation(presentation_exchange_record: aries_cloudagent.protocols.presentations.models.presentation_exchange.PresentationExchange, requested_credentials: dict)[source]

Receive a presentation request.

Parameters:
  • presentation_exchange_record – Record to update
  • requested_credentials – Indy formatted requested_credentials

i.e.,

{
    "self_attested_attributes": {
        "j233ffbc-bd35-49b1-934f-51e083106f6d": "value"
    },
    "requested_attributes": {
        "6253ffbb-bd35-49b3-934f-46e083106f6c": {
            "cred_id": "5bfa40b7-062b-4ae0-a251-a86c87922c0e",
            "revealed": true
        }
    },
    "requested_predicates": {
        "bfc8a97d-60d3-4f21-b998-85eeabe5c8c0": {
            "cred_id": "5bfa40b7-062b-4ae0-a251-a86c87922c0e"
        }
    }
}
create_request(name: str, version: str, requested_attributes: list, requested_predicates: list, connection_id: str)[source]

Create a proof request.

receive_presentation(presentation: dict, thread_id: str)[source]

Receive a presentation request.

receive_request(presentation_request_message: aries_cloudagent.protocols.presentations.messages.presentation_request.PresentationRequest, connection_id: str)[source]

Receive a presentation request.

Parameters:presentation_request_message – Presentation message to receive
verify_presentation(presentation_exchange_record: aries_cloudagent.protocols.presentations.models.presentation_exchange.PresentationExchange)[source]

Verify a presentation request.

exception aries_cloudagent.protocols.presentations.manager.PresentationManagerError(*args, error_code: str = None, **kwargs)[source]

Bases: aries_cloudagent.core.error.BaseError

Presentation error.

aries_cloudagent.protocols.presentations.message_types module

Message type identifiers for presentations.

aries_cloudagent.protocols.presentations.routes module

Admin routes for presentations.

class aries_cloudagent.protocols.presentations.routes.PresentationExchangeListSchema(*, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)[source]

Bases: marshmallow.schema.Schema

Result schema for a presentation exchange query.

opts = <marshmallow.schema.SchemaOpts object>
class aries_cloudagent.protocols.presentations.routes.PresentationRequestRequestSchema(*, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)[source]

Bases: marshmallow.schema.Schema

Request schema for sending a proof request.

class RequestedAttribute(*, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)[source]

Bases: marshmallow.schema.Schema

RequestedAttribute model.

opts = <marshmallow.schema.SchemaOpts object>
class RequestedPredicate(*, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)[source]

Bases: marshmallow.schema.Schema

RequestedPredicate model.

opts = <marshmallow.schema.SchemaOpts object>
opts = <marshmallow.schema.SchemaOpts object>
class aries_cloudagent.protocols.presentations.routes.SendPresentationRequestSchema(*, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)[source]

Bases: marshmallow.schema.Schema

Request schema for sending a presentation.

opts = <marshmallow.schema.SchemaOpts object>
aries_cloudagent.protocols.presentations.routes.presentation_exchange_create_request(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7faf68eef748>)[source]

Request handler for creating a presentation request.

Parameters:request – aiohttp request object
Returns:The presentation exchange details.
aries_cloudagent.protocols.presentations.routes.presentation_exchange_credentials_list(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7faf68eef748>)[source]

Request handler for searching applicable credential records.

Parameters:request – aiohttp request object
Returns:The credential list response
aries_cloudagent.protocols.presentations.routes.presentation_exchange_list(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7faf68eef748>)[source]

Request handler for searching presentation exchange records.

Parameters:request – aiohttp request object
Returns:The presentation exchange list response
aries_cloudagent.protocols.presentations.routes.presentation_exchange_remove(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7faf68eef748>)[source]

Request handler for removing a presentation exchange record.

Parameters:request – aiohttp request object
aries_cloudagent.protocols.presentations.routes.presentation_exchange_retrieve(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7faf68eef748>)[source]

Request handler for fetching a single presentation exchange record.

Parameters:request – aiohttp request object
Returns:The presentation exchange record response
aries_cloudagent.protocols.presentations.routes.presentation_exchange_send_credential_presentation(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7faf68eef748>)[source]

Request handler for sending a credential presentation.

Parameters:request – aiohttp request object
Returns:The presentation exchange details.
aries_cloudagent.protocols.presentations.routes.presentation_exchange_send_request(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7faf68eef748>)[source]

Request handler for creating and sending a presentation request.

Parameters:request – aiohttp request object
Returns:The presentation exchange details.
aries_cloudagent.protocols.presentations.routes.presentation_exchange_verify_credential_presentation(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7faf68eef748>)[source]

Request handler for verifying a presentation request.

Parameters:request – aiohttp request object
Returns:The presentation exchange details.
aries_cloudagent.protocols.presentations.routes.register(app: <sphinx.ext.autodoc.importer._MockObject object at 0x7faf68eef748>)[source]

Register routes.