sopc_sk_manager.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_SK_MANAGER_H_
#define SOPC_SK_MANAGER_H_
 
#include <stdbool.h>
#include <stdint.h>
 
#include "sopc_builtintypes.h"
#include "sopc_enums.h"
 
#ifndef SOPC_SK_MANAGER_CURRENT_TOKEN_ID
#define SOPC_SK_MANAGER_CURRENT_TOKEN_ID 0
#endif
 
/* Default KeyLifetime 1 hour */
#ifndef SOPC_SK_MANAGER_DEFAULT_KEYLIFETIME
#define SOPC_SK_MANAGER_DEFAULT_KEYLIFETIME (60 * 60 * 1000)
#endif
 
#ifndef SOPC_SK_MANAGER_DEFAULT_INITIAL_SIZE
#define SOPC_SK_MANAGER_DEFAULT_INITIAL_SIZE 10
#endif
 
typedef struct SOPC_SKManager SOPC_SKManager;
 
typedef uint32_t (*SOPC_SKManager_GetSize_Func)(SOPC_SKManager* skm);
 
typedef SOPC_ReturnStatus (*SOPC_SKManager_SetKeyLifetime_Func)(SOPC_SKManager* skm, uint32_t KeyLifetime);
 
typedef uint32_t (*SOPC_SKManager_GetAllKeysLifeTime_Func)(SOPC_SKManager* skm);
 
typedef SOPC_ReturnStatus (*SOPC_SKManager_SetSecurityPolicyUri_Func)(SOPC_SKManager* skm,
                                                                      SOPC_String* SecurityPolicyUri);
 
typedef SOPC_ReturnStatus (*SOPC_SKManager_SetKeys_Func)(SOPC_SKManager* skm,
                                                         SOPC_String* SecurityPolicyUri,
                                                         uint32_t FirstTokenId,
                                                         SOPC_ByteString* Keys,
                                                         uint32_t NbKeys,
                                                         uint32_t TimeToNextKey,
                                                         uint32_t KeyLifetime);
typedef uint32_t (*SOPC_SKManager_AddKeys_Func)(SOPC_SKManager* skm, SOPC_ByteString* Keys, uint32_t NbToken);
 
typedef SOPC_ReturnStatus (*SOPC_SKManager_GetKeys_Func)(SOPC_SKManager* skm,
                                                         uint32_t StartingTokenId,
                                                         uint32_t NbRequestedToken,
                                                         SOPC_String** SecurityPolicyUri,
                                                         uint32_t* FirstTokenId,
                                                         SOPC_ByteString** Keys,
                                                         uint32_t* NbKeys,
                                                         uint32_t* TimeToNextKey,
                                                         uint32_t* KeyLifetime);
typedef void (*SOPC_SKManager_Clear_Func)(SOPC_SKManager* skm);
 
struct SOPC_SKManager
{
    SOPC_SKManager_GetSize_Func ptrSize;                   /* number of token */
    SOPC_SKManager_SetKeyLifetime_Func ptrSetKeyLifetime;  
    SOPC_SKManager_SetSecurityPolicyUri_Func ptrSetPolicy; 
    SOPC_SKManager_SetKeys_Func ptrSetKeys;                
    SOPC_SKManager_AddKeys_Func ptrAddKeys;                
    SOPC_SKManager_GetKeys_Func ptrGetKeys;                
    SOPC_SKManager_GetAllKeysLifeTime_Func ptrGetAllKeysLifeTime;
    SOPC_SKManager_Clear_Func ptrClear; 
    void* data;                         
};
 
SOPC_SKManager* SOPC_SKManager_Create(void);
 
uint32_t SOPC_SKManager_Size(SOPC_SKManager* skm);
 
SOPC_ReturnStatus SOPC_SKManager_SetKeyLifetime(SOPC_SKManager* skm, uint32_t KeyLifetime);
 
SOPC_ReturnStatus SOPC_SKManager_SetSecurityPolicyUri(SOPC_SKManager* skm, SOPC_String* SecurityPolicyUri);
 
SOPC_ReturnStatus SOPC_SKManager_SetKeys(SOPC_SKManager* skm,
                                         SOPC_String* SecurityPolicyUri,
                                         uint32_t FirstTokenId,
                                         SOPC_ByteString* Keys,
                                         uint32_t NbKeys,
                                         uint32_t TimeToNextKey,
                                         uint32_t KeyLifetime);
 
uint32_t SOPC_SKManager_AddKeys(SOPC_SKManager* skm, SOPC_ByteString* Keys, uint32_t NbToken);
 
SOPC_ReturnStatus SOPC_SKManager_GetKeys(SOPC_SKManager* skm,
                                         uint32_t StartingTokenId,
                                         uint32_t NbRequestedToken,
                                         SOPC_String** SecurityPolicyUri,
                                         uint32_t* FirstTokenId,
                                         SOPC_ByteString** Keys,
                                         uint32_t* NbKeys,
                                         uint32_t* TimeToNextKey,
                                         uint32_t* KeyLifetime);
 
uint32_t SOPC_SKManager_GetAllKeysLifeTime(SOPC_SKManager* skm);
 
void SOPC_SKManager_Clear(SOPC_SKManager* skm);
 
#endif /* SOPC_SK_MANAGER_H_ */