updated Doxyfile
[strongswan.git] / src / charon / sa / tasks / child_create.h
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.
14 *
15 * $Id$
16 */
17
18 /**
19 * @defgroup child_create child_create
20 * @{ @ingroup tasks
21 */
22
23 #ifndef CHILD_CREATE_H_
24 #define CHILD_CREATE_H_
25
26 typedef struct child_create_t child_create_t;
27
28 #include <library.h>
29 #include <sa/ike_sa.h>
30 #include <sa/tasks/task.h>
31 #include <config/child_cfg.h>
32
33 /**
34 * Task of type CHILD_CREATE, established a new CHILD_SA.
35 *
36 * This task may be included in the IKE_AUTH message or in a separate
37 * CREATE_CHILD_SA exchange.
38 */
39 struct child_create_t {
40
41 /**
42 * Implements the task_t interface
43 */
44 task_t task;
45
46 /**
47 * Use a specific reqid for the CHILD_SA.
48 *
49 * When this task is used for rekeying, the same reqid is used
50 * for the new CHILD_SA.
51 *
52 * @param reqid reqid to use
53 */
54 void (*use_reqid) (child_create_t *this, u_int32_t reqid);
55
56 /**
57 * Get the lower of the two nonces, used for rekey collisions.
58 *
59 * @return lower nonce
60 */
61 chunk_t (*get_lower_nonce) (child_create_t *this);
62
63 /**
64 * Get the CHILD_SA established/establishing by this task.
65 *
66 * @return child_sa
67 */
68 child_sa_t* (*get_child) (child_create_t *this);
69 };
70
71 /**
72 * Create a new child_create task.
73 *
74 * @param ike_sa IKE_SA this task works for
75 * @param config child_cfg if task initiator, NULL if responder
76 * @return child_create task to handle by the task_manager
77 */
78 child_create_t *child_create_create(ike_sa_t *ike_sa, child_cfg_t *config);
79
80 #endif /** CHILD_CREATE_H_ @}*/