liboqs/scripts/copy_from_upstream/copy_from_upstream.yml
Basil Hess fc35e09a14
Update copy_from_pqclean / copy_from_upstream (#883)
* Update copy_from_pqclean / copy_from_upstream (#880)

* Renames copy_from_pqclean to copy_from_upstream.

* Adds 'upstreams' field to copy_from_upstream.yml, allowing to specify upstream repositories, branches and commits.

* Modifies "copy" command in copy_from_upstream: sources are pulled from specified git-repositories. Implementation folders in $LIBOQS_DIR/src will be prefixed with the upstream-name.

* Adds "verify" command in copy_from_upstream: Implementations in $LIBOQS_DIR/src are compared with expected upstream versions.

* Prepares for copying pqclean, pqcrystals-kyber and pqcrystals-dilithium from upstream.

* Updates copy_from_upstream to process common dependencies from an upstream.

* Adds reminder text to manually update algorithm docs .md files after copying
2021-02-03 18:43:02 +01:00

492 lines
17 KiB
YAML

upstreams:
-
name: pqclean
git_url: https://github.com/PQClean/PQClean.git
git_branch: master
git_commit: 3d7d2024fa892bd7f00dca3fff4122175f4a26dc
kem_meta_path: 'crypto_kem/{pqclean_scheme}/META.yml'
sig_meta_path: 'crypto_sign/{pqclean_scheme}/META.yml'
kem_scheme_path: 'crypto_kem/{pqclean_scheme}'
sig_scheme_path: 'crypto_sign/{pqclean_scheme}'
-
name: pqcrystals-kyber
git_url: https://github.com/bhess/kyber.git
git_branch: feat.commons
git_commit: e0912718a12731467cb7f79c57972af1c2469dad
kem_meta_path: '{pretty_name_full}_META.yml'
common_meta_path: 'Common_META.yml'
kem_scheme_path: '.'
-
name: pqcrystals-dilithium
git_url: https://github.com/bhess/dilithium.git
git_branch: feat.commons
git_commit: efe7ccccf71763560ce7075266bf7400764ffed2
sig_meta_path: '{pretty_name_full}_META.yml'
common_meta_path: 'Common_META.yml'
sig_scheme_path: '.'
kems:
-
name: classic_mceliece
default_implementation: vec
upstream_location: pqclean
schemes:
-
scheme: "348864"
pqclean_scheme: mceliece348864
pretty_name_full: Classic-McEliece-348864
implementation: vec
sources: ['aes256ctr.c', 'benes.c', 'bm.c', 'controlbits.c', 'decrypt.c', 'encrypt.c', 'fft.c', 'fft_tr.c', 'gf.c', 'operations.c', 'pk_gen.c', 'sk_gen.c', 'transpose.c', 'util.c', 'vec.c']
-
scheme: "348864f"
pqclean_scheme: mceliece348864f
pretty_name_full: Classic-McEliece-348864f
implementation: vec
sources: ['aes256ctr.c', 'benes.c', 'bm.c', 'controlbits.c', 'decrypt.c', 'encrypt.c', 'fft.c', 'fft_tr.c', 'gf.c', 'operations.c', 'pk_gen.c', 'sk_gen.c', 'transpose.c', 'util.c', 'vec.c']
-
scheme: "460896"
pqclean_scheme: mceliece460896
pretty_name_full: Classic-McEliece-460896
implementation: vec
sources: ['aes256ctr.c', 'benes.c', 'bm.c', 'controlbits.c', 'decrypt.c', 'encrypt.c', 'fft.c', 'fft_tr.c', 'gf.c', 'operations.c', 'pk_gen.c', 'sk_gen.c', 'transpose.c', 'util.c', 'vec.c']
-
scheme: "460896f"
pqclean_scheme: mceliece460896f
pretty_name_full: Classic-McEliece-460896f
implementation: vec
sources: ['aes256ctr.c', 'benes.c', 'bm.c', 'controlbits.c', 'decrypt.c', 'encrypt.c', 'fft.c', 'fft_tr.c', 'gf.c', 'operations.c', 'pk_gen.c', 'sk_gen.c', 'transpose.c', 'util.c', 'vec.c']
-
scheme: "6688128"
pqclean_scheme: mceliece6688128
pretty_name_full: Classic-McEliece-6688128
implementation: vec
sources: ['aes256ctr.c', 'benes.c', 'bm.c', 'controlbits.c', 'decrypt.c', 'encrypt.c', 'fft.c', 'fft_tr.c', 'gf.c', 'operations.c', 'pk_gen.c', 'sk_gen.c', 'transpose.c', 'util.c', 'vec.c']
-
scheme: "6688128f"
pqclean_scheme: mceliece6688128f
pretty_name_full: Classic-McEliece-6688128f
implementation: vec
sources: ['aes256ctr.c', 'benes.c', 'bm.c', 'controlbits.c', 'decrypt.c', 'encrypt.c', 'fft.c', 'fft_tr.c', 'gf.c', 'operations.c', 'pk_gen.c', 'sk_gen.c', 'transpose.c', 'util.c', 'vec.c']
-
scheme: "6960119"
pqclean_scheme: mceliece6960119
pretty_name_full: Classic-McEliece-6960119
implementation: vec
sources: ['aes256ctr.c', 'benes.c', 'bm.c', 'controlbits.c', 'decrypt.c', 'encrypt.c', 'fft.c', 'fft_tr.c', 'gf.c', 'operations.c', 'pk_gen.c', 'sk_gen.c', 'transpose.c', 'util.c', 'vec.c']
-
scheme: "6960119f"
pqclean_scheme: mceliece6960119f
pretty_name_full: Classic-McEliece-6960119f
implementation: vec
sources: ['aes256ctr.c', 'benes.c', 'bm.c', 'controlbits.c', 'decrypt.c', 'encrypt.c', 'fft.c', 'fft_tr.c', 'gf.c', 'operations.c', 'pk_gen.c', 'sk_gen.c', 'transpose.c', 'util.c', 'vec.c']
-
scheme: "8192128"
pqclean_scheme: mceliece8192128
pretty_name_full: Classic-McEliece-8192128
implementation: vec
sources: ['aes256ctr.c', 'benes.c', 'bm.c', 'controlbits.c', 'decrypt.c', 'encrypt.c', 'fft.c', 'fft_tr.c', 'gf.c', 'operations.c', 'pk_gen.c', 'sk_gen.c', 'transpose.c', 'util.c', 'vec.c']
-
scheme: "8192128f"
pqclean_scheme: mceliece8192128f
pretty_name_full: Classic-McEliece-8192128f
implementation: vec
sources: ['aes256ctr.c', 'benes.c', 'bm.c', 'controlbits.c', 'decrypt.c', 'encrypt.c', 'fft.c', 'fft_tr.c', 'gf.c', 'operations.c', 'pk_gen.c', 'sk_gen.c', 'transpose.c', 'util.c', 'vec.c']
-
name: hqc
default_implementation: clean
upstream_location: pqclean
schemes:
-
scheme: "128"
pqclean_scheme: hqc-rmrs-128
pretty_name_full: HQC-128
-
scheme: "192"
pqclean_scheme: hqc-rmrs-192
pretty_name_full: HQC-192
-
scheme: "256"
pqclean_scheme: hqc-rmrs-256
pretty_name_full: HQC-256
-
name: kyber
default_implementation: ref
upstream_location: pqcrystals-kyber
schemes:
-
scheme: "512"
pqclean_scheme: kyber512
pretty_name_full: Kyber512
-
scheme: "768"
pqclean_scheme: kyber768
pretty_name_full: Kyber768
-
scheme: "1024"
pqclean_scheme: kyber1024
pretty_name_full: Kyber1024
-
scheme: "512_90s"
pqclean_scheme: kyber512-90s
pretty_name_full: Kyber512-90s
-
scheme: "768_90s"
pqclean_scheme: kyber768-90s
pretty_name_full: Kyber768-90s
-
scheme: "1024_90s"
pqclean_scheme: kyber1024-90s
pretty_name_full: Kyber1024-90s
-
name: ntru
default_implementation: clean
upstream_location: pqclean
schemes:
-
scheme: hps2048509
pqclean_scheme: ntruhps2048509
pretty_name_full: NTRU-HPS-2048-509
-
scheme: hps2048677
pqclean_scheme: ntruhps2048677
pretty_name_full: NTRU-HPS-2048-677
-
scheme: hps4096821
pqclean_scheme: ntruhps4096821
pretty_name_full: NTRU-HPS-4096-821
-
scheme: hrss701
pqclean_scheme: ntruhrss701
pretty_name_full: NTRU-HRSS-701
-
name: ntruprime
default_implementation: clean
upstream_location: pqclean
schemes:
-
scheme: ntrulpr653
pqclean_scheme: ntrulpr653
pretty_name_full: ntrulpr653
-
scheme: ntrulpr761
pqclean_scheme: ntrulpr761
pretty_name_full: ntrulpr761
-
scheme: ntrulpr857
pqclean_scheme: ntrulpr857
pretty_name_full: ntrulpr857
-
scheme: sntrup653
pqclean_scheme: sntrup653
pretty_name_full: sntrup653
-
scheme: sntrup761
pqclean_scheme: sntrup761
pretty_name_full: sntrup761
-
scheme: sntrup857
pqclean_scheme: sntrup857
pretty_name_full: sntrup857
-
name: saber
default_implementation: clean
upstream_location: pqclean
schemes:
-
scheme: lightsaber
pqclean_scheme: lightsaber
pretty_name_full: LightSaber-KEM
-
scheme: saber
pqclean_scheme: saber
pretty_name_full: Saber-KEM
-
scheme: firesaber
pqclean_scheme: firesaber
pretty_name_full: FireSaber-KEM
sigs:
-
name: dilithium
default_implementation: ref
upstream_location: pqcrystals-dilithium
schemes:
-
scheme: "2"
pqclean_scheme: dilithium2
pretty_name_full: Dilithium2
signed_msg_order: sig_then_msg
-
scheme: "3"
pqclean_scheme: dilithium3
pretty_name_full: Dilithium3
signed_msg_order: sig_then_msg
-
scheme: "5"
pqclean_scheme: dilithium_5
pretty_name_full: Dilithium5
signed_msg_order: sig_then_msg
-
scheme: "2_aes"
pqclean_scheme: dilithium2-aes
pretty_name_full: Dilithium2-AES
signed_msg_order: sig_then_msg
-
scheme: "3_aes"
pqclean_scheme: dilithium3-aes
pretty_name_full: Dilithium3-AES
signed_msg_order: sig_then_msg
-
scheme: "5_aes"
pqclean_scheme: dilithium_5-aes
pretty_name_full: Dilithium5-AES
signed_msg_order: sig_then_msg
-
name: falcon
default_implementation: clean
upstream_location: pqclean
schemes:
-
scheme: "512"
pqclean_scheme: falcon-512
pretty_name_full: Falcon-512
signed_msg_order: falcon
-
scheme: "1024"
pqclean_scheme: falcon-1024
pretty_name_full: Falcon-1024
signed_msg_order: falcon
-
name: rainbow
default_implementation: clean
upstream_location: pqclean
schemes:
-
scheme: "I_classic"
pqclean_scheme: rainbowI-classic
pretty_name_full: Rainbow-I-Classic
signed_msg_order: msg_then_sig
-
scheme: "I_circumzenithal"
pqclean_scheme: rainbowI-circumzenithal
pretty_name_full: Rainbow-I-Circumzenithal
signed_msg_order: msg_then_sig
-
scheme: "I_compressed"
pqclean_scheme: rainbowI-compressed
pretty_name_full: Rainbow-I-Compressed
signed_msg_order: msg_then_sig
-
scheme: "III_classic"
pqclean_scheme: rainbowIII-classic
pretty_name_full: Rainbow-III-Classic
signed_msg_order: msg_then_sig
-
scheme: "III_circumzenithal"
pqclean_scheme: rainbowIII-circumzenithal
pretty_name_full: Rainbow-III-Circumzenithal
signed_msg_order: msg_then_sig
-
scheme: "III_compressed"
pqclean_scheme: rainbowIII-compressed
pretty_name_full: Rainbow-III-Compressed
signed_msg_order: msg_then_sig
-
scheme: "V_classic"
pqclean_scheme: rainbowV-classic
pretty_name_full: Rainbow-V-Classic
signed_msg_order: msg_then_sig
-
scheme: "V_circumzenithal"
pqclean_scheme: rainbowV-circumzenithal
pretty_name_full: Rainbow-V-Circumzenithal
signed_msg_order: msg_then_sig
-
scheme: "V_compressed"
pqclean_scheme: rainbowV-compressed
pretty_name_full: Rainbow-V-Compressed
signed_msg_order: msg_then_sig
-
name: sphincs
default_implementation: clean
upstream_location: pqclean
schemes:
-
scheme: haraka_128f_robust
pqclean_scheme: sphincs-haraka-128f-robust
pretty_name_full: SPHINCS+-Haraka-128f-robust
signed_msg_order: sig_then_msg
-
scheme: haraka_128f_simple
pqclean_scheme: sphincs-haraka-128f-simple
pretty_name_full: SPHINCS+-Haraka-128f-simple
signed_msg_order: sig_then_msg
-
scheme: haraka_128s_robust
pqclean_scheme: sphincs-haraka-128s-robust
pretty_name_full: SPHINCS+-Haraka-128s-robust
signed_msg_order: sig_then_msg
-
scheme: haraka_128s_simple
pqclean_scheme: sphincs-haraka-128s-simple
pretty_name_full: SPHINCS+-Haraka-128s-simple
signed_msg_order: sig_then_msg
-
scheme: haraka_192f_robust
pqclean_scheme: sphincs-haraka-192f-robust
pretty_name_full: SPHINCS+-Haraka-192f-robust
signed_msg_order: sig_then_msg
-
scheme: haraka_192f_simple
pqclean_scheme: sphincs-haraka-192f-simple
pretty_name_full: SPHINCS+-Haraka-192f-simple
signed_msg_order: sig_then_msg
-
scheme: haraka_192s_robust
pqclean_scheme: sphincs-haraka-192s-robust
pretty_name_full: SPHINCS+-Haraka-192s-robust
signed_msg_order: sig_then_msg
-
scheme: haraka_192s_simple
pqclean_scheme: sphincs-haraka-192s-simple
pretty_name_full: SPHINCS+-Haraka-192s-simple
signed_msg_order: sig_then_msg
-
scheme: haraka_256f_robust
pqclean_scheme: sphincs-haraka-256f-robust
pretty_name_full: SPHINCS+-Haraka-256f-robust
signed_msg_order: sig_then_msg
-
scheme: haraka_256f_simple
pqclean_scheme: sphincs-haraka-256f-simple
pretty_name_full: SPHINCS+-Haraka-256f-simple
signed_msg_order: sig_then_msg
-
scheme: haraka_256s_robust
pqclean_scheme: sphincs-haraka-256s-robust
pretty_name_full: SPHINCS+-Haraka-256s-robust
signed_msg_order: sig_then_msg
-
scheme: haraka_256s_simple
pqclean_scheme: sphincs-haraka-256s-simple
pretty_name_full: SPHINCS+-Haraka-256s-simple
signed_msg_order: sig_then_msg
-
scheme: sha256_128f_robust
pqclean_scheme: sphincs-sha256-128f-robust
pretty_name_full: SPHINCS+-SHA256-128f-robust
signed_msg_order: sig_then_msg
-
scheme: sha256_128f_simple
pqclean_scheme: sphincs-sha256-128f-simple
pretty_name_full: SPHINCS+-SHA256-128f-simple
signed_msg_order: sig_then_msg
-
scheme: sha256_128s_robust
pqclean_scheme: sphincs-sha256-128s-robust
pretty_name_full: SPHINCS+-SHA256-128s-robust
signed_msg_order: sig_then_msg
-
scheme: sha256_128s_simple
pqclean_scheme: sphincs-sha256-128s-simple
pretty_name_full: SPHINCS+-SHA256-128s-simple
signed_msg_order: sig_then_msg
-
scheme: sha256_192f_robust
pqclean_scheme: sphincs-sha256-192f-robust
pretty_name_full: SPHINCS+-SHA256-192f-robust
signed_msg_order: sig_then_msg
-
scheme: sha256_192f_simple
pqclean_scheme: sphincs-sha256-192f-simple
pretty_name_full: SPHINCS+-SHA256-192f-simple
signed_msg_order: sig_then_msg
-
scheme: sha256_192s_robust
pqclean_scheme: sphincs-sha256-192s-robust
pretty_name_full: SPHINCS+-SHA256-192s-robust
signed_msg_order: sig_then_msg
-
scheme: sha256_192s_simple
pqclean_scheme: sphincs-sha256-192s-simple
pretty_name_full: SPHINCS+-SHA256-192s-simple
signed_msg_order: sig_then_msg
-
scheme: sha256_256f_robust
pqclean_scheme: sphincs-sha256-256f-robust
pretty_name_full: SPHINCS+-SHA256-256f-robust
signed_msg_order: sig_then_msg
-
scheme: sha256_256f_simple
pqclean_scheme: sphincs-sha256-256f-simple
pretty_name_full: SPHINCS+-SHA256-256f-simple
signed_msg_order: sig_then_msg
-
scheme: sha256_256s_robust
pqclean_scheme: sphincs-sha256-256s-robust
pretty_name_full: SPHINCS+-SHA256-256s-robust
signed_msg_order: sig_then_msg
-
scheme: sha256_256s_simple
pqclean_scheme: sphincs-sha256-256s-simple
pretty_name_full: SPHINCS+-SHA256-256s-simple
signed_msg_order: sig_then_msg
-
scheme: shake256_128f_robust
pqclean_scheme: sphincs-shake256-128f-robust
pretty_name_full: SPHINCS+-SHAKE256-128f-robust
signed_msg_order: sig_then_msg
-
scheme: shake256_128f_simple
pqclean_scheme: sphincs-shake256-128f-simple
pretty_name_full: SPHINCS+-SHAKE256-128f-simple
signed_msg_order: sig_then_msg
-
scheme: shake256_128s_robust
pqclean_scheme: sphincs-shake256-128s-robust
pretty_name_full: SPHINCS+-SHAKE256-128s-robust
signed_msg_order: sig_then_msg
-
scheme: shake256_128s_simple
pqclean_scheme: sphincs-shake256-128s-simple
pretty_name_full: SPHINCS+-SHAKE256-128s-simple
signed_msg_order: sig_then_msg
-
scheme: shake256_192f_robust
pqclean_scheme: sphincs-shake256-192f-robust
pretty_name_full: SPHINCS+-SHAKE256-192f-robust
signed_msg_order: sig_then_msg
-
scheme: shake256_192f_simple
pqclean_scheme: sphincs-shake256-192f-simple
pretty_name_full: SPHINCS+-SHAKE256-192f-simple
signed_msg_order: sig_then_msg
-
scheme: shake256_192s_robust
pqclean_scheme: sphincs-shake256-192s-robust
pretty_name_full: SPHINCS+-SHAKE256-192s-robust
signed_msg_order: sig_then_msg
-
scheme: shake256_192s_simple
pqclean_scheme: sphincs-shake256-192s-simple
pretty_name_full: SPHINCS+-SHAKE256-192s-simple
signed_msg_order: sig_then_msg
-
scheme: shake256_256f_robust
pqclean_scheme: sphincs-shake256-256f-robust
pretty_name_full: SPHINCS+-SHAKE256-256f-robust
signed_msg_order: sig_then_msg
-
scheme: shake256_256f_simple
pqclean_scheme: sphincs-shake256-256f-simple
pretty_name_full: SPHINCS+-SHAKE256-256f-simple
signed_msg_order: sig_then_msg
-
scheme: shake256_256s_robust
pqclean_scheme: sphincs-shake256-256s-robust
pretty_name_full: SPHINCS+-SHAKE256-256s-robust
signed_msg_order: sig_then_msg
-
scheme: shake256_256s_simple
pqclean_scheme: sphincs-shake256-256s-simple
pretty_name_full: SPHINCS+-SHAKE256-256s-simple
signed_msg_order: sig_then_msg