1 /* GIO - GLib Input, Output and Certificateing Library
3 * Copyright (C) 2010 Red Hat, Inc.
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General
16 * Public License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
18 * Boston, MA 02111-1307, USA.
23 #include "gtlscertificate.h"
26 #include "ginitable.h"
27 #include "gtlsbackend.h"
28 #include "gtlsconnection.h"
32 * SECTION:gtlscertificate
33 * @title: GTlsCertificate
34 * @short_description: TLS certificate
35 * @see_also: #GTlsConnection
37 * A certificate used for TLS authentication and encryption.
38 * This can represent either a public key only (eg, the certificate
39 * received by a client from a server), or the combination of
40 * a public key and a private key (which is needed when acting as a
41 * #GTlsServerConnection).
49 * Abstract base class for TLS certificate types.
54 G_DEFINE_ABSTRACT_TYPE (GTlsCertificate
, g_tls_certificate
, G_TYPE_OBJECT
);
68 g_tls_certificate_init (GTlsCertificate
*cert
)
73 g_tls_certificate_get_property (GObject
*object
,
78 G_OBJECT_WARN_INVALID_PROPERTY_ID (object
, prop_id
, pspec
);
82 g_tls_certificate_set_property (GObject
*object
,
87 G_OBJECT_WARN_INVALID_PROPERTY_ID (object
, prop_id
, pspec
);
91 g_tls_certificate_class_init (GTlsCertificateClass
*class)
93 GObjectClass
*gobject_class
= G_OBJECT_CLASS (class);
95 gobject_class
->set_property
= g_tls_certificate_set_property
;
96 gobject_class
->get_property
= g_tls_certificate_get_property
;
99 * GTlsCertificate:certificate:
101 * The DER (binary) encoded representation of the certificate's
102 * public key. This property and the
103 * #GTlsCertificate:certificate-pem property represent the same
104 * data, just in different forms.
108 g_object_class_install_property (gobject_class
, PROP_CERTIFICATE
,
109 g_param_spec_boxed ("certificate",
111 P_("The DER representation of the certificate"),
114 G_PARAM_CONSTRUCT_ONLY
|
115 G_PARAM_STATIC_STRINGS
));
117 * GTlsCertificate:certificate-pem:
119 * The PEM (ASCII) encoded representation of the certificate's
120 * public key. This property and the #GTlsCertificate:certificate
121 * property represent the same data, just in different forms.
125 g_object_class_install_property (gobject_class
, PROP_CERTIFICATE_PEM
,
126 g_param_spec_string ("certificate-pem",
127 P_("Certificate (PEM)"),
128 P_("The PEM representation of the certificate"),
131 G_PARAM_CONSTRUCT_ONLY
|
132 G_PARAM_STATIC_STRINGS
));
134 * GTlsCertificate:private-key:
136 * The DER (binary) encoded representation of the certificate's
137 * private key. This property (or the
138 * #GTlsCertificate:private-key-pem property) can be set when
139 * constructing a key (eg, from a file), but cannot be read.
143 g_object_class_install_property (gobject_class
, PROP_PRIVATE_KEY
,
144 g_param_spec_boxed ("private-key",
146 P_("The DER representation of the certificate's private key"),
149 G_PARAM_CONSTRUCT_ONLY
|
150 G_PARAM_STATIC_STRINGS
));
152 * GTlsCertificate:private-key-pem:
154 * The PEM (ASCII) encoded representation of the certificate's
155 * private key. This property (or the #GTlsCertificate:private-key
156 * property) can be set when constructing a key (eg, from a file),
157 * but cannot be read.
161 g_object_class_install_property (gobject_class
, PROP_PRIVATE_KEY_PEM
,
162 g_param_spec_string ("private-key-pem",
163 P_("Private key (PEM)"),
164 P_("The PEM representation of the certificate's private key"),
167 G_PARAM_CONSTRUCT_ONLY
|
168 G_PARAM_STATIC_STRINGS
));
170 * GTlsCertificate:issuer:
172 * A #GTlsCertificate representing the entity that issued this
173 * certificate. If %NULL, this means that the certificate is either
174 * self-signed, or else the certificate of the issuer is not
179 g_object_class_install_property (gobject_class
, PROP_ISSUER
,
180 g_param_spec_object ("issuer",
182 P_("The certificate for the issuing entity"),
183 G_TYPE_TLS_CERTIFICATE
,
185 G_PARAM_CONSTRUCT_ONLY
|
186 G_PARAM_STATIC_STRINGS
));
189 static GTlsCertificate
*
190 g_tls_certificate_new_internal (const gchar
*certificate_pem
,
191 const gchar
*private_key_pem
,
195 GTlsBackend
*backend
;
197 backend
= g_tls_backend_get_default ();
199 cert
= g_initable_new (g_tls_backend_get_certificate_type (backend
),
201 "certificate-pem", certificate_pem
,
202 "private-key-pem", private_key_pem
,
204 return G_TLS_CERTIFICATE (cert
);
207 #define PEM_CERTIFICATE_HEADER "-----BEGIN CERTIFICATE-----"
208 #define PEM_CERTIFICATE_FOOTER "-----END CERTIFICATE-----"
209 #define PEM_PRIVKEY_HEADER "-----BEGIN RSA PRIVATE KEY-----"
210 #define PEM_PRIVKEY_FOOTER "-----END RSA PRIVATE KEY-----"
212 static GTlsCertificate
*
213 parse_next_pem_certificate (const gchar
**data
,
214 const gchar
*data_end
,
218 const gchar
*start
, *end
, *next
;
219 gchar
*cert_pem
, *privkey_pem
= NULL
;
220 GTlsCertificate
*cert
;
222 start
= g_strstr_len (*data
, data_end
- *data
, PEM_CERTIFICATE_HEADER
);
227 g_set_error_literal (error
, G_TLS_ERROR
, G_TLS_ERROR_BAD_CERTIFICATE
,
228 _("No PEM-encoded certificate found"));
233 end
= g_strstr_len (start
, data_end
- start
, PEM_CERTIFICATE_FOOTER
);
236 g_set_error_literal (error
, G_TLS_ERROR
, G_TLS_ERROR_BAD_CERTIFICATE
,
237 _("Could not parse PEM-encoded certificate"));
240 end
+= strlen (PEM_CERTIFICATE_FOOTER
);
241 while (*end
== '\r' || *end
== '\n')
244 cert_pem
= g_strndup (start
, end
- start
);
248 next
= g_strstr_len (*data
, data_end
- *data
, PEM_CERTIFICATE_HEADER
);
249 start
= g_strstr_len (*data
, data_end
- *data
, PEM_PRIVKEY_HEADER
);
251 end
= g_strstr_len (start
, data_end
- start
, PEM_PRIVKEY_FOOTER
);
253 if (start
&& (!next
|| start
< next
))
255 if (!end
|| (next
&& end
> next
))
257 g_set_error_literal (error
, G_TLS_ERROR
, G_TLS_ERROR_BAD_CERTIFICATE
,
258 _("Could not parse PEM-encoded private key"));
262 end
+= strlen (PEM_PRIVKEY_FOOTER
);
263 while (*end
== '\r' || *end
== '\n')
266 privkey_pem
= g_strndup (start
, end
- start
);
268 *data
= end
+ strlen (PEM_PRIVKEY_FOOTER
);
271 cert
= g_tls_certificate_new_internal (cert_pem
, privkey_pem
, error
);
273 g_free (privkey_pem
);
279 * g_tls_certificate_new_from_pem:
280 * @data: PEM-encoded certificate data
281 * @length: the length of @data, or -1 if it's 0-terminated.
282 * @error: #GError for error reporting, or %NULL to ignore.
284 * Creates a new #GTlsCertificate from the PEM-encoded data in @data.
285 * If @data includes both a certificate and a private key, then the
286 * returned certificate will include the private key data as well.
288 * If @data includes multiple certificates, only the first one will be
291 * Return value: the new certificate, or %NULL if @data is invalid
296 g_tls_certificate_new_from_pem (const gchar
*data
,
300 const gchar
*data_end
;
302 g_return_val_if_fail (data
!= NULL
, NULL
);
305 data_end
= data
+ strlen (data
);
307 data_end
= data
+ length
;
308 return parse_next_pem_certificate (&data
, data_end
, TRUE
, error
);
312 * g_tls_certificate_new_from_file:
313 * @file: file containing a PEM-encoded certificate to import
314 * @error: #GError for error reporting, or %NULL to ignore.
316 * Creates a #GTlsCertificate from the PEM-encoded data in @file. If
317 * @file cannot be read or parsed, the function will return %NULL and
318 * set @error. Otherwise, this behaves like g_tls_certificate_new().
320 * Return value: the new certificate, or %NULL on error
325 g_tls_certificate_new_from_file (const gchar
*file
,
328 GTlsCertificate
*cert
;
332 if (!g_file_get_contents (file
, &contents
, &length
, error
))
335 cert
= g_tls_certificate_new_from_pem (contents
, length
, error
);
341 * g_tls_certificate_new_from_files:
342 * @cert_file: file containing a PEM-encoded certificate to import
343 * @key_file: file containing a PEM-encoded private key to import
344 * @error: #GError for error reporting, or %NULL to ignore.
346 * Creates a #GTlsCertificate from the PEM-encoded data in @cert_file
347 * and @key_file. If either file cannot be read or parsed, the
348 * function will return %NULL and set @error. Otherwise, this behaves
349 * like g_tls_certificate_new().
351 * Return value: the new certificate, or %NULL on error
356 g_tls_certificate_new_from_files (const gchar
*cert_file
,
357 const gchar
*key_file
,
360 GTlsCertificate
*cert
;
361 gchar
*cert_data
, *key_data
;
363 if (!g_file_get_contents (cert_file
, &cert_data
, NULL
, error
))
365 if (!g_file_get_contents (key_file
, &key_data
, NULL
, error
))
371 cert
= g_tls_certificate_new_internal (cert_data
, key_data
, error
);
378 * g_tls_certificate_list_new_from_file:
379 * @file: file containing PEM-encoded certificates to import
380 * @error: #GError for error reporting, or %NULL to ignore.
382 * Creates one or more #GTlsCertificate<!-- -->s from the PEM-encoded
383 * data in @file. If @file cannot be read or parsed, the function will
384 * return %NULL and set @error. If @file does not contain any
385 * PEM-encoded certificates, this will return an empty list and not
388 * Return value: (element-type Gio.TlsCertificate) (transfer full): a
389 * #GList containing #GTlsCertificate objects. You must free the list
390 * and its contents when you are done with it.
395 g_tls_certificate_list_new_from_file (const gchar
*file
,
398 GTlsCertificate
*cert
;
400 gchar
*contents
, *end
;
404 if (!g_file_get_contents (file
, &contents
, &length
, error
))
408 end
= contents
+ length
;
412 cert
= parse_next_pem_certificate (&p
, end
, FALSE
, error
);
415 for (l
= list
; l
; l
= l
->next
)
416 g_object_unref (l
->data
);
421 list
= g_list_prepend (list
, cert
);
425 return g_list_reverse (list
);
430 * g_tls_certificate_get_issuer:
431 * @cert: a #GTlsCertificate
433 * Gets the #GTlsCertificate representing @cert's issuer, if known
435 * Return value: (transfer none): The certificate of @cert's issuer,
436 * or %NULL if @cert is self-signed or signed with an unknown
442 g_tls_certificate_get_issuer (GTlsCertificate
*cert
)
444 GTlsCertificate
*issuer
;
446 g_object_get (G_OBJECT (cert
), "issuer", &issuer
, NULL
);
448 g_object_unref (issuer
);
454 * g_tls_certificate_verify:
455 * @cert: a #GTlsCertificate
456 * @identity: (allow-none): the expected peer identity
457 * @trusted_ca: (allow-none): the certificate of a trusted authority
459 * This verifies @cert and returns a set of #GTlsCertificateFlags
460 * indicating any problems found with it. This can be used to verify a
461 * certificate outside the context of making a connection, or to
462 * check a certificate against a CA that is not part of the system
465 * If @identity is not %NULL, @cert's name(s) will be compared against
466 * it, and %G_TLS_CERTIFICATE_BAD_IDENTITY will be set in the return
467 * value if it does not match. If @identity is %NULL, that bit will
468 * never be set in the return value.
470 * If @trusted_ca is not %NULL, then @cert (or one of the certificates
471 * in its chain) must be signed by it, or else
472 * %G_TLS_CERTIFICATE_UNKNOWN_CA will be set in the return value. If
473 * @trusted_ca is %NULL, that bit will never be set in the return
476 * (All other #GTlsCertificateFlags values will always be set or unset
479 * Return value: the appropriate #GTlsCertificateFlags
484 g_tls_certificate_verify (GTlsCertificate
*cert
,
485 GSocketConnectable
*identity
,
486 GTlsCertificate
*trusted_ca
)
488 return G_TLS_CERTIFICATE_GET_CLASS (cert
)->verify (cert
, identity
, trusted_ca
);