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
|
/*
* Copyright (C) 2012-2014 Reto Buerki
* Copyright (C) 2012 Adrian-Ken Rueegsegger
* HSR Hochschule fuer Technik Rapperswil
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the
* Free Software Foundation; either version 2 of the License, or (at your
* option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* for more details.
*/
/**
* @defgroup tkm-kernel-sad kernel sad
* @{ @ingroup tkm
*/
#ifndef TKM_KERNEL_SAD_H_
#define TKM_KERNEL_SAD_H_
#include <networking/host.h>
#include <tkm/types.h>
typedef struct tkm_kernel_sad_t tkm_kernel_sad_t;
/**
* The TKM kernel SAD (security association database) stores information about
* CHILD SAs.
*/
struct tkm_kernel_sad_t {
/**
* Insert new SAD entry with specified parameters.
*
* @param esa_id ESP SA context identifier
* @param reqid reqid of the SA
* @param src source address of CHILD SA
* @param dst destination address of CHILD SA
* @param spi_loc Local SPI of CHILD SA
* @param spi_rem Remote SPI of CHILD SA
* @param proto protocol of CHILD SA (ESP/AH)
* @return TRUE if entry was inserted, FALSE otherwise
*/
bool (*insert)(tkm_kernel_sad_t * const this, const esa_id_type esa_id,
const uint32_t reqid, const host_t * const src,
const host_t * const dst, const uint32_t spi_loc,
const uint32_t spi_rem, const uint8_t proto);
/**
* Get ESA id for entry with given parameters.
*
* @param src source address of CHILD SA
* @param dst destination address of CHILD SA
* @param spi SPI of CHILD SA
* @param proto protocol of CHILD SA (ESP/AH)
* @param local whether the SPI is local or remote
* @return ESA id of entry if found, 0 otherwise
*/
esa_id_type (*get_esa_id)(tkm_kernel_sad_t * const this,
const host_t * const src, const host_t * const dst,
const uint32_t spi, const uint8_t proto, const bool local);
/**
* Get destination host for entry with given parameters.
*
* @param reqid reqid of CHILD SA
* @param spi Remote SPI of CHILD SA
* @param proto protocol of CHILD SA (ESP/AH)
* @return destination host of entry if found (cloned),
* NULL otherwise
*/
host_t * (*get_dst_host)(tkm_kernel_sad_t * const this,
const uint32_t reqid, const uint32_t spi, const uint8_t proto);
/**
* Remove entry with given ESA id from SAD.
*
* @param esa_id ESA identifier of entry to remove
* @return TRUE if entry was removed, FALSE otherwise
*/
bool (*remove)(tkm_kernel_sad_t * const this, const esa_id_type esa_id);
/**
* Destroy a tkm_kernel_sad instance.
*/
void (*destroy)(tkm_kernel_sad_t *this);
};
/**
* Create a TKM kernel SAD instance.
*/
tkm_kernel_sad_t *tkm_kernel_sad_create();
#endif /** TKM_KERNEL_SAD_H_ @}*/
|
