2 * QEMU crypto secret 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.1 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 "qemu/osdep.h"
22 #include "crypto/secret_common.h"
23 #include "crypto/cipher.h"
24 #include "qapi/error.h"
25 #include "qom/object_interfaces.h"
26 #include "qemu/base64.h"
27 #include "qemu/module.h"
31 static void qcrypto_secret_decrypt(QCryptoSecretCommon *secret,
38 g_autofree uint8_t *iv = NULL;
39 g_autofree uint8_t *key = NULL;
40 g_autofree uint8_t *ciphertext = NULL;
41 size_t keylen, ciphertextlen, ivlen;
42 g_autoptr(QCryptoCipher) aes = NULL;
43 g_autofree uint8_t *plaintext = NULL;
48 if (qcrypto_secret_lookup(secret->keyid,
55 error_setg(errp, "Key should be 32 bytes in length");
60 error_setg(errp, "IV is required to decrypt secret");
64 iv = qbase64_decode(secret->iv, -1, &ivlen, errp);
69 error_setg(errp, "IV should be 16 bytes in length not %zu",
74 aes = qcrypto_cipher_new(QCRYPTO_CIPHER_ALG_AES_256,
75 QCRYPTO_CIPHER_MODE_CBC,
82 if (qcrypto_cipher_setiv(aes, iv, ivlen, errp) < 0) {
86 if (secret->format == QCRYPTO_SECRET_FORMAT_BASE64) {
87 ciphertext = qbase64_decode((const gchar *)input,
94 plaintext = g_new0(uint8_t, ciphertextlen + 1);
96 ciphertextlen = inputlen;
97 plaintext = g_new0(uint8_t, inputlen + 1);
99 if (qcrypto_cipher_decrypt(aes,
100 ciphertext ? ciphertext : input,
107 if (plaintext[ciphertextlen - 1] > 16 ||
108 plaintext[ciphertextlen - 1] > ciphertextlen) {
109 error_setg(errp, "Incorrect number of padding bytes (%d) "
110 "found on decrypted data",
111 (int)plaintext[ciphertextlen - 1]);
116 * Even though plaintext may contain arbitrary NUL
117 * ensure it is explicitly NUL terminated.
119 ciphertextlen -= plaintext[ciphertextlen - 1];
120 plaintext[ciphertextlen] = '\0';
122 *output = g_steal_pointer(&plaintext);
123 *outputlen = ciphertextlen;
127 static void qcrypto_secret_decode(const uint8_t *input,
133 *output = qbase64_decode((const gchar *)input,
141 qcrypto_secret_complete(UserCreatable *uc, Error **errp)
143 QCryptoSecretCommon *secret = QCRYPTO_SECRET_COMMON(uc);
144 QCryptoSecretCommonClass *sec_class
145 = QCRYPTO_SECRET_COMMON_GET_CLASS(uc);
147 Error *local_err = NULL;
148 uint8_t *input = NULL;
150 uint8_t *output = NULL;
151 size_t outputlen = 0;
153 if (sec_class->load_data) {
154 sec_class->load_data(secret, &input, &inputlen, &local_err);
156 error_propagate(errp, local_err);
160 error_setg(errp, "%s provides no 'load_data' method'",
161 object_get_typename(OBJECT(uc)));
166 qcrypto_secret_decrypt(secret, input, inputlen,
167 &output, &outputlen, &local_err);
170 error_propagate(errp, local_err);
174 inputlen = outputlen;
176 if (secret->format == QCRYPTO_SECRET_FORMAT_BASE64) {
177 qcrypto_secret_decode(input, inputlen,
178 &output, &outputlen, &local_err);
181 error_propagate(errp, local_err);
185 inputlen = outputlen;
189 secret->rawdata = input;
190 secret->rawlen = inputlen;
195 qcrypto_secret_prop_get_loaded(Object *obj,
196 Error **errp G_GNUC_UNUSED)
198 QCryptoSecretCommon *secret = QCRYPTO_SECRET_COMMON(obj);
199 return secret->rawdata != NULL;
204 qcrypto_secret_prop_set_format(Object *obj,
206 Error **errp G_GNUC_UNUSED)
208 QCryptoSecretCommon *creds = QCRYPTO_SECRET_COMMON(obj);
209 creds->format = value;
214 qcrypto_secret_prop_get_format(Object *obj,
215 Error **errp G_GNUC_UNUSED)
217 QCryptoSecretCommon *creds = QCRYPTO_SECRET_COMMON(obj);
218 return creds->format;
223 qcrypto_secret_prop_set_iv(Object *obj,
227 QCryptoSecretCommon *secret = QCRYPTO_SECRET_COMMON(obj);
230 secret->iv = g_strdup(value);
235 qcrypto_secret_prop_get_iv(Object *obj,
238 QCryptoSecretCommon *secret = QCRYPTO_SECRET_COMMON(obj);
239 return g_strdup(secret->iv);
244 qcrypto_secret_prop_set_keyid(Object *obj,
248 QCryptoSecretCommon *secret = QCRYPTO_SECRET_COMMON(obj);
250 g_free(secret->keyid);
251 secret->keyid = g_strdup(value);
256 qcrypto_secret_prop_get_keyid(Object *obj,
259 QCryptoSecretCommon *secret = QCRYPTO_SECRET_COMMON(obj);
260 return g_strdup(secret->keyid);
265 qcrypto_secret_finalize(Object *obj)
267 QCryptoSecretCommon *secret = QCRYPTO_SECRET_COMMON(obj);
270 g_free(secret->keyid);
271 g_free(secret->rawdata);
275 qcrypto_secret_class_init(ObjectClass *oc, void *data)
277 UserCreatableClass *ucc = USER_CREATABLE_CLASS(oc);
279 ucc->complete = qcrypto_secret_complete;
281 object_class_property_add_bool(oc, "loaded",
282 qcrypto_secret_prop_get_loaded,
284 object_class_property_add_enum(oc, "format",
285 "QCryptoSecretFormat",
286 &QCryptoSecretFormat_lookup,
287 qcrypto_secret_prop_get_format,
288 qcrypto_secret_prop_set_format);
289 object_class_property_add_str(oc, "keyid",
290 qcrypto_secret_prop_get_keyid,
291 qcrypto_secret_prop_set_keyid);
292 object_class_property_add_str(oc, "iv",
293 qcrypto_secret_prop_get_iv,
294 qcrypto_secret_prop_set_iv);
298 int qcrypto_secret_lookup(const char *secretid,
304 QCryptoSecretCommon *secret;
306 obj = object_resolve_path_component(
307 object_get_objects_root(), secretid);
309 error_setg(errp, "No secret with id '%s'", secretid);
313 secret = (QCryptoSecretCommon *)
314 object_dynamic_cast(obj,
315 TYPE_QCRYPTO_SECRET_COMMON);
317 error_setg(errp, "Object with id '%s' is not a secret",
322 if (!secret->rawdata) {
323 error_setg(errp, "Secret with id '%s' has no data",
328 *data = g_new0(uint8_t, secret->rawlen + 1);
329 memcpy(*data, secret->rawdata, secret->rawlen);
330 (*data)[secret->rawlen] = '\0';
331 *datalen = secret->rawlen;
337 char *qcrypto_secret_lookup_as_utf8(const char *secretid,
343 if (qcrypto_secret_lookup(secretid,
350 if (!g_utf8_validate((const gchar *)data, datalen, NULL)) {
352 "Data from secret %s is not valid UTF-8",
362 char *qcrypto_secret_lookup_as_base64(const char *secretid,
369 if (qcrypto_secret_lookup(secretid,
376 ret = g_base64_encode(data, datalen);
382 static const TypeInfo qcrypto_secret_info = {
383 .parent = TYPE_OBJECT,
384 .name = TYPE_QCRYPTO_SECRET_COMMON,
385 .instance_size = sizeof(QCryptoSecretCommon),
386 .instance_finalize = qcrypto_secret_finalize,
387 .class_size = sizeof(QCryptoSecretCommonClass),
388 .class_init = qcrypto_secret_class_init,
390 .interfaces = (InterfaceInfo[]) {
391 { TYPE_USER_CREATABLE },
398 qcrypto_secret_register_types(void)
400 type_register_static(&qcrypto_secret_info);
404 type_init(qcrypto_secret_register_types);