coap_proxy.h

Go to the documentation of this file.

/*
 * coap_proxy.h -- helper functions for proxy handling
 *
 * Copyright (C) 2024-2025 Jon Shallow <supjps-libcoap@jpshallow.com>
 *
 * SPDX-License-Identifier: BSD-2-Clause
 *
 * This file is part of the CoAP library libcoap. Please see README for terms
 * of use.
 */
 
#ifndef COAP_PROXY_H_
#define COAP_PROXY_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum {
  /* Old entries, now updated for flexibility */
  COAP_PROXY_REVERSE,       
  COAP_PROXY_REVERSE_STRIP, 
  COAP_PROXY_FORWARD,       
  COAP_PROXY_FORWARD_STRIP, 
  COAP_PROXY_DIRECT,        
  COAP_PROXY_DIRECT_STRIP,  
  COAP_PROXY_FORWARD_DYNAMIC = COAP_PROXY_DIRECT,
  COAP_PROXY_FORWARD_DYNAMIC_STRIP = COAP_PROXY_DIRECT_STRIP,
  /* New style Proxy types */
  COAP_PROXY_REV = (1 << 3),         
  COAP_PROXY_FWD_STATIC = (2 << 3),  
  COAP_PROXY_FWD_DYNAMIC = (3 << 3), 
  /* Start of additional optional bit mask mapping */
  COAP_PROXY_BIT_STRIP = (1 << 6),
  COAP_PROXY_BIT_MCAST = (1 << 7),
} coap_proxy_t;
 
#define COAP_PROXY_OLD_MASK 0x07 
#define COAP_PROXY_NEW_MASK 0x38 
typedef struct coap_proxy_server_t {
  coap_uri_t uri;         
  coap_dtls_pki_t *dtls_pki;       
  coap_dtls_cpsk_t *dtls_cpsk;     
  coap_oscore_conf_t *oscore_conf; 
} coap_proxy_server_t;
 
typedef struct coap_proxy_server_list_t {
  coap_proxy_server_t *entry; 
  size_t entry_count;         
  size_t next_entry;          
  coap_proxy_t type;          
  int track_client_session;   
  unsigned int idle_timeout_secs; 
} coap_proxy_server_list_t;
 
typedef coap_pdu_t *(*coap_proxy_response_handler_t)(coap_session_t *session,
                                                     const coap_pdu_t *sent,
                                                     coap_pdu_t *received,
                                                     coap_cache_key_t *cache_key);
 
void coap_register_proxy_response_handler(coap_context_t *context,
                                          coap_proxy_response_handler_t handler);
 
int coap_verify_proxy_scheme_supported(coap_uri_scheme_t scheme);
 
COAP_API int coap_proxy_forward_request(coap_session_t *req_session,
                                        const coap_pdu_t *request,
                                        coap_pdu_t *response,
                                        coap_resource_t *resource,
                                        coap_cache_key_t *cache_key,
                                        coap_proxy_server_list_t *server_list);
 
coap_response_t COAP_API coap_proxy_forward_response(coap_session_t *rsp_session,
                                                     const coap_pdu_t *received,
                                                     coap_cache_key_t **cache_key);
 
COAP_API coap_session_t *coap_new_client_session_proxy(coap_context_t *context,
                                                       coap_proxy_server_list_t *server_list);
 
#ifdef __cplusplus
}
#endif
 
#endif /* COAP_PROXY_H_ */