Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / ceeba4f9684be6b705568718d9a1afd5886989cd
commitceeba4f9684be6b705568718d9a1afd5886989cd[log] [tgz]
authorEd Tanous <edtanous@google.com>Mon May 16 14:59:33 2022 -0700
committerEd Tanous <ed@tanous.net>Thu Jun 23 21:55:53 2022 +0000
tree1187315e5af9ae82c5d87405e521a11aed49d79a
parentf1eac5775ed6593fe7148118304bdecec08af1ef [diff]
Start to document maintainer responsibilities

In the past, a number of contributors have inquired about what bmcweb
maintainers do, and how they can become one.  As bmcweb grows in
popularity and scope, it's important that we be able to spread out the
load amongst more maintainers, and make sure that we're including
community members, while still keeping the core principles that made
bmcweb attract so many users intact.

To that end, I've attempted to document, in the OWNERS file, the basic
responsibilities that are required to be a maintainer within bmcweb.  I
very much expect that this list evolves over time, but this is expected
to be a starting point, and a place to point people that are interested
in becoming a maintainer of bmcweb.

As a pattern, I would like to see this kind of "how to be a maintainer
of this component" called out in more repositories, as I believe it
opens up the community to more people, common solutions, and better
results.

Signed-off-by: Ed Tanous <edtanous@google.com>
Change-Id: Id156edd7e340df9432bf5a8a73e8a117b5d4099a
1 file changed
tree: 1187315e5af9ae82c5d87405e521a11aed49d79a
  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.