Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / 83935af944c6f8f94497ce1e437730cc80f0002f
commit83935af944c6f8f94497ce1e437730cc80f0002f[log] [tgz]
authorAndrew Geissler <geissonator@yahoo.com>Thu Feb 13 10:24:53 2020 -0600
committerAndrew Geissler <geissonator@yahoo.com>Thu Feb 20 13:18:23 2020 +0000
tree55e116ff6ddb67223911ef11477f119fa8ce0bd9
parentb8c7eb23f9b598274792fe3b8d178d1f2e4cc6b0 [diff]
diag-mode: return InTest if host is in diag mode

Per discussion with DMTF and clarification of InTest state within
http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status
it was determined that this would represent the situation where the host
is collecting diagnostic data. This maps to the new DiagnosticMode
state added to the xyz.openbmc_project.State.Host.HostState namespace.

Tested:
Verified that Redfish API returned expected result when in
DiagnosticMode:
  "Status": {
    "Health": "OK",
    "HealthRollup": "OK",
    "State": "InTest"
  },

Change-Id: I1c5deb5fdc251a5dcd4d1d01f4eedb6c507ded0a
Signed-off-by: Andrew Geissler <geissonator@yahoo.com>
1 file changed
tree: 55e116ff6ddb67223911ef11477f119fa8ce0bd9
  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 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.