Run

Module for the “test wrapper” command.

enum crypto_condor.cli.run.AesStrKeyLength(value)

Bases: StrEnum

Workaround for using IntEnum with Typer.

Typer/Click don’t handle ints as choices from an enum, so mimic the real enum with str values and convert back when calling the function.

Member Type:

str

Valid values are as follows:

ALL = <AesStrKeyLength.ALL: '0'>
AES128 = <AesStrKeyLength.AES128: '128'>
AES192 = <AesStrKeyLength.AES192: '192'>
AES256 = <AesStrKeyLength.AES256: '256'>
crypto_condor.cli.run.aes(wrapper, mode, key_length=AesStrKeyLength.ALL, iv_length=0, compliance=True, resilience=False, encrypt=True, decrypt=True, filename='', no_save=False)

Runs an AES wrapper.

Parameters:

  • wrapper (Annotated[str, <typer.models.ArgumentInfo object at 0x7fac524ebc90>]) – The wrapper to test.

  • mode (Annotated[Mode, <typer.models.ArgumentInfo object at 0x7fac5306ad50>]) – The mode of operation.

  • key_length (Annotated[AesStrKeyLength, <typer.models.ArgumentInfo object at 0x7fac524ebd50>]) – The length of the keys to use in bits.

  • iv_length (Annotated[int, <typer.models.OptionInfo object at 0x7fac524ebf10>]) – The length of the IV that can be tested.

  • compliance (Annotated[bool, <typer.models.OptionInfo object at 0x7fac5395f490>]) – Whether to use compliance test vectors.

  • resilience (Annotated[bool, <typer.models.OptionInfo object at 0x7fac524be750>]) – Whether to use resilience test vectors.

  • encrypt (Annotated[bool, <typer.models.OptionInfo object at 0x7fac534643d0>]) – Whether to test encryption.

  • decrypt (Annotated[bool, <typer.models.OptionInfo object at 0x7fac524eba10>]) – Whether to test decryption.

  • filename (Annotated[str, <typer.models.OptionInfo object at 0x7fac524ebb90>]) – Name of the file to save results.

  • no_save (Annotated[bool, <typer.models.OptionInfo object at 0x7fac524ebc10>]) – Do not save results or prompt the user.

Notes

  • no_encrypt and no_decrypt should not be True at the same time.

  • no_compliance and no_resilience should not be True at the same time.

crypto_condor.cli.run.ecdsa(language, curve, hash_function, key_encoding=None, pubkey_encoding=None, pre_hashed=False, compliance=True, resilience=False, test_sign=True, test_verify=True, test_sign_then_verify=False, filename='', no_save=False)

Runs an ECDSA wrapper.

Parameters:

  • language (Annotated[Wrapper, <typer.models.ArgumentInfo object at 0x7fac531fa910>]) – The language of the wrapper.

  • curve (Annotated[Curve, <typer.models.ArgumentInfo object at 0x7fac524f8410>]) – The elliptic curve to use.

  • hash_function (Annotated[Hash, <typer.models.ArgumentInfo object at 0x7fac524f8510>]) – The hash function to use.

  • key_encoding (Annotated[KeyEncoding | None, <typer.models.OptionInfo object at 0x7fac524f87d0>]) – The encoding used for private keys.

  • pubkey_encoding (Annotated[PubKeyEncoding | None, <typer.models.OptionInfo object at 0x7fac524f89d0>]) – The encoding used for public keys.

  • pre_hashed (Annotated[bool, <typer.models.OptionInfo object at 0x7fac524f8a50>]) – Whether the messages given to the implementation must be hashed first.

  • compliance (Annotated[bool, <typer.models.OptionInfo object at 0x7fac5395f490>]) – Whether to use compliance test vectors.

  • resilience (Annotated[bool, <typer.models.OptionInfo object at 0x7fac524be750>]) – Whether to use resilience test vectors.

  • test_sign (Annotated[bool, <typer.models.OptionInfo object at 0x7fac524eb890>]) – Whether to test the signing function.

  • test_verify (Annotated[bool, <typer.models.OptionInfo object at 0x7fac524ebb50>]) – Whether to test the verifying function.

  • test_sign_then_verify (Annotated[bool, <typer.models.OptionInfo object at 0x7fac524f8b10>]) – Whether to test both functions by signing then verifying.

  • filename (Annotated[str, <typer.models.OptionInfo object at 0x7fac524ebb90>]) – Name of the file to save results.

  • no_save (Annotated[bool, <typer.models.OptionInfo object at 0x7fac524ebc10>]) – Do not save results or prompt the user.

Notes

  • compliance and resilience should not be False at the same time unless test_sign_then_verify is used.

  • test_sign, test_verify, and test_sign_then_verify should not be False at the same time.

crypto_condor.cli.run.kyber(language, parameter_set, encapsulate=True, decapsulate=True, filename='', no_save=False)

Runs a Kyber wrapper.

Parameters:

  • language (Annotated[Wrapper, <typer.models.ArgumentInfo object at 0x7fac531fa910>]) – The language of the wrapper to run.

  • parameter_set (Annotated[Paramset, <typer.models.ArgumentInfo object at 0x7fac524f8dd0>]) – The Kyber parameter set to use.

  • encapsulate (Annotated[bool, <typer.models.OptionInfo object at 0x7fac524f8ed0>]) – Whether to test the encapsulation function.

  • decapsulate (Annotated[bool, <typer.models.OptionInfo object at 0x7fac524f8fd0>]) – Whether to test the decapsulation function.

  • filename (Annotated[str, <typer.models.OptionInfo object at 0x7fac524ebb90>]) – Name of the file to save results.

  • no_save (Annotated[bool, <typer.models.OptionInfo object at 0x7fac524ebc10>]) – Do not save results or prompt the user.

crypto_condor.cli.run.dilithium(language, parameter_set, sign=True, verify=True, filename='', no_save=False)

Runs a Dilithium wrapper.

Parameters:

  • language (Annotated[Wrapper, <typer.models.ArgumentInfo object at 0x7fac531fa910>]) – The language of the wrapper to run.

  • parameter_set (Annotated[Paramset, <typer.models.ArgumentInfo object at 0x7fac524f9210>]) – The Dilithium parameter set to use.

  • sign (Annotated[bool, <typer.models.OptionInfo object at 0x7fac524eb890>]) – Whether to test the signing function.

  • verify (Annotated[bool, <typer.models.OptionInfo object at 0x7fac524ebb50>]) – Whether to test the verifying function.

  • filename (Annotated[str, <typer.models.OptionInfo object at 0x7fac524ebb90>]) – Name of the file to save results.

  • no_save (Annotated[bool, <typer.models.OptionInfo object at 0x7fac524ebc10>]) – Do not save results or prompt the user.

crypto_condor.cli.run.sha(wrapper, algorithm, orientation=Orientation.BYTE, filename='', no_save=False)

Runs a SHA wrapper.

Parameters:

  • wrapper (Annotated[str, <typer.models.ArgumentInfo object at 0x7fac524f9410>]) – The wrapper to test.

  • algorithm (Annotated[Algorithm, <typer.models.ArgumentInfo object at 0x7fac524f9490>]) – The SHA algorithm to test.

  • orientation (Annotated[Orientation, <typer.models.ArgumentInfo object at 0x7fac524f9590>]) – The orientation of the implementation, either bit- or byte-oriented.

  • filename (Annotated[str, <typer.models.OptionInfo object at 0x7fac524ebb90>]) – Name of the file to save results.

  • no_save (Annotated[bool, <typer.models.OptionInfo object at 0x7fac524ebc10>]) – Do not save results or prompt the user.

crypto_condor.cli.run.shake(language, algorithm, orientation, filename='', no_save=False)

Runs a SHA wrapper.

Parameters:

  • language (Annotated[Wrapper, <typer.models.ArgumentInfo object at 0x7fac531fa910>]) – The language of the wrapper to run.

  • algorithm (Annotated[Algorithm, <typer.models.ArgumentInfo object at 0x7fac524f9750>]) – The SHAKE algorithm to test.

  • orientation (Annotated[Orientation, <typer.models.ArgumentInfo object at 0x7fac524f9850>]) – The orientation of the implementation, either bit- or byte-oriented.

  • filename (Annotated[str, <typer.models.OptionInfo object at 0x7fac524ebb90>]) – Name of the file to save results.

  • no_save (Annotated[bool, <typer.models.OptionInfo object at 0x7fac524ebc10>]) – Do not save results or prompt the user.

crypto_condor.cli.run.rsassa(language, scheme, sha, mgf_sha=None, sign=True, verify=True, filename='', no_save=False)

Runs an RSA wrapper.

Parameters:

  • language (Annotated[Wrapper, <typer.models.ArgumentInfo object at 0x7fac531fa910>]) – The language of the wrapper to run.

  • scheme (Annotated[Scheme, <typer.models.ArgumentInfo object at 0x7fac524f9a50>]) – The RSA scheme to test.

  • sha (Annotated[Hash, <typer.models.ArgumentInfo object at 0x7fac524f9b50>]) – The SHA to use.

  • mgf_sha (Annotated[Hash | None, <typer.models.OptionInfo object at 0x7fac524f9e50>]) – (RSASSA-PSS only) The SHA to use with MGF1.

  • sign (Annotated[bool, <typer.models.OptionInfo object at 0x7fac524eb890>]) – Whether to test the signing function.

  • verify (Annotated[bool, <typer.models.OptionInfo object at 0x7fac524ebb50>]) – Whether to test the verifying function.

  • filename (Annotated[str, <typer.models.OptionInfo object at 0x7fac524ebb90>]) – Name of the file to save results.

  • no_save (Annotated[bool, <typer.models.OptionInfo object at 0x7fac524ebc10>]) – Do not save results or prompt the user.

crypto_condor.cli.run.rsaes(language, scheme, sha=None, mgf_sha=None, filename='', no_save=False)

Runs a RSAES wrapper.

Parameters:

  • language (Annotated[Wrapper, <typer.models.ArgumentInfo object at 0x7fac531fa910>]) – The language of the wrapper to run.

  • scheme (Annotated[Scheme, <typer.models.ArgumentInfo object at 0x7fac524f9f90>]) – The RSA scheme to test.

  • sha (Annotated[Hash | None, <typer.models.OptionInfo object at 0x7fac524fa250>]) – The SHA to use in RSAES-OAEP.

  • mgf_sha (Annotated[Hash | None, <typer.models.OptionInfo object at 0x7fac524fa2d0>]) – The SHA to use with MGF1 in RSAES-OAEP.

  • filename (Annotated[str, <typer.models.OptionInfo object at 0x7fac524ebb90>]) – Name of the file to save results.

  • no_save (Annotated[bool, <typer.models.OptionInfo object at 0x7fac524ebc10>]) – Do not save results or prompt the user.

crypto_condor.cli.run.chacha20(language, mode, resilience=True, encrypt=True, decrypt=True, filename='', no_save=False)

Runs an ChaCha20 wrapper.

Parameters:

  • language (Annotated[Wrapper, <typer.models.ArgumentInfo object at 0x7fac531fa910>]) – The language of the wrapper.

  • mode (Annotated[Mode, <typer.models.ArgumentInfo object at 0x7fac5306ad50>]) – The mode of operation.

  • resilience (Annotated[bool, <typer.models.OptionInfo object at 0x7fac524be750>]) – Whether to use resilience test vectors.

  • encrypt (Annotated[bool, <typer.models.OptionInfo object at 0x7fac534643d0>]) – Whether to test encryption.

  • decrypt (Annotated[bool, <typer.models.OptionInfo object at 0x7fac524eba10>]) – Whether to test decryption.

  • filename (Annotated[str, <typer.models.OptionInfo object at 0x7fac524ebb90>]) – Name of the file to save results.

  • no_save (Annotated[bool, <typer.models.OptionInfo object at 0x7fac524ebc10>]) – Do not save results or prompt the user.

Notes

  • encrypt and decrypt should not be False at the same time.

  • If resilience if False, no test can be done.

crypto_condor.cli.run.hmac(language, hash_function, compliance=True, resilience=False, filename='', no_save=False)

Runs an HMAC wrapper.

crypto_condor.cli.run.ecdh(lang, curve, wrapper='ECDH_wrapper.py', compliance=True, resilience=False, filename='', no_save=False)

Runs an ECDH wrapper.

Parameters:

  • lang (Annotated[Wrapper, <typer.models.ArgumentInfo object at 0x7fac524fa7d0>]) – The language of the wrapper.

  • curve (Annotated[Curve, <typer.models.ArgumentInfo object at 0x7fac524fa850>]) – The elliptic curve to use.

  • wrapper (Annotated[str, <typer.models.ArgumentInfo object at 0x7fac524fa950>]) – The name of the wrapper, ECDH_wrapper.py by default.

  • compliance (Annotated[bool, <typer.models.OptionInfo object at 0x7fac5395f490>]) – Whether to use compliance test vectors.

  • resilience (Annotated[bool, <typer.models.OptionInfo object at 0x7fac524be750>]) – Whether to use resilience test vectors.

  • filename (Annotated[str, <typer.models.OptionInfo object at 0x7fac524ebb90>]) – Name of the file to save results.

  • no_save (Annotated[bool, <typer.models.OptionInfo object at 0x7fac524ebc10>]) – Do not save results or prompt the user.