include/openssl/self_test.h

0001 /*
0002  * Copyright 2019-2024 The OpenSSL Project Authors. All Rights Reserved.
0003  *
0004  * Licensed under the Apache License 2.0 (the "License").  You may not use
0005  * this file except in compliance with the License.  You can obtain a copy
0006  * in the file LICENSE in the source distribution or at
0007  * https://www.openssl.org/source/license.html
0008  */
0009
0010 #ifndef OPENSSL_SELF_TEST_H
0011 # define OPENSSL_SELF_TEST_H
0012 # pragma once
0013
0014 # include <openssl/core.h> /* OSSL_CALLBACK */
0015
0016 # ifdef __cplusplus
0017 extern "C" {
0018 # endif
0019
0020 /* The test event phases */
0021 # define OSSL_SELF_TEST_PHASE_NONE     "None"
0022 # define OSSL_SELF_TEST_PHASE_START    "Start"
0023 # define OSSL_SELF_TEST_PHASE_CORRUPT  "Corrupt"
0024 # define OSSL_SELF_TEST_PHASE_PASS     "Pass"
0025 # define OSSL_SELF_TEST_PHASE_FAIL     "Fail"
0026
0027 /* Test event categories */
0028 # define OSSL_SELF_TEST_TYPE_NONE               "None"
0029 # define OSSL_SELF_TEST_TYPE_MODULE_INTEGRITY   "Module_Integrity"
0030 # define OSSL_SELF_TEST_TYPE_INSTALL_INTEGRITY  "Install_Integrity"
0031 # define OSSL_SELF_TEST_TYPE_CRNG               "Continuous_RNG_Test"
0032 # define OSSL_SELF_TEST_TYPE_PCT                "Conditional_PCT"
0033 # define OSSL_SELF_TEST_TYPE_PCT_KAT            "Conditional_KAT"
0034 # define OSSL_SELF_TEST_TYPE_KAT_INTEGRITY      "KAT_Integrity"
0035 # define OSSL_SELF_TEST_TYPE_KAT_CIPHER         "KAT_Cipher"
0036 # define OSSL_SELF_TEST_TYPE_KAT_ASYM_CIPHER    "KAT_AsymmetricCipher"
0037 # define OSSL_SELF_TEST_TYPE_KAT_DIGEST         "KAT_Digest"
0038 # define OSSL_SELF_TEST_TYPE_KAT_SIGNATURE      "KAT_Signature"
0039 # define OSSL_SELF_TEST_TYPE_PCT_SIGNATURE      "PCT_Signature"
0040 # define OSSL_SELF_TEST_TYPE_KAT_KDF            "KAT_KDF"
0041 # define OSSL_SELF_TEST_TYPE_KAT_KA             "KAT_KA"
0042 # define OSSL_SELF_TEST_TYPE_DRBG               "DRBG"
0043
0044 /* Test event sub categories */
0045 # define OSSL_SELF_TEST_DESC_NONE           "None"
0046 # define OSSL_SELF_TEST_DESC_INTEGRITY_HMAC "HMAC"
0047 # define OSSL_SELF_TEST_DESC_PCT_RSA        "RSA"
0048 # define OSSL_SELF_TEST_DESC_PCT_RSA_PKCS1  "RSA"
0049 # define OSSL_SELF_TEST_DESC_PCT_ECDSA      "ECDSA"
0050 # define OSSL_SELF_TEST_DESC_PCT_EDDSA      "EDDSA"
0051 # define OSSL_SELF_TEST_DESC_PCT_DSA        "DSA"
0052 # define OSSL_SELF_TEST_DESC_CIPHER_AES_GCM "AES_GCM"
0053 # define OSSL_SELF_TEST_DESC_CIPHER_AES_ECB "AES_ECB_Decrypt"
0054 # define OSSL_SELF_TEST_DESC_CIPHER_TDES    "TDES"
0055 # define OSSL_SELF_TEST_DESC_ASYM_RSA_ENC   "RSA_Encrypt"
0056 # define OSSL_SELF_TEST_DESC_ASYM_RSA_DEC   "RSA_Decrypt"
0057 # define OSSL_SELF_TEST_DESC_MD_SHA1        "SHA1"
0058 # define OSSL_SELF_TEST_DESC_MD_SHA2        "SHA2"
0059 # define OSSL_SELF_TEST_DESC_MD_SHA3        "SHA3"
0060 # define OSSL_SELF_TEST_DESC_SIGN_DSA       "DSA"
0061 # define OSSL_SELF_TEST_DESC_SIGN_RSA       "RSA"
0062 # define OSSL_SELF_TEST_DESC_SIGN_ECDSA     "ECDSA"
0063 # define OSSL_SELF_TEST_DESC_SIGN_EDDSA     "EDDSA"
0064 # define OSSL_SELF_TEST_DESC_DRBG_CTR       "CTR"
0065 # define OSSL_SELF_TEST_DESC_DRBG_HASH      "HASH"
0066 # define OSSL_SELF_TEST_DESC_DRBG_HMAC      "HMAC"
0067 # define OSSL_SELF_TEST_DESC_KA_DH          "DH"
0068 # define OSSL_SELF_TEST_DESC_KA_ECDH        "ECDH"
0069 # define OSSL_SELF_TEST_DESC_KDF_HKDF       "HKDF"
0070 # define OSSL_SELF_TEST_DESC_KDF_SSKDF      "SSKDF"
0071 # define OSSL_SELF_TEST_DESC_KDF_X963KDF    "X963KDF"
0072 # define OSSL_SELF_TEST_DESC_KDF_X942KDF    "X942KDF"
0073 # define OSSL_SELF_TEST_DESC_KDF_PBKDF2     "PBKDF2"
0074 # define OSSL_SELF_TEST_DESC_KDF_SSHKDF     "SSHKDF"
0075 # define OSSL_SELF_TEST_DESC_KDF_TLS12_PRF  "TLS12_PRF"
0076 # define OSSL_SELF_TEST_DESC_KDF_KBKDF      "KBKDF"
0077 # define OSSL_SELF_TEST_DESC_KDF_KBKDF_KMAC "KBKDF_KMAC"
0078 # define OSSL_SELF_TEST_DESC_KDF_TLS13_EXTRACT  "TLS13_KDF_EXTRACT"
0079 # define OSSL_SELF_TEST_DESC_KDF_TLS13_EXPAND   "TLS13_KDF_EXPAND"
0080 # define OSSL_SELF_TEST_DESC_RNG            "RNG"
0081
0082 void OSSL_SELF_TEST_set_callback(OSSL_LIB_CTX *libctx, OSSL_CALLBACK *cb,
0083                                  void *cbarg);
0084 void OSSL_SELF_TEST_get_callback(OSSL_LIB_CTX *libctx, OSSL_CALLBACK **cb,
0085                                  void **cbarg);
0086
0087 OSSL_SELF_TEST *OSSL_SELF_TEST_new(OSSL_CALLBACK *cb, void *cbarg);
0088 void OSSL_SELF_TEST_free(OSSL_SELF_TEST *st);
0089
0090 void OSSL_SELF_TEST_onbegin(OSSL_SELF_TEST *st, const char *type,
0091                             const char *desc);
0092 int OSSL_SELF_TEST_oncorrupt_byte(OSSL_SELF_TEST *st, unsigned char *bytes);
0093 void OSSL_SELF_TEST_onend(OSSL_SELF_TEST *st, int ret);
0094
0095 # ifdef __cplusplus
0096 }
0097 # endif
0098 #endif /* OPENSSL_SELF_TEST_H */