sopc_pubsub_security.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 SOPC_PUBSUB_SECURITY_H_
#define SOPC_PUBSUB_SECURITY_H_
 
#include "sopc_crypto_provider.h"
#include "sopc_enums.h"
#include "sopc_pubsub_conf.h"
#include "sopc_pubsub_sks.h"
 
typedef struct SOPC_PubSub_SecurityType
{
    SOPC_SecurityMode_Type mode;
    SOPC_CryptoProvider* provider;
    SOPC_PubSubSKS_Keys* groupKeys;
    SOPC_ExposedBuffer* msgNonceRandom;
    uint32_t sequenceNumber;
} SOPC_PubSub_SecurityType;
 
typedef SOPC_PubSub_SecurityType* SOPC_UADP_GetSecurity_Func(uint32_t tokenId,
                                                             SOPC_Conf_PublisherId pub_id,
                                                             uint16_t writerGroupId);
 
void SOPC_PubSub_Security_Clear(SOPC_PubSub_SecurityType* security);
 
SOPC_Buffer* SOPC_PubSub_Security_Encrypt(const SOPC_PubSub_SecurityType* security, SOPC_Buffer* payload);
 
SOPC_Buffer* SOPC_PubSub_Security_Decrypt(const SOPC_PubSub_SecurityType* keys, SOPC_Buffer* src, uint32_t size);
 
SOPC_ReturnStatus SOPC_PubSub_Security_GetSignSize(const SOPC_PubSub_SecurityType* security,
                                                   bool enabled,
                                                   uint32_t* length);
 
SOPC_ReturnStatus SOPC_PubSub_Security_Sign(const SOPC_PubSub_SecurityType* security, SOPC_Buffer* src);
 
bool SOPC_PubSub_Security_Verify(const SOPC_PubSub_SecurityType* security, SOPC_Buffer* src, uint32_t payloadPosition);
 
SOPC_ExposedBuffer* SOPC_PubSub_Security_Random(const SOPC_CryptoProvider* provider);
 
#endif /* SOPC_PUBSUB_SECURITY_H_ */