Support new boot override setting design

Add support for the new boot override setting design that was pushed
in the commit: "phosphor-settings-manager: redesign boot setting
override feature" (openbmc/openbmc/+/44226).
The new design not only simplifies boot override settings handling,
but also removes interdependency between BootType/BootSource/
BootMode parameters that was present in the handling code.

In the old design there wasn't any place to encode boot override
disabled state on a Dbus. Therefore bmcweb used implicit mapping of
boot parameters to address the problem of encoding disabled override
state:
"BootSourceOverrideEnabled=Disabled" =
"BootSourceOverrideMode=UEFI" + "BootSourceOverrideTarget=None"
But with this approach if you set:
"BootSourceOverrideEnabled=Once"
"BootSourceOverrideMode=UEFI"
"BootSourceOverrideTarget=None"
You would later read:
"BootSourceOverrideEnabled=Disabled"
"BootSourceOverrideMode=UEFI"
"BootSourceOverrideTarget=None"
Which is not what is expected.

Also this interdependency between boot parameters complicates the code.
For example if we only try to set the boot mode, we need also to check
the boot target and probably set the boot enabled state. If we only try
to read boot enabled, we also need to check boot mode and boot target.
This is also not good.

In the new design there is a specific Dbus interface that is used to
store overall override enabled state. With it is possible to remove the
implicit mapping of boot parameters to disabled state and remove the
unnecessary interdependency between the boot override parameters.

Also now with the help of "Support all parameter combinations in
Redfish boot tests" (openbmc-test-automation/+/44225) it it possible to
test for all combinations of boot override parameters.

Tested with the openbmc-test-automation with the aforementioned patch
applied (openbmc-test-automation/+/44225) with "boot_type" feature
present:
  robot -v PLATFORM_ARCH_TYPE:x86 \
        -v OPENBMC_HOST:<BMC IP> \
        redfish/systems/test_boot_devices.robot

Also tested with the openbmc-test-automation with the aforementioned
patch applied (openbmc-test-automation/+/44225) without "boot_type"
feature present:
  robot -v OPENBMC_HOST:<BMC IP> \
        redfish/systems/test_boot_devices.robot

More information about boot source override design differences can be
found at the mailing list discussions:
https://lists.ozlabs.org/pipermail/openbmc/2021-May/026533.html
and
https://lists.ozlabs.org/pipermail/openbmc/2021-June/026759.html

Signed-off-by: Konstantin Aladyshev <aladyshev22@gmail.com>
Change-Id: Id0b24b37a4519a2efbb97da597858c295d7c6c27
Signed-off-by: Konstantin Aladyshev <aladyshev22@gmail.com>
1 file changed
tree: f77a6039f79ffc0619c5eaeea2eea7e73af3100a
  1. .github/
  2. http/
  3. include/
  4. redfish-core/
  5. scripts/
  6. src/
  7. static/
  8. subprojects/
  9. .clang-format
  10. .clang-ignore
  11. .clang-tidy
  12. .dockerignore
  13. .gitignore
  14. .shellcheck
  15. bmcweb.service.in
  16. bmcweb.socket.in
  17. bmcweb_config.h.in
  18. build_x86.sh
  19. build_x86_docker.sh
  20. COMMON_ERRORS.md
  21. DEVELOPING.md
  22. Dockerfile
  23. Dockerfile.base
  24. LICENSE
  25. MAINTAINERS
  26. meson.build
  27. meson_options.txt
  28. OEM_SCHEMAS.md
  29. OWNERS
  30. pam-webserver
  31. README.md
  32. Redfish.md
README.md

OpenBMC webserver

This component attempts to be a "do everything" embedded webserver for openbmc.

Capabilities

At this time, the webserver implements a few interfaces:

  • Authentication middleware that supports cookie and token based authentication, as well as CSRF prevention backed by linux PAM authentication credentials.
  • An (incomplete) attempt at replicating phosphor-dbus-rest interfaces in C++. Right now, a few of the endpoint definitions work as expected, but there is still a lot of work to be done. The portions of the interface that are functional are designed to work correctly for phosphor-webui, but may not yet be complete.
  • Replication of the rest-dbus backend interfaces to allow bmc debug to logged in users.
  • An initial attempt at a read-only redfish interface. Currently the redfish interface targets ServiceRoot, SessionService, AccountService, Roles, and ManagersService. Some functionality here has been shimmed to make development possible. For example, there exists only a single user role.
  • SSL key generation at runtime. See the configuration section for details.
  • Static file hosting. Currently, static files are hosted from the fixed location at /usr/share/www. This is intended to allow loose coupling with yocto projects, and allow overriding static files at build time.
  • Dbus-monitor over websocket. A generic endpoint that allows UIs to open a websocket and register for notification of events to avoid polling in single page applications. (this interface may be modified in the future due to security concerns.

Configuration

BMCWeb is configured by setting -D flags that correspond to options in bmcweb/meson_options.txt and then compiling. For example, meson <builddir> -Dkvm=disabled ... followed by ninja in build directory. The option names become C++ preprocessor symbols that control which code is compiled into the program.

Compile bmcweb with default options:

meson builddir
ninja -C builddir

Compile bmcweb with yocto defaults:

meson builddir -Dbuildtype=minsize -Db_lto=true -Dtests=disabled
ninja -C buildir

If any of the dependencies are not found on the host system during configuration, meson automatically gets them via its wrap dependencies mentioned in bmcweb/subprojects.

Enable/Disable meson wrap feature

meson builddir -Dwrap_mode=nofallback
ninja -C builddir

Enable debug traces

meson builddir -Dbuildtype=debug
ninja -C builddir

Generate test coverage report:

meson builddir -Db_coverage=true -Dtests=enabled
ninja coverage -C builddir test

When BMCWeb starts running, it reads persistent configuration data (such as UUID and session data) from a local file. If this is not usable, it generates a new configuration.

When BMCWeb SSL support is enabled and a usable certificate is not found, it will generate a self-sign a certificate before launching the server. The keys are generated by the secp384r1 algorithm. The certificate

  • is issued by C=US, O=OpenBMC, CN=testhost,
  • is valid for 10 years,
  • has a random serial number, and
  • is signed using the SHA-256 algorithm.