ipgen.h File Reference

File containing the definition of the ip generic interface utilities. More...

#include <stdbool.h>
#include <stdio.h>
#include <stdlib.h>
#include <errno.h>
#include <string.h>
#include "os.h"

Include dependency graph for ipgen.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	ipgenctx

Functions
struct ipgenctx *	ipgen_init_context (char *path)
	Initialises the ipgen context. More...
void	ipgen_free_context (struct ipgenctx *context)
	Frees the ipgen context. More...
int	ipgen_create_interface (const struct ipgenctx *context, const char *ifname, const char *type, const char *ip_addr, const char *brd_addr, const char *subnet_mask)
	Creates and interface and assigns an IP. More...
int	ipgen_set_interface_ip (const struct ipgenctx *context, const char *ifname, const char *ip_addr, const char *brd_addr, const char *subnet_mask)
	Set the IP address for an interface. More...
int	ipgen_reset_interface (const struct ipgenctx *context, const char *ifname)
	Resets the interface. More...

Detailed Description

File containing the definition of the ip generic interface utilities.

Author

Alexandru Mereacre

Date

2022

Copyright

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

Function Documentation

ipgen_create_interface()

int ipgen_create_interface	(	const struct ipgenctx *	context,
		const char *	ifname,
		const char *	type,
		const char *	ip_addr,
		const char *	brd_addr,
		const char *	subnet_mask
	)

Creates and interface and assigns an IP.

Parameters

context	The ipgen context interface
ifname	The interface name
type	The interface type
ip_addr	The interface IP4 address
brd_addr	The interface IP4 broadcast address
subnet_mask	The interface IP4 subnet mask

Returns

int 0 on success, -1 on failure

ipgen_free_context()

void ipgen_free_context

(

struct ipgenctx *

context

)

Frees the ipgen context.

Parameters

context	The ipgen context created by ipgen_init_context()
context	The ipgen context

ipgen_init_context()

struct ipgenctx* ipgen_init_context

(

char *

path

)

Initialises the ipgen context.

Parameters

path	The path string to the ip command

Returns

The ip generic context or NULL on failure. Must be cleaned-up with ipgen_free_context().

ipgen_reset_interface()

int ipgen_reset_interface	(	const struct ipgenctx *	context,
		const char *	ifname
	)

Resets the interface.

Parameters

context	The ipgen context interface
ifname	The interface name

Returns

int 0 on success, -1 on failure

ipgen_set_interface_ip()

int ipgen_set_interface_ip	(	const struct ipgenctx *	context,
		const char *	ifname,
		const char *	ip_addr,
		const char *	brd_addr,
		const char *	subnet_mask
	)

Set the IP address for an interface.

Parameters

context	The ipgen context interface
ifname	The interface name
ip_addr	The interface IP4 address
brd_addr	The interface IP4 broadcast address
subnet_mask	The interface IP4 subnet mask

Returns

int 0 on success, -1 on failure