14f4de3899ba5ecb7ae30db64aa87f421d863d3b
[strongswan.git] / src / libstrongswan / credentials / certificates / certificate.h
1 /*
2 * Copyright (C) 2007-2008 Martin Willi
3 * Hochschule fuer Technik Rapperswil
4 *
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; either version 2 of the License, or (at your
8 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
9 *
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
12 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 * for more details.
14 */
15
16 /**
17 * @defgroup certificate certificate
18 * @{ @ingroup certificates
19 */
20
21 #ifndef CERTIFICATE_H_
22 #define CERTIFICATE_H_
23
24 typedef struct certificate_t certificate_t;
25 typedef enum certificate_type_t certificate_type_t;
26 typedef enum cert_validation_t cert_validation_t;
27
28 #include <library.h>
29 #include <utils/identification.h>
30 #include <credentials/keys/public_key.h>
31
32 /**
33 * Kind of a certificate_t
34 */
35 enum certificate_type_t {
36 /** just any certificate */
37 CERT_ANY,
38 /** X.509 certificate */
39 CERT_X509,
40 /** X.509 certificate revocation list */
41 CERT_X509_CRL,
42 /** X.509 online certificate status protocol request */
43 CERT_X509_OCSP_REQUEST,
44 /** X.509 online certificate status protocol response */
45 CERT_X509_OCSP_RESPONSE,
46 /** X.509 attribute certificate */
47 CERT_X509_AC,
48 /** trusted, preinstalled public key */
49 CERT_TRUSTED_PUBKEY,
50 /** PGP certificate */
51 CERT_PGP,
52 };
53
54 /**
55 * Enum names for certificate_type_t
56 */
57 extern enum_name_t *certificate_type_names;
58
59 /**
60 * Result of a certificate validation.
61 */
62 enum cert_validation_t {
63 /** certificate has been validated successfully */
64 VALIDATION_GOOD,
65 /** certificate has been validated, but check based on stale information */
66 VALIDATION_STALE,
67 /** certificate has been revoked */
68 VALIDATION_REVOKED,
69 /** validation failed due to a processing error */
70 VALIDATION_FAILED,
71 /** validation has been skipped due to missing validation information */
72 VALIDATION_SKIPPED,
73 };
74
75 /**
76 * Enum names for cert_validation_t
77 */
78 extern enum_name_t *cert_validation_names;
79
80 /**
81 * An abstract certificate.
82 *
83 * A certificate designs a subject-issuer relationship. It may have an
84 * associated public key.
85 */
86 struct certificate_t {
87
88 /**
89 * Get the type of the certificate.
90 *
91 * @return certifcate type
92 */
93 certificate_type_t (*get_type)(certificate_t *this);
94
95 /**
96 * Get the primary subject to which this certificate belongs.
97 *
98 * @return subject identity
99 */
100 identification_t* (*get_subject)(certificate_t *this);
101
102 /**
103 * Check if certificate contains a subject ID.
104 *
105 * A certificate may contain additional subject identifiers, which are
106 * not returned by get_subject (e.g. subjectAltNames)
107 *
108 * @param subject subject identity
109 * @return matching value of best match
110 */
111 id_match_t (*has_subject)(certificate_t *this, identification_t *subject);
112
113 /**
114 * Get the issuer which signed this certificate.
115 *
116 * @return issuer identity
117 */
118 identification_t* (*get_issuer)(certificate_t *this);
119
120 /**
121 * Check if certificate contains an issuer ID.
122 *
123 * A certificate may contain additional issuer identifiers, which are
124 * not returned by get_issuer (e.g. issuerAltNames)
125 *
126 * @param subject isser identity
127 * @return matching value of best match
128 */
129 id_match_t (*has_issuer)(certificate_t *this, identification_t *issuer);
130
131 /**
132 * Check if this certificate is issued and signed by a specific issuer.
133 *
134 * @param issuer issuer's certificate
135 * @return TRUE if certificate issued by issuer and trusted
136 */
137 bool (*issued_by)(certificate_t *this, certificate_t *issuer);
138
139 /**
140 * Get the public key associated to this certificate.
141 *
142 * @return newly referenced public_key, NULL if none available
143 */
144 public_key_t* (*get_public_key)(certificate_t *this);
145
146 /**
147 * Check the lifetime of the certificate.
148 *
149 * @param when check validity at a certain time (NULL for now)
150 * @param not_before receives certificates start of lifetime
151 * @param not_after receives certificates end of lifetime
152 * @return TRUE if when between not_after and not_before
153 */
154 bool (*get_validity)(certificate_t *this, time_t *when,
155 time_t *not_before, time_t *not_after);
156
157 /**
158 * Is this newer than that?
159 *
160 * @return TRUE if newer, FALSE otherwise
161 */
162 bool (*is_newer)(certificate_t *this, certificate_t *that);
163
164 /**
165 * Get the certificate in an encoded form.
166 *
167 * @return allocated chunk of encoded cert
168 */
169 chunk_t (*get_encoding)(certificate_t *this);
170
171 /**
172 * Check if two certificates are equal.
173 *
174 * @param other certificate to compair against this
175 * @return TRUE if certificates are equal
176 */
177 bool (*equals)(certificate_t *this, certificate_t *other);
178
179 /**
180 * Get a new reference to the certificate.
181 *
182 * @return this, with an increased refcount
183 */
184 certificate_t* (*get_ref)(certificate_t *this);
185
186 /**
187 * Destroy a certificate.
188 */
189 void (*destroy)(certificate_t *this);
190 };
191
192 #endif /* CERTIFICATE_H_ @}*/