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, see <http://www.gnu.org/licenses/>.
21 #include "gtlscertificate.h"
24 #include "ginitable.h"
25 #include "gtlsbackend.h"
26 #include "gtlsconnection.h"
30 * SECTION:gtlscertificate
31 * @title: GTlsCertificate
32 * @short_description: TLS certificate
34 * @see_also: #GTlsConnection
36 * A certificate used for TLS authentication and encryption.
37 * This can represent either a certificate only (eg, the certificate
38 * received by a client from a server), or the combination of
39 * a certificate and a private key (which is needed when acting as a
40 * #GTlsServerConnection).
48 * Abstract base class for TLS certificate types.
53 G_DEFINE_ABSTRACT_TYPE (GTlsCertificate, g_tls_certificate, G_TYPE_OBJECT);
67 g_tls_certificate_init (GTlsCertificate *cert)
72 g_tls_certificate_get_property (GObject *object,
77 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
81 g_tls_certificate_set_property (GObject *object,
86 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
90 g_tls_certificate_class_init (GTlsCertificateClass *class)
92 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
94 gobject_class->set_property = g_tls_certificate_set_property;
95 gobject_class->get_property = g_tls_certificate_get_property;
98 * GTlsCertificate:certificate:
100 * The DER (binary) encoded representation of the certificate.
101 * This property and the #GTlsCertificate:certificate-pem property
102 * represent the same data, just in different forms.
106 g_object_class_install_property (gobject_class, PROP_CERTIFICATE,
107 g_param_spec_boxed ("certificate",
109 P_("The DER representation of the certificate"),
112 G_PARAM_CONSTRUCT_ONLY |
113 G_PARAM_STATIC_STRINGS));
115 * GTlsCertificate:certificate-pem:
117 * The PEM (ASCII) encoded representation of the certificate.
118 * This property and the #GTlsCertificate:certificate
119 * property represent the same data, just in different forms.
123 g_object_class_install_property (gobject_class, PROP_CERTIFICATE_PEM,
124 g_param_spec_string ("certificate-pem",
125 P_("Certificate (PEM)"),
126 P_("The PEM representation of the certificate"),
129 G_PARAM_CONSTRUCT_ONLY |
130 G_PARAM_STATIC_STRINGS));
132 * GTlsCertificate:private-key:
134 * The DER (binary) encoded representation of the certificate's
135 * private key, in either PKCS#1 format or unencrypted PKCS#8
136 * format. This property (or the #GTlsCertificate:private-key-pem
137 * property) can be set when constructing a key (eg, from a file),
138 * but cannot be read.
140 * PKCS#8 format is supported since 2.32; earlier releases only
141 * support PKCS#1. You can use the `openssl rsa`
142 * tool to convert PKCS#8 keys to PKCS#1.
146 g_object_class_install_property (gobject_class, PROP_PRIVATE_KEY,
147 g_param_spec_boxed ("private-key",
149 P_("The DER representation of the certificate's private key"),
152 G_PARAM_CONSTRUCT_ONLY |
153 G_PARAM_STATIC_STRINGS));
155 * GTlsCertificate:private-key-pem:
157 * The PEM (ASCII) encoded representation of the certificate's
158 * private key in either PKCS#1 format ("`BEGIN RSA PRIVATE
159 * KEY`") or unencrypted PKCS#8 format ("`BEGIN
160 * PRIVATE KEY`"). This property (or the
161 * #GTlsCertificate:private-key property) can be set when
162 * constructing a key (eg, from a file), but cannot be read.
164 * PKCS#8 format is supported since 2.32; earlier releases only
165 * support PKCS#1. You can use the `openssl rsa`
166 * tool to convert PKCS#8 keys to PKCS#1.
170 g_object_class_install_property (gobject_class, PROP_PRIVATE_KEY_PEM,
171 g_param_spec_string ("private-key-pem",
172 P_("Private key (PEM)"),
173 P_("The PEM representation of the certificate's private key"),
176 G_PARAM_CONSTRUCT_ONLY |
177 G_PARAM_STATIC_STRINGS));
179 * GTlsCertificate:issuer:
181 * A #GTlsCertificate representing the entity that issued this
182 * certificate. If %NULL, this means that the certificate is either
183 * self-signed, or else the certificate of the issuer is not
188 g_object_class_install_property (gobject_class, PROP_ISSUER,
189 g_param_spec_object ("issuer",
191 P_("The certificate for the issuing entity"),
192 G_TYPE_TLS_CERTIFICATE,
194 G_PARAM_CONSTRUCT_ONLY |
195 G_PARAM_STATIC_STRINGS));
198 static GTlsCertificate *
199 g_tls_certificate_new_internal (const gchar *certificate_pem,
200 const gchar *private_key_pem,
204 GTlsBackend *backend;
206 backend = g_tls_backend_get_default ();
208 cert = g_initable_new (g_tls_backend_get_certificate_type (backend),
210 "certificate-pem", certificate_pem,
211 "private-key-pem", private_key_pem,
213 return G_TLS_CERTIFICATE (cert);
216 #define PEM_CERTIFICATE_HEADER "-----BEGIN CERTIFICATE-----"
217 #define PEM_CERTIFICATE_FOOTER "-----END CERTIFICATE-----"
218 #define PEM_PKCS1_PRIVKEY_HEADER "-----BEGIN RSA PRIVATE KEY-----"
219 #define PEM_PKCS1_PRIVKEY_FOOTER "-----END RSA PRIVATE KEY-----"
220 #define PEM_PKCS8_PRIVKEY_HEADER "-----BEGIN PRIVATE KEY-----"
221 #define PEM_PKCS8_PRIVKEY_FOOTER "-----END PRIVATE KEY-----"
222 #define PEM_PKCS8_ENCRYPTED_HEADER "-----BEGIN ENCRYPTED PRIVATE KEY-----"
223 #define PEM_PKCS8_ENCRYPTED_FOOTER "-----END ENCRYPTED PRIVATE KEY-----"
226 parse_private_key (const gchar *data,
231 const gchar *start, *end, *footer;
233 start = g_strstr_len (data, data_len, PEM_PKCS1_PRIVKEY_HEADER);
235 footer = PEM_PKCS1_PRIVKEY_FOOTER;
238 start = g_strstr_len (data, data_len, PEM_PKCS8_PRIVKEY_HEADER);
240 footer = PEM_PKCS8_PRIVKEY_FOOTER;
243 start = g_strstr_len (data, data_len, PEM_PKCS8_ENCRYPTED_HEADER);
246 g_set_error_literal (error, G_TLS_ERROR, G_TLS_ERROR_BAD_CERTIFICATE,
247 _("Cannot decrypt PEM-encoded private key"));
251 g_set_error_literal (error, G_TLS_ERROR, G_TLS_ERROR_BAD_CERTIFICATE,
252 _("No PEM-encoded private key found"));
258 end = g_strstr_len (start, data_len - (data - start), footer);
261 g_set_error_literal (error, G_TLS_ERROR, G_TLS_ERROR_BAD_CERTIFICATE,
262 _("Could not parse PEM-encoded private key"));
265 end += strlen (footer);
266 while (*end == '\r' || *end == '\n')
269 return g_strndup (start, end - start);
274 parse_next_pem_certificate (const gchar **data,
275 const gchar *data_end,
279 const gchar *start, *end;
281 start = g_strstr_len (*data, data_end - *data, PEM_CERTIFICATE_HEADER);
286 g_set_error_literal (error, G_TLS_ERROR, G_TLS_ERROR_BAD_CERTIFICATE,
287 _("No PEM-encoded certificate found"));
292 end = g_strstr_len (start, data_end - start, PEM_CERTIFICATE_FOOTER);
295 g_set_error_literal (error, G_TLS_ERROR, G_TLS_ERROR_BAD_CERTIFICATE,
296 _("Could not parse PEM-encoded certificate"));
299 end += strlen (PEM_CERTIFICATE_FOOTER);
300 while (*end == '\r' || *end == '\n')
305 return g_strndup (start, end - start);
309 * g_tls_certificate_new_from_pem:
310 * @data: PEM-encoded certificate data
311 * @length: the length of @data, or -1 if it's 0-terminated.
312 * @error: #GError for error reporting, or %NULL to ignore.
314 * Creates a new #GTlsCertificate from the PEM-encoded data in @data.
315 * If @data includes both a certificate and a private key, then the
316 * returned certificate will include the private key data as well. (See
317 * the #GTlsCertificate:private-key-pem property for information about
318 * supported formats.)
320 * If @data includes multiple certificates, only the first one will be
323 * Returns: the new certificate, or %NULL if @data is invalid
328 g_tls_certificate_new_from_pem (const gchar *data,
332 const gchar *data_end;
333 gchar *key_pem, *cert_pem;
334 GTlsCertificate *cert;
336 g_return_val_if_fail (data != NULL, NULL);
339 length = strlen (data);
341 data_end = data + length;
343 key_pem = parse_private_key (data, length, FALSE, error);
347 cert_pem = parse_next_pem_certificate (&data, data_end, TRUE, error);
354 cert = g_tls_certificate_new_internal (cert_pem, key_pem, error);
362 * g_tls_certificate_new_from_file:
363 * @file: file containing a PEM-encoded certificate to import
364 * @error: #GError for error reporting, or %NULL to ignore.
366 * Creates a #GTlsCertificate from the PEM-encoded data in @file. If
367 * @file cannot be read or parsed, the function will return %NULL and
368 * set @error. Otherwise, this behaves like
369 * g_tls_certificate_new_from_pem().
371 * Returns: the new certificate, or %NULL on error
376 g_tls_certificate_new_from_file (const gchar *file,
379 GTlsCertificate *cert;
383 if (!g_file_get_contents (file, &contents, &length, error))
386 cert = g_tls_certificate_new_from_pem (contents, length, error);
392 * g_tls_certificate_new_from_files:
393 * @cert_file: file containing a PEM-encoded certificate to import
394 * @key_file: file containing a PEM-encoded private key to import
395 * @error: #GError for error reporting, or %NULL to ignore.
397 * Creates a #GTlsCertificate from the PEM-encoded data in @cert_file
398 * and @key_file. If either file cannot be read or parsed, the
399 * function will return %NULL and set @error. Otherwise, this behaves
400 * like g_tls_certificate_new_from_pem().
402 * Returns: the new certificate, or %NULL on error
407 g_tls_certificate_new_from_files (const gchar *cert_file,
408 const gchar *key_file,
411 GTlsCertificate *cert;
412 gchar *cert_data, *key_data;
413 gsize cert_len, key_len;
414 gchar *cert_pem, *key_pem;
417 if (!g_file_get_contents (cert_file, &cert_data, &cert_len, error))
420 cert_pem = parse_next_pem_certificate (&p, p + cert_len, TRUE, error);
425 if (!g_file_get_contents (key_file, &key_data, &key_len, error))
430 key_pem = parse_private_key (key_data, key_len, TRUE, error);
438 cert = g_tls_certificate_new_internal (cert_pem, key_pem, error);
445 * g_tls_certificate_list_new_from_file:
446 * @file: file containing PEM-encoded certificates to import
447 * @error: #GError for error reporting, or %NULL to ignore.
449 * Creates one or more #GTlsCertificates from the PEM-encoded
450 * data in @file. If @file cannot be read or parsed, the function will
451 * return %NULL and set @error. If @file does not contain any
452 * PEM-encoded certificates, this will return an empty list and not
455 * Returns: (element-type Gio.TlsCertificate) (transfer full): a
456 * #GList containing #GTlsCertificate objects. You must free the list
457 * and its contents when you are done with it.
462 g_tls_certificate_list_new_from_file (const gchar *file,
465 GQueue queue = G_QUEUE_INIT;
466 gchar *contents, *end;
470 if (!g_file_get_contents (file, &contents, &length, error))
473 end = contents + length;
478 GTlsCertificate *cert = NULL;
479 GError *parse_error = NULL;
481 cert_pem = parse_next_pem_certificate (&p, end, FALSE, &parse_error);
484 cert = g_tls_certificate_new_internal (cert_pem, NULL, &parse_error);
491 g_propagate_error (error, parse_error);
492 g_list_free_full (queue.head, g_object_unref);
497 g_queue_push_tail (&queue, cert);
506 * g_tls_certificate_get_issuer:
507 * @cert: a #GTlsCertificate
509 * Gets the #GTlsCertificate representing @cert's issuer, if known
511 * Returns: (transfer none): The certificate of @cert's issuer,
512 * or %NULL if @cert is self-signed or signed with an unknown
518 g_tls_certificate_get_issuer (GTlsCertificate *cert)
520 GTlsCertificate *issuer;
522 g_object_get (G_OBJECT (cert), "issuer", &issuer, NULL);
524 g_object_unref (issuer);
530 * g_tls_certificate_verify:
531 * @cert: a #GTlsCertificate
532 * @identity: (allow-none): the expected peer identity
533 * @trusted_ca: (allow-none): the certificate of a trusted authority
535 * This verifies @cert and returns a set of #GTlsCertificateFlags
536 * indicating any problems found with it. This can be used to verify a
537 * certificate outside the context of making a connection, or to
538 * check a certificate against a CA that is not part of the system
541 * If @identity is not %NULL, @cert's name(s) will be compared against
542 * it, and %G_TLS_CERTIFICATE_BAD_IDENTITY will be set in the return
543 * value if it does not match. If @identity is %NULL, that bit will
544 * never be set in the return value.
546 * If @trusted_ca is not %NULL, then @cert (or one of the certificates
547 * in its chain) must be signed by it, or else
548 * %G_TLS_CERTIFICATE_UNKNOWN_CA will be set in the return value. If
549 * @trusted_ca is %NULL, that bit will never be set in the return
552 * (All other #GTlsCertificateFlags values will always be set or unset
555 * Returns: the appropriate #GTlsCertificateFlags
560 g_tls_certificate_verify (GTlsCertificate *cert,
561 GSocketConnectable *identity,
562 GTlsCertificate *trusted_ca)
564 return G_TLS_CERTIFICATE_GET_CLASS (cert)->verify (cert, identity, trusted_ca);
568 * g_tls_certificate_is_same:
569 * @cert_one: first certificate to compare
570 * @cert_two: second certificate to compare
572 * Check if two #GTlsCertificate objects represent the same certificate.
573 * The raw DER byte data of the two certificates are checked for equality.
574 * This has the effect that two certificates may compare equal even if
575 * their #GTlsCertificate:issuer, #GTlsCertificate:private-key, or
576 * #GTlsCertificate:private-key-pem properties differ.
578 * Returns: whether the same or not
583 g_tls_certificate_is_same (GTlsCertificate *cert_one,
584 GTlsCertificate *cert_two)
589 g_return_val_if_fail (G_IS_TLS_CERTIFICATE (cert_one), FALSE);
590 g_return_val_if_fail (G_IS_TLS_CERTIFICATE (cert_two), FALSE);
592 g_object_get (cert_one, "certificate", &b1, NULL);
593 g_object_get (cert_two, "certificate", &b2, NULL);
595 equal = (b1->len == b2->len &&
596 memcmp (b1->data, b2->data, b1->len) == 0);
598 g_byte_array_unref (b1);
599 g_byte_array_unref (b2);