2 * @file responder_init.c
4 * @brief Start state of a IKE_SA as responder
9 * Copyright (C) 2005 Jan Hutter, Martin Willi
10 * Hochschule fuer Technik Rapperswil
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>.
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
23 #include "responder_init.h"
26 #include <sa/states/state.h>
27 #include <sa/states/ike_sa_init_responded.h>
28 #include <utils/allocator.h>
29 #include <encoding/payloads/sa_payload.h>
30 #include <encoding/payloads/ke_payload.h>
31 #include <encoding/payloads/nonce_payload.h>
32 #include <transforms/diffie_hellman.h>
35 typedef struct private_responder_init_t private_responder_init_t
;
38 * Private data of a responder_init_t object.
41 struct private_responder_init_t
{
43 * Methods of the state_t interface.
45 responder_init_t
public;
50 protected_ike_sa_t
*ike_sa
;
53 * Diffie Hellman object used to compute shared secret.
55 * After processing of incoming IKE_SA_INIT-Request the shared key is
56 * passed to the next state of type ike_sa_init_responded_t.
58 diffie_hellman_t
*diffie_hellman
;
61 * Diffie Hellman group number.
63 u_int16_t dh_group_number
;
66 * Priority used to get matching dh_group number.
68 u_int16_t dh_group_priority
;
73 * This value is passed to the next state of type ike_sa_init_responded_t.
78 * Received nonce value
80 * This value is passed to the next state of type ike_sa_init_responded_t.
82 chunk_t received_nonce
;
85 * Logger used to log data
87 * Is logger of ike_sa!
92 * Proposals used to initiate connection
94 linked_list_t
*proposals
;
97 * Builds the SA payload for this state.
99 * @param this calling object
100 * @param payload The generated SA payload object of type ke_payload_t is
101 * stored at this location.
106 status_t (*build_sa_payload
) (private_responder_init_t
*this, payload_t
**payload
);
109 * Builds the KE payload for this state.
111 * @param this calling object
112 * @param payload The generated KE payload object of type ke_payload_t is
113 * stored at this location.
118 status_t (*build_ke_payload
) (private_responder_init_t
*this, payload_t
**payload
);
120 * Builds the NONCE payload for this state.
122 * @param this calling object
123 * @param payload The generated NONCE payload object of type ke_payload_t is
124 * stored at this location.
129 status_t (*build_nonce_payload
) (private_responder_init_t
*this, payload_t
**payload
);
132 * Destroy function called internally of this class after state change succeeded.
134 * This destroy function does not destroy objects which were passed to the new state.
136 * @param this calling object
137 * @return SUCCESS in any case
139 status_t (*destroy_after_state_change
) (private_responder_init_t
*this);
143 * Implements state_t.get_state
145 static status_t
process_message(private_responder_init_t
*this, message_t
*message
, state_t
**new_state
)
147 linked_list_iterator_t
*payloads
;
148 host_t
*source
, *destination
;
153 chunk_t shared_secret
;
154 exchange_type_t exchange_type
;
155 ike_sa_init_responded_t
*next_state
;
157 exchange_type
= message
->get_exchange_type(message
);
158 if (exchange_type
!= IKE_SA_INIT
)
160 this->logger
->log(this->logger
, ERROR
| MORE
, "Message of type %s not supported in state responder_init",mapping_find(exchange_type_m
,exchange_type
));
164 if (!message
->get_request(message
))
166 this->logger
->log(this->logger
, ERROR
| MORE
, "Only requests of type IKE_SA_INIT supported in state responder_init");
170 /* this is the first message we process, so copy host infos */
171 message
->get_source(message
, &source
);
172 message
->get_destination(message
, &destination
);
174 /* we need to clone them, since we destroy the message later */
175 destination
->clone(destination
, &(this->ike_sa
->me
.host
));
176 source
->clone(source
, &(this->ike_sa
->other
.host
));
178 /* parse incoming message */
179 status
= message
->parse_body(message
);
180 if (status
!= SUCCESS
)
182 this->logger
->log(this->logger
, ERROR
| MORE
, "Could not parse body of request message");
186 /* iterate over incoming payloads. We can be sure, the message contains only accepted payloads! */
187 status
= message
->get_payload_iterator(message
, &payloads
);
188 if (status
!= SUCCESS
)
190 this->logger
->log(this->logger
, ERROR
, "Fatal error: Could not get payload interator");
194 while (payloads
->has_next(payloads
))
198 /* get current payload */
199 payloads
->current(payloads
, (void**)&payload
);
201 this->logger
->log(this->logger
, CONTROL
|MORE
, "Processing payload of type %s", mapping_find(payload_type_m
, payload
->get_type(payload
)));
202 switch (payload
->get_type(payload
))
204 case SECURITY_ASSOCIATION
:
206 sa_payload_t
*sa_payload
= (sa_payload_t
*)payload
;
207 linked_list_iterator_t
*suggested_proposals
, *accepted_proposals
;
208 encryption_algorithm_t encryption_algorithm
= ENCR_UNDEFINED
;
209 pseudo_random_function_t pseudo_random_function
= PRF_UNDEFINED
;
210 integrity_algorithm_t integrity_algorithm
= AUTH_UNDEFINED
;
212 status
= this->proposals
->create_iterator(this->proposals
, &accepted_proposals
, FALSE
);
213 if (status
!= SUCCESS
)
215 this->logger
->log(this->logger
, ERROR
, "Fatal error: Could not create iterator on list for proposals");
216 payloads
->destroy(payloads
);
220 /* get the list of suggested proposals */
221 status
= sa_payload
->create_proposal_substructure_iterator(sa_payload
, &suggested_proposals
, TRUE
);
222 if (status
!= SUCCESS
)
224 this->logger
->log(this->logger
, ERROR
, "Fatal error: Could not create iterator on suggested proposals");
225 accepted_proposals
->destroy(accepted_proposals
);
226 payloads
->destroy(payloads
);
230 /* now let the configuration-manager select a subset of the proposals */
231 status
= global_configuration_manager
->select_proposals_for_host(global_configuration_manager
,
232 this->ike_sa
->other
.host
, suggested_proposals
, accepted_proposals
);
233 if (status
!= SUCCESS
)
235 this->logger
->log(this->logger
, CONTROL
| MORE
, "No proposal of suggested proposals selected");
236 suggested_proposals
->destroy(suggested_proposals
);
237 accepted_proposals
->destroy(accepted_proposals
);
238 payloads
->destroy(payloads
);
242 /* iterators are not needed anymore */
243 suggested_proposals
->destroy(suggested_proposals
);
246 /* now let the configuration-manager return the transforms for the given proposal*/
247 this->logger
->log(this->logger
, CONTROL
| MOST
, "Get transforms for accepted proposal");
248 status
= global_configuration_manager
->get_transforms_for_host_and_proposals(global_configuration_manager
,
249 this->ike_sa
->other
.host
, accepted_proposals
, &encryption_algorithm
,&pseudo_random_function
,&integrity_algorithm
);
250 if (status
!= SUCCESS
)
252 this->logger
->log(this->logger
, ERROR
| MORE
, "Accepted proposals not supported?!");
253 accepted_proposals
->destroy(accepted_proposals
);
254 payloads
->destroy(payloads
);
257 accepted_proposals
->destroy(accepted_proposals
);
259 this->ike_sa
->prf
= prf_create(pseudo_random_function
);
260 if (this->ike_sa
->prf
== NULL
)
262 this->logger
->log(this->logger
, ERROR
| MORE
, "PRF type not supported");
263 payloads
->destroy(payloads
);
267 this->logger
->log(this->logger
, CONTROL
| MORE
, "SA Payload processed");
268 /* ok, we have what we need for sa_payload (proposals are stored in this->proposals)*/
273 ke_payload_t
*ke_payload
= (ke_payload_t
*)payload
;
274 diffie_hellman_group_t group
;
275 diffie_hellman_t
*dh
;
278 group
= ke_payload
->get_dh_group_number(ke_payload
);
280 status
= global_configuration_manager
->is_dh_group_allowed_for_host(global_configuration_manager
,
281 this->ike_sa
->other
.host
, group
, &allowed_group
);
283 if (status
!= SUCCESS
)
285 this->logger
->log(this->logger
, ERROR
| MORE
, "Could not get informations about DH group");
286 payloads
->destroy(payloads
);
291 /** @todo Send info reply */
294 /* create diffie hellman object to handle DH exchange */
295 dh
= diffie_hellman_create(group
);
298 this->logger
->log(this->logger
, ERROR
, "Could not generate DH object");
299 payloads
->destroy(payloads
);
303 this->logger
->log(this->logger
, CONTROL
| MORE
, "Set other DH public value");
305 status
= dh
->set_other_public_value(dh
, ke_payload
->get_key_exchange_data(ke_payload
));
306 if (status
!= SUCCESS
)
308 this->logger
->log(this->logger
, ERROR
, "Could not set other DH public value");
310 payloads
->destroy(payloads
);
314 this->diffie_hellman
= dh
;
316 this->logger
->log(this->logger
, CONTROL
| MORE
, "KE Payload processed");
321 nonce_payload_t
*nonce_payload
= (nonce_payload_t
*)payload
;
323 if (this->received_nonce
.ptr
!= NULL
)
325 this->logger
->log(this->logger
, CONTROL
| MOST
, "Destroy stored received nonce");
326 allocator_free(this->received_nonce
.ptr
);
327 this->received_nonce
.ptr
= NULL
;
328 this->received_nonce
.len
= 0;
331 this->logger
->log(this->logger
, CONTROL
| MORE
, "Get nonce value and store it");
332 status
= nonce_payload
->get_nonce(nonce_payload
, &(this->received_nonce
));
333 if (status
!= SUCCESS
)
335 this->logger
->log(this->logger
, ERROR
, "Fatal error: Could not get nonce");
336 payloads
->destroy(payloads
);
340 this->logger
->log(this->logger
, CONTROL
| MORE
, "Nonce Payload processed");
345 this->logger
->log(this->logger
, ERROR
| MORE
, "Payload type not supported!");
346 payloads
->destroy(payloads
);
353 /* iterator can be destroyed */
354 payloads
->destroy(payloads
);
356 this->logger
->log(this->logger
, CONTROL
| MORE
, "Request successfully handled. Going to create reply.");
358 this->logger
->log(this->logger
, CONTROL
| MOST
, "Going to create nonce.");
359 if (this->ike_sa
->randomizer
->allocate_pseudo_random_bytes(this->ike_sa
->randomizer
, NONCE_SIZE
, &(this->sent_nonce
)) != SUCCESS
)
361 this->logger
->log(this->logger
, ERROR
, "Could not create nonce!");
365 /* store shared secret */
366 this->logger
->log(this->logger
, CONTROL
| MOST
, "Retrieve shared secret and store it");
367 status
= this->diffie_hellman
->get_shared_secret(this->diffie_hellman
, &shared_secret
);
368 this->logger
->log_chunk(this->logger
, PRIVATE
, "Shared secret", &shared_secret
);
370 status
= this->ike_sa
->compute_secrets(this->ike_sa
,shared_secret
,this->received_nonce
, this->sent_nonce
);
371 if (status
!= SUCCESS
)
373 /* secrets could not be computed */
374 this->logger
->log(this->logger
, ERROR
| MORE
, "Secrets could not be computed!");
380 /* set up the reply */
381 status
= this->ike_sa
->build_message(this->ike_sa
, IKE_SA_INIT
, FALSE
, &response
);
382 if (status
!= SUCCESS
)
384 this->logger
->log(this->logger
, ERROR
, "Could not create empty message");
388 /* build SA payload */
389 status
= this->build_sa_payload(this, &payload
);
390 if (status
!= SUCCESS
)
392 this->logger
->log(this->logger
, ERROR
, "Could not build SA payload");
396 this ->logger
->log(this->logger
, CONTROL
|MOST
, "add SA payload to message");
397 status
= response
->add_payload(response
, payload
);
398 if (status
!= SUCCESS
)
400 this->logger
->log(this->logger
, ERROR
, "Could not add SA payload to message");
404 /* build KE payload */
405 status
= this->build_ke_payload(this,&payload
);
406 if (status
!= SUCCESS
)
408 this->logger
->log(this->logger
, ERROR
, "Could not build KE payload");
412 this ->logger
->log(this->logger
, CONTROL
|MOST
, "add KE payload to message");
413 status
= response
->add_payload(response
, payload
);
414 if (status
!= SUCCESS
)
416 this->logger
->log(this->logger
, ERROR
, "Could not add KE payload to message");
420 /* build Nonce payload */
421 status
= this->build_nonce_payload(this, &payload
);
422 if (status
!= SUCCESS
)
424 this->logger
->log(this->logger
, ERROR
, "Could not build NONCE payload");
428 this ->logger
->log(this->logger
, CONTROL
|MOST
, "add nonce payload to message");
429 status
= response
->add_payload(response
, payload
);
430 if (status
!= SUCCESS
)
432 this->logger
->log(this->logger
, ERROR
, "Could not add nonce payload to message");
436 /* generate packet */
437 this ->logger
->log(this->logger
, CONTROL
|MOST
, "generate packet from message");
438 status
= response
->generate(response
, &packet
);
439 if (status
!= SUCCESS
)
441 this->logger
->log(this->logger
, ERROR
, "Fatal error: could not generate packet from message");
445 this ->logger
->log(this->logger
, CONTROL
|MOST
, "Add packet to global send queue");
446 status
= global_send_queue
->add(global_send_queue
, packet
);
447 if (status
!= SUCCESS
)
449 this->logger
->log(this->logger
, ERROR
, "Could not add packet to send queue");
453 /* state can now be changed */
454 this ->logger
->log(this->logger
, CONTROL
|MOST
, "Create next state object");
456 next_state
= ike_sa_init_responded_create(this->ike_sa
, shared_secret
, this->received_nonce
, this->sent_nonce
);
458 if (next_state
== NULL
)
460 this ->logger
->log(this->logger
, ERROR
, "Fatal error: could not create next state object of type ike_sa_init_responded_t");
461 allocator_free_chunk(shared_secret
);
465 if ( this->ike_sa
->last_responded_message
!= NULL
)
467 /* destroy message */
468 this ->logger
->log(this->logger
, CONTROL
|MOST
, "Destroy stored last responded message");
469 this->ike_sa
->last_responded_message
->destroy(this->ike_sa
->last_responded_message
);
471 this->ike_sa
->last_responded_message
= response
;
473 /* message counter can now be increased */
474 this ->logger
->log(this->logger
, CONTROL
|MOST
, "Increate message counter for incoming messages");
475 this->ike_sa
->message_id_in
++;
477 *new_state
= (state_t
*) next_state
;
478 /* state has NOW changed :-) */
479 this ->logger
->log(this->logger
, CONTROL
|MORE
, "Changed state of IKE_SA from %s to %s",mapping_find(ike_sa_state_m
,RESPONDER_INIT
),mapping_find(ike_sa_state_m
,IKE_SA_INIT_RESPONDED
) );
481 this ->logger
->log(this->logger
, CONTROL
|MOST
, "Destroy old sate object");
482 this->destroy_after_state_change(this);
488 * implements private_initiator_init_t.build_sa_payload
490 static status_t
build_sa_payload(private_responder_init_t
*this, payload_t
**payload
)
492 sa_payload_t
* sa_payload
;
493 linked_list_iterator_t
*proposal_iterator
;
497 /* SA payload takes proposals from this->ike_sa_init_data.proposals and writes them to the created sa_payload */
499 this->logger
->log(this->logger
, CONTROL
|MORE
, "building sa payload");
501 status
= this->proposals
->create_iterator(this->proposals
, &proposal_iterator
, FALSE
);
502 if (status
!= SUCCESS
)
504 this->logger
->log(this->logger
, ERROR
, "Fatal error: Could not create iterator on list for proposals");
508 sa_payload
= sa_payload_create();
509 if (sa_payload
== NULL
)
511 this->logger
->log(this->logger
, ERROR
, "Fatal error: Could not create SA payload object");
515 while (proposal_iterator
->has_next(proposal_iterator
))
517 proposal_substructure_t
*current_proposal
;
518 proposal_substructure_t
*current_proposal_clone
;
519 status
= proposal_iterator
->current(proposal_iterator
,(void **) ¤t_proposal
);
520 if (status
!= SUCCESS
)
522 this->logger
->log(this->logger
, ERROR
, "Could not get current proposal needed to copy");
523 proposal_iterator
->destroy(proposal_iterator
);
524 sa_payload
->destroy(sa_payload
);
527 status
= current_proposal
->clone(current_proposal
,¤t_proposal_clone
);
528 if (status
!= SUCCESS
)
530 this->logger
->log(this->logger
, ERROR
, "Could not clone current proposal");
531 proposal_iterator
->destroy(proposal_iterator
);
532 sa_payload
->destroy(sa_payload
);
536 status
= sa_payload
->add_proposal_substructure(sa_payload
,current_proposal_clone
);
537 if (status
!= SUCCESS
)
539 this->logger
->log(this->logger
, ERROR
, "Could not add cloned proposal to SA payload");
540 proposal_iterator
->destroy(proposal_iterator
);
541 sa_payload
->destroy(sa_payload
);
547 proposal_iterator
->destroy(proposal_iterator
);
549 this->logger
->log(this->logger
, CONTROL
|MORE
, "sa payload builded");
551 *payload
= (payload_t
*) sa_payload
;
557 * implements private_initiator_init_t.build_ke_payload
559 static status_t
build_ke_payload(private_responder_init_t
*this, payload_t
**payload
)
561 ke_payload_t
*ke_payload
;
565 this->logger
->log(this->logger
, CONTROL
|MORE
, "building ke payload");
568 this ->logger
->log(this->logger
, CONTROL
|MORE
, "get public dh value to send in ke payload");
569 status
= this->diffie_hellman
->get_my_public_value(this->diffie_hellman
,&key_data
);
570 if (status
!= SUCCESS
)
572 this->logger
->log(this->logger
, ERROR
, "Could not get my DH public value");
576 ke_payload
= ke_payload_create();
577 if (ke_payload
== NULL
)
579 this->logger
->log(this->logger
, ERROR
, "Could not create KE payload");
580 allocator_free_chunk(key_data
);
583 ke_payload
->set_dh_group_number(ke_payload
, MODP_1024_BIT
);
584 if (ke_payload
->set_key_exchange_data(ke_payload
, key_data
) != SUCCESS
)
586 this->logger
->log(this->logger
, ERROR
, "Could not set key exchange data of KE payload");
587 ke_payload
->destroy(ke_payload
);
588 allocator_free_chunk(key_data
);
591 allocator_free_chunk(key_data
);
593 *payload
= (payload_t
*) ke_payload
;
598 * implements private_initiator_init_t.build_nonce_payload
600 static status_t
build_nonce_payload(private_responder_init_t
*this, payload_t
**payload
)
602 nonce_payload_t
*nonce_payload
;
605 this->logger
->log(this->logger
, CONTROL
|MORE
, "building nonce payload");
607 nonce_payload
= nonce_payload_create();
608 if (nonce_payload
== NULL
)
610 this->logger
->log(this->logger
, ERROR
, "Fatal error: could not create nonce payload object");
614 status
= nonce_payload
->set_nonce(nonce_payload
, this->sent_nonce
);
616 if (status
!= SUCCESS
)
618 this->logger
->log(this->logger
, ERROR
, "Fatal error: could not set nonce data of payload");
619 nonce_payload
->destroy(nonce_payload
);
623 *payload
= (payload_t
*) nonce_payload
;
630 * Implements state_t.get_state
632 static ike_sa_state_t
get_state(private_responder_init_t
*this)
634 return RESPONDER_INIT
;
638 * Implements state_t.get_state
640 static status_t
destroy(private_responder_init_t
*this)
642 this->logger
->log(this->logger
, CONTROL
| MORE
, "Going to destroy responder init state object");
644 /* destroy stored proposal */
645 this->logger
->log(this->logger
, CONTROL
| MOST
, "Destroy stored proposals");
646 while (this->proposals
->get_count(this->proposals
) > 0)
648 proposal_substructure_t
*current_proposal
;
649 this->proposals
->remove_first(this->proposals
,(void **)¤t_proposal
);
650 current_proposal
->destroy(current_proposal
);
652 this->proposals
->destroy(this->proposals
);
654 if (this->sent_nonce
.ptr
!= NULL
)
656 this->logger
->log(this->logger
, CONTROL
| MOST
, "Destroy sent nonce");
657 allocator_free(this->sent_nonce
.ptr
);
660 if (this->received_nonce
.ptr
!= NULL
)
662 this->logger
->log(this->logger
, CONTROL
| MOST
, "Destroy received nonce");
663 allocator_free(this->received_nonce
.ptr
);
666 /* destroy diffie hellman object */
667 if (this->diffie_hellman
!= NULL
)
669 this->logger
->log(this->logger
, CONTROL
| MOST
, "Destroy diffie_hellman_t object");
670 this->diffie_hellman
->destroy(this->diffie_hellman
);
673 allocator_free(this);
680 * Implements private_responder_init_t.destroy_after_state_change
682 static status_t
destroy_after_state_change (private_responder_init_t
*this)
684 this->logger
->log(this->logger
, CONTROL
| MORE
, "Going to destroy responder_init_t state object");
686 /* destroy stored proposal */
687 this->logger
->log(this->logger
, CONTROL
| MOST
, "Destroy stored proposals");
688 while (this->proposals
->get_count(this->proposals
) > 0)
690 proposal_substructure_t
*current_proposal
;
691 this->proposals
->remove_first(this->proposals
,(void **)¤t_proposal
);
692 current_proposal
->destroy(current_proposal
);
694 this->proposals
->destroy(this->proposals
);
696 /* destroy diffie hellman object */
697 if (this->diffie_hellman
!= NULL
)
699 this->logger
->log(this->logger
, CONTROL
| MOST
, "Destroy diffie_hellman_t object");
700 this->diffie_hellman
->destroy(this->diffie_hellman
);
703 allocator_free(this);
708 * Described in header.
710 responder_init_t
*responder_init_create(protected_ike_sa_t
*ike_sa
)
712 private_responder_init_t
*this = allocator_alloc_thing(private_responder_init_t
);
719 /* interface functions */
720 this->public.state_interface
.process_message
= (status_t (*) (state_t
*,message_t
*,state_t
**)) process_message
;
721 this->public.state_interface
.get_state
= (ike_sa_state_t (*) (state_t
*)) get_state
;
722 this->public.state_interface
.destroy
= (status_t (*) (state_t
*)) destroy
;
724 /* private functions */
725 this->build_sa_payload
= build_sa_payload
;
726 this->build_ke_payload
= build_ke_payload
;
727 this->build_nonce_payload
= build_nonce_payload
;
728 this->destroy_after_state_change
= destroy_after_state_change
;
731 this->ike_sa
= ike_sa
;
732 this->logger
= this->ike_sa
->logger
;
733 this->sent_nonce
.ptr
= NULL
;
734 this->sent_nonce
.len
= 0;
735 this->received_nonce
.ptr
= NULL
;
736 this->received_nonce
.len
= 0;
737 this->proposals
= linked_list_create();
738 if (this->proposals
== NULL
)
740 allocator_free(this);
744 return &(this->public);