liboqs/docs/algorithms/kem/classic_mceliece.md
Jason Goertzen 769412623c
Adding multiple upstream support to doc generation (#1123)
* Fix an issue where run_tests tried to run tests from upstream. Fix by @DStebila

* No longer checking spdx on files copied from upstream

* Added compiler checking for gcc. Must be at least 9.4.0.

* Added pqclean's aarch64 optimized kyber implementation to liboqs

* stripping asimd flag for ARM64_V8 as it isn't needed and will cause errors when trying to specify it during compilation

* Updated kyber docs

* Updated kyber markdown so that no-secret-dependent-branching-checked-by-valgrind correctly says false for the new aarch64 implementation

* Added automated updating of legacy yaml format, and added some yaml files which don't get automatically updated

* Fixed a bug where optimized upstreams would use the primary upstream's supported platform

* Fixed a bug with copy_from_upstream.py's verify function where it would always use the default upstream location when comparing with diff

* Added reporting for implementations that are in upstream but aren't yet integrated into liboqs

* Added support to ignore implementations from upstream in copy_from_upstream.yml. This is to prevent implementations that haven't been integrated into LIBOQS yet from being pulled in by copy_from_upstream.py. It also silences the warning when verifying.

* Adding updated ymls and md files for docs

* copy_from_upstream.py now also calls update_docs_from_yaml.py
2021-11-18 06:56:19 +01:00

15 KiB

Classic McEliece

  • Algorithm type: Key encapsulation mechanism.
  • Main cryptographic assumption: Niederreiter's dual version of McEliece's public key encryption using binary Goppa codes.
  • Principal submitters: Daniel J. Bernstein, Tung Chou, Tanja Lange, Ingo von Maurich, Rafael Misoczki, Ruben Niederhagen, Edoardo Persichetti, Christiane Peters, Peter Schwabe, Nicolas Sendrier, Jakub Szefer, Wen Wang.
  • Authors' website: https://classic.mceliece.org
  • Specification version: SUPERCOP-20191221.
  • Primary Source:
    • Source: 7eb978b4a7
    • Implementation license (SPDX-Identifier): Public domain , which takes it from:
    • SUPERCOP-20191221 "vec" and "avx" implementations

Parameter set summary

Parameter set Security model Claimed NIST Level Public key size (bytes) Secret key size (bytes) Ciphertext size (bytes) Shared secret size (bytes)
Classic-McEliece-348864 IND-CCA2 1 261120 6452 128 32
Classic-McEliece-348864f IND-CCA2 1 261120 6452 128 32
Classic-McEliece-460896 IND-CCA2 3 524160 13568 188 32
Classic-McEliece-460896f IND-CCA2 3 524160 13568 188 32
Classic-McEliece-6688128 IND-CCA2 5 1044992 13892 240 32
Classic-McEliece-6688128f IND-CCA2 5 1044992 13892 240 32
Classic-McEliece-6960119 IND-CCA2 5 1047319 13908 226 32
Classic-McEliece-6960119f IND-CCA2 5 1047319 13908 226 32
Classic-McEliece-8192128 IND-CCA2 5 1357824 14080 240 32
Classic-McEliece-8192128f IND-CCA2 5 1357824 14080 240 32

Classic-McEliece-348864 implementation characteristics

Implementation source Identifier in upstream Supported architecture(s) Supported operating system(s) CPU extension(s) used No branching-on-secrets claimed? No branching-on-secrets checked by valgrind? Large stack usage?‡
Primary Source vec All All None True True True
Primary Source avx x86_64 Linux,Darwin AVX2,POPCNT False True True

Are implementations chosen based on runtime CPU feature detection? Yes.

‡For an explanation of what this denotes, consult the Explanation of Terms section at the end of this file.

Classic-McEliece-348864f implementation characteristics

Implementation source Identifier in upstream Supported architecture(s) Supported operating system(s) CPU extension(s) used No branching-on-secrets claimed? No branching-on-secrets checked by valgrind? Large stack usage?
Primary Source vec All All None True True True
Primary Source avx x86_64 Linux,Darwin AVX2,POPCNT,BMI1 False True True

Are implementations chosen based on runtime CPU feature detection? Yes.

Classic-McEliece-460896 implementation characteristics

Implementation source Identifier in upstream Supported architecture(s) Supported operating system(s) CPU extension(s) used No branching-on-secrets claimed? No branching-on-secrets checked by valgrind? Large stack usage?
Primary Source vec All All None True True True
Primary Source avx x86_64 Linux,Darwin AVX2,POPCNT False True True

Are implementations chosen based on runtime CPU feature detection? Yes.

Classic-McEliece-460896f implementation characteristics

Implementation source Identifier in upstream Supported architecture(s) Supported operating system(s) CPU extension(s) used No branching-on-secrets claimed? No branching-on-secrets checked by valgrind? Large stack usage?
Primary Source vec All All None True True True
Primary Source avx x86_64 Linux,Darwin AVX2,BMI1,POPCNT False True True

Are implementations chosen based on runtime CPU feature detection? Yes.

Classic-McEliece-6688128 implementation characteristics

Implementation source Identifier in upstream Supported architecture(s) Supported operating system(s) CPU extension(s) used No branching-on-secrets claimed? No branching-on-secrets checked by valgrind? Large stack usage?
Primary Source vec All All None True True True
Primary Source avx x86_64 Linux,Darwin AVX2,POPCNT False True True

Are implementations chosen based on runtime CPU feature detection? Yes.

Classic-McEliece-6688128f implementation characteristics

Implementation source Identifier in upstream Supported architecture(s) Supported operating system(s) CPU extension(s) used No branching-on-secrets claimed? No branching-on-secrets checked by valgrind? Large stack usage?
Primary Source vec All All None True True True
Primary Source avx x86_64 Linux,Darwin AVX2,BMI1,POPCNT False True True

Are implementations chosen based on runtime CPU feature detection? Yes.

Classic-McEliece-6960119 implementation characteristics

Implementation source Identifier in upstream Supported architecture(s) Supported operating system(s) CPU extension(s) used No branching-on-secrets claimed? No branching-on-secrets checked by valgrind? Large stack usage?
Primary Source vec All All None True True True
Primary Source avx x86_64 Linux,Darwin AVX2,POPCNT False True True

Are implementations chosen based on runtime CPU feature detection? Yes.

Classic-McEliece-6960119f implementation characteristics

Implementation source Identifier in upstream Supported architecture(s) Supported operating system(s) CPU extension(s) used No branching-on-secrets claimed? No branching-on-secrets checked by valgrind? Large stack usage?
Primary Source vec All All None True True True
Primary Source avx x86_64 Linux,Darwin AVX2,BMI1,POPCNT False True True

Are implementations chosen based on runtime CPU feature detection? Yes.

Classic-McEliece-8192128 implementation characteristics

Implementation source Identifier in upstream Supported architecture(s) Supported operating system(s) CPU extension(s) used No branching-on-secrets claimed? No branching-on-secrets checked by valgrind? Large stack usage?
Primary Source vec All All None True True True
Primary Source avx x86_64 Linux,Darwin AVX2,POPCNT False True True

Are implementations chosen based on runtime CPU feature detection? Yes.

Classic-McEliece-8192128f implementation characteristics

Implementation source Identifier in upstream Supported architecture(s) Supported operating system(s) CPU extension(s) used No branching-on-secrets claimed? No branching-on-secrets checked by valgrind? Large stack usage?
Primary Source vec All All None True True True
Primary Source avx x86_64 Linux,Darwin AVX2,POPCNT,BMI1 False True True

Are implementations chosen based on runtime CPU feature detection? Yes.

Explanation of Terms

  • Large Stack Usage: Implementations identified as having such may cause failures when running in threads or in constrained environments.