upnp.h

Go to the documentation of this file.

 
#pragma once
 
/* Storage capacities in elements; text buffers include the terminating NUL. */
#define NETWORK_NAT_UPNP_EXTERNAL_IP_BUFFER_SIZE 16
#define NETWORK_NAT_UPNP_DEVICE_DESCRIPTION_BUFFER_SIZE 256
#define NETWORK_NAT_UPNP_INTERNAL_IP_BUFFER_SIZE 16
#define NETWORK_NAT_UPNP_SERVICE_TYPE_BUFFER_SIZE 128
#define NETWORK_NAT_UPNP_DESCRIPTION_BUFFER_SIZE 128
 
#include <stdint.h>
#include <stdbool.h>
#include "../../common.h"
 
typedef enum { NAT_UPNP_TCP, NAT_UPNP_UDP } nat_upnp_protocol_t;

typedef struct nat_upnp_context {
  char external_ip[NETWORK_NAT_UPNP_EXTERNAL_IP_BUFFER_SIZE]; 
  uint16_t mapped_port;   
  uint16_t internal_port; 
  char device_description[NETWORK_NAT_UPNP_DEVICE_DESCRIPTION_BUFFER_SIZE]; 
  bool is_natpmp;                                                           
  char internal_ip[NETWORK_NAT_UPNP_INTERNAL_IP_BUFFER_SIZE];   
  char *control_url;                                            
  char service_type[NETWORK_NAT_UPNP_SERVICE_TYPE_BUFFER_SIZE]; 
  char description[NETWORK_NAT_UPNP_DESCRIPTION_BUFFER_SIZE];   
  uint32_t gateway;                                             
  uint32_t lease_seconds;                                       
  uint64_t expires_at_ns;                                       
  uint64_t refresh_at_ns;                                       
  bool is_mapped;                                               
  nat_upnp_protocol_t protocol;                                 
  bool external_is_private; 
} nat_upnp_context_t;

asciichat_error_t nat_upnp_open(uint16_t internal_port, const char *description, nat_upnp_context_t **ctx);

asciichat_error_t nat_upnp_open_protocol(uint16_t internal_port, const char *description, nat_upnp_protocol_t protocol,
                                         nat_upnp_context_t **ctx);

void nat_upnp_close(nat_upnp_context_t **ctx);

bool nat_upnp_is_active(const nat_upnp_context_t *ctx);

bool nat_upnp_matches_bind_address(const nat_upnp_context_t *ctx, const char *bind_address);

asciichat_error_t nat_upnp_get_endpoint(const nat_upnp_context_t *ctx, char *ip, size_t ip_len, uint16_t *port);

asciichat_error_t nat_upnp_refresh(nat_upnp_context_t *ctx);

asciichat_error_t nat_upnp_get_address(const nat_upnp_context_t *ctx, char *addr, size_t addr_len);