Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / 5b816f2366de282e6d30090cdd5c85fcaef6bda9
commit5b816f2366de282e6d30090cdd5c85fcaef6bda9[log] [tgz]
authorGunnar Mills <gmills@us.ibm.com>Fri Feb 14 11:48:20 2020 -0600
committerGunnar Mills <gmills@us.ibm.com>Fri Feb 14 20:29:58 2020 +0000
treeb491282dc6fc7ec521f09cf8f96288d9da2feac8
parentaa05fb27ebd2429c29040708ff05eb27407bd963 [diff]
Move to latest Redfish Service version

The latest version of the Redfish Service is 1.9.0.
Nothing preventing us from moving to it.
Find the Redfish Specification (DSP0266) here:
https://www.dmtf.org/dsp/DSP0266

Looks like code is already trying to use some of the 1.7.0
features:
"Added "Password Management" clause to describe functional behavior
for restricting access when an account requires a password change."
Eventing mechanism and ApplyTime.

Will want to use features like:
odata.context optional, query parameter clarification, and eventing
clarification.

Tested: Redfish Validator. Not really a valid test though.
        Ran Redfish-Service-Conformance-Check, didn't see
        additional errors.

Note: bmcweb still has a lot of Conformance Checker errors,
we are not in 100% complicance with Redfish specification.

Change-Id: I0acd28efa2aaa91149f53efddae530816fd41fff
Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
1 file changed
tree: b491282dc6fc7ec521f09cf8f96288d9da2feac8
  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.