2005-11-14 06:55:51 +00:00
|
|
|
/*
|
2007-10-03 15:10:41 +00:00
|
|
|
* Copyright (C) 2007 Tobias Brunner
|
2006-07-07 08:49:06 +00:00
|
|
|
* Copyright (C) 2005-2006 Martin Willi
|
|
|
|
* Copyright (C) 2005 Jan Hutter
|
2005-11-14 06:55:51 +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 payload payload
|
|
|
|
* @{ @ingroup payloads
|
2005-11-14 06:55:51 +00:00
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef PAYLOAD_H_
|
|
|
|
#define PAYLOAD_H_
|
|
|
|
|
2006-10-30 14:07:05 +00:00
|
|
|
typedef enum payload_type_t payload_type_t;
|
|
|
|
typedef struct payload_t payload_t;
|
|
|
|
|
2006-10-31 12:27:59 +00:00
|
|
|
#include <library.h>
|
2005-11-23 09:57:18 +00:00
|
|
|
#include <encoding/payloads/encodings.h>
|
2005-11-14 06:55:51 +00:00
|
|
|
|
2011-11-16 08:29:38 +00:00
|
|
|
/**
|
|
|
|
* Domain of interpretation used by IPsec/IKEv1
|
|
|
|
*/
|
|
|
|
#define IKEV1_DOI_IPSEC 1
|
2005-11-14 06:55:51 +00:00
|
|
|
|
|
|
|
/**
|
2011-11-15 13:47:20 +00:00
|
|
|
* Payload-Types of an IKE message.
|
2006-10-30 14:07:05 +00:00
|
|
|
*
|
2009-09-02 15:26:36 +00:00
|
|
|
* Header and substructures are also defined as
|
2005-11-14 06:55:51 +00:00
|
|
|
* payload types with values from PRIVATE USE space.
|
|
|
|
*/
|
2011-11-15 13:47:20 +00:00
|
|
|
enum payload_type_t {
|
2005-11-14 06:55:51 +00:00
|
|
|
|
|
|
|
/**
|
2005-12-06 11:51:13 +00:00
|
|
|
* End of payload list in next_payload
|
2005-11-14 06:55:51 +00:00
|
|
|
*/
|
|
|
|
NO_PAYLOAD = 0,
|
2009-09-04 11:46:09 +00:00
|
|
|
|
2011-11-15 13:47:20 +00:00
|
|
|
/**
|
|
|
|
* The security association (SA) payload containing proposals.
|
|
|
|
*/
|
|
|
|
SECURITY_ASSOCIATION_V1 = 1,
|
|
|
|
|
|
|
|
/**
|
|
|
|
* The proposal payload, containing transforms.
|
|
|
|
*/
|
|
|
|
PROPOSAL_V1 = 2,
|
|
|
|
|
|
|
|
/**
|
|
|
|
* The transform payload.
|
|
|
|
*/
|
|
|
|
TRANSFORM_V1 = 3,
|
|
|
|
|
|
|
|
/**
|
|
|
|
* The key exchange (KE) payload containing diffie-hellman values.
|
|
|
|
*/
|
|
|
|
KEY_EXCHANGE_V1 = 4,
|
|
|
|
|
|
|
|
/**
|
|
|
|
* ID payload.
|
|
|
|
*/
|
|
|
|
ID_V1 = 5,
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Certificate payload with certificates (CERT).
|
|
|
|
*/
|
|
|
|
CERTIFICATE_V1 = 6,
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Certificate request payload.
|
|
|
|
*/
|
|
|
|
CERTIFICATE_REQUEST_V1 = 7,
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Hash payload.
|
|
|
|
*/
|
|
|
|
HASH_V1 = 8,
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Signature payload
|
|
|
|
*/
|
|
|
|
SIGNATURE_V1 = 9,
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Nonce payload.
|
|
|
|
*/
|
|
|
|
NONCE_V1 = 10,
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Notification payload.
|
|
|
|
*/
|
|
|
|
NOTIFICATION_V1 = 11,
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Delete payload.
|
|
|
|
*/
|
|
|
|
DELETE_V1 = 12,
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Vendor id payload.
|
|
|
|
*/
|
|
|
|
VENDOR_ID_V1 = 13,
|
|
|
|
|
2005-11-14 06:55:51 +00:00
|
|
|
/**
|
2005-12-06 11:51:13 +00:00
|
|
|
* The security association (SA) payload containing proposals.
|
2005-11-14 06:55:51 +00:00
|
|
|
*/
|
|
|
|
SECURITY_ASSOCIATION = 33,
|
2005-11-28 18:24:10 +00:00
|
|
|
|
2005-11-14 06:55:51 +00:00
|
|
|
/**
|
2005-12-06 11:51:13 +00:00
|
|
|
* The key exchange (KE) payload containing diffie-hellman values.
|
2005-11-14 06:55:51 +00:00
|
|
|
*/
|
|
|
|
KEY_EXCHANGE = 34,
|
2005-11-28 18:24:10 +00:00
|
|
|
|
2005-11-14 06:55:51 +00:00
|
|
|
/**
|
2005-12-06 11:51:13 +00:00
|
|
|
* Identification for the original initiator (IDi).
|
2005-11-14 06:55:51 +00:00
|
|
|
*/
|
|
|
|
ID_INITIATOR = 35,
|
2005-11-28 18:24:10 +00:00
|
|
|
|
2005-11-14 06:55:51 +00:00
|
|
|
/**
|
2005-12-06 11:51:13 +00:00
|
|
|
* Identification for the original responder (IDr).
|
2005-11-14 06:55:51 +00:00
|
|
|
*/
|
|
|
|
ID_RESPONDER = 36,
|
2005-11-28 18:24:10 +00:00
|
|
|
|
2005-11-14 06:55:51 +00:00
|
|
|
/**
|
2005-12-06 11:51:13 +00:00
|
|
|
* Certificate payload with certificates (CERT).
|
2005-11-14 06:55:51 +00:00
|
|
|
*/
|
|
|
|
CERTIFICATE = 37,
|
2005-11-28 18:24:10 +00:00
|
|
|
|
2005-11-14 06:55:51 +00:00
|
|
|
/**
|
2005-12-06 11:51:13 +00:00
|
|
|
* Certificate request payload (CERTREQ).
|
2005-11-14 06:55:51 +00:00
|
|
|
*/
|
|
|
|
CERTIFICATE_REQUEST = 38,
|
2005-11-28 18:24:10 +00:00
|
|
|
|
2005-11-14 06:55:51 +00:00
|
|
|
/**
|
2005-12-06 11:51:13 +00:00
|
|
|
* Authentication payload contains auth data (AUTH).
|
2005-11-14 06:55:51 +00:00
|
|
|
*/
|
|
|
|
AUTHENTICATION = 39,
|
2005-11-28 18:24:10 +00:00
|
|
|
|
2005-11-14 06:55:51 +00:00
|
|
|
/**
|
2011-08-15 14:31:04 +00:00
|
|
|
* Nonces, for initiator and responder (Ni, Nr, N)
|
2005-11-14 06:55:51 +00:00
|
|
|
*/
|
|
|
|
NONCE = 40,
|
2005-11-28 18:24:10 +00:00
|
|
|
|
2005-11-14 06:55:51 +00:00
|
|
|
/**
|
2009-02-17 17:14:15 +00:00
|
|
|
* Notify paylaod (N).
|
2005-11-14 06:55:51 +00:00
|
|
|
*/
|
|
|
|
NOTIFY = 41,
|
2005-11-28 18:24:10 +00:00
|
|
|
|
2005-11-14 06:55:51 +00:00
|
|
|
/**
|
2005-12-06 11:51:13 +00:00
|
|
|
* Delete payload (D)
|
2005-11-14 06:55:51 +00:00
|
|
|
*/
|
|
|
|
DELETE = 42,
|
2005-11-28 18:24:10 +00:00
|
|
|
|
2005-11-14 06:55:51 +00:00
|
|
|
/**
|
2005-12-06 11:51:13 +00:00
|
|
|
* Vendor id paylpoad (V).
|
2005-11-14 06:55:51 +00:00
|
|
|
*/
|
|
|
|
VENDOR_ID = 43,
|
2005-11-28 18:24:10 +00:00
|
|
|
|
2005-11-14 06:55:51 +00:00
|
|
|
/**
|
2005-12-06 11:51:13 +00:00
|
|
|
* Traffic selector for the original initiator (TSi).
|
2005-11-14 06:55:51 +00:00
|
|
|
*/
|
|
|
|
TRAFFIC_SELECTOR_INITIATOR = 44,
|
2005-11-28 18:24:10 +00:00
|
|
|
|
2005-11-14 06:55:51 +00:00
|
|
|
/**
|
2005-12-06 11:51:13 +00:00
|
|
|
* Traffic selector for the original responser (TSr).
|
2005-11-14 06:55:51 +00:00
|
|
|
*/
|
|
|
|
TRAFFIC_SELECTOR_RESPONDER = 45,
|
2005-11-28 18:24:10 +00:00
|
|
|
|
2005-11-14 06:55:51 +00:00
|
|
|
/**
|
2005-12-06 11:51:13 +00:00
|
|
|
* Encryption payload, contains other payloads (E).
|
2005-11-14 06:55:51 +00:00
|
|
|
*/
|
|
|
|
ENCRYPTED = 46,
|
2005-11-28 18:24:10 +00:00
|
|
|
|
2005-11-14 06:55:51 +00:00
|
|
|
/**
|
2005-12-06 11:51:13 +00:00
|
|
|
* Configuration payload (CP).
|
2005-11-14 06:55:51 +00:00
|
|
|
*/
|
|
|
|
CONFIGURATION = 47,
|
2005-11-28 18:24:10 +00:00
|
|
|
|
2005-11-14 06:55:51 +00:00
|
|
|
/**
|
2005-12-06 11:51:13 +00:00
|
|
|
* Extensible authentication payload (EAP).
|
2005-11-14 06:55:51 +00:00
|
|
|
*/
|
|
|
|
EXTENSIBLE_AUTHENTICATION = 48,
|
2009-09-04 11:46:09 +00:00
|
|
|
|
2008-03-26 18:40:19 +00:00
|
|
|
#ifdef ME
|
2007-10-03 15:10:41 +00:00
|
|
|
/**
|
2008-03-26 18:40:19 +00:00
|
|
|
* Identification payload for peers has a value from
|
2009-09-02 15:26:36 +00:00
|
|
|
* the PRIVATE USE space.
|
2007-10-03 15:10:41 +00:00
|
|
|
*/
|
|
|
|
ID_PEER = 128,
|
2008-03-26 18:40:19 +00:00
|
|
|
#endif /* ME */
|
2009-09-04 11:46:09 +00:00
|
|
|
|
2005-11-14 06:55:51 +00:00
|
|
|
/**
|
2005-11-28 18:24:10 +00:00
|
|
|
* Header has a value of PRIVATE USE space.
|
2009-09-02 15:26:36 +00:00
|
|
|
*
|
|
|
|
* This payload type is not sent over wire and just
|
2005-11-14 06:55:51 +00:00
|
|
|
* used internally to handle IKEv2-Header like a payload.
|
|
|
|
*/
|
2010-11-10 14:41:46 +00:00
|
|
|
HEADER = 256,
|
2009-09-04 11:46:09 +00:00
|
|
|
|
2005-11-14 10:14:22 +00:00
|
|
|
/**
|
2005-11-28 18:24:10 +00:00
|
|
|
* PROPOSAL_SUBSTRUCTURE has a value of PRIVATE USE space.
|
2009-09-02 15:26:36 +00:00
|
|
|
*
|
|
|
|
* This payload type is not sent over wire and just
|
2005-11-14 10:14:22 +00:00
|
|
|
* used internally to handle a proposal substructure like a payload.
|
|
|
|
*/
|
2010-11-10 14:41:46 +00:00
|
|
|
PROPOSAL_SUBSTRUCTURE = 257,
|
2005-11-14 10:14:22 +00:00
|
|
|
|
|
|
|
/**
|
2005-11-28 18:24:10 +00:00
|
|
|
* TRANSFORM_SUBSTRUCTURE has a value of PRIVATE USE space.
|
2009-09-02 15:26:36 +00:00
|
|
|
*
|
|
|
|
* This payload type is not sent over wire and just
|
2005-11-14 10:14:22 +00:00
|
|
|
* used internally to handle a transform substructure like a payload.
|
|
|
|
*/
|
2010-11-10 14:41:46 +00:00
|
|
|
TRANSFORM_SUBSTRUCTURE = 258,
|
2009-09-04 11:46:09 +00:00
|
|
|
|
2005-11-14 12:04:06 +00:00
|
|
|
/**
|
2005-11-28 18:24:10 +00:00
|
|
|
* TRANSFORM_ATTRIBUTE has a value of PRIVATE USE space.
|
2009-09-02 15:26:36 +00:00
|
|
|
*
|
|
|
|
* This payload type is not sent over wire and just
|
2005-11-14 12:04:06 +00:00
|
|
|
* used internally to handle a transform attribute like a payload.
|
|
|
|
*/
|
2010-11-10 14:41:46 +00:00
|
|
|
TRANSFORM_ATTRIBUTE = 259,
|
2005-11-29 15:23:04 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* TRAFFIC_SELECTOR_SUBSTRUCTURE has a value of PRIVATE USE space.
|
2009-09-02 15:26:36 +00:00
|
|
|
*
|
|
|
|
* This payload type is not sent over wire and just
|
2005-11-29 15:23:04 +00:00
|
|
|
* used internally to handle a transform selector like a payload.
|
2009-09-02 15:26:36 +00:00
|
|
|
*/
|
2010-11-10 14:41:46 +00:00
|
|
|
TRAFFIC_SELECTOR_SUBSTRUCTURE = 260,
|
2009-09-04 11:46:09 +00:00
|
|
|
|
2005-12-05 18:16:39 +00:00
|
|
|
/**
|
|
|
|
* CONFIGURATION_ATTRIBUTE has a value of PRIVATE USE space.
|
2009-09-02 15:26:36 +00:00
|
|
|
*
|
|
|
|
* This payload type is not sent over wire and just
|
2005-12-05 18:16:39 +00:00
|
|
|
* used internally to handle a transform attribute like a payload.
|
|
|
|
*/
|
2010-11-10 14:41:46 +00:00
|
|
|
CONFIGURATION_ATTRIBUTE = 261,
|
2011-11-16 08:29:38 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* PROPOSAL_SUBSTRUCTURE has a value of PRIVATE USE space.
|
|
|
|
*
|
|
|
|
* This payload type is not sent over wire and just
|
|
|
|
* used internally to handle a proposal substructure like a payload.
|
|
|
|
*/
|
|
|
|
PROPOSAL_SUBSTRUCTURE_V1 = 262,
|
2005-11-14 06:55:51 +00:00
|
|
|
};
|
|
|
|
|
2005-12-06 11:51:13 +00:00
|
|
|
/**
|
2006-10-18 11:46:13 +00:00
|
|
|
* enum names for payload_type_t.
|
2005-11-14 06:55:51 +00:00
|
|
|
*/
|
2006-10-18 11:46:13 +00:00
|
|
|
extern enum_name_t *payload_type_names;
|
2005-11-14 06:55:51 +00:00
|
|
|
|
2006-07-05 10:53:20 +00:00
|
|
|
/**
|
2006-10-18 11:46:13 +00:00
|
|
|
* enum names for payload_type_t in a short form.
|
2006-07-05 10:53:20 +00:00
|
|
|
*/
|
2006-10-18 11:46:13 +00:00
|
|
|
extern enum_name_t *payload_type_short_names;
|
2006-07-05 10:53:20 +00:00
|
|
|
|
2005-11-14 06:55:51 +00:00
|
|
|
/**
|
2008-03-13 14:14:44 +00:00
|
|
|
* Generic interface for all payload types (incl.header and substructures).
|
2009-09-02 15:26:36 +00:00
|
|
|
*
|
2005-12-06 11:51:13 +00:00
|
|
|
* To handle all kinds of payloads on a generic way, this interface must
|
|
|
|
* be implemented by every payload. This allows parser_t/generator_t a simple
|
|
|
|
* handling of all payloads.
|
2005-11-14 06:55:51 +00:00
|
|
|
*/
|
2005-11-24 09:17:51 +00:00
|
|
|
struct payload_t {
|
2009-09-04 11:46:09 +00:00
|
|
|
|
2005-11-14 06:55:51 +00:00
|
|
|
/**
|
2008-03-13 14:14:44 +00:00
|
|
|
* Get encoding rules for this payload.
|
2005-11-14 06:55:51 +00:00
|
|
|
*
|
2008-03-13 14:14:44 +00:00
|
|
|
* @param rules location to store pointer of first rule
|
|
|
|
* @param rule_count location to store number of rules
|
2005-11-14 06:55:51 +00:00
|
|
|
*/
|
2005-11-28 18:24:10 +00:00
|
|
|
void (*get_encoding_rules) (payload_t *this, encoding_rule_t **rules, size_t *rule_count);
|
2005-11-14 06:55:51 +00:00
|
|
|
|
|
|
|
/**
|
2008-03-13 14:14:44 +00:00
|
|
|
* Get type of payload.
|
2005-11-14 06:55:51 +00:00
|
|
|
*
|
2008-03-13 14:14:44 +00:00
|
|
|
* @return type of this payload
|
2005-11-14 06:55:51 +00:00
|
|
|
*/
|
|
|
|
payload_type_t (*get_type) (payload_t *this);
|
|
|
|
|
|
|
|
/**
|
2008-03-13 14:14:44 +00:00
|
|
|
* Get type of next payload or NO_PAYLOAD (0) if this is the last one.
|
2005-11-14 06:55:51 +00:00
|
|
|
*
|
2008-03-13 14:14:44 +00:00
|
|
|
* @return type of next payload
|
2005-11-14 06:55:51 +00:00
|
|
|
*/
|
|
|
|
payload_type_t (*get_next_type) (payload_t *this);
|
2009-09-04 11:46:09 +00:00
|
|
|
|
2005-11-15 09:14:45 +00:00
|
|
|
/**
|
2008-03-13 14:14:44 +00:00
|
|
|
* Set type of next payload.
|
2005-11-15 09:14:45 +00:00
|
|
|
*
|
2008-03-13 14:14:44 +00:00
|
|
|
* @param type type of next payload
|
2005-11-15 09:14:45 +00:00
|
|
|
*/
|
2005-11-28 18:24:10 +00:00
|
|
|
void (*set_next_type) (payload_t *this,payload_type_t type);
|
2005-11-14 06:55:51 +00:00
|
|
|
|
|
|
|
/**
|
2008-03-13 14:14:44 +00:00
|
|
|
* Get length of payload.
|
2005-11-14 06:55:51 +00:00
|
|
|
*
|
2008-03-13 14:14:44 +00:00
|
|
|
* @return length of this payload
|
2005-11-14 06:55:51 +00:00
|
|
|
*/
|
2005-11-14 07:15:43 +00:00
|
|
|
size_t (*get_length) (payload_t *this);
|
2009-09-04 11:46:09 +00:00
|
|
|
|
2005-11-17 12:49:35 +00:00
|
|
|
/**
|
2008-03-13 14:14:44 +00:00
|
|
|
* Verifies payload structure and makes consistence check.
|
2005-11-17 12:49:35 +00:00
|
|
|
*
|
2008-03-13 14:14:44 +00:00
|
|
|
* @return SUCCESS, FAILED if consistence not given
|
2005-11-17 12:49:35 +00:00
|
|
|
*/
|
|
|
|
status_t (*verify) (payload_t *this);
|
2009-09-04 11:46:09 +00:00
|
|
|
|
2005-12-06 11:51:13 +00:00
|
|
|
/**
|
2008-03-13 14:14:44 +00:00
|
|
|
* Destroys a payload and all included substructures.
|
2005-12-06 11:51:13 +00:00
|
|
|
*/
|
|
|
|
void (*destroy) (payload_t *this);
|
2005-11-14 06:55:51 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
2008-03-13 14:14:44 +00:00
|
|
|
* Create an empty payload.
|
2009-09-02 15:26:36 +00:00
|
|
|
*
|
2005-11-14 06:55:51 +00:00
|
|
|
* Useful for the parser, who wants a generic constructor for all payloads.
|
2009-09-02 15:26:36 +00:00
|
|
|
* It supports all payload_t methods. If a payload type is not known,
|
2005-12-06 11:51:13 +00:00
|
|
|
* an unknwon_paylod is created with the chunk of data in it.
|
2009-09-02 15:26:36 +00:00
|
|
|
*
|
2005-11-14 06:55:51 +00:00
|
|
|
* @param type type of the payload to create
|
2005-12-06 13:44:22 +00:00
|
|
|
* @return payload_t object
|
2005-11-14 06:55:51 +00:00
|
|
|
*/
|
2005-11-14 09:43:18 +00:00
|
|
|
payload_t *payload_create(payload_type_t type);
|
2005-11-14 06:55:51 +00:00
|
|
|
|
2010-11-10 13:17:03 +00:00
|
|
|
/**
|
2011-02-07 10:13:27 +00:00
|
|
|
* Check if a specific payload is implemented, or handled as unknown payload.
|
2010-11-10 13:17:03 +00:00
|
|
|
*
|
|
|
|
* @param type type of the payload to check
|
2011-02-07 10:13:27 +00:00
|
|
|
* @return FALSE if payload type handled as unknown payload
|
2010-11-10 13:17:03 +00:00
|
|
|
*/
|
|
|
|
bool payload_is_known(payload_type_t type);
|
|
|
|
|
2010-11-24 15:52:49 +00:00
|
|
|
/**
|
|
|
|
* Get the value field in a payload using encoding rules.
|
|
|
|
*
|
|
|
|
* @param payload payload to look up a field
|
|
|
|
* @param type encoding rule type to look up
|
|
|
|
* @param skip number rules of type to skip, 0 to get first
|
|
|
|
* @return type specific value pointer, NULL if not found
|
|
|
|
*/
|
|
|
|
void* payload_get_field(payload_t *payload, encoding_type_t type, u_int skip);
|
|
|
|
|
2009-03-24 17:43:01 +00:00
|
|
|
#endif /** PAYLOAD_H_ @}*/
|