2005-11-14 10:14:22 +00:00
|
|
|
/**
|
|
|
|
* @file sa_payload.h
|
|
|
|
*
|
2005-11-28 18:24:10 +00:00
|
|
|
* @brief Interface of sa_payload_t.
|
2005-11-14 10:14:22 +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 SA_PAYLOAD_H_
|
|
|
|
#define SA_PAYLOAD_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>
|
|
|
|
#include <encoding/payloads/proposal_substructure.h>
|
2005-11-23 09:08:45 +00:00
|
|
|
#include <utils/linked_list.h>
|
2005-11-14 10:14:22 +00:00
|
|
|
|
|
|
|
/**
|
2005-11-28 18:24:10 +00:00
|
|
|
* SA_PAYLOAD length in bytes without any proposal substructure.
|
|
|
|
*
|
|
|
|
* @ingroup payloads
|
2005-11-14 10:14:22 +00:00
|
|
|
*/
|
|
|
|
#define SA_PAYLOAD_HEADER_LENGTH 4
|
|
|
|
|
2005-11-24 09:17:51 +00:00
|
|
|
typedef struct sa_payload_t sa_payload_t;
|
|
|
|
|
2005-11-14 10:14:22 +00:00
|
|
|
/**
|
2005-12-06 13:44:22 +00:00
|
|
|
* @brief Class representing an IKEv2-SA Payload.
|
2005-11-14 10:14:22 +00:00
|
|
|
*
|
|
|
|
* The SA Payload format is described in RFC section 3.3.
|
|
|
|
*
|
2005-12-06 13:44:22 +00:00
|
|
|
* @b Constructors:
|
|
|
|
* - sa_payload_create()
|
|
|
|
* - sa_payload_create_from_ike_proposals()
|
2006-02-14 14:52:00 +00:00
|
|
|
* - sa_payload_create_from_proposal()
|
2005-12-06 13:44:22 +00:00
|
|
|
*
|
2006-02-14 14:52:00 +00:00
|
|
|
* @todo Add support of algorithms without specified keylength in get_proposals and get_ike_proposals.
|
2005-12-12 08:44:35 +00:00
|
|
|
*
|
2005-11-28 18:24:10 +00:00
|
|
|
* @ingroup payloads
|
2005-11-14 10:14:22 +00:00
|
|
|
*/
|
2005-11-24 09:17:51 +00:00
|
|
|
struct sa_payload_t {
|
2005-11-14 10:14:22 +00:00
|
|
|
/**
|
2005-11-28 18:24:10 +00:00
|
|
|
* The payload_t interface.
|
2005-11-14 10:14:22 +00:00
|
|
|
*/
|
|
|
|
payload_t payload_interface;
|
|
|
|
|
2005-11-14 12:04:06 +00:00
|
|
|
/**
|
|
|
|
* @brief Creates an iterator of stored proposal_substructure_t objects.
|
|
|
|
*
|
|
|
|
* @warning The created iterator has to get destroyed by the caller!
|
2005-11-15 09:14:45 +00:00
|
|
|
*
|
|
|
|
* @warning When deleting an proposal using this iterator,
|
|
|
|
* the length of this transform substructure has to be refreshed
|
|
|
|
* by calling get_length()!
|
2005-11-14 12:04:06 +00:00
|
|
|
*
|
2005-12-06 13:44:22 +00:00
|
|
|
* @param this calling sa_payload_t object
|
|
|
|
* @param[in] forward iterator direction (TRUE: front to end)
|
|
|
|
* @return created iterator_t object
|
2005-11-14 12:04:06 +00:00
|
|
|
*/
|
2005-11-29 08:54:48 +00:00
|
|
|
iterator_t *(*create_proposal_substructure_iterator) (sa_payload_t *this, bool forward);
|
2005-11-14 12:04:06 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Adds a proposal_substructure_t object to this object.
|
|
|
|
*
|
|
|
|
* @warning The added proposal_substructure_t object is
|
|
|
|
* getting destroyed in destroy function of sa_payload_t.
|
|
|
|
*
|
2005-12-06 13:44:22 +00:00
|
|
|
* @param this calling sa_payload_t object
|
|
|
|
* @param proposal proposal_substructure_t object to add
|
2005-11-14 12:04:06 +00:00
|
|
|
*/
|
2005-11-28 18:24:10 +00:00
|
|
|
void (*add_proposal_substructure) (sa_payload_t *this,proposal_substructure_t *proposal);
|
2006-02-14 14:52:00 +00:00
|
|
|
|
2005-12-01 12:18:20 +00:00
|
|
|
/**
|
2006-02-14 14:52:00 +00:00
|
|
|
* @brief Gets the proposals in this payload as a list.
|
2005-12-01 12:18:20 +00:00
|
|
|
*
|
2006-02-14 14:52:00 +00:00
|
|
|
* @return a list containing proposal_t s
|
2005-12-01 12:18:20 +00:00
|
|
|
*/
|
2006-02-14 14:52:00 +00:00
|
|
|
linked_list_t *(*get_proposals) (sa_payload_t *this);
|
2006-02-06 14:05:35 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Add a child proposal (AH/ESP) to the payload.
|
|
|
|
*
|
|
|
|
* @param proposal child proposal to add to the payload
|
|
|
|
*/
|
2006-02-14 14:52:00 +00:00
|
|
|
void (*add_proposal) (sa_payload_t *this, proposal_t *proposal);
|
2006-02-06 14:05:35 +00:00
|
|
|
|
2005-11-14 10:14:22 +00:00
|
|
|
/**
|
|
|
|
* @brief Destroys an sa_payload_t object.
|
|
|
|
*
|
|
|
|
* @param this sa_payload_t object to destroy
|
|
|
|
*/
|
2005-11-28 18:24:10 +00:00
|
|
|
void (*destroy) (sa_payload_t *this);
|
2005-11-14 10:14:22 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Creates an empty sa_payload_t object
|
|
|
|
*
|
2005-12-06 13:44:22 +00:00
|
|
|
* @return created sa_payload_t object
|
2005-11-28 18:24:10 +00:00
|
|
|
*
|
|
|
|
* @ingroup payloads
|
2005-11-14 10:14:22 +00:00
|
|
|
*/
|
2006-05-09 07:34:25 +00:00
|
|
|
sa_payload_t *sa_payload_create(void);
|
2005-11-14 10:14:22 +00:00
|
|
|
|
2005-12-01 08:48:57 +00:00
|
|
|
/**
|
2006-02-14 14:52:00 +00:00
|
|
|
* @brief Creates a sa_payload_t object from a list of proposals.
|
2005-12-01 08:48:57 +00:00
|
|
|
*
|
2006-02-14 14:52:00 +00:00
|
|
|
* @param proposals list of proposals to build the payload from
|
2005-12-06 13:44:22 +00:00
|
|
|
* @return sa_payload_t object
|
2005-12-01 08:48:57 +00:00
|
|
|
*
|
|
|
|
* @ingroup payloads
|
|
|
|
*/
|
2006-02-14 14:52:00 +00:00
|
|
|
sa_payload_t *sa_payload_create_from_proposal_list(linked_list_t *proposals);
|
2005-11-14 10:14:22 +00:00
|
|
|
|
2006-02-14 14:52:00 +00:00
|
|
|
/**
|
|
|
|
* @brief Creates a sa_payload_t object from a single proposal.
|
|
|
|
*
|
|
|
|
* This is only for convenience. Use sa_payload_create_from_proposal_list
|
|
|
|
* if you want to add more than one proposal.
|
|
|
|
*
|
|
|
|
* @param proposal proposal from which the payload should be built.
|
|
|
|
* @return sa_payload_t object
|
|
|
|
*
|
|
|
|
* @ingroup payloads
|
|
|
|
*/
|
|
|
|
sa_payload_t *sa_payload_create_from_proposal(proposal_t *proposal);
|
2005-12-06 13:44:22 +00:00
|
|
|
|
2005-11-14 10:14:22 +00:00
|
|
|
#endif /*SA_PAYLOAD_H_*/
|