aries_cloudagent.messaging.jsonld package

Submodules

aries_cloudagent.messaging.jsonld.create_verify_data module

Contains the functions needed to produce and verify a json-ld signature.

This file was ported from https://github.com/transmute-industries/Ed25519Signature2018/blob/master/src/createVerifyData/index.js

aries_cloudagent.messaging.jsonld.create_verify_data.create_verify_data(data, signature_options, document_loader=None)

Encapsulate process of constructing string used during sign and verify.

aries_cloudagent.messaging.jsonld.credential module

Sign and verify functions for json-ld based credentials.

aries_cloudagent.messaging.jsonld.credential.b64decode(bytes)

Url Safe B64 Decode.

aries_cloudagent.messaging.jsonld.credential.b64encode(str)

Url Safe B64 Encode.

aries_cloudagent.messaging.jsonld.credential.create_jws(encoded_header, verify_data)

Compose JWS.

aries_cloudagent.messaging.jsonld.credential.did_key(verkey: str) → str

Qualify verkey into DID key if need be.

aries_cloudagent.messaging.jsonld.credential.jws_sign(session, verify_data, verkey)

Sign JWS.

aries_cloudagent.messaging.jsonld.credential.jws_verify(session, verify_data, signature, public_key)

Detatched jws verify handling.

aries_cloudagent.messaging.jsonld.credential.sign_credential(session, credential, signature_options, verkey)

Sign Credential.

aries_cloudagent.messaging.jsonld.credential.verify_credential(session, doc, verkey)

Verify credential.

aries_cloudagent.messaging.jsonld.credential.verify_jws_header(header)

Check header requirements.

aries_cloudagent.messaging.jsonld.error module

JSON-LD messaging Exceptions.

exception aries_cloudagent.messaging.jsonld.error.BadJWSHeaderError(*args, error_code: str = None, **kwargs)

Bases: aries_cloudagent.messaging.jsonld.error.BaseJSONLDMessagingError

Exception indicating invalid JWS header.

exception aries_cloudagent.messaging.jsonld.error.BaseJSONLDMessagingError(*args, error_code: str = None, **kwargs)

Bases: aries_cloudagent.core.error.BaseError

Base exception class for JSON-LD messaging.

exception aries_cloudagent.messaging.jsonld.error.DroppedAttributeError(*args, error_code: str = None, **kwargs)

Bases: aries_cloudagent.messaging.jsonld.error.BaseJSONLDMessagingError

Exception used to track that an attribute was removed.

exception aries_cloudagent.messaging.jsonld.error.InvalidVerificationMethod(*args, error_code: str = None, **kwargs)

Bases: aries_cloudagent.messaging.jsonld.error.BaseJSONLDMessagingError

Exception indicating an invalid verification method in doc to verify.

exception aries_cloudagent.messaging.jsonld.error.MissingVerificationMethodError(*args, error_code: str = None, **kwargs)

Bases: aries_cloudagent.messaging.jsonld.error.BaseJSONLDMessagingError

Exception indicating missing verification method from signature options.

exception aries_cloudagent.messaging.jsonld.error.SignatureTypeError(*args, error_code: str = None, **kwargs)

Bases: aries_cloudagent.messaging.jsonld.error.BaseJSONLDMessagingError

Exception indicating Signature type error.

aries_cloudagent.messaging.jsonld.routes module

jsonld admin routes.

class aries_cloudagent.messaging.jsonld.routes.DocSchema(*args, **kwargs)

Bases: aries_cloudagent.messaging.models.openapi.OpenAPISchema

Schema for LD doc to sign.

credential

Used by autodoc_mock_imports.

options

Used by autodoc_mock_imports.

class aries_cloudagent.messaging.jsonld.routes.SignRequestSchema(*args, **kwargs)

Bases: aries_cloudagent.messaging.models.openapi.OpenAPISchema

Request schema for signing a jsonld doc.

doc

Used by autodoc_mock_imports.

verkey

Used by autodoc_mock_imports.

class aries_cloudagent.messaging.jsonld.routes.SignResponseSchema(*args, **kwargs)

Bases: aries_cloudagent.messaging.models.openapi.OpenAPISchema

Response schema for a signed jsonld doc.

error

Used by autodoc_mock_imports.

signed_doc

Used by autodoc_mock_imports.

class aries_cloudagent.messaging.jsonld.routes.SignatureOptionsSchema(*args, **kwargs)

Bases: sphinx.ext.autodoc.importer._MockObject

Schema for LD signature options.

challenge

Used by autodoc_mock_imports.

domain

Used by autodoc_mock_imports.

proofPurpose

Used by autodoc_mock_imports.

type

Used by autodoc_mock_imports.

verificationMethod

Used by autodoc_mock_imports.

class aries_cloudagent.messaging.jsonld.routes.SignedDocSchema(*args, **kwargs)

Bases: aries_cloudagent.messaging.models.openapi.OpenAPISchema

Verifiable doc schema.

class Meta

Bases: object

Keep unknown values.

unknown

Used by autodoc_mock_imports.

proof

Used by autodoc_mock_imports.

class aries_cloudagent.messaging.jsonld.routes.VerifyRequestSchema(*args, **kwargs)

Bases: aries_cloudagent.messaging.models.openapi.OpenAPISchema

Request schema for signing a jsonld doc.

doc

Used by autodoc_mock_imports.

verkey

Used by autodoc_mock_imports.

class aries_cloudagent.messaging.jsonld.routes.VerifyResponseSchema(*args, **kwargs)

Bases: aries_cloudagent.messaging.models.openapi.OpenAPISchema

Response schema for verification result.

error

Used by autodoc_mock_imports.

valid

Used by autodoc_mock_imports.

aries_cloudagent.messaging.jsonld.routes.post_process_routes(app: <sphinx.ext.autodoc.importer._MockObject object at 0x7fc04494f6d0>)

Amend swagger API.

aries_cloudagent.messaging.jsonld.routes.register(app: <sphinx.ext.autodoc.importer._MockObject object at 0x7fc04494f6d0>)

Register routes.

aries_cloudagent.messaging.jsonld.routes.sign(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7fc04494f6d0>)

Request handler for signing a jsonld doc.

Parameters:request – aiohttp request object

aries_cloudagent.messaging.jsonld.routes.verify(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7fc04494f6d0>)

Request handler for signing a jsonld doc.

Parameters:request – aiohttp request object