kdrive_express_keyring.h

Go to the documentation of this file.

//
// Copyright (c) 2002-2023 WEINZIERL ENGINEERING GmbH
// All rights reserved.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
// SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY DAMAGES OR OTHER LIABILITY,
// WHETHER IN CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE
//
 
#ifndef __KDRIVE_EXPRESS_KEYRING_H__
#define __KDRIVE_EXPRESS_KEYRING_H__
 
#include "kdrive_express_config.h"
#include "kdrive_express_defs.h"
 
#if KDRIVE_EXPRESS_SECURITY_ENABLED == 1
 
#ifdef __cplusplus
extern "C"
{
#endif
 
/*******************************
** Keyring
********************************/
 
kdriveExpress_API int32_t kdrive_keyring_create(const char* name);
 
kdriveExpress_API error_t kdrive_keyring_import_knxkeys(const char* filename,
        const char* password, int32_t* keyring);
 
kdriveExpress_API bool_t kdrive_keyring_remove(int32_t keyring);
 
kdriveExpress_API error_t kdrive_keyring_get_proj_name(int32_t keyring, char name[], uint32_t* name_length);
 
kdriveExpress_API error_t kdrive_keyring_get_proj_creator(int32_t keyring,
        char creator[], uint32_t* creator_length);
 
typedef struct keyring_dev_t
{
        uint16_t ind_addr;                               
        uint8_t tool_key[KDRIVE_SEC_KEY_LEN];            
        bool_t has_tool_key;                             
        char password[KDRIVE_MAX_SEC_PASSWORD_LEN];      
        bool_t has_mgmt_password;                        
        char auth_password[KDRIVE_MAX_SEC_PASSWORD_LEN]; 
        bool_t has_auth_password;                        
} keyring_dev_t;
 
kdriveExpress_API error_t kdrive_keyring_set_device(int32_t keyring, const keyring_dev_t* device);
 
kdriveExpress_API error_t kdrive_keyring_get_device(int32_t keyring, keyring_dev_t* device);
 
typedef struct keyring_tun_t
{
        uint16_t host_ind_addr;                          
        uint16_t ind_addr;                               
        uint8_t user_id;                                 
        char password[KDRIVE_MAX_SEC_PASSWORD_LEN];      
        uint32_t has_user_credentials;                   
        char auth_password[KDRIVE_MAX_SEC_PASSWORD_LEN]; 
        uint32_t has_auth_password;                      
} keyring_tun_t;
 
kdriveExpress_API error_t kdrive_keyring_set_tunnel(int32_t keyring, const keyring_tun_t* tunnel);
 
kdriveExpress_API error_t kdrive_keyring_get_tunnel(int32_t keyring, keyring_tun_t* tunnel);
 
kdriveExpress_API error_t kdrive_keyring_remove_device_tunnel(int32_t keyring, uint16_t address);
 
kdriveExpress_API error_t kdrive_keyring_set_group_addr(int32_t keyring,
        uint16_t group_addr,
        const uint8_t key[KDRIVE_SEC_KEY_LEN]);
 
kdriveExpress_API error_t kdrive_keyring_get_group_addr(int32_t keyring,
        uint16_t group_addr,
        uint8_t key[KDRIVE_SEC_KEY_LEN]);
 
kdriveExpress_API error_t kdrive_keyring_remove_group_addr(int32_t keyring, uint16_t group_addr);
 
#ifdef __cplusplus
}
#endif
 
#endif /* KDRIVE_EXPRESS_SECURITY_ENABLED */
 
#endif /* __KDRIVE_EXPRESS_KEYRING_H__ */