bolt-device.c 12.8 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

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

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

38 39 40 41
struct _BoltDevice
{
  BoltDBusDeviceSkeleton object;

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

45 46 47 48 49
  char        *dbus_path;

  char        *uid;
  char        *name;
  char        *vendor;
50

51 52
  BoltStatus   status;

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


enum {
  PROP_0,

  PROP_UID,
62 63
  PROP_NAME,
  PROP_VENDOR,
64
  PROP_STATUS,
65
  PROP_SYSFS,
66 67 68 69 70 71 72 73 74 75 76 77 78 79

  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);

80 81
  g_free (dev->dbus_path);

82
  g_free (dev->uid);
83 84 85
  g_free (dev->name);
  g_free (dev->vendor);
  g_free (dev->syspath);
86 87 88 89 90

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

static void
91
bolt_device_init (BoltDevice *dev)
92
{
93 94
  g_signal_connect (dev, "handle-authorize",
                    G_CALLBACK (handle_authorize), NULL);
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110
}

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;

111 112 113 114 115 116 117 118
    case PROP_NAME:
      g_value_set_string (value, dev->name);
      break;

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

119 120 121 122
    case PROP_STATUS:
      g_value_set_uint (value, dev->status);
      break;

123 124 125 126
    case PROP_SYSFS:
      g_value_set_string (value, dev->syspath);
      break;

127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
    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:
      dev->uid = g_value_dup_string (value);
      break;

146
    case PROP_NAME:
147
      dev->name = g_value_dup_string (value);
148 149 150
      break;

    case PROP_VENDOR:
151
      dev->vendor = g_value_dup_string (value);
152 153
      break;

154 155 156 157
    case PROP_STATUS:
      dev->status = g_value_get_uint (value);
      break;

158 159 160 161
    case PROP_SYSFS:
      dev->syspath = g_value_dup_string (value);
      break;

162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
    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");
181 182 183 184 185 186 187 188 189

  g_object_class_override_property (gobject_class,
                                    PROP_NAME,
                                    "name");

  g_object_class_override_property (gobject_class,
                                    PROP_VENDOR,
                                    "vendor");

190 191 192 193
  g_object_class_override_property (gobject_class,
                                    PROP_STATUS,
                                    "status");

194 195 196 197 198
  g_object_class_override_property (gobject_class,
                                    PROP_SYSFS,
                                    "sysfs-path");

}
199 200 201

/* internal methods */

202 203
static const char *
read_sysattr_name (struct udev_device *udev, const char *attr, GError **error)
204 205
{
  g_autofree char *s = NULL;
206
  const char *v;
207 208

  s = g_strdup_printf ("%s_name", attr);
209 210 211 212 213 214
  v = udev_device_get_sysattr_value (udev, s);

  if (v != NULL)
    return v;

  v = udev_device_get_sysattr_value (udev, attr);
215

216
  if (v == NULL)
217 218 219
    g_set_error (error,
                 BOLT_ERROR, BOLT_ERROR_UDEV,
                 "failed to get sysfs attr: %s", attr);
220 221

  return v;
222 223
}

224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
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;
}

286 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 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 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 446 447 448 449 450 451 452 453 454 455 456 457
/*  device authorization */

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

typedef struct
{
  char level;

  /* 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);
}

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

  devdir = bolt_opendir (dev->syspath, &error);
  if (devdir == NULL)
    {
      g_task_return_error (task, error);
      return;
    }

  ok = bolt_verify_uid (dirfd (devdir), dev->uid, &error);
  if (!ok)
    {
      g_task_return_error (task, error);
      return;
    }

  ok = bolt_write_char_at (dirfd (devdir),
                           "authorized",
                           auth->level,
                           &error);

  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)
{
  BoltDevice *dev = BOLT_DEVICE (object);
  GTask *task = G_TASK (res);

  g_autoptr(GError) error = NULL;
  AuthData *auth;
  gboolean ok;

  auth = g_task_get_task_data (task);

  ok = g_task_propagate_boolean (task, &error);

  if (ok)
    dev->status = BOLT_STATUS_AUTH_ERROR;
  else
    dev->status = BOLT_STATUS_AUTHORIZED;

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

static gboolean
bolt_device_authorize (BoltDevice  *dev,
                       AuthCallback callback,
                       gpointer     user_data,
                       GError     **error)
{
  AuthData *auth_data;
  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;
    }

  task = g_task_new (dev, NULL, authorize_thread_done, NULL);

  auth_data = g_slice_new (AuthData);
  auth_data->level = '1';
  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;
}

458 459 460 461 462 463 464
/* public methods */

BoltDevice *
bolt_device_new_for_udev (BoltManager        *mgr,
                          struct udev_device *udev,
                          GError            **error)
{
465 466 467 468
  const char *uid;
  const char *name;
  const char *vendor;
  const char *syspath;
469
  BoltDevice *dev;
470 471


472 473 474 475 476 477 478
  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;
    }
479

480 481
  syspath = udev_device_get_syspath (udev);
  g_return_val_if_fail (syspath != NULL, NULL);
482

483
  name = read_sysattr_name (udev, "device", error);
484 485 486
  if (name == NULL)
    return NULL;

487
  vendor = read_sysattr_name (udev, "vendor", error);
488 489
  if (vendor == NULL)
    return NULL;
490 491

  dev = g_object_new (BOLT_TYPE_DEVICE,
492 493 494 495
                      "uid", uid,
                      "name", name,
                      "vendor", vendor,
                      "sysfs-path", syspath,
496 497
                      NULL);

498
  dev->status = bolt_status_from_udev (udev);
499

500 501 502
  g_object_add_weak_pointer (G_OBJECT (mgr),
                             (gpointer *) &dev->mgr);

503 504 505
  return dev;
}

506
const char *
507 508 509 510
bolt_device_export (BoltDevice      *device,
                    GDBusConnection *connection,
                    GError         **error)
{
511
  const char *path;
512
  gboolean ok;
513 514

  g_return_val_if_fail (BOLT_IS_DEVICE (device), FALSE);
515

516
  path = bolt_device_get_object_path (device);
517 518 519

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

520 521 522 523 524
  ok = g_dbus_interface_skeleton_export (G_DBUS_INTERFACE_SKELETON (device),
                                         connection,
                                         path,
                                         error);
  return ok ? path : NULL;
525 526 527 528 529
}

void
bolt_device_unexport (BoltDevice *device)
{
530 531 532 533 534
  const char *path;

  path = bolt_device_get_object_path (device);

  g_debug ("Unexporting device at: %s", path);
535 536
  g_dbus_interface_skeleton_unexport (G_DBUS_INTERFACE_SKELETON (device));
}
537

538 539 540 541 542 543
const char *
bolt_device_get_name (BoltDevice *dev)
{
  return dev->name;
}

544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560
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;
}
561 562 563 564 565 566 567 568 569 570 571 572

const char *
bolt_device_get_uid (BoltDevice *dev)
{
  return dev->uid;
}

const char *
bolt_device_get_syspath (BoltDevice *dev)
{
  return dev->syspath;
}
573 574 575 576 577 578

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