d2854701e9c760c8d635cdbfb91488d9967fbff8
[strongswan.git] / src / charon / sa / tasks / task.h
1 /*
2 * Copyright (C) 2007 Tobias Brunner
3 * Copyright (C) 2006 Martin Willi
4 * Hochschule fuer Technik Rapperswil
5 *
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation; either version 2 of the License, or (at your
9 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
10 *
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
13 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * for more details.
15 *
16 * $Id$
17 */
18
19 /**
20 * @defgroup task task
21 * @{ @ingroup tasks
22 */
23
24 #ifndef TASK_H_
25 #define TASK_H_
26
27 typedef enum task_type_t task_type_t;
28 typedef struct task_t task_t;
29
30 #include <library.h>
31 #include <sa/ike_sa.h>
32 #include <encoding/message.h>
33
34 /**
35 * Different kinds of tasks.
36 */
37 enum task_type_t {
38 /** establish an unauthenticated IKE_SA */
39 IKE_INIT,
40 /** detect NAT situation */
41 IKE_NATD,
42 /** handle MOBIKE stuff */
43 IKE_MOBIKE,
44 /** authenticate the initiated IKE_SA */
45 IKE_AUTHENTICATE,
46 /** AUTH_LIFETIME negotiation, RFC4478 */
47 IKE_AUTH_LIFETIME,
48 /** certificate processing before authentication (certreqs, cert parsing) */
49 IKE_CERT_PRE,
50 /** certificate processing after authentication (certs payload generation) */
51 IKE_CERT_POST,
52 /** Configuration payloads, virtual IP and such */
53 IKE_CONFIG,
54 /** rekey an IKE_SA */
55 IKE_REKEY,
56 /** reestablish a complete IKE_SA */
57 IKE_REAUTH,
58 /** delete an IKE_SA */
59 IKE_DELETE,
60 /** liveness check */
61 IKE_DPD,
62 #ifdef ME
63 /** handle ME stuff */
64 IKE_ME,
65 #endif /* ME */
66 /** establish a CHILD_SA within an IKE_SA */
67 CHILD_CREATE,
68 /** delete an established CHILD_SA */
69 CHILD_DELETE,
70 /** rekey an CHILD_SA */
71 CHILD_REKEY,
72 };
73
74 /**
75 * enum names for task_type_t.
76 */
77 extern enum_name_t *task_type_names;
78
79 /**
80 * Interface for a task, an operation handled within exchanges.
81 *
82 * A task is an elemantary operation. It may be handled by a single or by
83 * multiple exchanges. An exchange may even complete multiple tasks.
84 * A task has a build() and an process() operation. The build() operation
85 * creates payloads and adds it to the message. The process() operation
86 * inspects a message and handles its payloads. An initiator of an exchange
87 * first calls build() to build the request, and processes the response message
88 * with the process() method.
89 * A responder does the opposite; it calls process() first to handle an incoming
90 * request and secondly calls build() to build an appropriate response.
91 * Both methods return either SUCCESS, NEED_MORE or FAILED. A SUCCESS indicates
92 * that the task completed, even when the task completed unsuccesfully. The
93 * manager then removes the task from the list. A NEED_MORE is returned when
94 * the task needs further build()/process() calls to complete, the manager
95 * leaves the taks in the queue. A returned FAILED indicates a critical failure.
96 * The manager closes the IKE_SA whenever a task returns FAILED.
97 */
98 struct task_t {
99
100 /**
101 * Build a request or response message for this task.
102 *
103 * @param message message to add payloads to
104 * @return
105 * - FAILED if a critical error occured
106 * - NEED_MORE if another call to build/process needed
107 * - SUCCESS if task completed
108 */
109 status_t (*build) (task_t *this, message_t *message);
110
111 /**
112 * Process a request or response message for this task.
113 *
114 * @param message message to read payloads from
115 * @return
116 * - FAILED if a critical error occured
117 * - NEED_MORE if another call to build/process needed
118 * - SUCCESS if task completed
119 */
120 status_t (*process) (task_t *this, message_t *message);
121
122 /**
123 * Get the type of the task implementation.
124 */
125 task_type_t (*get_type) (task_t *this);
126
127 /**
128 * Migrate a task to a new IKE_SA.
129 *
130 * After migrating a task, it goes back to a state where it can be
131 * used again to initate an exchange. This is useful when a task
132 * has to get migrated to a new IKE_SA.
133 * A special usage is when a INVALID_KE_PAYLOAD is received. A call
134 * to reset resets the task, but uses another DH group for the next
135 * try.
136 * The ike_sa is the new IKE_SA this task belongs to and operates on.
137 *
138 * @param ike_sa new IKE_SA this task works for
139 */
140 void (*migrate) (task_t *this, ike_sa_t *ike_sa);
141
142 /**
143 * Destroys a task_t object.
144 */
145 void (*destroy) (task_t *this);
146 };
147
148 #endif /* TASK_H_ @} */