deon/gnuk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
Deon Spengler
2022-07-17 12:39:26 +02:00
parent 7d1b5e4b71
commit 057920600f
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -4,7 +4,7 @@ Here is the link to the original project: <http://git.gniibe.org/cgit/gnuk/gnuk.
What's Gnuk? 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 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.
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). 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).
@@ -16,7 +16,7 @@ How to build the Gnuk firmware
============================== ==============================
You will need the GNU toolchain and newlib for arm-none-eabi. You will need the GNU toolchain and newlib for arm-none-eabi.
To clone source code and compile, use the following commands To clone the source code and compile, use the following commands.
``` ```
git clone --recursive https://git.spengler.co.za/deon/gnuk.git gnuk git clone --recursive https://git.spengler.co.za/deon/gnuk.git gnuk
cd gnuk/src cd gnuk/src
@@ -30,7 +30,7 @@ Then, we will have "gnuk.bin" under src/build directory.
How to flash the Gnuk firmware How to flash the Gnuk firmware
============================== ==============================
Ensure that you have openocd installed. In order to flash the firmware ensure that you have openocd installed.
Now create a file called stm32f103.cfg with the following content Now create a file called stm32f103.cfg with the following content
``` ```