S2OPC OPCUA Toolkit
Loading...
Searching...
No Matches
sopc_sk_builder.h
Go to the documentation of this file.
1/*
2 * Licensed to Systerel under one or more contributor license
3 * agreements. See the NOTICE file distributed with this work
4 * for additional information regarding copyright ownership.
5 * Systerel licenses this file to you under the Apache
6 * License, Version 2.0 (the "License"); you may not use this
7 * file except in compliance with the License. You may obtain
8 * a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19
28#ifndef SOPC_SK_BUILDER_H_
29#define SOPC_SK_BUILDER_H_
30
31#include <stdbool.h>
32#include <stdint.h>
33
34#include "sopc_builtintypes.h"
35#include "sopc_enums.h"
36#include "sopc_sk_manager.h"
37#include "sopc_sk_provider.h"
38
39#define SOPC_SK_BUILDER_NB_GENERATED_KEYS 5
40
42
44typedef void (*SOPC_SKBuilder_Clear_Func)(void* data);
45
51{
52 SOPC_SKBuilder_Update_Func ptrUpdate; /* Function to update keys of a SK Manager */
53 SOPC_SKBuilder_Clear_Func ptrClear; /* Function to clear data */
54 void* data; /* data bytes */
55};
56
63
73
80
90
97
98#endif /* SOPC_SK_BUILDER_H_ */
enum _SOPC_ReturnStatus SOPC_ReturnStatus
Common enumerations for S2OPC.
SOPC_SKBuilder * SOPC_SKBuilder_Append_Create(void)
Creates an instance of a default SOPC_SKBuilder which append data to the Security Keys Manager.
SOPC_ReturnStatus(* SOPC_SKBuilder_Update_Func)(SOPC_SKBuilder *skb, SOPC_SKProvider *skp, SOPC_SKManager *skm)
Definition sopc_sk_builder.h:43
SOPC_ReturnStatus SOPC_SKBuilder_Update(SOPC_SKBuilder *skb, SOPC_SKProvider *skp, SOPC_SKManager *skm)
Gets Keys from a Security Keys Provider and fill Security Keys Manager.
void(* SOPC_SKBuilder_Clear_Func)(void *data)
Definition sopc_sk_builder.h:44
SOPC_SKBuilder * SOPC_SKBuilder_Setter_Create(void)
Creates an instance of a default SOPC_SKBuilder which replaces all the keys.
SOPC_SKBuilder * SOPC_SKBuilder_Truncate_Create(SOPC_SKBuilder *skb, uint32_t sizeMax)
Creates an instance of a default SOPC_SKBuilder which deletes old keys.
void SOPC_SKBuilder_Clear(SOPC_SKBuilder *skb)
Deallocates Security Keys Builder data bytes content.
Security Keys Manager: manages local storage of the keys retrieved from the Security Keys Provider fo...
Security Keys Provider: source providing the keys for SKS.
Bytes Security Keys Builder structure.
Definition sopc_sk_builder.h:51
SOPC_SKBuilder_Clear_Func ptrClear
Definition sopc_sk_builder.h:53
SOPC_SKBuilder_Update_Func ptrUpdate
Definition sopc_sk_builder.h:52
void * data
Definition sopc_sk_builder.h:54
Definition sopc_sk_manager.h:86
Security Keys Provider structure.
Definition sopc_sk_provider.h:56