Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / 988403c64f7d1937eece8c52a076d5abedfb3b60
commit988403c64f7d1937eece8c52a076d5abedfb3b60[log] [tgz]
authorEd Tanous <ed@tanous.net>Mon Aug 24 11:29:49 2020 -0700
committerEd Tanous <ed@tanous.net>Wed Oct 07 18:39:41 2020 +0000
tree290144bdce8cf1189d9f89a525243058eab44099
parentcc0904473c19977eb0b9789b3c1be54a74ca873d [diff]
Clean up utils

Lots of the utils functions have been superceeded or replaced by std::
implementations, or are no longer needed because of the removal of
middlewares.


Tested:
Ran on a bmc with this implemented.  Pulled down the webui, and
observed no issues.  Code compiles and passes clang-tidy cert checks.

Change-Id: If29bb5f4ba9979912aeb2a8fa4cbd9f4e4f32006
Signed-off-by: Ed Tanous <ed@tanous.net>
4 files changed
tree: 290144bdce8cf1189d9f89a525243058eab44099
  1. http/
  2. include/
  3. redfish-core/
  4. scripts/
  5. src/
  6. static/
  7. subprojects/
  8. .clang-format
  9. .dockerignore
  10. .gitignore
  11. bmcweb.service.in
  12. bmcweb.socket
  13. build_x86.sh
  14. build_x86_docker.sh
  15. COMMON_ERRORS.md
  16. DEVELOPING.md
  17. Dockerfile
  18. Dockerfile.base
  19. JenkinsFile
  20. LICENCE
  21. MAINTAINERS
  22. meson.build
  23. meson_options.txt
  24. pam-webserver
  25. README.md
  26. 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

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.