S2OPC OPCUA Toolkit
sopc_crypto_provider.h
Go to the documentation of this file.
1 /*
2  * Licensed to Systerel under one or more contributor license
3  * agreements. See the NOTICE file distributed with this work
4  * for additional information regarding copyright ownership.
5  * Systerel licenses this file to you under the Apache
6  * License, Version 2.0 (the "License"); you may not use this
7  * file except in compliance with the License. You may obtain
8  * a copy of the License at
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing,
13  * software distributed under the License is distributed on an
14  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15  * KIND, either express or implied. See the License for the
16  * specific language governing permissions and limitations
17  * under the License.
18  */
19 
26 #ifndef SOPC_CRYPTO_PROVIDER_H_
27 #define SOPC_CRYPTO_PROVIDER_H_
28 
29 #include "sopc_crypto_decl.h"
30 #include "sopc_enums.h"
31 #include "sopc_key_sets.h"
32 #include "sopc_pki_decl.h"
33 
42 struct SOPC_CryptoProvider
43 {
50  const SOPC_CryptoProfile* const pProfile;
57  const SOPC_CryptoProfile_PubSub* const pProfilePubSub;
62  SOPC_CryptolibContext* pCryptolibContext;
63 };
64 
65 /* ------------------------------------------------------------------------------------------------
66  * CryptoProvider
67  * ------------------------------------------------------------------------------------------------
68  */
69 
84 SOPC_CryptoProvider* SOPC_CryptoProvider_Create(const char* uri);
85 
100 SOPC_CryptoProvider* SOPC_CryptoProvider_CreatePubSub(const char* uri);
101 
107 void SOPC_CryptoProvider_Free(SOPC_CryptoProvider* pCryptoProvider);
108 
114 const SOPC_CryptoProfile* SOPC_CryptoProvider_GetProfileServices(const SOPC_CryptoProvider* pProvider);
115 
121 const SOPC_CryptoProfile_PubSub* SOPC_CryptoProvider_GetProfilePubSub(const SOPC_CryptoProvider* pProvider);
122 
123 /* ------------------------------------------------------------------------------------------------
124  * CryptoProvider get-length & uris operations
125  * ------------------------------------------------------------------------------------------------
126  */
127 
142 SOPC_ReturnStatus SOPC_CryptoProvider_SymmetricGetLength_CryptoKey(const SOPC_CryptoProvider* pProvider,
143  uint32_t* pLength);
144 
160 SOPC_ReturnStatus SOPC_CryptoProvider_SymmetricGetLength_Encryption(const SOPC_CryptoProvider* pProvider,
161  uint32_t lengthIn,
162  uint32_t* pLengthOut);
163 
179 SOPC_ReturnStatus SOPC_CryptoProvider_SymmetricGetLength_Decryption(const SOPC_CryptoProvider* pProvider,
180  uint32_t lengthIn,
181  uint32_t* pLengthOut);
182 
197 SOPC_ReturnStatus SOPC_CryptoProvider_SymmetricGetLength_SignKey(const SOPC_CryptoProvider* pProvider,
198  uint32_t* pLength);
199 
212 SOPC_ReturnStatus SOPC_CryptoProvider_SymmetricGetLength_Signature(const SOPC_CryptoProvider* pProvider,
213  uint32_t* pLength);
214 
235 SOPC_ReturnStatus SOPC_CryptoProvider_SymmetricGetLength_Blocks(const SOPC_CryptoProvider* pProvider,
236  uint32_t* pCipherTextBlockSize,
237  uint32_t* pPlainTextBlockSize);
238 
251 SOPC_ReturnStatus SOPC_CryptoProvider_SymmetricGetLength_SecureChannelNonce(const SOPC_CryptoProvider* pProvider,
252  uint32_t* pLenNonce);
253 
270 SOPC_ReturnStatus SOPC_CryptoProvider_DeriveGetLengths(const SOPC_CryptoProvider* pProvider,
271  uint32_t* pSymmCryptoKeyLength,
272  uint32_t* pSymmSignKeyLength,
273  uint32_t* pSymmInitVectorLength);
274 
291 SOPC_ReturnStatus SOPC_CryptoProvider_AsymmetricGetLength_KeyBytes(const SOPC_CryptoProvider* pProvider,
292  const SOPC_AsymmetricKey* pKey,
293  uint32_t* pLenKeyBytes);
294 
308 SOPC_ReturnStatus SOPC_CryptoProvider_AsymmetricGetLength_OAEPHashLength(const SOPC_CryptoProvider* pProvider,
309  uint32_t* length);
310 
329 SOPC_ReturnStatus SOPC_CryptoProvider_AsymmetricGetLength_Msgs(const SOPC_CryptoProvider* pProvider,
330  const SOPC_AsymmetricKey* pKey,
331  uint32_t* pCipherTextBlockSize,
332  uint32_t* pPlainTextBlockSize);
333 
350 SOPC_ReturnStatus SOPC_CryptoProvider_AsymmetricGetLength_Encryption(const SOPC_CryptoProvider* pProvider,
351  const SOPC_AsymmetricKey* pKey,
352  uint32_t lengthIn,
353  uint32_t* pLengthOut);
354 
372 SOPC_ReturnStatus SOPC_CryptoProvider_AsymmetricGetLength_Decryption(const SOPC_CryptoProvider* pProvider,
373  const SOPC_AsymmetricKey* pKey,
374  uint32_t lengthIn,
375  uint32_t* pLengthOut);
376 
392 SOPC_ReturnStatus SOPC_CryptoProvider_AsymmetricGetLength_Signature(const SOPC_CryptoProvider* pProvider,
393  const SOPC_AsymmetricKey* pKey,
394  uint32_t* pLength);
395 
405 const char* SOPC_CryptoProvider_AsymmetricGetUri_SignAlgorithm(const SOPC_CryptoProvider* pProvider);
406 
420 SOPC_ReturnStatus SOPC_CryptoProvider_CertificateGetLength_Thumbprint(const SOPC_CryptoProvider* pProvider,
421  uint32_t* pLength);
422 
438 SOPC_ReturnStatus SOPC_CryptoProvider_PubSubGetLength_KeyNonce(const SOPC_CryptoProvider* pProvider, uint32_t* pLength);
439 
455 SOPC_ReturnStatus SOPC_CryptoProvider_PubSubGetLength_MessageRandom(const SOPC_CryptoProvider* pProvider,
456  uint32_t* pLength);
457 
458 /* ------------------------------------------------------------------------------------------------
459  * Symmetric cryptography
460  * ------------------------------------------------------------------------------------------------
461  */
462 
490 SOPC_ReturnStatus SOPC_CryptoProvider_SymmetricEncrypt(const SOPC_CryptoProvider* pProvider,
491  const uint8_t* pInput,
492  uint32_t lenPlainText,
493  SOPC_SecretBuffer* pKey,
494  SOPC_SecretBuffer* pIV,
495  uint8_t* pOutput,
496  uint32_t lenOutput);
497 
527 SOPC_ReturnStatus SOPC_CryptoProvider_SymmetricDecrypt(const SOPC_CryptoProvider* pProvider,
528  const uint8_t* pInput,
529  uint32_t lenCipherText,
530  SOPC_SecretBuffer* pKey,
531  SOPC_SecretBuffer* pIV,
532  uint8_t* pOutput,
533  uint32_t lenOutput);
534 
567 SOPC_ReturnStatus SOPC_CryptoProvider_PubSubCrypt(const SOPC_CryptoProvider* pProvider,
568  const uint8_t* pInput,
569  uint32_t lenInput,
570  SOPC_SecretBuffer* pKey,
571  SOPC_SecretBuffer* pKeyNonce,
572  const SOPC_ExposedBuffer* pRandom,
573  uint32_t lenRandom,
574  uint32_t uSequenceNumber,
575  uint8_t* pOutput,
576  uint32_t lenOutput);
577 
604 SOPC_ReturnStatus SOPC_CryptoProvider_SymmetricSign(const SOPC_CryptoProvider* pProvider,
605  const uint8_t* pInput,
606  uint32_t lenInput,
607  SOPC_SecretBuffer* pKey,
608  uint8_t* pOutput,
609  uint32_t lenOutput);
610 
638 SOPC_ReturnStatus SOPC_CryptoProvider_SymmetricVerify(const SOPC_CryptoProvider* pProvider,
639  const uint8_t* pInput,
640  uint32_t lenInput,
641  SOPC_SecretBuffer* pKey,
642  const uint8_t* pSignature,
643  uint32_t lenOutput);
644 
645 /* ------------------------------------------------------------------------------------------------
646  * Random and pseudo-random functionalities
647  * ------------------------------------------------------------------------------------------------
648  */
649 
671 SOPC_ReturnStatus SOPC_CryptoProvider_GenerateRandomBytes(const SOPC_CryptoProvider* pProvider,
672  uint32_t nBytes,
673  SOPC_ExposedBuffer** ppBuffer);
674 
693 SOPC_ReturnStatus SOPC_CryptoProvider_GenerateSecureChannelNonce(const SOPC_CryptoProvider* pProvider,
694  SOPC_SecretBuffer** ppNonce);
695 
710 SOPC_ReturnStatus SOPC_CryptoProvider_GenerateRandomID(const SOPC_CryptoProvider* pProvider, uint32_t* pID);
711 
720 SOPC_ReturnStatus SOPC_CryptoProvider_DerivePseudoRandomData(const SOPC_CryptoProvider* pProvider,
721  const SOPC_ExposedBuffer* pSecret,
722  uint32_t lenSecret,
723  const SOPC_ExposedBuffer* pSeed,
724  uint32_t lenSeed,
725  SOPC_ExposedBuffer* pOutput,
726  uint32_t lenOutput);
727 
752 SOPC_ReturnStatus SOPC_CryptoProvider_DeriveKeySets(const SOPC_CryptoProvider* pProvider,
753  const SOPC_ExposedBuffer* pClientNonce,
754  uint32_t lenClientNonce,
755  const SOPC_ExposedBuffer* pServerNonce,
756  uint32_t lenServerNonce,
757  SOPC_SC_SecurityKeySet* pClientKeySet,
758  SOPC_SC_SecurityKeySet* pServerKeySet);
759 
782 SOPC_ReturnStatus SOPC_CryptoProvider_DeriveKeySetsClient(const SOPC_CryptoProvider* pProvider, // DeriveKeySets
783  SOPC_SecretBuffer* pClientNonce,
784  const SOPC_ExposedBuffer* pServerNonce,
785  uint32_t lenServerNonce,
786  SOPC_SC_SecurityKeySet* pClientKeySet,
787  SOPC_SC_SecurityKeySet* pServerKeySet);
788 
811 SOPC_ReturnStatus SOPC_CryptoProvider_DeriveKeySetsServer(const SOPC_CryptoProvider* pProvider,
812  const SOPC_ExposedBuffer* pClientNonce,
813  uint32_t lenClientNonce,
814  SOPC_SecretBuffer* pServerNonce,
815  SOPC_SC_SecurityKeySet* pClientKeySet,
816  SOPC_SC_SecurityKeySet* pServerKeySet);
817 
818 /* ------------------------------------------------------------------------------------------------
819  * Asymmetric cryptography
820  * ------------------------------------------------------------------------------------------------
821  */
822 
852 SOPC_ReturnStatus SOPC_CryptoProvider_AsymmetricEncrypt(const SOPC_CryptoProvider* pProvider,
853  const uint8_t* pInput,
854  uint32_t lenInput,
855  const SOPC_AsymmetricKey* pKey,
856  uint8_t* pOutput,
857  uint32_t lenOutput,
858  const char** errorReason);
859 
892 SOPC_ReturnStatus SOPC_CryptoProvider_AsymmetricDecrypt(const SOPC_CryptoProvider* pProvider,
893  const uint8_t* pInput,
894  uint32_t lenInput,
895  const SOPC_AsymmetricKey* pKey,
896  uint8_t* pOutput,
897  uint32_t lenOutput,
898  uint32_t* pLenWritten,
899  const char** errorReason);
900 
937 SOPC_ReturnStatus SOPC_CryptoProvider_AsymmetricSign(const SOPC_CryptoProvider* pProvider,
938  const uint8_t* pInput,
939  uint32_t lenInput,
940  const SOPC_AsymmetricKey* pKeyPrivateLocal,
941  uint8_t* pSignature,
942  uint32_t lenSignature,
943  const char** errorReason);
944 
976 SOPC_ReturnStatus SOPC_CryptoProvider_AsymmetricVerify(const SOPC_CryptoProvider* pProvider,
977  const uint8_t* pInput,
978  uint32_t lenInput,
979  const SOPC_AsymmetricKey* pKeyRemotePublic,
980  const uint8_t* pSignature,
981  uint32_t lenSignature,
982  const char** errorReason);
983 
984 /* ------------------------------------------------------------------------------------------------
985  * Certificate validation
986  * ------------------------------------------------------------------------------------------------
987  */
988 
1011 SOPC_ReturnStatus SOPC_CryptoProvider_Certificate_Validate(const SOPC_CryptoProvider* pProvider,
1012  SOPC_PKIProvider* pPKI,
1013  const SOPC_PKI_Type PKIType,
1014  const SOPC_CertificateList* pCert,
1015  uint32_t* error);
1016 
1017 #endif /* SOPC_CRYPTO_PROVIDER_H_ */
sopc_pki_decl.h
Defines the common declarations for the PKI objects. The structures and macros defined in this file a...
SOPC_CryptoProvider_PubSubGetLength_MessageRandom
SOPC_ReturnStatus SOPC_CryptoProvider_PubSubGetLength_MessageRandom(const SOPC_CryptoProvider *pProvider, uint32_t *pLength)
Writes the length in bytes in pLength of the random bytes used for PubSub encryption/decryption.
SOPC_CryptoProvider_GetProfileServices
const SOPC_CryptoProfile * SOPC_CryptoProvider_GetProfileServices(const SOPC_CryptoProvider *pProvider)
Returns the non NULL client-server crypto profile but returns NULL if the PubSub profile is non NULL.
SOPC_CryptoProvider_DeriveGetLengths
SOPC_ReturnStatus SOPC_CryptoProvider_DeriveGetLengths(const SOPC_CryptoProvider *pProvider, uint32_t *pSymmCryptoKeyLength, uint32_t *pSymmSignKeyLength, uint32_t *pSymmInitVectorLength)
Provides the lengths in bytes of the secrets derived from the nonce exchange.
SOPC_CryptoProvider::pCryptolibContext
SOPC_CryptolibContext * pCryptolibContext
Definition: sopc_crypto_provider.h:62
SOPC_CryptoProvider_DeriveKeySets
SOPC_ReturnStatus SOPC_CryptoProvider_DeriveKeySets(const SOPC_CryptoProvider *pProvider, const SOPC_ExposedBuffer *pClientNonce, uint32_t lenClientNonce, const SOPC_ExposedBuffer *pServerNonce, uint32_t lenServerNonce, SOPC_SC_SecurityKeySet *pClientKeySet, SOPC_SC_SecurityKeySet *pServerKeySet)
Derive pseudo-random key sets from the randomly generated and shared secrets.
SOPC_CryptoProvider_GetProfilePubSub
const SOPC_CryptoProfile_PubSub * SOPC_CryptoProvider_GetProfilePubSub(const SOPC_CryptoProvider *pProvider)
Returns the non NULL PubSub crypto profile but returns NULL if the client-server profile is non NULL.
SOPC_CertificateList
The signed public key representation, or a chained list of such keys.
Definition: key_manager_mbedtls.h:65
SOPC_CryptoProvider_AsymmetricEncrypt
SOPC_ReturnStatus SOPC_CryptoProvider_AsymmetricEncrypt(const SOPC_CryptoProvider *pProvider, const uint8_t *pInput, uint32_t lenInput, const SOPC_AsymmetricKey *pKey, uint8_t *pOutput, uint32_t lenOutput, const char **errorReason)
Encrypts a payload pInput of lenInput bytes.
SOPC_PKIProvider
The PKIProvider object for the Public Key Infrastructure.
Definition: sopc_pki_struct_lib_internal.h:129
SOPC_CryptoProvider::pProfilePubSub
const SOPC_CryptoProfile_PubSub *const pProfilePubSub
Definition: sopc_crypto_provider.h:57
SOPC_CryptoProvider_Create
SOPC_CryptoProvider * SOPC_CryptoProvider_Create(const char *uri)
Creates an initialized SOPC_CryptoProvider context for a client-server connection from a string conta...
SOPC_CryptoProvider_DerivePseudoRandomData
SOPC_ReturnStatus SOPC_CryptoProvider_DerivePseudoRandomData(const SOPC_CryptoProvider *pProvider, const SOPC_ExposedBuffer *pSecret, uint32_t lenSecret, const SOPC_ExposedBuffer *pSeed, uint32_t lenSeed, SOPC_ExposedBuffer *pOutput, uint32_t lenOutput)
Derives pseudo-random data from the randomly generated and shared secrets.
SOPC_CryptoProvider_GenerateRandomID
SOPC_ReturnStatus SOPC_CryptoProvider_GenerateRandomID(const SOPC_CryptoProvider *pProvider, uint32_t *pID)
Generates 4 bytes of truly random data.
SOPC_CryptoProvider_SymmetricGetLength_Signature
SOPC_ReturnStatus SOPC_CryptoProvider_SymmetricGetLength_Signature(const SOPC_CryptoProvider *pProvider, uint32_t *pLength)
Provides the length in bytes of the symmetric signature message.
SOPC_CryptoProvider_AsymmetricDecrypt
SOPC_ReturnStatus SOPC_CryptoProvider_AsymmetricDecrypt(const SOPC_CryptoProvider *pProvider, const uint8_t *pInput, uint32_t lenInput, const SOPC_AsymmetricKey *pKey, uint8_t *pOutput, uint32_t lenOutput, uint32_t *pLenWritten, const char **errorReason)
Decrypts a payload pInput of lenInput bytes.
SOPC_CryptoProvider_Certificate_Validate
SOPC_ReturnStatus SOPC_CryptoProvider_Certificate_Validate(const SOPC_CryptoProvider *pProvider, SOPC_PKIProvider *pPKI, const SOPC_PKI_Type PKIType, const SOPC_CertificateList *pCert, uint32_t *error)
Validates the given Certificate pCert.
sopc_crypto_decl.h
Defines the common declarations for the cryptographic objects. The structures and macros defined in t...
SOPC_CryptoProvider_GenerateRandomBytes
SOPC_ReturnStatus SOPC_CryptoProvider_GenerateRandomBytes(const SOPC_CryptoProvider *pProvider, uint32_t nBytes, SOPC_ExposedBuffer **ppBuffer)
Generates truly random data of arbitrary length.
sopc_enums.h
SOPC_CryptolibContext
Definition: crypto_provider_mbedtls.h:35
SOPC_CryptoProvider
The SOPC_CryptoProvider context.
Definition: sopc_crypto_provider.h:43
SOPC_CryptoProvider_AsymmetricGetLength_Encryption
SOPC_ReturnStatus SOPC_CryptoProvider_AsymmetricGetLength_Encryption(const SOPC_CryptoProvider *pProvider, const SOPC_AsymmetricKey *pKey, uint32_t lengthIn, uint32_t *pLengthOut)
Calculates the size of the required output buffer to cipher lengthIn bytes through asymmetric encrypt...
SOPC_CryptoProvider_SymmetricVerify
SOPC_ReturnStatus SOPC_CryptoProvider_SymmetricVerify(const SOPC_CryptoProvider *pProvider, const uint8_t *pInput, uint32_t lenInput, SOPC_SecretBuffer *pKey, const uint8_t *pSignature, uint32_t lenOutput)
Verifies the signature pSignature of the payload pInput of lenInput bytes.
SOPC_CryptoProvider_SymmetricDecrypt
SOPC_ReturnStatus SOPC_CryptoProvider_SymmetricDecrypt(const SOPC_CryptoProvider *pProvider, const uint8_t *pInput, uint32_t lenCipherText, SOPC_SecretBuffer *pKey, SOPC_SecretBuffer *pIV, uint8_t *pOutput, uint32_t lenOutput)
Decrypts a payload pInput of lenPlainText bytes into a padded deciphered payload pOutput.
SOPC_CryptoProvider_AsymmetricGetLength_KeyBytes
SOPC_ReturnStatus SOPC_CryptoProvider_AsymmetricGetLength_KeyBytes(const SOPC_CryptoProvider *pProvider, const SOPC_AsymmetricKey *pKey, uint32_t *pLenKeyBytes)
Writes the length in bytes in pLenKeyBytes of the asymmetric key pKey.
SOPC_CryptoProvider_GenerateSecureChannelNonce
SOPC_ReturnStatus SOPC_CryptoProvider_GenerateSecureChannelNonce(const SOPC_CryptoProvider *pProvider, SOPC_SecretBuffer **ppNonce)
Generates a single truly random nonce for the SecureChannel creation.
SOPC_CryptoProvider_AsymmetricGetLength_OAEPHashLength
SOPC_ReturnStatus SOPC_CryptoProvider_AsymmetricGetLength_OAEPHashLength(const SOPC_CryptoProvider *pProvider, uint32_t *length)
Provides the length of the hash used for OAEP encryption/decryption.
SOPC_CryptoProvider_DeriveKeySetsServer
SOPC_ReturnStatus SOPC_CryptoProvider_DeriveKeySetsServer(const SOPC_CryptoProvider *pProvider, const SOPC_ExposedBuffer *pClientNonce, uint32_t lenClientNonce, SOPC_SecretBuffer *pServerNonce, SOPC_SC_SecurityKeySet *pClientKeySet, SOPC_SC_SecurityKeySet *pServerKeySet)
Derive pseudo-random key sets from the randomly generated and shared secrets.
SOPC_CryptoProvider_SymmetricSign
SOPC_ReturnStatus SOPC_CryptoProvider_SymmetricSign(const SOPC_CryptoProvider *pProvider, const uint8_t *pInput, uint32_t lenInput, SOPC_SecretBuffer *pKey, uint8_t *pOutput, uint32_t lenOutput)
Signs a payload pInput of lenInput bytes, writes the signature in pOutput of lenOutput bytes.
SOPC_CryptoProvider_SymmetricEncrypt
SOPC_ReturnStatus SOPC_CryptoProvider_SymmetricEncrypt(const SOPC_CryptoProvider *pProvider, const uint8_t *pInput, uint32_t lenPlainText, SOPC_SecretBuffer *pKey, SOPC_SecretBuffer *pIV, uint8_t *pOutput, uint32_t lenOutput)
Encrypts a padded payload pInput of lenPlainText bytes.
SOPC_CryptoProvider_SymmetricGetLength_SecureChannelNonce
SOPC_ReturnStatus SOPC_CryptoProvider_SymmetricGetLength_SecureChannelNonce(const SOPC_CryptoProvider *pProvider, uint32_t *pLenNonce)
Provides the length in bytes of the SecureChannel nonces used in the symmetric encryption process.
SOPC_CryptoProvider_PubSubCrypt
SOPC_ReturnStatus SOPC_CryptoProvider_PubSubCrypt(const SOPC_CryptoProvider *pProvider, const uint8_t *pInput, uint32_t lenInput, SOPC_SecretBuffer *pKey, SOPC_SecretBuffer *pKeyNonce, const SOPC_ExposedBuffer *pRandom, uint32_t lenRandom, uint32_t uSequenceNumber, uint8_t *pOutput, uint32_t lenOutput)
Encrypts or Decrypts a payload pInput of lenInput bytes.
SOPC_CryptoProvider_SymmetricGetLength_CryptoKey
SOPC_ReturnStatus SOPC_CryptoProvider_SymmetricGetLength_CryptoKey(const SOPC_CryptoProvider *pProvider, uint32_t *pLength)
Writes the length in bytes in pLength of the key used for symmetric encryption/decryption.
SOPC_CryptoProvider_Free
void SOPC_CryptoProvider_Free(SOPC_CryptoProvider *pCryptoProvider)
Frees a SOPC_CryptoProvider created with SOPC_CryptoProvider_Create().
SOPC_PKI_Type
SOPC_PKI_Type
Type of PKI.
Definition: sopc_pki_decl.h:129
SOPC_CryptoProvider_CreatePubSub
SOPC_CryptoProvider * SOPC_CryptoProvider_CreatePubSub(const char *uri)
Creates an initialized SOPC_CryptoProvider context for PubSub exchanges from a string containing the ...
SOPC_CryptoProvider_SymmetricGetLength_Decryption
SOPC_ReturnStatus SOPC_CryptoProvider_SymmetricGetLength_Decryption(const SOPC_CryptoProvider *pProvider, uint32_t lengthIn, uint32_t *pLengthOut)
Writes the length in bytes in pLengthOut of a decrypted message of lengthIn bytes.
SOPC_CryptoProvider_AsymmetricVerify
SOPC_ReturnStatus SOPC_CryptoProvider_AsymmetricVerify(const SOPC_CryptoProvider *pProvider, const uint8_t *pInput, uint32_t lenInput, const SOPC_AsymmetricKey *pKeyRemotePublic, const uint8_t *pSignature, uint32_t lenSignature, const char **errorReason)
Verifies the signature pSignature of a payload pInput of lenInput bytes.
SOPC_CryptoProvider_DeriveKeySetsClient
SOPC_ReturnStatus SOPC_CryptoProvider_DeriveKeySetsClient(const SOPC_CryptoProvider *pProvider, SOPC_SecretBuffer *pClientNonce, const SOPC_ExposedBuffer *pServerNonce, uint32_t lenServerNonce, SOPC_SC_SecurityKeySet *pClientKeySet, SOPC_SC_SecurityKeySet *pServerKeySet)
Derive pseudo-random key sets from the randomly generated and shared secrets.
SOPC_CryptoProvider_PubSubGetLength_KeyNonce
SOPC_ReturnStatus SOPC_CryptoProvider_PubSubGetLength_KeyNonce(const SOPC_CryptoProvider *pProvider, uint32_t *pLength)
Writes the length in bytes in pLength of the key nonce used for PubSub encryption/decryption.
SOPC_CryptoProvider_AsymmetricGetLength_Decryption
SOPC_ReturnStatus SOPC_CryptoProvider_AsymmetricGetLength_Decryption(const SOPC_CryptoProvider *pProvider, const SOPC_AsymmetricKey *pKey, uint32_t lengthIn, uint32_t *pLengthOut)
Calculates the size of the required output buffer to decipher lengthIn bytes through asymmetric decry...
sopc_key_sets.h
SOPC_AsymmetricKey
The asymmetric key representation.
Definition: key_manager_mbedtls.h:45
SOPC_CryptoProvider::pProfile
const SOPC_CryptoProfile *const pProfile
Definition: sopc_crypto_provider.h:50
SOPC_CryptoProfile
SOPC_CryptoProfiles gather pointers to cryptographic functions of the security policies of OPC UA Ser...
Definition: sopc_crypto_profiles.h:181
SOPC_SC_SecurityKeySet
Definition: sopc_key_sets.h:26
SOPC_CryptoProfile_PubSub
SOPC_CryptoProfiles_PubSub gather pointers to cryptographic functions of the security policies of OPC...
Definition: sopc_crypto_profiles.h:205
SOPC_SecretBuffer
struct SOPC_SecretBuffer SOPC_SecretBuffer
Definition: sopc_secret_buffer.h:35
SOPC_CryptoProvider_AsymmetricGetLength_Signature
SOPC_ReturnStatus SOPC_CryptoProvider_AsymmetricGetLength_Signature(const SOPC_CryptoProvider *pProvider, const SOPC_AsymmetricKey *pKey, uint32_t *pLength)
Calculates the size of the required output buffer to contain the asymmetric signature.
SOPC_ExposedBuffer
uint8_t SOPC_ExposedBuffer
Definition: sopc_secret_buffer.h:36
SOPC_CryptoProvider_AsymmetricGetLength_Msgs
SOPC_ReturnStatus SOPC_CryptoProvider_AsymmetricGetLength_Msgs(const SOPC_CryptoProvider *pProvider, const SOPC_AsymmetricKey *pKey, uint32_t *pCipherTextBlockSize, uint32_t *pPlainTextBlockSize)
Provides the lengths in bytes of the messages used in asymmetric encryption process.
SOPC_CryptoProvider_SymmetricGetLength_Blocks
SOPC_ReturnStatus SOPC_CryptoProvider_SymmetricGetLength_Blocks(const SOPC_CryptoProvider *pProvider, uint32_t *pCipherTextBlockSize, uint32_t *pPlainTextBlockSize)
Provides the lengths in bytes of the blocks used in the symmetric encryption process.
SOPC_CryptoProvider_AsymmetricSign
SOPC_ReturnStatus SOPC_CryptoProvider_AsymmetricSign(const SOPC_CryptoProvider *pProvider, const uint8_t *pInput, uint32_t lenInput, const SOPC_AsymmetricKey *pKeyPrivateLocal, uint8_t *pSignature, uint32_t lenSignature, const char **errorReason)
Signs a payload pInput of lenInput bytes.
SOPC_CryptoProvider_AsymmetricGetUri_SignAlgorithm
const char * SOPC_CryptoProvider_AsymmetricGetUri_SignAlgorithm(const SOPC_CryptoProvider *pProvider)
Returns the URI of the AsymetricSignatureAlgorithm.
SOPC_CryptoProvider_SymmetricGetLength_SignKey
SOPC_ReturnStatus SOPC_CryptoProvider_SymmetricGetLength_SignKey(const SOPC_CryptoProvider *pProvider, uint32_t *pLength)
Writes the length in bytes in pLength of the key used for symmetric signature.
SOPC_CryptoProvider_SymmetricGetLength_Encryption
SOPC_ReturnStatus SOPC_CryptoProvider_SymmetricGetLength_Encryption(const SOPC_CryptoProvider *pProvider, uint32_t lengthIn, uint32_t *pLengthOut)
Writes the length in bytes in pLengthOut of an encrypted message of lengthIn bytes.
SOPC_CryptoProvider_CertificateGetLength_Thumbprint
SOPC_ReturnStatus SOPC_CryptoProvider_CertificateGetLength_Thumbprint(const SOPC_CryptoProvider *pProvider, uint32_t *pLength)
Calculates the size of the signature of the certificates.
SOPC_ReturnStatus
SOPC_ReturnStatus
Definition: libs2opc_client.h:64
Generated on Tue Nov 28 2023 09:37:26 for S2OPC OPCUA Toolkit by   doxygen 1.8.18