ydb/contrib/restricted/aws/s2n/pq-crypto

Post-quantum cryptography for s2n

This directory contains code for new post-quantum key exchange mechanisms. There are no known computationally feasible attacks (classical or quantum) against these algorithms when used with the recommended key lengths.

Quantum computers

Quantum computers use the properties of quantum mechanics to evaluate quantum algorithms. These algorithms can solve some classically hard (exponential time) problems quickly (polynomial time). Shor's algorithm is one such algorithm which can factor large integers, thus breaking RSA encryption and digital signature, and another quantum algorithm can solve the discrete logarithm problem over arbitrary groups thus breaking Diffie–Hellman and elliptic curve Diffie–Hellman key exchange.

Post-quantum cryptography

Post-quantum public-key cryptographic algorithms run on a classical computer and are conjectured secure against both classical and quantum attacks. NIST is in the process of reviewing submissions and standardizing them, see more info on the NIST website. Until the review and standardization is complete the post-quantum key exchanges in s2n must not be used for key establishment by themselves. Instead they should only be used as part of a hybrid key exchange, which combines a post-quantum key exchange scheme and a classical key exchange scheme.

Hybrid key exchange

A hybrid key exchange combines both the high assurance of classical key exchange with the conjectured quantum-resistance of newly proposed key exchanges. For hybrid TLS 1.2, s2n implements the hybrid specification from this RFC. See this s2n issue for more up-to-date information. For hybrid TLS 1.3, s2n implements the hybrid specification from this draft RFC. See also this doc that defines hybrid group values for interoperability.

How to disable optimized assembly code for PQ Crypto

Certain post-quantum KEM algorithms included in s2n use optimized assembly code for efficient computation. When compiling s2n on compatible toolchains, the optimized assembly code will significantly improve performance of the post-quantum cryptographic operations. s2n attempts to detect whether or not the architecture is compatible with the assembly code, and falls back to the portable C implementation if it detects incompatibility. However, some users may wish to manually force s2n to use the portable C implementation. To do so, simply export S2N_NO_PQ_ASM=1 as an environment variable before compiling.

How to disable all PQ Crypto

Users may have need to compile s2n without any PQ crypto support whatsoever. To so do, export S2N_NO_PQ=1 as an environment variable before compiling.

How to add a new PQ KEM family for use in hybrid TLS 1.2

1. Add the code to pq-crypto/KEM_NAME/
   1. Update pq-crypto/Makefile to build that directory
   2. Update lib/Makefile to also include that directory
   3. Update the KEM code to include pq-crypto/s2n_pq_random.h and use the function s2n_get_random_bytes for any random data the KEM needs
   4. Create a pq-crypto/KEM_NAME/KEM_NAME.h with the size of objects and method definitions
2. Define the new cipher suite value and KEM extension value in tls/s2n_tls_parameters.h
3. Create the KEM_NAME s2n_kem struct in tls/s2n_kem.c
   1. Create the supported_KEM_NAME_params array in tls/s2n_kem.c
   2. Add the new kem to the kem_mapping with the correct cipher suite value
4. Add known answer tests using s2n_test_kem_with_kat() in tests/unit/s2n_KEM_NAME_kat_test.c
5. Add fuzz testing in tests/fuzz/s2n_KEM_NAME_fuzz_test.c
6. Add formal verification in tests/saw/KEM_NAME/verify.saw
7. Create a new s2n_cipher_suite in tls/s2n_cipher_suites.c
8. Create a new s2n_cipher_preferences in tls/s2n_cipher_preferences.c that uses the new cipher suite
   1. Once this change is made, the KEM will be available for use in TLS handshakes; ensure that all testing/verification has been completed

How to add a new variant to an existing PQ KEM family for use in hybrid TLS 1.2

1. Add the code to pq-crypto/KEM_NAME/
   1. Update pq-crypto/Makefile to build that directory
   2. Update lib/Makefile to also include that directory
   3. Update the KEM code to include pq-crypto/s2n_pq_random.h and use the function s2n_get_random_bytes for any random data the KEM needs
   4. Create a pq-crypto/KEM_NAME/KEM_NAME.h with the size of objects and method definitions
2. Define the KEM extension value in tls/s2n_tls_parameters.h
3. Create the KEM_NAME s2n_kem struct in tls/s2n_kem.c
4. Add known answer tests using s2n_test_kem_with_kat() in tests/unit/s2n_KEM_NAME_kat_test.c
5. Add fuzz testing in tests/fuzz/s2n_KEM_NAME_fuzz_test.c
6. Add formal verification in tests/saw/KEM_NAME/verify.saw
7. Update the appropriate supported_KEM_NAME_params array in tls/s2n_kem.c
   1. Once this change is made, the KEM extension will be available for use in TLS handshakes; ensure that all testing/verification has been completed

How to use PQ cipher suites for hybrid TLS 1.2

1. Checkout s2n git clone https://github.com/awslabs/s2n.git
2. Following the docs/USAGE-GUIDE.md build s2n

3. Use the sample server and client in the bin directory:

   # Terminal 1
   # Use the s2nd CLI tool to start a TLS daemon with the KMS-PQ-TLS-1-0-2019-06 cipher preferences listening on port 8888
   export PATH_TO_S2N=/path/to/s2n
   export LD_LIBRARY_PATH=${PATH_TO_S2N}/test-deps/openssl-1.1.1/lib:${PATH_TO_S2N}/test-deps/openssl-1.1.1/lib:${PATH_TO_S2N}/lib:${PATH_TO_S2N}/bin
   export PATH=${PATH_TO_S2N}/bin:$PATH
   s2nd --cert ${PATH_TO_S2N}/tests/pems/rsa_2048_sha256_wildcard_cert.pem --key ${PATH_TO_S2N}/tests/pems/rsa_2048_sha256_wildcard_key.pem --negotiate --ciphers KMS-PQ-TLS-1-0-2019-06 0.0.0.0 8888
   
   # Terminal 2
   # Use the s2nc TLS CLI client to connect to the TLS server daemon started in Terminal 1 on port 8888
   export PATH_TO_S2N=/path/to/s2n
   export LD_LIBRARY_PATH=${PATH_TO_S2N}/test-deps/openssl-1.1.1/lib:${PATH_TO_S2N}/test-deps/openssl-1.1.1/lib:${PATH_TO_S2N}/lib:${PATH_TO_S2N}/bin
   export PATH=${PATH_TO_S2N}/bin:$PATH
   s2nc -i --ciphers KMS-PQ-TLS-1-0-2019-06 0.0.0.0 8888