include/openssl/self_test.h

   1 /*
   2  * Copyright 2019-2020 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the Apache License 2.0 (the "License").  You may not use
   5  * this file except in compliance with the License.  You can obtain a copy
   6  * in the file LICENSE in the source distribution or at
   7  * https://www.openssl.org/source/license.html
   8  */
   9
  10 #ifndef OPENSSL_SELF_TEST_H
  11 # define OPENSSL_SELF_TEST_H
  12
  13 # include <openssl/core.h> /* OSSL_CALLBACK */
  14
  15 # ifdef __cplusplus
  16 extern "C" {
  17 # endif
  18
  19 /* The test event phases */
  20 # define OSSL_SELF_TEST_PHASE_NONE     "None"
  21 # define OSSL_SELF_TEST_PHASE_START    "Start"
  22 # define OSSL_SELF_TEST_PHASE_CORRUPT  "Corrupt"
  23 # define OSSL_SELF_TEST_PHASE_PASS     "Pass"
  24 # define OSSL_SELF_TEST_PHASE_FAIL     "Fail"
  25
  26 /* Test event categories */
  27 # define OSSL_SELF_TEST_TYPE_NONE               "None"
  28 # define OSSL_SELF_TEST_TYPE_MODULE_INTEGRITY   "Module_Integrity"
  29 # define OSSL_SELF_TEST_TYPE_INSTALL_INTEGRITY  "Install_Integrity"
  30 # define OSSL_SELF_TEST_TYPE_CRNG               "Continuous_RNG_Test"
  31 # define OSSL_SELF_TEST_TYPE_PCT                "Pairwise_Consistency_Test"
  32 # define OSSL_SELF_TEST_TYPE_KAT_CIPHER         "KAT_Cipher"
  33 # define OSSL_SELF_TEST_TYPE_KAT_DIGEST         "KAT_Digest"
  34 # define OSSL_SELF_TEST_TYPE_KAT_SIGNATURE      "KAT_Signature"
  35 # define OSSL_SELF_TEST_TYPE_KAT_KDF            "KAT_KDF"
  36 # define OSSL_SELF_TEST_TYPE_KAT_KA             "KAT_KA"
  37 # define OSSL_SELF_TEST_TYPE_DRBG               "DRBG"
  38
  39 /* Test event sub categories */
  40 # define OSSL_SELF_TEST_DESC_NONE           "None"
  41 # define OSSL_SELF_TEST_DESC_INTEGRITY_HMAC "HMAC"
  42 # define OSSL_SELF_TEST_DESC_PCT_RSA_PKCS1  "RSA"
  43 # define OSSL_SELF_TEST_DESC_PCT_ECDSA      "ECDSA"
  44 # define OSSL_SELF_TEST_DESC_PCT_DSA        "DSA"
  45 # define OSSL_SELF_TEST_DESC_CIPHER_AES_GCM "AES_GCM"
  46 # define OSSL_SELF_TEST_DESC_CIPHER_TDES    "TDES"
  47 # define OSSL_SELF_TEST_DESC_MD_SHA1        "SHA1"
  48 # define OSSL_SELF_TEST_DESC_MD_SHA2        "SHA2"
  49 # define OSSL_SELF_TEST_DESC_MD_SHA3        "SHA3"
  50 # define OSSL_SELF_TEST_DESC_SIGN_DSA       "DSA"
  51 # define OSSL_SELF_TEST_DESC_SIGN_RSA       "RSA"
  52 # define OSSL_SELF_TEST_DESC_SIGN_ECDSA     "ECDSA"
  53 # define OSSL_SELF_TEST_DESC_DRBG_CTR       "CTR"
  54 # define OSSL_SELF_TEST_DESC_DRBG_HASH      "HASH"
  55 # define OSSL_SELF_TEST_DESC_DRBG_HMAC      "HMAC"
  56 # define OSSL_SELF_TEST_DESC_KA_DH          "DH"
  57 # define OSSL_SELF_TEST_DESC_KA_ECDH        "ECDH"
  58 # define OSSL_SELF_TEST_DESC_KDF_HKDF       "HKDF"
  59 # define OSSL_SELF_TEST_DESC_KDF_SSKDF      "SSKDF"
  60
  61 # ifdef __cplusplus
  62 }
  63 # endif
  64
  65 void OSSL_SELF_TEST_set_callback(OPENSSL_CTX *libctx, OSSL_CALLBACK *cb,
  66                                  void *cbarg);
  67 void OSSL_SELF_TEST_get_callback(OPENSSL_CTX *libctx, OSSL_CALLBACK **cb,
  68                                  void **cbarg);
  69
  70 OSSL_SELF_TEST *OSSL_SELF_TEST_new(OSSL_CALLBACK *cb, void *cbarg);
  71 void OSSL_SELF_TEST_free(OSSL_SELF_TEST *st);
  72
  73 void OSSL_SELF_TEST_onbegin(OSSL_SELF_TEST *st, const char *type,
  74                             const char *desc);
  75 void OSSL_SELF_TEST_oncorrupt_byte(OSSL_SELF_TEST *st, unsigned char *bytes);
  76 void OSSL_SELF_TEST_onend(OSSL_SELF_TEST *st, int ret);
  77
  78 #endif /* OPENSSL_SELF_TEST_H */