2005-11-14 12:04:06 +00:00
|
|
|
/*
|
2006-07-07 08:49:06 +00:00
|
|
|
* Copyright (C) 2005-2006 Martin Willi
|
|
|
|
* Copyright (C) 2005 Jan Hutter
|
2005-11-14 12:04:06 +00:00
|
|
|
* 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.
|
2008-03-13 14:14:44 +00:00
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @defgroup transform_attribute transform_attribute
|
|
|
|
* @{ @ingroup payloads
|
2005-11-14 12:04:06 +00:00
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef TRANSFORM_ATTRIBUTE_H_
|
|
|
|
#define TRANSFORM_ATTRIBUTE_H_
|
|
|
|
|
2006-10-30 14:07:05 +00:00
|
|
|
typedef enum transform_attribute_type_t transform_attribute_type_t;
|
|
|
|
typedef struct transform_attribute_t transform_attribute_t;
|
|
|
|
|
2006-10-31 12:27:59 +00:00
|
|
|
#include <library.h>
|
2005-11-23 09:57:18 +00:00
|
|
|
#include <encoding/payloads/payload.h>
|
2005-11-14 12:04:06 +00:00
|
|
|
|
2005-11-16 16:12:31 +00:00
|
|
|
|
|
|
|
/**
|
2006-03-07 09:42:15 +00:00
|
|
|
* Type of the attribute, as in IKEv2 RFC 3.3.5.
|
2005-11-16 16:12:31 +00:00
|
|
|
*/
|
2005-11-24 09:17:51 +00:00
|
|
|
enum transform_attribute_type_t {
|
2005-11-16 16:12:31 +00:00
|
|
|
ATTRIBUTE_UNDEFINED = 16384,
|
|
|
|
KEY_LENGTH = 14
|
|
|
|
};
|
|
|
|
|
2009-09-04 11:46:09 +00:00
|
|
|
/**
|
2006-10-18 11:46:13 +00:00
|
|
|
* enum name for transform_attribute_type_t.
|
2005-11-16 16:12:31 +00:00
|
|
|
*/
|
2006-10-18 11:46:13 +00:00
|
|
|
extern enum_name_t *transform_attribute_type_names;
|
2005-11-16 16:12:31 +00:00
|
|
|
|
2005-11-14 12:04:06 +00:00
|
|
|
/**
|
2008-03-13 14:14:44 +00:00
|
|
|
* Class representing an IKEv2- TRANSFORM Attribute.
|
2009-09-04 11:46:09 +00:00
|
|
|
*
|
2005-11-14 12:04:06 +00:00
|
|
|
* The TRANSFORM ATTRIBUTE format is described in RFC section 3.3.5.
|
|
|
|
*/
|
2005-11-24 09:17:51 +00:00
|
|
|
struct transform_attribute_t {
|
2005-11-14 12:04:06 +00:00
|
|
|
/**
|
2005-11-28 18:24:10 +00:00
|
|
|
* The payload_t interface.
|
2005-11-14 12:04:06 +00:00
|
|
|
*/
|
|
|
|
payload_t payload_interface;
|
2005-11-14 13:51:49 +00:00
|
|
|
|
|
|
|
/**
|
2008-03-13 14:14:44 +00:00
|
|
|
* Returns the currently set value of the attribute.
|
2009-09-04 11:46:09 +00:00
|
|
|
*
|
2008-03-13 14:14:44 +00:00
|
|
|
* Returned data are not copied.
|
2009-09-04 11:46:09 +00:00
|
|
|
*
|
2005-11-14 13:51:49 +00:00
|
|
|
* @return chunk_t pointing to the value
|
|
|
|
*/
|
2005-11-16 16:12:31 +00:00
|
|
|
chunk_t (*get_value_chunk) (transform_attribute_t *this);
|
2009-09-04 11:46:09 +00:00
|
|
|
|
2005-11-16 16:12:31 +00:00
|
|
|
/**
|
2008-03-13 14:14:44 +00:00
|
|
|
* Returns the currently set value of the attribute.
|
2009-09-04 11:46:09 +00:00
|
|
|
*
|
2008-03-13 14:14:44 +00:00
|
|
|
* Returned data are not copied.
|
2009-09-04 11:46:09 +00:00
|
|
|
*
|
2005-11-16 16:12:31 +00:00
|
|
|
* @return value
|
|
|
|
*/
|
|
|
|
u_int16_t (*get_value) (transform_attribute_t *this);
|
2009-09-04 11:46:09 +00:00
|
|
|
|
2005-11-14 13:51:49 +00:00
|
|
|
/**
|
2008-03-13 14:14:44 +00:00
|
|
|
* Sets the value of the attribute.
|
2009-09-04 11:46:09 +00:00
|
|
|
*
|
2008-03-13 14:14:44 +00:00
|
|
|
* Value is getting copied.
|
2009-09-04 11:46:09 +00:00
|
|
|
*
|
2005-11-14 13:51:49 +00:00
|
|
|
* @param value chunk_t pointing to the value to set
|
|
|
|
*/
|
2005-11-28 18:24:10 +00:00
|
|
|
void (*set_value_chunk) (transform_attribute_t *this, chunk_t value);
|
2005-11-16 16:12:31 +00:00
|
|
|
|
|
|
|
/**
|
2008-03-13 14:14:44 +00:00
|
|
|
* Sets the value of the attribute.
|
2009-09-04 11:46:09 +00:00
|
|
|
*
|
2005-11-16 16:12:31 +00:00
|
|
|
* @param value value to set
|
|
|
|
*/
|
2005-11-28 18:24:10 +00:00
|
|
|
void (*set_value) (transform_attribute_t *this, u_int16_t value);
|
2005-11-14 13:51:49 +00:00
|
|
|
|
|
|
|
/**
|
2008-03-13 14:14:44 +00:00
|
|
|
* Sets the type of the attribute.
|
2009-09-04 11:46:09 +00:00
|
|
|
*
|
2005-11-14 13:51:49 +00:00
|
|
|
* @param type type to set (most significant bit is set to zero)
|
|
|
|
*/
|
2005-11-28 18:24:10 +00:00
|
|
|
void (*set_attribute_type) (transform_attribute_t *this, u_int16_t type);
|
2009-09-04 11:46:09 +00:00
|
|
|
|
2005-11-14 13:51:49 +00:00
|
|
|
/**
|
2008-03-13 14:14:44 +00:00
|
|
|
* get the type of the attribute.
|
2009-09-04 11:46:09 +00:00
|
|
|
*
|
2005-11-14 13:51:49 +00:00
|
|
|
* @return type of the value
|
|
|
|
*/
|
|
|
|
u_int16_t (*get_attribute_type) (transform_attribute_t *this);
|
2009-09-04 11:46:09 +00:00
|
|
|
|
2005-11-21 13:44:16 +00:00
|
|
|
/**
|
2008-03-13 14:14:44 +00:00
|
|
|
* Clones an transform_attribute_t object.
|
2005-11-21 13:44:16 +00:00
|
|
|
*
|
2005-11-29 08:54:48 +00:00
|
|
|
* @return cloned transform_attribute_t object
|
2005-11-21 13:44:16 +00:00
|
|
|
*/
|
2005-11-29 08:54:48 +00:00
|
|
|
transform_attribute_t * (*clone) (transform_attribute_t *this);
|
2005-11-21 13:44:16 +00:00
|
|
|
|
2005-11-14 12:04:06 +00:00
|
|
|
/**
|
2008-03-13 14:14:44 +00:00
|
|
|
* Destroys an transform_attribute_t object.
|
2005-11-14 12:04:06 +00:00
|
|
|
*/
|
2005-11-28 18:24:10 +00:00
|
|
|
void (*destroy) (transform_attribute_t *this);
|
2005-11-14 12:04:06 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
2008-03-13 14:14:44 +00:00
|
|
|
* Creates an empty transform_attribute_t object.
|
2009-09-04 11:46:09 +00:00
|
|
|
*
|
2005-12-06 13:44:22 +00:00
|
|
|
* @return transform_attribute_t object
|
2005-11-14 12:04:06 +00:00
|
|
|
*/
|
2006-05-09 07:34:25 +00:00
|
|
|
transform_attribute_t *transform_attribute_create(void);
|
2005-11-14 12:04:06 +00:00
|
|
|
|
2005-12-01 08:48:57 +00:00
|
|
|
/**
|
2008-03-13 14:14:44 +00:00
|
|
|
* Creates an transform_attribute_t of type KEY_LENGTH.
|
2009-09-04 11:46:09 +00:00
|
|
|
*
|
2005-12-01 08:48:57 +00:00
|
|
|
* @param key_length key length in bytes
|
2005-12-06 13:44:22 +00:00
|
|
|
* @return transform_attribute_t object
|
2005-12-01 08:48:57 +00:00
|
|
|
*/
|
|
|
|
transform_attribute_t *transform_attribute_create_key_length(u_int16_t key_length);
|
|
|
|
|
2009-03-24 17:43:01 +00:00
|
|
|
#endif /** TRANSFORM_ATTRIBUTE_H_ @}*/
|