sopc_crypto_profiles.h

Go to the documentation of this file.

/*
 * 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.
 */
 
#ifndef SOPC_CRYPTO_PROFILES_H_
#define SOPC_CRYPTO_PROFILES_H_
 
#include <stdbool.h>
#include <stdint.h>
 
#include "sopc_crypto_decl.h"
#include "sopc_enums.h"
#include "sopc_secret_buffer.h"
 
// s2opc_common_export.h is generated by CMake, when not using CMake, copy and include
// "src/Common/helpers_platform_dep/<platform>/s2opc_common_export.h_"
#include "s2opc_common_export.h"
 
// Client-server security policies
 
// Crypto profiles uri and ID
typedef enum SOPC_SecurityPolicy_ID
{
    SOPC_SecurityPolicy_Invalid_ID = 0,
    SOPC_SecurityPolicy_Basic256Sha256_ID = 1,
    SOPC_SecurityPolicy_Basic256_ID = 2,
    SOPC_SecurityPolicy_None_ID = 3,
    SOPC_SecurityPolicy_PubSub_Aes256_ID = 4,
    SOPC_SecurityPolicy_Aes128Sha256RsaOaep_ID = 5,
    SOPC_SecurityPolicy_Aes256Sha256RsaPss_ID = 6,
    SOPC_SecurityPolicy_Last_ID
} SOPC_SecurityPolicy_ID;
 
#define SOPC_SecurityPolicy_Basic256Sha256_URI "http://opcfoundation.org/UA/SecurityPolicy#Basic256Sha256"
#define SOPC_SecurityPolicy_Basic256_URI "http://opcfoundation.org/UA/SecurityPolicy#Basic256"
#define SOPC_SecurityPolicy_None_URI "http://opcfoundation.org/UA/SecurityPolicy#None"
#define SOPC_SecurityPolicy_PubSub_Aes256_URI "http://opcfoundation.org/UA/SecurityPolicy#PubSub-Aes256-CTR"
#define SOPC_SecurityPolicy_Aes128Sha256RsaOaep_URI "http://opcfoundation.org/UA/SecurityPolicy#Aes128_Sha256_RsaOaep"
#define SOPC_SecurityPolicy_Aes256Sha256RsaPss_URI "http://opcfoundation.org/UA/SecurityPolicy#Aes256_Sha256_RsaPss"
 
#define SOPC_SecurityPolicy_Basic256Sha256_URI_SignAlgo "http://www.w3.org/2001/04/xmldsig-more#rsa-sha256"
#define SOPC_SecurityPolicy_Aes128Sha256RsaOaep_URI_SignAlgo "http://www.w3.org/2001/04/xmldsig-more#rsa-sha256"
#define SOPC_SecurityPolicy_Aes256Sha256RsaPss_URI_SignAlgo "http://opcfoundation.org/UA/security/rsa-pss-sha2-256"
#define SOPC_SecurityPolicy_Basic256_URI_SignAlgo "http://www.w3.org/2000/09/xmldsig#rsa-sha1"
 
typedef struct SOPC_SecurityPolicy_Config
{
    const char* uri;
    const bool isInvalid; 
    const char* name;     
    const SOPC_CryptoProfile* profile;
    const SOPC_CryptoProfile_PubSub* psProfile;
    uint8_t secuPolicyWeight;          
    uint32_t symmLen_CryptoKey;        
    uint32_t symmLen_SignKey;          
    uint32_t symmLen_Signature;        
    uint32_t symmLen_Block;            
    uint32_t symmLen_KeyNonce;         
    uint32_t symmLen_MessageRandom;    
    uint32_t asymLen_OAEP_Hash;        
    uint32_t asymLen_KeyMinBits;       
    uint32_t asymLen_KeyMaxBits;       
    uint32_t secureChannelNonceLength; 
    uint32_t certLen_Thumbprint;       
    const char* URI_SignAlgo;          
} SOPC_SecurityPolicy_Config;
 
const SOPC_SecurityPolicy_Config* SOPC_SecurityPolicy_Config_Get(SOPC_SecurityPolicy_ID policyId);
 
// CryptoProfiles instances (Client/Server)
S2OPC_COMMON_EXPORT extern const SOPC_CryptoProfile sopc_g_cpAes256Sha256RsaPss;
S2OPC_COMMON_EXPORT extern const SOPC_CryptoProfile sopc_g_cpAes128Sha256RsaOaep;
S2OPC_COMMON_EXPORT extern const SOPC_CryptoProfile sopc_g_cpBasic256Sha256;
S2OPC_COMMON_EXPORT extern const SOPC_CryptoProfile sopc_g_cpBasic256;
S2OPC_COMMON_EXPORT extern const SOPC_CryptoProfile sopc_g_cpNone;
 
// CryptoProfiles instances (PubSub)
S2OPC_COMMON_EXPORT extern const SOPC_CryptoProfile_PubSub sopc_g_cppsPubSubAes256;
S2OPC_COMMON_EXPORT extern const SOPC_CryptoProfile_PubSub sopc_g_cppsNone;
 
// API
const SOPC_SecurityPolicy_Config* SOPC_CryptoProfile_Get(const char* uri);
const SOPC_CryptoProfile_PubSub* SOPC_CryptoProfile_PubSub_Get(const char* uri);
 
/* ------------------------------------------------------------------------------------------------
 * Internal CryptoProfile function pointers.
 * ------------------------------------------------------------------------------------------------
 */
typedef SOPC_ReturnStatus FnSymmetricEncrypt(const SOPC_CryptoProvider* pProvider,
                                             const uint8_t* pInput,
                                             uint32_t lenPlainText,
                                             const SOPC_ExposedBuffer* pKey,
                                             const SOPC_ExposedBuffer* pIV,
                                             uint8_t* pOutput,
                                             uint32_t lenOutput);
typedef SOPC_ReturnStatus FnSymmetricDecrypt(const SOPC_CryptoProvider* pProvider,
                                             const uint8_t* pInput,
                                             uint32_t lenCipherText,
                                             const SOPC_ExposedBuffer* pKey,
                                             const SOPC_ExposedBuffer* pIV,
                                             uint8_t* pOutput,
                                             uint32_t lenOutput);
typedef SOPC_ReturnStatus FnSymmetricSign(const SOPC_CryptoProvider* pProvider,
                                          const uint8_t* pInput,
                                          uint32_t lenInput,
                                          const SOPC_ExposedBuffer* pKey,
                                          uint8_t* pOutput);
typedef SOPC_ReturnStatus FnSymmetricVerify(const SOPC_CryptoProvider* pProvider,
                                            const uint8_t* pInput,
                                            uint32_t lenInput,
                                            const SOPC_ExposedBuffer* pKey,
                                            const uint8_t* pSignature);
typedef SOPC_ReturnStatus FnGenerateRandom(const SOPC_CryptoProvider* pProvider,
                                           SOPC_ExposedBuffer* pData,
                                           uint32_t lenData);
typedef SOPC_ReturnStatus FnDerivePseudoRandomData(const SOPC_CryptoProvider* pProvider,
                                                   const SOPC_ExposedBuffer* pSecret,
                                                   uint32_t lenSecret,
                                                   const SOPC_ExposedBuffer* pSeed,
                                                   uint32_t lenSeed,
                                                   SOPC_ExposedBuffer* pOutput,
                                                   uint32_t lenOutput);
typedef SOPC_ReturnStatus FnAsymmetricEncrypt(const SOPC_CryptoProvider* pProvider,
                                              const uint8_t* pInput,
                                              uint32_t lenPlainText,
                                              const SOPC_AsymmetricKey* pKey,
                                              uint8_t* pOutput);
typedef SOPC_ReturnStatus FnAsymmetricDecrypt(const SOPC_CryptoProvider* pProvider,
                                              const uint8_t* pInput,
                                              uint32_t lenCipherText,
                                              const SOPC_AsymmetricKey* pKey,
                                              uint8_t* pOutput,
                                              uint32_t* lenWritten);
typedef SOPC_ReturnStatus FnAsymmetricSign(const SOPC_CryptoProvider* pProvider,
                                           const uint8_t* pInput,
                                           uint32_t lenInput,
                                           const SOPC_AsymmetricKey* pKey,
                                           uint8_t* pSignature);
typedef SOPC_ReturnStatus FnAsymmetricVerify(const SOPC_CryptoProvider* pProvider,
                                             const uint8_t* pInput,
                                             uint32_t lenInput,
                                             const SOPC_AsymmetricKey* pKey,
                                             const uint8_t* pSignature);
 
typedef SOPC_ReturnStatus FnPubSubCrypt(const SOPC_CryptoProvider* pProvider,
                                        const uint8_t* pInput,
                                        uint32_t lenInput,
                                        const SOPC_ExposedBuffer* pKey,
                                        const SOPC_ExposedBuffer* pKeyNonce,
                                        const SOPC_ExposedBuffer* pRandom,
                                        uint32_t uSequenceNumber,
                                        uint8_t* pOutput);
 
/* ------------------------------------------------------------------------------------------------
 * The CryptoProfile definitions
 * ------------------------------------------------------------------------------------------------
 */
 
struct SOPC_CryptoProfile
{
    const SOPC_SecurityPolicy_ID SecurityPolicyID;
    FnSymmetricEncrypt* const pFnSymmEncrypt;
    FnSymmetricDecrypt* const pFnSymmDecrypt;
    FnSymmetricSign* const pFnSymmSign;
    FnSymmetricVerify* const pFnSymmVerif;
    FnGenerateRandom* const pFnGenRnd;
    FnDerivePseudoRandomData* const pFnDeriveData;
    FnAsymmetricEncrypt* const pFnAsymEncrypt;
    FnAsymmetricDecrypt* const pFnAsymDecrypt;
    FnAsymmetricSign* const pFnAsymSign;
    FnAsymmetricVerify* const pFnAsymVerify;
};
 
struct SOPC_CryptoProfile_PubSub
{
    const uint32_t SecurityPolicyID;
    FnPubSubCrypt* const pFnCrypt;
    FnSymmetricSign* const pFnSymmSign;
    FnSymmetricVerify* const pFnSymmVerif;
    FnGenerateRandom* const pFnGenRnd;
};
 
#endif /* SOPC_CRYPTO_PROFILES_H_ */