- code cleaned up
[strongswan.git] / Source / charon / sa / authenticator.h
1 /**
2 * @file authenticator.h
3 *
4 * @brief Interface of authenticator_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 _AUTHENTICATOR_H_
24 #define _AUTHENTICATOR_H_
25
26 #include <types.h>
27 #include <sa/ike_sa.h>
28 #include <network/packet.h>
29 #include <encoding/payloads/auth_payload.h>
30 #include <encoding/payloads/id_payload.h>
31
32
33 typedef struct authenticator_t authenticator_t;
34
35 /**
36 * @brief Class used to authenticate a peer.
37 *
38 * Currently the following two AUTH methods are supported:
39 * - SHARED_KEY_MESSAGE_INTEGRITY_CODE
40 * - RSA_DIGITAL_SIGNATURE
41 *
42 * This class retrieves needed data for specific AUTH methods (RSA keys, shared secrets, etc.)
43 * over an internal stored protected_ike_sa_t object or directly from the configuration_manager_t over
44 * the daemon_t object "charon".
45 *
46 * @b Constructors:
47 * - authenticator_create()
48 *
49 * @ingroup sa
50 */
51 struct authenticator_t {
52
53 /**
54 * @brief Verify's given authentication data.
55 *
56 * To verify a received AUTH payload the following data must be provided:
57 * - the last received IKEv2 Message from the other peer in binary form
58 * - the nonce value sent to the other peer
59 * - the ID payload of the other peer
60 *
61 * @param this calling object
62 * @param last_received_packet binary representation of the last received IKEv2-Message
63 * @param my_nonce the sent nonce (without payload header)
64 * @param other_id_payload the ID payload received from other peer
65 * @param initiator type of other peer. TRUE, if it is original initiator, FALSE otherwise
66 *
67 * @todo Document RSA error status types
68 *
69 * @return
70 * - SUCCESS if verification could be processed
71 * (does not mean the data could be verified)
72 * - FAILED if verification failed
73 * - NOT_SUPPORTED if AUTH method not supported
74 * - NOT_FOUND if the data for specific AUTH method could not be found
75 * (e.g. shared secret, rsa key)
76 */
77 status_t (*verify_auth_data) (authenticator_t *this,
78 auth_payload_t *auth_payload,
79 chunk_t last_received_packet,
80 chunk_t my_nonce,
81 id_payload_t *other_id_payload,
82 bool initiator);
83
84 /**
85 * @brief Computes authentication data and creates specific AUTH payload.
86 *
87 * To create an AUTH payload, the following data must be provided:
88 * - the last sent IKEv2 Message in binary form
89 * - the nonce value received from the other peer
90 * - the ID payload of myself
91 *
92 * @param this calling object
93 * @param[out] auth_payload The object of typee auth_payload_t will be created at pointing location
94 * @param last_sent_packet binary representation of the last sent IKEv2-Message
95 * @param other_nonce the received nonce (without payload header)
96 * @param my_id_payload the ID payload going to send to other peer
97 * @param initiator type of myself. TRUE, if I'm original initiator, FALSE otherwise
98 *
99 * @todo Document RSA error status types
100 *
101 * @return
102 * - SUCCESS if authentication data could be computed
103 * - NOT_SUPPORTED if AUTH method not supported
104 * - NOT_FOUND if the data for AUTH method could not be found
105 */
106 status_t (*compute_auth_data) (authenticator_t *this,
107 auth_payload_t **auth_payload,
108 chunk_t last_sent_packet,
109 chunk_t other_nonce,
110 id_payload_t *my_id_payload,
111 bool initiator);
112
113 /**
114 * @brief Destroys a authenticator_t object.
115 *
116 * @param this calling object
117 */
118 void (*destroy) (authenticator_t *this);
119 };
120
121 /**
122 * @brief Creates an authenticator object.
123 *
124 * @warning: The following functions of the assigned protected_ike_sa_t object
125 * must return a valid value:
126 * - protected_ike_sa_t.get_sa_config
127 * - protected_ike_sa_t.get_prf
128 * - protected_ike_sa_t.get_logger
129 * This preconditions are not given in IKE_SA states INITIATOR_INIT or RESPONDER_INIT!
130 *
131 * @param ike_sa object of type protected_ike_sa_t
132 *
133 * @return authenticator_t object
134 *
135 * @ingroup sa
136 */
137 authenticator_t *authenticator_create(protected_ike_sa_t *ike_sa);
138
139 #endif //_AUTHENTICATOR_H_