libs2opc_client_config_custom.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_CONFIG_CUSTOM_H_
#define LIBS2OPC_CLIENT_CONFIG_CUSTOM_H_
 
#include <stdbool.h>
 
#include "libs2opc_client_config.h"
#include "libs2opc_common_config.h"
 
SOPC_ReturnStatus SOPC_ClientConfigHelper_SetPreferredLocaleIds(size_t nbLocales, const char** localeIds);
 
SOPC_ReturnStatus SOPC_ClientConfigHelper_SetApplicationDescription(const char* applicationUri,
                                                                    const char* productUri,
                                                                    const char* defaultAppName,
                                                                    const char* defaultAppNameLocale,
                                                                    OpcUa_ApplicationType applicationType);
 
SOPC_ReturnStatus SOPC_ClientConfigHelper_SetPKIprovider(SOPC_PKIProvider* pki);
 
SOPC_ReturnStatus SOPC_ClientConfigHelper_SetKeyCertPairFromPath(const char* clientCertPath,
                                                                 const char* clientKeyPath,
                                                                 bool encrypted);
 
SOPC_ReturnStatus SOPC_ClientConfigHelper_SetKeyCertPairFromBytes(size_t certificateNbBytes,
                                                                  const unsigned char* clientCertificate,
                                                                  size_t keyNbBytes,
                                                                  const unsigned char* clientPrivateKey);
 
SOPC_SecureConnection_Config* SOPC_ClientConfigHelper_CreateSecureConnection(const char* userDefinedId,
                                                                             const char* endpointUrl,
                                                                             OpcUa_MessageSecurityMode secuMode,
                                                                             SOPC_SecurityPolicy_URI secuPolicy);
 
SOPC_ReturnStatus SOPC_SecureConnectionConfig_SetExpectedEndpointsDescription(
    SOPC_SecureConnection_Config* secConnConfig,
    const OpcUa_GetEndpointsResponse* getEndpointsResponse);
 
SOPC_ReturnStatus SOPC_SecureConnectionConfig_SetReverseConnection(SOPC_SecureConnection_Config* secConnConfig,
                                                                   const char* clientReverseEndpointUri);
 
SOPC_ReturnStatus SOPC_SecureConnectionConfig_SetReqLifetime(SOPC_SecureConnection_Config* secConnConfig,
                                                             uint32_t reqLifetime);
 
SOPC_ReturnStatus SOPC_SecureConnectionConfig_SetServerCertificateFromPath(SOPC_SecureConnection_Config* secConnConfig,
                                                                           const char* serverCertPath);
 
SOPC_ReturnStatus SOPC_SecureConnectionConfig_SetServerCertificateFromBytes(SOPC_SecureConnection_Config* secConnConfig,
                                                                            size_t certificateNbBytes,
                                                                            const unsigned char* serverCertificate);
 
SOPC_ReturnStatus SOPC_SecureConnectionConfig_SetAnonymous(SOPC_SecureConnection_Config* secConnConfig,
                                                           const char* userPolicyId);
 
SOPC_ReturnStatus SOPC_SecureConnectionConfig_SetUserName(SOPC_SecureConnection_Config* secConnConfig,
                                                          const char* userPolicyId,
                                                          const char* userName,
                                                          const char* password);
 
SOPC_ReturnStatus SOPC_SecureConnectionConfig_SetUserX509FromPaths(SOPC_SecureConnection_Config* secConnConfig,
                                                                   const char* userPolicyId,
                                                                   const char* userCertPath,
                                                                   const char* userKeyPath,
                                                                   bool encrypted);
 
SOPC_ReturnStatus SOPC_SecureConnectionConfig_SetUserX509FromBytes(SOPC_SecureConnection_Config* secConnConfig,
                                                                   const char* userPolicyId,
                                                                   size_t certificateNbBytes,
                                                                   const unsigned char* userCertificate,
                                                                   size_t keyNbBytes,
                                                                   const unsigned char* userPrivateKey);
 
SOPC_ReturnStatus SOPC_SecureConnectionConfig_SetServerCertUpdateCb(SOPC_SecureConnection_Config* secConnConfig,
                                                                    SOPC_KeyCertPairUpdateCb* serverCertUpdateCb,
                                                                    uintptr_t updateParam);
 
SOPC_ReturnStatus SOPC_ClientConfigHelper_GetSecureConnectionConfigs(size_t* nbScConfigs,
                                                                     SOPC_SecureConnection_Config*** scConfigArray);
 
#endif