2 * QEMU crypto TLS x509 credential support
4 * Copyright (c) 2015 Red Hat, Inc.
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, see <http://www.gnu.org/licenses/>.
21 #include "crypto/tlscredsx509.h"
22 #include "crypto/tlscredspriv.h"
23 #include "crypto/secret.h"
24 #include "qom/object_interfaces.h"
30 #include <gnutls/x509.h>
34 qcrypto_tls_creds_check_cert_times(gnutls_x509_crt_t cert
,
40 time_t now
= time(NULL
);
42 if (now
== ((time_t)-1)) {
43 error_setg_errno(errp
, errno
, "cannot get current time");
47 if (gnutls_x509_crt_get_expiration_time(cert
) < now
) {
50 "The CA certificate %s has expired" :
52 "The server certificate %s has expired" :
53 "The client certificate %s has expired")),
58 if (gnutls_x509_crt_get_activation_time(cert
) > now
) {
61 "The CA certificate %s is not yet active" :
63 "The server certificate %s is not yet active" :
64 "The client certificate %s is not yet active")),
73 #if LIBGNUTLS_VERSION_NUMBER >= 2
75 * The gnutls_x509_crt_get_basic_constraints function isn't
76 * available in GNUTLS 1.0.x branches. This isn't critical
77 * though, since gnutls_certificate_verify_peers2 will do
78 * pretty much the same check at runtime, so we can just
82 qcrypto_tls_creds_check_cert_basic_constraints(QCryptoTLSCredsX509
*creds
,
83 gnutls_x509_crt_t cert
,
91 status
= gnutls_x509_crt_get_basic_constraints(cert
, NULL
, NULL
, NULL
);
92 trace_qcrypto_tls_creds_x509_check_basic_constraints(
93 creds
, certFile
, status
);
95 if (status
> 0) { /* It is a CA cert */
97 error_setg(errp
, isServer
?
98 "The certificate %s basic constraints show a CA, "
99 "but we need one for a server" :
100 "The certificate %s basic constraints show a CA, "
101 "but we need one for a client",
105 } else if (status
== 0) { /* It is not a CA cert */
108 "The certificate %s basic constraints do not "
113 } else if (status
== GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE
) {
114 /* Missing basicConstraints */
117 "The certificate %s is missing basic constraints "
122 } else { /* General error */
124 "Unable to query certificate %s basic constraints: %s",
125 certFile
, gnutls_strerror(status
));
135 qcrypto_tls_creds_check_cert_key_usage(QCryptoTLSCredsX509
*creds
,
136 gnutls_x509_crt_t cert
,
137 const char *certFile
,
142 unsigned int usage
= 0;
143 unsigned int critical
= 0;
145 status
= gnutls_x509_crt_get_key_usage(cert
, &usage
, &critical
);
146 trace_qcrypto_tls_creds_x509_check_key_usage(
147 creds
, certFile
, status
, usage
, critical
);
150 if (status
== GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE
) {
151 usage
= isCA
? GNUTLS_KEY_KEY_CERT_SIGN
:
152 GNUTLS_KEY_DIGITAL_SIGNATURE
|GNUTLS_KEY_KEY_ENCIPHERMENT
;
155 "Unable to query certificate %s key usage: %s",
156 certFile
, gnutls_strerror(status
));
162 if (!(usage
& GNUTLS_KEY_KEY_CERT_SIGN
)) {
165 "Certificate %s usage does not permit "
166 "certificate signing", certFile
);
171 if (!(usage
& GNUTLS_KEY_DIGITAL_SIGNATURE
)) {
174 "Certificate %s usage does not permit digital "
175 "signature", certFile
);
179 if (!(usage
& GNUTLS_KEY_KEY_ENCIPHERMENT
)) {
182 "Certificate %s usage does not permit key "
183 "encipherment", certFile
);
194 qcrypto_tls_creds_check_cert_key_purpose(QCryptoTLSCredsX509
*creds
,
195 gnutls_x509_crt_t cert
,
196 const char *certFile
,
202 unsigned int purposeCritical
;
203 unsigned int critical
;
206 bool allowClient
= false, allowServer
= false;
211 status
= gnutls_x509_crt_get_key_purpose_oid(cert
, i
, buffer
,
214 if (status
== GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE
) {
216 /* If there is no data at all, then we must allow
217 client/server to pass */
219 allowServer
= allowClient
= true;
223 if (status
!= GNUTLS_E_SHORT_MEMORY_BUFFER
) {
225 "Unable to query certificate %s key purpose: %s",
226 certFile
, gnutls_strerror(status
));
230 buffer
= g_new0(char, size
);
232 status
= gnutls_x509_crt_get_key_purpose_oid(cert
, i
, buffer
,
233 &size
, &purposeCritical
);
236 trace_qcrypto_tls_creds_x509_check_key_purpose(
237 creds
, certFile
, status
, "<none>", purposeCritical
);
240 "Unable to query certificate %s key purpose: %s",
241 certFile
, gnutls_strerror(status
));
244 trace_qcrypto_tls_creds_x509_check_key_purpose(
245 creds
, certFile
, status
, buffer
, purposeCritical
);
246 if (purposeCritical
) {
250 if (g_str_equal(buffer
, GNUTLS_KP_TLS_WWW_SERVER
)) {
252 } else if (g_str_equal(buffer
, GNUTLS_KP_TLS_WWW_CLIENT
)) {
254 } else if (g_str_equal(buffer
, GNUTLS_KP_ANY
)) {
255 allowServer
= allowClient
= true;
266 "Certificate %s purpose does not allow "
267 "use with a TLS server", certFile
);
275 "Certificate %s purpose does not allow use "
276 "with a TLS client", certFile
);
287 qcrypto_tls_creds_check_cert(QCryptoTLSCredsX509
*creds
,
288 gnutls_x509_crt_t cert
,
289 const char *certFile
,
294 if (qcrypto_tls_creds_check_cert_times(cert
, certFile
,
300 #if LIBGNUTLS_VERSION_NUMBER >= 2
301 if (qcrypto_tls_creds_check_cert_basic_constraints(creds
,
309 if (qcrypto_tls_creds_check_cert_key_usage(creds
,
316 qcrypto_tls_creds_check_cert_key_purpose(creds
,
318 isServer
, errp
) < 0) {
327 qcrypto_tls_creds_check_cert_pair(gnutls_x509_crt_t cert
,
328 const char *certFile
,
329 gnutls_x509_crt_t
*cacerts
,
331 const char *cacertFile
,
337 if (gnutls_x509_crt_list_verify(&cert
, 1,
341 error_setg(errp
, isServer
?
342 "Unable to verify server certificate %s against "
343 "CA certificate %s" :
344 "Unable to verify client certificate %s against "
346 certFile
, cacertFile
);
351 const char *reason
= "Invalid certificate";
353 if (status
& GNUTLS_CERT_INVALID
) {
354 reason
= "The certificate is not trusted";
357 if (status
& GNUTLS_CERT_SIGNER_NOT_FOUND
) {
358 reason
= "The certificate hasn't got a known issuer";
361 if (status
& GNUTLS_CERT_REVOKED
) {
362 reason
= "The certificate has been revoked";
365 #ifndef GNUTLS_1_0_COMPAT
366 if (status
& GNUTLS_CERT_INSECURE_ALGORITHM
) {
367 reason
= "The certificate uses an insecure algorithm";
372 "Our own certificate %s failed validation against %s: %s",
373 certFile
, cacertFile
, reason
);
381 static gnutls_x509_crt_t
382 qcrypto_tls_creds_load_cert(QCryptoTLSCredsX509
*creds
,
383 const char *certFile
,
388 gnutls_x509_crt_t cert
= NULL
;
394 trace_qcrypto_tls_creds_x509_load_cert(creds
, isServer
, certFile
);
396 if (gnutls_x509_crt_init(&cert
) < 0) {
397 error_setg(errp
, "Unable to initialize certificate");
401 if (!g_file_get_contents(certFile
, &buf
, &buflen
, &gerr
)) {
402 error_setg(errp
, "Cannot load CA cert list %s: %s",
403 certFile
, gerr
->message
);
408 data
.data
= (unsigned char *)buf
;
409 data
.size
= strlen(buf
);
411 if (gnutls_x509_crt_import(cert
, &data
, GNUTLS_X509_FMT_PEM
) < 0) {
412 error_setg(errp
, isServer
?
413 "Unable to import server certificate %s" :
414 "Unable to import client certificate %s",
423 gnutls_x509_crt_deinit(cert
);
432 qcrypto_tls_creds_load_ca_cert_list(QCryptoTLSCredsX509
*creds
,
433 const char *certFile
,
434 gnutls_x509_crt_t
*certs
,
435 unsigned int certMax
,
446 trace_qcrypto_tls_creds_x509_load_cert_list(creds
, certFile
);
448 if (!g_file_get_contents(certFile
, &buf
, &buflen
, &gerr
)) {
449 error_setg(errp
, "Cannot load CA cert list %s: %s",
450 certFile
, gerr
->message
);
455 data
.data
= (unsigned char *)buf
;
456 data
.size
= strlen(buf
);
458 if (gnutls_x509_crt_list_import(certs
, &certMax
, &data
,
459 GNUTLS_X509_FMT_PEM
, 0) < 0) {
461 "Unable to import CA certificate list %s",
477 qcrypto_tls_creds_x509_sanity_check(QCryptoTLSCredsX509
*creds
,
479 const char *cacertFile
,
480 const char *certFile
,
483 gnutls_x509_crt_t cert
= NULL
;
484 gnutls_x509_crt_t cacerts
[MAX_CERTS
];
489 memset(cacerts
, 0, sizeof(cacerts
));
491 access(certFile
, R_OK
) == 0) {
492 cert
= qcrypto_tls_creds_load_cert(creds
,
499 if (access(cacertFile
, R_OK
) == 0) {
500 if (qcrypto_tls_creds_load_ca_cert_list(creds
,
502 MAX_CERTS
, &ncacerts
,
509 qcrypto_tls_creds_check_cert(creds
,
510 cert
, certFile
, isServer
,
515 for (i
= 0; i
< ncacerts
; i
++) {
516 if (qcrypto_tls_creds_check_cert(creds
,
517 cacerts
[i
], cacertFile
,
518 isServer
, true, errp
) < 0) {
523 if (cert
&& ncacerts
&&
524 qcrypto_tls_creds_check_cert_pair(cert
, certFile
, cacerts
,
525 ncacerts
, cacertFile
,
526 isServer
, errp
) < 0) {
534 gnutls_x509_crt_deinit(cert
);
536 for (i
= 0; i
< ncacerts
; i
++) {
537 gnutls_x509_crt_deinit(cacerts
[i
]);
544 qcrypto_tls_creds_x509_load(QCryptoTLSCredsX509
*creds
,
547 char *cacert
= NULL
, *cacrl
= NULL
, *cert
= NULL
,
548 *key
= NULL
, *dhparams
= NULL
;
552 trace_qcrypto_tls_creds_x509_load(creds
,
553 creds
->parent_obj
.dir
? creds
->parent_obj
.dir
: "<nodir>");
555 if (creds
->parent_obj
.endpoint
== QCRYPTO_TLS_CREDS_ENDPOINT_SERVER
) {
556 if (qcrypto_tls_creds_get_path(&creds
->parent_obj
,
557 QCRYPTO_TLS_CREDS_X509_CA_CERT
,
558 true, &cacert
, errp
) < 0 ||
559 qcrypto_tls_creds_get_path(&creds
->parent_obj
,
560 QCRYPTO_TLS_CREDS_X509_CA_CRL
,
561 false, &cacrl
, errp
) < 0 ||
562 qcrypto_tls_creds_get_path(&creds
->parent_obj
,
563 QCRYPTO_TLS_CREDS_X509_SERVER_CERT
,
564 true, &cert
, errp
) < 0 ||
565 qcrypto_tls_creds_get_path(&creds
->parent_obj
,
566 QCRYPTO_TLS_CREDS_X509_SERVER_KEY
,
567 true, &key
, errp
) < 0 ||
568 qcrypto_tls_creds_get_path(&creds
->parent_obj
,
569 QCRYPTO_TLS_CREDS_DH_PARAMS
,
570 false, &dhparams
, errp
) < 0) {
574 if (qcrypto_tls_creds_get_path(&creds
->parent_obj
,
575 QCRYPTO_TLS_CREDS_X509_CA_CERT
,
576 true, &cacert
, errp
) < 0 ||
577 qcrypto_tls_creds_get_path(&creds
->parent_obj
,
578 QCRYPTO_TLS_CREDS_X509_CLIENT_CERT
,
579 false, &cert
, errp
) < 0 ||
580 qcrypto_tls_creds_get_path(&creds
->parent_obj
,
581 QCRYPTO_TLS_CREDS_X509_CLIENT_KEY
,
582 false, &key
, errp
) < 0) {
587 if (creds
->sanityCheck
&&
588 qcrypto_tls_creds_x509_sanity_check(creds
,
589 creds
->parent_obj
.endpoint
== QCRYPTO_TLS_CREDS_ENDPOINT_SERVER
,
590 cacert
, cert
, errp
) < 0) {
594 ret
= gnutls_certificate_allocate_credentials(&creds
->data
);
596 error_setg(errp
, "Cannot allocate credentials: '%s'",
597 gnutls_strerror(ret
));
601 ret
= gnutls_certificate_set_x509_trust_file(creds
->data
,
603 GNUTLS_X509_FMT_PEM
);
605 error_setg(errp
, "Cannot load CA certificate '%s': %s",
606 cacert
, gnutls_strerror(ret
));
610 if (cert
!= NULL
&& key
!= NULL
) {
611 #if GNUTLS_VERSION_NUMBER >= 0x030111
612 char *password
= NULL
;
613 if (creds
->passwordid
) {
614 password
= qcrypto_secret_lookup_as_utf8(creds
->passwordid
,
620 ret
= gnutls_certificate_set_x509_key_file2(creds
->data
,
626 #else /* GNUTLS_VERSION_NUMBER < 0x030111 */
627 if (creds
->passwordid
) {
628 error_setg(errp
, "PKCS8 decryption requires GNUTLS >= 3.1.11");
631 ret
= gnutls_certificate_set_x509_key_file(creds
->data
,
633 GNUTLS_X509_FMT_PEM
);
634 #endif /* GNUTLS_VERSION_NUMBER < 0x030111 */
636 error_setg(errp
, "Cannot load certificate '%s' & key '%s': %s",
637 cert
, key
, gnutls_strerror(ret
));
643 ret
= gnutls_certificate_set_x509_crl_file(creds
->data
,
645 GNUTLS_X509_FMT_PEM
);
647 error_setg(errp
, "Cannot load CRL '%s': %s",
648 cacrl
, gnutls_strerror(ret
));
653 if (creds
->parent_obj
.endpoint
== QCRYPTO_TLS_CREDS_ENDPOINT_SERVER
) {
654 if (qcrypto_tls_creds_get_dh_params_file(&creds
->parent_obj
, dhparams
,
655 &creds
->parent_obj
.dh_params
,
659 gnutls_certificate_set_dh_params(creds
->data
,
660 creds
->parent_obj
.dh_params
);
675 qcrypto_tls_creds_x509_unload(QCryptoTLSCredsX509
*creds
)
678 gnutls_certificate_free_credentials(creds
->data
);
681 if (creds
->parent_obj
.dh_params
) {
682 gnutls_dh_params_deinit(creds
->parent_obj
.dh_params
);
683 creds
->parent_obj
.dh_params
= NULL
;
688 #else /* ! CONFIG_GNUTLS */
692 qcrypto_tls_creds_x509_load(QCryptoTLSCredsX509
*creds G_GNUC_UNUSED
,
695 error_setg(errp
, "TLS credentials support requires GNUTLS");
700 qcrypto_tls_creds_x509_unload(QCryptoTLSCredsX509
*creds G_GNUC_UNUSED
)
706 #endif /* ! CONFIG_GNUTLS */
710 qcrypto_tls_creds_x509_prop_set_loaded(Object
*obj
,
714 QCryptoTLSCredsX509
*creds
= QCRYPTO_TLS_CREDS_X509(obj
);
717 qcrypto_tls_creds_x509_load(creds
, errp
);
719 qcrypto_tls_creds_x509_unload(creds
);
728 qcrypto_tls_creds_x509_prop_get_loaded(Object
*obj
,
729 Error
**errp G_GNUC_UNUSED
)
731 QCryptoTLSCredsX509
*creds
= QCRYPTO_TLS_CREDS_X509(obj
);
733 return creds
->data
!= NULL
;
737 #else /* ! CONFIG_GNUTLS */
741 qcrypto_tls_creds_x509_prop_get_loaded(Object
*obj G_GNUC_UNUSED
,
742 Error
**errp G_GNUC_UNUSED
)
748 #endif /* ! CONFIG_GNUTLS */
752 qcrypto_tls_creds_x509_prop_set_sanity(Object
*obj
,
754 Error
**errp G_GNUC_UNUSED
)
756 QCryptoTLSCredsX509
*creds
= QCRYPTO_TLS_CREDS_X509(obj
);
758 creds
->sanityCheck
= value
;
763 qcrypto_tls_creds_x509_prop_set_passwordid(Object
*obj
,
765 Error
**errp G_GNUC_UNUSED
)
767 QCryptoTLSCredsX509
*creds
= QCRYPTO_TLS_CREDS_X509(obj
);
769 creds
->passwordid
= g_strdup(value
);
774 qcrypto_tls_creds_x509_prop_get_passwordid(Object
*obj
,
775 Error
**errp G_GNUC_UNUSED
)
777 QCryptoTLSCredsX509
*creds
= QCRYPTO_TLS_CREDS_X509(obj
);
779 return g_strdup(creds
->passwordid
);
784 qcrypto_tls_creds_x509_prop_get_sanity(Object
*obj
,
785 Error
**errp G_GNUC_UNUSED
)
787 QCryptoTLSCredsX509
*creds
= QCRYPTO_TLS_CREDS_X509(obj
);
789 return creds
->sanityCheck
;
794 qcrypto_tls_creds_x509_complete(UserCreatable
*uc
, Error
**errp
)
796 object_property_set_bool(OBJECT(uc
), true, "loaded", errp
);
801 qcrypto_tls_creds_x509_init(Object
*obj
)
803 QCryptoTLSCredsX509
*creds
= QCRYPTO_TLS_CREDS_X509(obj
);
805 creds
->sanityCheck
= true;
807 object_property_add_bool(obj
, "loaded",
808 qcrypto_tls_creds_x509_prop_get_loaded
,
809 qcrypto_tls_creds_x509_prop_set_loaded
,
811 object_property_add_bool(obj
, "sanity-check",
812 qcrypto_tls_creds_x509_prop_get_sanity
,
813 qcrypto_tls_creds_x509_prop_set_sanity
,
815 object_property_add_str(obj
, "passwordid",
816 qcrypto_tls_creds_x509_prop_get_passwordid
,
817 qcrypto_tls_creds_x509_prop_set_passwordid
,
823 qcrypto_tls_creds_x509_finalize(Object
*obj
)
825 QCryptoTLSCredsX509
*creds
= QCRYPTO_TLS_CREDS_X509(obj
);
827 g_free(creds
->passwordid
);
828 qcrypto_tls_creds_x509_unload(creds
);
833 qcrypto_tls_creds_x509_class_init(ObjectClass
*oc
, void *data
)
835 UserCreatableClass
*ucc
= USER_CREATABLE_CLASS(oc
);
837 ucc
->complete
= qcrypto_tls_creds_x509_complete
;
841 static const TypeInfo qcrypto_tls_creds_x509_info
= {
842 .parent
= TYPE_QCRYPTO_TLS_CREDS
,
843 .name
= TYPE_QCRYPTO_TLS_CREDS_X509
,
844 .instance_size
= sizeof(QCryptoTLSCredsX509
),
845 .instance_init
= qcrypto_tls_creds_x509_init
,
846 .instance_finalize
= qcrypto_tls_creds_x509_finalize
,
847 .class_size
= sizeof(QCryptoTLSCredsX509Class
),
848 .class_init
= qcrypto_tls_creds_x509_class_init
,
849 .interfaces
= (InterfaceInfo
[]) {
850 { TYPE_USER_CREATABLE
},
857 qcrypto_tls_creds_x509_register_types(void)
859 type_register_static(&qcrypto_tls_creds_x509_info
);
863 type_init(qcrypto_tls_creds_x509_register_types
);