e765eff5f8a8a1e7f3e451eaa8da9ee969373fa8
[strongswan.git] / Source / charon / generator.h
1 /**
2 * @file generator.h
3 *
4 * @brief Generic generator class used to generate IKEv2-Header and Payload
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 * Data Buffer for generating has start size of 3000 Bytes
31 */
32 #define GENERATOR_DATA_BUFFER_SIZE 3000
33
34 /**
35 * @brief A generator_t-object which generates payloads of specific type
36 */
37 typedef struct generator_s generator_t;
38
39 struct generator_s {
40
41 /**
42 * @brief Generates a specific payload from given data struct
43 *
44 * Remember: Header and substructures are also seen as payloads
45 *
46 * @param generator generator object
47 * @param payload_type payload type to generate using the given data struct
48 * @param[in] data_struct Data struct where the needed data for generating are stored
49 * @param[out] output pointer to a chunk_t where the data are generated to
50 * @return SUCCESSFUL if succeeded,
51 * NOT_SUPPORTED if payload_type is not supported
52 * OUT_OF_RES if out of ressources
53 */
54 status_t (*generate_payload) (generator_t *this,payload_type_t payload_type,void * data_struct, chunk_t *data);
55
56 /**
57 * @brief Destroys a generator object
58 *
59 * @param generator generator object
60 * @return SUCCESSFUL if succeeded, FAILED otherwise
61 */
62 status_t (*destroy) (generator_t *this);
63 };
64
65 /**
66 * Constructor to create a generator
67 *
68 * @param payload_infos pointer to the payload_info_t-array containing
69 * all the payload informations needed to automatic generate a specific payload
70 */
71 generator_t * generator_create(payload_info_t ** payload_infos);
72
73 #endif /*GENERATOR_H_*/