Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / 107077def176ad4a29557fae353de9bb00381ca9
commit107077def176ad4a29557fae353de9bb00381ca9[log] [tgz]
authorPrzemyslaw Czarnowski <przemyslaw.hawrylewicz.czarnowski@intel.com>Thu Jul 11 10:16:43 2019 +0200
committerPrzemyslaw Czarnowski <przemyslaw.hawrylewicz.czarnowski@intel.com>Mon Jan 27 09:52:18 2020 +0000
tree98c079957b689e7b615ee12ada7ba06e2d6bb4de
parent4228a1609a9f9751604a1e636de11a34ed58b840 [diff]
Add VirtualMedia schema to Redfish

This change adds VirtualMedia scheme to Redfish.
Implementation is based on input from virtual-media module
and nbd proxy which is a bmcweb part. The code is used
only in case ndb-proxy is supported in bmcweb
(BMCWEB_ENABLE_VM_NBDPROXY compilation flag).

Tested:
* Manual tests together with nbd proxy and virtual media app
  - For requests: Postman and/or HTTPie, started with logs
    enabled and Valgrind
  - Manual result validation
* Tests ran:
  - GET on collection with manual validation
  - PUT/POST/DELETE on collection
  - GET on item/nonexistent item
  - PUT/POST/DELETE on item
* Redfish Service Validator tested, no new issues found.

Signed-off-by: Przemyslaw Czarnowski <przemyslaw.hawrylewicz.czarnowski@intel.com>
Change-Id: I5415dc0ffe52069fd35bc614b0378bbc4ad41ff6
4 files changed
tree: 98c079957b689e7b615ee12ada7ba06e2d6bb4de
  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.