Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / 3e0414fd3f3b8b08ef3960f66fa056d8376e3544
commit3e0414fd3f3b8b08ef3960f66fa056d8376e3544[log] [tgz]
authorJason M. Bills <jason.m.bills@linux.intel.com>Tue Oct 29 12:46:33 2019 -0700
committerJason Bills <jason.m.bills@linux.intel.com>Mon Dec 02 16:53:55 2019 +0000
treedc08b0f784baa1dab2ec75dbfb7e41b34d20b2eb
parent4363d3b256d469c5c133e5714f3e3be2f29b5e65 [diff]
Return no-content instead of waiting for OnDemand

Since an OnDemand crashdump could take some time it may cause
the request to time out before the response can be sent.

The correct fix for this is to implement the Redfish Task Monitor
service to handle all asynchronous tasks.  Until then, this
change will return 204 (no content) and add the OnDemand log to
the Entries list.

When Task Monitor is implemented it can return 202 (accepted) with
the location of the Task to poll.

Tested:
Used Postman to trigger the OnDemand action and immediately got a
204 response.  Polled the Entries list and saw the OnDemand entry
after it was ready.

Change-Id: I3e2692ec5d377823072e0d610fa3ca17a9259a37
Signed-off-by: Jason M. Bills <jason.m.bills@linux.intel.com>
1 file changed
tree: dc08b0f784baa1dab2ec75dbfb7e41b34d20b2eb
  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.