- comments
[strongswan.git] / Source / charon / sa / states / ike_sa_init_responded.h
index e9780da..1e7dd03 100644 (file)
@@ -1,7 +1,7 @@
 /**
  * @file ike_sa_init_responded.h
  * 
- * @brief State of a IKE_SA after responding to an IKE_SA_INIT request
+ * @brief Interface of ike_sa_init_responded_t.
  * 
  */
 
 #include <sa/ike_sa.h>
 #include <sa/states/state.h>
 
+typedef struct ike_sa_init_responded_t ike_sa_init_responded_t;
+
 /**
- * @brief This class represents an IKE_SA state when responded to an IKE_SA_INIT request
- *
+ * @brief This class represents an IKE_SA state when 
+ * responded to an IKE_SA_INIT request.
+ * 
+ * The state accpets IKE_AUTH requests. It proves the authenticity
+ * and sets up the first child sa. Then it sends back an IKE_AUTH
+ * reply and processes to the IKE_SA_ESTABLISHED state.
+ * 
+ * @ingroup states
  */
-typedef struct ike_sa_init_responded_s ike_sa_init_responded_t;
-
-struct ike_sa_init_responded_s {
+struct ike_sa_init_responded_t {
        /**
         * methods of the state_t interface
         */
@@ -41,10 +47,13 @@ struct ike_sa_init_responded_s {
 };
 
 /**
- * Constructor of class ike_sa_init_responded_t
+ * @brief Constructor of class ike_sa_init_responded_t
+ * 
+ * @param ike_sa               assigned IKE_SA
+ * @todo Params description
  * 
- * @param ike_sa assigned IKE_SA
+ * @ingroup states
  */
-ike_sa_init_responded_t *ike_sa_init_responded_create(protected_ike_sa_t *ike_sa, chunk_t shared_secret, chunk_t received_nonce, chunk_t sent_nonce);
+ike_sa_init_responded_t *ike_sa_init_responded_create(protected_ike_sa_t *ike_sa);
 
 #endif /*IKE_SA_INIT_RESPONDED_H_*/