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
)
147 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
;
158 randomizer_t
*randomizer
;
160 exchange_type
= message
->get_exchange_type(message
);
161 if (exchange_type
!= IKE_SA_INIT
)
163 this->logger
->log(this->logger
, ERROR
| MORE
, "Message of type %s not supported in state responder_init",mapping_find(exchange_type_m
,exchange_type
));
167 if (!message
->get_request(message
))
169 this->logger
->log(this->logger
, ERROR
| MORE
, "Only requests of type IKE_SA_INIT supported in state responder_init");
173 /* this is the first message we process, so copy host infos */
174 message
->get_source(message
, &source
);
175 message
->get_destination(message
, &destination
);
177 /* we need to clone them, since we destroy the message later */
178 status
= destination
->clone(destination
, &my_host
);
179 if (status
!= SUCCESS
)
181 this->logger
->log(this->logger
, ERROR
, "Fatal error: could not clone my host informations");
184 status
= source
->clone(source
, &other_host
);
185 if (status
!= SUCCESS
)
187 this->logger
->log(this->logger
, ERROR
, "Fatal error: could not clone other host informations");
188 my_host
->destroy(my_host
);
193 this->ike_sa
->set_my_host(this->ike_sa
, my_host
);
194 this->ike_sa
->set_other_host(this->ike_sa
, other_host
);
196 /* parse incoming message */
197 status
= message
->parse_body(message
);
198 if (status
!= SUCCESS
)
200 this->logger
->log(this->logger
, ERROR
| MORE
, "Could not parse body of request message");
204 /* iterate over incoming payloads. We can be sure, the message contains only accepted payloads! */
205 status
= message
->get_payload_iterator(message
, &payloads
);
206 if (status
!= SUCCESS
)
208 this->logger
->log(this->logger
, ERROR
, "Fatal error: Could not get payload interator");
212 while (payloads
->has_next(payloads
))
216 /* get current payload */
217 payloads
->current(payloads
, (void**)&payload
);
219 this->logger
->log(this->logger
, CONTROL
|MORE
, "Processing payload of type %s", mapping_find(payload_type_m
, payload
->get_type(payload
)));
220 switch (payload
->get_type(payload
))
222 case SECURITY_ASSOCIATION
:
224 sa_payload_t
*sa_payload
= (sa_payload_t
*)payload
;
225 iterator_t
*suggested_proposals
, *accepted_proposals
;
226 encryption_algorithm_t encryption_algorithm
= ENCR_UNDEFINED
;
227 pseudo_random_function_t pseudo_random_function
= PRF_UNDEFINED
;
228 integrity_algorithm_t integrity_algorithm
= AUTH_UNDEFINED
;
231 status
= this->proposals
->create_iterator(this->proposals
, &accepted_proposals
, FALSE
);
232 if (status
!= SUCCESS
)
234 this->logger
->log(this->logger
, ERROR
, "Fatal error: Could not create iterator on list for proposals");
235 payloads
->destroy(payloads
);
239 /* get the list of suggested proposals */
240 status
= sa_payload
->create_proposal_substructure_iterator(sa_payload
, &suggested_proposals
, TRUE
);
241 if (status
!= SUCCESS
)
243 this->logger
->log(this->logger
, ERROR
, "Fatal error: Could not create iterator on suggested proposals");
244 accepted_proposals
->destroy(accepted_proposals
);
245 payloads
->destroy(payloads
);
249 /* now let the configuration-manager select a subset of the proposals */
250 status
= global_configuration_manager
->select_proposals_for_host(global_configuration_manager
,
251 this->ike_sa
->get_other_host(this->ike_sa
), suggested_proposals
, accepted_proposals
);
252 if (status
!= SUCCESS
)
254 this->logger
->log(this->logger
, CONTROL
| MORE
, "No proposal of suggested proposals selected");
255 suggested_proposals
->destroy(suggested_proposals
);
256 accepted_proposals
->destroy(accepted_proposals
);
257 payloads
->destroy(payloads
);
261 /* iterators are not needed anymore */
262 suggested_proposals
->destroy(suggested_proposals
);
265 /* now let the configuration-manager return the transforms for the given proposal*/
266 this->logger
->log(this->logger
, CONTROL
| MOST
, "Get transforms for accepted proposal");
267 status
= global_configuration_manager
->get_transforms_for_host_and_proposals(global_configuration_manager
,
268 this->ike_sa
->get_other_host(this->ike_sa
), accepted_proposals
, &encryption_algorithm
,&pseudo_random_function
,&integrity_algorithm
);
269 if (status
!= SUCCESS
)
271 this->logger
->log(this->logger
, ERROR
| MORE
, "Accepted proposals not supported?!");
272 accepted_proposals
->destroy(accepted_proposals
);
273 payloads
->destroy(payloads
);
276 accepted_proposals
->destroy(accepted_proposals
);
278 prf
= prf_create(pseudo_random_function
);
281 this->logger
->log(this->logger
, ERROR
| MORE
, "PRF type not supported");
282 payloads
->destroy(payloads
);
285 this->ike_sa
->set_prf(this->ike_sa
,prf
);
287 this->logger
->log(this->logger
, CONTROL
| MORE
, "SA Payload processed");
288 /* ok, we have what we need for sa_payload (proposals are stored in this->proposals)*/
293 ke_payload_t
*ke_payload
= (ke_payload_t
*)payload
;
294 diffie_hellman_group_t group
;
295 diffie_hellman_t
*dh
;
298 group
= ke_payload
->get_dh_group_number(ke_payload
);
300 status
= global_configuration_manager
->is_dh_group_allowed_for_host(global_configuration_manager
,
301 this->ike_sa
->get_other_host(this->ike_sa
), group
, &allowed_group
);
303 if (status
!= SUCCESS
)
305 this->logger
->log(this->logger
, ERROR
| MORE
, "Could not get informations about DH group");
306 payloads
->destroy(payloads
);
311 /** @todo Send info reply */
314 /* create diffie hellman object to handle DH exchange */
315 dh
= diffie_hellman_create(group
);
318 this->logger
->log(this->logger
, ERROR
, "Could not generate DH object");
319 payloads
->destroy(payloads
);
323 this->logger
->log(this->logger
, CONTROL
| MORE
, "Set other DH public value");
325 status
= dh
->set_other_public_value(dh
, ke_payload
->get_key_exchange_data(ke_payload
));
326 if (status
!= SUCCESS
)
328 this->logger
->log(this->logger
, ERROR
, "Could not set other DH public value");
330 payloads
->destroy(payloads
);
334 this->diffie_hellman
= dh
;
336 this->logger
->log(this->logger
, CONTROL
| MORE
, "KE Payload processed");
341 nonce_payload_t
*nonce_payload
= (nonce_payload_t
*)payload
;
343 if (this->received_nonce
.ptr
!= NULL
)
345 this->logger
->log(this->logger
, CONTROL
| MOST
, "Destroy stored received nonce");
346 allocator_free(this->received_nonce
.ptr
);
347 this->received_nonce
.ptr
= NULL
;
348 this->received_nonce
.len
= 0;
351 this->logger
->log(this->logger
, CONTROL
| MORE
, "Get nonce value and store it");
352 status
= nonce_payload
->get_nonce(nonce_payload
, &(this->received_nonce
));
353 if (status
!= SUCCESS
)
355 this->logger
->log(this->logger
, ERROR
, "Fatal error: Could not get nonce");
356 payloads
->destroy(payloads
);
360 this->logger
->log(this->logger
, CONTROL
| MORE
, "Nonce Payload processed");
365 this->logger
->log(this->logger
, ERROR
| MORE
, "Payload type not supported!");
366 payloads
->destroy(payloads
);
373 /* iterator can be destroyed */
374 payloads
->destroy(payloads
);
376 this->logger
->log(this->logger
, CONTROL
| MORE
, "Request successfully handled. Going to create reply.");
378 this->logger
->log(this->logger
, CONTROL
| MOST
, "Going to create nonce.");
380 randomizer
= this->ike_sa
->get_randomizer(this->ike_sa
);
382 if (randomizer
->allocate_pseudo_random_bytes(randomizer
, NONCE_SIZE
, &(this->sent_nonce
)) != SUCCESS
)
384 this->logger
->log(this->logger
, ERROR
, "Could not create nonce!");
388 /* store shared secret */
389 this->logger
->log(this->logger
, CONTROL
| MOST
, "Retrieve shared secret and store it");
390 status
= this->diffie_hellman
->get_shared_secret(this->diffie_hellman
, &shared_secret
);
391 this->logger
->log_chunk(this->logger
, PRIVATE
, "Shared secret", &shared_secret
);
393 status
= this->ike_sa
->compute_secrets(this->ike_sa
,shared_secret
,this->received_nonce
, this->sent_nonce
);
394 if (status
!= SUCCESS
)
396 /* secrets could not be computed */
397 this->logger
->log(this->logger
, ERROR
| MORE
, "Secrets could not be computed!");
403 /* set up the reply */
404 status
= this->ike_sa
->build_message(this->ike_sa
, IKE_SA_INIT
, FALSE
, &response
);
405 if (status
!= SUCCESS
)
407 this->logger
->log(this->logger
, ERROR
, "Could not create empty message");
411 /* build SA payload */
412 status
= this->build_sa_payload(this, &payload
);
413 if (status
!= SUCCESS
)
415 this->logger
->log(this->logger
, ERROR
, "Could not build SA payload");
419 this ->logger
->log(this->logger
, CONTROL
|MOST
, "add SA payload to message");
420 status
= response
->add_payload(response
, payload
);
421 if (status
!= SUCCESS
)
423 this->logger
->log(this->logger
, ERROR
, "Could not add SA payload to message");
427 /* build KE payload */
428 status
= this->build_ke_payload(this,&payload
);
429 if (status
!= SUCCESS
)
431 this->logger
->log(this->logger
, ERROR
, "Could not build KE payload");
435 this ->logger
->log(this->logger
, CONTROL
|MOST
, "add KE payload to message");
436 status
= response
->add_payload(response
, payload
);
437 if (status
!= SUCCESS
)
439 this->logger
->log(this->logger
, ERROR
, "Could not add KE payload to message");
443 /* build Nonce payload */
444 status
= this->build_nonce_payload(this, &payload
);
445 if (status
!= SUCCESS
)
447 this->logger
->log(this->logger
, ERROR
, "Could not build NONCE payload");
451 this ->logger
->log(this->logger
, CONTROL
|MOST
, "add nonce payload to message");
452 status
= response
->add_payload(response
, payload
);
453 if (status
!= SUCCESS
)
455 this->logger
->log(this->logger
, ERROR
, "Could not add nonce payload to message");
459 /* generate packet */
460 this ->logger
->log(this->logger
, CONTROL
|MOST
, "generate packet from message");
461 status
= response
->generate(response
, &packet
);
462 if (status
!= SUCCESS
)
464 this->logger
->log(this->logger
, ERROR
, "Fatal error: could not generate packet from message");
468 this ->logger
->log(this->logger
, CONTROL
|MOST
, "Add packet to global send queue");
469 status
= global_send_queue
->add(global_send_queue
, packet
);
470 if (status
!= SUCCESS
)
472 this->logger
->log(this->logger
, ERROR
, "Could not add packet to send queue");
473 packet
->destroy(packet
);
477 /* state can now be changed */
478 this ->logger
->log(this->logger
, CONTROL
|MOST
, "Create next state object");
480 next_state
= ike_sa_init_responded_create(this->ike_sa
, shared_secret
, this->received_nonce
, this->sent_nonce
);
482 if (next_state
== NULL
)
484 this ->logger
->log(this->logger
, ERROR
, "Fatal error: could not create next state object of type ike_sa_init_responded_t");
485 allocator_free_chunk(&shared_secret
);
489 /* last message can now be set */
490 status
= this->ike_sa
->set_last_responded_message(this->ike_sa
, response
);
492 if (status
!= SUCCESS
)
494 this->logger
->log(this->logger
, ERROR
, "Could not set last responded message");
495 response
->destroy(response
);
496 (next_state
->state_interface
).destroy(&(next_state
->state_interface
));
500 /* state can now be changed */
501 this->ike_sa
->set_new_state(this->ike_sa
, (state_t
*) next_state
);
502 /* state has NOW changed :-) */
503 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
) );
505 this ->logger
->log(this->logger
, CONTROL
|MOST
, "Destroy old sate object");
506 this->destroy_after_state_change(this);
512 * implements private_initiator_init_t.build_sa_payload
514 static status_t
build_sa_payload(private_responder_init_t
*this, payload_t
**payload
)
516 sa_payload_t
* sa_payload
;
517 iterator_t
*proposal_iterator
;
521 /* SA payload takes proposals from this->ike_sa_init_data.proposals and writes them to the created sa_payload */
523 this->logger
->log(this->logger
, CONTROL
|MORE
, "building sa payload");
525 status
= this->proposals
->create_iterator(this->proposals
, &proposal_iterator
, FALSE
);
526 if (status
!= SUCCESS
)
528 this->logger
->log(this->logger
, ERROR
, "Fatal error: Could not create iterator on list for proposals");
532 sa_payload
= sa_payload_create();
533 if (sa_payload
== NULL
)
535 this->logger
->log(this->logger
, ERROR
, "Fatal error: Could not create SA payload object");
539 while (proposal_iterator
->has_next(proposal_iterator
))
541 proposal_substructure_t
*current_proposal
;
542 proposal_substructure_t
*current_proposal_clone
;
543 status
= proposal_iterator
->current(proposal_iterator
,(void **) ¤t_proposal
);
544 if (status
!= SUCCESS
)
546 this->logger
->log(this->logger
, ERROR
, "Could not get current proposal needed to copy");
547 proposal_iterator
->destroy(proposal_iterator
);
548 sa_payload
->destroy(sa_payload
);
551 status
= current_proposal
->clone(current_proposal
,¤t_proposal_clone
);
552 if (status
!= SUCCESS
)
554 this->logger
->log(this->logger
, ERROR
, "Could not clone current proposal");
555 proposal_iterator
->destroy(proposal_iterator
);
556 sa_payload
->destroy(sa_payload
);
560 status
= sa_payload
->add_proposal_substructure(sa_payload
,current_proposal_clone
);
561 if (status
!= SUCCESS
)
563 this->logger
->log(this->logger
, ERROR
, "Could not add cloned proposal to SA payload");
564 proposal_iterator
->destroy(proposal_iterator
);
565 sa_payload
->destroy(sa_payload
);
571 proposal_iterator
->destroy(proposal_iterator
);
573 this->logger
->log(this->logger
, CONTROL
|MORE
, "sa payload builded");
575 *payload
= (payload_t
*) sa_payload
;
581 * implements private_initiator_init_t.build_ke_payload
583 static status_t
build_ke_payload(private_responder_init_t
*this, payload_t
**payload
)
585 ke_payload_t
*ke_payload
;
589 this->logger
->log(this->logger
, CONTROL
|MORE
, "building ke payload");
592 this ->logger
->log(this->logger
, CONTROL
|MORE
, "get public dh value to send in ke payload");
593 status
= this->diffie_hellman
->get_my_public_value(this->diffie_hellman
,&key_data
);
594 if (status
!= SUCCESS
)
596 this->logger
->log(this->logger
, ERROR
, "Could not get my DH public value");
600 ke_payload
= ke_payload_create();
601 if (ke_payload
== NULL
)
603 this->logger
->log(this->logger
, ERROR
, "Could not create KE payload");
604 allocator_free_chunk(&key_data
);
607 ke_payload
->set_dh_group_number(ke_payload
, MODP_1024_BIT
);
608 if (ke_payload
->set_key_exchange_data(ke_payload
, key_data
) != SUCCESS
)
610 this->logger
->log(this->logger
, ERROR
, "Could not set key exchange data of KE payload");
611 ke_payload
->destroy(ke_payload
);
612 allocator_free_chunk(&key_data
);
615 allocator_free_chunk(&key_data
);
617 *payload
= (payload_t
*) ke_payload
;
622 * implements private_initiator_init_t.build_nonce_payload
624 static status_t
build_nonce_payload(private_responder_init_t
*this, payload_t
**payload
)
626 nonce_payload_t
*nonce_payload
;
629 this->logger
->log(this->logger
, CONTROL
|MORE
, "building nonce payload");
631 nonce_payload
= nonce_payload_create();
632 if (nonce_payload
== NULL
)
634 this->logger
->log(this->logger
, ERROR
, "Fatal error: could not create nonce payload object");
638 status
= nonce_payload
->set_nonce(nonce_payload
, this->sent_nonce
);
640 if (status
!= SUCCESS
)
642 this->logger
->log(this->logger
, ERROR
, "Fatal error: could not set nonce data of payload");
643 nonce_payload
->destroy(nonce_payload
);
647 *payload
= (payload_t
*) nonce_payload
;
654 * Implements state_t.get_state
656 static ike_sa_state_t
get_state(private_responder_init_t
*this)
658 return RESPONDER_INIT
;
662 * Implements state_t.get_state
664 static status_t
destroy(private_responder_init_t
*this)
666 this->logger
->log(this->logger
, CONTROL
| MORE
, "Going to destroy responder init state object");
668 /* destroy stored proposal */
669 this->logger
->log(this->logger
, CONTROL
| MOST
, "Destroy stored proposals");
670 while (this->proposals
->get_count(this->proposals
) > 0)
672 proposal_substructure_t
*current_proposal
;
673 this->proposals
->remove_first(this->proposals
,(void **)¤t_proposal
);
674 current_proposal
->destroy(current_proposal
);
676 this->proposals
->destroy(this->proposals
);
678 if (this->sent_nonce
.ptr
!= NULL
)
680 this->logger
->log(this->logger
, CONTROL
| MOST
, "Destroy sent nonce");
681 allocator_free(this->sent_nonce
.ptr
);
684 if (this->received_nonce
.ptr
!= NULL
)
686 this->logger
->log(this->logger
, CONTROL
| MOST
, "Destroy received nonce");
687 allocator_free(this->received_nonce
.ptr
);
690 /* destroy diffie hellman object */
691 if (this->diffie_hellman
!= NULL
)
693 this->logger
->log(this->logger
, CONTROL
| MOST
, "Destroy diffie_hellman_t object");
694 this->diffie_hellman
->destroy(this->diffie_hellman
);
697 allocator_free(this);
704 * Implements private_responder_init_t.destroy_after_state_change
706 static status_t
destroy_after_state_change (private_responder_init_t
*this)
708 this->logger
->log(this->logger
, CONTROL
| MORE
, "Going to destroy responder_init_t state object");
710 /* destroy stored proposal */
711 this->logger
->log(this->logger
, CONTROL
| MOST
, "Destroy stored proposals");
712 while (this->proposals
->get_count(this->proposals
) > 0)
714 proposal_substructure_t
*current_proposal
;
715 this->proposals
->remove_first(this->proposals
,(void **)¤t_proposal
);
716 current_proposal
->destroy(current_proposal
);
718 this->proposals
->destroy(this->proposals
);
720 /* destroy diffie hellman object */
721 if (this->diffie_hellman
!= NULL
)
723 this->logger
->log(this->logger
, CONTROL
| MOST
, "Destroy diffie_hellman_t object");
724 this->diffie_hellman
->destroy(this->diffie_hellman
);
727 allocator_free(this);
732 * Described in header.
734 responder_init_t
*responder_init_create(protected_ike_sa_t
*ike_sa
)
736 private_responder_init_t
*this = allocator_alloc_thing(private_responder_init_t
);
743 /* interface functions */
744 this->public.state_interface
.process_message
= (status_t (*) (state_t
*,message_t
*)) process_message
;
745 this->public.state_interface
.get_state
= (ike_sa_state_t (*) (state_t
*)) get_state
;
746 this->public.state_interface
.destroy
= (status_t (*) (state_t
*)) destroy
;
748 /* private functions */
749 this->build_sa_payload
= build_sa_payload
;
750 this->build_ke_payload
= build_ke_payload
;
751 this->build_nonce_payload
= build_nonce_payload
;
752 this->destroy_after_state_change
= destroy_after_state_change
;
755 this->ike_sa
= ike_sa
;
756 this->logger
= this->ike_sa
->get_logger(this->ike_sa
);
757 this->sent_nonce
.ptr
= NULL
;
758 this->sent_nonce
.len
= 0;
759 this->received_nonce
.ptr
= NULL
;
760 this->received_nonce
.len
= 0;
761 this->proposals
= linked_list_create();
762 if (this->proposals
== NULL
)
764 allocator_free(this);
768 return &(this->public);