Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / 2c615dffdb6baf7e0bdd5772a39f4b97d1e38a2c
commit2c615dffdb6baf7e0bdd5772a39f4b97d1e38a2c[log] [tgz]
authorEd Tanous <edtanous@google.com>Mon May 16 13:51:10 2022 -0700
committerEd Tanous <ed@tanous.net>Sun Jun 12 16:34:54 2022 +0000
tree5ab76618f27f6721abfa41e1bd86e6cbbbc7979d
parent7b7f04104bb3d4e8dd20fa0e338a3e7a5ae3d9fa [diff]
Add initial documentation about bmcweb clients

bmcweb has a number of clients that it interacts with.  Many times there
have been questions about what clients are available to test with, and
what the expected level of compatibility is.

This commit attempts to start documenting it.  It should not be
considered complete, but aims to start documenting what the expected
level of support one could expect when running the matrix of bmcweb vs
particular clients, and, as we get more evolved, what the status is for
the CI integration of said clients tests.

Signed-off-by: Ed Tanous <edtanous@google.com>
Change-Id: Ifdb34b951d366a74d7255ce41a6df12532f22b2f
1 file changed
tree: 5ab76618f27f6721abfa41e1bd86e6cbbbc7979d
  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. CLIENTS.md
  21. COMMON_ERRORS.md
  22. DEVELOPING.md
  23. Dockerfile
  24. Dockerfile.base
  25. HEADERS.md
  26. LICENSE
  27. MAINTAINERS
  28. meson.build
  29. meson_options.txt
  30. OEM_SCHEMAS.md
  31. OWNERS
  32. pam-webserver
  33. README.md
  34. Redfish.md
  35. run-ci
  36. setup.cfg
  37. 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.