aries_cloudagent.wallet package

Abstract and Indy wallet handling.

Submodules

aries_cloudagent.wallet.base module

Wallet base class.

class aries_cloudagent.wallet.base.BaseWallet(config: dict)

Bases: abc.ABC

Abstract wallet interface.

WALLET_TYPE = None

close()

Close previously-opened wallet, removing it if so configured.

create_local_did(seed: str = None, did: str = None, metadata: dict = None) → aries_cloudagent.wallet.base.DIDInfo

Create and store a new local DID.

Parameters:

• seed – Optional seed to use for did
• did – The DID to use
• metadata – Metadata to store with DID

Returns:

The created DIDInfo

create_public_did(seed: str = None, did: str = None, metadata: dict = {}) → aries_cloudagent.wallet.base.DIDInfo

Create and store a new public DID.

Implicitly flags all other dids as not public.

Parameters:

• seed – Optional seed to use for did
• did – The DID to use
• metadata – Metadata to store with DID

Returns:

The created DIDInfo

create_signing_key(seed: str = None, metadata: dict = None) → aries_cloudagent.wallet.base.KeyInfo

Create a new public/private signing keypair.

Parameters:

• seed – Optional seed allowing deterministic key creation
• metadata – Optional metadata to store with the keypair

Returns:

A KeyInfo representing the new record

created

Check whether the wallet was created on the last open call.

get_local_did(did: str) → aries_cloudagent.wallet.base.DIDInfo

Find info for a local DID.

Parameters:did – The DID to get info for Returns:A DIDInfo instance for the DID

get_local_did_for_verkey(verkey: str) → aries_cloudagent.wallet.base.DIDInfo

Resolve a local DID from a verkey.

Parameters:verkey – Verkey to get DID info for Returns:A DIDInfo instance for the DID

get_local_dids() → Sequence[aries_cloudagent.wallet.base.DIDInfo]

Get list of defined local DIDs.

Returns:A list of DIDInfo instances

get_public_did() → aries_cloudagent.wallet.base.DIDInfo

Retrieve the public did.

Returns:The created DIDInfo

get_signing_key(verkey: str) → aries_cloudagent.wallet.base.KeyInfo

Fetch info for a signing keypair.

Parameters:verkey – The verification key of the keypair Returns:A KeyInfo representing the keypair

handle

Get internal wallet reference.

Returns:Defaults to None

name

Accessor for the wallet name.

Returns:Defaults to None

open()

Open wallet, removing and/or creating it if so configured.

opened

Check whether wallet is currently open.

Returns:Defaults to False

pack_message(message: str, to_verkeys: Sequence[str], from_verkey: str = None) → bytes

Pack a message for one or more recipients.

Parameters:

• message – The message to pack
• to_verkeys – The verkeys to pack the message for
• from_verkey – The sender verkey

Returns:

The packed message

replace_local_did_metadata(did: str, metadata: dict)

Replace the metadata associated with a local DID.

Parameters:

• did – DID to replace metadata for
• metadata – The new metadata

replace_signing_key_metadata(verkey: str, metadata: dict)

Replace the metadata associated with a signing keypair.

Parameters:

• verkey – The verification key of the keypair
• metadata – The new metadata to store

set_public_did(did: str) → aries_cloudagent.wallet.base.DIDInfo

Assign the public did.

Returns:The created DIDInfo

sign_message(message: bytes, from_verkey: str) → bytes

Sign a message using the private key associated with a given verkey.

Parameters:

• message – The message to sign
• from_verkey – Sign using the private key related to this verkey

Returns:

The signature

type

Accessor for the wallet type.

Returns:Defaults to None

unpack_message(enc_message: bytes) -> (<class 'str'>, <class 'str'>, <class 'str'>)

Unpack a message.

Parameters:enc_message – The encrypted message Returns:(message, from_verkey, to_verkey) Return type:A tuple

verify_message(message: bytes, signature: bytes, from_verkey: str) → bool

Verify a signature against the public key of the signer.

Parameters:

• message – The message to verify
• signature – The signature to verify
• from_verkey – Verkey to use in verification

Returns:

True if verified, else False

class aries_cloudagent.wallet.base.DIDInfo(did, verkey, metadata)

Bases: tuple

did

Alias for field number 0

metadata

Alias for field number 2

verkey

Alias for field number 1

class aries_cloudagent.wallet.base.KeyInfo(verkey, metadata)

Bases: tuple

metadata

Alias for field number 1

verkey

Alias for field number 0

aries_cloudagent.wallet.basic module

In-memory implementation of BaseWallet interface.

class aries_cloudagent.wallet.basic.BasicWallet(config: dict = None)

Bases: aries_cloudagent.wallet.base.BaseWallet

In-memory wallet implementation.

WALLET_TYPE = 'basic'

close()

Not applicable to in-memory wallet.

create_local_did(seed: str = None, did: str = None, metadata: dict = None) → aries_cloudagent.wallet.base.DIDInfo

Create and store a new local DID.

Parameters:

• seed – Optional seed to use for did
• did – The DID to use
• metadata – Metadata to store with DID

Returns:

A DIDInfo instance representing the created DID

Raises:

WalletDuplicateError – If the DID already exists in the wallet

create_signing_key(seed: str = None, metadata: dict = None) → aries_cloudagent.wallet.base.KeyInfo

Create a new public/private signing keypair.

Parameters:

• seed – Seed to use for signing key
• metadata – Optional metadata to store with the keypair

Returns:

A KeyInfo representing the new record

Raises:

WalletDuplicateError – If the resulting verkey already exists in the wallet

created

Check whether the wallet was created on the last open call.

get_local_did(did: str) → aries_cloudagent.wallet.base.DIDInfo

Find info for a local DID.

Parameters:did – The DID to get info for Returns:A DIDInfo instance representing the found DID Raises:WalletNotFoundError – If the DID is not found

get_local_did_for_verkey(verkey: str) → aries_cloudagent.wallet.base.DIDInfo

Resolve a local DID from a verkey.

Parameters:verkey – The verkey to get the local DID for Returns:A DIDInfo instance representing the found DID Raises:WalletNotFoundError – If the verkey is not found

get_local_dids() → Sequence[aries_cloudagent.wallet.base.DIDInfo]

Get list of defined local DIDs.

Returns:A list of locally stored DIDs as DIDInfo instances

get_signing_key(verkey: str) → aries_cloudagent.wallet.base.KeyInfo

Fetch info for a signing keypair.

Parameters:verkey – The verification key of the keypair Returns:A KeyInfo representing the keypair Raises:WalletNotFoundError – if no keypair is associated with the verification key

name

Accessor for the wallet name.

open()

Not applicable to in-memory wallet.

opened

Check whether wallet is currently open.

Returns:True

pack_message(message: str, to_verkeys: Sequence[str], from_verkey: str = None) → bytes

Pack a message for one or more recipients.

Parameters:

• message – The message to pack
• to_verkeys – List of verkeys to pack for
• from_verkey – Sender verkey to pack from

Returns:

The resulting packed message bytes

replace_local_did_metadata(did: str, metadata: dict)

Replace metadata for a local DID.

Parameters:

• did – The DID to replace metadata for
• metadata – The new metadata

Raises:

WalletNotFoundError – If the DID doesn’t exist

replace_signing_key_metadata(verkey: str, metadata: dict)

Replace the metadata associated with a signing keypair.

Parameters:

• verkey – The verification key of the keypair
• metadata – The new metadata to store

Raises:

WalletNotFoundError – if no keypair is associated with the verification key

sign_message(message: bytes, from_verkey: str) → bytes

Sign a message using the private key associated with a given verkey.

Parameters:

• message – Message bytes to sign
• from_verkey – The verkey to use to sign

Returns:

A signature

Raises:

• WalletError – If the message is not provided
• WalletError – If the verkey is not provided

unpack_message(enc_message: bytes) -> (<class 'str'>, <class 'str'>, <class 'str'>)

Unpack a message.

Parameters:

enc_message – The packed message bytes

Returns:

(message, from_verkey, to_verkey)

Return type:

A tuple

Raises:

• WalletError – If the message is not provided
• WalletError – If there is a problem unpacking the message

verify_message(message: bytes, signature: bytes, from_verkey: str) → bool

Verify a signature against the public key of the signer.

Parameters:

• message – Message to verify
• signature – Signature to verify
• from_verkey – Verkey to use in verification

Returns:

True if verified, else False

Raises:

• WalletError – If the verkey is not provided
• WalletError – If the signature is not provided
• WalletError – If the message is not provided

aries_cloudagent.wallet.crypto module

Cryptography functions used by BasicWallet.

class aries_cloudagent.wallet.crypto.PackMessageSchema(*, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)

Bases: marshmallow.schema.Schema

Packed message schema.

opts = <marshmallow.schema.SchemaOpts object>

class aries_cloudagent.wallet.crypto.PackRecipientHeaderSchema(*, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)

Bases: marshmallow.schema.Schema

Packed recipient header schema.

opts = <marshmallow.schema.SchemaOpts object>

class aries_cloudagent.wallet.crypto.PackRecipientSchema(*, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)

Bases: marshmallow.schema.Schema

Packed recipient schema.

opts = <marshmallow.schema.SchemaOpts object>

class aries_cloudagent.wallet.crypto.PackRecipientsSchema(*, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)

Bases: marshmallow.schema.Schema

Packed recipients schema.

opts = <marshmallow.schema.SchemaOpts object>

aries_cloudagent.wallet.crypto.create_keypair(seed: bytes = None) → Tuple[bytes, bytes]

Create a public and private signing keypair from a seed value.

Parameters:seed – Seed for keypair Returns:A tuple of (public key, secret key)

aries_cloudagent.wallet.crypto.decode_pack_message(enc_message: bytes, find_key: Callable) → Tuple[str, Optional[str], str]

Decode a packed message.

Disassemble and unencrypt a packed message, returning the message content, verification key of the sender (if available), and verification key of the recipient.

Parameters:

• enc_message – The encrypted message
• find_key – Function to retrieve private key

Returns:

A tuple of (message, sender_vk, recip_vk)

Raises:

• ValueError – If the packed message is invalid
• ValueError – If the packed message reipients are invalid
• ValueError – If the pack algorithm is unsupported
• ValueError – If the sender’s public key was not provided

aries_cloudagent.wallet.crypto.decode_pack_message_outer(enc_message: bytes) → Tuple[dict, dict, bool]

Decode the outer wrapper of a packed message and extract the recipients.

Parameters:enc_message – The encrypted message

Returns: a tuple of the decoded wrapper, recipients, and authcrypt flag

aries_cloudagent.wallet.crypto.decode_pack_message_payload(wrapper: dict, payload_key: bytes) → str

Decode the payload of a packed message once the CEK is known.

Parameters:

• wrapper – The decoded message wrapper
• payload_key – The decrypted payload key

aries_cloudagent.wallet.crypto.decrypt_plaintext(ciphertext: bytes, recips_bin: bytes, nonce: bytes, key: bytes) → str

Decrypt the payload of a packed message.

Parameters:

• ciphertext –
• recips_bin –
• nonce –
• key –

Returns:

The decrypted string

aries_cloudagent.wallet.crypto.encode_pack_message(message: str, to_verkeys: Sequence[bytes], from_secret: bytes = None) → bytes

Assemble a packed message for a set of recipients, optionally including the sender.

Parameters:

• message – The message to pack
• to_verkeys – The verkeys to pack the message for
• from_secret – The sender secret

Returns:

The encoded message

aries_cloudagent.wallet.crypto.encrypt_plaintext(message: str, add_data: bytes, key: bytes) → Tuple[bytes, bytes, bytes]

Encrypt the payload of a packed message.

Parameters:

• message – Message to encrypt
• add_data –
• key – Key used for encryption

Returns:

A tuple of (ciphertext, nonce, tag)

aries_cloudagent.wallet.crypto.extract_pack_recipients(recipients: Sequence[dict]) → dict

Extract the pack message recipients into a dict indexed by verkey.

Parameters:recipients – Recipients to locate Raises:ValueError – If the recipients block is mal-formatted

aries_cloudagent.wallet.crypto.extract_payload_key(sender_cek: dict, recip_secret: bytes) → Tuple[bytes, str]

Extract the payload key from pack recipient details.

Returns: A tuple of the CEK and sender verkey

aries_cloudagent.wallet.crypto.prepare_pack_recipient_keys(to_verkeys: Sequence[bytes], from_secret: bytes = None) → Tuple[str, bytes]

Assemble the recipients block of a packed message.

Parameters:

• to_verkeys – Verkeys of recipients
• from_secret – Secret to use for signing keys

Returns:

A tuple of (json result, key)

aries_cloudagent.wallet.crypto.random_seed() → bytes

Generate a random seed value.

Returns:A new random seed

aries_cloudagent.wallet.crypto.seed_to_did(seed: str) → str

Derive a DID from a seed value.

Parameters:seed – The seed to derive Returns:The DID derived from the seed

aries_cloudagent.wallet.crypto.sign_message(message: bytes, secret: bytes) → bytes

Sign a message using a private signing key.

Parameters:

• message – The message to sign
• secret – The private signing key

Returns:

The signature

aries_cloudagent.wallet.crypto.sign_pk_from_sk(secret: bytes) → bytes

Extract the verkey from a secret signing key.

aries_cloudagent.wallet.crypto.validate_seed(seed: (<class 'str'>, <class 'bytes'>)) → bytes

Convert a seed parameter to standard format and check length.

Parameters:seed – The seed to validate Returns:The validated and encoded seed

aries_cloudagent.wallet.crypto.verify_signed_message(signed: bytes, verkey: bytes) → bool

Verify a signed message according to a public verification key.

Parameters:

• signed – The signed message
• verkey – The verkey to use in verification

Returns:

True if verified, else False

aries_cloudagent.wallet.error module

Wallet-related exceptions.

exception aries_cloudagent.wallet.error.WalletDuplicateError(*args, error_code: str = None, **kwargs)

Bases: aries_cloudagent.wallet.error.WalletError

Duplicate record exception.

exception aries_cloudagent.wallet.error.WalletError(*args, error_code: str = None, **kwargs)

Bases: aries_cloudagent.core.error.BaseError

General wallet exception.

exception aries_cloudagent.wallet.error.WalletNotFoundError(*args, error_code: str = None, **kwargs)

Bases: aries_cloudagent.wallet.error.WalletError

Record not found exception.

aries_cloudagent.wallet.indy module

Indy implementation of BaseWallet interface.

class aries_cloudagent.wallet.indy.IndyWallet(config: dict = None)

Bases: aries_cloudagent.wallet.base.BaseWallet

Indy wallet implementation.

DEFAULT_FRESHNESS = 0

DEFAULT_KEY = ''

DEFAULT_KEY_DERIVIATION = 'ARGON2I_MOD'

DEFAULT_NAME = 'default'

DEFAULT_STORAGE_TYPE = None

KEY_DERIVATION_ARGON2I_INT = 'ARGON2I_INT'

KEY_DERIVATION_ARGON2I_MOD = 'ARGON2I_MOD'

KEY_DERIVATION_RAW = 'RAW'

WALLET_TYPE = 'indy'

close()

Close previously-opened wallet, removing it if so configured.

create(replace: bool = False)

Create a new wallet.

Parameters:

replace – Removes the old wallet if True

Raises:

• WalletError – If there was a problem removing the wallet
• WalletError – IF there was a libindy error

create_local_did(seed: str = None, did: str = None, metadata: dict = None) → aries_cloudagent.wallet.base.DIDInfo

Create and store a new local DID.

Parameters:

• seed – Optional seed to use for did
• did – The DID to use
• metadata – Metadata to store with DID

Returns:

A DIDInfo instance representing the created DID

Raises:

• WalletDuplicateError – If the DID already exists in the wallet
• WalletError – If there is a libindy error

create_signing_key(seed: str = None, metadata: dict = None) → aries_cloudagent.wallet.base.KeyInfo

Create a new public/private signing keypair.

Parameters:

• seed – Seed for key
• metadata – Optional metadata to store with the keypair

Returns:

A KeyInfo representing the new record

Raises:

• WalletDuplicateError – If the resulting verkey already exists in the wallet
• WalletError – If there is a libindy error

created

Check whether the wallet was created on the last open call.

classmethod generate_wallet_key(seed: str = None) → str

Generate a raw Indy wallet key.

get_credential_definition_tag_policy(credential_definition_id: str)

Return the tag policy for a given credential definition ID.

get_local_did(did: str) → aries_cloudagent.wallet.base.DIDInfo

Find info for a local DID.

Parameters:

did – The DID to get info for

Returns:

A DIDInfo instance representing the found DID

Raises:

• WalletNotFoundError – If the DID is not found
• WalletError – If there is a libindy error

get_local_did_for_verkey(verkey: str) → aries_cloudagent.wallet.base.DIDInfo

Resolve a local DID from a verkey.

Parameters:verkey – The verkey to get the local DID for Returns:A DIDInfo instance representing the found DID Raises:WalletNotFoundError – If the verkey is not found

get_local_dids() → Sequence[aries_cloudagent.wallet.base.DIDInfo]

Get list of defined local DIDs.

Returns:A list of locally stored DIDs as DIDInfo instances

get_signing_key(verkey: str) → aries_cloudagent.wallet.base.KeyInfo

Fetch info for a signing keypair.

Parameters:

verkey – The verification key of the keypair

Returns:

A KeyInfo representing the keypair

Raises:

• WalletNotFoundError – If no keypair is associated with the verification key
• WalletError – If there is a libindy error

handle

Get internal wallet reference.

Returns:A handle to the wallet

master_secret_id

Accessor for the master secret id.

Returns:The master secret id

name

Accessor for the wallet name.

Returns:The wallet name

open()

Open wallet, removing and/or creating it if so configured.

Raises:

• WalletError – If wallet not found after creation
• WalletNotFoundError – If the wallet is not found
• WalletError – If the wallet is already open
• WalletError – If there is a libindy error

opened

Check whether wallet is currently open.

Returns:True if open, else False

pack_message(message: str, to_verkeys: Sequence[str], from_verkey: str = None) → bytes

Pack a message for one or more recipients.

Parameters:

• message – The message to pack
• to_verkeys – List of verkeys to pack for
• from_verkey – Sender verkey to pack from

Returns:

The resulting packed message bytes

Raises:

• WalletError – If no message is provided
• WalletError – If a libindy error occurs

remove()

Remove an existing wallet.

Raises:

• WalletNotFoundError – If the wallet could not be found
• WalletError – If there was an libindy error

replace_local_did_metadata(did: str, metadata: dict)

Replace metadata for a local DID.

Parameters:

• did – The DID to replace metadata for
• metadata – The new metadata

replace_signing_key_metadata(verkey: str, metadata: dict)

Replace the metadata associated with a signing keypair.

Parameters:

• verkey – The verification key of the keypair
• metadata – The new metadata to store

Raises:

WalletNotFoundError – if no keypair is associated with the verification key

set_credential_definition_tag_policy(credential_definition_id: str, taggables: Sequence[str] = None, retroactive: bool = True)

Set the tag policy for a given credential definition ID.

Parameters:

• credential_definition_id – The ID of the credential definition
• taggables – A sequence of string values representing attribute names
• retroactive – Whether to apply the policy to previously-stored credentials

sign_message(message: bytes, from_verkey: str) → bytes

Sign a message using the private key associated with a given verkey.

Parameters:

• message – Message bytes to sign
• from_verkey – The verkey to use to sign

Returns:

A signature

Raises:

• WalletError – If the message is not provided
• WalletError – If the verkey is not provided
• WalletError – If a libindy error occurs

unpack_message(enc_message: bytes) -> (<class 'str'>, <class 'str'>, <class 'str'>)

Unpack a message.

Parameters:

enc_message – The packed message bytes

Returns:

(message, from_verkey, to_verkey)

Return type:

A tuple

Raises:

• WalletError – If the message is not provided
• WalletError – If a libindy error occurs

verify_message(message: bytes, signature: bytes, from_verkey: str) → bool

Verify a signature against the public key of the signer.

Parameters:

• message – Message to verify
• signature – Signature to verify
• from_verkey – Verkey to use in verification

Returns:

True if verified, else False

Raises:

• WalletError – If the verkey is not provided
• WalletError – If the signature is not provided
• WalletError – If the message is not provided
• WalletError – If a libindy error occurs

aries_cloudagent.wallet.provider module

Default wallet provider classes.

class aries_cloudagent.wallet.provider.WalletProvider

Bases: aries_cloudagent.config.base.BaseProvider

Provider for the default configurable wallet classes.

WALLET_TYPES = {'basic': 'aries_cloudagent.wallet.basic.BasicWallet', 'indy': 'aries_cloudagent.wallet.indy.IndyWallet'}

provide(settings: aries_cloudagent.config.base.BaseSettings, injector: aries_cloudagent.config.base.BaseInjector)

Create and open the wallet instance.

aries_cloudagent.wallet.routes module

Wallet admin routes.

class aries_cloudagent.wallet.routes.DIDListSchema(*, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)

Bases: marshmallow.schema.Schema

Result schema for connection list.

opts = <marshmallow.schema.SchemaOpts object>

class aries_cloudagent.wallet.routes.DIDResultSchema(*, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)

Bases: marshmallow.schema.Schema

Result schema for a DID.

opts = <marshmallow.schema.SchemaOpts object>

class aries_cloudagent.wallet.routes.DIDSchema(*, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)

Bases: marshmallow.schema.Schema

Result schema for a DID.

opts = <marshmallow.schema.SchemaOpts object>

class aries_cloudagent.wallet.routes.GetTagPolicyResultSchema(*, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)

Bases: marshmallow.schema.Schema

Result schema for tagging policy get request.

opts = <marshmallow.schema.SchemaOpts object>

class aries_cloudagent.wallet.routes.SetTagPolicyRequestSchema(*, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)

Bases: marshmallow.schema.Schema

Request schema for tagging policy set request.

opts = <marshmallow.schema.SchemaOpts object>

aries_cloudagent.wallet.routes.format_did_info(info: aries_cloudagent.wallet.base.DIDInfo)

Serialize a DIDInfo object.

aries_cloudagent.wallet.routes.register(app: <sphinx.ext.autodoc.importer._MockObject object at 0x7ffa2ed67c18>)

Register routes.

aries_cloudagent.wallet.routes.wallet_create_did(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7ffa2ed67c18>)

Request handler for creating a new wallet DID.

Parameters:request – aiohttp request object Returns:The DID info

aries_cloudagent.wallet.routes.wallet_did_list(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7ffa2ed67c18>)

Request handler for searching wallet DIDs.

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

aries_cloudagent.wallet.routes.wallet_get_public_did(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7ffa2ed67c18>)

Request handler for fetching the current public DID.

Parameters:request – aiohttp request object Returns:The DID info

aries_cloudagent.wallet.routes.wallet_get_tagging_policy(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7ffa2ed67c18>)

Request handler for getting the tag policy associated with a cred def.

Parameters:request – aiohttp request object Returns:A JSON object containing the tagging policy

aries_cloudagent.wallet.routes.wallet_set_public_did(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7ffa2ed67c18>)

Request handler for setting the current public DID.

Parameters:request – aiohttp request object Returns:The updated DID info

aries_cloudagent.wallet.routes.wallet_set_tagging_policy(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7ffa2ed67c18>)

Request handler for setting the tag policy associated with a cred def.

Parameters:request – aiohttp request object Returns:An empty JSON response

aries_cloudagent.wallet.util module

Wallet utility functions.

aries_cloudagent.wallet.util.b58_to_bytes(val: str) → bytes

Convert a base 58 string to bytes.

aries_cloudagent.wallet.util.b64_to_bytes(val: str, urlsafe=False) → bytes

Convert a base 64 string to bytes.

aries_cloudagent.wallet.util.b64_to_str(val: str, urlsafe=False, encoding=None) → str

Convert a base 64 string to string on input encoding (default utf-8).

aries_cloudagent.wallet.util.bytes_to_b58(val: bytes) → str

Convert a byte string to base 58.

aries_cloudagent.wallet.util.bytes_to_b64(val: bytes, urlsafe=False, pad=True) → str

Convert a byte string to base 64.

aries_cloudagent.wallet.util.pad(val: str) → str

Pad base64 values if need be: JWT calls to omit trailing padding.

aries_cloudagent.wallet.util.set_urlsafe_b64(val: str, urlsafe: bool = True) → str

Set URL safety in base64 encoding.

aries_cloudagent.wallet.util.str_to_b64(val: str, urlsafe=False, encoding=None, pad=True) → str

Convert a string to base64 string on input encoding (default utf-8).

aries_cloudagent.wallet.util.unpad(val: str) → str

Remove padding from base64 values if need be.