diff --git a/README.md b/README.md index 7db3c0c..7b5ad93 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,18 @@ -***Note:*** *This fork of Gnuk fixes some compiling bugs and focuses on using the ST-Link v2 clone hardware.* +***Note:*** *This fork of Gnuk fixes some compiling bugs and focuses on using the "ST-Link V2" clone hardware.* Here is the link to the original project: What's Gnuk? ============ -Gnuk is an implementation of a USB cryptographic security token that supports the OpenPGP card protocol version 3. It runs on a STM32F103 processor (and its compatible). In short it allows one to convert a cheap $2 "ST-Link v2" clone device into a hardware security token. +Gnuk is an implementation of a USB cryptographic security token that supports the OpenPGP card protocol version 2. It runs on a STM32F103 processor (and its compatible). In short it allows one to convert a cheap $2 "ST-Link V2" clone device into a hardware security token. It has supports of Ed25519 and X25519 (ECDH on Curve25519). It also has experimental support of ECDSA (on NIST P256 and secp256k1) and ECDH (on NIST P256 and secp256k1). -With regards to RSA-4096 support, users should know that it takes more than 8 seconds to sign/decrypt. Key generation of RSA-4096 just fails, because the device doesn't have enough memory. - Gnuk supports the Key Derived Function (KDF) functionality. To use this feature one will need to use GnuPG 2.2.6 or later. How to build the Gnuk firmware ============================== -You will need the GNU toolchain and newlib for arm-none-eabi. +You will need the GNU toolchain for arm-none-eabi and newlib. To clone the source code and compile, use the following commands. ```