src/libcharon/encoding/payloads/transform_substructure.h

   1 /*
   2  * Copyright (C) 2005-2006 Martin Willi
   3  * Copyright (C) 2005 Jan Hutter
   4  *
   5  * Copyright (C) secunet Security Networks AG
   6  *
   7  * This program is free software; you can redistribute it and/or modify it
   8  * under the terms of the GNU General Public License as published by the
   9  * Free Software Foundation; either version 2 of the License, or (at your
  10  * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  14  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  15  * for more details.
  16  */
  17
  18 /**
  19  * @defgroup transform_substructure transform_substructure
  20  * @{ @ingroup payloads
  21  */
  22
  23 #ifndef TRANSFORM_SUBSTRUCTURE_H_
  24 #define TRANSFORM_SUBSTRUCTURE_H_
  25
  26 typedef struct transform_substructure_t transform_substructure_t;
  27
  28 #include <library.h>
  29 #include <encoding/payloads/payload.h>
  30 #include <encoding/payloads/transform_attribute.h>
  31 #include <collections/linked_list.h>
  32 #include <crypto/diffie_hellman.h>
  33 #include <crypto/signers/signer.h>
  34 #include <crypto/prfs/prf.h>
  35 #include <crypto/crypters/crypter.h>
  36 #include <crypto/proposal/proposal.h>
  37
  38 /**
  39  * IKEv1 Value for a transform payload.
  40  */
  41 #define TRANSFORM_TYPE_VALUE 3
  42
  43 /**
  44  * Class representing an IKEv1/IKEv2 transform substructure.
  45  */
  46 struct transform_substructure_t {
  47
  48         /**
  49          * The payload_t interface.
  50          */
  51         payload_t payload_interface;
  52
  53         /**
  54          * Adds a transform_attribute_t object to this object.
  55          *
  56          * @param proposal  transform_attribute_t object to add
  57          */
  58         void (*add_transform_attribute) (transform_substructure_t *this,
  59                                                                          transform_attribute_t *attribute);
  60
  61         /**
  62          * Sets the next_payload field of this substructure
  63          *
  64          * If this is the last transform, next payload field is set to 0,
  65          * otherwise to 3
  66          *
  67          * @param is_last       When TRUE, next payload field is set to 0, otherwise to 3
  68          */
  69         void (*set_is_last_transform) (transform_substructure_t *this, bool is_last);
  70
  71         /**
  72          * Get transform type (IKEv2) or the transform number (IKEv1).
  73          *
  74          * @return                      Transform type of current transform substructure.
  75          */
  76         uint8_t (*get_transform_type_or_number) (transform_substructure_t *this);
  77
  78         /**
  79          * Get transform id of the current transform.
  80          *
  81          * @return                      Transform id of current transform substructure.
  82          */
  83         uint16_t (*get_transform_id) (transform_substructure_t *this);
  84
  85         /**
  86          * Create an enumerator over transform attributes.
  87          *
  88          * @return                      enumerator over transform_attribute_t*
  89          */
  90         enumerator_t* (*create_attribute_enumerator)(transform_substructure_t *this);
  91
  92         /**
  93          * Destroys an transform_substructure_t object.
  94          */
  95         void (*destroy) (transform_substructure_t *this);
  96 };
  97
  98 /**
  99  * Creates an empty transform_substructure_t object.
 100  *
 101  * @param type                  PLV2_TRANSFORM_SUBSTRUCTURE or PLV1_TRANSFORM_SUBSTRUCTURE
 102  * @return                              created transform_substructure_t object
 103  */
 104 transform_substructure_t *transform_substructure_create(payload_type_t type);
 105
 106 /**
 107  * Creates an empty transform_substructure_t object.
 108  *
 109  * @param type                          PLV2_TRANSFORM_SUBSTRUCTURE or PLV1_TRANSFORM_SUBSTRUCTURE
 110  * @param type_or_number        Type (IKEv2) or number (IKEv1) of transform
 111  * @param id                            transform id specific for the transform type
 112  * @return                                      transform_substructure_t object
 113  */
 114 transform_substructure_t *transform_substructure_create_type(payload_type_t type,
 115                                                                                 uint8_t type_or_number, uint16_t id);
 116
 117 #endif /** TRANSFORM_SUBSTRUCTURE_H_ @}*/