RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-01-17 06:12:43 +01:00
Code Releases Activity

pkg/micro-ecc: remove trailing whitespaces from doc.txt

Browse Source
This commit is contained in:
Martine Lenders 2020-12-19 09:59:32 +01:00
parent b6a5c533d9
commit ce9050f2a6
No known key found for this signature in database
GPG Key ID: CCD317364F63286F
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
pkg/micro-ecc/doc.txt
View File

@ -5,42 +5,42 @@
* @brief Micro-ECC for RIOT * @brief Micro-ECC for RIOT
* *
* # Micro-ECC for RIOT * # Micro-ECC for RIOT
* *
* This port of Micro-ECC to RIOT is based on the Micro-ECC * This port of Micro-ECC to RIOT is based on the Micro-ECC
* [upstream](https://github.com/kmackay/micro-ecc) and adds `hwrng_read` * [upstream](https://github.com/kmackay/micro-ecc) and adds `hwrng_read`
* (provided by RIOT) as the default RNG function if it is available on the target * (provided by RIOT) as the default RNG function if it is available on the target
* platform. This port also fixes a minor issue with unused variables in the * platform. This port also fixes a minor issue with unused variables in the
* upstream code. * upstream code.
* *
* # Usage * # Usage
* *
* ## Build * ## Build
* *
* Add * Add
* ```Makefile * ```Makefile
* USEPKG += micro-ecc * USEPKG += micro-ecc
* ``` * ```
* to your Makefile. * to your Makefile.
* *
* ## Choosing the right API * ## Choosing the right API
* *
* Before using the Micro-ECC library, you need to check the `Makefile.features` * Before using the Micro-ECC library, you need to check the `Makefile.features`
* of your target board to see if `periph_hwrng` is provided. * of your target board to see if `periph_hwrng` is provided.
* *
* If it is provided, you may safely use `uECC_make_key` to generate ECDSA key * If it is provided, you may safely use `uECC_make_key` to generate ECDSA key
* pairs and call `uECC_sign`/`uECC_verify` to sign/verify the ECDSA signatures. * pairs and call `uECC_sign`/`uECC_verify` to sign/verify the ECDSA signatures.
* *
* If not, you cannot use `uECC_make_key` or `uECC_sign` APIs anymore. The ECDSA * If not, you cannot use `uECC_make_key` or `uECC_sign` APIs anymore. The ECDSA
* keys have to be generated on a platform with HWRNG support (e.g., `native`) and * keys have to be generated on a platform with HWRNG support (e.g., `native`) and
* transferred to your target device. You need to use `uECC_sign_deterministic` to * transferred to your target device. You need to use `uECC_sign_deterministic` to
* perform ECDSA deterministic signing (standardized by RFC 6979). You can still * perform ECDSA deterministic signing (standardized by RFC 6979). You can still
* use `uECC_verify` to verify the signatures from both signing APIs. * use `uECC_verify` to verify the signatures from both signing APIs.
* *
* **WARNING** Calling `uECC_make_key` and `uECC_sign` APIs on platforms without * **WARNING** Calling `uECC_make_key` and `uECC_sign` APIs on platforms without
* HWRNG support will lead to compile failure. * HWRNG support will lead to compile failure.
* *
* Examples of using these uECC APIs can be found in the `test` folder of the * Examples of using these uECC APIs can be found in the `test` folder of the
* Micro-ECC upstream. * Micro-ECC upstream.
* *
* @see https://github.com/kmackay/micro-ecc * @see https://github.com/kmackay/micro-ecc
*/ */