oc_endpoint.h

Go to the documentation of this file.

/*
// Copyright (c) 2017, 2020 Intel Corporation
// Copyright (c) 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_ENDPOINT_H
#define OC_ENDPOINT_H
 
#include "oc_helpers.h"
#include "oc_uuid.h"
 
#include "messaging/coap/oscore_constants.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct
{
  uint16_t port;       
  uint8_t address[16]; 
  uint8_t scope;       
} oc_ipv6_addr_t;
 
typedef struct
{
  uint16_t port;      
  uint8_t address[4]; 
} oc_ipv4_addr_t;
 
enum transport_flags {
  DISCOVERY = 1 << 0,        
  SECURED = 1 << 1,          
  IPV4 = 1 << 2,             
  IPV6 = 1 << 3,             
  TCP = 1 << 4,              
  OSCORE = 1 << 5,           
  MULTICAST = 1 << 6,        
  ACCEPTED = 1 << 7,         
  OSCORE_DECRYPTED = 1 << 8, 
  OSCORE_ENCRYPTED = 1 << 9, 
};
 
#define SERIAL_NUM_SIZE (12) 
typedef struct oc_endpoint_t
{
  struct oc_endpoint_t *next; 
  size_t device;              
  enum transport_flags flags; 
  // oc_string_t
  //   oscore_id; /**< OSCORE context (binary), e.g. binary serial number*/
  char oscore_id[SERIAL_NUM_SIZE + 1]; 
  size_t oscore_id_len;
  union dev_addr {
    oc_ipv6_addr_t ipv6; 
    oc_ipv4_addr_t ipv4; 
  } addr, addr_local;
  int interface_index;    
  uint8_t priority;       
  uint32_t group_address; 
  int32_t
    auth_at_index; 
  uint8_t request_piv[OSCORE_PIV_LEN]; 
  uint8_t request_piv_len;             
  uint8_t kid_len;
  uint8_t kid[OSCORE_CTXID_LEN];
  uint8_t kid_ctx_len;
  uint8_t kid_ctx[OSCORE_IDCTX_LEN];
  // bool rx_msg_is_response;
} oc_endpoint_t;
 
#define oc_make_ipv4_endpoint(__name__, __flags__, __port__, ...)              \
  oc_endpoint_t __name__ = { .flags = __flags__,                               \
                             .addr.ipv4 = { .port = __port__,                  \
                                            .address = { __VA_ARGS__ } } }
#define oc_make_ipv6_endpoint(__name__, __flags__, __port__, ...)              \
  oc_endpoint_t __name__ = { .flags = __flags__,                               \
                             .device = 0,                                      \
                             .group_address = 0,                               \
                             .addr.ipv6 = { .port = __port__,                  \
                                            .address = { __VA_ARGS__ } } }
 
oc_endpoint_t *oc_new_endpoint(void);
 
void oc_free_endpoint(oc_endpoint_t *endpoint);
 
int oc_endpoint_set_oscore_id_from_str(oc_endpoint_t *endpoint,
                                       char *oscore_str_id);
 
int oc_endpoint_set_oscore_id(oc_endpoint_t *endpoint, char *oscore_id,
                              int oscore_id_len);
 
void oc_endpoint_set_auth_at_index(oc_endpoint_t *endpoint, int32_t index);
 
int oc_endpoint_to_string(oc_endpoint_t *endpoint, oc_string_t *endpoint_str);
 
int oc_string_to_endpoint(oc_string_t *endpoint_str, oc_endpoint_t *endpoint,
                          oc_string_t *uri);
 
int oc_endpoint_string_parse_path(oc_string_t *endpoint_str, oc_string_t *path);
 
int oc_ipv6_endpoint_is_link_local(oc_endpoint_t *endpoint);
 
int oc_endpoint_compare(const oc_endpoint_t *ep1, const oc_endpoint_t *ep2);
 
int oc_endpoint_compare_address(const oc_endpoint_t *ep1,
                                const oc_endpoint_t *ep2);
 
void oc_endpoint_set_local_address(oc_endpoint_t *ep, int interface_index);
 
void oc_endpoint_copy(oc_endpoint_t *dst, oc_endpoint_t *src);
 
void oc_endpoint_list_copy(oc_endpoint_t **dst, oc_endpoint_t *src);
 
void oc_endpoint_print(oc_endpoint_t *ep);
 
#ifdef __cplusplus
}
#endif
 
#endif /* OC_ENDPOINT_H */