/* vim:set et sw=2 cin cino=t0,f0,(0,{s,>2s,n-s,^-s,e2s: */ /* * Copyright © 2019 Collabora Ltd. * * SPDX-License-Identifier: LGPL-2.0+ * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2 of the License, or (at your option) any later version. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library. If not, see . * * Authors: * - Denis Pynkin (d4s) */ #include "config.h" #include #include "ostree-sign-ed25519.h" #ifdef HAVE_LIBSODIUM #include #endif #undef G_LOG_DOMAIN #define G_LOG_DOMAIN "OSTreeSign" #define OSTREE_SIGN_ED25519_NAME "ed25519" #define OSTREE_SIGN_METADATA_ED25519_KEY "ostree.sign.ed25519" #define OSTREE_SIGN_METADATA_ED25519_TYPE "aay" typedef enum { ED25519_OK, ED25519_NOT_SUPPORTED, ED25519_FAILED_INITIALIZATION } ed25519_state; struct _OstreeSignEd25519 { GObject parent; ed25519_state state; guchar *secret_key; GList *public_keys; GList *revoked_keys; }; #ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC G_DEFINE_AUTOPTR_CLEANUP_FUNC (OstreeSignEd25519, g_object_unref) #endif static void ostree_sign_ed25519_iface_init (OstreeSignInterface *self); G_DEFINE_TYPE_WITH_CODE (OstreeSignEd25519, _ostree_sign_ed25519, G_TYPE_OBJECT, G_IMPLEMENT_INTERFACE (OSTREE_TYPE_SIGN, ostree_sign_ed25519_iface_init)); static void ostree_sign_ed25519_iface_init (OstreeSignInterface *self) { self->data = ostree_sign_ed25519_data; self->data_verify = ostree_sign_ed25519_data_verify; self->get_name = ostree_sign_ed25519_get_name; self->metadata_key = ostree_sign_ed25519_metadata_key; self->metadata_format = ostree_sign_ed25519_metadata_format; self->clear_keys = ostree_sign_ed25519_clear_keys; self->set_sk = ostree_sign_ed25519_set_sk; self->set_pk = ostree_sign_ed25519_set_pk; self->add_pk = ostree_sign_ed25519_add_pk; self->load_pk = ostree_sign_ed25519_load_pk; } static void _ostree_sign_ed25519_class_init (OstreeSignEd25519Class *self) { } static void _ostree_sign_ed25519_init (OstreeSignEd25519 *self) { self->state = ED25519_OK; self->secret_key = NULL; self->public_keys = NULL; self->revoked_keys = NULL; #ifdef HAVE_LIBSODIUM if (sodium_init() < 0) self->state = ED25519_FAILED_INITIALIZATION; #else self->state = ED25519_NOT_SUPPORTED; #endif /* HAVE_LIBSODIUM */ } static gboolean _ostree_sign_ed25519_is_initialized (OstreeSignEd25519 *self, GError **error) { switch (self->state) { case ED25519_OK: break; case ED25519_NOT_SUPPORTED: return glnx_throw(error, "ed25519: engine is not supported"); case ED25519_FAILED_INITIALIZATION: return glnx_throw(error, "ed25519: libsodium library isn't initialized properly"); } return TRUE; } gboolean ostree_sign_ed25519_data (OstreeSign *self, GBytes *data, GBytes **signature, GCancellable *cancellable, GError **error) { g_return_val_if_fail (OSTREE_IS_SIGN (self), FALSE); OstreeSignEd25519 *sign = _ostree_sign_ed25519_get_instance_private(OSTREE_SIGN_ED25519(self)); #ifdef HAVE_LIBSODIUM guchar *sig = NULL; #endif if (!_ostree_sign_ed25519_is_initialized (sign, error)) return FALSE; if (sign->secret_key == NULL) return glnx_throw (error, "Not able to sign: secret key is not set"); #ifdef HAVE_LIBSODIUM unsigned long long sig_size = 0; sig = g_malloc0(crypto_sign_BYTES); if (crypto_sign_detached (sig, &sig_size, g_bytes_get_data (data, NULL), g_bytes_get_size (data), sign->secret_key)) { return glnx_throw (error, "Not able to sign: fail to sign the object"); } *signature = g_bytes_new_take (sig, sig_size); return TRUE; #endif /* HAVE_LIBSODIUM */ return FALSE; } #ifdef HAVE_LIBSODIUM static gint _compare_ed25519_keys(gconstpointer a, gconstpointer b) { return memcmp (a, b, crypto_sign_PUBLICKEYBYTES); } #endif gboolean ostree_sign_ed25519_data_verify (OstreeSign *self, GBytes *data, GVariant *signatures, char **out_success_message, GError **error) { g_return_val_if_fail (OSTREE_IS_SIGN (self), FALSE); g_return_val_if_fail (data != NULL, FALSE); OstreeSignEd25519 *sign = _ostree_sign_ed25519_get_instance_private(OSTREE_SIGN_ED25519(self)); if (!_ostree_sign_ed25519_is_initialized (sign, error)) return FALSE; if (signatures == NULL) return glnx_throw (error, "ed25519: commit have no signatures of my type"); if (!g_variant_is_of_type (signatures, (GVariantType *) OSTREE_SIGN_METADATA_ED25519_TYPE)) return glnx_throw (error, "ed25519: wrong type passed for verification"); #ifdef HAVE_LIBSODIUM /* If no keys pre-loaded then, * try to load public keys from storage(s) */ if (sign->public_keys == NULL) { g_autoptr (GVariantBuilder) builder = NULL; g_autoptr (GVariant) options = NULL; builder = g_variant_builder_new (G_VARIANT_TYPE ("a{sv}")); options = g_variant_builder_end (builder); if (!ostree_sign_ed25519_load_pk (self, options, error)) return FALSE; } g_debug ("verify: data hash = 0x%x", g_bytes_hash(data)); g_autoptr(GString) invalid_signatures = NULL; guint n_invalid_signatures = 0; for (gsize i = 0; i < g_variant_n_children(signatures); i++) { g_autoptr (GVariant) child = g_variant_get_child_value (signatures, i); g_autoptr (GBytes) signature = g_variant_get_data_as_bytes(child); g_autofree char * hex = g_malloc0 (crypto_sign_PUBLICKEYBYTES*2 + 1); g_debug("Read signature %d: %s", (gint)i, g_variant_print(child, TRUE)); for (GList *public_key = sign->public_keys; public_key != NULL; public_key = public_key->next) { /* TODO: use non-list for tons of revoked keys? */ if (g_list_find_custom (sign->revoked_keys, public_key->data, _compare_ed25519_keys) != NULL) { g_debug("Skip revoked key '%s'", sodium_bin2hex (hex, crypto_sign_PUBLICKEYBYTES*2+1, public_key->data, crypto_sign_PUBLICKEYBYTES)); continue; } if (crypto_sign_verify_detached ((guchar *) g_variant_get_data (child), g_bytes_get_data (data, NULL), g_bytes_get_size (data), public_key->data) != 0) { /* Incorrect signature! */ if (invalid_signatures == NULL) invalid_signatures = g_string_new (""); else g_string_append (invalid_signatures, "; "); n_invalid_signatures++; g_string_append_printf (invalid_signatures, "key '%s'", sodium_bin2hex (hex, crypto_sign_PUBLICKEYBYTES*2+1, public_key->data, crypto_sign_PUBLICKEYBYTES)); } else { if (out_success_message) { *out_success_message = g_strdup_printf ("ed25519: Signature verified successfully with key '%s'", sodium_bin2hex (hex, crypto_sign_PUBLICKEYBYTES*2+1, public_key->data, crypto_sign_PUBLICKEYBYTES)); } return TRUE; } } } if (invalid_signatures) { g_assert_cmpuint (n_invalid_signatures, >, 0); /* The test suite has a key ring with 100 keys. This seems insane, let's * cap a reasonable error message at 3. */ if (n_invalid_signatures > 3) return glnx_throw (error, "ed25519: Signature couldn't be verified; tried %u keys", n_invalid_signatures); return glnx_throw (error, "ed25519: Signature couldn't be verified with: %s", invalid_signatures->str); } return glnx_throw (error, "ed25519: no signatures found"); #endif /* HAVE_LIBSODIUM */ return FALSE; } const gchar * ostree_sign_ed25519_get_name (OstreeSign *self) { g_return_val_if_fail (OSTREE_IS_SIGN (self), FALSE); return OSTREE_SIGN_ED25519_NAME; } const gchar * ostree_sign_ed25519_metadata_key (OstreeSign *self) { return OSTREE_SIGN_METADATA_ED25519_KEY; } const gchar * ostree_sign_ed25519_metadata_format (OstreeSign *self) { return OSTREE_SIGN_METADATA_ED25519_TYPE; } gboolean ostree_sign_ed25519_clear_keys (OstreeSign *self, GError **error) { g_return_val_if_fail (OSTREE_IS_SIGN (self), FALSE); OstreeSignEd25519 *sign = _ostree_sign_ed25519_get_instance_private(OSTREE_SIGN_ED25519(self)); if (!_ostree_sign_ed25519_is_initialized (sign, error)) return FALSE; #ifdef HAVE_LIBSODIUM /* Clear secret key */ if (sign->secret_key != NULL) { memset (sign->secret_key, 0, crypto_sign_SECRETKEYBYTES); g_free (sign->secret_key); sign->secret_key = NULL; } /* Clear already loaded trusted keys */ if (sign->public_keys != NULL) { g_list_free_full (sign->public_keys, g_free); sign->public_keys = NULL; } /* Clear already loaded revoked keys */ if (sign->revoked_keys != NULL) { g_list_free_full (sign->revoked_keys, g_free); sign->revoked_keys = NULL; } return TRUE; #endif /* HAVE_LIBSODIUM */ return FALSE; } /* Support 2 representations: * base64 ascii -- secret key is passed as string * raw key -- key is passed as bytes array * */ gboolean ostree_sign_ed25519_set_sk (OstreeSign *self, GVariant *secret_key, GError **error) { g_return_val_if_fail (OSTREE_IS_SIGN (self), FALSE); if (!ostree_sign_ed25519_clear_keys (self, error)) return FALSE; #ifdef HAVE_LIBSODIUM OstreeSignEd25519 *sign = _ostree_sign_ed25519_get_instance_private(OSTREE_SIGN_ED25519(self)); gsize n_elements = 0; if (g_variant_is_of_type (secret_key, G_VARIANT_TYPE_STRING)) { const gchar *sk_ascii = g_variant_get_string (secret_key, NULL); sign->secret_key = g_base64_decode (sk_ascii, &n_elements); } else if (g_variant_is_of_type (secret_key, G_VARIANT_TYPE_BYTESTRING)) { sign->secret_key = (guchar *) g_variant_get_fixed_array (secret_key, &n_elements, sizeof(guchar)); } else { return glnx_throw (error, "Unknown ed25519 secret key type"); } if (n_elements != crypto_sign_SECRETKEYBYTES) return glnx_throw (error, "Incorrect ed25519 secret key"); return TRUE; #endif /* HAVE_LIBSODIUM */ return FALSE; } /* Support 2 representations: * base64 ascii -- public key is passed as string * raw key -- key is passed as bytes array * */ gboolean ostree_sign_ed25519_set_pk (OstreeSign *self, GVariant *public_key, GError **error) { g_return_val_if_fail (OSTREE_IS_SIGN (self), FALSE); if (!ostree_sign_ed25519_clear_keys (self, error)) return FALSE; return ostree_sign_ed25519_add_pk (self, public_key, error); } /* Support 2 representations: * base64 ascii -- public key is passed as string * raw key -- key is passed as bytes array * */ gboolean ostree_sign_ed25519_add_pk (OstreeSign *self, GVariant *public_key, GError **error) { g_return_val_if_fail (OSTREE_IS_SIGN (self), FALSE); OstreeSignEd25519 *sign = _ostree_sign_ed25519_get_instance_private(OSTREE_SIGN_ED25519(self)); if (!_ostree_sign_ed25519_is_initialized (sign, error)) return FALSE; #ifdef HAVE_LIBSODIUM gpointer key = NULL; gsize n_elements = 0; if (g_variant_is_of_type (public_key, G_VARIANT_TYPE_STRING)) { const gchar *pk_ascii = g_variant_get_string (public_key, NULL); key = g_base64_decode (pk_ascii, &n_elements); } else if (g_variant_is_of_type (public_key, G_VARIANT_TYPE_BYTESTRING)) { key = (gpointer) g_variant_get_fixed_array (public_key, &n_elements, sizeof(guchar)); } else { return glnx_throw (error, "Unknown ed25519 public key type"); } if (n_elements != crypto_sign_PUBLICKEYBYTES) return glnx_throw (error, "Incorrect ed25519 public key"); g_autofree char *hex = g_malloc0 (crypto_sign_PUBLICKEYBYTES*2 + 1); g_debug ("Read ed25519 public key = %s", sodium_bin2hex (hex, crypto_sign_PUBLICKEYBYTES*2+1, key, n_elements)); if (g_list_find_custom (sign->public_keys, key, _compare_ed25519_keys) == NULL) { gpointer newkey = g_memdup (key, n_elements); sign->public_keys = g_list_prepend (sign->public_keys, newkey); } #endif /* HAVE_LIBSODIUM */ return TRUE; } #ifdef HAVE_LIBSODIUM /* Add revoked public key */ static gboolean _ed25519_add_revoked (OstreeSign *self, GVariant *revoked_key, GError **error) { g_return_val_if_fail (OSTREE_IS_SIGN (self), FALSE); if (!g_variant_is_of_type (revoked_key, G_VARIANT_TYPE_STRING)) return glnx_throw (error, "Unknown ed25519 revoked key type"); OstreeSignEd25519 *sign = _ostree_sign_ed25519_get_instance_private(OSTREE_SIGN_ED25519(self)); const gchar *rk_ascii = g_variant_get_string (revoked_key, NULL); gsize n_elements = 0; gpointer key = g_base64_decode (rk_ascii, &n_elements); if (n_elements != crypto_sign_PUBLICKEYBYTES) { return glnx_throw (error, "Incorrect ed25519 revoked key"); } g_autofree char * hex = g_malloc0 (crypto_sign_PUBLICKEYBYTES*2 + 1); g_debug ("Read ed25519 revoked key = %s", sodium_bin2hex (hex, crypto_sign_PUBLICKEYBYTES*2+1, key, n_elements)); if (g_list_find_custom (sign->revoked_keys, key, _compare_ed25519_keys) == NULL) { gpointer newkey = g_memdup (key, n_elements); sign->revoked_keys = g_list_prepend (sign->revoked_keys, newkey); } return TRUE; } #endif /* HAVE_LIBSODIUM */ static gboolean _load_pk_from_stream (OstreeSign *self, GDataInputStream *key_data_in, gboolean trusted, GError **error) { g_return_val_if_fail (key_data_in, FALSE); #ifdef HAVE_LIBSODIUM gboolean ret = FALSE; /* Use simple file format with just a list of base64 public keys per line */ while (TRUE) { gsize len = 0; g_autoptr (GVariant) pk = NULL; gboolean added = FALSE; g_autoptr(GError) local_error = NULL; g_autofree char *line = g_data_input_stream_read_line (key_data_in, &len, NULL, &local_error); if (local_error != NULL) { g_propagate_error (error, g_steal_pointer (&local_error)); return FALSE; } if (line == NULL) return ret; /* Read the key itself */ /* base64 encoded key */ pk = g_variant_new_string (line); if (trusted) added = ostree_sign_ed25519_add_pk (self, pk, error); else added = _ed25519_add_revoked (self, pk, error); g_debug ("%s %s key: %s", added ? "Added" : "Invalid", trusted ? "public" : "revoked", line); /* Mark what we load at least one key */ if (added) ret = TRUE; } #endif /* HAVE_LIBSODIUM */ return FALSE; } static gboolean _load_pk_from_file (OstreeSign *self, const gchar *filename, gboolean trusted, GError **error) { g_debug ("Processing file '%s'", filename); g_autoptr (GFile) keyfile = NULL; g_autoptr (GFileInputStream) key_stream_in = NULL; g_autoptr (GDataInputStream) key_data_in = NULL; if (!g_file_test (filename, G_FILE_TEST_IS_REGULAR)) { g_debug ("Can't open file '%s' with public keys", filename); return glnx_throw (error, "File object '%s' is not a regular file", filename); } keyfile = g_file_new_for_path (filename); key_stream_in = g_file_read (keyfile, NULL, error); if (key_stream_in == NULL) return FALSE; key_data_in = g_data_input_stream_new (G_INPUT_STREAM(key_stream_in)); g_assert (key_data_in != NULL); if (!_load_pk_from_stream (self, key_data_in, trusted, error)) { if (error == NULL || *error == NULL) return glnx_throw (error, "signature: ed25519: no valid keys in file '%s'", filename); else return FALSE; } return TRUE; } static gboolean _ed25519_load_pk (OstreeSign *self, GVariant *options, gboolean trusted, GError **error) { gboolean ret = FALSE; const gchar *custom_dir = NULL; g_autoptr (GPtrArray) base_dirs = g_ptr_array_new_with_free_func (g_free); g_autoptr (GPtrArray) ed25519_files = g_ptr_array_new_with_free_func (g_free); if (g_variant_lookup (options, "basedir", "&s", &custom_dir)) { /* Add custom directory */ g_ptr_array_add (base_dirs, g_strdup (custom_dir)); } else { /* Default paths where to find files with public keys */ g_ptr_array_add (base_dirs, g_strdup ("/etc/ostree")); g_ptr_array_add (base_dirs, g_strdup (DATADIR "/ostree")); } /* Scan all well-known directories and construct the list with file names to scan keys */ for (gint i=0; i < base_dirs->len; i++) { gchar *base_name = NULL; g_autofree gchar *base_dir = NULL; g_autoptr (GDir) dir = NULL; base_name = g_build_filename ((gchar *)g_ptr_array_index (base_dirs, i), trusted ? "trusted.ed25519" : "revoked.ed25519", NULL); g_debug ("Check ed25519 keys from file: %s", base_name); g_ptr_array_add (ed25519_files, base_name); base_dir = g_strconcat (base_name, ".d", NULL); dir = g_dir_open (base_dir, 0, error); if (dir == NULL) { g_clear_error (error); continue; } const gchar *entry = NULL; while ((entry = g_dir_read_name (dir)) != NULL) { gchar *filename = g_build_filename (base_dir, entry, NULL); g_debug ("Check ed25519 keys from file: %s", filename); g_ptr_array_add (ed25519_files, filename); } } /* Scan all well-known files */ for (gint i=0; i < ed25519_files->len; i++) { if (!_load_pk_from_file (self, (gchar *)g_ptr_array_index (ed25519_files, i), trusted, error)) { g_debug ("Problem with loading ed25519 %s keys from `%s`", trusted ? "public" : "revoked", (gchar *)g_ptr_array_index (ed25519_files, i)); g_clear_error(error); } else ret = TRUE; } if (!ret && (error == NULL || *error == NULL)) return glnx_throw (error, "signature: ed25519: no keys loaded"); return ret; } /* * options argument should be a{sv}: * - filename -- single file to use to load keys from; * - basedir -- directory containing subdirectories * 'trusted.ed25519.d' and 'revoked.ed25519.d' with appropriate * public keys. Used for testing and re-definition of system-wide * directories if defaults are not suitable for any reason. */ gboolean ostree_sign_ed25519_load_pk (OstreeSign *self, GVariant *options, GError **error) { const gchar *filename = NULL; OstreeSignEd25519 *sign = _ostree_sign_ed25519_get_instance_private(OSTREE_SIGN_ED25519(self)); if (!_ostree_sign_ed25519_is_initialized (sign, error)) return FALSE; /* Read keys only from single file provided */ if (g_variant_lookup (options, "filename", "&s", &filename)) return _load_pk_from_file (self, filename, TRUE, error); /* Load public keys from well-known directories and files */ if (!_ed25519_load_pk (self, options, TRUE, error)) return FALSE; /* Load untrusted keys from well-known directories and files * Ignore the failure from this function -- it is expected to have * empty list of revoked keys. * */ if (!_ed25519_load_pk (self, options, FALSE, error)) g_clear_error(error); return TRUE; }