Added not-yet used sa_payload parameters used in IKEv1
[strongswan.git] / src / libcharon / encoding / payloads / sa_payload.h
index d6c6b60..dfba477 100644 (file)
@@ -28,6 +28,8 @@ typedef struct sa_payload_t sa_payload_t;
 #include <encoding/payloads/payload.h>
 #include <encoding/payloads/proposal_substructure.h>
 #include <utils/linked_list.h>
+#include <kernel/kernel_ipsec.h>
+#include <sa/authenticators/authenticator.h>
 
 /**
  * Class representing an IKEv1 or IKEv2 SA Payload.
@@ -49,6 +51,35 @@ struct sa_payload_t {
        linked_list_t *(*get_proposals) (sa_payload_t *this);
 
        /**
+        * Get the (shortest) lifetime of a proposal (IKEv1 only).
+        *
+        * @return                                      lifetime, in seconds
+        */
+       u_int32_t (*get_lifetime)(sa_payload_t *this);
+
+       /**
+        * Get the (shortest) life duration of a proposal (IKEv1 only).
+        *
+        * @return                                      life duration, in bytes
+        */
+       u_int64_t (*get_lifebytes)(sa_payload_t *this);
+
+       /**
+        * Get the first authentication method from the proposal (IKEv1 only).
+        *
+        * @return                                      auth method, or AUTH_NONE
+        */
+       auth_method_t (*get_auth_method)(sa_payload_t *this);
+
+       /**
+        * Get the (first) encapsulation mode from a proposal (IKEv1 only).
+        *
+        * @param udp                           set to TRUE if UDP encapsulation used
+        * @return                                      ipsec encapsulation mode
+        */
+       ipsec_mode_t (*get_encap_mode)(sa_payload_t *this, bool *udp);
+
+       /**
         * Create an enumerator over all proposal substructures.
         *
         * @return                                      enumerator over proposal_substructure_t
@@ -70,26 +101,49 @@ struct sa_payload_t {
 sa_payload_t *sa_payload_create(payload_type_t type);
 
 /**
- * Creates a sa_payload_t object from a list of proposals.
+ * Creates an IKEv2 sa_payload_t object from a list of proposals.
  *
- * @param type                         SECURITY_ASSOCIATION or SECURITY_ASSOCIATION_V1
  * @param proposals                    list of proposals to build the payload from
  * @return                                     sa_payload_t object
  */
-sa_payload_t *sa_payload_create_from_proposal_list(payload_type_t type,
-                                                                                                  linked_list_t *proposals);
+sa_payload_t *sa_payload_create_from_proposals_v2(linked_list_t *proposals);
+
+/**
+ * Creates an IKEv2 sa_payload_t object from a single proposal.
+ *
+ * @param proposal                     proposal from which the payload should be built.
+ * @return                                     sa_payload_t object
+ */
+sa_payload_t *sa_payload_create_from_proposal_v2(proposal_t *proposal);
 
 /**
- * Creates a sa_payload_t object from a single proposal.
+ * Creates an IKEv1 sa_payload_t object from a list of proposals.
  *
- * This is only for convenience. Use sa_payload_create_from_proposal_list
- * if you want to add more than one proposal.
+ * @param proposals                    list of proposals to build the payload from
+ * @param lifetime                     lifetime in seconds
+ * @param lifebytes                    lifebytes, in bytes
+ * @param auth                         authentication method to use, or AUTH_NONE
+ * @param mode                         IPsec encapsulation mode, TRANSPORT or TUNNEL
+ * @param udp                          TRUE to use UDP encapsulation
+ * @return                                     sa_payload_t object
+ */
+sa_payload_t *sa_payload_create_from_proposals_v1(linked_list_t *proposals,
+                                                       u_int32_t lifetime, u_int64_t lifebytes,
+                                                       auth_method_t auth, ipsec_mode_t mode, bool udp);
+
+/**
+ * Creates an IKEv1 sa_payload_t object from a single proposal.
  *
- * @param type                         SECURITY_ASSOCIATION or SECURITY_ASSOCIATION_V1
  * @param proposal                     proposal from which the payload should be built.
+ * @param lifetime                     lifetime in seconds
+ * @param lifebytes                    lifebytes, in bytes
+ * @param auth                         authentication method to use, or AUTH_NONE
+ * @param mode                         IPsec encapsulation mode, TRANSPORT or TUNNEL
+ * @param udp                          TRUE to use UDP encapsulation
  * @return                                     sa_payload_t object
  */
-sa_payload_t *sa_payload_create_from_proposal(payload_type_t type,
-                                                                                         proposal_t *proposal);
+sa_payload_t *sa_payload_create_from_proposal_v1(proposal_t *proposal,
+                                                       u_int32_t lifetime, u_int64_t lifebytes,
+                                                       auth_method_t auth, ipsec_mode_t mode, bool udp);
 
 #endif /** SA_PAYLOAD_H_ @}*/