libs2opc_client_internal.h

Go to the documentation of this file.

/*
 * Licensed to Systerel under one or more contributor license
 * agreements. See the NOTICE file distributed with this work
 * for additional information regarding copyright ownership.
 * Systerel licenses this file to you under the Apache
 * License, Version 2.0 (the "License"); you may not use this
 * file except in compliance with the License. You may obtain
 * a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
 
#ifndef LIBS2OPC_CLIENT_INTERNAL_H_
#define LIBS2OPC_CLIENT_INTERNAL_H_
 
#include <stdbool.h>
 
#include "libs2opc_client.h"
 
#include "sopc_mutexes.h"
#include "sopc_toolkit_config.h"
#include "sopc_user_app_itf.h"
 
// The client helper dedicated configuration in addition to configuration ::SOPC_S2OPC_Config
typedef struct SOPC_ClientHelper_Config
{
    // Flag atomically set when the structure is initialized during call to SOPC_ClientConfigHelper_Initialize
    // and singleton config is initialized
    int32_t initialized;
    SOPC_Mutex configMutex;
    SOPC_Condition reverseEPsClosedCond;
 
    SOPC_ClientConnection* secureConnections[SOPC_MAX_CLIENT_SECURE_CONNECTIONS_CONFIG];
    SOPC_ReverseEndpointConfigIdx
        configuredReverseEndpointsToCfgIdx[SOPC_MAX_CLIENT_SECURE_CONNECTIONS_CONFIG]; // Max 1 per secure connection
    bool openedReverseEndpointsFromCfgIdx[SOPC_MAX_ENDPOINT_DESCRIPTION_CONFIGURATIONS +
                                          1]; // index is valid
                                              // (SOPC_ReverseEndpointConfigIdx -
                                              // SOPC_MAX_ENDPOINT_DESCRIPTION_CONFIGURATIONS)
                                              // : ]0 : SOPC_MAX_ENDPOINT_DESCRIPTION_CONFIGURATIONS]
 
    SOPC_ServiceAsyncResp_Fct* asyncRespCb;
 
    SOPC_GetPassword_Fct* getClientKeyPasswordCb;
 
    SOPC_GetClientUserKeyPassword_Fct* getUserKeyPasswordCb;
    SOPC_GetClientUserNamePassword_Fct* getUserNamePasswordCb;
} SOPC_ClientHelper_Config;
 
// The singleton configuration structure
extern SOPC_ClientHelper_Config sopc_client_helper_config;
 
// Returns true if the client is initialize, false otherwise
bool SOPC_ClientInternal_IsInitialized(void);
 
void SOPC_ClientInternal_ToolkitEventCallback(SOPC_App_Com_Event event,
                                              uint32_t IdOrStatus,
                                              void* param,
                                              uintptr_t appContext);
 
// Finalize the SecureChannel configuration by parsing the necessary files
SOPC_ReturnStatus SOPC_ClientConfigHelper_Finalize_SecureConnectionConfig(SOPC_Client_Config* cConfig,
                                                                          SOPC_SecureConnection_Config* secConnConfig);
 
bool SOPC_ClientInternal_GetClientKeyPassword(char** outPassword);
 
bool SOPC_ClientInternal_IsEncryptedClientKey(void);
 
bool SOPC_ClientInternal_GetUserKeyPassword(const SOPC_SecureConnection_Config* secConnConfig,
                                            const char* cert1Sha1,
                                            char** outPassword);
 
bool SOPC_ClientInternal_GetUserNamePassword(const SOPC_SecureConnection_Config* secConnConfig,
                                             char** outUserName,
                                             char** outPassword);
 
uint32_t SOPC_ClientInternal_GetReverseEPcfgIdxNoOffset(SOPC_ReverseEndpointConfigIdx rEPcfgIdx);
 
void SOPC_ClientInternal_KeyCertPairUpdateCb(uintptr_t updateParam);
 
void SOPC_ClientInternal_PKIProviderUpdateCb(uintptr_t updateParam);
 
#endif /* LIBS2OPC_CLIENT_INTERNAL_H_ */