tase2_endpoint.h

Go to the documentation of this file.

/*
 *  tase2_endpoint.h
 *
 *  This file is part of libtase2
 *
 *  Copyright 2017-2023 Michael Zillgith
 *
 *  All rights reserved.
 */
 
#ifndef TASE2_ENDPOINT_H_
#define TASE2_ENDPOINT_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "iso_connection_parameters.h"
#include "tls_config.h"
#include "asecurity.h"
 
typedef struct sTase2_BilateralTable* Tase2_BilateralTable;
 
typedef struct sTase2_Endpoint* Tase2_Endpoint;
 
typedef struct sTase2_Endpoint_Connection* Tase2_Endpoint_Connection;
 
typedef enum
{
    TASE2_ENDPOINT_STATE_IDLE = 0,
 
    TASE2_ENDPOINT_STATE_LISTENING = 1,
 
    TASE2_ENDPOINT_STATE_CONNECTED = 2,
 
    TASE2_ENDPOINT_STATE_CONNECTING = 3,
 
    TASE2_ENDPOINT_STATE_ERROR = 4
} Tase2_Endpoint_State;
 
typedef enum
{
    TASE2_ALS_MODE_UNSECURE = 0,
 
    TASE2_ALS_MODE_BOTH = 1,
 
    TASE2_ALS_MODE_SECURE = 2
} Tase2_ALS_Mode;
 
typedef struct sTase2_Client* Tase2_Client;
 
typedef struct sTase2_Server* Tase2_Server;
 
typedef struct
{
    uint8_t size; 
    uint8_t value[16]; 
} Tase2_TSelector;
 
typedef struct
{
    uint8_t size; 
    uint8_t value[16]; 
} Tase2_SSelector;
 
typedef struct
{
    uint8_t size; 
    uint8_t value[16]; 
} Tase2_PSelector;
 
typedef struct sTase2_ApplicationAddress* Tase2_ApplicationAddress;
 
struct sTase2_ApplicationAddress
{
    unsigned int hasAeQualifier:1;
    unsigned int hasAeInvocationId:1;
    unsigned int hasApInvocationId:1;
 
    ItuObjectIdentifier apTitle;
    int aeQualifier;
    int aeInvocationId;
    int apInvocationId;
    Tase2_PSelector pSelector;
    Tase2_SSelector sSelector;
    Tase2_TSelector tSelector;
};
 
typedef void (*Tase2_Endpoint_StateChangedHandler) (Tase2_Endpoint endpoint, void* parameter, Tase2_Endpoint_State newState);
 
typedef void (*Tase2_Endpoint_ConnectionHandler) (Tase2_Endpoint endpoint, void* parameter, Tase2_Endpoint_Connection connection, bool connect);
 
TASE2_API Tase2_Endpoint
Tase2_Endpoint_create(TLSConfiguration tlsConfig, bool passive);
 
TASE2_API bool
Tase2_Endpoint_isPassive(Tase2_Endpoint self);
 
TASE2_API void
Tase2_Endpoint_setTLSConfiguration(Tase2_Endpoint self, TLSConfiguration tlsConfig);
 
TASE2_API void
Tase2_Endpoint_setALSMode(Tase2_Endpoint self, Tase2_ALS_Mode mode);
 
TASE2_API void
Tase2_Endpoint_setALSConfiguration(Tase2_Endpoint self, ASecurityConfiguration secConfig);
 
TASE2_API void
Tase2_Endpoint_setStateChangedHandler(Tase2_Endpoint self, Tase2_Endpoint_StateChangedHandler handler, void* parameter);
 
TASE2_API void
Tase2_Endpoint_setConnectionHandler(Tase2_Endpoint self, Tase2_Endpoint_ConnectionHandler handler, void* parameter);
 
typedef enum
{
    TASE2_AUTH_TYPE_NONE = 0,
 
    TASE2_AUTH_TYPE_PASSWORD = 1,
 
    TASE2_AUTH_TYPE_CERTIFICATE = 2,
 
    TASE2_AUTH_TYPE_TLS = 3,
 
    TASE2_AUTH_TYPE_UNKNOWN = 99
} Tase2_AuthenticationMethod;
 
typedef bool (*Tase2_Endpoint_ConnectionAcceptHandler) (Tase2_Endpoint endpoint, void* parameter, const char* peerAddress, Tase2_BilateralTable clientBlt,
        Tase2_AuthenticationMethod authType, uint8_t* authValue, int authValLen);
 
TASE2_API void
Tase2_Endpoint_setConnectionAcceptHandler(Tase2_Endpoint self, Tase2_Endpoint_ConnectionAcceptHandler handler, void* parameter);
 
typedef ASecurityConfiguration (*Tase2_Endpoint_ALSConfigurationProvider) (Tase2_Endpoint endpoint, void* parameter, const char* peerAddress,
    Tase2_ApplicationAddress localApAddr, Tase2_ApplicationAddress remoteApAddr);
 
TASE2_API void
Tase2_Endpoint_setALSConfigurationProvider(Tase2_Endpoint self, Tase2_Endpoint_ALSConfigurationProvider provider, void* parameter);
 
TASE2_API void
Tase2_Endpoint_setAddressMatchingRules(Tase2_Endpoint self, bool apTitle, bool aeQualifier, bool pSelector, bool sSelector, bool tSelector);
 
TASE2_API void
Tase2_Endpoint_setIdentity(Tase2_Endpoint self, const char* vendor, const char* model, const char* revision);
 
TASE2_API Tase2_ApplicationAddress
Tase2_Endpoint_getLocalApplicationAddress(Tase2_Endpoint self);
 
TASE2_API void
Tase2_Endpoint_setLocalApTitle(Tase2_Endpoint self, const char* apTitle, int aeQualifier);
 
TASE2_API void
Tase2_Endpoint_setLocalAddresses(Tase2_Endpoint self, Tase2_PSelector pSelector, Tase2_SSelector sSelector, Tase2_TSelector tSelector);
 
TASE2_API void
Tase2_Endpoint_setLocalIpAddress(Tase2_Endpoint self, const char* ipAddress);
 
TASE2_API void
Tase2_Endpoint_setLocalTcpPort(Tase2_Endpoint self, int tcpPort);
 
TASE2_API void
Tase2_Endpoint_setLocalApTitleEx(Tase2_Endpoint self, const char* apTitle);
 
TASE2_API void
Tase2_Endpoint_setLocalAeQualifier(Tase2_Endpoint self, int aeQualifier);
 
TASE2_API void
Tase2_Endpoint_setLocalAeInvocationId(Tase2_Endpoint self, int aeInvocationId);
 
TASE2_API void
Tase2_Endpoint_setLocalApInvocationId(Tase2_Endpoint self, int apInvocationId);
 
 
TASE2_API Tase2_ApplicationAddress
Tase2_Endpoint_getRemoteApplicationAddress(Tase2_Endpoint self);
 
TASE2_API void
Tase2_Endpoint_setRemoteApTitle(Tase2_Endpoint self, const char* apTitle, int aeQualifier);
 
TASE2_API void
Tase2_Endpoint_setRemoteAddresses(Tase2_Endpoint self, Tase2_PSelector pSelector, Tase2_SSelector sSelector, Tase2_TSelector tSelector);
 
TASE2_API void
Tase2_Endpoint_setRemoteIpAddress(Tase2_Endpoint self, const char* ipAddress);
 
TASE2_API void
Tase2_Endpoint_setRemoteTcpPort(Tase2_Endpoint self, int tcpPort);
 
TASE2_API void
Tase2_Endpoint_setRemoteApTitleEx(Tase2_Endpoint self, const char* apTitle);
 
TASE2_API void
Tase2_Endpoint_setRemoteAeQualifier(Tase2_Endpoint self, int aeQualifier);
 
TASE2_API void
Tase2_Endpoint_setRemoteAeInvocationId(Tase2_Endpoint self, int aeInvocationId);
 
TASE2_API void
Tase2_Endpoint_setRemoteApInvocationId(Tase2_Endpoint self, int apInvocationId);
 
TASE2_API void
Tase2_Endpoint_setMaxMmsPduSize(Tase2_Endpoint self, int maxPduSize);
 
TASE2_API void
Tase2_Endpoint_setMaxServOutstandingCalling(Tase2_Endpoint self, int value);
 
TASE2_API void
Tase2_Endpoint_setMaxServOutstandingCalled(Tase2_Endpoint self, int value);
 
TASE2_API void
Tase2_Endpoint_setRequestTimeout(Tase2_Endpoint self, int timeoutInMs);
 
TASE2_API void
Tase2_Endpoint_setWriteTimeout(Tase2_Endpoint self, int timeoutInMs);
 
TASE2_API void
Tase2_Endpoint_setConnectTimeout(Tase2_Endpoint self, int timeoutInMs);
 
TASE2_API void
Tase2_Endpoint_connect(Tase2_Endpoint self);
 
TASE2_API void
Tase2_Endpoint_disconnect(Tase2_Endpoint self, int disconnectMethod);
 
TASE2_API void
Tase2_Endpoint_disconnectPeer(Tase2_Endpoint self, const char* peerIpAddress);
 
TASE2_API bool
Tase2_Endpoint_isConnected(Tase2_Endpoint self);
 
TASE2_API int
Tase2_Endpoint_connectedPeers(Tase2_Endpoint self);
 
TASE2_API bool
Tase2_Endpoint_waitForState(Tase2_Endpoint self, Tase2_Endpoint_State state, int timeoutInMs);
 
TASE2_API Tase2_Endpoint_State
Tase2_Endpoint_getState(Tase2_Endpoint self);
 
TASE2_API void
Tase2_Endpoint_addServer(Tase2_Endpoint self, Tase2_Server server);
 
TASE2_API Tase2_Server
Tase2_Endpoint_removeServer(Tase2_Endpoint self, Tase2_Server server);
 
 
TASE2_API Tase2_Client
Tase2_Endpoint_removeClient(Tase2_Endpoint self, Tase2_Client client);
 
TASE2_API void
Tase2_Endpoint_destroy(Tase2_Endpoint self);
 
TASE2_API const char*
Tase2_Endpoint_getId(Tase2_Endpoint self);
 
TASE2_API void
Tase2_Endpoint_setId(Tase2_Endpoint self, const char* id);
 
TASE2_API char*
Tase2_Endpoint_Connection_getPeerIpAddress(Tase2_Endpoint_Connection self);
 
TASE2_API char*
Tase2_Endpoint_Connection_getPeerApTitle(Tase2_Endpoint_Connection self);
 
TASE2_API Tase2_TSelector*
Tase2_Endpoint_Connection_getPeerTSel(Tase2_Endpoint_Connection self);
 
TASE2_API Tase2_SSelector*
Tase2_Endpoint_Connection_getPeerSSel(Tase2_Endpoint_Connection self);
 
TASE2_API Tase2_PSelector*
Tase2_Endpoint_Connection_getPeerPSel(Tase2_Endpoint_Connection self);
 
TASE2_API int
Tase2_Endpoint_Connection_getPeerAeQualifier(Tase2_Endpoint_Connection self);
 
TASE2_API int
Tase2_Endpoint_Connection_getMaxPduSize(Tase2_Endpoint_Connection self);
 
#ifdef __cplusplus
}
#endif
 
#endif /* TASE2_ENDPOINT_H_ */