Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / 0cd5f786f5e8bcf5facb88d542bad3f7332da586
commit0cd5f786f5e8bcf5facb88d542bad3f7332da586[log] [tgz]
authorEd Tanous <edtanous@google.com>Tue Apr 26 16:09:09 2022 -0700
committerEd Tanous <ed@tanous.net>Wed May 04 15:35:28 2022 +0000
tree80abe5420b65f3ddfea0833498cadd1cc7c01666
parentf12b57b27157418bbc2c1bf96f1d1cd9db52739b [diff]
Fix whitespacing on meson_options.txt

The meson_options.txt file is difficult to read and maintain because it
has inconsistent whitespace, lines that are far longer than fit on a
single monitor, and inline strings that are inconsistent.

This commit fixes those, moving the syntax to use newlines for each
option method key value, no space on the key colon, and wraps
description strings using mesons multi-line syntax on 80 character
boundaries.

Doing this should make this file more maintainable in the future, and
helps people to review, and read it better than previously.

The intent is that this patchset has no functional changes, only
whitespace and non-enforcing string manipulation, with one exception.
Anywhere we noted a redfish path, we used escaped single quotes.
Multiline strings in meson don't support escaping, so in lieu of worse
alternatives, the quoting was removed, which inline with this patch,
continues to improve the readability of the file.

Tested:
Code builds.   No functional changes.

Signed-off-by: Ed Tanous <edtanous@google.com>
Change-Id: I04f3e31e364bcd3d4b09a219afff21a8eaabc463
1 file changed
tree: 80abe5420b65f3ddfea0833498cadd1cc7c01666
  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
  33. run-ci
  34. setup.cfg
  35. TESTING.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 -C builddir test
ninja -C builddir coverage

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.