/* * Copyright (c) 2013, Red Hat Inc. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * * Redistributions of source code must retain the above * copyright notice, this list of conditions and the * following disclaimer. * * Redistributions in binary form must reproduce the * above copyright notice, this list of conditions and * the following disclaimer in the documentation and/or * other materials provided with the distribution. * * The names of contributors to this software may not be * used to endorse or promote products derived from this * software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH * DAMAGE. * * Author: Stef Walter */ #include "config.h" #define P11_DEBUG_FLAG P11_DEBUG_TOOL #include "attrs.h" #include "debug.h" #include "oid.h" #include "dict.h" #include "extract.h" #include "message.h" #include "path.h" #include "pkcs11.h" #include "pkcs11x.h" #include "x509.h" #include #include static bool load_stapled_extension (p11_dict *stapled, p11_dict *asn1_defs, const unsigned char *der, size_t len) { char message[ASN1_MAX_ERROR_DESCRIPTION_SIZE]; node_asn *ext; char *oid; int length; int start; int end; int ret; ext = p11_asn1_decode (asn1_defs, "PKIX1.Extension", der, len, message); if (ext == NULL) { p11_message ("couldn't parse stapled certificate extension: %s", message); return false; } ret = asn1_der_decoding_startEnd (ext, der, len, "extnID", &start, &end); return_val_if_fail (ret == ASN1_SUCCESS, false); /* Make sure it's a straightforward oid with certain assumptions */ length = (end - start) + 1; if (!p11_oid_simple (der + start, length)) { p11_debug ("strange complex certificate extension object id"); return false; } oid = memdup (der + start, length); return_val_if_fail (oid != NULL, false); if (!p11_dict_set (stapled, oid, ext)) return_val_if_reached (false); return true; } static p11_dict * load_stapled_extensions (p11_extract_info *ex, CK_FUNCTION_LIST_PTR module, CK_SESSION_HANDLE session, CK_ATTRIBUTE *spki) { CK_OBJECT_CLASS extension = CKO_X_CERTIFICATE_EXTENSION; CK_ATTRIBUTE *attrs; P11KitIter *iter; CK_RV rv = CKR_OK; p11_dict *stapled; CK_ATTRIBUTE match[] = { { CKA_CLASS, &extension, sizeof (extension) }, { CKA_X_PUBLIC_KEY_INFO, spki->pValue, spki->ulValueLen }, }; CK_ATTRIBUTE template[] = { { CKA_VALUE, }, }; stapled = p11_dict_new (p11_oid_hash, p11_oid_equal, free, p11_asn1_free); /* No ID to use, just short circuit */ if (!spki->pValue || !spki->ulValueLen) return stapled; iter = p11_kit_iter_new (NULL, 0); p11_kit_iter_add_filter (iter, match, 2); p11_kit_iter_begin_with (iter, module, 0, session); while (rv == CKR_OK) { rv = p11_kit_iter_next (iter); if (rv == CKR_OK) { attrs = p11_attrs_buildn (NULL, template, 1); rv = p11_kit_iter_load_attributes (iter, attrs, 1); if (rv == CKR_OK) { if (!load_stapled_extension (stapled, ex->asn1_defs, attrs[0].pValue, attrs[0].ulValueLen)) { rv = CKR_GENERAL_ERROR; } } p11_attrs_free (attrs); } } if (rv != CKR_OK && rv != CKR_CANCEL) { p11_message ("couldn't load stapled extensions for certificate: %s", p11_kit_strerror (rv)); p11_dict_free (stapled); stapled = NULL; } p11_kit_iter_free (iter); return stapled; } static bool extract_purposes (p11_extract_info *ex) { node_asn *ext = NULL; unsigned char *value = NULL; size_t length; if (ex->stapled) { ext = p11_dict_get (ex->stapled, P11_OID_EXTENDED_KEY_USAGE); if (ext != NULL) { value = p11_asn1_read (ext, "extnValue", &length); return_val_if_fail (value != NULL, false); } } if (value == NULL && ex->cert_asn) { value = p11_x509_find_extension (ex->cert_asn, P11_OID_EXTENDED_KEY_USAGE, ex->cert_der, ex->cert_len, &length); } /* No such extension, match anything */ if (value == NULL) return true; ex->purposes = p11_x509_parse_extended_key_usage (ex->asn1_defs, value, length); free (value); return ex->purposes != NULL; } static bool check_blacklisted (P11KitIter *iter, CK_ATTRIBUTE *cert) { CK_OBJECT_HANDLE dummy; CK_FUNCTION_LIST *module; CK_SESSION_HANDLE session; CK_BBOOL distrusted = CK_TRUE; CK_ULONG have; CK_RV rv; CK_ATTRIBUTE match[] = { { CKA_VALUE, cert->pValue, cert->ulValueLen }, { CKA_X_DISTRUSTED, &distrusted, sizeof (distrusted) }, }; module = p11_kit_iter_get_module (iter); session = p11_kit_iter_get_session (iter); rv = (module->C_FindObjectsInit) (session, match, 2); if (rv == CKR_OK) { rv = (module->C_FindObjects) (session, &dummy, 1, &have); (module->C_FindObjectsFinal) (session); } if (rv != CKR_OK) { p11_message ("couldn't check if certificate is on blacklist"); return true; } if (have == 0) { p11_debug ("anchor is not on blacklist"); return false; } else { p11_debug ("anchor is on blacklist"); return true; } } static bool check_trust_flags (P11KitIter *iter, p11_extract_info *ex, CK_ATTRIBUTE *cert) { CK_BBOOL trusted; CK_BBOOL distrusted; int flags = 0; /* If no extract trust flags, then just continue */ if (!(ex->flags & (P11_EXTRACT_ANCHORS | P11_EXTRACT_BLACKLIST))) return true; if (p11_attrs_find_bool (ex->attrs, CKA_TRUSTED, &trusted) && trusted && !check_blacklisted (iter, cert)) { flags |= P11_EXTRACT_ANCHORS; } if (p11_attrs_find_bool (ex->attrs, CKA_X_DISTRUSTED, &distrusted) && distrusted) { flags |= P11_EXTRACT_BLACKLIST; } /* Any of the flags can match */ if (flags & ex->flags) return true; return false; } static bool extract_certificate (P11KitIter *iter, p11_extract_info *ex) { char message[ASN1_MAX_ERROR_DESCRIPTION_SIZE]; CK_ATTRIBUTE *attr; CK_ULONG type; /* Don't even bother with not X.509 certificates */ if (!p11_attrs_find_ulong (ex->attrs, CKA_CERTIFICATE_TYPE, &type)) type = (CK_ULONG)-1; if (type != CKC_X_509) { p11_debug ("skipping non X.509 certificate"); return false; } attr = p11_attrs_find_valid (ex->attrs, CKA_VALUE); if (!attr || !attr->pValue) { p11_debug ("skipping certificate without a value"); return false; } /* * If collapsing and have already seen this certificate, and shouldn't * process it even again during this extract procedure. */ if (ex->flags & P11_EXTRACT_COLLAPSE) { if (!ex->already_seen) { ex->already_seen = p11_dict_new (p11_attr_hash, p11_attr_equal, p11_attrs_free, NULL); return_val_if_fail (ex->already_seen != NULL, true); } if (p11_dict_get (ex->already_seen, attr)) return false; } if (!check_trust_flags (iter, ex, attr)) { p11_debug ("skipping certificate that doesn't match trust flags"); return false; } if (ex->already_seen) { if (!p11_dict_set (ex->already_seen, p11_attrs_build (NULL, attr, NULL), "x")) return_val_if_reached (true); } ex->cert_der = attr->pValue; ex->cert_len = attr->ulValueLen; ex->cert_asn = p11_asn1_decode (ex->asn1_defs, "PKIX1.Certificate", ex->cert_der, ex->cert_len, message); if (!ex->cert_asn) { p11_message ("couldn't parse certificate: %s", message); return false; } return true; } static bool extract_info (P11KitIter *iter, p11_extract_info *ex) { CK_ATTRIBUTE *attr; CK_RV rv; static const CK_ATTRIBUTE attr_types[] = { { CKA_ID, }, { CKA_CLASS, }, { CKA_CERTIFICATE_TYPE, }, { CKA_LABEL, }, { CKA_VALUE, }, { CKA_SUBJECT, }, { CKA_ISSUER, }, { CKA_TRUSTED, }, { CKA_CERTIFICATE_CATEGORY }, { CKA_X_DISTRUSTED }, { CKA_X_PUBLIC_KEY_INFO }, { CKA_INVALID, }, }; ex->attrs = p11_attrs_dup (attr_types); rv = p11_kit_iter_load_attributes (iter, ex->attrs, p11_attrs_count (ex->attrs)); /* The attributes couldn't be loaded */ if (rv != CKR_OK && rv != CKR_ATTRIBUTE_TYPE_INVALID && rv != CKR_ATTRIBUTE_SENSITIVE) { p11_message ("couldn't load attributes: %s", p11_kit_strerror (rv)); return false; } /* No class attribute, very strange, just skip */ if (!p11_attrs_find_ulong (ex->attrs, CKA_CLASS, &ex->klass)) return false; /* If a certificate then */ if (ex->klass != CKO_CERTIFICATE) { p11_message ("skipping non-certificate object"); return false; } if (!extract_certificate (iter, ex)) return false; attr = p11_attrs_find_valid (ex->attrs, CKA_X_PUBLIC_KEY_INFO); if (attr) { ex->stapled = load_stapled_extensions (ex, p11_kit_iter_get_module (iter), p11_kit_iter_get_session (iter), attr); if (!ex->stapled) return false; } if (!extract_purposes (ex)) return false; return true; } static void extract_clear (p11_extract_info *ex) { ex->klass = (CK_ULONG)-1; p11_attrs_free (ex->attrs); ex->attrs = NULL; asn1_delete_structure (&ex->cert_asn); ex->cert_der = NULL; ex->cert_len = 0; p11_dict_free (ex->stapled); ex->stapled = NULL; p11_array_free (ex->purposes); ex->purposes = NULL; } CK_RV p11_extract_info_load_filter (P11KitIter *iter, CK_BBOOL *matches, void *data) { p11_extract_info *ex = data; int i; extract_clear (ex); /* Try to load the certificate and extensions */ if (!extract_info (iter, ex)) { *matches = CK_FALSE; return CKR_OK; } /* * Limit to certain purposes. Note that the lack of purposes noted * on the certificate means they match any purpose. This is the * behavior of the ExtendedKeyUsage extension. */ if (ex->limit_to_purposes && ex->purposes) { *matches = CK_FALSE; for (i = 0; i < ex->purposes->num; i++) { if (p11_dict_get (ex->limit_to_purposes, ex->purposes->elem[i])) { *matches = CK_TRUE; break; } } } return CKR_OK; } void p11_extract_info_init (p11_extract_info *ex) { memset (ex, 0, sizeof (p11_extract_info)); ex->asn1_defs = p11_asn1_defs_load (); return_if_fail (ex->asn1_defs != NULL); } void p11_extract_info_cleanup (p11_extract_info *ex) { extract_clear (ex); p11_dict_free (ex->limit_to_purposes); ex->limit_to_purposes = NULL; p11_dict_free (ex->already_seen); ex->already_seen = NULL; p11_dict_free (ex->asn1_defs); ex->asn1_defs = NULL; } void p11_extract_info_limit_purpose (p11_extract_info *ex, const char *purpose) { char *value; if (!ex->limit_to_purposes) { ex->limit_to_purposes = p11_dict_new (p11_dict_str_hash, p11_dict_str_equal, free, NULL); return_if_fail (ex->limit_to_purposes != NULL); } value = strdup (purpose); return_if_fail (value != NULL); if (!p11_dict_set (ex->limit_to_purposes, value, value)) return_if_reached (); } static char * extract_label (p11_extract_info *extract) { CK_ATTRIBUTE *attr; /* Look for a label and just use that */ attr = p11_attrs_find_valid (extract->attrs, CKA_LABEL); if (attr && attr->pValue && attr->ulValueLen) return strndup (attr->pValue, attr->ulValueLen); /* For extracting certificates */ if (extract->klass == CKO_CERTIFICATE) return strdup ("certificate"); return strdup ("unknown"); } char * p11_extract_info_filename (p11_extract_info *extract) { char *label; label = extract_label (extract); return_val_if_fail (label != NULL, NULL); p11_path_canon (label); return label; } char * p11_extract_info_comment (p11_extract_info *ex, bool first) { char *comment; char *label; if (!(ex->flags & P11_EXTRACT_COMMENT)) return NULL; label = extract_label (ex); if (!asprintf (&comment, "%s# %s\n", first ? "" : "\n", label ? label : "")) return_val_if_reached (NULL); free (label); return comment; }