2005-11-14 06:55:51 +00:00
|
|
|
/**
|
|
|
|
* @file ike_header.h
|
|
|
|
*
|
2005-11-28 18:24:10 +00:00
|
|
|
* @brief Interface of ike_header_t.
|
2005-11-14 06:55:51 +00:00
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
|
|
|
/*
|
|
|
|
* 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 IKE_HEADER_H_
|
|
|
|
#define IKE_HEADER_H_
|
|
|
|
|
2005-11-23 09:08:45 +00:00
|
|
|
#include <types.h>
|
2005-11-23 09:57:18 +00:00
|
|
|
#include <encoding/payloads/payload.h>
|
2005-11-14 06:55:51 +00:00
|
|
|
|
|
|
|
/**
|
2005-11-28 18:24:10 +00:00
|
|
|
* Major Version of IKEv2.
|
|
|
|
*
|
|
|
|
* @ingroup payloads
|
2005-11-14 09:00:33 +00:00
|
|
|
*/
|
|
|
|
#define IKE_MAJOR_VERSION 2
|
|
|
|
|
|
|
|
/**
|
2005-11-28 18:24:10 +00:00
|
|
|
* Minor Version of IKEv2.
|
|
|
|
*
|
|
|
|
* @ingroup payloads
|
2005-11-14 09:00:33 +00:00
|
|
|
*/
|
|
|
|
#define IKE_MINOR_VERSION 0
|
|
|
|
|
|
|
|
/**
|
2005-11-28 18:24:10 +00:00
|
|
|
* Flag in IKEv2-Header. Always 0.
|
|
|
|
*
|
|
|
|
* @ingroup payloads
|
2005-11-14 09:00:33 +00:00
|
|
|
*/
|
|
|
|
#define HIGHER_VERSION_SUPPORTED_FLAG 0
|
|
|
|
|
|
|
|
/**
|
2005-11-28 18:24:10 +00:00
|
|
|
* Length of IKE Header in Bytes.
|
|
|
|
*
|
|
|
|
* @ingroup payloads
|
2005-11-14 09:00:33 +00:00
|
|
|
*/
|
|
|
|
#define IKE_HEADER_LENGTH 28
|
|
|
|
|
2005-11-24 09:17:51 +00:00
|
|
|
typedef enum exchange_type_t exchange_type_t;
|
|
|
|
|
2005-11-14 09:00:33 +00:00
|
|
|
/**
|
|
|
|
* @brief Different types of IKE-Exchanges.
|
|
|
|
*
|
2005-11-28 18:24:10 +00:00
|
|
|
* See Draft for different types.
|
|
|
|
*
|
|
|
|
* @ingroup payloads
|
2005-11-14 09:00:33 +00:00
|
|
|
*/
|
2005-11-24 09:17:51 +00:00
|
|
|
enum exchange_type_t{
|
2005-11-14 09:00:33 +00:00
|
|
|
|
|
|
|
/**
|
2005-12-06 13:44:22 +00:00
|
|
|
* EXCHANGE_TYPE_UNDEFINED. In private space, since not a official message type.
|
2005-11-14 09:00:33 +00:00
|
|
|
*/
|
2005-11-16 16:12:03 +00:00
|
|
|
EXCHANGE_TYPE_UNDEFINED = 240,
|
2005-11-28 18:24:10 +00:00
|
|
|
|
2005-11-14 09:00:33 +00:00
|
|
|
/**
|
2005-11-28 18:24:10 +00:00
|
|
|
* IKE_SA_INIT.
|
2005-11-14 09:00:33 +00:00
|
|
|
*/
|
|
|
|
IKE_SA_INIT = 34,
|
2005-11-28 18:24:10 +00:00
|
|
|
|
2005-11-14 09:00:33 +00:00
|
|
|
/**
|
2005-11-28 18:24:10 +00:00
|
|
|
* IKE_AUTH.
|
2005-11-14 09:00:33 +00:00
|
|
|
*/
|
|
|
|
IKE_AUTH = 35,
|
2005-11-28 18:24:10 +00:00
|
|
|
|
2005-11-14 09:00:33 +00:00
|
|
|
/**
|
2005-11-28 18:24:10 +00:00
|
|
|
* CREATE_CHILD_SA.
|
2005-11-14 09:00:33 +00:00
|
|
|
*/
|
|
|
|
CREATE_CHILD_SA = 36,
|
2005-11-28 18:24:10 +00:00
|
|
|
|
2005-11-14 09:00:33 +00:00
|
|
|
/**
|
2005-11-28 18:24:10 +00:00
|
|
|
* INFORMATIONAL.
|
2005-11-14 09:00:33 +00:00
|
|
|
*/
|
|
|
|
INFORMATIONAL = 37
|
|
|
|
};
|
|
|
|
|
2005-12-06 13:44:22 +00:00
|
|
|
/**
|
|
|
|
* string mappings for exchange_type_t
|
|
|
|
*
|
|
|
|
* @ingroup payloads
|
|
|
|
*/
|
2005-11-16 16:12:03 +00:00
|
|
|
extern mapping_t exchange_type_m[];
|
|
|
|
|
2005-12-06 13:44:22 +00:00
|
|
|
|
2005-11-24 09:17:51 +00:00
|
|
|
typedef struct ike_header_t ike_header_t;
|
|
|
|
|
2005-11-14 09:00:33 +00:00
|
|
|
/**
|
2005-12-06 13:44:22 +00:00
|
|
|
* @brief An object of this type represents an IKEv2 header and is used to
|
2005-11-28 18:24:10 +00:00
|
|
|
* generate and parse IKEv2 headers.
|
|
|
|
*
|
2005-11-14 06:55:51 +00:00
|
|
|
* The header format of an IKEv2-Message is compatible to the
|
|
|
|
* ISAKMP-Header format to allow implementations supporting
|
|
|
|
* both versions of the IKE-protocol.
|
|
|
|
*
|
2005-12-06 13:44:22 +00:00
|
|
|
* @b Constructors:
|
|
|
|
* - ike_header_create()
|
|
|
|
*
|
2005-11-28 18:24:10 +00:00
|
|
|
* @ingroup payloads
|
2005-11-14 06:55:51 +00:00
|
|
|
*/
|
2005-11-24 09:17:51 +00:00
|
|
|
struct ike_header_t {
|
2005-11-14 06:55:51 +00:00
|
|
|
/**
|
2005-11-28 18:24:10 +00:00
|
|
|
* The payload_t interface.
|
2005-11-14 06:55:51 +00:00
|
|
|
*/
|
|
|
|
payload_t payload_interface;
|
2005-11-15 08:09:58 +00:00
|
|
|
|
2005-11-14 06:55:51 +00:00
|
|
|
/**
|
2005-11-28 18:24:10 +00:00
|
|
|
* @brief Get the initiator spi.
|
2005-11-15 08:09:58 +00:00
|
|
|
*
|
|
|
|
* @param this ike_header_t object
|
|
|
|
* @return initiator_spi
|
2005-11-14 06:55:51 +00:00
|
|
|
*/
|
2005-11-15 08:09:58 +00:00
|
|
|
u_int64_t (*get_initiator_spi) (ike_header_t *this);
|
|
|
|
|
2005-11-14 06:55:51 +00:00
|
|
|
/**
|
2005-11-28 18:24:10 +00:00
|
|
|
* @brief Set the initiator spi.
|
2005-11-15 08:09:58 +00:00
|
|
|
*
|
|
|
|
* @param this ike_header_t object
|
|
|
|
* @param initiator_spi initiator_spi
|
2005-11-14 06:55:51 +00:00
|
|
|
*/
|
2005-11-15 08:09:58 +00:00
|
|
|
void (*set_initiator_spi) (ike_header_t *this, u_int64_t initiator_spi);
|
|
|
|
|
2005-11-14 06:55:51 +00:00
|
|
|
/**
|
2005-11-28 18:24:10 +00:00
|
|
|
* @brief Get the responder spi.
|
2005-11-15 08:09:58 +00:00
|
|
|
*
|
|
|
|
* @param this ike_header_t object
|
|
|
|
* @return responder_spi
|
2005-11-14 06:55:51 +00:00
|
|
|
*/
|
2005-11-15 08:09:58 +00:00
|
|
|
u_int64_t (*get_responder_spi) (ike_header_t *this);
|
|
|
|
|
2005-11-14 06:55:51 +00:00
|
|
|
/**
|
2005-11-28 18:24:10 +00:00
|
|
|
* @brief Set the responder spi.
|
2005-11-15 08:09:58 +00:00
|
|
|
*
|
|
|
|
* @param this ike_header_t object
|
|
|
|
* @param responder_spi responder_spi
|
2005-11-14 06:55:51 +00:00
|
|
|
*/
|
2005-11-15 08:09:58 +00:00
|
|
|
void (*set_responder_spi) (ike_header_t *this, u_int64_t responder_spi);
|
|
|
|
|
2005-11-14 06:55:51 +00:00
|
|
|
/**
|
2005-11-28 18:24:10 +00:00
|
|
|
* @brief Get the major version.
|
2005-11-15 08:09:58 +00:00
|
|
|
*
|
|
|
|
* @param this ike_header_t object
|
|
|
|
* @return major version
|
|
|
|
*/
|
|
|
|
u_int8_t (*get_maj_version) (ike_header_t *this);
|
|
|
|
|
2005-11-14 06:55:51 +00:00
|
|
|
/**
|
2005-11-28 18:24:10 +00:00
|
|
|
* @brief Get the minor version.
|
2005-11-15 08:09:58 +00:00
|
|
|
*
|
|
|
|
* @param this ike_header_t object
|
|
|
|
* @return minor version
|
|
|
|
*/
|
|
|
|
u_int8_t (*get_min_version) (ike_header_t *this);
|
2005-11-14 06:55:51 +00:00
|
|
|
|
|
|
|
/**
|
2005-11-28 18:24:10 +00:00
|
|
|
* @brief Get the response flag.
|
2005-11-15 08:09:58 +00:00
|
|
|
*
|
|
|
|
* @param this ike_header_t object
|
|
|
|
* @return response flag
|
2005-11-14 06:55:51 +00:00
|
|
|
*/
|
2005-11-15 08:09:58 +00:00
|
|
|
bool (*get_response_flag) (ike_header_t *this);
|
|
|
|
|
2005-11-15 08:52:48 +00:00
|
|
|
/**
|
2005-11-28 18:24:10 +00:00
|
|
|
* @brief Set the response flag-
|
2005-11-15 08:52:48 +00:00
|
|
|
*
|
|
|
|
* @param this ike_header_t object
|
|
|
|
* @param response response flag
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
void (*set_response_flag) (ike_header_t *this, bool response);
|
2005-11-14 06:55:51 +00:00
|
|
|
/**
|
2005-11-28 18:24:10 +00:00
|
|
|
* @brief Get "higher version supported"-flag.
|
2005-11-15 08:09:58 +00:00
|
|
|
*
|
|
|
|
* @param this ike_header_t object
|
|
|
|
* @return version flag
|
2005-11-14 06:55:51 +00:00
|
|
|
*/
|
2005-11-15 08:09:58 +00:00
|
|
|
bool (*get_version_flag) (ike_header_t *this);
|
|
|
|
|
|
|
|
/**
|
2005-11-28 18:24:10 +00:00
|
|
|
* @brief Get the initiator flag.
|
2005-11-15 08:09:58 +00:00
|
|
|
*
|
|
|
|
* @param this ike_header_t object
|
|
|
|
* @return initiator flag
|
|
|
|
*/
|
|
|
|
bool (*get_initiator_flag) (ike_header_t *this);
|
|
|
|
|
2005-11-15 08:52:48 +00:00
|
|
|
/**
|
2005-11-28 18:24:10 +00:00
|
|
|
* @brief Set the initiator flag.
|
2005-11-15 08:52:48 +00:00
|
|
|
*
|
|
|
|
* @param this ike_header_t object
|
|
|
|
* @param initiator initiator flag
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
void (*set_initiator_flag) (ike_header_t *this, bool initiator);
|
|
|
|
|
2005-11-15 08:09:58 +00:00
|
|
|
/**
|
2005-11-28 18:24:10 +00:00
|
|
|
* @brief Get the exchange type.
|
2005-11-15 08:09:58 +00:00
|
|
|
*
|
|
|
|
* @param this ike_header_t object
|
|
|
|
* @return exchange type
|
|
|
|
*/
|
|
|
|
u_int8_t (*get_exchange_type) (ike_header_t *this);
|
|
|
|
|
2005-11-14 06:55:51 +00:00
|
|
|
/**
|
2005-11-28 18:24:10 +00:00
|
|
|
* @brief Set the exchange type.
|
2005-11-15 08:09:58 +00:00
|
|
|
*
|
|
|
|
* @param this ike_header_t object
|
|
|
|
* @param exchange_type exchange type
|
|
|
|
*/
|
|
|
|
void (*set_exchange_type) (ike_header_t *this, u_int8_t exchange_type);
|
|
|
|
|
|
|
|
/**
|
2005-11-28 18:24:10 +00:00
|
|
|
* @brief Get the message id.
|
2005-11-15 08:09:58 +00:00
|
|
|
*
|
|
|
|
* @param this ike_header_t object
|
|
|
|
* @return message id
|
|
|
|
*/
|
|
|
|
u_int32_t (*get_message_id) (ike_header_t *this);
|
|
|
|
|
|
|
|
/**
|
2005-11-28 18:24:10 +00:00
|
|
|
* @brief Set the message id.
|
2005-11-15 08:09:58 +00:00
|
|
|
*
|
|
|
|
* @param this ike_header_t object
|
|
|
|
* @param initiator_spi message id
|
2005-11-14 06:55:51 +00:00
|
|
|
*/
|
2005-11-15 08:09:58 +00:00
|
|
|
void (*set_message_id) (ike_header_t *this, u_int32_t message_id);
|
2005-11-14 08:12:59 +00:00
|
|
|
|
|
|
|
/**
|
2005-11-14 09:00:33 +00:00
|
|
|
* @brief Destroys a ike_header_t object.
|
2005-11-14 08:12:59 +00:00
|
|
|
*
|
2005-12-06 13:44:22 +00:00
|
|
|
* @param this ike_header_t object to destroy
|
2005-11-14 08:12:59 +00:00
|
|
|
*/
|
2005-11-28 18:24:10 +00:00
|
|
|
void (*destroy) (ike_header_t *this);
|
2005-11-14 06:55:51 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
2005-11-14 09:00:33 +00:00
|
|
|
* @brief Create an ike_header_t object
|
2005-11-14 06:55:51 +00:00
|
|
|
*
|
2005-12-06 13:44:22 +00:00
|
|
|
* @return ike_header_t object
|
2005-11-28 18:24:10 +00:00
|
|
|
*
|
|
|
|
* @ingroup payloads
|
2005-11-14 06:55:51 +00:00
|
|
|
*/
|
2005-11-14 07:15:43 +00:00
|
|
|
ike_header_t *ike_header_create();
|
2005-11-14 06:55:51 +00:00
|
|
|
|
|
|
|
#endif /*IKE_HEADER_H_*/
|