File containing the implementation of the uci utilities. More...

#include <arpa/inet.h>
#include <inttypes.h>
#include <string.h>
#include <uci.h>
#include "uci_wrt.h"
#include "allocs.h"
#include "iface_mapper.h"
#include "log.h"
#include "net.h"
#include "squeue.h"
#include <uthash.h>

Include dependency graph for uci_wrt.c:

Data Structures
struct	uci_section_type_count
	Hashmap that stores the count of all the seen section types. More...

Macros
#define	IFNAME_EXPR ".ifname="

#define	IPADDR_EXPR ".ipaddr="

#define	IP_SECTION_STR "%d%d%d%d"

Functions
void	uwrt_print_error (struct uci_context ctx, const char name)

int	uwrt_lookup_package (struct uci_package p, UT_array kv)

int	uwrt_lookup_key (struct uci_context ctx, char key, UT_array *kv)

const char *	uwrt_extract_value (const char str, const char key)

int	uwrt_get_net_if (UT_array kv, netif_info_t nif)

int	uwrt_set_property (struct uci_context ctx, char property)

int	uwrt_set_properties (struct uci_context ctx, UT_array properties)
	Set multiple OpenWRT UCI properties at once. More...

int	uwrt_add_list (struct uci_context ctx, char property)

int	uwrt_add_list_properties (struct uci_context ctx, UT_array properties)
	Set multiple OpenWRT UCI list properties at once. More...

int	uwrt_delete_property (struct uci_context ctx, char property)

void	uwrt_delete_properties (struct uci_context ctx, UT_array properties)
	Delete multiple OpenWRT UCI properties at once Errors with uwrt_delete_property will be logged and ignored. More...

void	uwrt_free_context (struct uctx *context)
	Frees the uci context. More...

struct uctx *	uwrt_init_context (const char *path)
	Initialises the uci context. More...

UT_array *	uwrt_get_interfaces (const struct uctx context, const char ifname)
	Get the array of `struct` netif_info_t for each available interface. More...

int	uwrt_set_interface_ip (const struct uctx context, const char ifname, const char ip_addr, const char netmask)
	Assigns an IP to an interface. More...

int	uwrt_create_interface (const struct uctx context, const char ifname, const char type, const char ip_addr, const char brd_addr, const char netmask)
	Creates and interface and assigns an IP. More...

int	uwrt_commit_section (const struct uctx context, const char section)
	Commit a uci section. More...

int	uwrt_gen_dnsmasq_instance (const struct uctx context, const struct string_queue ifname_queue, const UT_array server_array, const char leasefile, const char *scriptfile)
	Generates a dnsmasq uci instance. More...

int	uwrt_add_dhcp_pool (const struct uctx context, const char ifname, const char ip_addr_low, const char ip_addr_upp, const char subnet_mask, const char lease_time)
	Adds a dhcp pool entry. More...

int	uwrt_gen_hostapd_instance (const struct uctx context, const struct hostapd_params params)
	Generate the hostapd config. More...

int	uwrt_gen_firewall_zone (const struct uctx context, const char brname)
	Generate a firewall zone for a bridge. More...

int	uwrt_add_firewall_nat (const struct uctx context, const char brname, const char ip_addr, const char nat_name)
	Adds a firewall rule for an IP address. More...

int	uwrt_delete_firewall_nat (const struct uctx context, const char ip_addr)
	Deletes a firewall rule for an IP address. More...

int	uwrt_add_firewall_bridge (const struct uctx context, const char sip, const char sbr, const char dip, const char *dbr)
	Adds a firewall bridge rule for two IP addresses. More...

int	uwrt_delete_firewall_bridge (const struct uctx context, const char sip, const char *dip)
	Deletes a firewall bridge rule for two IP addresses. More...

int	uwrt_cleanup_firewall (const struct uctx *context)
	Removes all the firewall rules. More...

Detailed Description

File containing the implementation of the uci utilities.

Author: Alexandru Mereacre

Date: 2022

Copyright: SPDX-FileCopyrightText: © 2022 NQMCyber Ltd and edgesec contributors SPDX-License-Identifier: LGPL-3.0-or-later

Utility functions for working with UCI (Unified Configuration Interface), which is most commonly used to configure OpenWRT services.

Please see https://openwrt.org/docs/guide-user/base-system/uci for a description of UCI data/object model.

Macro Definition Documentation

◆ IFNAME_EXPR

#define IFNAME_EXPR ".ifname="

◆ IP_SECTION_STR

#define IP_SECTION_STR "%d%d%d%d"

◆ IPADDR_EXPR

#define IPADDR_EXPR ".ipaddr="

Function Documentation

◆ uwrt_add_dhcp_pool()

int uwrt_add_dhcp_pool	(	const struct uctx *	context,
		const char *	ifname,
		const char *	ip_addr_low,
		const char *	ip_addr_upp,
		const char *	subnet_mask,
		const char *	lease_time
	)

Adds a dhcp pool entry.

Parameters

context	The uci context
ifname	The interface name
ip_addr_low	Interface string IP address lower bound
ip_addr_upp	Interface string IP address upper bound
subnet_mask	Interface string IP subnet mask
lease_time	Interface lease time string

Returns: int 0 on success, -1 on failure

◆ uwrt_add_firewall_bridge()

int uwrt_add_firewall_bridge	(	const struct uctx *	context,
		const char *	sip,
		const char *	sbr,
		const char *	dip,
		const char *	dbr
	)

Adds a firewall bridge rule for two IP addresses.

Parameters

context	The uci context
sip	The source IP address
sbr	The source bridge interface name
dip	The destination IP address
dbr	The destination bridge interface name

Returns: int 0 on success, -1 on failure

◆ uwrt_add_firewall_nat()

int uwrt_add_firewall_nat	(	const struct uctx *	context,
		const char *	brname,
		const char *	ip_addr,
		const char *	nat_name
	)

Adds a firewall rule for an IP address.

Parameters

context	The uci context
brname	The bridge name
ip_addr	The IP address
nat_name	The NAT bridge name

Returns: int 0 on success, -1 on failure

◆ uwrt_add_list()

int uwrt_add_list	(	struct uci_context *	ctx,
		char *	property
	)

◆ uwrt_add_list_properties()

int uwrt_add_list_properties	(	struct uci_context *	ctx,
		UT_array *	properties
	)

Set multiple OpenWRT UCI list properties at once.

Parameters

[in]	ctx	UCI context. The context ptr will be modified.
[in]	properties	Array of list properties to set. Warning, strings may be modified by UCI.

Return values

0	Success
-1	Error

◆ uwrt_cleanup_firewall()

int uwrt_cleanup_firewall ( const struct uctx * context )

Removes all the firewall rules.

Parameters

context The uci context

Returns: int 0 on success, -1 on failure

◆ uwrt_commit_section()

int uwrt_commit_section	(	const struct uctx *	context,
		const char *	section
	)

Commit a uci section.

Parameters

context	The uci context
section	The uci section

Returns: int 0 on success, -1 on failure

◆ uwrt_create_interface()

int uwrt_create_interface	(	const struct uctx *	context,
		const char *	ifname,
		const char *	type,
		const char *	ip_addr,
		const char *	brd_addr,
		const char *	netmask
	)

Creates and interface and assigns an IP.

Parameters

context	The uci context
ifname	The interface name
type	The interface type
ip_addr	The interface IP4 address
brd_addr	The interface IP4 broadcast address
netmask	The interface IP4 netmask

Returns: int 0 on success, -1 on failure

◆ uwrt_delete_firewall_bridge()

int uwrt_delete_firewall_bridge	(	const struct uctx *	context,
		const char *	sip,
		const char *	dip
	)

Deletes a firewall bridge rule for two IP addresses.

Parameters

context	The uci context
sip	The source IP address
dip	The destination IP address

Returns: int 0 on success, -1 on failure

◆ uwrt_delete_firewall_nat()

int uwrt_delete_firewall_nat	(	const struct uctx *	context,
		const char *	ip_addr
	)

Deletes a firewall rule for an IP address.

Parameters

context	The uci context
ip_addr	The IP address

Returns: int 0 on success, -1 on failure

◆ uwrt_delete_properties()

void uwrt_delete_properties	(	struct uci_context *	ctx,
		UT_array *	properties
	)

Delete multiple OpenWRT UCI properties at once Errors with uwrt_delete_property will be logged and ignored.

Parameters

[in]	ctx	UCI context. The context ptr will be modified.
[in]	properties	Array of properties to delete. Warning, strings may be modified by UCI.

◆ uwrt_delete_property()

int uwrt_delete_property	(	struct uci_context *	ctx,
		char *	property
	)

◆ uwrt_extract_value()

const char* uwrt_extract_value	(	const char *	str,
		const char *	key
	)

◆ uwrt_free_context()

void uwrt_free_context ( struct uctx * context )

Frees the uci context.

Parameters

context The uci context

◆ uwrt_gen_dnsmasq_instance()

int uwrt_gen_dnsmasq_instance	(	const struct uctx *	context,
		const struct string_queue *	ifname_queue,
		const UT_array *	server_array,
		const char *	leasefile,
		const char *	scriptfile
	)

Generates a dnsmasq uci instance.

Parameters

context	The uci context
ifname_queue	The interface queue
server_array	The array of servers
leasefile	The lease file path string
scriptfile	The script file path string

Returns: int 0 on success, -1 on failure

◆ uwrt_gen_firewall_zone()

int uwrt_gen_firewall_zone	(	const struct uctx *	context,
		const char *	brname
	)

Generate a firewall zone for a bridge.

Parameters

context	The uci context
brname	The bridge name

Returns: int 0 on success, -1 on failure

◆ uwrt_gen_hostapd_instance()

int uwrt_gen_hostapd_instance	(	const struct uctx *	context,
		const struct hostapd_params *	params
	)

Generate the hostapd config.

Parameters

context	The uci context
params	The hostapd params

Returns: int 0 on success, -1 on failure

◆ uwrt_get_interfaces()

UT_array* uwrt_get_interfaces	(	const struct uctx *	context,
		const char *	ifname
	)

Get the array of struct netif_info_t for each available interface.

Parameters

context	The uci context
ifname	The interface name, if NULL return all interfaces

Returns: UT_array* The returned array of struct netif_info_t This return variable must be cleaned up by utarray_free().

◆ uwrt_get_net_if()

int uwrt_get_net_if	(	UT_array *	kv,
		netif_info_t *	nif
	)

◆ uwrt_init_context()

struct uctx* uwrt_init_context ( const char * path )

Initialises the uci context.

Parameters

path	The path string to the config folder

Returns: The uci context, or NULL on error. This return variable must be cleaned up by uwrt_free_context().

◆ uwrt_lookup_key()

int uwrt_lookup_key	(	struct uci_context *	ctx,
		char *	key,
		UT_array *	kv
	)

◆ uwrt_lookup_package()

int uwrt_lookup_package	(	struct uci_package *	p,
		UT_array *	kv
	)

Counts the section types we've already encountered

◆ uwrt_print_error()

void uwrt_print_error	(	struct uci_context *	ctx,
		const char *	name
	)

◆ uwrt_set_interface_ip()

int uwrt_set_interface_ip	(	const struct uctx *	context,
		const char *	ifname,
		const char *	ip_addr,
		const char *	netmask
	)

Assigns an IP to an interface.

Parameters

context	The uci context
ifname	The interface name
ip_addr	The interface IP4 address
netmask	The interface IP4 netmask

Returns: int 0 on success, -1 on failure

◆ uwrt_set_properties()

int uwrt_set_properties	(	struct uci_context *	ctx,
		UT_array *	properties
	)

Set multiple OpenWRT UCI properties at once.

Parameters

[in]	ctx	UCI context. The context ptr will be modified.
[in]	properties	Array of properties to set. Warning, strings may be modified by UCI.

Return values

0	Success
-1	Error

◆ uwrt_set_property()

int uwrt_set_property	(	struct uci_context *	ctx,
		char *	property
	)

Data Structures

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ IFNAME_EXPR

◆ IP_SECTION_STR

◆ IPADDR_EXPR

Function Documentation

◆ uwrt_add_dhcp_pool()

◆ uwrt_add_firewall_bridge()

◆ uwrt_add_firewall_nat()

◆ uwrt_add_list()

◆ uwrt_add_list_properties()

◆ uwrt_cleanup_firewall()

◆ uwrt_commit_section()

◆ uwrt_create_interface()

◆ uwrt_delete_firewall_bridge()

◆ uwrt_delete_firewall_nat()

◆ uwrt_delete_properties()

◆ uwrt_delete_property()

◆ uwrt_extract_value()

◆ uwrt_free_context()

◆ uwrt_gen_dnsmasq_instance()

◆ uwrt_gen_firewall_zone()

◆ uwrt_gen_hostapd_instance()

◆ uwrt_get_interfaces()

◆ uwrt_get_net_if()

◆ uwrt_init_context()

◆ uwrt_lookup_key()

◆ uwrt_lookup_package()

◆ uwrt_print_error()

◆ uwrt_set_interface_ip()

◆ uwrt_set_properties()

◆ uwrt_set_property()