iso_connection_parameters.h

Go to the documentation of this file.

/*
 *  iso_connection_parameters.h
 *
 *  Copyright 2013-2023 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 ISO_CONNECTION_PARAMETERS_H_
#define ISO_CONNECTION_PARAMETERS_H_
 
#ifndef CONFIG_MMS_SUPPORT_TLS
#define CONFIG_MMS_SUPPORT_TLS 0
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "tls_config.h"
 
typedef enum
{
    ACSE_AUTH_NONE = 0,
 
    ACSE_AUTH_PASSWORD = 1,
 
    ACSE_AUTH_CERTIFICATE = 2,
 
    ACSE_AUTH_TLS = 3
} AcseAuthenticationMechanism;
 
 
typedef struct sAcseAuthenticationParameter* AcseAuthenticationParameter;
 
struct sAcseAuthenticationParameter
{
    AcseAuthenticationMechanism mechanism;
 
    union
    {
        struct
        {
            uint8_t* octetString;
            int passwordLength;
        } password; /* for mechanism = ACSE_AUTH_PASSWORD */
 
        struct
        {
            uint8_t* buf;
            int length;
        } certificate; /* for mechanism = ACSE_AUTH_CERTIFICATE or ACSE_AUTH_TLS */
 
    } value;
};
 
LIB61850_API AcseAuthenticationParameter
AcseAuthenticationParameter_create(void);
 
LIB61850_API void
AcseAuthenticationParameter_destroy(AcseAuthenticationParameter self);
 
LIB61850_API void
AcseAuthenticationParameter_setAuthMechanism(AcseAuthenticationParameter self, AcseAuthenticationMechanism mechanism);
 
LIB61850_API void
AcseAuthenticationParameter_setPassword(AcseAuthenticationParameter self, char* password);
 
 
typedef bool
(*AcseAuthenticator)(void* parameter, AcseAuthenticationParameter authParameter, void** securityToken, IsoApplicationReference* appReference);
 
typedef struct {
    uint8_t size; 
    uint8_t value[4]; 
} TSelector;
 
typedef struct {
    uint8_t size; 
    uint8_t value[16]; 
} SSelector;
 
typedef struct {
    uint8_t size; 
    uint8_t value[16]; 
} PSelector;
 
struct sIsoConnectionParameters
{
    AcseAuthenticationParameter acseAuthParameter;
 
#if (CONFIG_MMS_SUPPORT_TLS == 1)
    TLSConfiguration tlsConfiguration;
#endif
 
    const char* hostname;
    int tcpPort;
 
    const char* localIpAddress;
    int localTcpPort;
 
    uint8_t remoteApTitle[10];
    int remoteApTitleLen;
    int remoteAEQualifier;
    PSelector remotePSelector;
    SSelector remoteSSelector;
    TSelector remoteTSelector;
 
 
    uint8_t localApTitle[10];
    int localApTitleLen;
    int localAEQualifier;
    PSelector localPSelector;
    SSelector localSSelector;
    TSelector localTSelector;
 
};
 
typedef struct sIsoConnectionParameters* IsoConnectionParameters;
 
LIB61850_API IsoConnectionParameters
IsoConnectionParameters_create(void);
 
LIB61850_API void
IsoConnectionParameters_destroy(IsoConnectionParameters self);
 
 
LIB61850_API void
IsoConnectionParameters_setTlsConfiguration(IsoConnectionParameters self, TLSConfiguration tlsConfig);
 
LIB61850_API void
IsoConnectionParameters_setAcseAuthenticationParameter(IsoConnectionParameters self,
        AcseAuthenticationParameter acseAuthParameter);
 
LIB61850_API void
IsoConnectionParameters_setTcpParameters(IsoConnectionParameters self, const char* hostname, int tcpPort);
 
LIB61850_API void
IsoConnectionParameters_setLocalTcpParameters(IsoConnectionParameters self, const char* localIpAddress, int localTcpPort);
 
LIB61850_API void
IsoConnectionParameters_setRemoteApTitle(IsoConnectionParameters self, const char* apTitle, int aeQualifier);
 
LIB61850_API void
IsoConnectionParameters_setRemoteAddresses(IsoConnectionParameters self, PSelector pSelector, SSelector sSelector, TSelector tSelector);
 
LIB61850_API void
IsoConnectionParameters_setLocalApTitle(IsoConnectionParameters self, const char* apTitle, int aeQualifier);
 
LIB61850_API void
IsoConnectionParameters_setLocalAddresses(IsoConnectionParameters self, PSelector pSelector, SSelector sSelector, TSelector tSelector);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ISO_CONNECTION_PARAMETERS_H_ */