Fix various reported issues etc.

CMakeLists.txt

@@ -247,6 +247,7 @@ if(NOT TARGET clean_all)
     COMMAND ${CMAKE_BUILD_TOOL} clean
     COMMAND find . -name "*.o" -o -regex "./libsecutils[0-9-].*" | xargs rm
     COMMAND rm -rf debian/{tmp,libsecutils,libsecutils-dev,libsecutils-bin}
+    COMMAND rm -rf ${CMAKE_CURRENT_BINARY_DIR}/src/${PROJECT_NAME}.pc
     COMMAND find . -type d -name "build" | xargs -r rm -r
     # cowardly not doing rm -r ${CMAKE_BINARY_DIR}
 

README.md

@@ -48,11 +48,11 @@ also on a virtual machine or the Windows Subsystem for Linux ([WSL](https://docs
 and with MacOS.
 
 The following network and development tools are needed or recommended.
-* Git (for getting the software, tested versions include 2.7.2, 2.11.0, 2.20, 2.34.1, 2.48.0)
-* CMake (for using [`CMakeLists.txt`](CMakeLists.txt), tested versions include 3.18.4, 3.22.1, 3.27.7, 3.31.5)
+* Git (for getting the software, tested versions include 2.7.2, 2.11.0, 2.20, 2.34.1, 2.48.0, 2.53.0)
+* CMake (for using [`CMakeLists.txt`](CMakeLists.txt), tested versions include 3.18.4, 3.22.1, 3.27.7, 3.31.5, 4.3.0)
 * GNU make (tested versions include 3.81, 4.1, 4.2.1, 4.3)
-* GNU C compiler (gcc, tested versions include 5.4.0, 7.3.0, 8.3.0, 10.2.1, 11.4.0, 12.2.0)
-  or clang (tested versions include 14.0.3, 17.0.3, 19.1.1)
+* GNU C compiler (gcc, tested versions include 5.4.0, 7.3.0, 8.3.0, 10.2.1, 11.4.0, 12.2.0, 13.3.0)
+  or clang (tested versions include 14.0.3, 17.0.3, 19.1.1, 22.1.1)
 
 The following OSS components are used.
 * OpenSSL development edition, at least version 3.0. Tested, among others,

src/libsecutils/include/secutils/certstatus/cdp_util.h

@@ -5,8 +5,6 @@
 *
 * @copyright Copyright (c) Siemens Mobility GmbH, 2021
 *
-* @author David von Oheimb <david.von.oheimb@siemens.com>
-*
 * This work is licensed under the terms of the Apache Software License 
 * 2.0. See the COPYING file in the top-level directory.
 *

src/libsecutils/include/secutils/certstatus/crl_mgmt.h

@@ -5,8 +5,6 @@
 *
 * @copyright Copyright (c) Siemens Mobility GmbH, 2021
 *
-* @author David von Oheimb <david.von.oheimb@siemens.com>
-*
 * This work is licensed under the terms of the Apache Software License 
 * 2.0. See the COPYING file in the top-level directory.
 *

src/libsecutils/include/secutils/certstatus/crls.h

@@ -42,6 +42,7 @@ bool CRL_check(const char *src, OPTIONAL X509_CRL *crl, OPTIONAL const X509_VERI
  * @brief retrieve CRL in DER format (ASN.1) from given CRL distribution point
  *
  * @param url the location of the CDP
+ * @note when given an https URL, uses trivial unauthenticated TLS
  * @param timeout number of seconds the HTTP transaction may take, or 0 for infinite or -1 for default
  * @param max_resp_len the maximal size of the response message, or 0 for the OpenSSL default: 100 kiB
  * @param desc description of the CRL to use for any error messages, or null
@@ -65,6 +66,8 @@ int check_cert_crls(X509_STORE_CTX* ctx, OPTIONAL STACK_OF(X509_CRL) * crls, con
 
 /*!
  * @brief check the revocation status of the certificate at current error depth in ctx using CDPs
+ * @note This does not limit the use of URLs taken from CDP entries in the certificate.
+ * Thus any referenced online endpoints and local file locations may get accessed.
  *
  * @param ctx pointer to verification context structure including the cert to check
  * @return 1 on success, 0 on rejection (i.e., cert revoked), -2 on no CRL available, -1 on other error

src/libsecutils/include/secutils/certstatus/ocsp.h

@@ -32,6 +32,7 @@
  * @brief obtain OCSP response from given OCSP responder
  *
  * @param url the location of the OCSP responder
+ * @note when given an https URL, uses trivial unauthenticated TLS
  * @param timeout number of seconds the HTTP transaction may take, or 0 for infinite or -1 for default
  * @param req the OCSP request to send
  * @param desc description of contents to use for any error messages, or null
@@ -45,6 +46,7 @@ static const int OCSP_DEFAULT_TIMEOUT = 10; /* in seconds */
 /*!
  * @brief check cert status using the given OCSP response
  * @note the OCSP response may be obtained using an OCSP request or OCSP stapling
+ * @note at this level, any nonce and cert ID relating request and response cannot be checked
  *
  * @param ts pointer to trust store containing verification parameters
  * @param untrusted a stack of certs that may be used for chain building, or null
@@ -59,6 +61,10 @@ int check_ocsp_resp(X509_STORE* ts, STACK_OF(X509) *untrusted,
 /*!
  * @brief check cert revocation status via OCSP.
  * @note tries using any AIA entries (if enabled) then try any given fallback OCSP responder URLs, in the given order
+ * @note This does not limit the use of URLs taken from AIA entries in the certificate.
+ * Thus any referenced online endpoints and local file locations may get accessed.
+ * @note to avoid performance penalty on OCSP responders, does not use nonce for
+ * replay protection when retrieving OCSP response unless defined SECUTILS_OCSP_USE_NONCE
  *
  * @param ctx verification context containing verification parameters etc.
  * @param untrusted a stack of certs that may be used for chain building, or null

src/libsecutils/include/secutils/connections/http.h

@@ -26,6 +26,8 @@
  * @brief obtain ASN.1 response from given server
  *
  * @param url the location of the server
+ * @note when given an https URL, uses trivial unauthenticated TLS -
+ * so use with care; this is okay for retrieving CRLs and OCSP responses
  * @param timeout number of seconds the HTTP transaction may take, or 0 for infinite
  * @param max_resp_len the maximal size of the response message, or 0 for the default: 100k
  * @param content_type the content type of the request, or null

src/libsecutils/include/secutils/credentials/credentials.h

@@ -153,7 +153,8 @@ void CREDENTIALS_free(OPTIONAL CREDENTIALS* creds);
 
 /*!*****************************************************************************
  * @brief load asymmetric credentials from the given file(s) and optionally crypto engine
- * @note If used, encryption indirectly also protects integrity&authenticity of file-based storage.
+ * @note If used, password-based decryption indirectly
+ * also checks integrity&authenticity of file-based storage.
  *
  * @param certs name of file holding certificate and optional chain, or null
  * @param key name of file holding private key or an engine key identifier, or null
@@ -173,9 +174,9 @@ CREDENTIALS* CREDENTIALS_load(OPTIONAL const char* certs, OPTIONAL const char* k
 
 
 /*!*****************************************************************************
- * @brief load asymmetric credentials from the given file(s) and optionally using DV-based integrity&authenticity
- *protection
- * @note If used, encryption indirectly also protects integrity&authenticity of file-based storage.
+ * @brief load asymmetric credentials from the given file(s),
+ * using DV-based decryption and integrity&authenticity check
+ * @note If SECUTILS_USE_UTA is not set, cannot derive secure password from DV
  *
  * @param certs name of file holding certificate and optional chain, or null
  * @param key name of file holding private key, or null
@@ -191,7 +192,8 @@ CREDENTIALS* CREDENTIALS_load_dv(OPTIONAL const char* certs, OPTIONAL const char
 
 /*!*****************************************************************************
  * @brief save asymmetric credentials (except key held in crypto engine or provider) to the given file(s)
- * @note If used, encryption indirectly also protects integrity&authenticity of file-based storage.
+ * @note If used, password-based encryption indirectly
+ * also protects integrity&authenticity of file-based storage.
  *
  * @param creds pointer to the credential structure to save
  * @param certs name of file to store certificates, or null. Any previous contents are overwritten.
@@ -214,8 +216,9 @@ bool CREDENTIALS_save(const CREDENTIALS* creds, OPTIONAL const char* certs, OPTI
 
 
 /*!*****************************************************************************
- * @brief save asymmetric credentials to the given file(s)
- * @note If used, encryption indirectly also protects integrity&authenticity of file-based storage.
+ * @brief save asymmetric credentials to the given file(s),
+ * using DV-based encryption and integrity&authenticity protection
+ * @note If SECUTILS_USE_UTA is not set, cannot derive secure password from DV
  *
  * @param creds pointer to the credential structure to save
  * @param certs name of file to store certificates, or null. Any previous contents are overwritten.
@@ -235,7 +238,7 @@ static const char* const CREDS_DIR_DEFAULT = "certs/creds";
 /*!*****************************************************************************
  * @brief obtain credentials of the given component (based on its ID) from PKCS#12 file
  * @note file name is derived from CREDS_DIR_ENV (defaulting to CREDS_DIR_DEFAULT), cid, and extension ".p12".
- * @note uses DV-based encryption, which also protects integrity&authenticity.
+ * @note does not use DV-based protection
  *
  * @param cid identifier of the component credentials
  * @return pointer to a new CREDENTIALS structure, or null on error
@@ -245,7 +248,7 @@ CREDENTIALS* CREDENTIALS_get(component_creds_id cid);
 /*!*****************************************************************************
  * @brief store credentials of the given component (based on its ID) in PKCS#12 format
  * @note file name is derived from CREDS_DIR_ENV (defaulting to CREDS_DIR_DEFAULT), cid, and extension ".p12".
- * @note uses DV-based encryption, which also protects integrity&authenticity.
+ * @note does not use DV-based protection
  *
  * @param cid identifier of the component credentials
  * @param creds credentials to store

src/libsecutils/include/secutils/credentials/store.h

@@ -85,9 +85,13 @@ const char *STORE_get0_desc(OPTIONAL const X509_STORE *store);
  * @param stapling enable OCSP stapling, which makes sense only for TLS
  * @param crls (optional) provide a list of CRLS to be added to the store and enable CRL-based checks
  * @param use_CDP enable using HTTP CDP entries in certificates and enable CRL-based status checking
+ * @note The use of URLs taken from CDP entries in certificates is not limited.
+ * Thus any referenced online endpoints and local file locations may get accessed.
  * @param cdps (optional) provide fallback CDP URL(s) and enable CRL-based status checking
  * @param crls_timeout number of seconds fetching a CRL may take, or 0 for infinite or -1 for default (= 10)
  * @param use_AIA enable using AIA OCSP responder entries in certificates and enable OCSP-based status checking
+ * @note The use of URLs taken from AIA entries in certificates is not limited.
+ * Thus any referenced online endpoints and local file locations may get accessed.
  * @param ocsp (optional) provides fallback OCSP responder URL(s) and enable OCSP-based status checking
  * @param ocsp_timeout number of seconds getting an OCSP response may take, or 0 for infinite or -1 for default (= 10)
  * @return true on success, false on failure
@@ -135,6 +139,9 @@ X509_CRL *STORE_fetch_crl(const X509_STORE *store, OPTIONAL const char *url, int
 /*!
  * @brief create or extend cert store structure with any given cert(s)
  * @note sets CREDENTIALS_print_cert_verify_cb() enabling diagnostic log output
+ * @note This turns X509_V_ERR_CERT_NOT_YET_VALID into just a warning,
+ * effectively accepting not yet valid certificates, which are considered OK here.
+ *
  * @note use in addition STORE_set_parameters() to enable certificate status checks
  *
  * @param store certificate store to be extended if not null
@@ -157,6 +164,7 @@ X509_STORE* STORE_create(OPTIONAL X509_STORE* store, OPTIONAL const X509* cert,
  * @param vpm verification parameters, or null, governing if and how to check cert times,
  * depending on X509_V_FLAG_USE_CHECK_TIME and X509_V_FLAG_NO_CHECK_TIME
  * @param ctx (optional) pointer to UTA context for checking file integrity&authenticity using ICV
+ * @note if ctx is null or SECUTILS_USE_ICV not defined, no ICV-based check is done
  * @return true on success, false on error
  * @note For loaded certs their validity period and their CA flag are checked.
  *       Failures are logged as a warning if vpm is null, otherwise as an error.
@@ -177,6 +185,7 @@ bool STORE_load_more_check(X509_STORE** pstore, const char* file,
  * @param vpm verification parameters, or null, governing if and how to check cert times,
  * depending on X509_V_FLAG_USE_CHECK_TIME and X509_V_FLAG_NO_CHECK_TIME
  * @param ctx (optional) pointer to UTA context for checking file integrity&authenticity using ICV
+ * @note if ctx is null or SECUTILS_USE_ICV not defined, no ICV-based check is done
  * @return pointer to a new X509_STORE structure, or null on error
  * @note For loaded certs their validity period and their CA flag are checked.
  *       Failures are logged as a warning if vpm is null, otherwise as an error.
@@ -198,6 +207,7 @@ X509_STORE* STORE_load_check(const char* files, OPTIONAL const char* desc,
  * @param vpm verification parameters, or null, governing if and how to check cert times,
  * depending on X509_V_FLAG_USE_CHECK_TIME and X509_V_FLAG_NO_CHECK_TIME
  * @param ctx (optional) pointer to UTA context for checking file integrity&authenticity using ICV
+ * @note if ctx is null or SECUTILS_USE_ICV not defined, no ICV-based check is done
  * @note at least one valid certificate file must be found in all tested directories
  * @return true on success, false on error/failure
  * @note For loaded certs their validity period and their CA flag are checked.
@@ -217,7 +227,8 @@ bool STORE_load_check_dir(X509_STORE** pstore, const char* trust_dir,
  * @param crl_dir     directory where to search for CRLs
  * @param desc        description of CRLs to use for error reporting, or null
  * @param recursive   if true, use recursive search in subdirectories
- * @param ctx pointer to UTA context for checking file integrity&authenticity using ICV, or null
+ * @param ctx (optional) pointer to UTA context for checking file integrity&authenticity using ICV
+ * @note if ctx is null or SECUTILS_USE_ICV not defined, no ICV-based check is done
  * @note at least one valid CRL file must be found in each visited directory
  * @return true on success, false on error/failure
  ******************************************************************************/

src/libsecutils/include/secutils/credentials/trusted.h

@@ -37,6 +37,7 @@ static const char* const TRUST_CONFIG_ENTRY_CRLS = "crls";
  * @param cid identifier of the component, which indicates the config file section to use, or TRUST_CONFIG_SECTION_DEFAULT if it is 0
  * @param vpm OpenSSL certificate verification parameters to be taken over, or null for default
  * @param ctx (optional) pointer to UTA context for checking file integrity&authenticity using ICV
+ * @note if ctx is null or SECUTILS_USE_ICV not defined, no ICV-based check is done
  * @return pointer to a new CREDENTIALS structure, or null on error
  *******************************************************************************/
 X509_STORE* CREDENTIALS_get_trust_store(component_creds_id cid, OPTIONAL X509_VERIFY_PARAM* vpm, OPTIONAL uta_ctx* ctx);

src/libsecutils/include/secutils/credentials/verify.h

@@ -46,6 +46,9 @@ bool STORE_CTX_tls_active(const X509_STORE_CTX* ctx);
  * @param ctx_x509 pointer to structure containing certificate verification options like trusted certs
  * @return 0 if and only if the cert verification is considered failed
  *
+ * @note This callback turns X509_V_ERR_CERT_NOT_YET_VALID into just a warning,
+ * effectively accepting not yet valid certificates, which are considered OK here.
+ *
  * @note OpenSSL's X509_verify_cert function calls this function
  * during certificate verification whenever a problem has been
  * found and on success at the end of the verification to give an opportunity
@@ -78,6 +81,9 @@ bool verify_cb_cert(X509_STORE_CTX* store_ctx, X509* cert, int err);
  * @param cert certificate to be verified
  * @param untrusted (optional) intermediate certs that may be useful for building
  * the chain of certificates between the cert and the trusted certs in the trust store
+ * @note This function turns X509_V_ERR_CERT_NOT_YET_VALID into just a warning,
+ * effectively accepting not yet valid certificates, which are considered OK here.
+ *
  * @param trust_store pointer to structure containing trusted (root) certs and further verification parameters
  * @note trust_store may contain CRLs loaded via STORE_load_crl_dir()
  * @return < 0 on on verification error, 0 for invalid cert, 1 for valid cert

src/libsecutils/include/secutils/crypto/crypto.h

@@ -5,7 +5,7 @@
 *
 * @copyright Copyright (c) Siemens Mobility GmbH, 2021
 *
-* @author David von Oheimb <david.von.oheimb@siemens.com>
+* @author Martin Vitek <martin.vitek@siemens.com>
 *
 * This work is licensed under the terms of the Apache Software License 
 * 2.0. See the COPYING file in the top-level directory.
@@ -78,11 +78,11 @@ ssize_t AESGCM_decrypt(EVP_CIPHER_CTX* osslctx, uint8_t* plain_buff, size_t plai
 
 
 /*!
- * @brief The function finalizes encryption and store tag (integrity protection value).
+ * @brief The function finalizes encryption and stores tag (integrity protection value).
  *
- * @param osslctx pointer to context of decryption operation
+ * @param osslctx pointer to context of encryption operation
  * @param tag_buff     pointer to buffer used to store tag
- * @param tag_len      size of resulting tag to be stored in tag_buff
+ * @param tag_len      size of resulting tag to be stored in tag_buff, should be EVP_GCM_TLS_TAG_LEN
  * @note  If tag_buff is set to null and tag_len is set to 0 then tag will not be generated
  *
  * @return  true  on success
@@ -96,7 +96,7 @@ bool AESGCM_encrypt_final(EVP_CIPHER_CTX* osslctx, uint8_t* tag_buff, size_t tag
  *
  * @param osslctx pointer to context of decryption operation
  * @param tag     pointer to tag
- * @param tag_len size of tag
+ * @param tag_len size of tag, should be EVP_GCM_TLS_TAG_LEN
  * @note  If tag_buff is set to null and tag_len is set 0 then authenticity will not be checked
  * @param plain   pointer to plain text obtained by calling AESGCM_decrypt or null
  * @note  on failure the function cleans plain text if parameter plain is not null

src/libsecutils/include/secutils/operators.h

@@ -5,7 +5,7 @@
 *
 * @copyright Copyright (c) Siemens Mobility GmbH, 2021
 *
-* @author David von Oheimb <david.von.oheimb@siemens.com>
+* @author Martin Barta <martin.barta@siemens.com>
 *
 * This work is  licensed under the terms of the Apache Software License 
 * 2.0. See the COPYING file in the top-level directory.

src/libsecutils/include/secutils/storage/files_dv.h

@@ -31,6 +31,7 @@
 
 /*!
  * @brief get file encryption password from UTA using derivation value based on file path name
+ * @note If SECUTILS_USE_UTA is not set, cannot derive secure password
  *
  * @param pass_buf place to store the derived password as base64 encoded string, must be at least MAX_UTA_PASS_LEN chars
  * long
@@ -55,6 +56,7 @@ bool FILES_get_dv(const char* filename, unsigned char* dv_out);
 
 /*!
  * @brief store private key in given file and format, optionally using DV-based password
+ * @note If SECUTILS_USE_UTA is not set, cannot derive secure password from DV
  *
  * @param pkey private key to save
  * @param file (path) name of the output file. Any previous contents are overwritten.
@@ -70,6 +72,7 @@ bool FILES_store_key_dv(const EVP_PKEY* pkey, const char* file, file_format_t fo
 
 /*!
  * @brief load private key from the given file or engine with flexible format, optionally using DV-based password
+ * @note If SECUTILS_USE_UTA is not set, cannot derive secure password from DV
  *
  * @param key file (path) name of the input file or engine key ID
  * @param file_format the format to try first when reading file contents
@@ -85,6 +88,7 @@ EVP_PKEY* FILES_load_key_autofmt_dv(OPTIONAL const char* key, file_format_t file
 
 /*!
  * @brief load certificates from the given file with flexible format, optionally using DV-based password
+ * @note If SECUTILS_USE_UTA is not set, cannot derive secure password from DV
  *
  * @param file (path) name of the input file
  * @param format the format to try first when reading file contents