payload: Use common prefixes for all payload type identifiers
[strongswan.git] / src / libcharon / encoding / payloads / transform_substructure.h
index 5d31f8c..ba821d3 100644 (file)
@@ -27,50 +27,29 @@ typedef struct transform_substructure_t transform_substructure_t;
 #include <library.h>
 #include <encoding/payloads/payload.h>
 #include <encoding/payloads/transform_attribute.h>
-#include <utils/linked_list.h>
+#include <collections/linked_list.h>
 #include <crypto/diffie_hellman.h>
 #include <crypto/signers/signer.h>
 #include <crypto/prfs/prf.h>
 #include <crypto/crypters/crypter.h>
 #include <config/proposal.h>
 
-
 /**
  * IKEv1 Value for a transform payload.
  */
 #define TRANSFORM_TYPE_VALUE 3
 
 /**
- * Length of the transform substructure header in bytes.
- */
-#define TRANSFORM_SUBSTRUCTURE_HEADER_LENGTH 8
-
-
-/**
- * Class representing an IKEv2- TRANSFORM SUBSTRUCTURE.
- *
- * The TRANSFORM SUBSTRUCTURE format is described in RFC section 3.3.2.
+ * Class representing an IKEv1/IKEv2 transform substructure.
  */
 struct transform_substructure_t {
+
        /**
         * The payload_t interface.
         */
        payload_t payload_interface;
 
        /**
-        * Creates an iterator of stored transform_attribute_t objects.
-        *
-        * When deleting an transform attribute using this iterator,
-        * the length of this transform substructure has to be refreshed
-        * by calling get_length().
-        *
-        * @param forward               iterator direction (TRUE: front to end)
-        * @return                              created iterator_t object.
-        */
-       iterator_t * (*create_transform_attribute_iterator) (
-                                                               transform_substructure_t *this, bool forward);
-
-       /**
         * Adds a transform_attribute_t object to this object.
         *
         * @param proposal  transform_attribute_t object to add
@@ -89,58 +68,25 @@ struct transform_substructure_t {
        void (*set_is_last_transform) (transform_substructure_t *this, bool is_last);
 
        /**
-        * Checks if this is the last transform.
-        *
-        * @return                      TRUE if this is the last Transform, FALSE otherwise
-        */
-       bool (*get_is_last_transform) (transform_substructure_t *this);
-
-       /**
-        * Sets transform type of the current transform substructure.
-        *
-        * @param type          type value to set
-        */
-       void (*set_transform_type) (transform_substructure_t *this, u_int8_t type);
-
-       /**
-        * get transform type of the current transform.
+        * Get transform type (IKEv2) or the transform number (IKEv1).
         *
         * @return                      Transform type of current transform substructure.
         */
-       u_int8_t (*get_transform_type) (transform_substructure_t *this);
-
-       /**
-        * Sets transform id of the current transform substructure.
-        *
-        * @param id            transform id to set
-        */
-       void (*set_transform_id) (transform_substructure_t *this, u_int16_t id);
+       u_int8_t (*get_transform_type_or_number) (transform_substructure_t *this);
 
        /**
-        * get transform id of the current transform.
+        * Get transform id of the current transform.
         *
         * @return                      Transform id of current transform substructure.
         */
        u_int16_t (*get_transform_id) (transform_substructure_t *this);
 
        /**
-        * get transform id of the current transform.
+        * Create an enumerator over transform attributes.
         *
-        * @param key_length    The key length is written to this location
-        * @return
-        *                                              - SUCCESS if a key length attribute is contained
-        *                                              - FAILED if no key length attribute is part of this
-        *                                                transform or key length uses more then 16 bit!
+        * @return                      enumerator over transform_attribute_t*
         */
-       status_t (*get_key_length) (transform_substructure_t *this,
-                                                               u_int16_t *key_length);
-
-       /**
-        * Clones an transform_substructure_t object.
-        *
-        * @return              cloned transform_substructure_t object
-        */
-       transform_substructure_t* (*clone) (transform_substructure_t *this);
+       enumerator_t* (*create_attribute_enumerator)(transform_substructure_t *this);
 
        /**
         * Destroys an transform_substructure_t object.
@@ -151,24 +97,20 @@ struct transform_substructure_t {
 /**
  * Creates an empty transform_substructure_t object.
  *
- * @return                     created transform_substructure_t object
+ * @param type                 PLV2_TRANSFORM_SUBSTRUCTURE or PLV1_TRANSFORM_SUBSTRUCTURE
+ * @return                             created transform_substructure_t object
  */
-transform_substructure_t *transform_substructure_create(void);
+transform_substructure_t *transform_substructure_create(payload_type_t type);
 
 /**
  * Creates an empty transform_substructure_t object.
  *
- * The key length is used for the transport types ENCRYPTION_ALGORITHM,
- * PSEUDO_RANDOM_FUNCTION, INTEGRITY_ALGORITHM. For all
- * other transport types the key_length parameter is not used
- *
- * @param transform_type       type of transform to create
- * @param transform_id         transform id specifying the specific algorithm of a transform type
- * @param key_length           Key length for key lenght attribute
+ * @param type                         PLV2_TRANSFORM_SUBSTRUCTURE or PLV1_TRANSFORM_SUBSTRUCTURE
+ * @param type_or_number       Type (IKEv2) or number (IKEv1) of transform
+ * @param id                           transform id specifc for the transform type
  * @return                                     transform_substructure_t object
  */
-transform_substructure_t *transform_substructure_create_type(
-                                               transform_type_t transform_type, u_int16_t transform_id,
-                                               u_int16_t key_length);
+transform_substructure_t *transform_substructure_create_type(payload_type_t type,
+                                                                               u_int8_t type_or_number, u_int16_t id);
 
 #endif /** TRANSFORM_SUBSTRUCTURE_H_ @}*/