[thirdparty/strongswan.git] / src / libcharon / sa / tasks / ike_rekey.h

/*
 * Copyright (C) 2007 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.
 */

/**
 * @defgroup ike_rekey ike_rekey
 * @{ @ingroup tasks
 */

#ifndef IKE_REKEY_H_
#define IKE_REKEY_H_

typedef struct ike_rekey_t ike_rekey_t;

#include <library.h>
#include <sa/ike_sa.h>
#include <sa/tasks/task.h>

/**
 * Task of type TASK_IKE_REKEY, rekey an established IKE_SA.
 */
struct ike_rekey_t {

	/**
	 * Implements the task_t interface
	 */
	task_t task;

	/**
	 * Register a rekeying task which collides with this one.
	 *
	 * If two peers initiate rekeying at the same time, the collision must
	 * be handled gracefully. The task manager is aware of what exchanges
	 * are going on and notifies the outgoing task by passing the incoming.
	 *
	 * @param other		incoming task
	 */
	void (*collide)(ike_rekey_t* this, task_t *other);
};

/**
 * Create a new TASK_IKE_REKEY task.
 *
 * @param ike_sa		IKE_SA this task works for
 * @param initiator		TRUE for initiator, FALSE for responder
 * @return				TASK_IKE_REKEY task to handle by the task_manager
 */
ike_rekey_t *ike_rekey_create(ike_sa_t *ike_sa, bool initiator);

#endif /** IKE_REKEY_H_ @}*/
Commit	Line	Data
c60c7694 MW	1	/*
	2	* Copyright (C) 2007 Martin Willi
	3	* Hochschule fuer Technik Rapperswil
	4	*
	5	* This program is free software; you can redistribute it and/or modify it
	6	* under the terms of the GNU General Public License as published by the
	7	* Free Software Foundation; either version 2 of the License, or (at your
	8	* option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
	9	*
	10	* This program is distributed in the hope that it will be useful, but
	11	* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
	12	* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
	13	* for more details.
552cc11b MW	14	*/
	15
	16	/**
	17	* @defgroup ike_rekey ike_rekey
	18	* @{ @ingroup tasks
c60c7694 MW	19	*/
	20
	21	#ifndef IKE_REKEY_H_
	22	#define IKE_REKEY_H_
	23
	24	typedef struct ike_rekey_t ike_rekey_t;
	25
	26	#include <library.h>
	27	#include <sa/ike_sa.h>
	28	#include <sa/tasks/task.h>
	29
	30	/**
a09972df	31	* Task of type TASK_IKE_REKEY, rekey an established IKE_SA.
c60c7694 MW	32	*/
	33	struct ike_rekey_t {
	34
	35	/**
	36	* Implements the task_t interface
	37	*/
	38	task_t task;
7daf5226	39
eef08590	40	/**
552cc11b	41	* Register a rekeying task which collides with this one.
eef08590 MW	42	*
	43	* If two peers initiate rekeying at the same time, the collision must
	44	* be handled gracefully. The task manager is aware of what exchanges
	45	* are going on and notifies the outgoing task by passing the incoming.
	46	*
eef08590 MW	47	* @param other incoming task
	48	*/
	49	void (collide)(ike_rekey_t this, task_t *other);
c60c7694 MW	50	};
	51
	52	/**
a09972df	53	* Create a new TASK_IKE_REKEY task.
c60c7694 MW	54	*
	55	* @param ike_sa IKE_SA this task works for
	56	* @param initiator TRUE for initiator, FALSE for responder
a09972df	57	* @return TASK_IKE_REKEY task to handle by the task_manager
c60c7694 MW	58	*/
	59	ike_rekey_t ike_rekey_create(ike_sa_t ike_sa, bool initiator);
	60
1490ff4d	61	#endif /** IKE_REKEY_H_ @}*/