esx_util.c 15.4 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 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39

/*
 * esx_util.c: utility methods for the VMware ESX driver
 *
 * Copyright (C) 2009 Matthias Bolte <matthias.bolte@googlemail.com>
 * Copyright (C) 2009 Maximilian Wilhelm <max@rfc2324.org>
 *
 * 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.
 *
 * 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, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
 *
 */

#include <config.h>

#include <netdb.h>

#include "internal.h"
#include "virterror_internal.h"
#include "datatypes.h"
#include "qparams.h"
#include "util.h"
#include "memory.h"
#include "logging.h"
#include "uuid.h"
#include "esx_util.h"

#define VIR_FROM_THIS VIR_FROM_ESX

40 41 42
#define ESX_ERROR(code, fmt...)                                              \
    virReportErrorHelper(NULL, VIR_FROM_ESX, code, __FILE__, __FUNCTION__,   \
                         __LINE__, fmt)
43

44 45 46 47
/* AI_ADDRCONFIG is missing on some systems. */
#ifndef AI_ADDRCONFIG
# define AI_ADDRCONFIG 0
#endif
48 49


50

51
char *
M
Matthias Bolte 已提交
52
esxUtil_RequestUsername(virConnectAuthPtr auth, const char *defaultUsername,
53
                        const char *hostname)
54 55 56 57 58 59 60
{
    unsigned int ncred;
    virConnectCredential cred;
    char *prompt = NULL;

    memset(&cred, 0, sizeof(virConnectCredential));

61
    if (virAsprintf(&prompt, "Enter username for %s [%s]", hostname,
M
Matthias Bolte 已提交
62
                    defaultUsername) < 0) {
63 64 65 66 67 68 69 70 71 72
        return NULL;
    }

    for (ncred = 0; ncred < auth->ncredtype; ncred++) {
        if (auth->credtype[ncred] != VIR_CRED_AUTHNAME) {
            continue;
        }

        cred.type = VIR_CRED_AUTHNAME;
        cred.prompt = prompt;
73
        cred.challenge = hostname;
M
Matthias Bolte 已提交
74
        cred.defresult = defaultUsername;
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93
        cred.result = NULL;
        cred.resultlen = 0;

        if ((*(auth->cb))(&cred, 1, auth->cbdata) < 0) {
            VIR_FREE(cred.result);
        }

        break;
    }

    VIR_FREE(prompt);

    return cred.result;
}



char *
esxUtil_RequestPassword(virConnectAuthPtr auth, const char *username,
94
                        const char *hostname)
95 96 97 98 99 100 101 102
{
    unsigned int ncred;
    virConnectCredential cred;
    char *prompt;

    memset(&cred, 0, sizeof(virConnectCredential));

    if (virAsprintf(&prompt, "Enter %s password for %s", username,
103
                    hostname) < 0) {
104 105 106 107 108 109 110 111 112 113 114
        return NULL;
    }

    for (ncred = 0; ncred < auth->ncredtype; ncred++) {
        if (auth->credtype[ncred] != VIR_CRED_PASSPHRASE &&
            auth->credtype[ncred] != VIR_CRED_NOECHOPROMPT) {
            continue;
        }

        cred.type = auth->credtype[ncred];
        cred.prompt = prompt;
115
        cred.challenge = hostname;
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134
        cred.defresult = NULL;
        cred.result = NULL;
        cred.resultlen = 0;

        if ((*(auth->cb))(&cred, 1, auth->cbdata) < 0) {
            VIR_FREE(cred.result);
        }

        break;
    }

    VIR_FREE(prompt);

    return cred.result;
}



int
135
esxUtil_ParseQuery(xmlURIPtr uri, char **transport, char **vCenter,
136
                   int *noVerify, int *autoAnswer)
137 138 139 140 141 142 143 144 145 146
{
    int result = 0;
    int i;
    struct qparam_set *queryParamSet = NULL;
    struct qparam *queryParam = NULL;

    if (transport != NULL) {
        *transport = NULL;
    }

M
Matthias Bolte 已提交
147 148
    if (vCenter != NULL) {
        *vCenter = NULL;
149 150
    }

151 152 153 154 155 156 157 158
    if (noVerify != NULL) {
        *noVerify = 0;
    }

    if (autoAnswer != NULL) {
        *autoAnswer = 0;
    }

159
#ifdef HAVE_XMLURI_QUERY_RAW
160
    queryParamSet = qparam_query_parse(uri->query_raw);
161
#else
162
    queryParamSet = qparam_query_parse(uri->query);
163 164 165 166 167 168 169 170 171
#endif

    if (queryParamSet == NULL) {
        goto failure;
    }

    for (i = 0; i < queryParamSet->n; i++) {
        queryParam = &queryParamSet->p[i];

172 173 174 175 176
        if (STRCASEEQ(queryParam->name, "transport")) {
            if (transport == NULL) {
                continue;
            }

177 178 179
            *transport = strdup(queryParam->value);

            if (*transport == NULL) {
180
                virReportOOMError(NULL);
181 182 183 184
                goto failure;
            }

            if (STRNEQ(*transport, "http") && STRNEQ(*transport, "https")) {
185
                ESX_ERROR(VIR_ERR_INVALID_ARG,
186 187 188 189
                          "Query parameter 'transport' has unexpected value "
                          "'%s' (should be http|https)", *transport);
                goto failure;
            }
190 191 192 193 194
        } else if (STRCASEEQ(queryParam->name, "vcenter")) {
            if (vCenter == NULL) {
                continue;
            }

M
Matthias Bolte 已提交
195
            *vCenter = strdup(queryParam->value);
196

M
Matthias Bolte 已提交
197
            if (*vCenter == NULL) {
198
                virReportOOMError(NULL);
199 200
                goto failure;
            }
201 202 203 204 205
        } else if (STRCASEEQ(queryParam->name, "no_verify")) {
            if (noVerify == NULL) {
                continue;
            }

206 207
            if (virStrToLong_i(queryParam->value, NULL, 10, noVerify) < 0 ||
                (*noVerify != 0 && *noVerify != 1)) {
208
                ESX_ERROR(VIR_ERR_INVALID_ARG,
209 210 211 212
                          "Query parameter 'no_verify' has unexpected value "
                          "'%s' (should be 0 or 1)", queryParam->value);
                goto failure;
            }
213 214 215 216 217 218 219
        } else if (STRCASEEQ(queryParam->name, "auto_answer")) {
            if (autoAnswer == NULL) {
                continue;
            }

            if (virStrToLong_i(queryParam->value, NULL, 10, autoAnswer) < 0 ||
                (*autoAnswer != 0 && *autoAnswer != 1)) {
220
                ESX_ERROR(VIR_ERR_INVALID_ARG,
221 222 223 224
                          "Query parameter 'auto_answer' has unexpected value "
                          "'%s' (should be 0 or 1)", queryParam->value);
                goto failure;
            }
225 226 227 228 229 230 231 232 233 234
        } else {
            VIR_WARN("Ignoring unexpected query parameter '%s'",
                     queryParam->name);
        }
    }

    if (transport != NULL && *transport == NULL) {
        *transport = strdup("https");

        if (*transport == NULL) {
235
            virReportOOMError(NULL);
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251
            goto failure;
        }
    }

  cleanup:
    if (queryParamSet != NULL) {
        free_qparam_set(queryParamSet);
    }

    return result;

  failure:
    if (transport != NULL) {
        VIR_FREE(*transport);
    }

M
Matthias Bolte 已提交
252 253
    if (vCenter != NULL) {
        VIR_FREE(*vCenter);
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
    }

    result = -1;

    goto cleanup;
}



int
esxUtil_ParseVirtualMachineIDString(const char *id_string, int *id)
{
    /* Try to parse an integer from the complete string. */
    if (virStrToLong_i(id_string, NULL, 10, id) == 0) {
        return 0;
    }

    /*
     * If that fails try to parse an integer from the string tail
     * assuming the naming scheme Virtual Center seems to use.
     */
    if (STRPREFIX(id_string, "vm-")) {
        if (virStrToLong_i(id_string + 3, NULL, 10, id) == 0) {
            return 0;
        }
    }

    return -1;
}



M
Matthias Bolte 已提交
286
int
287
esxUtil_ParseDatastoreRelatedPath(const char *datastoreRelatedPath,
M
Matthias Bolte 已提交
288 289 290 291 292 293 294 295 296 297
                                  char **datastoreName,
                                  char **directoryName, char **fileName)
{
    int result = 0;
    char *directoryAndFileName = NULL;
    char *separator = NULL;

    if (datastoreName == NULL || *datastoreName != NULL ||
        directoryName == NULL || *directoryName != NULL ||
        fileName == NULL || *fileName != NULL) {
298
        ESX_ERROR(VIR_ERR_INTERNAL_ERROR, "Invalid argument");
299
        return -1;
M
Matthias Bolte 已提交
300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317
    }

    /*
     * Parse string as '[<datastore>] <path>'. '%as' is similar to '%s', but
     * sscanf() will allocate the memory for the string, so the caller doesn't
     * need to preallocate a buffer that's large enough.
     *
     * The s in '%as' can be replaced with a character set, e.g. [a-z].
     *
     * '%a[^]%]' matches <datastore>. '[^]%]' excludes ']' from the accepted
     * characters, otherwise sscanf() wont match what it should.
     *
     * '%a[^\n]' matches <path>. '[^\n]' excludes '\n' from the accepted
     * characters, otherwise sscanf() would only match up to the first space,
     * but spaces are valid in <path>.
     */
    if (sscanf(datastoreRelatedPath, "[%a[^]%]] %a[^\n]", datastoreName,
               &directoryAndFileName) != 2) {
318
        ESX_ERROR(VIR_ERR_INTERNAL_ERROR,
M
Matthias Bolte 已提交
319 320 321 322 323 324 325 326 327 328 329 330 331 332 333
                  "Datastore related path '%s' doesn't have expected format "
                  "'[<datastore>] <path>'", datastoreRelatedPath);
        goto failure;
    }

    /* Split <path> into <directory>/<file>, where <directory> is optional */
    separator = strrchr(directoryAndFileName, '/');

    if (separator != NULL) {
        *separator++ = '\0';

        *directoryName = directoryAndFileName;
        directoryAndFileName = NULL;

        if (*separator == '\0') {
334
            ESX_ERROR(VIR_ERR_INTERNAL_ERROR,
M
Matthias Bolte 已提交
335 336 337 338 339 340 341 342
                      "Datastore related path '%s' doesn't reference a file",
                      datastoreRelatedPath);
            goto failure;
        }

        *fileName = strdup(separator);

        if (*fileName == NULL) {
343
            virReportOOMError(NULL);
M
Matthias Bolte 已提交
344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367
            goto failure;
        }
    } else {
        *fileName = directoryAndFileName;
        directoryAndFileName = NULL;
    }

  cleanup:
    VIR_FREE(directoryAndFileName);

    return result;

  failure:
    VIR_FREE(*datastoreName);
    VIR_FREE(*directoryName);
    VIR_FREE(*fileName);

    result = -1;

    goto cleanup;
}



368
int
369
esxUtil_ResolveHostname(const char *hostname,
M
Matthias Bolte 已提交
370
                        char *ipAddress, size_t ipAddress_length)
371 372 373 374 375
{
    struct addrinfo hints;
    struct addrinfo *result = NULL;
    int errcode;

M
Matthias Bolte 已提交
376
    memset(&hints, 0, sizeof(struct addrinfo));
377 378 379 380 381 382 383 384 385

    hints.ai_flags = AI_ADDRCONFIG;
    hints.ai_family = AF_INET;
    hints.ai_socktype = SOCK_STREAM;
    hints.ai_protocol = 0;

    errcode = getaddrinfo(hostname, NULL, &hints, &result);

    if (errcode != 0) {
386
        ESX_ERROR(VIR_ERR_INTERNAL_ERROR,
387 388 389 390 391 392
                  "IP address lookup for host '%s' failed: %s", hostname,
                  gai_strerror(errcode));
        return -1;
    }

    if (result == NULL) {
393
        ESX_ERROR(VIR_ERR_INTERNAL_ERROR,
394 395 396 397 398
                  "No IP address for host '%s' found: %s", hostname,
                  gai_strerror(errcode));
        return -1;
    }

M
Matthias Bolte 已提交
399 400
    errcode = getnameinfo(result->ai_addr, result->ai_addrlen, ipAddress,
                          ipAddress_length, NULL, 0, NI_NUMERICHOST);
401 402

    if (errcode != 0) {
403
        ESX_ERROR(VIR_ERR_INTERNAL_ERROR,
404 405 406 407 408 409 410 411 412 413 414 415 416 417
                  "Formating IP address for host '%s' failed: %s", hostname,
                  gai_strerror(errcode));
        freeaddrinfo(result);
        return -1;
    }

    freeaddrinfo(result);

    return 0;
}



int
418 419
esxUtil_GetConfigString(virConfPtr conf, const char *name, char **string,
                        int optional)
420 421 422 423 424 425 426 427 428 429 430
{
    virConfValuePtr value;

    *string = NULL;
    value = virConfGetValue(conf, name);

    if (value == NULL) {
        if (optional) {
            return 0;
        }

431
        ESX_ERROR(VIR_ERR_INTERNAL_ERROR,
432 433 434 435 436
                  "Missing essential config entry '%s'", name);
        return -1;
    }

    if (value->type != VIR_CONF_STRING) {
437
        ESX_ERROR(VIR_ERR_INTERNAL_ERROR,
438 439 440 441 442 443 444 445 446
                  "Config entry '%s' must be a string", name);
        return -1;
    }

    if (value->str == NULL) {
        if (optional) {
            return 0;
        }

447
        ESX_ERROR(VIR_ERR_INTERNAL_ERROR,
448 449 450 451 452 453 454
                  "Missing essential config entry '%s'", name);
        return -1;
    }

    *string = strdup(value->str);

    if (*string == NULL) {
455
        virReportOOMError(NULL);
456 457 458 459 460 461 462 463 464
        return -1;
    }

    return 0;
}



int
465 466
esxUtil_GetConfigUUID(virConfPtr conf, const char *name, unsigned char *uuid,
                      int optional)
467 468 469 470 471 472 473 474 475
{
    virConfValuePtr value;

    value = virConfGetValue(conf, name);

    if (value == NULL) {
        if (optional) {
            return 0;
        } else {
476
            ESX_ERROR(VIR_ERR_INTERNAL_ERROR,
477 478 479 480 481 482
                      "Missing essential config entry '%s'", name);
            return -1;
        }
    }

    if (value->type != VIR_CONF_STRING) {
483
        ESX_ERROR(VIR_ERR_INTERNAL_ERROR,
484 485 486 487 488 489 490 491
                  "Config entry '%s' must be a string", name);
        return -1;
    }

    if (value->str == NULL) {
        if (optional) {
            return 0;
        } else {
492
            ESX_ERROR(VIR_ERR_INTERNAL_ERROR,
493 494 495 496 497
                      "Missing essential config entry '%s'", name);
            return -1;
        }
    }

498
    if (virUUIDParse(value->str, uuid) < 0) {
499
        ESX_ERROR(VIR_ERR_INTERNAL_ERROR,
500 501 502
                  "Could not parse UUID from string '%s'", value->str);
        return -1;
    }
503 504 505 506 507 508 509

    return 0;
}



int
510 511
esxUtil_GetConfigLong(virConfPtr conf, const char *name, long long *number,
                      long long default_, int optional)
512 513 514 515 516 517 518 519 520 521
{
    virConfValuePtr value;

    *number = default_;
    value = virConfGetValue(conf, name);

    if (value == NULL) {
        if (optional) {
            return 0;
        } else {
522
            ESX_ERROR(VIR_ERR_INTERNAL_ERROR,
523 524 525 526 527 528 529 530 531 532
                      "Missing essential config entry '%s'", name);
            return -1;
        }
    }

    if (value->type == VIR_CONF_STRING) {
        if (value->str == NULL) {
            if (optional) {
                return 0;
            } else {
533
                ESX_ERROR(VIR_ERR_INTERNAL_ERROR,
534 535 536 537 538 539 540 541
                          "Missing essential config entry '%s'", name);
                return -1;
            }
        }

        if (STREQ(value->str, "unlimited")) {
            *number = -1;
        } else if (virStrToLong_ll(value->str, NULL, 10, number) < 0) {
542
            ESX_ERROR(VIR_ERR_INTERNAL_ERROR,
543 544 545 546 547
                      "Config entry '%s' must represent an integer value",
                      name);
            return -1;
        }
    } else {
548
        ESX_ERROR(VIR_ERR_INTERNAL_ERROR,
549 550 551 552 553 554 555 556 557 558
                  "Config entry '%s' must be a string", name);
        return -1;
    }

    return 0;
}



int
559 560
esxUtil_GetConfigBoolean(virConfPtr conf, const char *name, int *boolean_,
                         int default_, int optional)
561 562 563
{
    virConfValuePtr value;

M
Matthias Bolte 已提交
564
    *boolean_ = default_;
565 566 567 568 569 570
    value = virConfGetValue(conf, name);

    if (value == NULL) {
        if (optional) {
            return 0;
        } else {
571
            ESX_ERROR(VIR_ERR_INTERNAL_ERROR,
572 573 574 575 576 577 578 579 580 581
                      "Missing essential config entry '%s'", name);
            return -1;
        }
    }

    if (value->type == VIR_CONF_STRING) {
        if (value->str == NULL) {
            if (optional) {
                return 0;
            } else {
582
                ESX_ERROR(VIR_ERR_INTERNAL_ERROR,
583 584 585 586 587 588
                          "Missing essential config entry '%s'", name);
                return -1;
            }
        }

        if (STRCASEEQ(value->str, "true")) {
M
Matthias Bolte 已提交
589
            *boolean_ = 1;
590
        } else if (STRCASEEQ(value->str, "false")) {
M
Matthias Bolte 已提交
591
            *boolean_ = 0;
592
        } else {
593
            ESX_ERROR(VIR_ERR_INTERNAL_ERROR,
594 595 596 597 598
                      "Config entry '%s' must represent a boolean value "
                      "(true|false)", name);
            return -1;
        }
    } else {
599
        ESX_ERROR(VIR_ERR_INTERNAL_ERROR,
600 601 602 603 604 605
                  "Config entry '%s' must be a string", name);
        return -1;
    }

    return 0;
}