160 lines
6.0 KiB
Python
160 lines
6.0 KiB
Python
# cryptocb.py
|
|
#
|
|
# Copyright (C) 2026 wolfSSL Inc.
|
|
#
|
|
# This file is part of wolfSSL. (formerly known as CyaSSL)
|
|
#
|
|
# wolfSSL is free software; you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation; either version 2 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# wolfSSL is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with this program; if not, write to the Free Software
|
|
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
|
|
|
|
# pylint: disable=no-member,no-name-in-module
|
|
|
|
from __future__ import annotations
|
|
|
|
import logging
|
|
from collections import defaultdict
|
|
from typing import TYPE_CHECKING, Final
|
|
|
|
from typing_extensions import Self
|
|
|
|
from wolfcrypt._ffi import ffi as _ffi
|
|
from wolfcrypt._ffi import lib as _lib
|
|
from wolfcrypt.exceptions import WolfCryptError
|
|
|
|
if TYPE_CHECKING:
|
|
from types import TracebackType
|
|
|
|
log = logging.getLogger(__name__)
|
|
|
|
if _lib.CRYPTO_CB_ENABLED:
|
|
|
|
ALGO_TYPE_NAME: Final = defaultdict(
|
|
lambda: "unknown",
|
|
{
|
|
_lib.WC_ALGO_TYPE_NONE: "none",
|
|
_lib.WC_ALGO_TYPE_HASH: "hash",
|
|
_lib.WC_ALGO_TYPE_CIPHER: "cipher",
|
|
_lib.WC_ALGO_TYPE_PK: "pk",
|
|
_lib.WC_ALGO_TYPE_RNG: "rng",
|
|
_lib.WC_ALGO_TYPE_SEED: "seed",
|
|
_lib.WC_ALGO_TYPE_HMAC: "hmac",
|
|
_lib.WC_ALGO_TYPE_CMAC: "cmac",
|
|
_lib.WC_ALGO_TYPE_CERT: "cert",
|
|
_lib.WC_ALGO_TYPE_KDF: "kdf",
|
|
_lib.WC_ALGO_TYPE_COPY: "copy",
|
|
_lib.WC_ALGO_TYPE_FREE: "free",
|
|
_lib.WC_ALGO_TYPE_MAX: "max",
|
|
},
|
|
)
|
|
|
|
HASH_TYPE_NAME: Final = defaultdict(
|
|
lambda: "unknown",
|
|
{
|
|
_lib.WC_HASH_TYPE_SHA: "SHA1",
|
|
_lib.WC_HASH_TYPE_SHA256: "SHA256",
|
|
_lib.WC_HASH_TYPE_SHA384: "SHA384",
|
|
_lib.WC_HASH_TYPE_SHA512: "SHA512",
|
|
_lib.WC_HASH_TYPE_SHA3_256: "SHA3_256",
|
|
_lib.WC_HASH_TYPE_SHA3_384: "SHA3_384",
|
|
_lib.WC_HASH_TYPE_SHA3_512: "SHA3_512",
|
|
},
|
|
)
|
|
|
|
DIGEST_SIZE: Final = {
|
|
_lib.WC_HASH_TYPE_SHA: 20,
|
|
_lib.WC_HASH_TYPE_SHA256: 32,
|
|
_lib.WC_HASH_TYPE_SHA384: 48,
|
|
_lib.WC_HASH_TYPE_SHA512: 64,
|
|
_lib.WC_HASH_TYPE_SHA3_256: 32,
|
|
_lib.WC_HASH_TYPE_SHA3_384: 48,
|
|
_lib.WC_HASH_TYPE_SHA3_512: 64,
|
|
}
|
|
|
|
|
|
class CryptoCallback:
|
|
def __init__(self, device_id: int) -> None:
|
|
self.device_id = device_id
|
|
self.ctx = _ffi.new_handle(self)
|
|
ret = _lib.wc_CryptoCb_RegisterDevice(device_id, _lib.py_wc_crypto_callback, self.ctx)
|
|
if ret < 0: # pragma: no cover
|
|
raise WolfCryptError(f"CryptoCb device registration error ({ret})")
|
|
|
|
def __enter__(self) -> Self:
|
|
return self
|
|
|
|
def __exit__(
|
|
self, exc_type: type[BaseException] | None, exc_value: BaseException | None, traceback: TracebackType | None
|
|
) -> bool:
|
|
self._unregister()
|
|
return False
|
|
|
|
def __del__(self) -> None:
|
|
self._unregister()
|
|
|
|
def callback(self, device_id: int, info: _lib.wc_CryptoInfo) -> int:
|
|
log.debug("device_id=%d algo_type = %s", device_id, ALGO_TYPE_NAME[info.algo_type])
|
|
try:
|
|
if info.algo_type == _lib.WC_ALGO_TYPE_HASH:
|
|
if info.hash.type not in DIGEST_SIZE:
|
|
return _lib.CRYPTOCB_UNAVAILABLE
|
|
log.debug("hash_type = %s", HASH_TYPE_NAME[info.hash.type])
|
|
if info.hash.digest == _ffi.NULL:
|
|
self.hash_update_callback(
|
|
device_id,
|
|
info.hash.type,
|
|
bytes(_ffi.buffer(info.hash.data, info.hash.data_size)),
|
|
)
|
|
else:
|
|
digest = self.hash_finalize_callback(device_id, info.hash.type)
|
|
if len(digest) != DIGEST_SIZE[info.hash.type]:
|
|
raise ValueError(
|
|
f"Generated digest is expected to be {DIGEST_SIZE[info.hash.type]} bytes long, "
|
|
f"but is {len(digest)} bytes long"
|
|
)
|
|
_ffi.buffer(info.hash.digest, DIGEST_SIZE[info.hash.type])[:] = digest
|
|
return 0
|
|
if info.algo_type == _lib.WC_ALGO_TYPE_CIPHER:
|
|
self.cipher_callback(device_id)
|
|
return 0
|
|
if info.algo_type == _lib.WC_ALGO_TYPE_RNG:
|
|
out = self.rng_callback(device_id, info.rng.rng, info.rng.sz)
|
|
if len(out) != info.rng.sz:
|
|
raise ValueError(
|
|
f"Generated random is expected to be {info.rng.sz} bytes long, but is {len(out)} bytes long"
|
|
)
|
|
_ffi.buffer(info.rng.out, info.rng.sz)[:] = out
|
|
return 0
|
|
return _lib.CRYPTOCB_UNAVAILABLE
|
|
except NotImplementedError:
|
|
return _lib.CRYPTOCB_UNAVAILABLE
|
|
|
|
def rng_callback(self, device_id: int, rng: _lib.RNG, size: int) -> bytes:
|
|
raise NotImplementedError
|
|
|
|
def hash_update_callback(self, device_id: int, hash_type: int, data: bytes) -> None:
|
|
raise NotImplementedError
|
|
|
|
def hash_finalize_callback(self, device_id: int, hash_type: int) -> bytes:
|
|
raise NotImplementedError
|
|
|
|
def cipher_callback(self, device_id: int) -> None:
|
|
raise NotImplementedError
|
|
|
|
def _unregister(self) -> None:
|
|
_lib.wc_CryptoCb_UnRegisterDevice(self.device_id)
|
|
|
|
@classmethod
|
|
def default_device_id(cls) -> int:
|
|
return _lib.wc_CryptoCb_DefaultDevID()
|