src/charon/charon/sa/states/ike_auth_requested.h

   1 /**
   2  * @file ike_auth_requested.h
   3  *
   4  * @brief Interface of ike_auth_requested_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_AUTH_REQUESTED_H_
  24 #define IKE_AUTH_REQUESTED_H_
  25
  26 #include <sa/states/state.h>
  27 #include <sa/ike_sa.h>
  28
  29
  30 typedef struct ike_auth_requested_t ike_auth_requested_t;
  31
  32 /**
  33  * @brief This class represents an IKE_SA, which has requested an IKE_AUTH.
  34  *
  35  * The state accpets IKE_AUTH responses. It proves the authenticity
  36  * and sets up the first child sa. After that, it changes IKE_SA state to
  37  * IKE_SA_ESTABLISHED.
  38  *
  39  * @ Constructors:
  40  *  - ike_auth_requested_create()
  41  *
  42  * @todo handle certificate payloads
  43  *
  44  * @ingroup states
  45  */
  46 struct ike_auth_requested_t {
  47         /**
  48          * The state_t interface.
  49          */
  50         state_t state_interface;
  51
  52 };
  53
  54 /**
  55  * Constructor of class ike_auth_requested_t
  56  *
  57  * @param ike_sa                                        assigned ike_sa object
  58  * @param sent_nonce                            Sent nonce value in IKE_SA_INIT request
  59  * @param received_nonce                        Received nonce value in IKE_SA_INIT response
  60  * @param ike_sa_init_reply_data        binary representation of IKE_SA_INIT reply
  61  * @param child_sa                                      opened but not completed child_sa
  62  * @return                                                      created ike_auth_requested_t object
  63  *
  64  * @ingroup states
  65  */
  66 ike_auth_requested_t *ike_auth_requested_create(protected_ike_sa_t *ike_sa,
  67                                                                                                 chunk_t sent_nonce,
  68                                                                                                 chunk_t received_nonce,
  69                                                                                                 chunk_t ike_sa_init_reply_data,
  70                                                                                                 child_sa_t *child_sa);
  71
  72 #endif /*IKE_AUTH_REQUESTED_H_*/