Source/charon/generator.h

   1 /**
   2  * @file generator.h
   3  *
   4  * @brief Generic generator class used to generate IKEv2-header and payloads.
   5  *
   6  */
   7
   8 /*
   9  * Copyright (C) 2005 Jan Hutter, Martin Willi
  10  * Hochschule fuer Technik Rapperswil
  11  *
  12  * This program is free software; you can redistribute it and/or modify it
  13  * under the terms of the GNU General Public License as published by the
  14  * Free Software Foundation; either version 2 of the License, or (at your
  15  * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
  16  *
  17  * This program is distributed in the hope that it will be useful, but
  18  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  19  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  20  * for more details.
  21  */
  22
  23 #ifndef GENERATOR_H_
  24 #define GENERATOR_H_
  25
  26 #include "types.h"
  27 #include "encodings.h"
  28
  29 /**
  30  * Generating is done in a data buffer.
  31  * This is thehe start size of this buffer in Bytes.
  32  */
  33 #define GENERATOR_DATA_BUFFER_SIZE 3000
  34
  35 /**
  36  * Number of bytes to increase the buffer, if it is to small.
  37  */
  38 #define GENERATOR_DATA_BUFFER_INCREASE_VALUE 1000
  39
  40 /**
  41  * @brief A generator_t-object which generates payloads of specific type
  42  */
  43 typedef struct generator_s generator_t;
  44
  45 struct generator_s {
  46
  47         /**
  48          * @brief Generates a specific payload from given data struct
  49          *
  50          * Remember: Header and substructures are also seen as payloads
  51          *
  52          * @param generator generator object
  53          * @param payload_type payload type to generate using the given data struct
  54          * @param[in] data_struct Data struct where the needed data for generating are stored
  55          * @param[out] output pointer to a chunk_t where the data are generated to
  56          * @return SUCCESSFUL if succeeded,
  57          *                 NOT_SUPPORTED if payload_type is not supported
  58          *                 OUT_OF_RES if out of ressources
  59          */
  60         status_t (*generate_payload) (generator_t *this,payload_type_t payload_type,void * data_struct, chunk_t *data);
  61
  62         /**
  63          * @brief Destroys a generator object
  64          *
  65          * @param generator generator object
  66          * @return SUCCESSFUL if succeeded, FAILED otherwise
  67          */
  68         status_t (*destroy) (generator_t *this);
  69 };
  70
  71 /**
  72  * Constructor to create a generator
  73  *
  74  * @param payload_infos pointer to the payload_info_t-array containing
  75  * all the payload informations needed to automatic generate a specific payload
  76  */
  77 generator_t * generator_create(payload_info_t ** payload_infos);
  78
  79 #endif /*GENERATOR_H_*/