[thirdparty/strongswan.git] / src / charon / 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.
 *
 * $Id$
 */

/**
 * @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 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 IKE_REKEY task.
 *
 * @param ike_sa		IKE_SA this task works for
 * @param initiator		TRUE for initiator, FALSE for responder
 * @return			  	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	* $Id$
	16	*/
	17
	18	/**
	19	* @defgroup ike_rekey ike_rekey
	20	* @{ @ingroup tasks
c60c7694 MW	21	*/
	22
	23	#ifndef IKE_REKEY_H_
	24	#define IKE_REKEY_H_
	25
	26	typedef struct ike_rekey_t ike_rekey_t;
	27
	28	#include <library.h>
	29	#include <sa/ike_sa.h>
	30	#include <sa/tasks/task.h>
	31
	32	/**
552cc11b	33	* Task of type IKE_REKEY, rekey an established IKE_SA.
c60c7694 MW	34	*/
	35	struct ike_rekey_t {
	36
	37	/**
	38	* Implements the task_t interface
	39	*/
	40	task_t task;
eef08590 MW	41
eef08590 MW	42	/**
552cc11b	43	* Register a rekeying task which collides with this one.
eef08590 MW	44	*
	45	* If two peers initiate rekeying at the same time, the collision must
	46	* be handled gracefully. The task manager is aware of what exchanges
	47	* are going on and notifies the outgoing task by passing the incoming.
	48	*
eef08590 MW	49	* @param other incoming task
	50	*/
	51	void (collide)(ike_rekey_t this, task_t *other);
c60c7694 MW	52	};
	53
	54	/**
552cc11b	55	* Create a new IKE_REKEY task.
c60c7694 MW	56	*
	57	* @param ike_sa IKE_SA this task works for
	58	* @param initiator TRUE for initiator, FALSE for responder
	59	* @return IKE_REKEY task to handle by the task_manager
	60	*/
	61	ike_rekey_t ike_rekey_create(ike_sa_t ike_sa, bool initiator);
	62
552cc11b	63	#endif /* IKE_REKEY_H_ @} */