- cleanup of states ike_auth_requested and ike_sa_init_responded
[strongswan.git] / Source / charon / sa / states / ike_sa_init_responded.h
1 /**
2 * @file ike_sa_init_responded.h
3 *
4 * @brief Interface of ike_sa_init_responded_t.
5 *
6 */
7
8 /*
9 * Copyright (C) 2005 Jan Hutter, Martin Willi
10 * Hochschule fuer Technik Rapperswil
11 *
12 * This program is free software; you can redistribute it and/or modify it
13 * under the terms of the GNU General Public License as published by the
14 * Free Software Foundation; either version 2 of the License, or (at your
15 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
16 *
17 * This program is distributed in the hope that it will be useful, but
18 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
19 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
20 * for more details.
21 */
22
23 #ifndef IKE_SA_INIT_RESPONDED_H_
24 #define IKE_SA_INIT_RESPONDED_H_
25
26 #include <sa/ike_sa.h>
27 #include <sa/states/state.h>
28
29 typedef struct ike_sa_init_responded_t ike_sa_init_responded_t;
30
31 /**
32 * @brief This class represents an IKE_SA state when
33 * responded to an IKE_SA_INIT request.
34 *
35 * The state accpets IKE_AUTH requests. It proves the authenticity
36 * and sets up the first child sa. Then it sends back an IKE_AUTH
37 * reply and changes to the IKE_SA_ESTABLISHED state.
38 *
39 * @b Constructors:
40 * - ike_sa_init_response_data()
41 *
42 * @todo Implement handling of SET_WINDOW_SIZE notify
43 *
44 * @todo Implement handling of INITIAL_CONTACT notify
45 *
46 * @ingroup states
47 */
48 struct ike_sa_init_responded_t {
49 /**
50 * The state_t interface.
51 */
52 state_t state_interface;
53
54 };
55
56 /**
57 * @brief Constructor of class ike_sa_init_responded_t
58 *
59 * @param ike_sa assigned IKE_SA
60 * @param received_nonce received nonce data in IKE_SA_INIT request
61 * @param received_nonce sent nonce data in IKE_SA_INIT response
62 * @param ike_sa_init_request_data binary representation of received IKE_SA_INIT request
63 * @param ike_sa_init_response_data binary representation of sent IKE_SA_INIT response
64 *
65 * @ingroup states
66 */
67 ike_sa_init_responded_t *ike_sa_init_responded_create(protected_ike_sa_t *ike_sa,
68 chunk_t received_nonce,
69 chunk_t sent_nonce,
70 chunk_t ike_sa_init_request_data,
71 chunk_t ike_sa_init_response_data);
72
73 #endif /*IKE_SA_INIT_RESPONDED_H_*/