Mirrors_BOOKS/Threadx-docs
1
0
Fork 0
mirror of https://github.com/eclipse-threadx/rtos-docs.git synced 2026-02-06 02:52:14 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Migrate NetX Crypto docs to Eclipse, other link fixes (#11)

Browse Source 
* Migrate NetX Crypto docs to Eclipse, other link fixes

* Fix netx duo crypto paths

* Fix index links to HTTP guide
This commit is contained in:
timlt
2024-03-13 17:14:09 -06:00
committed by GitHub
parent beaff7224f
commit 9f62733930
9 changed files with 1908 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
rtos-docs/netx-duo/index.md
View File

@@ -27,16 +27,17 @@ NetX Duo addons
- [Ch. 3 - NetX Duo BSD Services](netx-duo-bsd/chapter3.md)
- NetX Duo Crypto user guide
- [Ch. 1 - Introduction to NetX Duo Crypto](../netx/netx-crypto/chapter1.md)
- [Ch. 2 - Installation and use of NetX Duo Crypto](../netx/netx-crypto/chapter2.md)
- [Ch. 3 - Functional components of NetX Duo Crypto](../netx/netx-crypto/chapter3.md)
- [Ch. 4 - NetX Duo Crypto API description](../netx/netx-crypto/chapter4.md)
- [Ch. 1 - Introduction to NetX Duo Crypto](netx-duo-crypto/chapter1.md)
- [Ch. 2 - Installation and use of NetX Duo Crypto](netx-duo-crypto/chapter2.md)
- [Ch. 3 - Functional components of NetX Duo Crypto](netx-duo-crypto/chapter3.md)
- [Ch. 4 - NetX Duo Crypto API description](netx-duo-crypto/chapter4.md)
- [App. A - Azure RTOS NetX Crypto CAVS test](netx-duo-crypto/appendix-a.md)
- NetX Duo DHCP client user guide
- [Ch. 1 - Introduction to the NetX Duo DHCP client](netx-duo-dhcp-client/chapter1.md)
- [Ch. 2 - Installation and use of NetX Duo DHCP client](netx-duo-dhcp-client/chapter2.md)
- [Ch. 3 - Description of NetX Duo DHCP client services](netx-duo-dhcp-client/chapter3.md)
- [App. A - Description of the Restore state feature for NetX Duo DHCP client services](netx-duo-dhcp-client/appendixA.md)
- [App. A - Description of the Restore state feature for NetX Duo DHCP client services](netx-duo-dhcp-client/appendix-a.md)
- NetX Duo DHCP server user guide
- [Ch. 1 - Introduction to NetX Duo DHCP server](netx-duo-dhcp-server/chapter1.md)
@@ -71,9 +72,9 @@ NetX Duo addons
- [Ch. 3 - Description of FTP services](netx-duo-ftp/chapter3.md)
- NetX Duo HTTP user guide
- [Chapter 1 - Introduction to NetX Duo HTTP](netx-duo-http/chapter1.md)
- [Chapter 2 - Installation and Use of NetX Duo HTTP](netx-duo-http/chapter2.md)
- [Chapter 3 - Description of NetX HTTP Services](netx-duo-http/chapter3.md)
- [Chapter 1 - Introduction to NetX Duo HTTP](netx-duo-http/Chapter1.md)
- [Chapter 2 - Installation and Use of NetX Duo HTTP](netx-duo-http/Chapter2.md)
- [Chapter 3 - Description of NetX HTTP Services](netx-duo-http/Chapter3.md)
- NetX Duo Iperf user guide
- [Chapter 1 - Introduction to NetX Duo Iperf](netx-duo-iperf/chapter1.md)

71
rtos-docs/netx-duo/netx-duo-crypto/appendix-a.md Normal file
View File

@@ -0,0 +1,71 @@
---
title: Appendix - NetX Duo Crypto CAVS test
description: NetX Duo Crypto CAVS test
---
# Appendix - NetX Duo Crypto CAVS test
```
NetX Crypto CAVS AES Test: CBCGFSbox128........................SUCCESS!
NetX Crypto CAVS AES Test: CBCGFSbox192........................SUCCESS!
NetX Crypto CAVS AES Test: CBCGFSbox256........................SUCCESS!
NetX Crypto CAVS AES Test: CBCMCT128...........................SUCCESS!
NetX Crypto CAVS AES Test: CBCMCT192...........................SUCCESS!
NetX Crypto CAVS AES Test: CBCMCT256...........................SUCCESS!
NetX Crypto CAVS AES Test: CBCMMT128...........................SUCCESS!
NetX Crypto CAVS AES Test: CBCMMT192...........................SUCCESS!
NetX Crypto CAVS AES Test: CBCMMT256...........................SUCCESS!
NetX Crypto CAVS AES Test: CBCKeySbox128.......................SUCCESS!
NetX Crypto CAVS AES Test: CBCKeySbox192.......................SUCCESS!
NetX Crypto CAVS AES Test: CBCKeySbox256.......................SUCCESS!
NetX Crypto CAVS AES Test: CBCVarKey128........................SUCCESS!
NetX Crypto CAVS AES Test: CBCVarKey192........................SUCCESS!
NetX Crypto CAVS AES Test: CBCVarKey256........................SUCCESS!
NetX Crypto CAVS AES Test: CBCVarTxt128........................SUCCESS!
NetX Crypto CAVS AES Test: CBCVarTxt192........................SUCCESS!
NetX Crypto CAVS AES Test: CBCVarTxt256........................SUCCESS!
NetX Crypto CAVS 3DES Test: TCBCinvperm 192....................SUCCESS!
NetX Crypto CAVS 3DES Test: TCBCpermop 192.....................SUCCESS!
NetX Crypto CAVS 3DES Test: TCBCvarkey 192.....................SUCCESS!
NetX Crypto CAVS 3DES Test: TCBCvartext 192....................SUCCESS!
NetX Crypto CAVS 3DES Test: TCBCsubtab 192.....................SUCCESS!
NetX Crypto CAVS 3DES Test: TCBCMMT2 192.......................SUCCESS!
NetX Crypto CAVS 3DES Test: TCBCMMT3 192.......................SUCCESS!
NetX Crypto CAVS 3DES Test: TCBCMonte2 192.....................SUCCESS!
NetX Crypto CAVS 3DES Test: TCBCMonte3 192.....................SUCCESS!
NetX Crypto CAVS SHA Test: SHA1LongMsg.........................SUCCESS!
NetX Crypto CAVS SHA Test: SHA1Monte...........................SUCCESS!
NetX Crypto CAVS SHA Test: SHA1ShortMsg........................SUCCESS!
NetX Crypto CAVS SHA Test: SHA224LongMsg.......................SUCCESS!
NetX Crypto CAVS SHA Test: SHA224Monte.........................SUCCESS!
NetX Crypto CAVS SHA Test: SHA224ShortMsg......................SUCCESS!
NetX Crypto CAVS SHA Test: SHA256LongMsg.......................SUCCESS!
NetX Crypto CAVS SHA Test: SHA256Monte.........................SUCCESS!
NetX Crypto CAVS SHA Test: SHA256ShortMsg......................SUCCESS!
NetX Crypto CAVS SHA Test: SHA384LongMsg.......................SUCCESS!
NetX Crypto CAVS SHA Test: SHA384Monte.........................SUCCESS!
NetX Crypto CAVS SHA Test: SHA384ShortMsg......................SUCCESS!
NetX Crypto CAVS SHA Test: SHA512LongMsg.......................SUCCESS!
NetX Crypto CAVS SHA Test: SHA512Monte.........................SUCCESS!
NetX Crypto CAVS SHA Test: SHA512ShortMsg......................SUCCESS!
NetX Crypto CAVS SHA Test: SHA512_224LongMsg...................SUCCESS!
NetX Crypto CAVS SHA Test: SHA512_224Monte.....................SUCCESS!
NetX Crypto CAVS SHA Test: SHA512_224ShortMsg..................SUCCESS!
NetX Crypto CAVS SHA Test: SHA512_256LongMsg...................SUCCESS!
NetX Crypto CAVS SHA Test: SHA512_256Monte.....................SUCCESS!
NetX Crypto CAVS SHA Test: SHA512_256ShortMsg..................SUCCESS!
NetX Crypto CAVS HMAC Test: HMAC...............................SUCCESS!
NetX Crypto CAVS DRBG Test: CTR_DRBG...........................SUCCESS!
NetX Crypto CAVS KDF Test: tls.................................SUCCESS!
NetX Crypto CAVS RSA2_fixed Test: SigGen15_186-3...............SUCCESS!
NetX Crypto CAVS RSA2 Test: SigGen15_186-3.....................SUCCESS!
NetX Crypto CAVS RSA2_fixed Test: SigVer15_186-3...............SUCCESS!
NetX Crypto CAVS ECDSA Test: KeyPair...........................SUCCESS!
NetX Crypto CAVS ECDSA Test: SigGen............................SUCCESS!
NetX Crypto CAVS ECDSA Test: SigGenComponent...................SUCCESS!
NetX Crypto CAVS ECDSA Test: SigVer............................SUCCESS!
**** Testing Complete ****
```
Test finished.

58
rtos-docs/netx-duo/netx-duo-crypto/chapter1.md Normal file
View File

@@ -0,0 +1,58 @@
---
title: Chapter 1 - Introduction to NetX Duo Crypto
description: NetX Duo Crypto is a high-performance real-time implementation of cryptographic algorithms designed to provide data encryption and authentication services.
---
# Chapter 1 - Introduction to NetX Duo Crypto
NetX Duo Crypto is a high-performance real-time implementation of cryptographic algorithms designed to provide data encryption and authentication services. NetX Duo Crypto is designed to plug in for NetX Duo Secure TLS, DTLS, and IPsec modules. Applications may also use NetX Duo Crypto as a standalone module outside network security.
## NetX Duo Crypto Unique Features
NetX Duo Crypto is implemented in the standard C language (C99), compatible with virtually all C/C++ compilers. Its modular design allows an application to only link in the crypto algorithms it needs to use, therefore achieving minimal code size. The implementation is designed to work with most 32-bit microprocessors and uses only the basic math operations (addition, subtraction, multiplication, division, logical AND, OR, NOR, and bit shift operations). All these operations are used with 32-bit quantities, making NetX Duo Crypto portable across most 32-bit microprocessors. The implementation is specifically optimized to run on resource constrained microprocessors, targeting deeply embedded applications.
## Algorithms supported by NetX Duo Crypto
NetX Duo Crypto supports the following cryptographic algorithms. NetX Duo Crypto follows all general recommendations and basic requirements within the constraints of a real-time operating system and platforms requiring a small memory footprint and efficient execution.
| Algorithm | Key Length (bits) |
| --------------- | ---------------------- |
| AES(CBC, CTR) | 128, 192, 256 |
| AES(XCBC) | 128 |
| AES-CCM 8 | 128 |
| 3DES(CBC) | 192 |
| HMAC-SHA1 | Any length |
| HMAC-SHA224 | Any length |
| HMAC-SHA256 | Any length |
| HMAC-SHA384 | Any length |
| HMAC-SHA512 | Any length |
| HMAC-SHA512/224 | Any length |
| HMAC-SHA512/256 | Any length |
| HMAC-MD5 | Any length |
| RSA | 1024, 2048, 3072, 4096 |
| Algorithm | Digest Length (bits) | Block Size (bits) |
| --------------- | -------------------- | ----------------- |
| SHA1 | 160 | 512 |
| SHA224 | 224 | 512 |
| SHA256 | 256 | 512 |
| SHA384 | 384 | 1024 |
| SHA512 | 512 | 1024 |
| MD5 | 128 | 512 |
| HMAC-SHA1 | 160 | 512 |
| HMAC-SHA224 | 224 | 512 |
| HMAC-SHA256 | 256 | 512 |
| HMAC-SHA384 | 384 | 1024 |
| HMAC-SHA512 | 512 | 1024 |
| HMAC-SHA512/224 | 224 | 1024 |
| HMAC-SHA512/256 | 256 | 1024 |
| HMAC-MD5 | 128 | 512 |
| Elliptic Curve | P192/224/256/384/521 | |
## NetX Duo Crypto Requirements
TBD: Memory Requirement.. Interrupt/re-entrant safe? Needs discussion
## NetX Duo Crypto Constraints
None.

37
rtos-docs/netx-duo/netx-duo-crypto/chapter2.md Normal file
View File

@@ -0,0 +1,37 @@
---
title: Chapter 2 - Installation and use of NetX Duo Crypto
description: This chapter contains a description of various issues related to installation, setup, and usage of the NetX Duo Crypto component.
---
# Chapter 2 - Installation and use of NetX Duo Crypto
This chapter describes installation, setup, and usage of the NetX Duo Crypto component.
## Product Distribution
NetX Duo Crypto is available at [https://github.com/eclipse-threadx/netxduo/](https://github.com/eclipse-threadx/netxduo/). The package includes source files, include files, and a PDF file that contains this document, as follows:
- **nx_crypto.h**: Public API header file NetX Duo Crypto module
- **nx_crypto_*.c/h**: C/H Source files for NetX Duo Crypto
- **nx_crypto_port.h**: C header file containing all development-tool and target specific data definitions and structures.
- **NetX_Crypto_User_Guide.pdf**: PDF description of NetX Duo Crypto Module.
## NetX Duo Crypto Installation
The entire distribution mentioned previously is available in **crypto_libraries** directory, present at root level of NetX Duo repository.
In order to use NetX Duo Crypto, the entire distribution mentioned previously should be copied to the same directory level where NetX is installed. For example, if NetX is installed in the directory "\threadx\arm7\NetX" then the nx_crypto*.* directories should be copied into "\threadx\arm7\NetXCrypto".
For NetX Duo Crypto to be used in standalone mode, the entire distribution mentioned previously should be copied to the application project. For example **crypto_libraries** directory should be copied to the application project or a library project with **crypto_libraries** directory should be created and linked to the application project.
## Using NetX Duo Crypto
The application code must include the *nx_crypto.h*. Once *nx_crypto.h* is included, the application code is then able to make the NetX Duo Crypto function calls specified later in this guide.
## Configuration Options
There are several configuration options for building NetX Duo Crypto. Following is a list of all options, where each is described in detail:
- **NX_CRYPTO_MAX_RSA_MODULUS_SIZE**: Defined, this option gives the maximum RSA modulus expected, in bits. The default value is 4096 for a 4096-bit modulus. Other values can be 3072, 2048, or 1024 (not recommended).
- **NX_CRYPTO_SELF_TEST**: Defined, enables self tests for NetX Duo Crypto module. **NX_CRYPTO_FIPS** symbol is now deprecated and renamed to **NX_CRYPTO_SELF_TEST**
- **NX_CRYPTO_STANDALONE_ENABLE**: Defined enables NetX Duo Crypto to be used in standalone mode (without Eclipse ThreadX). By default this symbol is not defined.

101
rtos-docs/netx-duo/netx-duo-crypto/chapter3.md Normal file
View File

@@ -0,0 +1,101 @@
---
title: Chapter 3 - Functional description of NetX Duo Crypto
description: This chapter contains a functional description of NetX Duo Crypto.
author: TiejunMS
ms.author: tizho
ms.date: 03/08/2024
ms.topic: article
ms.service: rtos
---
# Chapter 3 - Functional description of NetX Duo Crypto
## Execution Overview
This chapter contains a functional description of NetX Duo Crypto. There are two primary types of program execution in a NetX Duo Crypto application: initialization and application interface calls.
*NetX Duo Crypto can be used as a standalone cryptographic library, or can be used with ThreadX, NetX, and/or NetX Secure.*
## AES
- **Algorithm Standard:**: NetX Duo Crypto implements AES according to NIST FIPS 197, which can be found at: [http://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.197.pdf](http://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.197.pdf)
- **Key Lengths Supported**: 128, 192, 256
- **Modes Supported**:
- CBC, CTR, (Key length 128-, 192-, 256-bit)
- XCBC (key length 128-bit only),
- CCM8 (key length 128-bit only)
- **Memory Requirements**: Application specifies input buffer and output buffer and an AES control structure. The AES control structure maintains AES algorithm state between calls to the API. The input buffer contains data to be encrypted or decrypted, and can be arbitrary size. The output buffer is used by AES to store data being processed by AES. The output buffer size must be no smaller than the input buffer size, and must be a multiple of 16 bytes, the AES block size. The input and output buffers must be contiguous memory and may not overlap, except in the special case of encrypting in-place (using the same memory for input and output). When encrypting in-place, the output buffer starts at exactly the same location as the input buffer, and must be no smaller than the input buffer. When AES encryption operates in-place no extra scratch memory is required.
## 3DES
- **Algorithm Standard**: NetX Duo Crypto implements Tripple DES(TDES, also known as 3DES) according to NIST Special Publication 800-67 rev 2: *"Recommendataion for the Triple Data Encryption Algorithm (TDES) Block Cipher"*, which can be found at: [https://csrc.nist.gov/publications/detail/sp/800-67/rev-2/final](https://csrc.nist.gov/publications/detail/sp/800-67/rev-2/final)
- **Key Length Supported**: 64 * 3 = 192
- **Memory Requreiment:**: None
In NetX Duo Crypto, the term "3DES" is used interchangeably with "TDES".
## MD5
- **Algorithm Standard**: NetX Duo Crypto implements MD5 according to RFC 1321: *"The MD5 Message-Digest Algorithm"*
- **Memory Requirement**: The application must supply an MD5 control block structure, used to maintain state between MD5 operations.
## SHA1, SHA256/512
- **Algorithm Standard:** NetX Duo Crypto implements SHA1/256/512 according to NIST FIPS publication 180-4: "*Secure Hash Standard*", which can be found at: [http://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.180-4.pdf](http://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.180-4.pdf)
- **Hash block size:**:
- SHA1: 160 bits hash value
- SHA 224: 224 bits hash value
- SHA 256: 256 bits hash value
- SHA 384: 384 bits hash value
- SHA 512: 512 bits hash value
- SHA 512/224: 224 bits hash value
- SHA 512/256: 256 bits hash value
In NetX Duo Crypto, SHA256 routines are used to hadn SHA256 and SHA224. SHA512 routines are used to hand SHA512, SHA384, SHA512/224 and SHA512/256.
- **Memory Requirement:** The application must provide a SHA control block structure for maintaining state between operations.
## RSA
- **Standard:** NetX Duo Crypto implements RSA according to the standard "*PKCS #1 v2.2: RSA Cryptography Standard*", which is published as RFC 8017 and can also be found at: [https://www.emc.com/collateral/white-papers/h11300-pkcs-1v2-2-rsa-cryptography-standard-wp.pdf](https://www.emc.com/collateral/white-papers/h11300-pkcs-1v2-2-rsa-cryptography-standard-wp.pdf)
- **Memory Requirement:** The application must provide an RSA control block structure for maintaining state between operations and to provide necessary "scratch" buffer space for intermediate calculations.
## HMAC
- **Standard:** NetX Duo Crypto implements HMAC according to FIPS PUB 198-1: "*The Keyed-Hash Message Authentication Code (HMAC)*", which can be found at: [https://csrc.nist.gov/csrc/media/publications/fips/198/1/final/documents/fips-198-1_final.pdf](https://csrc.nist.gov/csrc/media/publications/fips/198/1/final/documents/fips-198-1_final.pdf)
- **Memory Requirement:** The application must provide an HMAC control block structure for maintaining state between operations. The actual control block supplied depends on the desired underlying hash operation (e.g. SHA1, MD5).
## Elliptic Curve
- **Standard:** NetX Duo Crypto implements Elliptic Curve. The supported named curves are (prime field only):
- P-192
- P-224
- P-256
- P-384
- P-521
> [!TIP]
> Uncompressed format is supported. See section 2.3.3 and 2.3.4 of SEC1-v1: [http://www.secg.org/sec1-v2.pdf](http://www.secg.org/sec1-v2.pdf)
- **Memory Requirement:** None
## ECDSA
- **Standard:** NetX Duo Crypto implements ECDSA according to FIPS PUB 186-4: "*Digital Signature Standard (DSS)*", which can be found at: [https://nvlpubs.nist.gov/nistpubs/fips/nist.fips.186-4.pdf](https://nvlpubs.nist.gov/nistpubs/fips/nist.fips.186-4.pdf)
- **Memory Requirement:** The application must provide an ECDSA control block structure for maintaining state between operations.
## ECDH
> [!IMPORTANT]
> In Eclipse ThreadX, ECDH routines should only be used for ECDHE cryptography as ECDH with a static private key requires input point validation to be secure.
- **Standard:** NetX Duo Crypto implements ECDH according to FIPS PUB 800-56Ar2: "Recommendation for Pair-Wise Key Establishment Schemes Using Discrete Logarithm Cryptography", which can be found at: [https://nvlpubs.nist.gov/nistpubs/specialpublications/nist.sp.800-56ar2.pdf](https://nvlpubs.nist.gov/nistpubs/specialpublications/nist.sp.800-56ar2.pdf)
- **Memory Requirement:** The application must provide an ECDH control block structure for maintaining state between operations.
## DRBG
- **Standard:** NetX Duo Crypto implements DRBG according to FIPS PUB 800-90Ar1: "Recommendation for Random Number Generation Using Deterministic Random Bit Generators", which can be found at: [https://nvlpubs.nist.gov/nistpubs/SpecialPublications/NIST.SP.800-90Ar1.pdf](https://nvlpubs.nist.gov/nistpubs/SpecialPublications/NIST.SP.800-90Ar1.pdf)
- **Memory Requirement:** The application must provide an DRBG control block structure for maintaining state between operations.
## FIPS-Compliant
NetX Duo Crypto FIPS 140-2

1632
rtos-docs/netx-duo/netx-duo-crypto/chapter4.md Normal file
View File

File diff suppressed because it is too large Load Diff

0
rtos-docs/netx-duo/netx-duo-dhcp-client/appendixA.md → rtos-docs/netx-duo/netx-duo-dhcp-client/appendix-a.md
View File

4
rtos-docs/netx-duo/netx-duo-dhcp-client/chapter1.md
View File

@@ -1,10 +1,6 @@
---
title: Chapter 1 - Introduction to the NetX Duo DHCP Client
<<<<<<< HEAD
description: In NetX Duo DHCP Client, the application's IP address is one of the supplied parameters to the *nx_ip_create* service call.
=======
description: In NetX Duo DHCP Client, the application’s IP address is one of the supplied parameters to the nx_ip_create service call.
>>>>>>> cbb4d6e18ee28d86c6b8480f0804ded7e385d395
---
# Chapter 1 - Introduction to the NetX Duo DHCP Client

4
rtos-docs/netx-duo/netx-duo-dhcp-server/chapter1.md
View File

@@ -1,10 +1,6 @@
---
title: Chapter 1 - Introduction to NetX Duo DHCP Server
<<<<<<< HEAD
description: In NetX Duo, the application's IP address is one of the supplied parameters to the *nx_ip_create* service call.
=======
description: In NetX Duo, the application’s IP address is one of the supplied parameters to the nx_ip_create service call.
>>>>>>> cbb4d6e18ee28d86c6b8480f0804ded7e385d395
---
# Chapter 1 - Introduction to NetX Duo DHCP server