ethernet.c File Reference

Functions to parse and construct ethernet headers. More...

#include "ethernet.h"
#include <string.h>
#include <arpa/inet.h>
#include <freeradius-devel/io/proto.h>

Include dependency graph for ethernet.c:

Go to the source code of this file.

Functions
static ssize_t	fr_ethernet_decode (void *proto_ctx, uint8_t const *data, size_t data_len)
	Decodes an ethernet header with up to two levels of VLAN nesting. More...
static ssize_t	fr_ethernet_encode (void *proto_ctx, uint8_t *data, size_t data_len)
	Encodes an ethernet header and up to two levels of VLAN nesting. More...
static int	fr_ethernet_get_option (fr_value_box_t *out, void const *proto_ctx, fr_proto_opt_group_t group, int opt)
	Retrieve an option value from the proto_ctx. More...
static void	fr_ethernet_invert (void *proto_ctx)
	Inverts addresses, so that a decoder proto_ctx can be used for encoding. More...
static int	fr_ethernet_set_option (void *proto_ctx, fr_proto_opt_group_t group, int opt, fr_value_box_t *in)
	Set an option in the proto_ctx. More...

Variables
fr_proto_lib_t const	libfreeradius_ethernet

Detailed Description

Functions to parse and construct ethernet headers.

Id

0d464e019eb2ee7e4d66df61197c351e88bf0b24

Copyright

2017 Arran Cudbard-Bell (a.cud.nosp@m.bard.nosp@m.b@fre.nosp@m.erad.nosp@m.ius.o.nosp@m.rg)

Definition in file ethernet.c.

Function Documentation

fr_ethernet_decode()

static ssize_t fr_ethernet_decode ( void *  proto_ctx, uint8_t const *  data, size_t  data_len  )

static

Decodes an ethernet header with up to two levels of VLAN nesting.

Technically this should be a .1Q protocol, but because of how .1Q subsumes the ether_type field, it's just easier to munge it together with the ethernet decoder.

Parameters

[out]	proto_ctx	Header information extracted from the ethernet frame, and any additional VLAN tags discovered. Must point to memory of the size indicated by the fr_proto_lib_t struct exported by this library.
[in]	data	Start of packet data.
[in]	data_len	of the data.

Returns

• >0 Length of the header.
• <=0 on failure.

Definition at line 44 of file ethernet.c.

fr_ethernet_encode()

static ssize_t fr_ethernet_encode ( void *  proto_ctx, uint8_t *  data, size_t  data_len  )

static

Encodes an ethernet header and up to two levels of VLAN nesting.

Parameters

[in]	proto_ctx	produced by fr_ethernet_decode, or by the code creating a new packet.
[out]	data	Where to write output data.
[in]	data_len	Length of the output buffer.

Returns

• >0 The length of data written to the buffer.
• 0 an error occurred.
• <0 The amount of buffer space we would have needed (as a negative integer).

Definition at line 148 of file ethernet.c.

fr_ethernet_get_option()

static int fr_ethernet_get_option ( fr_value_box_t *  out, void const *  proto_ctx, fr_proto_opt_group_t  group, int  opt  )

static

Retrieve an option value from the proto_ctx.

Parameters

[out]	out	value box to place option value into.
[in]	proto_ctx	to retrieve value from.
[in]	group	Option group. Which collection of options to query.
[in]	opt	Option to retrieve.

Returns

• 0 on success.
• -1 on failure.

Definition at line 260 of file ethernet.c.

Here is the call graph for this function:

fr_ethernet_invert()

static void fr_ethernet_invert ( void *  proto_ctx )

static

Inverts addresses, so that a decoder proto_ctx can be used for encoding.

Parameters

[in]

proto_ctx

created by the user or decoder.

Definition at line 237 of file ethernet.c.

fr_ethernet_set_option()

static int fr_ethernet_set_option ( void *  proto_ctx, fr_proto_opt_group_t  group, int  opt, fr_value_box_t *  in  )

static

Set an option in the proto_ctx.

Parameters

[in]	proto_ctx	to set value in.
[in]	group	Option group. Which collection of options opt exists in.
[in]	opt	Option to set.
[in]	in	value to set.

Returns

• 0 on success.
• -1 on failure.

Definition at line 333 of file ethernet.c.

Here is the call graph for this function:

Variable Documentation

libfreeradius_ethernet

fr_proto_lib_t const libfreeradius_ethernet

Initial value:

= {
        .magic          = MODULE_MAGIC_INIT,
        .name           = "ethernet",
        .inst_size      = sizeof(fr_ethernet_proto_ctx_t),
 
        .opt_group      = PROTO_OPT_GROUP_CUSTOM | PROTO_OPT_GROUP_L2,
 
        .decode         = fr_ethernet_decode,
        .encode         = fr_ethernet_encode,
        .invert         = fr_ethernet_invert,
        .get_option     = fr_ethernet_get_option,
        .set_option     = fr_ethernet_set_option
}

Definition at line 403 of file ethernet.c.