- implemented GOOSE signatures in GOOSE publisher (LIB61850-329)
Michael Zillgith
3 years ago
parent
6f2bb1a19c
commit
a7dc9148c2
@ -0,0 +1,243 @@
|
|||||||
|
#include <stdint.h>
|
||||||
|
#include <stdio.h>
|
||||||
|
|
||||||
|
#include "l2_security.h"
|
||||||
|
#include "ber_encoder.h"
|
||||||
|
#include "r_session_crypto.h"
|
||||||
|
|
||||||
|
struct sL2Security {
|
||||||
|
RSignatureAlgorithm currentSigAlgo;
|
||||||
|
|
||||||
|
uint32_t timeOfCurrentKey;
|
||||||
|
uint32_t currentKeyId;
|
||||||
|
uint8_t* currentKey;
|
||||||
|
int currentKeySize;
|
||||||
|
|
||||||
|
int timeToNextKey;
|
||||||
|
};
|
||||||
|
|
||||||
|
static uint16_t poly[] = {
|
||||||
|
0x0000, 0x1189, 0x2312, 0x329b, 0x4624, 0x57ad, 0x6536, 0x74bf,
|
||||||
|
0x8c48, 0x9dc1, 0xaf5a, 0xbed3, 0xca6c, 0xdbe5, 0xe97e, 0xf8f7,
|
||||||
|
0x1081, 0x0108, 0x3393, 0x221a, 0x56a5, 0x472c, 0x75b7, 0x643e,
|
||||||
|
0x9cc9, 0x8d40, 0xbfdb, 0xae52, 0xdaed, 0xcb64, 0xf9ff, 0xe876,
|
||||||
|
0x2102, 0x308b, 0x0210, 0x1399, 0x6726, 0x76af, 0x4434, 0x55bd,
|
||||||
|
0xad4a, 0xbcc3, 0x8e58, 0x9fd1, 0xeb6e, 0xfae7, 0xc87c, 0xd9f5,
|
||||||
|
0x3183, 0x200a, 0x1291, 0x0318, 0x77a7, 0x662e, 0x54b5, 0x453c,
|
||||||
|
0xbdcb, 0xac42, 0x9ed9, 0x8f50, 0xfbef, 0xea66, 0xd8fd, 0xc974,
|
||||||
|
0x4204, 0x538d, 0x6116, 0x709f, 0x0420, 0x15a9, 0x2732, 0x36bb,
|
||||||
|
0xce4c, 0xdfc5, 0xed5e, 0xfcd7, 0x8868, 0x99e1, 0xab7a, 0xbaf3,
|
||||||
|
0x5285, 0x430c, 0x7197, 0x601e, 0x14a1, 0x0528, 0x37b3, 0x263a,
|
||||||
|
0xdecd, 0xcf44, 0xfddf, 0xec56, 0x98e9, 0x8960, 0xbbfb, 0xaa72,
|
||||||
|
0x6306, 0x728f, 0x4014, 0x519d, 0x2522, 0x34ab, 0x0630, 0x17b9,
|
||||||
|
0xef4e, 0xfec7, 0xcc5c, 0xddd5, 0xa96a, 0xb8e3, 0x8a78, 0x9bf1,
|
||||||
|
0x7387, 0x620e, 0x5095, 0x411c, 0x35a3, 0x242a, 0x16b1, 0x0738,
|
||||||
|
0xffcf, 0xee46, 0xdcdd, 0xcd54, 0xb9eb, 0xa862, 0x9af9, 0x8b70,
|
||||||
|
0x8408, 0x9581, 0xa71a, 0xb693, 0xc22c, 0xd3a5, 0xe13e, 0xf0b7,
|
||||||
|
0x0840, 0x19c9, 0x2b52, 0x3adb, 0x4e64, 0x5fed, 0x6d76, 0x7cff,
|
||||||
|
0x9489, 0x8500, 0xb79b, 0xa612, 0xd2ad, 0xc324, 0xf1bf, 0xe036,
|
||||||
|
0x18c1, 0x0948, 0x3bd3, 0x2a5a, 0x5ee5, 0x4f6c, 0x7df7, 0x6c7e,
|
||||||
|
0xa50a, 0xb483, 0x8618, 0x9791, 0xe32e, 0xf2a7, 0xc03c, 0xd1b5,
|
||||||
|
0x2942, 0x38cb, 0x0a50, 0x1bd9, 0x6f66, 0x7eef, 0x4c74, 0x5dfd,
|
||||||
|
0xb58b, 0xa402, 0x9699, 0x8710, 0xf3af, 0xe226, 0xd0bd, 0xc134,
|
||||||
|
0x39c3, 0x284a, 0x1ad1, 0x0b58, 0x7fe7, 0x6e6e, 0x5cf5, 0x4d7c,
|
||||||
|
0xc60c, 0xd785, 0xe51e, 0xf497, 0x8028, 0x91a1, 0xa33a, 0xb2b3,
|
||||||
|
0x4a44, 0x5bcd, 0x6956, 0x78df, 0x0c60, 0x1de9, 0x2f72, 0x3efb,
|
||||||
|
0xd68d, 0xc704, 0xf59f, 0xe416, 0x90a9, 0x8120, 0xb3bb, 0xa232,
|
||||||
|
0x5ac5, 0x4b4c, 0x79d7, 0x685e, 0x1ce1, 0x0d68, 0x3ff3, 0x2e7a,
|
||||||
|
0xe70e, 0xf687, 0xc41c, 0xd595, 0xa12a, 0xb0a3, 0x8238, 0x93b1,
|
||||||
|
0x6b46, 0x7acf, 0x4854, 0x59dd, 0x2d62, 0x3ceb, 0x0e70, 0x1ff9,
|
||||||
|
0xf78f, 0xe606, 0xd49d, 0xc514, 0xb1ab, 0xa022, 0x92b9, 0x8330,
|
||||||
|
0x7bc7, 0x6a4e, 0x58d5, 0x495c, 0x3de3, 0x2c6a, 0x1ef1, 0x0f78
|
||||||
|
};
|
||||||
|
|
||||||
|
/* see https://www.rfc-editor.org/rfc/rfc1662#page-19 */
|
||||||
|
static uint16_t
|
||||||
|
calculateCRC(uint8_t* data, int size)
|
||||||
|
{
|
||||||
|
uint16_t crc = 0xffff;
|
||||||
|
|
||||||
|
int i;
|
||||||
|
|
||||||
|
for (i = 0; i < size; i++) {
|
||||||
|
crc = (uint16_t)(((uint16_t)(crc >> 8)) ^ poly[(crc ^ data[i]) & 0xff]);
|
||||||
|
}
|
||||||
|
|
||||||
|
return (uint16_t)(~crc);
|
||||||
|
}
|
||||||
|
|
||||||
|
#if 0
|
||||||
|
int
|
||||||
|
main(int argc, char** argv)
|
||||||
|
{
|
||||||
|
uint8_t data[] = { 0x02, 0x07, 0x01, 0x03, 0x01, 0x02, 0x00, 0x34, 0x07, 0x07, 0x1C, 0x59, 0x34, 0x6F, 0xE1, 0x83, 0x00, 0x00, 0x41, 0x06, 0x06, 0x7B, 0x3C, 0xFF, 0xCF, 0x3C, 0xC0 };
|
||||||
|
|
||||||
|
uint16_t crc = calculateCRC(data, sizeof(data));
|
||||||
|
|
||||||
|
printf("CRC = %04x\n", crc);
|
||||||
|
printf("CRC = %04x\n", (uint16_t)(~crc));
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
|
||||||
|
uint16_t
|
||||||
|
L2Security_calculateCRC16(uint8_t* data, int size)
|
||||||
|
{
|
||||||
|
return calculateCRC(data, size);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* \brief Create the security extension
|
||||||
|
*
|
||||||
|
* \param buffer buffer with the encoded GOOSE message (security extension will be added)
|
||||||
|
* \param start start of the message payload used to calculate the MAC
|
||||||
|
* \param length length of the message payload
|
||||||
|
*
|
||||||
|
* \return length of the security extension
|
||||||
|
*/
|
||||||
|
uint16_t
|
||||||
|
L2Security_addSecurityExtension(L2Security self, uint8_t* buffer, int start, int length, int maxBufSize)
|
||||||
|
{
|
||||||
|
if (self->currentSigAlgo != MC_SEC_SIG_ALGO_NONE) {
|
||||||
|
bool hasIV = false;
|
||||||
|
int ivSize = 0;
|
||||||
|
int mACSize = 0;
|
||||||
|
|
||||||
|
/* determine length of the mAC */
|
||||||
|
if (self->currentSigAlgo == MC_SEC_SIG_ALGO_HMAC_SHA256_128) {
|
||||||
|
mACSize = 2 + 16;
|
||||||
|
}
|
||||||
|
else if (self->currentSigAlgo == MC_SEC_SIG_ALGO_HMAC_SHA256_256) {
|
||||||
|
mACSize = 2 + 32;
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
/* signature algorithm not supported */
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
uint32_t securityExtensionSize = 0;
|
||||||
|
|
||||||
|
/* TODO check for applicable/valid key */
|
||||||
|
|
||||||
|
/* determine length of the AuthenticationValue */
|
||||||
|
|
||||||
|
uint32_t authValueSize = 3; /* TLV(Version) */
|
||||||
|
|
||||||
|
/* TimeofCurrentKey */
|
||||||
|
authValueSize += (2 + BerEncoder_UInt32determineEncodedSize(self->timeOfCurrentKey));
|
||||||
|
|
||||||
|
/* TimeToNextKey */
|
||||||
|
authValueSize += (2 + BerEncoder_Int32determineEncodedSize(self->timeToNextKey));
|
||||||
|
|
||||||
|
/* IV */
|
||||||
|
if (hasIV) {
|
||||||
|
authValueSize += (2 + ivSize);
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Key ID */
|
||||||
|
authValueSize += (2 + BerEncoder_UInt32determineEncodedSize(self->currentKeyId));
|
||||||
|
|
||||||
|
securityExtensionSize += (1 + BerEncoder_determineLengthSize(authValueSize) + authValueSize);
|
||||||
|
securityExtensionSize += mACSize;
|
||||||
|
|
||||||
|
//TODO check that total size fits into the buffer!
|
||||||
|
|
||||||
|
int bufPos = start + length;
|
||||||
|
|
||||||
|
if (bufPos + securityExtensionSize > maxBufSize) {
|
||||||
|
printf("L2_SECURITY: security extension doesn't fit into message\n");
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* start encoding ... */
|
||||||
|
|
||||||
|
bufPos = BerEncoder_encodeTL(0xa0, securityExtensionSize, buffer, bufPos);
|
||||||
|
|
||||||
|
bufPos = BerEncoder_encodeTL(0xa4, authValueSize, buffer, bufPos);
|
||||||
|
|
||||||
|
//TODO encode AuthenticationValue content
|
||||||
|
|
||||||
|
/* Version */
|
||||||
|
bufPos = BerEncoder_encodeInt32WithTL(0x80, 1, buffer, bufPos);
|
||||||
|
|
||||||
|
/* TimeofCurrentKey */
|
||||||
|
bufPos = BerEncoder_encodeInt32WithTL(0x81, self->timeOfCurrentKey, buffer, bufPos);
|
||||||
|
|
||||||
|
/* TimeofNextKey */
|
||||||
|
bufPos = BerEncoder_encodeInt32WithTL(0x82, self->timeToNextKey, buffer, bufPos);
|
||||||
|
|
||||||
|
/* IV */
|
||||||
|
if (hasIV) {
|
||||||
|
//TODO encode IV
|
||||||
|
}
|
||||||
|
|
||||||
|
/* KeyID */
|
||||||
|
bufPos = BerEncoder_encodeInt32WithTL(0x84, self->currentKeyId, buffer, bufPos);
|
||||||
|
|
||||||
|
|
||||||
|
int macEnd = bufPos;
|
||||||
|
|
||||||
|
/* encode mAC */
|
||||||
|
bufPos = BerEncoder_encodeTL(0x85, mACSize - 2, buffer, bufPos);
|
||||||
|
|
||||||
|
if (self->currentSigAlgo == MC_SEC_SIG_ALGO_HMAC_SHA256_128) {
|
||||||
|
RSessionCrypto_createHMAC(buffer, macEnd, self->currentKey, self->currentKeySize, buffer + bufPos, 16);
|
||||||
|
bufPos += 16;
|
||||||
|
}
|
||||||
|
else if (self->currentSigAlgo == MC_SEC_SIG_ALGO_HMAC_SHA256_256) {
|
||||||
|
RSessionCrypto_createHMAC(buffer, macEnd, self->currentKey, self->currentKeySize, buffer + bufPos, 32);
|
||||||
|
bufPos += 32;
|
||||||
|
}
|
||||||
|
|
||||||
|
return securityExtensionSize;
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
L2Security
|
||||||
|
L2Security_create()
|
||||||
|
{
|
||||||
|
L2Security self = (L2Security)GLOBAL_CALLOC(1, sizeof(struct sL2Security));
|
||||||
|
|
||||||
|
if (self) {
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
return self;
|
||||||
|
}
|
||||||
|
|
||||||
|
MCKeyError
|
||||||
|
L2Security_addKey(L2Security self, uint32_t keyId, uint8_t* key, int keyLength, MCSecurityAlgorithm secAlgo, MCSignatureAlgorithm sigAlgo)
|
||||||
|
{
|
||||||
|
self->currentKeyId = keyId;
|
||||||
|
self->currentSigAlgo = sigAlgo;
|
||||||
|
self->currentKey = key;
|
||||||
|
self->currentKeySize = keyLength;
|
||||||
|
}
|
||||||
|
|
||||||
|
MCKeyError
|
||||||
|
L2Security_removeKey(L2Security self, uint32_t keyId)
|
||||||
|
{
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
void
|
||||||
|
L2Security_removeAllKeys(L2Security self)
|
||||||
|
{
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
RSessionError
|
||||||
|
L2Security_setActiveKey(L2Security self, uint32_t keyId)
|
||||||
|
{
|
||||||
|
self->currentKeyId = keyId;
|
||||||
|
}
|
||||||
|
|
||||||
|
void
|
||||||
|
L2Security_destroy(L2Security self)
|
||||||
|
{
|
||||||
|
if (self) {
|
||||||
|
GLOBAL_FREEMEM(self);
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -0,0 +1,122 @@
|
|||||||
|
/*
|
||||||
|
* l2_security.h
|
||||||
|
*
|
||||||
|
* Copyright 2022 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_L2_SECURITY_H_
|
||||||
|
#define LIBIEC61850_L2_SECURITY_H_
|
||||||
|
|
||||||
|
#include "libiec61850_common_api.h"
|
||||||
|
#include "r_session.h"
|
||||||
|
|
||||||
|
#ifdef __cplusplus
|
||||||
|
extern "C" {
|
||||||
|
#endif
|
||||||
|
|
||||||
|
typedef enum {
|
||||||
|
MULTICAST_KEY_ERROR_OK = 0,
|
||||||
|
MULTICAST_KEY_ERROR_INVALID_KEY = 1,
|
||||||
|
MULTICAST_KEY_ERROR_KEY_QUEUE_FULL = 2,
|
||||||
|
MULTICAST_KEY_ERROR_SEC_ALGO_NOT_SUPPORTED = 3,
|
||||||
|
MULTICAST_KEY_ERROR_SIG_ALGO_NOT_SUPPORTED = 4,
|
||||||
|
MULTICAST_KEY_ERROR_OUT_OF_MEMORY = 5,
|
||||||
|
MULTICAST_KEY_ERROR_INVALID_MESSAGE = 7,
|
||||||
|
MULTICAST_KEY_ERROR_SET_FAILED = 8
|
||||||
|
} MCKeyError;
|
||||||
|
|
||||||
|
typedef enum {
|
||||||
|
MC_SEC_SEC_ALGO_NONE = 0,
|
||||||
|
MC_SEC_SEC_ALGO_AES_128_GCM = 1,
|
||||||
|
MC_SEC_SEC_ALGO_AES_256_GCM = 2
|
||||||
|
} MCSecurityAlgorithm;
|
||||||
|
|
||||||
|
typedef enum {
|
||||||
|
MC_SEC_SIG_ALGO_NONE = 0,
|
||||||
|
MC_SEC_SIG_ALGO_HMAC_SHA256_80 = 1,
|
||||||
|
MC_SEC_SIG_ALGO_HMAC_SHA256_128 = 2,
|
||||||
|
MC_SEC_SIG_ALGO_HMAC_SHA256_256 = 3,
|
||||||
|
MC_SEC_SIG_ALGO_AES_GMAC_64 = 4,
|
||||||
|
MC_SEC_SIG_ALGO_AES_GMAC_128 = 5,
|
||||||
|
MC_SEC_SIG_ALGO_HMAC_SHA3_80 = 6,
|
||||||
|
MC_SEC_SIG_ALGO_HMAC_SHA3_128 = 7,
|
||||||
|
MC_SEC_SIG_ALGO_HMAC_SHA3_256 = 8
|
||||||
|
} MCSignatureAlgorithm;
|
||||||
|
|
||||||
|
typedef enum
|
||||||
|
{
|
||||||
|
MC_SEC_KEY_EVENT__NEED_KEY = 1
|
||||||
|
} MCKeyEvent;
|
||||||
|
|
||||||
|
typedef void (*MC_KeyEventHandler) (void* parameter, RSession rSession, MCKeyEvent event, uint32_t keyID);
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
typedef struct sL2Security* L2Security;
|
||||||
|
|
||||||
|
LIB61850_API L2Security
|
||||||
|
L2Security_create();
|
||||||
|
|
||||||
|
LIB61850_API MCKeyError
|
||||||
|
L2Security_addKey(L2Security self, uint32_t keyId, uint8_t* key, int keyLength, MCSecurityAlgorithm secAlgo, MCSignatureAlgorithm sigAlgo);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* \brief Remove key from the list of accepted keys
|
||||||
|
*
|
||||||
|
* \param self the MulticastKeystore instance
|
||||||
|
* \param keyId the key ID is unique for the security association
|
||||||
|
*/
|
||||||
|
LIB61850_API MCKeyError
|
||||||
|
L2Security_removeKey(L2Security self, uint32_t keyId);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* \brief Remove all keys from the list of accepted keys
|
||||||
|
*
|
||||||
|
* \param self the L2Security instance
|
||||||
|
*/
|
||||||
|
void
|
||||||
|
L2Security_removeAllKeys(L2Security self);
|
||||||
|
|
||||||
|
LIB61850_API RSessionError
|
||||||
|
L2Security_setActiveKey(L2Security self, uint32_t keyId);
|
||||||
|
|
||||||
|
uint16_t
|
||||||
|
L2Security_calculateCRC16(uint8_t* data, int size);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* \brief Create the security extension
|
||||||
|
*
|
||||||
|
* \param buffer buffer with the encoded GOOSE message (security extension will be added)
|
||||||
|
* \param start start of the message payload used to calculate the MAC
|
||||||
|
* \param length length of the message payload
|
||||||
|
*
|
||||||
|
* \return length of the security extension
|
||||||
|
*/
|
||||||
|
uint16_t
|
||||||
|
L2Security_addSecurityExtension(L2Security self, uint8_t* buffer, int start, int length, int maxBufSize);
|
||||||
|
|
||||||
|
LIB61850_API void
|
||||||
|
L2Security_destroy(L2Security self);
|
||||||
|
|
||||||
|
#ifdef __cplusplus
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#endif /* LIBIEC61850_L2_SECURITY_H_ */
|
||||||
Loading…
Reference in New Issue