166 lines
6.6 KiB
Python
166 lines
6.6 KiB
Python
"""
|
|
Cryptographic ciphers.
|
|
|
|
MicroPython module: https://docs.micropython.org/en/v1.26.0/library/cryptolib.html
|
|
|
|
---
|
|
Module: 'cryptolib' on micropython-v1.26.0-rp2-RPI_PICO
|
|
"""
|
|
|
|
# MCU: {'mpy': 'v6.3', 'build': '', 'ver': '1.26.0', 'arch': 'armv6m', 'version': '1.26.0', 'port': 'rp2', 'board': 'RPI_PICO', 'family': 'micropython', 'board_id': 'RPI_PICO', 'variant': '', 'cpu': 'RP2040'}
|
|
# Stubber: v1.26.0
|
|
from __future__ import annotations
|
|
from _typeshed import Incomplete
|
|
from _mpy_shed import AnyReadableBuf, AnyWritableBuf
|
|
from typing import overload
|
|
from typing_extensions import Awaitable, TypeAlias, TypeVar
|
|
|
|
class aes:
|
|
"""
|
|
.. class:: aes
|
|
"""
|
|
|
|
@overload
|
|
def encrypt(self, in_buf: AnyReadableBuf, /) -> bytes:
|
|
"""
|
|
Encrypt *in_buf*. If no *out_buf* is given result is returned as a
|
|
newly allocated `bytes` object. Otherwise, result is written into
|
|
mutable buffer *out_buf*. *in_buf* and *out_buf* can also refer
|
|
to the same mutable buffer, in which case data is encrypted in-place.
|
|
"""
|
|
|
|
@overload
|
|
def encrypt(self, in_buf: AnyReadableBuf, out_buf: AnyWritableBuf, /) -> None:
|
|
"""
|
|
Encrypt *in_buf*. If no *out_buf* is given result is returned as a
|
|
newly allocated `bytes` object. Otherwise, result is written into
|
|
mutable buffer *out_buf*. *in_buf* and *out_buf* can also refer
|
|
to the same mutable buffer, in which case data is encrypted in-place.
|
|
"""
|
|
|
|
@overload
|
|
def encrypt(self, in_buf: AnyReadableBuf, /) -> bytes:
|
|
"""
|
|
Encrypt *in_buf*. If no *out_buf* is given result is returned as a
|
|
newly allocated `bytes` object. Otherwise, result is written into
|
|
mutable buffer *out_buf*. *in_buf* and *out_buf* can also refer
|
|
to the same mutable buffer, in which case data is encrypted in-place.
|
|
"""
|
|
|
|
@overload
|
|
def encrypt(self, in_buf: AnyReadableBuf, out_buf: AnyWritableBuf, /) -> None:
|
|
"""
|
|
Encrypt *in_buf*. If no *out_buf* is given result is returned as a
|
|
newly allocated `bytes` object. Otherwise, result is written into
|
|
mutable buffer *out_buf*. *in_buf* and *out_buf* can also refer
|
|
to the same mutable buffer, in which case data is encrypted in-place.
|
|
"""
|
|
|
|
@overload
|
|
def decrypt(self, in_buf: AnyReadableBuf, /) -> bytes:
|
|
"""
|
|
Like `encrypt()`, but for decryption.
|
|
"""
|
|
|
|
@overload
|
|
def decrypt(self, in_buf: AnyReadableBuf, out_buf: AnyWritableBuf, /) -> None:
|
|
"""
|
|
Like `encrypt()`, but for decryption.
|
|
"""
|
|
|
|
@overload
|
|
def decrypt(self, in_buf: AnyReadableBuf, /) -> bytes:
|
|
"""
|
|
Like `encrypt()`, but for decryption.
|
|
"""
|
|
|
|
@overload
|
|
def decrypt(self, in_buf: AnyReadableBuf, out_buf: AnyWritableBuf, /) -> None:
|
|
"""
|
|
Like `encrypt()`, but for decryption.
|
|
"""
|
|
|
|
@overload
|
|
def __init__(self, key: AnyReadableBuf, mode: int, /):
|
|
"""
|
|
Initialize cipher object, suitable for encryption/decryption. Note:
|
|
after initialization, cipher object can be use only either for
|
|
encryption or decryption. Running decrypt() operation after encrypt()
|
|
or vice versa is not supported.
|
|
|
|
Parameters are:
|
|
|
|
* *key* is an encryption/decryption key (bytes-like).
|
|
* *mode* is:
|
|
|
|
* ``1`` (or ``cryptolib.MODE_ECB`` if it exists) for Electronic Code Book (ECB).
|
|
* ``2`` (or ``cryptolib.MODE_CBC`` if it exists) for Cipher Block Chaining (CBC).
|
|
* ``6`` (or ``cryptolib.MODE_CTR`` if it exists) for Counter mode (CTR).
|
|
|
|
* *IV* is an initialization vector for CBC mode.
|
|
* For Counter mode, *IV* is the initial value for the counter.
|
|
"""
|
|
|
|
@overload
|
|
def __init__(self, key: AnyReadableBuf, mode: int, IV: AnyReadableBuf, /):
|
|
"""
|
|
Initialize cipher object, suitable for encryption/decryption. Note:
|
|
after initialization, cipher object can be use only either for
|
|
encryption or decryption. Running decrypt() operation after encrypt()
|
|
or vice versa is not supported.
|
|
|
|
Parameters are:
|
|
|
|
* *key* is an encryption/decryption key (bytes-like).
|
|
* *mode* is:
|
|
|
|
* ``1`` (or ``cryptolib.MODE_ECB`` if it exists) for Electronic Code Book (ECB).
|
|
* ``2`` (or ``cryptolib.MODE_CBC`` if it exists) for Cipher Block Chaining (CBC).
|
|
* ``6`` (or ``cryptolib.MODE_CTR`` if it exists) for Counter mode (CTR).
|
|
|
|
* *IV* is an initialization vector for CBC mode.
|
|
* For Counter mode, *IV* is the initial value for the counter.
|
|
"""
|
|
|
|
@overload
|
|
def __init__(self, key: AnyReadableBuf, mode: int, /):
|
|
"""
|
|
Initialize cipher object, suitable for encryption/decryption. Note:
|
|
after initialization, cipher object can be use only either for
|
|
encryption or decryption. Running decrypt() operation after encrypt()
|
|
or vice versa is not supported.
|
|
|
|
Parameters are:
|
|
|
|
* *key* is an encryption/decryption key (bytes-like).
|
|
* *mode* is:
|
|
|
|
* ``1`` (or ``cryptolib.MODE_ECB`` if it exists) for Electronic Code Book (ECB).
|
|
* ``2`` (or ``cryptolib.MODE_CBC`` if it exists) for Cipher Block Chaining (CBC).
|
|
* ``6`` (or ``cryptolib.MODE_CTR`` if it exists) for Counter mode (CTR).
|
|
|
|
* *IV* is an initialization vector for CBC mode.
|
|
* For Counter mode, *IV* is the initial value for the counter.
|
|
"""
|
|
|
|
@overload
|
|
def __init__(self, key: AnyReadableBuf, mode: int, IV: AnyReadableBuf, /):
|
|
"""
|
|
Initialize cipher object, suitable for encryption/decryption. Note:
|
|
after initialization, cipher object can be use only either for
|
|
encryption or decryption. Running decrypt() operation after encrypt()
|
|
or vice versa is not supported.
|
|
|
|
Parameters are:
|
|
|
|
* *key* is an encryption/decryption key (bytes-like).
|
|
* *mode* is:
|
|
|
|
* ``1`` (or ``cryptolib.MODE_ECB`` if it exists) for Electronic Code Book (ECB).
|
|
* ``2`` (or ``cryptolib.MODE_CBC`` if it exists) for Cipher Block Chaining (CBC).
|
|
* ``6`` (or ``cryptolib.MODE_CTR`` if it exists) for Counter mode (CTR).
|
|
|
|
* *IV* is an initialization vector for CBC mode.
|
|
* For Counter mode, *IV* is the initial value for the counter.
|
|
"""
|