bolt-device.c 18.3 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
/*
 * Copyright © 2017 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 by the Free Software Foundation; either
 * version 2.1 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 <http://www.gnu.org/licenses/>.
 *
 * Authors:
 *       Christian J. Kellner <christian@kellner.me>
 */

#include "config.h"

23
#include "bolt-dbus.h"
24
#include "bolt-device.h"
25
#include "bolt-enums.h"
26
#include "bolt-error.h"
27
#include "bolt-io.h"
28
#include "bolt-manager.h"
29
#include "bolt-store.h"
30

31
#include <dirent.h>
32 33
#include <libudev.h>

34 35 36 37 38
/* dbus method calls */
static gboolean    handle_authorize (BoltDBusDevice        *object,
                                     GDBusMethodInvocation *invocation,
                                     gpointer               user_data);

39 40 41 42
struct _BoltDevice
{
  BoltDBusDeviceSkeleton object;

43 44
  /* weak reference */
  BoltManager *mgr;
45

46 47 48 49 50
  char        *dbus_path;

  char        *uid;
  char        *name;
  char        *vendor;
51

52 53
  BoltStatus   status;

54
  /* when device is attached */
55 56
  char        *syspath;
  BoltSecurity security;
57 58 59 60 61

  /* when device is stored */
  BoltPolicy policy;
  guint      store; /* currently: 0,no / 1,yes */
  guint      key; /* currently 0,no / 1,yes */
62 63 64 65 66 67 68
};


enum {
  PROP_0,

  PROP_UID,
69 70
  PROP_NAME,
  PROP_VENDOR,
71
  PROP_STATUS,
72

73
  PROP_SYSFS,
74
  PROP_SECURITY,
75

76 77 78 79
  PROP_STORED,
  PROP_POLICY,
  PROP_HAVE_KEY,

80 81 82 83 84 85 86 87 88 89 90 91 92
  PROP_LAST
};


G_DEFINE_TYPE (BoltDevice,
               bolt_device,
               BOLT_DBUS_TYPE_DEVICE_SKELETON)

static void
bolt_device_finalize (GObject *object)
{
  BoltDevice *dev = BOLT_DEVICE (object);

93 94
  g_free (dev->dbus_path);

95
  g_free (dev->uid);
96 97 98
  g_free (dev->name);
  g_free (dev->vendor);
  g_free (dev->syspath);
99 100 101 102 103

  G_OBJECT_CLASS (bolt_device_parent_class)->finalize (object);
}

static void
104
bolt_device_init (BoltDevice *dev)
105
{
106 107
  g_signal_connect (dev, "handle-authorize",
                    G_CALLBACK (handle_authorize), NULL);
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123
}

static void
bolt_device_get_property (GObject    *object,
                          guint       prop_id,
                          GValue     *value,
                          GParamSpec *pspec)
{
  BoltDevice *dev = BOLT_DEVICE (object);

  switch (prop_id)
    {
    case PROP_UID:
      g_value_set_string (value, dev->uid);
      break;

124 125 126 127 128 129 130 131
    case PROP_NAME:
      g_value_set_string (value, dev->name);
      break;

    case PROP_VENDOR:
      g_value_set_string (value, dev->vendor);
      break;

132 133 134 135
    case PROP_STATUS:
      g_value_set_uint (value, dev->status);
      break;

136 137 138 139
    case PROP_SYSFS:
      g_value_set_string (value, dev->syspath);
      break;

140 141 142 143
    case PROP_SECURITY:
      g_value_set_uint (value, dev->security);
      break;

144 145 146 147 148 149 150 151 152 153 154 155
    case PROP_STORED:
      g_value_set_uint (value, dev->store);
      break;

    case PROP_POLICY:
      g_value_set_uint (value, dev->policy);
      break;

    case PROP_HAVE_KEY:
      g_value_set_uint (value, dev->key);
      break;

156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
    }
}

static void
bolt_device_set_property (GObject      *object,
                          guint         prop_id,
                          const GValue *value,
                          GParamSpec   *pspec)
{
  BoltDevice *dev = BOLT_DEVICE (object);

  switch (prop_id)
    {
    case PROP_UID:
172
      g_return_if_fail (dev->uid == NULL);
173 174 175
      dev->uid = g_value_dup_string (value);
      break;

176
    case PROP_NAME:
177
      g_clear_pointer (&dev->name, g_free);
178
      dev->name = g_value_dup_string (value);
179 180 181
      break;

    case PROP_VENDOR:
182
      g_clear_pointer (&dev->vendor, g_free);
183
      dev->vendor = g_value_dup_string (value);
184 185
      break;

186 187 188 189
    case PROP_STATUS:
      dev->status = g_value_get_uint (value);
      break;

190
    case PROP_SYSFS:
191
      g_clear_pointer (&dev->syspath, g_free);
192 193
      dev->syspath = g_value_dup_string (value);
      break;
194 195 196 197

    case PROP_SECURITY:
      dev->security = g_value_get_uint (value);
      break;
198

199 200 201 202 203 204 205 206 207 208 209 210
    case PROP_STORED:
      dev->store = g_value_get_uint (value);
      break;

    case PROP_POLICY:
      dev->policy = g_value_get_uint (value);
      break;

    case PROP_HAVE_KEY:
      dev->key = g_value_get_uint (value);
      break;

211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
    }
}


static void
bolt_device_class_init (BoltDeviceClass *klass)
{
  GObjectClass *gobject_class = G_OBJECT_CLASS (klass);

  gobject_class->finalize = bolt_device_finalize;

  gobject_class->get_property = bolt_device_get_property;
  gobject_class->set_property = bolt_device_set_property;

  g_object_class_override_property (gobject_class,
                                    PROP_UID,
                                    "uid");
230 231 232 233 234 235 236 237 238

  g_object_class_override_property (gobject_class,
                                    PROP_NAME,
                                    "name");

  g_object_class_override_property (gobject_class,
                                    PROP_VENDOR,
                                    "vendor");

239 240 241 242
  g_object_class_override_property (gobject_class,
                                    PROP_STATUS,
                                    "status");

243 244 245 246
  g_object_class_override_property (gobject_class,
                                    PROP_SYSFS,
                                    "sysfs-path");

247 248 249 250
  g_object_class_override_property (gobject_class,
                                    PROP_SECURITY,
                                    "security");

251 252 253 254 255 256 257 258 259 260 261 262
  g_object_class_override_property (gobject_class,
                                    PROP_STORED,
                                    "store");

  g_object_class_override_property (gobject_class,
                                    PROP_POLICY,
                                    "policy");

  g_object_class_override_property (gobject_class,
                                    PROP_HAVE_KEY,
                                    "key");

263
}
264 265 266

/* internal methods */

267 268
static const char *
read_sysattr_name (struct udev_device *udev, const char *attr, GError **error)
269 270
{
  g_autofree char *s = NULL;
271
  const char *v;
272 273

  s = g_strdup_printf ("%s_name", attr);
274 275 276 277 278 279
  v = udev_device_get_sysattr_value (udev, s);

  if (v != NULL)
    return v;

  v = udev_device_get_sysattr_value (udev, attr);
280

281
  if (v == NULL)
282 283 284
    g_set_error (error,
                 BOLT_ERROR, BOLT_ERROR_UDEV,
                 "failed to get sysfs attr: %s", attr);
285 286

  return v;
287 288
}

289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350
static gint
read_sysfs_attr_int (struct udev_device *device, const char *attr)
{
  const char *str;
  char *end;
  gint64 val;

  str = udev_device_get_sysattr_value (device, attr);

  if (str == NULL)
    return 0;

  val = g_ascii_strtoull (str, &end, 0);

  if (str == end)
    return 0;

  if (val > G_MAXINT || val < G_MININT)
    {
      g_warning ("value read from sysfs outside of guint's range.");
      val = 0;
    }

  return (gint) val;
}

static gboolean
string_nonzero (const char *str)
{
  return str != NULL && str[0] != '\0';
}

static BoltStatus
bolt_status_from_udev (struct udev_device *udev)
{
  gint authorized;
  const char *key;
  gboolean have_key;

  authorized = read_sysfs_attr_int (udev, "authorized");

  if (authorized == 2)
    return BOLT_STATUS_AUTHORIZED_SECURE;

  key = udev_device_get_sysattr_value (udev, "key");
  have_key = string_nonzero (key);

  if (authorized == 1)
    {
      if (have_key)
        return BOLT_STATUS_AUTHORIZED_NEWKEY;
      else
        return BOLT_STATUS_AUTHORIZED;
    }
  else if (authorized == 0 && have_key)
    {
      return BOLT_STATUS_AUTH_ERROR;
    }

  return BOLT_STATUS_CONNECTED;
}

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 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395

static struct udev_device *
domain_for_device (struct udev_device *udev)
{
  struct udev_device *parent;
  gboolean found;

  found = FALSE;
  parent = udev;
  do
    {
      const char *name;
      parent = udev_device_get_parent (parent);
      if (!parent)
        break;

      name = udev_device_get_sysname (parent);
      found = g_str_has_prefix (name, "domain");

    }
  while (!found);

  return found ? parent : NULL;
}

static BoltSecurity
security_for_udev (struct udev_device *udev)
{
  struct udev_device *parent = NULL;
  const char *v;
  BoltSecurity s;

  parent = domain_for_device (udev);
  if (parent == NULL)
    {
      g_warning ("Failed to determine domain device");
      return BOLT_SECURITY_NONE;
    }

  v = udev_device_get_sysattr_value (parent, "security");
  s = bolt_security_from_string (v);

  return s;
}

396 397 398 399 400 401 402 403 404
/*  device authorization */

typedef void (*AuthCallback) (BoltDevice *dev,
                              gboolean    ok,
                              GError    **error,
                              gpointer    user_data);

typedef struct
{
405 406 407
  BoltSecurity level;
  BoltKey     *key;
  BoltPolicy   policy;
408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423

  /* the outer callback  */
  AuthCallback callback;
  gpointer     user_data;

} AuthData;

static void
auth_data_free (gpointer data)
{
  AuthData *auth = data;

  g_debug ("freeing auth data");
  g_slice_free (AuthData, auth);
}

424 425 426 427
static gboolean
authorize_device_internal (BoltDevice *dev,
                           AuthData   *auth,
                           GError    **error)
428 429 430 431
{
  g_autoptr(DIR) devdir = NULL;
  gboolean ok;

432
  devdir = bolt_opendir (dev->syspath, error);
433
  if (devdir == NULL)
434
    return FALSE;
435

436
  ok = bolt_verify_uid (dirfd (devdir), dev->uid, error);
437
  if (!ok)
438 439 440
    return FALSE;

  if (auth->key)
441
    {
442 443 444 445 446 447 448 449 450 451 452
      int keyfd;

      g_debug ("[%s] writing key", dev->uid);
      keyfd = bolt_openat (dirfd (devdir), "key", O_WRONLY | O_CLOEXEC, error);
      if (keyfd < 0)
        return FALSE;

      ok = bolt_key_write_to (auth->key, keyfd, &auth->level, error);
      close (keyfd);
      if (!ok)
        return FALSE;
453 454
    }

455
  g_debug ("[%s] writing authorization", dev->uid);
456 457 458
  ok = bolt_write_char_at (dirfd (devdir),
                           "authorized",
                           auth->level,
459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475
                           error);

  return ok;
}

static void
authorize_in_thread (GTask        *task,
                     gpointer      source,
                     gpointer      context,
                     GCancellable *cancellable)
{
  g_autoptr(GError) error = NULL;
  BoltDevice *dev = source;
  AuthData *auth = context;
  gboolean ok;

  ok = authorize_device_internal (dev, auth, &error);
476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494

  if (!ok)
    {
      g_task_return_new_error (task,
                               BOLT_ERROR, BOLT_ERROR_FAILED,
                               "failed to authorize device: %s",
                               error->message);
    }
  else
    {
      g_task_return_boolean (task, TRUE);
    }
}

static void
authorize_thread_done (GObject      *object,
                       GAsyncResult *res,
                       gpointer      user_data)
{
495
  g_autoptr(GError) error = NULL;
496
  BoltDevice *dev = BOLT_DEVICE (object);
497
  BoltStore *store;
498 499 500 501
  GTask *task = G_TASK (res);
  AuthData *auth;
  gboolean ok;

502
  store = bolt_manager_get_store (dev->mgr);
503 504 505 506
  auth = g_task_get_task_data (task);
  ok = g_task_propagate_boolean (task, &error);

  if (ok)
507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523
    {
      if (auth->level == BOLT_SECURITY_SECURE)
        dev->status = BOLT_STATUS_AUTHORIZED_SECURE;
      else if (auth->key)
        dev->status = BOLT_STATUS_AUTHORIZED_NEWKEY;
      else
        dev->status = BOLT_STATUS_AUTHORIZED;

      if (!dev->store)
        {
          ok = bolt_store_put_device (store,
                                      dev,
                                      BOLT_POLICY_AUTO,
                                      auth->key,
                                      &error);
        }
    }
524
  else
525 526 527 528 529
    {
      dev->status = BOLT_STATUS_AUTH_ERROR;
    }

  g_object_notify (G_OBJECT (dev), "status");
530 531 532

  if (auth->callback)
    auth->callback (dev, ok, &error, auth->user_data);
533

534 535 536 537 538 539 540 541 542
}

static gboolean
bolt_device_authorize (BoltDevice  *dev,
                       AuthCallback callback,
                       gpointer     user_data,
                       GError     **error)
{
  AuthData *auth_data;
543 544 545
  BoltStore *store;
  BoltSecurity level;
  BoltKey *key;
546 547 548 549 550 551 552 553 554 555
  GTask *task;

  if (dev->status != BOLT_STATUS_CONNECTED &&
      dev->status != BOLT_STATUS_AUTH_ERROR)
    {
      g_set_error (error, BOLT_ERROR, BOLT_ERROR_FAILED,
                   "wrong device state: %u", dev->status);
      return FALSE;
    }

556 557 558
  store = bolt_manager_get_store (dev->mgr);
  level = dev->security;
  key = NULL;
559

560 561 562 563 564 565 566 567 568 569 570 571 572 573
  if (level == BOLT_SECURITY_SECURE)
    {
      if (!dev->store)
        key = bolt_store_create_key (store, dev->uid, error);
      else if (dev->key)
        key = bolt_store_get_key (store, dev->uid, error);
      else
        level = BOLT_SECURITY_USER;
    }

  if (level == BOLT_SECURITY_SECURE && key == NULL)
    return FALSE;

  task = g_task_new (dev, NULL, authorize_thread_done, NULL);
574
  auth_data = g_slice_new (AuthData);
575 576
  auth_data->level = level;
  auth_data->key = key;
577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632
  auth_data->callback = callback;
  auth_data->user_data = user_data;
  g_task_set_task_data (task, auth_data, auth_data_free);

  dev->status = BOLT_STATUS_AUTHORIZING;
  g_object_notify (G_OBJECT (dev), "status");

  g_task_run_in_thread (task, authorize_in_thread);
  g_object_unref (task);

  return TRUE;
}


/* dbus methods */

static void
handle_authorize_done (BoltDevice *dev,
                       gboolean    ok,
                       GError    **error,
                       gpointer    user_data)
{
  GDBusMethodInvocation *invocation = user_data;

  if (ok)
    {
      bolt_dbus_device_complete_authorize (BOLT_DBUS_DEVICE (dev),
                                           invocation);
    }
  else
    {
      g_dbus_method_invocation_take_error (invocation, *error);
      error = NULL;
    }
}

static gboolean
handle_authorize (BoltDBusDevice        *object,
                  GDBusMethodInvocation *invocation,
                  gpointer               user_data)
{
  BoltDevice *dev = BOLT_DEVICE (object);
  GError *error = NULL;
  gboolean ok;

  ok = bolt_device_authorize (dev,
                              handle_authorize_done,
                              invocation,
                              &error);

  if (!ok)
    g_dbus_method_invocation_take_error (invocation, error);

  return TRUE;
}

633 634 635 636 637 638 639
/* public methods */

BoltDevice *
bolt_device_new_for_udev (BoltManager        *mgr,
                          struct udev_device *udev,
                          GError            **error)
{
640 641 642 643
  const char *uid;
  const char *name;
  const char *vendor;
  const char *syspath;
644
  BoltDevice *dev;
645 646


647 648 649 650 651 652 653
  uid = udev_device_get_sysattr_value (udev, "unique_id");
  if (udev == NULL)
    {
      g_set_error (error, BOLT_ERROR, BOLT_ERROR_UDEV,
                   "could not get unique_id for udev");
      return NULL;
    }
654

655 656
  syspath = udev_device_get_syspath (udev);
  g_return_val_if_fail (syspath != NULL, NULL);
657

658
  name = read_sysattr_name (udev, "device", error);
659 660 661
  if (name == NULL)
    return NULL;

662
  vendor = read_sysattr_name (udev, "vendor", error);
663 664
  if (vendor == NULL)
    return NULL;
665 666

  dev = g_object_new (BOLT_TYPE_DEVICE,
667 668 669 670
                      "uid", uid,
                      "name", name,
                      "vendor", vendor,
                      "sysfs-path", syspath,
671 672
                      NULL);

673
  dev->status = bolt_status_from_udev (udev);
674
  dev->security = security_for_udev (udev);
675

676
  dev->mgr = mgr;
677 678 679
  g_object_add_weak_pointer (G_OBJECT (mgr),
                             (gpointer *) &dev->mgr);

680 681 682
  return dev;
}

683
const char *
684 685 686 687
bolt_device_export (BoltDevice      *device,
                    GDBusConnection *connection,
                    GError         **error)
{
688
  const char *path;
689
  gboolean ok;
690 691

  g_return_val_if_fail (BOLT_IS_DEVICE (device), FALSE);
692

693
  path = bolt_device_get_object_path (device);
694 695 696

  g_debug ("Exporting device at: %s", path);

697 698 699 700 701
  ok = g_dbus_interface_skeleton_export (G_DBUS_INTERFACE_SKELETON (device),
                                         connection,
                                         path,
                                         error);
  return ok ? path : NULL;
702 703 704 705 706
}

void
bolt_device_unexport (BoltDevice *device)
{
707 708 709 710 711
  const char *path;

  path = bolt_device_get_object_path (device);

  g_debug ("Unexporting device at: %s", path);
712 713
  g_dbus_interface_skeleton_unexport (G_DBUS_INTERFACE_SKELETON (device));
}
714

715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754

BoltStatus
bolt_device_connected (BoltDevice         *dev,
                       struct udev_device *udev)
{
  const char *syspath;
  BoltSecurity security;
  BoltStatus status;

  syspath = udev_device_get_syspath (udev);
  status = bolt_status_from_udev (udev);
  security = security_for_udev (udev);

  g_object_set (G_OBJECT (dev),
                "sysfs-path", syspath,
                "security", security,
                "status", status,
                NULL);

  return status;
}

BoltStatus
bolt_device_disconnected (BoltDevice *dev)
{
  g_object_set (G_OBJECT (dev),
                "sysfs-path", NULL,
                "security", BOLT_SECURITY_NONE,
                "status", BOLT_STATUS_DISCONNECTED,
                NULL);

  return dev->status;
}

gboolean
bolt_device_is_connected (BoltDevice *device)
{
  return device->status > BOLT_STATUS_CONNECTING;
}

755 756 757 758 759 760
guint
bolt_device_get_key (BoltDevice *dev)
{
  return dev->key;
}

761 762 763 764 765 766
const char *
bolt_device_get_name (BoltDevice *dev)
{
  return dev->name;
}

767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783
const char *
bolt_device_get_object_path (BoltDevice *device)
{
  g_return_val_if_fail (BOLT_IS_DEVICE (device), FALSE);

  if (device->dbus_path == NULL)
    {
      char *path = NULL;

      path = g_strdup_printf ("/org/freedesktop/Bolt/devices/%s", device->uid);
      g_strdelimit (path, "-", '_');

      device->dbus_path = path;
    }

  return device->dbus_path;
}
784

785 786 787 788 789 790
BoltPolicy
bolt_device_get_policy (BoltDevice *dev)
{
  return dev->policy;
}

791 792 793 794 795 796
const char *
bolt_device_get_uid (BoltDevice *dev)
{
  return dev->uid;
}

797 798 799 800 801 802
BoltSecurity
bolt_device_get_security (BoltDevice *dev)
{
  return dev->security;
}

Christian Kellner's avatar
Christian Kellner committed
803 804 805 806 807 808
BoltStatus
bolt_device_get_status (BoltDevice *dev)
{
  return dev->status;
}

809 810 811 812 813 814
guint
bolt_device_get_store (BoltDevice *dev)
{
  return dev->store;
}

815 816 817 818 819
const char *
bolt_device_get_syspath (BoltDevice *dev)
{
  return dev->syspath;
}
820 821 822 823 824 825

const char *
bolt_device_get_vendor (BoltDevice *dev)
{
  return dev->vendor;
}