From: Samuel Mendoza-Jonas Date: Thu, 10 May 2018 05:48:21 +0000 (+1000) Subject: discover/pxe-parser: Parse simple iPXE scripts X-Git-Tag: v1.9.0~54 X-Git-Url: http://git.ozlabs.org/?p=petitboot;a=commitdiff_plain;h=d30872fe40c87300e62ef2aea484b9cea618c9de;ds=sidebyside discover/pxe-parser: Parse simple iPXE scripts Signed-off-by: Samuel Mendoza-Jonas --- diff --git a/discover/pxe-parser.c b/discover/pxe-parser.c index 470dd83..9221f95 100644 --- a/discover/pxe-parser.c +++ b/discover/pxe-parser.c @@ -259,6 +259,97 @@ static void pxe_load_next_filename(struct conf_context *conf) return; } +/* + * Parse a limited set of iPXE commands. This is handled separately from + * conf_parse_buf() since not all commands will have a value. + */ +static bool ipxe_simple_parser(struct conf_context *ctx, char *buf, int len) +{ + struct discover_boot_option *opt; + char *p, *name, *value; + struct pb_url *url; + + p = strstr(buf, "#!ipxe"); + + /* Only try to parse this if the ipxe header is right at the start */ + if (!p || p != buf) + return false; + p = strchr(buf, '\n') + 1; + + opt = discover_boot_option_create(ctx->dc, ctx->dc->device); + + opt->option->id = talloc_asprintf(opt, "%s@%p", + ctx->dc->device->device->id, opt); + opt->option->type = DISCOVER_BOOT_OPTION; + + while (p && p <= buf + len) { + + p = conf_get_pair(ctx, p, &name, &value, ' ', '\n'); + + /* The 'boot' command appears by itself without options */ + if (!name && value && streq(value, "boot")) { + opt->option->is_default = true; + continue; + } + + /* All other parameters require a value */ + if (!value) { + pb_debug("%s: '%s' missing value\n", __func__, name); + continue; + } + + if (streq(name, "kernel")) { + char *args, *name = NULL, *saveptr = NULL, *tmp; + + /* + * value is of the form: + * boot_image [--name option_name ] [option args ...] + */ + tmp = strtok_r(value, " ", &saveptr); + if (!tmp) { + pb_log("%s: malformed kernel statement\n", __func__); + break; + } + + url = pxe_url_join(ctx->dc, ctx->dc->conf_url, tmp); + opt->boot_image = create_url_resource(opt, url); + + tmp = strtok_r(NULL, " ", &saveptr); + if (!tmp) + continue; + if (streq(tmp, "--name")) { + tmp = strtok_r(NULL, " ", &saveptr); + name = talloc_asprintf(opt, "%s", + tmp ?: "malformed ipxe option"); + args = strtok_r(NULL, " ", &saveptr); + } else + args = tmp; + + while (args) { + pxe_append_string(opt, args); + args = strtok_r(NULL, " ", &saveptr); + } + + opt->option->name = name ?: talloc_asprintf(opt, + "ipxe option (%s)", url->full); + continue; + } + + if (streq(name, "initrd")) { + url = pxe_url_join(ctx->dc, ctx->dc->conf_url, value); + opt->initrd = create_url_resource(opt, url); + continue; + } + } + + if (opt->boot_image) + discover_context_add_boot_option(ctx->dc, opt); + else + pb_debug("ipxe file did not contain a valid option\n"); + + return true; +} + /* * Callback for asynchronous loads from pxe_parse() * @param result Result of load_url_async() @@ -309,9 +400,10 @@ static void pxe_conf_parse_cb(struct load_url_result *result, void *data) * Parse the first successfully downloaded file. We only want to parse * the first because otherwise we could parse options from both a * machine-specific config and a 'fallback' default config + * We also check if the file is in the limited ipxe format. */ - - conf_parse_buf(conf, buf, len); + if (!ipxe_simple_parser(conf, buf, len)) + conf_parse_buf(conf, buf, len); /* We may be called well after the original caller of iterate_parsers(), * commit any new boot options ourselves */ diff --git a/test/parser/Makefile.am b/test/parser/Makefile.am index 6ff3972..1732158 100644 --- a/test/parser/Makefile.am +++ b/test/parser/Makefile.am @@ -64,6 +64,9 @@ parser_TESTS = \ test/parser/test-pxe-initrd-in-append \ test/parser/test-pxe-mac-without-conf \ test/parser/test-pxe-ip-without-conf \ + test/parser/test-pxe-ipxe \ + test/parser/test-pxe-ipxe-named \ + test/parser/test-pxe-ipxe-default \ test/parser/test-pxe-non-url-conf \ test/parser/test-pxe-local \ test/parser/test-pxe-ipappend \ diff --git a/test/parser/test-pxe-ipxe-default.c b/test/parser/test-pxe-ipxe-default.c new file mode 100644 index 0000000..d80cc41 --- /dev/null +++ b/test/parser/test-pxe-ipxe-default.c @@ -0,0 +1,40 @@ +#include "parser-test.h" + +#if 0 /* PARSER_EMBEDDED_CONFIG */ +#!ipxe +kernel vmlinux --name test-option +initrd initrd +boot +#endif + +/** + * Test that we recognise an ipxe-formatted script obtained from bootfile_url + * (DHCPv6 option 59) that some vendors use, and that we set it as default. + */ + +void run_test(struct parser_test *test) +{ + struct discover_boot_option *opt; + struct discover_context *ctx; + + test_read_conf_embedded_url(test, "tftp://host/dir1/conf"); + + test_set_event_source(test); + test_set_event_param(test->ctx->event, "bootfile_url", "tftp://host/dir1/conf"); + + test_run_parser(test, "pxe"); + + ctx = test->ctx; + + check_boot_option_count(ctx, 1); + opt = get_boot_option(ctx, 0); + + check_name(opt, "test-option"); + + check_resolved_url_resource(opt->boot_image, + "tftp://host/dir1/vmlinux"); + check_resolved_url_resource(opt->initrd, + "tftp://host/dir1/initrd"); + check_args(opt, NULL); + check_is_default(opt); +} diff --git a/test/parser/test-pxe-ipxe-named.c b/test/parser/test-pxe-ipxe-named.c new file mode 100644 index 0000000..dae2fc6 --- /dev/null +++ b/test/parser/test-pxe-ipxe-named.c @@ -0,0 +1,39 @@ +#include "parser-test.h" + +#if 0 /* PARSER_EMBEDDED_CONFIG */ +#!ipxe +kernel vmlinux --name test-option append kernel args +initrd initrd +#endif + +/** + * Test that we recognise an ipxe-formatted script obtained from bootfile_url + * (DHCPv6 option 59) that some vendors use, and that we correctly parse the + * --name parameter from the kernel arguments. + */ + +void run_test(struct parser_test *test) +{ + struct discover_boot_option *opt; + struct discover_context *ctx; + + test_read_conf_embedded_url(test, "tftp://host/dir1/conf"); + + test_set_event_source(test); + test_set_event_param(test->ctx->event, "bootfile_url", "tftp://host/dir1/conf"); + + test_run_parser(test, "pxe"); + + ctx = test->ctx; + + check_boot_option_count(ctx, 1); + opt = get_boot_option(ctx, 0); + + check_name(opt, "test-option"); + + check_resolved_url_resource(opt->boot_image, + "tftp://host/dir1/vmlinux"); + check_resolved_url_resource(opt->initrd, + "tftp://host/dir1/initrd"); + check_args(opt, "append kernel args"); +} diff --git a/test/parser/test-pxe-ipxe.c b/test/parser/test-pxe-ipxe.c new file mode 100644 index 0000000..e3bc202 --- /dev/null +++ b/test/parser/test-pxe-ipxe.c @@ -0,0 +1,40 @@ + + +#include "parser-test.h" + +#if 0 /* PARSER_EMBEDDED_CONFIG */ +#!ipxe +kernel vmlinux append kernel args +initrd initrd +#endif + +/** + * Test that we recognise an ipxe-formatted script obtained from bootfile_url + * (DHCPv6 option 59) that some vendors use. + */ + +void run_test(struct parser_test *test) +{ + struct discover_boot_option *opt; + struct discover_context *ctx; + + test_read_conf_embedded_url(test, "tftp://host/dir1/conf"); + + test_set_event_source(test); + test_set_event_param(test->ctx->event, "bootfile_url", "tftp://host/dir1/conf"); + + test_run_parser(test, "pxe"); + + ctx = test->ctx; + + check_boot_option_count(ctx, 1); + opt = get_boot_option(ctx, 0); + + check_name(opt, "ipxe option (tftp://host/dir1/vmlinux)"); + + check_resolved_url_resource(opt->boot_image, + "tftp://host/dir1/vmlinux"); + check_resolved_url_resource(opt->initrd, + "tftp://host/dir1/initrd"); + check_args(opt, "append kernel args"); +}