secret-session.c 17.2 KB
Newer Older
Stef Walter's avatar
Stef Walter committed
1
/* libsecret - GLib wrapper for Secret Service
2 3 4 5 6 7
 *
 * Copyright 2011 Collabora Ltd.
 * Copyright 2012 Red Hat Inc.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
Stef Walter's avatar
Stef Walter committed
8
 * by the Free Software Foundation; either version 2.1 of the licence or (at
9 10 11
 * your option) any later version.
 *
 * See the included COPYING file for more information.
Stef Walter's avatar
Stef Walter committed
12 13
 *
 * Author: Stef Walter <stefw@gnome.org>
14 15 16 17
 */

#include "config.h"

Stef Walter's avatar
Stef Walter committed
18
#include "secret-private.h"
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35

#ifdef WITH_GCRYPT
#include "egg/egg-dh.h"
#include "egg/egg-hkdf.h"
#include "egg/egg-libgcrypt.h"
#endif

#include "egg/egg-hex.h"
#include "egg/egg-secure-memory.h"

#include <glib/gi18n-lib.h>

EGG_SECURE_DECLARE (secret_session);

#define ALGORITHMS_AES    "dh-ietf1024-sha256-aes128-cbc-pkcs7"
#define ALGORITHMS_PLAIN  "plain"

Stef Walter's avatar
Stef Walter committed
36
struct _SecretSession {
37 38 39 40 41 42 43 44 45 46 47 48
	gchar *path;
	const gchar *algorithms;
#ifdef WITH_GCRYPT
	gcry_mpi_t prime;
	gcry_mpi_t privat;
	gcry_mpi_t publi;
#endif
	gpointer key;
	gsize n_key;
};

void
Stef Walter's avatar
Stef Walter committed
49
_secret_session_free (gpointer data)
50
{
Stef Walter's avatar
Stef Walter committed
51
	SecretSession *session = data;
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68

	if (session == NULL)
		return;

	g_free (session->path);
#ifdef WITH_GCRYPT
	gcry_mpi_release (session->publi);
	gcry_mpi_release (session->privat);
	gcry_mpi_release (session->prime);
#endif
	egg_secure_free (session->key);
	g_free (session);
}

#ifdef WITH_GCRYPT

static GVariant *
Stef Walter's avatar
Stef Walter committed
69
request_open_session_aes (SecretSession *session)
70 71 72 73 74 75 76 77 78 79 80
{
	gcry_error_t gcry;
	gcry_mpi_t base;
	unsigned char *buffer;
	size_t n_buffer;
	GVariant *argument;

	g_assert (session->prime == NULL);
	g_assert (session->privat == NULL);
	g_assert (session->publi == NULL);

Stef Walter's avatar
Stef Walter committed
81 82
	egg_libgcrypt_initialize ();

83
	/* Initialize our local parameters and values */
84
	if (!egg_dh_default_params ("ietf-ike-grp-modp-1024",
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110
	                            &session->prime, &base))
		g_return_val_if_reached (NULL);

#if 0
	g_printerr ("\n lib prime: ");
	gcry_mpi_dump (session->prime);
	g_printerr ("\n  lib base: ");
	gcry_mpi_dump (base);
	g_printerr ("\n");
#endif

	if (!egg_dh_gen_pair (session->prime, base, 0,
	                      &session->publi, &session->privat))
		g_return_val_if_reached (NULL);
	gcry_mpi_release (base);

	gcry = gcry_mpi_aprint (GCRYMPI_FMT_USG, &buffer, &n_buffer, session->publi);
	g_return_val_if_fail (gcry == 0, NULL);
	argument = g_variant_new_from_data (G_VARIANT_TYPE ("ay"),
	                                    buffer, n_buffer, TRUE,
	                                    gcry_free, buffer);

	return g_variant_new ("(sv)", ALGORITHMS_AES, argument);
}

static gboolean
Stef Walter's avatar
Stef Walter committed
111
response_open_session_aes (SecretSession *session,
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174
                           GVariant *response)
{
	gconstpointer buffer;
	GVariant *argument;
	const gchar *sig;
	gsize n_buffer;
	gcry_mpi_t peer;
	gcry_error_t gcry;
	gpointer ikm;
	gsize n_ikm;

	sig = g_variant_get_type_string (response);
	g_return_val_if_fail (sig != NULL, FALSE);

	if (!g_str_equal (sig, "(vo)")) {
		g_warning ("invalid OpenSession() response from daemon with signature: %s", sig);
		return FALSE;
	}

	g_assert (session->path == NULL);
	g_variant_get (response, "(vo)", &argument, &session->path);

	buffer = g_variant_get_fixed_array (argument, &n_buffer, sizeof (guchar));
	gcry = gcry_mpi_scan (&peer, GCRYMPI_FMT_USG, buffer, n_buffer, NULL);
	g_return_val_if_fail (gcry == 0, FALSE);
	g_variant_unref (argument);

#if 0
	g_printerr (" lib publi: ");
	gcry_mpi_dump (session->publi);
	g_printerr ("\n  lib peer: ");
	gcry_mpi_dump (peer);
	g_printerr ("\n");
#endif

	ikm = egg_dh_gen_secret (peer, session->privat, session->prime, &n_ikm);
	gcry_mpi_release (peer);

#if 0
	g_printerr ("   lib ikm:  %s\n", egg_hex_encode (ikm, n_ikm));
#endif

	if (ikm == NULL) {
		g_warning ("couldn't negotiate a valid AES session key");
		g_free (session->path);
		session->path = NULL;
		return FALSE;
	}

	session->n_key = 16;
	session->key = egg_secure_alloc (session->n_key);
	if (!egg_hkdf_perform ("sha256", ikm, n_ikm, NULL, 0, NULL, 0,
	                       session->key, session->n_key))
		g_return_val_if_reached (FALSE);
	egg_secure_free (ikm);

	session->algorithms = ALGORITHMS_AES;
	return TRUE;
}

#endif /* WITH_GCRYPT */

static GVariant *
Stef Walter's avatar
Stef Walter committed
175
request_open_session_plain (SecretSession *session)
176 177 178 179 180 181
{
	GVariant *argument = g_variant_new_string ("");
	return g_variant_new ("(sv)", "plain", argument);
}

static gboolean
Stef Walter's avatar
Stef Walter committed
182
response_open_session_plain (SecretSession *session,
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
                             GVariant *response)
{
	GVariant *argument;
	const gchar *sig;

	sig = g_variant_get_type_string (response);
	g_return_val_if_fail (sig != NULL, FALSE);

	if (!g_str_equal (sig, "(vo)")) {
		g_warning ("invalid OpenSession() response from daemon with signature: %s",
		           g_variant_get_type_string (response));
		return FALSE;
	}

	g_assert (session->path == NULL);
	g_variant_get (response, "(vo)", &argument, &session->path);
	g_variant_unref (argument);

	g_assert (session->key == NULL);
	g_assert (session->n_key == 0);

	session->algorithms = ALGORITHMS_PLAIN;
	return TRUE;
}

typedef struct {
Stef Walter's avatar
Stef Walter committed
209
	SecretSession *session;
210 211 212 213 214 215 216
} OpenSessionClosure;

static void
open_session_closure_free (gpointer data)
{
	OpenSessionClosure *closure = data;
	g_assert (closure);
Stef Walter's avatar
Stef Walter committed
217
	_secret_session_free (closure->session);
218 219 220 221 222 223 224 225
	g_free (closure);
}

static void
on_service_open_session_plain (GObject *source,
                               GAsyncResult *result,
                               gpointer user_data)
{
226 227
	GTask *task = G_TASK (user_data);
	OpenSessionClosure *closure = g_task_get_task_data (task);
Stef Walter's avatar
Stef Walter committed
228
	SecretService *service = SECRET_SERVICE (source);
229 230 231 232 233 234 235 236
	GError *error = NULL;
	GVariant *response;

	response =  g_dbus_proxy_call_finish (G_DBUS_PROXY (service), result, &error);

	/* A successful response, decode it */
	if (response != NULL) {
		if (response_open_session_plain (closure->session, response)) {
Stef Walter's avatar
Stef Walter committed
237
			_secret_service_take_session (service, closure->session);
238
			closure->session = NULL;
239
			g_task_return_boolean (task, TRUE);
240 241

		} else {
242 243
			g_task_return_new_error (task, SECRET_ERROR, SECRET_ERROR_PROTOCOL,
			                         _("Couldn’t communicate with the secret storage"));
244 245 246 247 248
		}

		g_variant_unref (response);

	} else {
249
		g_task_return_error (task, g_steal_pointer (&error));
250 251
	}

252
	g_object_unref (task);
253 254 255 256 257 258 259 260 261
}

#ifdef WITH_GCRYPT

static void
on_service_open_session_aes (GObject *source,
                             GAsyncResult *result,
                             gpointer user_data)
{
262 263
	GTask *task = G_TASK (user_data);
	OpenSessionClosure * closure = g_task_get_task_data (task);
Stef Walter's avatar
Stef Walter committed
264
	SecretService *service = SECRET_SERVICE (source);
265 266 267 268 269 270 271 272
	GError *error = NULL;
	GVariant *response;

	response =  g_dbus_proxy_call_finish (G_DBUS_PROXY (service), result, &error);

	/* A successful response, decode it */
	if (response != NULL) {
		if (response_open_session_aes (closure->session, response)) {
Stef Walter's avatar
Stef Walter committed
273
			_secret_service_take_session (service, closure->session);
274
			closure->session = NULL;
275
			g_task_return_boolean (task, TRUE);
276 277

		} else {
278 279
			g_task_return_new_error (task, SECRET_ERROR, SECRET_ERROR_PROTOCOL,
			                         _("Couldn’t communicate with the secret storage"));
280 281 282 283 284 285 286 287 288 289
		}

		g_variant_unref (response);

	} else {
		/* AES session not supported, request a plain session */
		if (g_error_matches (error, G_DBUS_ERROR, G_DBUS_ERROR_NOT_SUPPORTED)) {
			g_dbus_proxy_call (G_DBUS_PROXY (source), "OpenSession",
			                   request_open_session_plain (closure->session),
			                   G_DBUS_CALL_FLAGS_NONE, -1,
290 291 292
			                   g_task_get_cancellable (task),
			                   on_service_open_session_plain,
			                   g_object_ref (task));
293 294 295 296
			g_error_free (error);

		/* Other errors result in a failure */
		} else {
297
			g_task_return_error (task, g_steal_pointer (&error));
298 299 300
		}
	}

301
	g_object_unref (task);
302 303 304 305 306 307
}

#endif /* WITH_GCRYPT */


void
Stef Walter's avatar
Stef Walter committed
308
_secret_session_open (SecretService *service,
309 310 311
                      GCancellable *cancellable,
                      GAsyncReadyCallback callback,
                      gpointer user_data)
312
{
313
	GTask *task;
314 315
	OpenSessionClosure *closure;

316 317
	task = g_task_new (service, cancellable, callback, user_data);
	g_task_set_source_tag (task, _secret_session_open);
318
	closure = g_new (OpenSessionClosure, 1);
Stef Walter's avatar
Stef Walter committed
319
	closure->session = g_new0 (SecretSession, 1);
320
	g_task_set_task_data (task, closure, open_session_closure_free);
321 322 323 324 325 326 327 328 329 330 331

	g_dbus_proxy_call (G_DBUS_PROXY (service), "OpenSession",
#ifdef WITH_GCRYPT
	                   request_open_session_aes (closure->session),
	                   G_DBUS_CALL_FLAGS_NONE, -1,
	                   cancellable, on_service_open_session_aes,
#else
	                   request_open_session_plain (closure->session),
	                   G_DBUS_CALL_FLAGS_NONE, -1,
	                   cancellable, on_service_open_session_plain,
#endif
332
	                   g_object_ref (task));
333

334
	g_object_unref (task);
335 336
}

337
gboolean
Stef Walter's avatar
Stef Walter committed
338
_secret_session_open_finish (GAsyncResult *result,
339 340
                              GError **error)
{
341 342
	if (!g_task_propagate_boolean (G_TASK (result), error)) {
		_secret_util_strip_remote_error (error);
343
		return FALSE;
344
	}
345

346
	return TRUE;
347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380
}

#ifdef WITH_GCRYPT

static gboolean
pkcs7_unpad_bytes_in_place (guchar *padded,
                            gsize *n_padded)
{
	gsize n_pad, i;

	if (*n_padded == 0)
		return FALSE;

	n_pad = padded[*n_padded - 1];

	/* Validate the padding */
	if (n_pad == 0 || n_pad > 16)
		return FALSE;
	if (n_pad > *n_padded)
		return FALSE;
	for (i = *n_padded - n_pad; i < *n_padded; ++i) {
		if (padded[i] != n_pad)
			return FALSE;
	}

	/* The last bit of data */
	*n_padded -= n_pad;

	/* Null teriminate as a courtesy */
	padded[*n_padded] = 0;

	return TRUE;
}

Stef Walter's avatar
Stef Walter committed
381 382
static SecretValue *
service_decode_aes_secret (SecretSession *session,
383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445
                           gconstpointer param,
                           gsize n_param,
                           gconstpointer value,
                           gsize n_value,
                           const gchar *content_type)
{
	gcry_cipher_hd_t cih;
	gsize n_padded;
	gcry_error_t gcry;
	guchar *padded;
	gsize pos;

	if (n_param != 16) {
		g_message ("received an encrypted secret structure with invalid parameter");
		return NULL;
	}

	if (n_value == 0 || n_value % 16 != 0) {
		g_message ("received an encrypted secret structure with bad secret length");
		return NULL;
	}

	gcry = gcry_cipher_open (&cih, GCRY_CIPHER_AES, GCRY_CIPHER_MODE_CBC, 0);
	if (gcry != 0) {
		g_warning ("couldn't create AES cipher: %s", gcry_strerror (gcry));
		return NULL;
	}

#if 0
	g_printerr ("    lib iv:  %s\n", egg_hex_encode (param, n_param));
#endif

	gcry = gcry_cipher_setiv (cih, param, n_param);
	g_return_val_if_fail (gcry == 0, NULL);

#if 0
	g_printerr ("   lib key:  %s\n", egg_hex_encode (session->key, session->n_key));
#endif

	gcry = gcry_cipher_setkey (cih, session->key, session->n_key);
	g_return_val_if_fail (gcry == 0, NULL);

	/* Copy the memory buffer */
	n_padded = n_value;
	padded = egg_secure_alloc (n_padded);
	memcpy (padded, value, n_padded);

	/* Perform the decryption */
	for (pos = 0; pos < n_padded; pos += 16) {
		gcry = gcry_cipher_decrypt (cih, (guchar*)padded + pos, 16, NULL, 0);
		g_return_val_if_fail (gcry == 0, FALSE);
	}

	gcry_cipher_close (cih);

	/* Unpad the resulting value */
	if (!pkcs7_unpad_bytes_in_place (padded, &n_padded)) {
		egg_secure_clear (padded, n_padded);
		egg_secure_free (padded);
		g_message ("received an invalid or unencryptable secret");
		return FALSE;
	}

Stef Walter's avatar
Stef Walter committed
446
	return secret_value_new_full ((gchar *)padded, n_padded, content_type, egg_secure_free);
447 448 449 450
}

#endif /* WITH_GCRYPT */

Stef Walter's avatar
Stef Walter committed
451 452
static SecretValue *
service_decode_plain_secret (SecretSession *session,
453 454 455 456 457 458 459 460 461 462 463
                             gconstpointer param,
                             gsize n_param,
                             gconstpointer value,
                             gsize n_value,
                             const gchar *content_type)
{
	if (n_param != 0) {
		g_message ("received a plain secret structure with invalid parameter");
		return NULL;
	}

Stef Walter's avatar
Stef Walter committed
464
	return secret_value_new (value, n_value, content_type);
465 466
}

Stef Walter's avatar
Stef Walter committed
467 468
SecretValue *
_secret_session_decode_secret (SecretSession *session,
469
                               GVariant *encoded)
470
{
Stef Walter's avatar
Stef Walter committed
471
	SecretValue *result;
472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539
	gconstpointer param;
	gconstpointer value;
	gchar *session_path;
	gchar *content_type;
	gsize n_param;
	gsize n_value;
	GVariant *vparam;
	GVariant *vvalue;

	g_return_val_if_fail (session != NULL, NULL);
	g_return_val_if_fail (encoded != NULL, NULL);

	/* Parsing (oayays) */
	g_variant_get_child (encoded, 0, "o", &session_path);

	if (session_path == NULL || !g_str_equal (session_path, session->path)) {
		g_message ("received a secret encoded with wrong session: %s != %s",
		           session_path, session->path);
		g_free (session_path);
		return NULL;
	}

	vparam = g_variant_get_child_value (encoded, 1);
	param = g_variant_get_fixed_array (vparam, &n_param, sizeof (guchar));
	vvalue = g_variant_get_child_value (encoded, 2);
	value = g_variant_get_fixed_array (vvalue, &n_value, sizeof (guchar));
	g_variant_get_child (encoded, 3, "s", &content_type);

#ifdef WITH_GCRYPT
	if (session->key != NULL)
		result = service_decode_aes_secret (session, param, n_param,
		                                    value, n_value, content_type);
	else
#endif
		result = service_decode_plain_secret (session, param, n_param,
		                                      value, n_value, content_type);

	g_variant_unref (vparam);
	g_variant_unref (vvalue);
	g_free (content_type);
	g_free (session_path);

	return result;
}

#ifdef WITH_GCRYPT

static guchar*
pkcs7_pad_bytes_in_secure_memory (gconstpointer secret,
                                  gsize length,
                                  gsize *n_padded)
{
	gsize n_pad;
	guchar *padded;

	/* Pad the secret */
	*n_padded = ((length + 16) / 16) * 16;
	g_assert (length < *n_padded);
	g_assert (*n_padded > 0);
	n_pad = *n_padded - length;
	g_assert (n_pad > 0 && n_pad <= 16);
	padded = egg_secure_alloc (*n_padded);
	memcpy (padded, secret, length);
	memset (padded + length, n_pad, n_pad);
	return padded;
}

static gboolean
Stef Walter's avatar
Stef Walter committed
540 541
service_encode_aes_secret (SecretSession *session,
                           SecretValue *value,
542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561
                           GVariantBuilder *builder)
{
	gcry_cipher_hd_t cih;
	guchar *padded;
	gsize n_padded, pos;
	gcry_error_t gcry;
	gpointer iv;
	gconstpointer secret;
	gsize n_secret;
	GVariant *child;

	g_variant_builder_add (builder, "o", session->path);

	/* Create the cipher */
	gcry = gcry_cipher_open (&cih, GCRY_CIPHER_AES, GCRY_CIPHER_MODE_CBC, 0);
	if (gcry != 0) {
		g_warning ("couldn't create AES cipher: %s", gcry_strerror (gcry));
		return FALSE;
	}

Stef Walter's avatar
Stef Walter committed
562
	secret = secret_value_get (value, &n_secret);
563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591

	/* Perform the encoding here */
	padded = pkcs7_pad_bytes_in_secure_memory (secret, n_secret, &n_padded);
	g_assert (padded != NULL);

	/* Setup the IV */
	iv = g_malloc0 (16);
	gcry_create_nonce (iv, 16);
	gcry = gcry_cipher_setiv (cih, iv, 16);
	g_return_val_if_fail (gcry == 0, FALSE);

	/* Setup the key */
	gcry = gcry_cipher_setkey (cih, session->key, session->n_key);
	g_return_val_if_fail (gcry == 0, FALSE);

	/* Perform the encryption */
	for (pos = 0; pos < n_padded; pos += 16) {
		gcry = gcry_cipher_encrypt (cih, (guchar*)padded + pos, 16, NULL, 0);
		g_return_val_if_fail (gcry == 0, FALSE);
	}

	gcry_cipher_close (cih);

	child = g_variant_new_from_data (G_VARIANT_TYPE ("ay"), iv, 16, TRUE, g_free, iv);
	g_variant_builder_add_value (builder, child);

	child = g_variant_new_from_data (G_VARIANT_TYPE ("ay"), padded, n_padded, TRUE, egg_secure_free, padded);
	g_variant_builder_add_value (builder, child);

Stef Walter's avatar
Stef Walter committed
592
	g_variant_builder_add (builder, "s", secret_value_get_content_type (value));
593 594 595 596 597 598
	return TRUE;
}

#endif /* WITH_GCRYPT */

static gboolean
Stef Walter's avatar
Stef Walter committed
599 600
service_encode_plain_secret (SecretSession *session,
                             SecretValue *value,
601 602 603 604 605 606 607 608
                             GVariantBuilder *builder)
{
	gconstpointer secret;
	gsize n_secret;
	GVariant *child;

	g_variant_builder_add (builder, "o", session->path);

Stef Walter's avatar
Stef Walter committed
609
	secret = secret_value_get (value, &n_secret);
610 611 612 613 614

	child = g_variant_new_from_data (G_VARIANT_TYPE ("ay"), "", 0, TRUE, NULL, NULL);
	g_variant_builder_add_value (builder, child);

	child = g_variant_new_from_data (G_VARIANT_TYPE ("ay"), secret, n_secret, TRUE,
Stef Walter's avatar
Stef Walter committed
615
	                                 secret_value_unref, secret_value_ref (value));
616 617
	g_variant_builder_add_value (builder, child);

Stef Walter's avatar
Stef Walter committed
618
	g_variant_builder_add (builder, "s", secret_value_get_content_type (value));
619 620 621 622
	return TRUE;
}

GVariant *
Stef Walter's avatar
Stef Walter committed
623
_secret_session_encode_secret (SecretSession *session,
624
                               SecretValue *value)
625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651
{
	GVariantBuilder *builder;
	GVariant *result = NULL;
	GVariantType *type;
	gboolean ret;

	g_return_val_if_fail (session != NULL, NULL);
	g_return_val_if_fail (value != NULL, NULL);

	type = g_variant_type_new ("(oayays)");
	builder = g_variant_builder_new (type);

#ifdef WITH_GCRYPT
	if (session->key)
		ret = service_encode_aes_secret (session, value, builder);
	else
#endif
		ret = service_encode_plain_secret (session, value, builder);
	if (ret)
		result = g_variant_builder_end (builder);

	g_variant_builder_unref (builder);
	g_variant_type_free (type);
	return result;
}

const gchar *
Stef Walter's avatar
Stef Walter committed
652
_secret_session_get_algorithms (SecretSession *session)
653 654 655 656 657 658
{
	g_return_val_if_fail (session != NULL, NULL);
	return session->algorithms;
}

const gchar *
Stef Walter's avatar
Stef Walter committed
659
_secret_session_get_path (SecretSession *session)
660 661 662 663
{
	g_return_val_if_fail (session != NULL, NULL);
	return session->path;
}