Blame view

RIOT/sys/include/net/gnrc/ipv6/whitelist.h 1.65 KB
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
  /*
   * Copyright (C) 2015 Martine Lenders <mlenders@inf.fu-berlin.de>
   *
   * 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_gnrc_ipv6_whitelist IPv6 address whitelist
   * @ingroup     net_gnrc_ipv6
   * @brief       This allows you to only accept IPv6 addresses that are defined in this list.
   * @{
   *
   * @file
   * @brief   IPv6 whitelist definitions
   *
   * @author  Martine Lenders <mlenders@inf.fu-berlin.de>
   */
  #ifndef NET_GNRC_IPV6_WHITELIST_H
  #define NET_GNRC_IPV6_WHITELIST_H
  
  #include <stdbool.h>
  
  #include "net/ipv6/addr.h"
  
  #ifdef __cplusplus
  extern "C" {
  #endif
  
  /**
   * Maximum size of the whitelist.
   */
  #ifndef GNRC_IPV6_WHITELIST_SIZE
  #define GNRC_IPV6_WHITELIST_SIZE    (8)
  #endif
  
  /**
   * @brief   Adds an IPv6 address to the whitelist.
   *
   * @param[in] addr  An IPv6 address.
   *
   * @return  0, on success.
   * @return  -1, if whitelist is full.
   */
  int gnrc_ipv6_whitelist_add(const ipv6_addr_t *addr);
  
  /**
   * @brief   Removes an IPv6 address from the whitelist.
   *
   * Addresses not in the whitelist will be ignored.
   *
   * @param[in] addr  An IPv6 address.
   */
  void gnrc_ipv6_whitelist_del(const ipv6_addr_t *addr);
  
  /**
   * @brief   Checks if an IPv6 address is whitelisted.
   *
   * @param[in] addr  An IPv6 address.
   *
   * @return  true, if @p addr is whitelisted.
   * @return  false, if @p addr is not whitelisted.
   */
  bool gnrc_ipv6_whitelisted(const ipv6_addr_t *addr);
  
  /**
   * @brief   Prints the whitelist.
   */
  void gnrc_ipv6_whitelist_print(void);
  
  #ifdef __cplusplus
  }
  #endif
  
  #endif /* NET_GNRC_IPV6_WHITELIST_H */
  /** @} */