summaryrefslogtreecommitdiff
path: root/src/charon/encoding/payloads/cert_payload.h
blob: bcb961398704c46172d1ebf21c5de15c19ace6c1 (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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
/**
 * @file cert_payload.h
 * 
 * @brief Interface of cert_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 CERT_PAYLOAD_H_
#define CERT_PAYLOAD_H_

typedef enum cert_encoding_t cert_encoding_t;
typedef struct cert_payload_t cert_payload_t;

#include <library.h>
#include <crypto/x509.h>
#include <encoding/payloads/payload.h>

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

/**
 * @brief Certificate encoding, as described in IKEv2 RFC section 3.6
 *
 * @ingroup payloads
 */
enum cert_encoding_t {
	CERT_NONE =						 0,
	CERT_PKCS7_WRAPPED_X509 =		 1,
	CERT_PGP =						 2,
	CERT_DNS_SIGNED_KEY =			 3,
	CERT_X509_SIGNATURE =			 4,
	CERT_KERBEROS_TOKEN	=			 6,
	CERT_CRL =						 7,
	CERT_ARL =						 8,
	CERT_SPKI =						 9,
	CERT_X509_ATTRIBUTE =			10,
	CERT_RAW_RSA_KEY =				11,
	CERT_X509_HASH_AND_URL =		12,
	CERT_X509_HASH_AND_URL_BUNDLE =	13,
	CERT_OCSP_CONTENT =				14,  /* from RFC 4806 */
	CERT_ROOF =						15
};

/**
 * string mappings for cert_encoding_t.
 * 
 * @ingroup payloads
 */
extern enum_name_t *cert_encoding_names;

/**
 * @brief Class representing an IKEv2 CERT payload.
 *
 * The CERT payload format is described in RFC section 3.6.
 * 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:
 * - cert_payload_create()
 *
 * @todo Implement setters/getters for the different certificate encodings.
 *
 * @ingroup payloads
 */
struct cert_payload_t {
	
	/**
	 * The payload_t interface.
	 */
	payload_t payload_interface;

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

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

/**
 * @brief Creates a cert_payload_t object with an X.509 certificate.
 * 
 * @param cert				X.509 certificate
 * @return					cert_payload_t object
 * 
 * @ingroup payloads
 */
cert_payload_t *cert_payload_create_from_x509(x509_t *cert);

#endif /* CERT_PAYLOAD_H_ */