a752c7ab
 elopes
add first test an...
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
/*
* Copyright (C) 2017 Freie Universitรคt Berlin
*
* This file is subject to the terms and conditions of the GNU Lesser
* General Public License v2.1. See the file LICENSE in the top level
* directory for more details.
*/
/**
* @defgroup net_l2filter Link layer address filter
* @ingroup net
* @brief Module for filtering (black- or white-listing) link layer
* addresses
*
* This module is used as a base for filtering link layer addresses. It allows
* to be (globally) configured in either blacklist or in whitelist mode. This
* configuration is done via RIOTs module system, for whitelist mode simply
* include the module `L2FILTER_WHITELIST`, for blacklist mode include
* `L2FILTER_BLACKLIST`.
*
* The actual memory for the filter lists should be allocated for every network
* device. This is done centrally in netdev_t type.
*
* @{
* @file
* @brief Link layer address filter interface definition
*
* @author Hauke Petersen <hauke.petersen@fu-berlin.de>
*/
#ifndef NET_L2FILTER_H
#define NET_L2FILTER_H
#include <stddef.h>
#include <stdint.h>
#include <stdbool.h>
#include <errno.h>
#ifdef __cplusplus
extern "C" {
#endif
/**
* @brief Maximal length of addresses that can be stored in the filter list
*/
#ifndef L2FILTER_ADDR_MAXLEN
#define L2FILTER_ADDR_MAXLEN (8U)
#endif
/**
* @brief Number of slots in each filter list (filter entries per device)
*/
#ifndef L2FILTER_LISTSIZE
#define L2FILTER_LISTSIZE (8U)
#endif
/**
* @brief Filter list entries
*
* The filter list supports address entries with differing length. This is
* useful e.g. for IEEE802.15.4, where the list can store short and long
* addresses at the same time.
*/
typedef struct {
uint8_t addr[L2FILTER_ADDR_MAXLEN]; /**< link layer address */
size_t addr_len; /**< address length in byte */
} l2filter_t;
/**
* @brief Add an entry to a devices filter list
*
* @param[in,out] list pointer to the filter list
* @param[in] addr address to be added to list
* @param[in] addr_len size of @p addr [in byte]
*
* @pre @p list != NULL
* @pre @p addr != NULL
* @pre @p addr_maxlen <= @ref L2FILTER_ADDR_MAXLEN
*
* @return 0 on success
* @return -ENOMEM if no empty slot left in list
*/
int l2filter_add(l2filter_t *list, const void *addr, size_t addr_len);
/**
* @brief Remove an entry from the given filter list
*
* @param[in,out] list pointer to the filter list
* @param[in] addr address to remove from the list
* @param[in] addr_len length of @p addr [in byte]
*
* @pre @p list != NULL
* @pre @p addr != NULL
* @pre @p addr_maxlen <= @ref L2FILTER_ADDR_MAXLEN
*
* @return 0 on success
* @return -ENOENT if @p addr was not found in @p list
*/
int l2filter_rm(l2filter_t *list, const void *addr, size_t addr_len);
/**
* @brief Check if the given address passes the set filters
*
* Independent if the l2filter module is used in blacklist or in whitelist mode,
* this function returns whether the given address passes the filter. In
* whitelist mode, this means that the given address has to be in the list, in
* blacklist mode this means that the given address is not in the list.
*
* @param[in] list list with black-/whitelisted addresses
* @param[in] addr address to check against the entries in @p list
* @param[in] addr_len length of @p addr [in byte]
*
* @pre @p list != NULL
* @pre @p addr != NULL
* @pre @p addr_maxlen <= @ref L2FILTER_ADDR_MAXLEN
*
* @return in whitelist mode: true if @p addr is in @p list
* @return in whitelist mode: false if @p addr is not in @p list
* @return in blacklist mode: true if @p addr is not in @p list
* @return in blacklist mode: false if @p addr is in @p list
*/
bool l2filter_pass(const l2filter_t *list, const void *addr, size_t addr_len);
#ifdef __cplusplus
}
#endif
#endif /* NET_L2FILTER_H */
/** @} */
|