Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / 40d68ef6ebe088e4cd0078f8ff4910ca58f2be5d
commit40d68ef6ebe088e4cd0078f8ff4910ca58f2be5d[log] [tgz]
authorGunnar Mills <gmills@us.ibm.com>Thu Nov 21 13:13:46 2019 -0600
committerGunnar Mills <gmills@us.ibm.com>Mon Dec 09 18:49:46 2019 +0000
tree4e974ed13ba6dfc8c85945747d5ca92da63f81fe
parent5e931ae994307babe6c3520cbaca6a7139acc81d [diff]
DEVELOPING: Engage Redfish before adding OEM

Added a Redfish section about engaging the DMTF's Redfish working group
before adding a Redfish OEM schema or property.

See https://lists.ozlabs.org/pipermail/openbmc/2019-November/019571.html

Tested: https://jbt.github.io/markdown-editor/ and grammarly.com
Change-Id: I946483a90e34f63930a2cba047d14226d2da7583
Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
1 file changed
tree: 4e974ed13ba6dfc8c85945747d5ca92da63f81fe
  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. DEVELOPING.md
  17. JenkinsFile
  18. LICENCE
  19. MAINTAINERS
  20. pam-webserver
  21. README.md
  22. 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 prime256v1 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.