blob: 6f7af75438ba18359e25f8edad536f6ac2f35c51 (
plain)
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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
|
/**
* @file transform_attribute.h
*
* @brief Declaration of the class transform_attribute_t.
*
* An object of this type represents an IKEv2 TRANSFORM attribute.
*
*/
/*
* Copyright (C) 2005 Jan Hutter, Martin Willi
* 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.
*/
#ifndef TRANSFORM_ATTRIBUTE_H_
#define TRANSFORM_ATTRIBUTE_H_
#include "../types.h"
#include "payload.h"
/**
* Type of the attribute, as in IKEv2 draft 3.3.5
*/
typedef enum transform_attribute_type_e transform_attribute_type_t;
enum transform_attribute_type_e {
ATTRIBUTE_UNDEFINED = 16384,
KEY_LENGTH = 14
};
/**
* string mappings for transform_attribute_type_t
*/
extern mapping_t transform_attribute_type_m[];
/**
* Object representing an IKEv2- TRANSFORM Attribute
*
* The TRANSFORM ATTRIBUTE format is described in RFC section 3.3.5.
*
*/
typedef struct transform_attribute_s transform_attribute_t;
struct transform_attribute_s {
/**
* implements payload_t interface
*/
payload_t payload_interface;
/**
* @brief Returns the currently set value of the attribute
*
* @warning Returned data are not copied
*
* @param this calling transform_attribute_t object
* @return chunk_t pointing to the value
*/
chunk_t (*get_value_chunk) (transform_attribute_t *this);
/**
* @brief Returns the currently set value of the attribute
*
* @warning Returned data are not copied
*
* @param this calling transform_attribute_t object
* @return value
*/
u_int16_t (*get_value) (transform_attribute_t *this);
/**
* @brief Sets the value of the attribute.
*
* @warning Value is getting copied
*
* @param this calling transform_attribute_t object
* @param value chunk_t pointing to the value to set
* @return
* - SUCCESS or
* - OUT_OF_RES
*/
status_t (*set_value_chunk) (transform_attribute_t *this, chunk_t value);
/**
* @brief Sets the value of the attribute.
*
* @param this calling transform_attribute_t object
* @param value value to set
* @return
* - SUCCESS or
* - OUT_OF_RES
*/
status_t (*set_value) (transform_attribute_t *this, u_int16_t value);
/**
* @brief Sets the type of the attribute.
*
* @param this calling transform_attribute_t object
* @param type type to set (most significant bit is set to zero)
* @return SUCCESS
*/
status_t (*set_attribute_type) (transform_attribute_t *this, u_int16_t type);
/**
* @brief get the type of the attribute.
*
* @param this calling transform_attribute_t object
* @return type of the value
*/
u_int16_t (*get_attribute_type) (transform_attribute_t *this);
/**
* @brief Clones an transform_attribute_t object.
*
* @param this transform_attribute_t object to clone
* @param clone the new clone will be written there
* @return
* - OUT_OF_RES
* - SUCCESS
*/
status_t (*clone) (transform_attribute_t *this,transform_attribute_t **clone);
/**
* @brief Destroys an transform_attribute_t object.
*
* @param this transform_attribute_t object to destroy
* @return
* SUCCESS in any case
*/
status_t (*destroy) (transform_attribute_t *this);
};
/**
* @brief Creates an empty transform_attribute_t object
*
* @return
* - created transform_attribute_t object, or
* - NULL if failed
*/
transform_attribute_t *transform_attribute_create();
#endif /*TRANSFORM_ATTRIBUTE_H_*/
|
