oc_knx_sec.h

Go to the documentation of this file.

/*
// Copyright (c) 2021-2023 Cascoda Ltd
//
// Licensed 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 OC_KNX_SEC_INTERNAL_H
#define OC_KNX_SEC_INTERNAL_H
 
#include <stddef.h>
 
#include "oc_ri.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum {
  OC_PROFILE_UNKNOWN = 0,     
  OC_PROFILE_COAP_DTLS = 1,   
  OC_PROFILE_COAP_OSCORE = 2, 
  OC_PROFILE_COAP_TLS =
    254, 
  OC_PROFILE_COAP_PASE = 255 
} oc_at_profile_t;
 
oc_at_profile_t oc_string_to_at_profile(oc_string_t str);
 
char *oc_at_profile_to_string(oc_at_profile_t at_profile);
 
typedef struct oc_auth_at_t
{
  oc_string_t id;            
  oc_interface_mask_t scope; 
  oc_at_profile_t
    profile; 
  oc_string_t aud;         
  oc_string_t sub;         
  oc_string_t kid;         
  oc_string_t osc_version; 
  oc_string_t osc_ms;      
  uint8_t osc_hkdf;        
  uint8_t osc_alg;         
  oc_string_t
    osc_salt; 
  oc_string_t osc_contextid;
  oc_string_t osc_id; 
  oc_string_t
    osc_rid;   
  int nbf;     
  int ga_len;  
  int64_t *ga; 
} oc_auth_at_t;
 
int oc_core_get_at_table_size();
 
int oc_core_set_at_table(size_t device_index, int index, oc_auth_at_t entry,
                         bool store);
 
int oc_core_find_at_entry_with_context_id(size_t device_index,
                                          char *context_id);
 
int oc_core_find_at_entry_with_osc_id(size_t device_index, uint8_t *osc_id,
                                      size_t osc_id_len);
 
int oc_core_find_at_entry_empty_slot(size_t device_index);
 
void oc_oscore_set_auth_mac(char *client_senderid, int client_senderid_size,
                            char *clientrecipient_id,
                            int clientrecipient_id_size, uint8_t *shared_key,
                            int shared_key_size);
 
void oc_oscore_set_auth_device(char *client_senderid, int client_senderid_size,
                               char *clientrecipient_id,
                               int clientrecipient_id_size, uint8_t *shared_key,
                               int shared_key_size);
 
oc_auth_at_t *oc_get_auth_at_entry(size_t device_index, int index);
 
void oc_print_auth_at_entry(size_t device_index, int index);
 
void oc_delete_at_table(size_t device_index);
 
void oc_reset_at_table(size_t device_index, int erase_code);
 
int oc_at_delete_entry(size_t device_index, int index);
 
uint64_t oc_oscore_get_rplwdo();
 
uint64_t oc_oscore_get_osndelay();
 
void oc_create_knx_sec_resources(size_t device);
 
void oc_init_oscore(size_t device_index);
 
void oc_init_oscore_from_storage(size_t device_index, bool from_storage);
 
bool oc_knx_contains_interface(oc_interface_mask_t at_interface,
                               oc_interface_mask_t resource_interface);
 
bool oc_if_method_allowed_according_to_mask(oc_interface_mask_t iface_mask,
                                            oc_method_t method);
 
bool oc_knx_sec_check_acl(oc_method_t method, const oc_resource_t *resource,
                          oc_endpoint_t *endpoint);
 
#ifdef __cplusplus
}
#endif
 
#endif /* OC_KNX_SEC_INTERNAL_H */