- merged R-GOOSE/R-SMV/SNTP code from v1.5_sntp_rsv feature branch (LIB61850-360)
Michael Zillgith
3 years ago
parent
ad78b9de26
commit
90372ced72
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,207 @@
|
||||
/*
|
||||
* r_session.h
|
||||
*
|
||||
* Copyright 2013-2021 Michael Zillgith
|
||||
*
|
||||
* This file is part of libIEC61850.
|
||||
*
|
||||
* libIEC61850 is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* libIEC61850 is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with libIEC61850. If not, see <http://www.gnu.org/licenses/>.
|
||||
*
|
||||
* See COPYING file for the complete license text.
|
||||
*/
|
||||
|
||||
#ifndef LIBIEC61850_SRC_SAMPLED_VALUES_R_SESSION_H_
|
||||
#define LIBIEC61850_SRC_SAMPLED_VALUES_R_SESSION_H_
|
||||
|
||||
#include "libiec61850_common_api.h"
|
||||
#include "hal_socket.h"
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
typedef struct sRSession* RSession;
|
||||
|
||||
typedef enum {
|
||||
R_SESSION_SEC_ALGO_NONE = 0,
|
||||
R_SESSION_SEC_ALGO_AES_128_GCM = 1,
|
||||
R_SESSION_SEC_ALGO_AES_256_GCM = 2
|
||||
} RSecurityAlgorithm;
|
||||
|
||||
typedef enum {
|
||||
R_SESSION_SIG_ALGO_NONE = 0,
|
||||
R_SESSION_SIG_ALGO_HMAC_SHA256_80 = 1,
|
||||
R_SESSION_SIG_ALGO_HMAC_SHA256_128 = 2,
|
||||
R_SESSION_SIG_ALGO_HMAC_SHA256_256 = 3,
|
||||
R_SESSION_SIG_ALGO_AES_GMAC_64 = 4,
|
||||
R_SESSION_SIG_ALGO_AES_GMAC_128 = 5,
|
||||
R_SESSION_SIG_ALGO_HMAC_SHA3_80 = 6,
|
||||
R_SESSION_SIG_ALGO_HMAC_SHA3_128 = 7,
|
||||
R_SESSION_SIG_ALGO_HMAC_SHA3_256 = 8
|
||||
} RSignatureAlgorithm;
|
||||
|
||||
typedef enum {
|
||||
R_SESSION_ERROR_OK = 0,
|
||||
R_SESSION_ERROR_INVALID_KEY = 1,
|
||||
R_SESSION_ERROR_KEY_QUEUE_FULL = 2,
|
||||
R_SESSION_ERROR_NO_SOCKET = 3,
|
||||
R_SESSION_ERROR_OUT_OF_MEMORY = 4,
|
||||
R_SESSION_ERROR_FAILED_TO_SEND = 5,
|
||||
R_SESSION_ERROR_FAILED_TO_RECEIVE = 6,
|
||||
R_SESSION_ERROR_INVALID_MESSAGE = 7,
|
||||
R_SESSION_ERROR_SET_FAILED = 8
|
||||
} RSessionError;
|
||||
|
||||
typedef struct sRSessionPayloadElement* RSessionPayloadElement;
|
||||
|
||||
struct sRSessionPayloadElement
|
||||
{
|
||||
bool simulation;
|
||||
uint16_t appId;
|
||||
uint8_t* payload;
|
||||
int payloadSize;
|
||||
RSessionPayloadElement nextElement; /* NULL when no more elements follow */
|
||||
};
|
||||
|
||||
/**
|
||||
* \brief Create a new RSession instance to provide R-GOOSE/R-SMV support for GOOSE/SMV publisher/subscriber
|
||||
*
|
||||
* \return new RSession instance
|
||||
*/
|
||||
LIB61850_API RSession
|
||||
RSession_create();
|
||||
|
||||
/**
|
||||
* \brief Set the maximum buffer size for session messages (range: 128 - 65535)
|
||||
*
|
||||
* \param self the RSession instance
|
||||
* \param bufferSize the size of the buffer for RSession UDP messages (range: 128 - 65535)
|
||||
*/
|
||||
LIB61850_API void
|
||||
RSession_setBufferSize(RSession self, uint16_t bufferSize);
|
||||
|
||||
/* Required only for version 1 of the protocol! */
|
||||
LIB61850_API RSessionError
|
||||
RSession_setSecurity(RSession self, RSecurityAlgorithm secAlgo, RSignatureAlgorithm sigAlgo);
|
||||
|
||||
LIB61850_API RSessionError
|
||||
RSession_setLocalAddress(RSession self, const char* localAddress, int localPort);
|
||||
|
||||
/**
|
||||
* \brief Add this instance to an IPv4/IPv6 multicast group
|
||||
*
|
||||
* \param self the RSession instance
|
||||
* \param multicastAddress IPv4 or IPv6 multicast address
|
||||
*
|
||||
* \return R_SESSION_ERROR_OK on success, R_SESSION_ERROR_SET_FAILED otherwise
|
||||
*/
|
||||
LIB61850_API RSessionError
|
||||
RSession_addMulticastGroup(RSession self, const char* multicastAddress);
|
||||
|
||||
/**
|
||||
* \brief Sets the multicast TTL (number of hops) for this RSession instance
|
||||
*
|
||||
* \param self the RSession instance
|
||||
* \param ttl number of hops for multicast messages. Default is 1 (not routable!)
|
||||
*
|
||||
* \return R_SESSION_ERROR_OK on success, error code otherwise
|
||||
*/
|
||||
LIB61850_API RSessionError
|
||||
RSession_setMulticastTtl(RSession self, int ttl);
|
||||
|
||||
/**
|
||||
* \brief Set the destionation address and port for publishers
|
||||
*
|
||||
* \param self the RSession instance
|
||||
* \param remoteAddress remote IP address
|
||||
* \param remotePort remote UDP port
|
||||
*
|
||||
* \return R_SESSION_ERROR_OK on success, error code otherwise
|
||||
*/
|
||||
LIB61850_API RSessionError
|
||||
RSession_setRemoteAddress(RSession self, const char* remoteAddress, int remotePort);
|
||||
|
||||
/**
|
||||
* \brief Start listening on the local UDP port to receive remote messages (only for subscriber)
|
||||
*
|
||||
* \param self the RSession instance
|
||||
*
|
||||
* \return R_SESSION_ERROR_OK on success, error code otherwise
|
||||
*/
|
||||
LIB61850_API RSessionError
|
||||
RSession_startListening(RSession self);
|
||||
|
||||
/**
|
||||
* \brief Stop listening on the local UDP port (only for subscriber)
|
||||
*
|
||||
* \param self the RSession instance
|
||||
*
|
||||
* \return R_SESSION_ERROR_OK on success, error code otherwise
|
||||
*/
|
||||
LIB61850_API RSessionError
|
||||
RSession_stopListening(RSession self);
|
||||
|
||||
/**
|
||||
* \brief Manually add a key to the RSession instance
|
||||
*
|
||||
* \param self the RSession instance
|
||||
* \param keyId the key ID is unique for the security association
|
||||
* \param key the key data
|
||||
* \param keyLength the length of the key in bytes
|
||||
* \param secAlgo the applicable security (encryption) algorithm
|
||||
* \param sigAlgo the applicable signature algorithm
|
||||
*/
|
||||
LIB61850_API RSessionError
|
||||
RSession_addKey(RSession self, uint32_t keyId, uint8_t* key, int keyLength, RSecurityAlgorithm secAlgo, RSignatureAlgorithm sigAlgo);
|
||||
|
||||
LIB61850_API RSessionError
|
||||
RSession_removeKey(RSession self, uint32_t keyId);
|
||||
|
||||
typedef enum
|
||||
{
|
||||
RSESSION_KEY_EVENT__NEED_KEY = 1
|
||||
} RSessionKeyEvent;
|
||||
|
||||
typedef void (*RSession_KeyEventHandler) (void* parameter, RSession rSession, RSessionKeyEvent event, uint32_t keyID);
|
||||
|
||||
/**
|
||||
* \brief Set a callback handler to receive key events from the RSession instance
|
||||
*
|
||||
* e.g. when the RSession instance has no valid key for the received messages or to publish messages.
|
||||
*/
|
||||
LIB61850_API void
|
||||
RSession_setKeyEventHandler(RSession self, RSession_KeyEventHandler handler, void* parameter);
|
||||
|
||||
/**
|
||||
* \brief Set the active key for the sender/publisher
|
||||
*
|
||||
* \param self the RSession instance
|
||||
* \param keyId the key ID of the new active key (has to be added with \ref RSession_addKey before).
|
||||
*/
|
||||
LIB61850_API RSessionError
|
||||
RSession_setActiveKey(RSession self, uint32_t keyId);
|
||||
|
||||
/**
|
||||
* \brief Destroy the RSession instance and free all resource
|
||||
*
|
||||
* \param self the RSession instance
|
||||
*/
|
||||
LIB61850_API void
|
||||
RSession_destroy(RSession self);
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif /* LIBIEC61850_SRC_SAMPLED_VALUES_R_SESSION_H_ */
|
||||
@ -0,0 +1,44 @@
|
||||
/*
|
||||
* r_session_crypto.h
|
||||
*
|
||||
* Copyright 2013-2021 Michael Zillgith
|
||||
*
|
||||
* This file is part of libIEC61850.
|
||||
*
|
||||
* libIEC61850 is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* libIEC61850 is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with libIEC61850. If not, see <http://www.gnu.org/licenses/>.
|
||||
*
|
||||
* See COPYING file for the complete license text.
|
||||
*/
|
||||
|
||||
#ifndef SRC_R_SESSION_R_SESSION_CRYPTO_H_
|
||||
#define SRC_R_SESSION_R_SESSION_CRYPTO_H_
|
||||
|
||||
#include <stdint.h>
|
||||
#include <stdbool.h>
|
||||
|
||||
#include "libiec61850_common_api.h"
|
||||
|
||||
LIB61850_INTERNAL bool
|
||||
RSessionCrypto_createHMAC(uint8_t* buffer, int bufSize, uint8_t* key, int keySize, uint8_t* hmac, int hmacMaxSize);
|
||||
|
||||
LIB61850_INTERNAL bool
|
||||
RSessionCrypto_gcmEncryptAndTag(uint8_t* key, int keySize, uint8_t* iv, int ivSize, uint8_t* addData, int addDataSize, uint8_t* encryptData, int encryptDataSize, uint8_t* tag, int tagSize);
|
||||
|
||||
LIB61850_INTERNAL bool
|
||||
RSessionCrypto_gcmAuthAndDecrypt(uint8_t* key, int keySize, uint8_t* iv, int ivSize, uint8_t* addData, int addDataSize, uint8_t* encryptData, int encryptDataSize, uint8_t* decryptedData, uint8_t* tag, int tagSize);
|
||||
|
||||
LIB61850_INTERNAL bool
|
||||
RSessionCrypto_createRandomData(uint8_t* data, int dataSize);
|
||||
|
||||
#endif /* SRC_R_SESSION_R_SESSION_CRYPTO_H_ */
|
||||
@ -0,0 +1,143 @@
|
||||
/*
|
||||
* r_session_crpyto_mbedtls.c
|
||||
*
|
||||
* Implementation of RSessionCrypto interface using mbedtls
|
||||
*
|
||||
* Copyright 2013-2021 Michael Zillgith
|
||||
*
|
||||
* This file is part of libIEC61850.
|
||||
*
|
||||
* libIEC61850 is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* libIEC61850 is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with libIEC61850. If not, see <http://www.gnu.org/licenses/>.
|
||||
*
|
||||
* See COPYING file for the complete license text.
|
||||
*/
|
||||
|
||||
|
||||
#include "mbedtls/cipher.h"
|
||||
#include "mbedtls/md.h"
|
||||
#include "mbedtls/md_internal.h"
|
||||
#include "mbedtls/platform_util.h"
|
||||
#include "mbedtls/gcm.h"
|
||||
#include "mbedtls/entropy.h"
|
||||
#include "mbedtls/ctr_drbg.h"
|
||||
|
||||
#include "libiec61850_platform_includes.h"
|
||||
|
||||
#include "r_session_crypto.h"
|
||||
|
||||
bool
|
||||
RSessionCrypto_createHMAC(uint8_t* buffer, int bufSize, uint8_t* key, int keySize, uint8_t* hmac, int hmacMaxSize)
|
||||
{
|
||||
const mbedtls_md_info_t* md_info = &mbedtls_sha256_info;
|
||||
|
||||
mbedtls_md_context_t md_ctx;
|
||||
|
||||
mbedtls_md_init( &md_ctx );
|
||||
|
||||
mbedtls_md_setup(&md_ctx, md_info, 1);
|
||||
|
||||
if (mbedtls_md_hmac_starts(&md_ctx, key, keySize)) {
|
||||
printf("Error in initializing HMAC\n");
|
||||
return false;
|
||||
}
|
||||
|
||||
if (mbedtls_md_hmac_update(&md_ctx, buffer, bufSize)) {
|
||||
printf("Failed to calculate HMAC\n");
|
||||
return false;
|
||||
}
|
||||
|
||||
if (mbedtls_md_hmac_finish(&md_ctx, hmac)) {
|
||||
printf("Failed to finish HMAC\n");
|
||||
return false;
|
||||
}
|
||||
|
||||
mbedtls_md_free(&md_ctx);
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
bool
|
||||
RSessionCrypto_gcmEncryptAndTag(uint8_t* key, int keySize, uint8_t* iv, int ivSize, uint8_t* addData, int addDataSize, uint8_t* encryptData, int encryptDataSize, uint8_t* tag, int tagSize)
|
||||
{
|
||||
mbedtls_gcm_context gcmCtx;
|
||||
|
||||
mbedtls_gcm_init(&gcmCtx);
|
||||
|
||||
if (mbedtls_gcm_setkey(&gcmCtx, MBEDTLS_CIPHER_ID_AES , (const unsigned char*) key, keySize * 8)) {
|
||||
printf("AES-GCM: Failed to set key\n");
|
||||
mbedtls_gcm_free(&gcmCtx);
|
||||
return false;
|
||||
}
|
||||
|
||||
if (mbedtls_gcm_crypt_and_tag(&gcmCtx, MBEDTLS_GCM_ENCRYPT, (size_t) encryptDataSize, iv, (size_t) ivSize, addData, (size_t) addDataSize, encryptData, encryptData, (size_t)tagSize, tag)) {
|
||||
printf("AES-GCM: Failed to authenticate/encrypt data\n");
|
||||
mbedtls_gcm_free(&gcmCtx);
|
||||
return false;
|
||||
}
|
||||
|
||||
mbedtls_gcm_free(&gcmCtx);
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
bool
|
||||
RSessionCrypto_gcmAuthAndDecrypt(uint8_t* key, int keySize, uint8_t* iv, int ivSize, uint8_t* addData, int addDataSize, uint8_t* encryptData, int encryptDataSize, uint8_t* decryptedData, uint8_t* tag, int tagSize)
|
||||
{
|
||||
mbedtls_gcm_context gcmCtx;
|
||||
|
||||
mbedtls_gcm_init(&gcmCtx);
|
||||
|
||||
if (mbedtls_gcm_setkey(&gcmCtx, MBEDTLS_CIPHER_ID_AES , (const unsigned char*) key, keySize * 8)) {
|
||||
printf("AES-GCM: Failed to set key\n");
|
||||
mbedtls_gcm_free(&gcmCtx);
|
||||
return false;
|
||||
}
|
||||
|
||||
if (mbedtls_gcm_auth_decrypt(&gcmCtx, (size_t) encryptDataSize, iv, (size_t) ivSize, addData, (size_t) addDataSize, tag, (size_t) tagSize, encryptData, decryptedData)) {
|
||||
printf("AES-GCM: Failed to authentication and decrypt!\n");
|
||||
mbedtls_gcm_free(&gcmCtx);
|
||||
return false;
|
||||
}
|
||||
|
||||
mbedtls_gcm_free(&gcmCtx);
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
bool
|
||||
RSessionCrypto_createRandomData(uint8_t* data, int dataSize)
|
||||
{
|
||||
int ret;
|
||||
mbedtls_ctr_drbg_context ctr_drbg;
|
||||
mbedtls_entropy_context entropy;
|
||||
|
||||
mbedtls_entropy_init( &entropy );
|
||||
mbedtls_ctr_drbg_init( &ctr_drbg );
|
||||
|
||||
if( ( ret = mbedtls_ctr_drbg_seed( &ctr_drbg, mbedtls_entropy_func, &entropy,
|
||||
NULL, 0) ) != 0 )
|
||||
{
|
||||
printf( " failed\n ! mbedtls_ctr_drbg_init returned -0x%04x\n", -ret );
|
||||
return false;
|
||||
}
|
||||
|
||||
if( ( ret = mbedtls_ctr_drbg_random( &ctr_drbg, data, dataSize ) ) != 0 )
|
||||
{
|
||||
printf( " failed\n ! mbedtls_ctr_drbg_random returned -0x%04x\n", -ret );
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
@ -0,0 +1,55 @@
|
||||
/*
|
||||
* r_session_internal.h
|
||||
*
|
||||
* Copyright 2013-2021 Michael Zillgith
|
||||
*
|
||||
* This file is part of libIEC61850.
|
||||
*
|
||||
* libIEC61850 is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* libIEC61850 is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with libIEC61850. If not, see <http://www.gnu.org/licenses/>.
|
||||
*
|
||||
* See COPYING file for the complete license text.
|
||||
*/
|
||||
|
||||
#ifndef SRC_R_SESSION_R_SESSION_INTERNAL_H_
|
||||
#define SRC_R_SESSION_R_SESSION_INTERNAL_H_
|
||||
|
||||
#include "r_session.h"
|
||||
|
||||
LIB61850_INTERNAL Socket
|
||||
RSession_getSocket(RSession self);
|
||||
|
||||
typedef enum {
|
||||
RSESSION_SPDU_ID_TUNNELED = 0xa0,
|
||||
RSESSION_SPDU_ID_GOOSE = 0xa1,
|
||||
RSESSION_SPDU_ID_SV = 0xa2,
|
||||
RSESSION_SPDU_ID_MGMT = 0xa3
|
||||
} RSessionProtocol_SPDU_ID;
|
||||
|
||||
/*
|
||||
* NOTE: For library internal use!
|
||||
*
|
||||
* \param spduId SPDU Identifier(SI) - 0xa0(tunneled), 0xa1(GOOSE), 0xa2(Sampled Values)
|
||||
*/
|
||||
LIB61850_INTERNAL RSessionError
|
||||
RSession_sendMessage(RSession self, RSessionProtocol_SPDU_ID spduId, bool simulation, uint16_t appId, uint8_t* payload, int payloadSize);
|
||||
|
||||
//RSessionError
|
||||
//RSession_sendMultiplePayloadMessage(RSession self, RSessionPayloadElement elements);
|
||||
|
||||
typedef void (*RSessionPayloadElementHandler) (void* parameter, uint16_t appId, uint8_t* payloadData, int payloadSize);
|
||||
|
||||
LIB61850_INTERNAL RSessionError
|
||||
RSession_receiveMessage(RSession self, RSessionPayloadElementHandler handler, void* parameter);
|
||||
|
||||
#endif /* SRC_R_SESSION_R_SESSION_INTERNAL_H_ */
|
||||
Loading…
Reference in New Issue