security_apparmor.c 16.8 KB
Newer Older
J
Jamie Strandboge 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58

/*
 * AppArmor security driver for libvirt
 * Copyright (C) 2009 Canonical Ltd.
 *
 * 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.1 of the License, or (at your option) any later version.
 *
 * Author:
 *   Jamie Strandboge <jamie@canonical.com>
 *   Based on security_selinux.c by James Morris <jmorris@namei.org>
 *
 * AppArmor security driver.
 */

#include <config.h>

#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <sys/apparmor.h>
#include <errno.h>
#include <unistd.h>
#include <wait.h>
#include <stdbool.h>

#include "internal.h"

#include "security_driver.h"
#include "security_apparmor.h"
#include "util.h"
#include "memory.h"
#include "virterror_internal.h"
#include "datatypes.h"
#include "uuid.h"

#define VIR_FROM_THIS VIR_FROM_SECURITY
#define SECURITY_APPARMOR_VOID_DOI      "0"
#define SECURITY_APPARMOR_NAME          "apparmor"
#define VIRT_AA_HELPER BINDIR "/virt-aa-helper"

/*
 * profile_status returns '-1' on error, '0' if loaded
 *
 * If check_enforcing is set to '1', then returns '-1' on error, '0' if
 * loaded in complain mode, and '1' if loaded in enforcing mode.
 */
static int
profile_status(const char *str, const int check_enforcing)
{
    char *content = NULL;
    char *tmp = NULL;
    char *etmp = NULL;
    int rc = -1;

    /* create string that is '<str> \0' for accurate matching */
59 60
    if (virAsprintf(&tmp, "%s ", str) == -1) {
        virReportOOMError(NULL);
J
Jamie Strandboge 已提交
61
        return rc;
62
    }
J
Jamie Strandboge 已提交
63 64 65 66 67

    if (check_enforcing != 0) {
        /* create string that is '<str> (enforce)\0' for accurate matching */
        if (virAsprintf(&etmp, "%s (enforce)", str) == -1) {
            VIR_FREE(tmp);
68
            virReportOOMError(NULL);
J
Jamie Strandboge 已提交
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89
            return rc;
        }
    }

    if (virFileReadAll(APPARMOR_PROFILES_PATH, MAX_FILE_LEN, &content) < 0) {
        virReportSystemError(NULL, errno,
                             _("Failed to read AppArmor profiles list "
                             "\'%s\'"), APPARMOR_PROFILES_PATH);
        goto clean;
    }

    if (strstr(content, tmp) != NULL)
        rc = 0;
    if (check_enforcing != 0) {
        if (rc == 0 && strstr(content, etmp) != NULL)
            rc = 1;                 /* return '1' if loaded and enforcing */
    }

    VIR_FREE(content);
  clean:
    VIR_FREE(tmp);
J
Jamie Strandboge 已提交
90
    VIR_FREE(etmp);
J
Jamie Strandboge 已提交
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107

    return rc;
}

static int
profile_loaded(const char *str)
{
    return profile_status(str, 0);
}

/*
 * profile_status_file returns '-1' on error, '0' if file on disk is in
 * complain mode and '1' if file on disk is in enforcing mode
 */
static int
profile_status_file(const char *str)
{
J
Jamie Strandboge 已提交
108
    char *profile = NULL;
J
Jamie Strandboge 已提交
109 110 111 112 113
    char *content = NULL;
    char *tmp = NULL;
    int rc = -1;
    int len;

J
Jamie Strandboge 已提交
114 115
    if (virAsprintf(&profile, "%s/%s", APPARMOR_DIR "/libvirt", str) == -1) {
        virReportOOMError(NULL);
J
Jamie Strandboge 已提交
116 117 118
        return rc;
    }

J
Jamie Strandboge 已提交
119 120 121
    if (!virFileExists(profile))
        goto failed;

J
Jamie Strandboge 已提交
122 123 124
    if ((len = virFileReadAll(profile, MAX_FILE_LEN, &content)) < 0) {
        virReportSystemError(NULL, errno,
                             _("Failed to read \'%s\'"), profile);
J
Jamie Strandboge 已提交
125
        goto failed;
J
Jamie Strandboge 已提交
126 127 128 129 130
    }

    /* create string that is ' <str> flags=(complain)\0' */
    if (virAsprintf(&tmp, " %s flags=(complain)", str) == -1) {
        virReportOOMError(NULL);
J
Jamie Strandboge 已提交
131
        goto failed;
J
Jamie Strandboge 已提交
132 133 134 135 136 137 138
    }

    if (strstr(content, tmp) != NULL)
        rc = 0;
    else
        rc = 1;

J
Jamie Strandboge 已提交
139
  failed:
J
Jamie Strandboge 已提交
140
    VIR_FREE(tmp);
J
Jamie Strandboge 已提交
141
    VIR_FREE(profile);
J
Jamie Strandboge 已提交
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
    VIR_FREE(content);

    return rc;
}

/*
 * load (add) a profile. Will create one if necessary
 */
static int
load_profile(virConnectPtr conn, const char *profile, virDomainObjPtr vm,
             virDomainDiskDefPtr disk)
{
    int rc = -1, status, ret;
    bool create = true;
    char *xml = NULL;
    int pipefd[2];
    pid_t child;

    if (pipe(pipefd) < -1) {
        virReportSystemError(conn, errno, "%s", _("unable to create pipe"));
        return rc;
    }

    xml = virDomainDefFormat(conn, vm->def, VIR_DOMAIN_XML_SECURE);
    if (!xml)
J
Jamie Strandboge 已提交
167
        goto clean;
J
Jamie Strandboge 已提交
168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206

    if (profile_status_file(profile) >= 0)
        create = false;

    if (create) {
        const char *const argv[] = {
            VIRT_AA_HELPER, "-c", "-u", profile, NULL
        };
        ret = virExec(conn, argv, NULL, NULL, &child,
                      pipefd[0], NULL, NULL, VIR_EXEC_CLEAR_CAPS);
    } else if (disk && disk->src) {
        const char *const argv[] = {
            VIRT_AA_HELPER, "-r", "-u", profile, "-f", disk->src, NULL
        };
        ret = virExec(conn, argv, NULL, NULL, &child,
                      pipefd[0], NULL, NULL, VIR_EXEC_CLEAR_CAPS);
    } else {
        const char *const argv[] = {
            VIRT_AA_HELPER, "-r", "-u", profile, NULL
        };
        ret = virExec(conn, argv, NULL, NULL, &child,
                      pipefd[0], NULL, NULL, VIR_EXEC_CLEAR_CAPS);
    }
    if (ret < 0)
        goto clean;

    /* parent continues here */
    if (safewrite(pipefd[1], xml, strlen(xml)) < 0) {
        virReportSystemError(conn, errno, "%s", _("unable to write to pipe"));
        goto clean;
    }
    close(pipefd[1]);
    rc = 0;

  rewait:
    if (waitpid(child, &status, 0) != child) {
        if (errno == EINTR)
            goto rewait;

C
Cole Robinson 已提交
207
        virSecurityReportError(conn, VIR_ERR_INTERNAL_ERROR,
J
Jamie Strandboge 已提交
208 209 210 211 212 213 214 215 216 217 218 219 220 221 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
                               _("Unexpected exit status from virt-aa-helper "
                               "%d pid %lu"),
                               WEXITSTATUS(status), (unsigned long)child);
        rc = -1;
    }

  clean:
    VIR_FREE(xml);

    if (pipefd[0] > 0)
        close(pipefd[0]);
    if (pipefd[1] > 0)
        close(pipefd[1]);

    return rc;
}

static int
remove_profile(const char *profile)
{
    int rc = -1;
    const char * const argv[] = {
        VIRT_AA_HELPER, "-R", "-u", profile, NULL
    };

    if (virRun(NULL, argv, NULL) == 0)
        rc = 0;

    return rc;
}

static char *
get_profile_name(virConnectPtr conn, virDomainObjPtr vm)
{
    char uuidstr[VIR_UUID_STRING_BUFLEN];
    char *name = NULL;

    virUUIDFormat(vm->def->uuid, uuidstr);
    if (virAsprintf(&name, "%s%s", AA_PREFIX, uuidstr) < 0) {
        virReportOOMError(conn);
        return NULL;
    }

    return name;
}

/* returns -1 on error or profile for libvirtd is unconfined, 0 if complain
 * mode and 1 if enforcing. This is required because at present you cannot
 * aa_change_profile() from a process that is unconfined.
 */
static int
use_apparmor(void)
{
    char libvirt_daemon[PATH_MAX];
    int rc = -1;
    ssize_t len = 0;

    if ((len = readlink("/proc/self/exe", libvirt_daemon,
                        PATH_MAX - 1)) < 0) {
C
Cole Robinson 已提交
267
        virSecurityReportError(NULL, VIR_ERR_INTERNAL_ERROR,
J
Jamie Strandboge 已提交
268 269 270 271 272 273 274 275 276 277 278 279 280 281 282
                               "%s", _("could not find libvirtd"));
        return rc;
    }
    libvirt_daemon[len] = '\0';

    if (access(APPARMOR_PROFILES_PATH, R_OK) != 0)
        return rc;

    return profile_status(libvirt_daemon, 1);
}

/* Called on libvirtd startup to see if AppArmor is available */
static int
AppArmorSecurityDriverProbe(void)
{
J
Jamie Strandboge 已提交
283 284
    char *template = NULL;
    int rc = SECURITY_DRIVER_DISABLE;
J
Jamie Strandboge 已提交
285 286

    if (use_apparmor() < 0)
J
Jamie Strandboge 已提交
287
        return rc;
J
Jamie Strandboge 已提交
288 289

    /* see if template file exists */
J
Jamie Strandboge 已提交
290 291 292 293
    if (virAsprintf(&template, "%s/TEMPLATE",
                               APPARMOR_DIR "/libvirt") == -1) {
        virReportOOMError(NULL);
        return rc;
J
Jamie Strandboge 已提交
294 295 296
    }

    if (!virFileExists(template)) {
C
Cole Robinson 已提交
297
        virSecurityReportError(NULL, VIR_ERR_INTERNAL_ERROR,
J
Jamie Strandboge 已提交
298
                               _("template \'%s\' does not exist"), template);
J
Jamie Strandboge 已提交
299
        goto clean;
J
Jamie Strandboge 已提交
300
    }
J
Jamie Strandboge 已提交
301
    rc = SECURITY_DRIVER_ENABLE;
J
Jamie Strandboge 已提交
302

J
Jamie Strandboge 已提交
303 304 305 306
  clean:
    VIR_FREE(template);

    return rc;
J
Jamie Strandboge 已提交
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
}

/* Security driver initialization. DOI is for 'Domain of Interpretation' and is
 * currently not used.
 */
static int
AppArmorSecurityDriverOpen(virConnectPtr conn, virSecurityDriverPtr drv)
{
    virSecurityDriverSetDOI(conn, drv, SECURITY_APPARMOR_VOID_DOI);
    return 0;
}

/* Currently called in qemudStartVMDaemon to setup a 'label'. We look for and
 * use a profile based on the UUID, otherwise create one based on a template.
 * Keep in mind that this is called on 'start' with RestoreSecurityLabel being
 * called on shutdown.
*/
static int
AppArmorGenSecurityLabel(virConnectPtr conn, virDomainObjPtr vm)
{
    int rc = -1;
    char *profile_name = NULL;

    if ((vm->def->seclabel.label) ||
        (vm->def->seclabel.model) || (vm->def->seclabel.imagelabel)) {
C
Cole Robinson 已提交
332
        virSecurityReportError(conn, VIR_ERR_INTERNAL_ERROR,
J
Jamie Strandboge 已提交
333 334 335 336 337 338 339 340 341 342 343
                               "%s",
                               _("security label already defined for VM"));
        return rc;
    }

    if ((profile_name = get_profile_name(conn, vm)) == NULL)
        return rc;

    /* if the profile is not already loaded, then load one */
    if (profile_loaded(profile_name) < 0) {
        if (load_profile(conn, profile_name, vm, NULL) < 0) {
C
Cole Robinson 已提交
344
            virSecurityReportError(conn, VIR_ERR_INTERNAL_ERROR,
J
Jamie Strandboge 已提交
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
                                   _("cannot generate AppArmor profile "
                                   "\'%s\'"), profile_name);
            goto clean;
        }
    }

    vm->def->seclabel.label = strndup(profile_name, strlen(profile_name));
    if (!vm->def->seclabel.label) {
        virReportOOMError(NULL);
        goto clean;
    }

    /* set imagelabel the same as label (but we won't use it) */
    vm->def->seclabel.imagelabel = strndup(profile_name,
                                           strlen(profile_name));
    if (!vm->def->seclabel.imagelabel) {
        virReportOOMError(NULL);
        goto err;
    }

    vm->def->seclabel.model = strdup(SECURITY_APPARMOR_NAME);
    if (!vm->def->seclabel.model) {
        virReportOOMError(conn);
        goto err;
    }

    rc = 0;
    goto clean;

  err:
    remove_profile(profile_name);
    VIR_FREE(vm->def->seclabel.label);
    VIR_FREE(vm->def->seclabel.imagelabel);
    VIR_FREE(vm->def->seclabel.model);

  clean:
    VIR_FREE(profile_name);

    return rc;
}

/* Seen with 'virsh dominfo <vm>'. This function only called if the VM is
 * running.
 */
static int
AppArmorGetSecurityLabel(virConnectPtr conn,
                         virDomainObjPtr vm, virSecurityLabelPtr sec)
{
    int rc = -1;
    char *profile_name = NULL;

    if ((profile_name = get_profile_name(conn, vm)) == NULL)
        return rc;

    if (virStrcpy(sec->label, profile_name,
        VIR_SECURITY_LABEL_BUFLEN) == NULL) {
C
Cole Robinson 已提交
401
        virSecurityReportError(conn, VIR_ERR_INTERNAL_ERROR,
J
Jamie Strandboge 已提交
402 403 404 405 406
                               "%s", _("error copying profile name"));
        goto clean;
    }

    if ((sec->enforcing = profile_status(profile_name, 1)) < 0) {
C
Cole Robinson 已提交
407
        virSecurityReportError(conn, VIR_ERR_INTERNAL_ERROR,
J
Jamie Strandboge 已提交
408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429
                               "%s", _("error calling profile_status()"));
        goto clean;
    }
    rc = 0;

  clean:
    VIR_FREE(profile_name);

    return rc;
}

/* Called on VM shutdown and destroy. See AppArmorGenSecurityLabel (above) for
 * more details. Currently called via qemudShutdownVMDaemon.
 */
static int
AppArmorRestoreSecurityLabel(virConnectPtr conn, virDomainObjPtr vm)
{
    const virSecurityLabelDefPtr secdef = &vm->def->seclabel;
    int rc = 0;

    if (secdef->imagelabel) {
        if ((rc = remove_profile(secdef->label)) != 0) {
C
Cole Robinson 已提交
430
            virSecurityReportError(conn, VIR_ERR_INTERNAL_ERROR,
J
Jamie Strandboge 已提交
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
                                   _("could not remove profile for \'%s\'"),
                                   secdef->label);
        }
        VIR_FREE(secdef->model);
        VIR_FREE(secdef->label);
        VIR_FREE(secdef->imagelabel);
    }
    return rc;
}

/* Called via virExecWithHook. Output goes to
 * LOCAL_STATE_DIR/log/libvirt/qemu/<vm name>.log
 */
static int
AppArmorSetSecurityLabel(virConnectPtr conn,
                         virSecurityDriverPtr drv, virDomainObjPtr vm)
{
    const virSecurityLabelDefPtr secdef = &vm->def->seclabel;
    int rc = -1;
    char *profile_name = NULL;

    if ((profile_name = get_profile_name(conn, vm)) == NULL)
        return rc;

    if (STRNEQ(drv->name, secdef->model)) {
C
Cole Robinson 已提交
456
        virSecurityReportError(conn, VIR_ERR_INTERNAL_ERROR,
J
Jamie Strandboge 已提交
457 458 459 460 461 462 463 464 465
                               _("security label driver mismatch: "
                               "\'%s\' model configured for domain, but "
                               "hypervisor driver is \'%s\'."),
                               secdef->model, drv->name);
        if (use_apparmor() > 0)
            goto clean;
    }

    if (aa_change_profile(profile_name) < 0) {
C
Cole Robinson 已提交
466
        virSecurityReportError(conn, VIR_ERR_INTERNAL_ERROR,
J
Jamie Strandboge 已提交
467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495
                               _("error calling aa_change_profile()"));
        goto clean;
    }
    rc = 0;

  clean:
    VIR_FREE(profile_name);

    return rc;
}


/* Called when hotplugging */
static int
AppArmorRestoreSecurityImageLabel(virConnectPtr conn,
                                  virDomainObjPtr vm,
                                  virDomainDiskDefPtr disk ATTRIBUTE_UNUSED)
{
    const virSecurityLabelDefPtr secdef = &vm->def->seclabel;
    int rc = -1;
    char *profile_name = NULL;

    if (secdef->imagelabel) {
        if ((profile_name = get_profile_name(conn, vm)) == NULL)
            return rc;

        /* Update the profile only if it is loaded */
        if (profile_loaded(secdef->imagelabel) >= 0) {
            if (load_profile(conn, secdef->imagelabel, vm, NULL) < 0) {
C
Cole Robinson 已提交
496
                virSecurityReportError(conn, VIR_ERR_INTERNAL_ERROR,
J
Jamie Strandboge 已提交
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
                                       _("cannot update AppArmor profile "
                                       "\'%s\'"),
                                       secdef->imagelabel);
                goto clean;
            }
        }
    }
    rc = 0;
  clean:
    VIR_FREE(profile_name);

    return rc;
}

/* Called when hotplugging */
static int
AppArmorSetSecurityImageLabel(virConnectPtr conn,
                              virDomainObjPtr vm, virDomainDiskDefPtr disk)
{
    const virSecurityLabelDefPtr secdef = &vm->def->seclabel;
    int rc = -1;
    char *profile_name;

    if (!disk->src)
        return 0;

    if (secdef->imagelabel) {
        /* if the device doesn't exist, error out */
        if (!virFileExists(disk->src)) {
C
Cole Robinson 已提交
526
            virSecurityReportError(conn, VIR_ERR_INTERNAL_ERROR,
J
Jamie Strandboge 已提交
527 528 529 530 531 532 533 534 535 536
                                   _("\'%s\' does not exist"), disk->src);
            return rc;
        }

        if ((profile_name = get_profile_name(conn, vm)) == NULL)
            return rc;

        /* update the profile only if it is loaded */
        if (profile_loaded(secdef->imagelabel) >= 0) {
            if (load_profile(conn, secdef->imagelabel, vm, disk) < 0) {
C
Cole Robinson 已提交
537
                virSecurityReportError(conn, VIR_ERR_INTERNAL_ERROR,
J
Jamie Strandboge 已提交
538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 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 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610
                                     _("cannot update AppArmor profile "
                                     "\'%s\'"),
                                     secdef->imagelabel);
                goto clean;
            }
        }
    }
    rc = 0;

  clean:
    VIR_FREE(profile_name);

    return rc;
}

static int
AppArmorSecurityVerify(virConnectPtr conn, virDomainDefPtr def)
{
    const virSecurityLabelDefPtr secdef = &def->seclabel;

    if (secdef->type == VIR_DOMAIN_SECLABEL_STATIC) {
        if (use_apparmor() < 0 || profile_status(secdef->label, 0) < 0) {
            virSecurityReportError(conn, VIR_ERR_XML_ERROR,
                                   _("Invalid security label \'%s\'"),
                                   secdef->label);
            return -1;
        }
    }
    return 0;
}

static int
AppArmorReserveSecurityLabel(virConnectPtr conn ATTRIBUTE_UNUSED,
                            virDomainObjPtr vm ATTRIBUTE_UNUSED)
{
    /* NOOP. Nothing to reserve with AppArmor */
    return 0;
}

static int
AppArmorSetSecurityHostdevLabel(virConnectPtr conn ATTRIBUTE_UNUSED,
                                virDomainObjPtr vm ATTRIBUTE_UNUSED,
                                virDomainHostdevDefPtr dev ATTRIBUTE_UNUSED)

{
    /* TODO: call load_profile with an update vm->def */
    return 0;
}

static int
AppArmorRestoreSecurityHostdevLabel(virConnectPtr conn ATTRIBUTE_UNUSED,
                                    virDomainHostdevDefPtr dev ATTRIBUTE_UNUSED)

{
    /* TODO: call load_profile (needs virDomainObjPtr vm) */
    return 0;
}

virSecurityDriver virAppArmorSecurityDriver = {
    .name = SECURITY_APPARMOR_NAME,
    .probe = AppArmorSecurityDriverProbe,
    .open = AppArmorSecurityDriverOpen,
    .domainSecurityVerify = AppArmorSecurityVerify,
    .domainSetSecurityImageLabel = AppArmorSetSecurityImageLabel,
    .domainRestoreSecurityImageLabel = AppArmorRestoreSecurityImageLabel,
    .domainGenSecurityLabel = AppArmorGenSecurityLabel,
    .domainReserveSecurityLabel = AppArmorReserveSecurityLabel,
    .domainGetSecurityLabel = AppArmorGetSecurityLabel,
    .domainRestoreSecurityLabel = AppArmorRestoreSecurityLabel,
    .domainSetSecurityLabel = AppArmorSetSecurityLabel,
    .domainSetSecurityHostdevLabel = AppArmorSetSecurityHostdevLabel,
    .domainRestoreSecurityHostdevLabel = AppArmorRestoreSecurityHostdevLabel,
};