/*

 * Licensed to Systerel under one or more contributor license

 * agreements. See the NOTICE file distributed with this work

 * for additional information regarding copyright ownership.

 * Systerel licenses this file to you under the Apache

 * License, Version 2.0 (the "License"); you may not use this

 * file except in compliance with the License. You may obtain

 * a copy of the License at

 *

 *   http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing,

 * software distributed under the License is distributed on an

 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY

 * KIND, either express or implied.  See the License for the

 * specific language governing permissions and limitations

 * under the License.

 */

#include <stddef.h>

#include <string.h>

#include "sopc_assert.h"

#include "sopc_buffer.h"

#include "sopc_common_constants.h"

#include "sopc_crypto_profiles.h"

#include "sopc_filesystem.h"

#include "sopc_helper_string.h"

#include "sopc_key_manager_lib_itf.h"

#include "sopc_logger.h"

#include "sopc_macros.h"

#include "sopc_mem_alloc.h"

#include "sopc_pki_stack.h"

#include "sopc_pki_stack_lib_internal_itf.h"

#include "sopc_pki_struct_lib_internal.h"

#ifndef STR_TRUSTLIST_NAME

#define STR_TRUSTLIST_NAME "/updatedTrustList"

#endif

#define STR_TRUSTED "/trusted"

#define STR_TRUSTED_CERTS "/trusted/certs"

#define STR_TRUSTED_CRL "/trusted/crl"

#define STR_ISSUERS "/issuers"

#define STR_ISSUERS_CERTS "/issuers/certs"

#define STR_ISSUERS_CRL "/issuers/crl"

#define STR_REJECTED "/rejected"

#define HEX_THUMBPRINT_SIZE 40

#ifndef WITH_NO_CRYPTO

static const SOPC_PKI_LeafProfile g_leaf_profile_rsa_sha256_2048_4096 = {.mdSign = SOPC_PKI_MD_SHA256,

                                                                         .pkAlgo = SOPC_PKI_PK_RSA,

                                                                         .RSAMinimumKeySize = 2048,

                                                                         .RSAMaximumKeySize = 4096,

                                                                         .bApplySecurityPolicy = true,

                                                                         .keyUsage = SOPC_PKI_KU_NONE,

                                                                         .extendedKeyUsage = SOPC_PKI_EKU_NONE,

                                                                         .sanApplicationUri = NULL,

                                                                         .sanURL = NULL};

static const SOPC_PKI_ChainProfile g_chain_profile_rsa_sha256_2048 = {.curves = SOPC_PKI_CURVES_ANY,

                                                                      .mdSign = SOPC_PKI_MD_SHA256_OR_ABOVE,

                                                                      .pkAlgo = SOPC_PKI_PK_RSA,

                                                                      .RSAMinimumKeySize = 2048,

                                                                      .bDisableRevocationCheck = false};

static const SOPC_PKI_LeafProfile g_leaf_profile_rsa_sha1_1024_2048 = {.mdSign = SOPC_PKI_MD_SHA1_AND_SHA256,

                                                                       .pkAlgo = SOPC_PKI_PK_RSA,

                                                                       .RSAMinimumKeySize = 1024,

                                                                       .RSAMaximumKeySize = 2048,

                                                                       .bApplySecurityPolicy = true,

                                                                       .keyUsage = SOPC_PKI_KU_NONE,

                                                                       .extendedKeyUsage = SOPC_PKI_EKU_NONE,

                                                                       .sanApplicationUri = NULL,

                                                                       .sanURL = NULL};

static const SOPC_PKI_ChainProfile g_chain_profile_rsa_sha1_1024 = {.curves = SOPC_PKI_CURVES_ANY,

                                                                    .mdSign = SOPC_PKI_MD_SHA1_OR_ABOVE,

                                                                    .pkAlgo = SOPC_PKI_PK_RSA,

                                                                    .RSAMinimumKeySize = 1024,

                                                                    .bDisableRevocationCheck = false};

typedef struct Profile_Cfg

{

    const SOPC_PKI_ChainProfile* chain;

    const SOPC_PKI_LeafProfile* leaf;

    const SOPC_SecurityPolicy_ID id;

} Profile_Cfg;

static const Profile_Cfg g_all_profiles[] = {

    {.id = SOPC_SecurityPolicy_Aes256Sha256RsaPss_ID,

     .leaf = &g_leaf_profile_rsa_sha256_2048_4096,

     .chain = &g_chain_profile_rsa_sha256_2048},

    {.id = SOPC_SecurityPolicy_Aes128Sha256RsaOaep_ID,

     .leaf = &g_leaf_profile_rsa_sha256_2048_4096,

     .chain = &g_chain_profile_rsa_sha256_2048},

    {.id = SOPC_SecurityPolicy_Basic256Sha256_ID,

     .leaf = &g_leaf_profile_rsa_sha256_2048_4096,

     .chain = &g_chain_profile_rsa_sha256_2048},

    {.id = SOPC_SecurityPolicy_Basic256_ID,

     .leaf = &g_leaf_profile_rsa_sha1_1024_2048,

     .chain = &g_chain_profile_rsa_sha1_1024},

};

static const SOPC_PKI_KeyUsage_Mask g_appKU = SOPC_PKI_KU_KEY_ENCIPHERMENT | SOPC_PKI_KU_KEY_DATA_ENCIPHERMENT |

                                              SOPC_PKI_KU_DIGITAL_SIGNATURE | SOPC_PKI_KU_NON_REPUDIATION;

static const SOPC_PKI_KeyUsage_Mask g_usrKU =

    SOPC_PKI_KU_DIGITAL_SIGNATURE; // it is not part of the OPC UA but it makes sense to keep it

static const SOPC_PKI_ExtendedKeyUsage_Mask g_clientEKU = SOPC_PKI_EKU_SERVER_AUTH;

static const SOPC_PKI_ExtendedKeyUsage_Mask g_serverEKU = SOPC_PKI_EKU_CLIENT_AUTH;

static const SOPC_PKI_ExtendedKeyUsage_Mask g_userEKU = SOPC_PKI_EKU_NONE;

/**

 * Static functions declaration

 */

static void sopc_pki_clear(SOPC_PKIProvider* pPKI);

// Copy newPKI content into currentPKI by preserving currentPKI mutex and then clear previous PKI content.

// Then frees the new PKI structure.

static void sopc_internal_replace_pki_and_clear(SOPC_PKIProvider* currentPKI, SOPC_PKIProvider** newPKI);

static SOPC_ReturnStatus sopc_pki_check_application_uri(const SOPC_CertificateList* pToValidate,

                                                        const char* applicationUri);

static SOPC_ReturnStatus sopc_pki_check_security_level_of_the_update(const SOPC_CertificateList* pTrustedCerts,

                                                                     const SOPC_CRLList* pTrustedCrl,

                                                                     const SOPC_CertificateList* pIssuerCerts,

                                                                     const SOPC_CRLList* pIssuerCrl,

                                                                     const char* securityPolicyUri);

static SOPC_ReturnStatus sopc_pki_merge_certificates(SOPC_CertificateList* pLeft,

                                                     SOPC_CertificateList* pRight,

                                                     SOPC_CertificateList** ppRes);

static SOPC_ReturnStatus write_cert_to_der_files(SOPC_CertificateList* pRoots,

                                                 SOPC_CertificateList* pCerts,

                                                 const char* directoryPath,

                                                 const bool bEraseExistingFiles);

static SOPC_ReturnStatus write_crl_to_der_files(SOPC_CRLList* pCrl,

                                                const char* directoryPath,

                                                const bool bEraseExistingFiles);

static SOPC_ReturnStatus may_create_pki_folder(const char* pBasePath, const char* pSubPath, char** ppPath);

static bool ignore_filtered_file(const char* pFilePath);

static SOPC_ReturnStatus load_certificate_or_crl_list(const char* basePath,

                                                      SOPC_CertificateList** ppCerts,

                                                      SOPC_CRLList** ppCrl,

                                                      bool bIscrl,

                                                      bool bDefaultBuild);

static SOPC_ReturnStatus sopc_pki_load_certificate_and_crl_list_from_store(const char* basePath,

                                                                           SOPC_CertificateList** ppTrustedCerts,

                                                                           SOPC_CRLList** ppTrustedCrl,

                                                                           SOPC_CertificateList** ppIssuerCerts,

                                                                           SOPC_CRLList** ppIssuerCrl,

                                                                           bool bDefaultBuild);

static bool pki_updated_trust_list_dir_exists(const char* path);

static SOPC_ReturnStatus pki_create_from_store(

    const char* directoryStorePath,

    bool bDefaultBuild, /* If true load the root PKI directory without trust list update,

                           if false try to load the updated trust list subdirectory.*/

    SOPC_PKIProvider** ppPKI);

static SOPC_ReturnStatus sopc_pki_merge_crls(SOPC_CRLList* pLeft, SOPC_CRLList* pRight, SOPC_CRLList** ppRes);

static SOPC_ReturnStatus sopc_pki_remove_cert_by_thumbprint(SOPC_CertificateList** ppList,

                                                            SOPC_CRLList** ppCRLList,

                                                            const char* pThumbprint,

                                                            const char* listName,

                                                            bool* pbIsRemoved,

                                                            bool* pbIsIssuer);

static SOPC_ReturnStatus sopc_pki_check_lists(SOPC_CertificateList* pTrustedCerts,

                                              SOPC_CertificateList* pIssuerCerts,

                                              SOPC_CRLList* pTrustedCrl,

                                              SOPC_CRLList* pIssuerCrl,

                                              bool* bTrustedCaFound,

                                              bool* bIssuerCaFound);

static SOPC_ReturnStatus sopc_pki_validate_anything(SOPC_PKIProvider* pPKI,

                                                    const SOPC_CertificateList* pToValidate,

                                                    const SOPC_PKI_Profile* pProfile,

                                                    uint32_t* error,

                                                    SOPC_PKI_Cert_Failure_Context* context);

static SOPC_ReturnStatus sopc_pki_check_list_length(SOPC_PKIProvider* pPKI,

                                                    SOPC_CertificateList* pTrustedCerts,

                                                    SOPC_CRLList* pTrustedCrl,

                                                    SOPC_CertificateList* pIssuerCerts,

                                                    SOPC_CRLList* pIssuerCrl,

                                                    const bool bIncludeExistingList);

static SOPC_ReturnStatus sopc_pki_get_list_length(const SOPC_CertificateList* pTrustedCerts,

                                                  const SOPC_CRLList* pTrustedCrl,

                                                  const SOPC_CertificateList* pIssuerCerts,

                                                  const SOPC_CRLList* pIssuerCrl,

                                                  uint32_t* listLength);

static const SOPC_PKI_ChainProfile* sopc_pki_get_chain_profile_from_security_policy(const char* uri);

static const SOPC_PKI_LeafProfile* sopc_pki_get_leaf_profile_from_security_policy(const char* uri);

/**

 * Static functions definition

 */

static void sopc_pki_clear(SOPC_PKIProvider* pPKI)

{

    if (NULL == pPKI)

    {

        return;

    }

    SOPC_ReturnStatus mutStatus = SOPC_Mutex_Lock(&pPKI->mutex);

    SOPC_ASSERT(SOPC_STATUS_OK == mutStatus);

    SOPC_KeyManager_Certificate_Free(pPKI->pTrustedRoots);

    SOPC_KeyManager_Certificate_Free(pPKI->pIssuerRoots);

    SOPC_KeyManager_Certificate_Free(pPKI->pAllRoots);

    SOPC_KeyManager_Certificate_Free(pPKI->pAllTrusted);

    SOPC_KeyManager_Certificate_Free(pPKI->pTrustedCerts);

    SOPC_KeyManager_Certificate_Free(pPKI->pIssuerCerts);

    SOPC_KeyManager_Certificate_Free(pPKI->pAllCerts);

    SOPC_KeyManager_CRL_Free(pPKI->pTrustedCrl);

    SOPC_KeyManager_CRL_Free(pPKI->pIssuerCrl);

    SOPC_KeyManager_CRL_Free(pPKI->pAllCrl);

    SOPC_KeyManager_Certificate_Free(pPKI->pRejectedList);

    SOPC_Free(pPKI->directoryStorePath);

    mutStatus = SOPC_Mutex_Unlock(&pPKI->mutex);

    SOPC_ASSERT(SOPC_STATUS_OK == mutStatus);

    mutStatus = SOPC_Mutex_Clear(&pPKI->mutex);

    SOPC_ASSERT(SOPC_STATUS_OK == mutStatus);

}

// Copy newPKI content into currentPKI by preserving currentPKI mutex and then clear previous PKI content.

// Then frees the new PKI structure.

static void sopc_internal_replace_pki_and_clear(SOPC_PKIProvider* currentPKI, SOPC_PKIProvider** newPKI)

{

    // tmpPKI used for clear

    SOPC_PKIProvider tmpPKI = *currentPKI;

    tmpPKI.mutex = (*newPKI)->mutex;

    // Replace all except mutex which shall remain the same since PKI is already in use

    currentPKI = memcpy(((char*) currentPKI) + sizeof(SOPC_Mutex), ((char*) (*newPKI)) + sizeof(SOPC_Mutex),

                        sizeof(SOPC_PKIProvider) - sizeof(SOPC_Mutex));

    // clear previous PKI data and unused new PKI mutex

    sopc_pki_clear(&tmpPKI);

    // frees unused new PKI structure

    SOPC_Free(*newPKI);

    *newPKI = NULL;

}

static SOPC_ReturnStatus sopc_pki_check_application_uri(const SOPC_CertificateList* pToValidate,

                                                        const char* applicationUri)

{

    SOPC_ASSERT(NULL != pToValidate);

    SOPC_ASSERT(NULL != applicationUri);

    bool ok = SOPC_KeyManager_Certificate_CheckApplicationUri(pToValidate, applicationUri);

    if (!ok)

    {

        char* pThumbprint = SOPC_KeyManager_Certificate_GetCstring_SHA1(pToValidate);

        const char* thumbprint = NULL == pThumbprint ? "NULL" : pThumbprint;

        SOPC_Logger_TraceError(SOPC_LOG_MODULE_COMMON,

                               "> PKI validation failed : the application URI %s is not stored in the URI SAN "

                               "extension of certificate thumbprint %s",

                               applicationUri, thumbprint);

        SOPC_Free(pThumbprint);

        return SOPC_STATUS_NOK;

    }

    return SOPC_STATUS_OK;

}

static SOPC_ReturnStatus sopc_pki_check_security_level_of_the_update(const SOPC_CertificateList* pTrustedCerts,

                                                                     const SOPC_CRLList* pTrustedCrl,

                                                                     const SOPC_CertificateList* pIssuerCerts,

                                                                     const SOPC_CRLList* pIssuerCrl,

                                                                     const char* securityPolicyUri)

{

    /*

    TODO :

    -1 Add a way to configure the security level for each security policy uri (give them a weight)

    -2 For each certificate, retrieve their security policies from their properties.

       How to do it? The following issue has been SUBMITTED : https://mantis.opcfoundation.org/view.php?id=8976

    */

    SOPC_UNUSED_ARG(pTrustedCerts);

    SOPC_UNUSED_ARG(pTrustedCrl);

    SOPC_UNUSED_ARG(pIssuerCerts);

    SOPC_UNUSED_ARG(pIssuerCrl);

    SOPC_UNUSED_ARG(securityPolicyUri);

    return SOPC_STATUS_OK;

}

static SOPC_ReturnStatus sopc_pki_merge_certificates(SOPC_CertificateList* pLeft,

                                                     SOPC_CertificateList* pRight,

                                                     SOPC_CertificateList** ppRes)

{

    SOPC_ReturnStatus status = SOPC_STATUS_OK;

    if (NULL == ppRes)

    {

        return SOPC_STATUS_INVALID_PARAMETERS;

    }

    SOPC_CertificateList* pRes = *ppRes;

    /* Left part */

    if (NULL != pLeft)

    {

        status = SOPC_KeyManager_Certificate_Copy(pLeft, &pRes);

    }

    /* Right part */

    if (NULL != pRight && SOPC_STATUS_OK == status)

    {

        status = SOPC_KeyManager_Certificate_Copy(pRight, &pRes);

    }

    /* clear if error */

    if (SOPC_STATUS_OK != status)

    {

        SOPC_KeyManager_Certificate_Free(pRes);

        pRes = NULL;

    }

    *ppRes = pRes;

    return status;

}

#if SOPC_HAS_FILESYSTEM

static SOPC_ReturnStatus remove_files(const char* directoryPath)

{

    SOPC_ASSERT(NULL != directoryPath);

    SOPC_ReturnStatus status = SOPC_STATUS_OK;

    SOPC_Array* pFilePaths = NULL;

    char* pFilePath = NULL;

    int res = -1;

    /* Get the array of file paths from the given directory */

    SOPC_FileSystem_GetDirResult dirRes = SOPC_FileSystem_GetDirFilePaths(directoryPath, &pFilePaths);

    if (SOPC_FileSystem_GetDir_OK != dirRes)

    {

        SOPC_Logger_TraceError(SOPC_LOG_MODULE_COMMON, "> PKI write to store: failed to open directory <%s>.",

                               directoryPath);

        return SOPC_STATUS_NOK;

    }

    size_t nbFiles = SOPC_Array_Size(pFilePaths);

    for (size_t idx = 0; idx < nbFiles && SOPC_STATUS_OK == status; idx++)

    {

        pFilePath = SOPC_Array_Get(pFilePaths, char*, idx);

        res = remove(pFilePath);

        if (0 != res)

        {

            status = SOPC_STATUS_NOK;

        }

    }

    SOPC_Array_Delete(pFilePaths);

    return status;

}

#else

SOPC_ReturnStatus remove_files(const char* directoryPath)

{

    SOPC_UNUSED_ARG(directoryPath);

    return SOPC_STATUS_NOT_SUPPORTED;

}

#endif /* SOPC_HAS_FILESYSTEM */

static SOPC_ReturnStatus write_cert_to_der_files(SOPC_CertificateList* pRoots,

                                                 SOPC_CertificateList* pCerts,

                                                 const char* directoryPath,

                                                 const bool bEraseExistingFiles)

{

    SOPC_ASSERT(NULL != directoryPath);

    SOPC_ReturnStatus status = SOPC_STATUS_OK;

    if (bEraseExistingFiles)

    {

        status = remove_files(directoryPath);

    }

    if (SOPC_STATUS_OK == status && NULL != pRoots)

    {

        status = SOPC_KeyManager_Certificate_ToDER_Files(pRoots, directoryPath);

    }

    if (SOPC_STATUS_OK == status && NULL != pCerts)

    {

        status = SOPC_KeyManager_Certificate_ToDER_Files(pCerts, directoryPath);

    }

    return status;

}

static SOPC_ReturnStatus write_crl_to_der_files(SOPC_CRLList* pCrl,

                                                const char* directoryPath,

                                                const bool bEraseExistingFiles)

{

    SOPC_ASSERT(NULL != directoryPath);

    SOPC_ReturnStatus status = SOPC_STATUS_OK;

    if (bEraseExistingFiles)

    {

        status = remove_files(directoryPath);

    }

    if (SOPC_STATUS_OK == status && NULL != pCrl)

    {

        status = SOPC_KeyManager_CRL_ToDER_Files(pCrl, directoryPath);

    }

    return status;

}

static SOPC_ReturnStatus may_create_pki_folder(const char* pBasePath, const char* pSubPath, char** ppPath)

{

    SOPC_FileSystem_CreationResult mkdir_res = SOPC_FileSystem_Creation_Error_UnknownIssue;

    char* pPath = NULL;

    SOPC_ReturnStatus status = SOPC_StrConcat(pBasePath, pSubPath, &pPath);

    if (SOPC_STATUS_OK == status)

    {

        mkdir_res = SOPC_FileSystem_mkdir(pPath);

        if (SOPC_FileSystem_Creation_Error_PathAlreadyExists != mkdir_res && SOPC_FileSystem_Creation_OK != mkdir_res)

        {

            status = SOPC_STATUS_NOK;

        }

    }

    if (SOPC_STATUS_OK != status)

    {

        SOPC_Free(pPath);

        pPath = NULL;

    }

    *ppPath = pPath;

    return status;

}

static bool ignore_filtered_file(const char* pFilePath)

{

    char* lastSep = strrchr(pFilePath, '/');

    if (NULL != lastSep && '.' == lastSep[1])

    {

        // Ignore file if first file character is a dot '.'

        return true;

    }

    return false;

}

static SOPC_ReturnStatus load_certificate_or_crl_list(const char* basePath,

                                                      SOPC_CertificateList** ppCerts,

                                                      SOPC_CRLList** ppCrl,

                                                      bool bIscrl,

                                                      bool bDefaultBuild)

{

    SOPC_ASSERT(NULL != basePath);

    if (bIscrl)

    {

        SOPC_ASSERT(NULL != ppCrl && NULL == ppCerts);

    }

    else

    {

        SOPC_ASSERT(NULL == ppCrl && NULL != ppCerts);

    }

    SOPC_ReturnStatus status = SOPC_STATUS_OK;

    SOPC_Array* pFilePaths = NULL;

    SOPC_CertificateList* pCerts = NULL;

    SOPC_CRLList* pCrl = NULL;

    char* pFilePath = NULL;

    /* Get the array of path from basePath */

    SOPC_FileSystem_GetDirResult dirRes = SOPC_FileSystem_GetDirFilePaths(basePath, &pFilePaths);

    if (SOPC_FileSystem_GetDir_OK != dirRes)

    {

        if (!bDefaultBuild)

        {

            SOPC_Logger_TraceWarning(SOPC_LOG_MODULE_COMMON, "> PKI creation warning: failed to open directory <%s>.",

                                     basePath);

        }

        else

        {

            SOPC_Logger_TraceError(SOPC_LOG_MODULE_COMMON, "> PKI creation error: failed to open directory <%s>.",

                                   basePath);

        }

        return SOPC_STATUS_NOK;

    }

    /* Get the size and iterate for each item */

    size_t nbFiles = SOPC_Array_Size(pFilePaths);

    bool hasFileToLoad = false;

    bool atLeastOneLoaded = false;

    bool allFilesLoaded = true;

    for (size_t idx = 0; idx < nbFiles && SOPC_STATUS_OK == status; idx++)

    {

        pFilePath = SOPC_Array_Get(pFilePaths, char*, idx);

        if (ignore_filtered_file(pFilePath))

        {

            SOPC_Logger_TraceDebug(SOPC_LOG_MODULE_COMMON, "> PKI ignoring file <%s>", pFilePath);

        }

        else

        {

            hasFileToLoad = true;

            SOPC_Logger_TraceDebug(SOPC_LOG_MODULE_COMMON, "> PKI loading file <%s>", pFilePath);

            if (bIscrl)

            {

                status = SOPC_KeyManager_CRL_CreateOrAddFromFile(pFilePath, &pCrl);

            }

            else

            {

                status = SOPC_KeyManager_Certificate_CreateOrAddFromFile(pFilePath, &pCerts);

            }

            if (SOPC_STATUS_OK == status)

            {

                atLeastOneLoaded = true;

            }

            else

            {

                allFilesLoaded = false;

                SOPC_Logger_TraceWarning(SOPC_LOG_MODULE_COMMON, "> PKI creation warning: ignored invalid %s <%s>.",

                                         bIscrl ? "CRL" : "certificate", pFilePath);

            }

        }

    }

#ifdef S2OPC_START_APP_PKI_WITH_ONE_VALID_CERT

    SOPC_UNUSED_ARG(allFilesLoaded);

    if (hasFileToLoad && !atLeastOneLoaded)

    {

        status = SOPC_STATUS_NOK;

    }

    else

    {

        status = SOPC_STATUS_OK;

    }

#else

    SOPC_UNUSED_ARG(hasFileToLoad);

    SOPC_UNUSED_ARG(atLeastOneLoaded);

    status = allFilesLoaded ? SOPC_STATUS_OK : SOPC_STATUS_NOK;

#endif

    /* Clear in case of error */

    if (SOPC_STATUS_OK != status)

    {

        SOPC_KeyManager_Certificate_Free(pCerts);

        SOPC_KeyManager_CRL_Free(pCrl);

    }

    else

    {

        if (bIscrl)

        {

            *ppCrl = pCrl;

        }

        else

        {

            *ppCerts = pCerts;

        }

    }

    /* Always clear */

    SOPC_Array_Delete(pFilePaths);

    return status;

}

static SOPC_ReturnStatus sopc_pki_load_certificate_and_crl_list_from_store(const char* basePath,

                                                                           SOPC_CertificateList** ppTrustedCerts,

                                                                           SOPC_CRLList** ppTrustedCrl,

                                                                           SOPC_CertificateList** ppIssuerCerts,

                                                                           SOPC_CRLList** ppIssuerCrl,

                                                                           bool bDefaultBuild)

{

    SOPC_ASSERT(NULL != basePath);

    SOPC_ASSERT(NULL != ppTrustedCerts);

    SOPC_ASSERT(NULL != ppTrustedCrl);

    SOPC_ASSERT(NULL != ppIssuerCerts);

    SOPC_ASSERT(NULL != ppIssuerCrl);

    /* Trusted Certs */

    char* trustedCertsPath = NULL;

    SOPC_ReturnStatus status = SOPC_StrConcat(basePath, STR_TRUSTED_CERTS, &trustedCertsPath);

    if (SOPC_STATUS_OK == status)

    {

        status = load_certificate_or_crl_list(trustedCertsPath, ppTrustedCerts, NULL, false, bDefaultBuild);

    }

    SOPC_Free(trustedCertsPath);

    /* Trusted Crl */

    if (SOPC_STATUS_OK == status)

    {

        char* trustedCrlPath = NULL;

        status = SOPC_StrConcat(basePath, STR_TRUSTED_CRL, &trustedCrlPath);

        if (SOPC_STATUS_OK == status)

        {

            status = load_certificate_or_crl_list(trustedCrlPath, NULL, ppTrustedCrl, true, bDefaultBuild);

        }

        SOPC_Free(trustedCrlPath);

    }

    /* Issuer Certs */

    if (SOPC_STATUS_OK == status)

    {

        char* issuerCertsPath = NULL;

        status = SOPC_StrConcat(basePath, STR_ISSUERS_CERTS, &issuerCertsPath);

        if (SOPC_STATUS_OK == status)

        {

            status = load_certificate_or_crl_list(issuerCertsPath, ppIssuerCerts, NULL, false, bDefaultBuild);

        }

        SOPC_Free(issuerCertsPath);

    }

    /* Issuer Crl */

    if (SOPC_STATUS_OK == status)

    {

        char* issuerCrlPath = NULL;

        status = SOPC_StrConcat(basePath, STR_ISSUERS_CRL, &issuerCrlPath);

        if (SOPC_STATUS_OK == status)

        {

            status = load_certificate_or_crl_list(issuerCrlPath, NULL, ppIssuerCrl, true, bDefaultBuild);

        }

        SOPC_Free(issuerCrlPath);

    }

    if (SOPC_STATUS_OK != status)

    {

        SOPC_KeyManager_Certificate_Free(*ppTrustedCerts);

        SOPC_KeyManager_Certificate_Free(*ppIssuerCerts);

        SOPC_KeyManager_CRL_Free(*ppTrustedCrl);

        SOPC_KeyManager_CRL_Free(*ppIssuerCrl);

        *ppTrustedCerts = NULL;

        *ppIssuerCerts = NULL;

        *ppTrustedCrl = NULL;

        *ppIssuerCrl = NULL;

    }

    return status;

}

static bool pki_updated_trust_list_dir_exists(const char* path)

{

    SOPC_Array* pFilePaths = NULL;

    SOPC_FileSystem_GetDirResult dirRes = SOPC_FileSystem_GetDirFilePaths(path, &pFilePaths);

    SOPC_Array_Delete(pFilePaths);

    return (SOPC_FileSystem_GetDir_OK == dirRes);

}

static SOPC_ReturnStatus pki_create_from_store(

    const char* directoryStorePath,

    bool bDefaultBuild, /* If true load the root PKI directory without trust list update,

                         if false try to load the updated trust list subdirectory.*/

    SOPC_PKIProvider** ppPKI)

{

    SOPC_ASSERT(NULL != directoryStorePath);

    SOPC_ASSERT(NULL != ppPKI);

    SOPC_ReturnStatus status = SOPC_STATUS_OK;

    SOPC_CertificateList* pTrustedCerts = NULL; /* trusted intermediate CA + trusted certificates */

    SOPC_CertificateList* pIssuerCerts = NULL;  /* issuer intermediate CA */

    SOPC_CRLList* pTrustedCrl = NULL;           /* CRLs of trusted intermediate CA and trusted root CA */

    SOPC_CRLList* pIssuerCrl = NULL;            /* CRLs of issuer intermediate CA and issuer root CA */

    const char* basePath = NULL;

    char* path = NULL;

    char* trust_list_name = NULL;

    /* Select the right folder: add updateTrustList subdirectory path containing PKI update*/

    if (!bDefaultBuild)

    {

        status = SOPC_StrConcat(directoryStorePath, STR_TRUSTLIST_NAME, &path);

        if (SOPC_STATUS_OK != status)

        {

            return status;

        }

        if (pki_updated_trust_list_dir_exists(path))

        {

            basePath = path;

        }

        else

        {

            SOPC_Free(path);

            path = NULL;

            status = SOPC_STATUS_WOULD_BLOCK;

        }

    }

    else

    {

        basePath = directoryStorePath;

    }

    /* Load the files from the directory Store path */

    if (SOPC_STATUS_OK == status)

    {

        status = sopc_pki_load_certificate_and_crl_list_from_store(basePath, &pTrustedCerts, &pTrustedCrl,

                                                                   &pIssuerCerts, &pIssuerCrl, bDefaultBuild);

    }

    /* Check if the trustList is empty */

    if (SOPC_STATUS_OK == status && NULL == pTrustedCerts && NULL == pTrustedCrl && NULL == pIssuerCerts &&

        NULL == pIssuerCrl)

    {

        status = SOPC_STATUS_NOK;

        if (!bDefaultBuild)

        {

            SOPC_Logger_TraceWarning(SOPC_LOG_MODULE_COMMON, "> PKI creation warning: certificate store is empty (%s).",

                                     basePath);

        }

        else

        {

            SOPC_Logger_TraceError(SOPC_LOG_MODULE_COMMON, "> PKI creation error: certificate store is empty (%s).",

                                   basePath);

        }

    }

    if (SOPC_STATUS_OK == status)

    {

        status = SOPC_PKIProvider_CreateFromList(pTrustedCerts, pTrustedCrl, pIssuerCerts, pIssuerCrl, ppPKI);

    }

    /* if error then try with trusted and issuers folder. */

    if (!bDefaultBuild && SOPC_STATUS_OK != status)

    {

        SOPC_Logger_TraceInfo(SOPC_LOG_MODULE_COMMON,

                              "> PKI creation: loading PKI store root directory %s content (default behavior).",

                              directoryStorePath);

        SOPC_Logger_TraceInfo(SOPC_LOG_MODULE_COMMON,

                              "> PKI creation: the updated PKI store subdirectory %s%s is absent"

                              " or its content cannot be loaded (see warnings in this case).",

                              directoryStorePath, STR_TRUSTLIST_NAME);

        status = pki_create_from_store(directoryStorePath, true, ppPKI);

    }

    /* Copy the directoryStorePath */

    if (SOPC_STATUS_OK == status)

    {

        /* Copy only if not done during the recursive call. */

        if (NULL == (*ppPKI)->directoryStorePath)

        {

            (*ppPKI)->directoryStorePath = SOPC_strdup(directoryStorePath);

            if (NULL == (*ppPKI)->directoryStorePath)

            {

                SOPC_PKIProvider_Free(ppPKI);

                *ppPKI = NULL;

                status = SOPC_STATUS_OUT_OF_MEMORY;

            }

        }

    }

    /* Clear */

    SOPC_Free(path);

    SOPC_Free(trust_list_name);

    SOPC_KeyManager_Certificate_Free(pTrustedCerts);

    SOPC_KeyManager_Certificate_Free(pIssuerCerts);

    SOPC_KeyManager_CRL_Free(pTrustedCrl);

    SOPC_KeyManager_CRL_Free(pIssuerCrl);

    return status;

}

static SOPC_ReturnStatus sopc_pki_get_list_length(const SOPC_CertificateList* pTrustedCerts,

                                                  const SOPC_CRLList* pTrustedCrl,

                                                  const SOPC_CertificateList* pIssuerCerts,

                                                  const SOPC_CRLList* pIssuerCrl,

                                                  uint32_t* listLength)

{

    *listLength = 0;

    size_t lenTrustedCerts = 0;

    size_t lenTrustedCrl = 0;

    size_t lenIssuerCerts = 0;

    size_t lenIssuerCrl = 0;

    size_t lenTot = 0;

    SOPC_ReturnStatus status = SOPC_STATUS_OK;

    if (NULL != pTrustedCerts)

    {

        status = SOPC_KeyManager_Certificate_GetListLength(pTrustedCerts, &lenTrustedCerts);

    }

    if (NULL != pTrustedCrl && SOPC_STATUS_OK == status)

    {

        status = SOPC_KeyManager_CRL_GetListLength(pTrustedCrl, &lenTrustedCrl);

    }

    if (NULL != pIssuerCerts && SOPC_STATUS_OK == status)

    {

        status = SOPC_KeyManager_Certificate_GetListLength(pIssuerCerts, &lenIssuerCerts);

    }

    if (NULL != pIssuerCrl && SOPC_STATUS_OK == status)

    {

        status = SOPC_KeyManager_CRL_GetListLength(pIssuerCrl, &lenIssuerCrl);

    }

    if (SOPC_STATUS_OK == status)

    {

        lenTot = lenTrustedCerts + lenTrustedCrl + lenIssuerCerts + lenIssuerCrl;

        if (UINT32_MAX < lenTot)

        {

            status = SOPC_STATUS_INVALID_STATE;

        }

        else

        {

            *listLength = (uint32_t) lenTot;

        }

    }

    return status;

}

static SOPC_ReturnStatus sopc_pki_merge_crls(SOPC_CRLList* pLeft, SOPC_CRLList* pRight, SOPC_CRLList** ppRes)

{

    SOPC_ReturnStatus status = SOPC_STATUS_OK;

    if (NULL == ppRes)

    {

        return SOPC_STATUS_INVALID_PARAMETERS;

    }

    SOPC_CRLList* pRes = *ppRes;

    /* Left part */

    if (NULL != pLeft)

    {

        status = SOPC_KeyManager_CRL_Copy(pLeft, &pRes);

    }

    /* Right part */

    if (NULL != pRight && SOPC_STATUS_OK == status)

    {

        status = SOPC_KeyManager_CRL_Copy(pRight, &pRes);

    }

    /* clear if error */

    if (SOPC_STATUS_OK != status)

    {

        SOPC_KeyManager_CRL_Free(pRes);

        pRes = NULL;

    }

    *ppRes = pRes;

    return status;

}

static SOPC_ReturnStatus sopc_pki_remove_cert_by_thumbprint(SOPC_CertificateList** ppList,

                                                            SOPC_CRLList** ppCRLList,

                                                            const char* pThumbprint,

                                                            const char* listName,

                                                            bool* pbIsRemoved,

                                                            bool* pbIsIssuer)

{

    SOPC_ASSERT(NULL != ppList);

    SOPC_ASSERT(NULL != ppCRLList);

    SOPC_ASSERT(NULL != pThumbprint);

    SOPC_ASSERT(NULL != pbIsRemoved);

    SOPC_ASSERT(NULL != pbIsIssuer);

    size_t lenThumb = strlen(pThumbprint);

    SOPC_ASSERT(HEX_THUMBPRINT_SIZE == lenThumb);

    /* Initialized the value to return */

    *pbIsRemoved = false;

    *pbIsIssuer = false;

    SOPC_ReturnStatus status = SOPC_STATUS_OK;

    if (NULL == *ppList)

    {

        /* the certificate list is empty, do nothing*/

        return SOPC_STATUS_OK;

    }

    uint32_t count = 0;

    bool bIsIssuer = false;

    bool bAtLeastOneIssuer = false;

    bool bAtLeastOne = false;

    bool bCertIsRemoved = true;

    while (bCertIsRemoved && SOPC_STATUS_OK == status)

    {

        status = SOPC_KeyManager_CertificateList_RemoveCertFromSHA1(ppList, ppCRLList, pThumbprint, &bCertIsRemoved,

                                                                    &bIsIssuer);

        if (bCertIsRemoved)

        {

            if (bIsIssuer)

            {

                bAtLeastOneIssuer = true;

            }

            if (bAtLeastOneIssuer && !bIsIssuer)

            {

                SOPC_Logger_TraceWarning(SOPC_LOG_MODULE_COMMON,

                                         "> PKI remove: certificate thumbprint <%s> has been found both as CA and as "

                                         "leaf certificate from %s",

                                         pThumbprint, listName);

            }

            bAtLeastOne = true;

            count = count + 1;

        }

    }

    if (bAtLeastOne && NULL != listName)

    {

        SOPC_Logger_TraceDebug(SOPC_LOG_MODULE_COMMON,

                               "> PKI remove: certificate thumbprint <%s> has been removed (%" PRIu32 " times) from %s",

                               pThumbprint, count, listName);

    }

    *pbIsIssuer = bAtLeastOneIssuer;

    *pbIsRemoved = bAtLeastOne;

    return status;

}

static SOPC_ReturnStatus sopc_pki_check_lists(SOPC_CertificateList* pTrustedCerts,

                                              SOPC_CertificateList* pIssuerCerts,

                                              SOPC_CRLList* pTrustedCrl,

                                              SOPC_CRLList* pIssuerCrl,

                                              bool* bTrustedCaFound,

                                              bool* bIssuerCaFound)

{

    SOPC_ReturnStatus status = SOPC_STATUS_OK;

    /* Trusted stats */

    uint32_t trusted_ca_count = 0;

    uint32_t trusted_list_length = 0;

    uint32_t issued_cert_count = 0;

    uint32_t trusted_root_count = 0;

    /* Issuer stats */

    uint32_t issuer_ca_count = 0;

    uint32_t issuer_list_length = 0;

    uint32_t issuer_root_count = 0;

    *bTrustedCaFound = false;

    *bIssuerCaFound = false;

    if (NULL == pTrustedCerts)

    {

        SOPC_Logger_TraceError(SOPC_LOG_MODULE_COMMON, "> PKI creation error: no trusted certificate is provided.");

        return SOPC_STATUS_INVALID_PARAMETERS;

    }

    SOPC_PKIProviderInternal_GetListStats(pTrustedCerts, &trusted_ca_count, &trusted_list_length, &trusted_root_count);

    issued_cert_count = trusted_list_length - trusted_ca_count;

    /* trusted CA => trusted CRL*/

    if (0 != trusted_ca_count && NULL == pTrustedCrl)