Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / 043a05366c1fe54d7b9ef883292d0cd2d01c66b2
commit043a05366c1fe54d7b9ef883292d0cd2d01c66b2[log] [tgz]
authorJohnathan Mantey <johnathanx.mantey@intel.com>Tue Mar 10 17:15:28 2020 -0700
committerJohnathan Mantey <johnathanx.mantey@intel.com>Thu Apr 09 19:51:30 2020 +0000
tree6d8389f9811693029d6ccf5596a57ef6c4b922c1
parent0f6efdc1a0c919ffdfc00b2ff8af0929652483dc [diff]
Match BMCWeb crashdump to the D-Bus interface provided by crashdump

The crashdump service changed to eliminate hangs, and failures to
retrieve the crashdump data. The BMCWeb crashdump handling code has to
be aligned with the server.

Tested:
Confirmed each of the primary functions operates as expected.
Getting the collection
Getting the entries
Forcing an on demand capture
Polling for the on demand capture to complete
Retrieving the creashdump data
Clearing all of the crashdump content
Ran service validator

Change-Id: Ie8fb48369a782d905b942c1f9bef11f387f6463e
Signed-off-by: Johnathan Mantey <johnathanx.mantey@intel.com>
1 file changed
tree: 6d8389f9811693029d6ccf5596a57ef6c4b922c1
  1. cmake/
  2. http/
  3. include/
  4. redfish-core/
  5. scripts/
  6. src/
  7. static/
  8. .clang-format
  9. .gitignore
  10. bmcweb.service.in
  11. bmcweb.socket
  12. build_x86.sh
  13. cmake-format.json
  14. CMakeLists.txt
  15. CMakeLists.txt.in
  16. config.h.in
  17. DEVELOPING.md
  18. JenkinsFile
  19. LICENCE
  20. MAINTAINERS
  21. pam-webserver
  22. README.md
  23. 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/CMakeLists.txt and then compiling. For example, cmake -DBMCWEB_ENABLE_KVM=NO ... followed by make. The option names become C++ preprocessor symbols that control which code is compiled into the program.

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.