Removed strayed code fragment
[strongswan.git] / src / charon / encoding / payloads / certreq_payload.h
1 /*
2 * Copyright (C) 2005-2006 Martin Willi
3 * Copyright (C) 2005 Jan Hutter
4 * Hochschule fuer Technik Rapperswil
5 *
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation; either version 2 of the License, or (at your
9 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
10 *
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
13 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * for more details.
15 */
16
17 /**
18 * @defgroup certreq_payload certreq_payload
19 * @{ @ingroup payloads
20 */
21
22 #ifndef CERTREQ_PAYLOAD_H_
23 #define CERTREQ_PAYLOAD_H_
24
25 typedef struct certreq_payload_t certreq_payload_t;
26
27 #include <library.h>
28 #include <encoding/payloads/payload.h>
29 #include <encoding/payloads/cert_payload.h>
30
31 /**
32 * Length of a CERTREQ payload without the CERTREQ data in bytes.
33 */
34 #define CERTREQ_PAYLOAD_HEADER_LENGTH 5
35
36 /**
37 * Class representing an IKEv2 CERTREQ payload.
38 *
39 * The CERTREQ payload format is described in RFC section 3.7.
40 */
41 struct certreq_payload_t {
42 /**
43 * The payload_t interface.
44 */
45 payload_t payload_interface;
46
47 /**
48 * Create an enumerator over contained keyids.
49 *
50 * @return enumerator over chunk_t's.
51 */
52 enumerator_t* (*create_keyid_enumerator)(certreq_payload_t *this);
53
54 /**
55 * Get the type of contained certificate keyids.
56 *
57 * @return certificate keyid type
58 */
59 certificate_type_t (*get_cert_type)(certreq_payload_t *this);
60
61 /**
62 * Add a certificates keyid to the payload.
63 *
64 * @param keyid keyid of the trusted certifcate
65 * @return
66 */
67 void (*add_keyid)(certreq_payload_t *this, chunk_t keyid);
68
69 /**
70 * Destroys an certreq_payload_t object.
71 */
72 void (*destroy) (certreq_payload_t *this);
73 };
74
75 /**
76 * Creates an empty certreq_payload_t object.
77 *
78 * @return certreq payload
79 */
80 certreq_payload_t *certreq_payload_create(void);
81
82 /**
83 * Creates an empty certreq_payload_t for a kind of certificates.
84 *
85 * @param type type of the added keyids
86 * @return certreq payload
87 */
88 certreq_payload_t *certreq_payload_create_type(certificate_type_t type);
89
90 #endif /** CERTREQ_PAYLOAD_H_ @}*/