Migrated ke_payload to INIT/METHOD macros
authorMartin Willi <martin@revosec.ch>
Wed, 24 Nov 2010 10:37:34 +0000 (11:37 +0100)
committerMartin Willi <martin@revosec.ch>
Wed, 5 Jan 2011 15:45:50 +0000 (16:45 +0100)
src/libcharon/encoding/payloads/ke_payload.c
src/libcharon/encoding/payloads/ke_payload.h

index 5a9f67d..ddea0b3 100644 (file)
@@ -1,5 +1,6 @@
 /*
- * Copyright (C) 2005-2006 Martin Willi
+ * Copyright (C) 2005-2010 Martin Willi
+ * Copyright (C) 2010 revosec AG
  * Copyright (C) 2005 Jan Hutter
  * Hochschule fuer Technik Rapperswil
  *
 
 #include <encoding/payloads/encodings.h>
 
-
 typedef struct private_ke_payload_t private_ke_payload_t;
 
 /**
  * Private data of an ke_payload_t object.
- *
  */
 struct private_ke_payload_t {
+
        /**
         * Public ke_payload_t interface.
         */
@@ -64,27 +64,26 @@ struct private_ke_payload_t {
  *
  * The defined offsets are the positions in a object of type
  * private_ke_payload_t.
- *
  */
 encoding_rule_t ke_payload_encodings[] = {
        /* 1 Byte next payload type, stored in the field next_payload */
-       { U_INT_8,                      offsetof(private_ke_payload_t, next_payload)            },
+       { U_INT_8,                              offsetof(private_ke_payload_t, next_payload)    },
        /* the critical bit */
-       { FLAG,                         offsetof(private_ke_payload_t, critical)                        },
+       { FLAG,                                 offsetof(private_ke_payload_t, critical)                },
        /* 7 Bit reserved bits, nowhere stored */
-       { RESERVED_BIT, 0                                                                                                               },
-       { RESERVED_BIT, 0                                                                                                               },
-       { RESERVED_BIT, 0                                                                                                               },
-       { RESERVED_BIT, 0                                                                                                               },
-       { RESERVED_BIT, 0                                                                                                               },
-       { RESERVED_BIT, 0                                                                                                               },
-       { RESERVED_BIT, 0                                                                                                               },
+       { RESERVED_BIT,                 0                                                                                               },
+       { RESERVED_BIT,                 0                                                                                               },
+       { RESERVED_BIT,                 0                                                                                               },
+       { RESERVED_BIT,                 0                                                                                               },
+       { RESERVED_BIT,                 0                                                                                               },
+       { RESERVED_BIT,                 0                                                                                               },
+       { RESERVED_BIT,                 0                                                                                               },
        /* Length of the whole payload*/
-       { PAYLOAD_LENGTH,       offsetof(private_ke_payload_t, payload_length)          },
+       { PAYLOAD_LENGTH,               offsetof(private_ke_payload_t, payload_length)  },
        /* DH Group number as 16 bit field*/
-       { U_INT_16,                     offsetof(private_ke_payload_t, dh_group_number)         },
-       { RESERVED_BYTE,        0                                                                                                       },
-       { RESERVED_BYTE,        0                                                                                                       },
+       { U_INT_16,                             offsetof(private_ke_payload_t, dh_group_number) },
+       { RESERVED_BYTE,                0                                                                                               },
+       { RESERVED_BYTE,                0                                                                                               },
        /* Key Exchange Data is from variable size */
        { KEY_EXCHANGE_DATA,    offsetof(private_ke_payload_t, key_exchange_data)}
 };
@@ -103,104 +102,60 @@ encoding_rule_t ke_payload_encodings[] = {
       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 */
 
-/**
- * Implementation of payload_t.verify.
- */
-static status_t verify(private_ke_payload_t *this)
+METHOD(payload_t, verify, status_t,
+       private_ke_payload_t *this)
 {
-       /* dh group is not verified in here */
        return SUCCESS;
 }
 
-/**
- * Implementation of payload_t.destroy.
- */
-static void destroy(private_ke_payload_t *this)
-{
-       if (this->key_exchange_data.ptr != NULL)
-       {
-               free(this->key_exchange_data.ptr);
-       }
-       free(this);
-}
-
-/**
- * Implementation of payload_t.get_encoding_rules.
- */
-static void get_encoding_rules(private_ke_payload_t *this, encoding_rule_t **rules, size_t *rule_count)
+METHOD(payload_t, get_encoding_rules, void,
+       private_ke_payload_t *this, encoding_rule_t **rules, size_t *rule_count)
 {
        *rules = ke_payload_encodings;
-       *rule_count = sizeof(ke_payload_encodings) / sizeof(encoding_rule_t);
+       *rule_count = countof(ke_payload_encodings);
 }
 
-/**
- * Implementation of payload_t.get_type.
- */
-static payload_type_t get_type(private_ke_payload_t *this)
+METHOD(payload_t, get_type, payload_type_t,
+       private_ke_payload_t *this)
 {
        return KEY_EXCHANGE;
 }
 
-/**
- * Implementation of payload_t.get_next_type.
- */
-static payload_type_t get_next_type(private_ke_payload_t *this)
+METHOD(payload_t, get_next_type, payload_type_t,
+       private_ke_payload_t *this)
 {
        return this->next_payload;
 }
 
-/**
- * Implementation of payload_t.set_next_type.
- */
-static void set_next_type(private_ke_payload_t *this,payload_type_t type)
+METHOD(payload_t, set_next_type, void,
+       private_ke_payload_t *this,payload_type_t type)
 {
        this->next_payload = type;
 }
 
-/**
- * recompute the length of the payload.
- */
-static void compute_length(private_ke_payload_t *this)
-{
-       size_t length = KE_PAYLOAD_HEADER_LENGTH;
-
-       if (this->key_exchange_data.ptr != NULL)
-       {
-               length += this->key_exchange_data.len;
-       }
-       this->payload_length = length;
-}
-
-/**
- * Implementation of payload_t.get_length.
- */
-static size_t get_length(private_ke_payload_t *this)
+METHOD(payload_t, get_length, size_t,
+       private_ke_payload_t *this)
 {
        return this->payload_length;
 }
 
-/**
- * Implementation of ke_payload_t.get_key_exchange_data.
- */
-static chunk_t get_key_exchange_data(private_ke_payload_t *this)
+METHOD(ke_payload_t, get_key_exchange_data, chunk_t,
+       private_ke_payload_t *this)
 {
        return this->key_exchange_data;
 }
 
-/**
- * Implementation of ke_payload_t.get_dh_group_number.
- */
-static diffie_hellman_group_t get_dh_group_number(private_ke_payload_t *this)
+METHOD(ke_payload_t, get_dh_group_number, diffie_hellman_group_t,
+       private_ke_payload_t *this)
 {
        return this->dh_group_number;
 }
 
-/**
- * Implementation of ke_payload_t.set_dh_group_number.
- */
-static void set_dh_group_number(private_ke_payload_t *this, diffie_hellman_group_t dh_group_number)
+METHOD2(payload_t, ke_payload_t, destroy, void,
+       private_ke_payload_t *this)
 {
-       this->dh_group_number = dh_group_number;
+       free(this->key_exchange_data.ptr);
+       free(this);
 }
 
 /*
@@ -208,30 +163,27 @@ static void set_dh_group_number(private_ke_payload_t *this, diffie_hellman_group
  */
 ke_payload_t *ke_payload_create()
 {
-       private_ke_payload_t *this = malloc_thing(private_ke_payload_t);
-
-       /* interface functions */
-       this->public.payload_interface.verify = (status_t (*) (payload_t *))verify;
-       this->public.payload_interface.get_encoding_rules = (void (*) (payload_t *, encoding_rule_t **, size_t *) ) get_encoding_rules;
-       this->public.payload_interface.get_length = (size_t (*) (payload_t *)) get_length;
-       this->public.payload_interface.get_next_type = (payload_type_t (*) (payload_t *)) get_next_type;
-       this->public.payload_interface.set_next_type = (void (*) (payload_t *,payload_type_t)) set_next_type;
-       this->public.payload_interface.get_type = (payload_type_t (*) (payload_t *)) get_type;
-       this->public.payload_interface.destroy = (void (*) (payload_t *))destroy;
-
-       /* public functions */
-       this->public.get_key_exchange_data = (chunk_t (*) (ke_payload_t *)) get_key_exchange_data;
-       this->public.get_dh_group_number = (diffie_hellman_group_t (*) (ke_payload_t *)) get_dh_group_number;
-       this->public.set_dh_group_number =(void (*) (ke_payload_t *,diffie_hellman_group_t)) set_dh_group_number;
-       this->public.destroy = (void (*) (ke_payload_t *)) destroy;
-
-       /* set default values of the fields */
-       this->critical = FALSE;
-       this->next_payload = NO_PAYLOAD;
-       this->payload_length = KE_PAYLOAD_HEADER_LENGTH;
-       this->key_exchange_data = chunk_empty;
-       this->dh_group_number = MODP_NONE;
-
+       private_ke_payload_t *this;
+
+       INIT(this,
+               .public = {
+                       .payload_interface = {
+                               .verify = _verify,
+                               .get_encoding_rules = _get_encoding_rules,
+                               .get_length = _get_length,
+                               .get_next_type = _get_next_type,
+                               .set_next_type = _set_next_type,
+                               .get_type = _get_type,
+                               .destroy = _destroy,
+                       },
+                       .get_key_exchange_data = _get_key_exchange_data,
+                       .get_dh_group_number = _get_dh_group_number,
+                       .destroy = _destroy,
+               },
+               .next_payload = NO_PAYLOAD,
+               .payload_length = KE_PAYLOAD_HEADER_LENGTH,
+               .dh_group_number = MODP_NONE,
+       );
        return &this->public;
 }
 
@@ -244,7 +196,7 @@ ke_payload_t *ke_payload_create_from_diffie_hellman(diffie_hellman_t *dh)
 
        dh->get_my_public_value(dh, &this->key_exchange_data);
        this->dh_group_number = dh->get_dh_group(dh);
-       compute_length(this);
+       this->payload_length = this->key_exchange_data.len + KE_PAYLOAD_HEADER_LENGTH;
 
        return &this->public;
 }
index 92ed29b..65cc118 100644 (file)
@@ -47,11 +47,9 @@ struct ke_payload_t {
        payload_t payload_interface;
 
        /**
-        * Returns the currently set key exchange data of this KE payload.
+        * Returns the key exchange data of this KE payload.
         *
-        * @warning Returned data are not copied.
-        *
-        * @return              chunk_t pointing to the value
+        * @return              chunk_t pointing to internal data
         */
        chunk_t (*get_key_exchange_data) (ke_payload_t *this);
 
@@ -63,14 +61,6 @@ struct ke_payload_t {
        diffie_hellman_group_t (*get_dh_group_number) (ke_payload_t *this);
 
        /**
-        * Sets the Diffie-Hellman Group Number of this KE payload.
-        *
-        * @param dh_group_number       DH Group to set
-        */
-       void (*set_dh_group_number) (ke_payload_t *this,
-                                                                diffie_hellman_group_t dh_group_number);
-
-       /**
         * Destroys an ke_payload_t object.
         */
        void (*destroy) (ke_payload_t *this);