mirrors/pico-hsm
1
0
Fork 0
mirror of https://github.com/polhenarejos/pico-hsm.git synced 2026-01-17 09:28:05 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1
pico-hsm/README.md
Pol Henarejos b7ee325d4f
Create README.md
2022-03-08 00:36:42 +01:00

2.5 KiB
Raw Blame History

Pico HSM

This is a project to create a Hardware Security Module (HSM) with a Raspberry Pico.

Capabilities

  • Key generation and protected storing.
  • RSA key generation from 1024 to 4096 bits.
  • ECDSA key generation from 192 to 521 bits.
  • ECC curves secp192r1, secp256r1, secp384r1, secp521r1, brainpoolP256r1, brainpoolP384r1, brainpoolP512r1, secp192k1 (insecure), secp256k1.
  • SHA1, SHA224, SHA256, SHA384, SHA256 digests.
  • RSA-PSS, RSA-PKCS and raw RSA signature.
  • ECDSA signature.
  • RSA-OEP and RSA-X-509 decryption.
  • AES key generation of 128, 192 and 256 bits.
  • AES-CBC encryption/decryption.
  • PIN authorization.
  • PKCS11 compliant interface.
  • HRNG (hardware random number generator).
  • Device Key Encryption Key (DKEK) shares.
  • DKEK n-of-m threshold scheme.
  • USB/CCID support with OpenSC, openssl, etc.
  • Extended APDU support.

Security considerations

All secret keys (asymmetric and symmetric) are stored encrypted in the flash memory of the Raspberry Pico. DKEK is used as a 256 bit AES key to protect private and secret keys. Keys are never stored in RAM except for signature and decryption operations. All keys (including DKEK) are loaded and cleared every time to avoid potential flaws.

At the same time, DKEK is encrypted with doubled salted and hashed PIN. Also, the PIN is hashed in memory during the session. Hence, PIN is never stored in plain text neither in flash nor in memory. Note that PIN is conveyed from the host to the HSM in plain text if no secure channel is provided.

If the Pico is stolen the contents of private and secret keys cannot be read without the PIN, even if the flash memory is dumped.

Download

Please, go to the Release page and download the UF2 file for your board.

Note that UF2 files are shiped with a dummy VID/PID to avoid license issues (FEFF:FCFD). If you are planning to use it with OpenSC or similar, you should modify Info.plist of CCID driver to add these VID/PID or use the VID/PID patcher as follows: ./patch_vidpid.sh VID:PID input_hsm_file.uf2 output_hsm_file.uf2

You can use whatever VID/PID (i.e., 234b:0000 from FISJ), but remember that you are not authorized to distribute the binary with a VID/PID that you do not own.

Credits

Pico HSM uses the following libraries or portion of code:

  • OpenSC for ASN1 manipulation.
  • mbedTLS for cryptographic operations.
  • gnuk for low level CCID procedures and OpenPGP support.
  • TinyUSB for low level USB procedures.

In the case of gnuk, it is intended to work with STM32 processor and its family. Part of the code of CCID procedures are ported and adapted to run with Pico.