coap_pdu_internal.h

Go to the documentation of this file.

/*
 * coap_pdu_internal.h -- CoAP PDU structure
 *
 * Copyright (C) 2010-2025 Olaf Bergmann <bergmann@tzi.org>
 *
 * SPDX-License-Identifier: BSD-2-Clause
 *
 * This file is part of the CoAP library libcoap. Please see README for terms
 * of use.
 */
 
#ifndef COAP_COAP_PDU_INTERNAL_H_
#define COAP_COAP_PDU_INTERNAL_H_
 
#include "coap_internal.h"
 
#ifdef WITH_LWIP
#include <lwip/pbuf.h>
#endif
 
#ifdef RIOT_VERSION
#include <limits.h>
#endif /* RIOT_VERSION */
 
#ifdef HAVE_LIMITS_H
#include <limits.h>
#endif /* HAVE_LIMITS_H */
 
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define COAP_DEFAULT_VERSION      1 /* version of CoAP supported */
 
/* TCP Message format constants, do not modify */
#define COAP_MESSAGE_SIZE_OFFSET_TCP8 13
#define COAP_MESSAGE_SIZE_OFFSET_TCP16 269 /* 13 + 256 */
#define COAP_MESSAGE_SIZE_OFFSET_TCP32 65805 /* 269 + 65536 */
 
/* Derived message size limits */
#define COAP_MAX_MESSAGE_SIZE_TCP0 (COAP_MESSAGE_SIZE_OFFSET_TCP8-1) /* 12 */
#define COAP_MAX_MESSAGE_SIZE_TCP8 (COAP_MESSAGE_SIZE_OFFSET_TCP16-1) /* 268 */
#define COAP_MAX_MESSAGE_SIZE_TCP16 (COAP_MESSAGE_SIZE_OFFSET_TCP32-1) /* 65804 */
#define COAP_MAX_MESSAGE_SIZE_TCP32 (COAP_MESSAGE_SIZE_OFFSET_TCP32+0xFFFFFFFF)
#if COAP_OSCORE_SUPPORT
/* for oscore encryption   */
#define COAP_MAX_CHUNK_SIZE COAP_DEFAULT_MAX_PDU_RX_SIZE
#define OSCORE_CRYPTO_BUFFER_SIZE (COAP_MAX_CHUNK_SIZE+16)
#endif /* COAP_OSCORE_SUPPORT  */
 
/* Extended Token constants */
#define COAP_TOKEN_EXT_1B_TKL 13
#define COAP_TOKEN_EXT_2B_TKL 14
#define COAP_TOKEN_EXT_1B_BIAS 13
#define COAP_TOKEN_EXT_2B_BIAS 269 /* 13 + 256 */
 
#ifndef COAP_DEBUG_BUF_SIZE
#if defined(WITH_CONTIKI) || defined(WITH_LWIP)
#define COAP_DEBUG_BUF_SIZE 128
#else /* defined(WITH_CONTIKI) || defined(WITH_LWIP) */
/* 1024 derived from RFC7252 4.6.  Message Size max payload */
#define COAP_DEBUG_BUF_SIZE (8 + 1024 * 2)
#endif /* defined(WITH_CONTIKI) || defined(WITH_LWIP) */
#endif /* COAP_DEBUG_BUF_SIZE */
 
#ifndef COAP_DEFAULT_MAX_PDU_RX_SIZE
#if defined(WITH_LWIP)
#define COAP_DEFAULT_MAX_PDU_RX_SIZE (COAP_MAX_MESSAGE_SIZE_TCP16+6UL)
#elif defined(WITH_CONTIKI)
#define COAP_DEFAULT_MAX_PDU_RX_SIZE (UIP_APPDATA_SIZE)
#elif (UINT_MAX < (8UL*1024*1024+256))
#define COAP_DEFAULT_MAX_PDU_RX_SIZE (1500UL)
#elif defined(RIOT_VERSION) && defined(COAP_DISABLE_TCP)
#define COAP_DEFAULT_MAX_PDU_RX_SIZE (1500UL)
#else
/* 8 MiB max-message-size plus some space for options */
#define COAP_DEFAULT_MAX_PDU_RX_SIZE (8UL*1024*1024+256)
#endif
#endif /* COAP_DEFAULT_MAX_PDU_RX_SIZE */
 
#define COAP_DROPPED_RESPONSE -2
 
#define COAP_PDU_DELAYED -3
 
#define COAP_PAYLOAD_START 0xFF /* payload marker */
 
#define COAP_PDU_IS_EMPTY(pdu)     ((pdu)->code == 0)
#define COAP_PDU_IS_REQUEST(pdu)   (!COAP_PDU_IS_EMPTY(pdu) && (pdu)->code < 32)
/* Code 1.xx (32-63) and 6.xx (192-224) currently invalid */
#define COAP_PDU_IS_RESPONSE(pdu)  ((pdu)->code >= 64 && (pdu)->code < 192)
#define COAP_PDU_IS_SIGNALING(pdu) ((pdu)->code >= 224)
#define COAP_PDU_IS_PING(pdu)      ((COAP_PDU_IS_EMPTY(pdu) && \
                                     ((pdu)->type == COAP_MESSAGE_CON)) || \
                                    ((pdu)->code == COAP_SIGNALING_CODE_PING))
 
#define COAP_PDU_MAX_UDP_HEADER_SIZE 4
#define COAP_PDU_MAX_TCP_HEADER_SIZE 6
 
struct coap_pdu_t {
  coap_pdu_type_t type;     
  coap_pdu_code_t code;     
  coap_mid_t mid;           
  uint8_t max_hdr_size;     
  uint8_t hdr_size;         
  uint8_t crit_opt;         
  uint16_t max_opt;         
  uint32_t e_token_length;  
  unsigned ref;             
  coap_bin_const_t actual_token; 
  size_t alloc_size;        
  size_t used_size;         
  size_t max_size;          
  uint8_t *token;           
  uint8_t *data;            
#ifdef WITH_LWIP
  struct pbuf *pbuf;        
#endif
  const uint8_t *body_data; 
  size_t body_length;       
  size_t body_offset;       
  size_t body_total;        
  coap_lg_xmit_t *lg_xmit;  
  coap_session_t *session;  
  coap_binary_t *data_free; 
};
 
int coap_pdu_parse2(coap_proto_t proto,
                    const uint8_t *data,
                    size_t length,
                    coap_pdu_t *pdu,
                    coap_opt_filter_t *error_opts);
 
int coap_pdu_resize(coap_pdu_t *pdu, size_t new_size);
 
int coap_pdu_check_resize(coap_pdu_t *pdu, size_t new_size);
 
size_t coap_pdu_parse_header_size(coap_proto_t proto,
                                  const uint8_t *data);
 
size_t coap_pdu_parse_size(coap_proto_t proto,
                           const uint8_t *data,
                           size_t length);
 
int coap_pdu_parse_header(coap_pdu_t *pdu, coap_proto_t proto);
 
int coap_pdu_parse_opt(coap_pdu_t *pdu, coap_opt_filter_t *error_opts);
 
void coap_pdu_clear(coap_pdu_t *pdu, size_t size);
 
size_t coap_add_option_internal(coap_pdu_t *pdu,
                                coap_option_num_t number,
                                size_t len,
                                const uint8_t *data);
int coap_remove_option(coap_pdu_t *pdu, coap_option_num_t number);
 
size_t coap_insert_option(coap_pdu_t *pdu, coap_option_num_t number,
                          size_t len, const uint8_t *data);
 
size_t coap_update_option(coap_pdu_t *pdu,
                          coap_option_num_t number,
                          size_t len,
                          const uint8_t *data);
 
size_t coap_pdu_encode_header(coap_pdu_t *pdu, coap_proto_t proto);
 
int coap_update_token(coap_pdu_t *pdu,
                      size_t len,
                      const uint8_t *data);
 
int coap_option_check_repeatable(coap_option_num_t number);
 
coap_pdu_t *coap_new_pdu_lkd(coap_pdu_type_t type, coap_pdu_code_t code,
                             coap_session_t *session);
 
void coap_delete_pdu_lkd(coap_pdu_t *pdu);
 
COAP_STATIC_INLINE void
coap_pdu_release_lkd(coap_pdu_t *pdu) {
  coap_delete_pdu_lkd(pdu);
}
 
coap_pdu_t *coap_pdu_duplicate_lkd(const coap_pdu_t *old_pdu,
                                   coap_session_t *session,
                                   size_t token_length,
                                   const uint8_t *token,
                                   coap_opt_filter_t *drop_options);
 
coap_pdu_t *coap_pdu_reference_lkd(coap_pdu_t *pdu);
 
coap_pdu_t *coap_const_pdu_reference_lkd(const coap_pdu_t *pdu);
 
#ifdef __cplusplus
}
#endif
 
#endif /* COAP_COAP_PDU_INTERNAL_H_ */