summaryrefslogtreecommitdiff
path: root/src/charon/encoding/payloads/certreq_payload.h
blob: 2985fdae144f17746010cb37f5030f502e49d21c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
/**
 * @file certreq_payload.h
 * 
 * @brief Interface of certreq_payload_t.
 * 
 */

/*
 * Copyright (C) 2005-2006 Martin Willi
 * Copyright (C) 2005 Jan Hutter
 * Hochschule fuer Technik Rapperswil
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2 of the License, or (at your
 * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * for more details.
 */

#ifndef CERTREQ_PAYLOAD_H_
#define CERTREQ_PAYLOAD_H_

typedef struct certreq_payload_t certreq_payload_t;

#include <library.h>
#include <encoding/payloads/payload.h>
#include <encoding/payloads/cert_payload.h>

/**
 * Length of a CERTREQ payload without the CERTREQ data in bytes.
 * 
 * @ingroup payloads
 */
#define CERTREQ_PAYLOAD_HEADER_LENGTH 5


/**
 * @brief Class representing an IKEv2 CERTREQ payload.
 *
 * The CERTREQ payload format is described in RFC section 3.7.
 * This is just a dummy implementation to fullfill the standards
 * requirements. A full implementation would offer setters/getters
 * for the different encoding types.
 *
 * @b Constructors:
 * - certreq_payload_create()
 *
 * @todo Implement payload functionality.
 *
 * @ingroup payloads
 */
struct certreq_payload_t {
	/**
	 * The payload_t interface.
	 */
	payload_t payload_interface;

	/**
	 * @brief Set the CERT encoding.
	 *
	 * @param this 			calling certreq_payload_t object
	 * @param encoding		CERT encoding
	 */
	void (*set_cert_encoding) (certreq_payload_t *this, cert_encoding_t encoding);
	
	/**
	 * @brief Get the CERT encoding.
	 *
	 * @param this 			calling certreq_payload_t object
	 * @return				Encoding of the CERT 
	 */
	cert_encoding_t (*get_cert_encoding) (certreq_payload_t *this);
	
	/**
	 * @brief Set the CERTREQ data.
	 * 
	 * Data are getting cloned.
	 *
	 * @param this 			calling certreq_payload_t object
	 * @param data			CERTREQ data as chunk_t
	 */
	void (*set_data) (certreq_payload_t *this, chunk_t data);
	
	/**
	 * @brief Get the CERTREQ data.
	 * 
	 * Returned data are a copy of the internal one.
	 *
	 * @param this 			calling certreq_payload_t object
	 * @return				CERTREQ data as chunk_t
	 */
	chunk_t (*get_data_clone) (certreq_payload_t *this);
	
	/**
	 * @brief Get the CERTREQ data.
	 * 
	 * Returned data are NOT copied.
	 *
	 * @param this 			calling certreq_payload_t object
	 * @return				CERTREQ data as chunk_t
	 */
	chunk_t (*get_data) (certreq_payload_t *this);
	
	/**
	 * @brief Destroys an certreq_payload_t object.
	 *
	 * @param this 	certreq_payload_t object to destroy
	 */
	void (*destroy) (certreq_payload_t *this);
};

/**
 * @brief Creates an empty certreq_payload_t object.
 * 
 * @return certreq_payload_t object
 * 
 * @ingroup payloads
 */
certreq_payload_t *certreq_payload_create(void);

/**
 * @brief Creates a certreq_payload_t object from a ca certificate
 * 
 * @param id				subject distinguished name of CA certificate
 * @return					certreq_payload_t object
 * 
 * @ingroup payloads
 */
certreq_payload_t *certreq_payload_create_from_cacert(identification_t *id);

/**
 * @brief Creates a certreq_payload_t object from all ca certificates
 * 
 * @return					certreq_payload_t object
 * 
 * @ingroup payloads
 */
certreq_payload_t *certreq_payload_create_from_cacerts(void);

#endif /* CERTREQ_PAYLOAD_H_ */