networking.h

Go to the documentation of this file.

/*
 *  Generic interface to platform specific networking code
 *
 *  Copyright (C) 2016-2025 Antonio Quartulli <a@unstable.cc>
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License version 2
 *  as published by the Free Software Foundation.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program (see the file COPYING included with this
 *  distribution); if not, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef NETWORKING_H_
#define NETWORKING_H_
 
#include "syshead.h"
 
#define IFACE_TYPE_LEN_MAX 64
 
struct context;
 
#ifdef ENABLE_SITNL
#include "networking_sitnl.h"
#elif ENABLE_IPROUTE
#include "networking_iproute2.h"
#elif defined(TARGET_FREEBSD)
typedef void *openvpn_net_ctx_t;
typedef char openvpn_net_iface_t;
#else  /* ifdef ENABLE_SITNL */
/* define mock types to ensure code builds on any platform */
typedef void *openvpn_net_ctx_t;
typedef void *openvpn_net_iface_t;
#endif /* ifdef ENABLE_SITNL */
 
/* Only the iproute2 backend implements these functions,
 * the rest can rely on these stubs
 */
#if !defined(ENABLE_IPROUTE)
static inline int
net_ctx_init(struct context *c, openvpn_net_ctx_t *ctx)
{
    (void)c;
    (void)ctx;
 
    return 0;
}
 
static inline void
net_ctx_reset(openvpn_net_ctx_t *ctx)
{
    (void)ctx;
}
 
static inline void
net_ctx_free(openvpn_net_ctx_t *ctx)
{
    (void)ctx;
}
#endif /* !defined(ENABLE_IPROUTE) */
 
#if defined(ENABLE_SITNL) || defined(ENABLE_IPROUTE)
 
int net_ctx_init(struct context *c, openvpn_net_ctx_t *ctx);
 
void net_ctx_reset(openvpn_net_ctx_t *ctx);
 
void net_ctx_free(openvpn_net_ctx_t *ctx);
 
int net_iface_new(openvpn_net_ctx_t *ctx, const openvpn_net_iface_t *iface, const char *type,
                  void *arg);
 
int net_iface_type(openvpn_net_ctx_t *ctx, const char *iface, char type[IFACE_TYPE_LEN_MAX]);
 
int net_iface_del(openvpn_net_ctx_t *ctx, const openvpn_net_iface_t *iface);
 
int net_iface_up(openvpn_net_ctx_t *ctx, const openvpn_net_iface_t *iface, bool up);
 
int net_iface_mtu_set(openvpn_net_ctx_t *ctx, const openvpn_net_iface_t *iface, uint32_t mtu);
 
int net_addr_ll_set(openvpn_net_ctx_t *ctx, const openvpn_net_iface_t *iface, uint8_t *addr);
 
int net_addr_v4_add(openvpn_net_ctx_t *ctx, const openvpn_net_iface_t *iface, const in_addr_t *addr,
                    int prefixlen);
 
int net_addr_v6_add(openvpn_net_ctx_t *ctx, const openvpn_net_iface_t *iface,
                    const struct in6_addr *addr, int prefixlen);
 
int net_addr_v4_del(openvpn_net_ctx_t *ctx, const openvpn_net_iface_t *iface, const in_addr_t *addr,
                    int prefixlen);
 
int net_addr_v6_del(openvpn_net_ctx_t *ctx, const openvpn_net_iface_t *iface,
                    const struct in6_addr *addr, int prefixlen);
 
int net_addr_ptp_v4_add(openvpn_net_ctx_t *ctx, const openvpn_net_iface_t *iface,
                        const in_addr_t *local, const in_addr_t *remote);
 
int net_addr_ptp_v4_del(openvpn_net_ctx_t *ctx, const openvpn_net_iface_t *iface,
                        const in_addr_t *local, const in_addr_t *remote);
 
#endif /* ENABLE_SITNL || ENABLE_IPROUTE */
 
#if defined(ENABLE_SITNL) || defined(ENABLE_IPROUTE) || defined(TARGET_FREEBSD)
int net_route_v4_add(openvpn_net_ctx_t *ctx, const in_addr_t *dst, int prefixlen,
                     const in_addr_t *gw, const openvpn_net_iface_t *iface, uint32_t table,
                     int metric);
 
int net_route_v6_add(openvpn_net_ctx_t *ctx, const struct in6_addr *dst, int prefixlen,
                     const struct in6_addr *gw, const openvpn_net_iface_t *iface, uint32_t table,
                     int metric);
 
int net_route_v4_del(openvpn_net_ctx_t *ctx, const in_addr_t *dst, int prefixlen,
                     const in_addr_t *gw, const openvpn_net_iface_t *iface, uint32_t table,
                     int metric);
 
int net_route_v6_del(openvpn_net_ctx_t *ctx, const struct in6_addr *dst, int prefixlen,
                     const struct in6_addr *gw, const openvpn_net_iface_t *iface, uint32_t table,
                     int metric);
 
#endif /* ENABLE_SITNL || ENABLE_IPROUTE || TARGET_FREEBSD */
 
#if defined(ENABLE_SITNL) || defined(ENABLE_IPROUTE)
 
int net_route_v4_best_gw(openvpn_net_ctx_t *ctx, const in_addr_t *dst, in_addr_t *best_gw,
                         openvpn_net_iface_t *best_iface);
 
int net_route_v6_best_gw(openvpn_net_ctx_t *ctx, const struct in6_addr *dst,
                         struct in6_addr *best_gw, openvpn_net_iface_t *best_iface);
 
#endif /* ENABLE_SITNL || ENABLE_IPROUTE */
 
#endif /* NETWORKING_H_ */