Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / 9440096005902d13e27fdb8911d33c657f8c7b77
commit9440096005902d13e27fdb8911d33c657f8c7b77[log] [tgz]
authorGunnar Mills <gmills@us.ibm.com>Fri Feb 14 11:56:41 2020 -0600
committerGunnar Mills <gmills@us.ibm.com>Wed Feb 19 18:55:08 2020 +0000
tree3f40001c2a66958928f0d5728f948bdd95b71942
parent890c10164e8c25f8276bc25b95e810fa30646769 [diff]
Account Service: Remove odata.context

Redfish made odata.context optional (1.6.0 of DSP0266).
Redfish has removed odata.context from example payloads in the
specification (1.7.0 of DSP0266), removed it from the mockups,
and Redfish recommended not using.

The reason for making optional and removing from mockups/examples,
"no one could figure out how to use it and it did not add value".

Don't see value in it for our implementation.

From the Redfish issue removing it:
"@odata.context provides little/no value. The common format we use
provides no value/guidance. A generic odata client cannot use it
because we don't return the specific version nor do we require it
be changed with a query parameter. Between @odata.type and the
metadata document and service document/service root, clients get
all of the information they need. And the case where it is
helpful (joins, etc) is something we never do."

https://github.com/DMTF/Redfish-Service-Conformance-Check/pull/171
removes from Redfish-Service-Conformance-Check.

Tested: Ran service validator. No errors.
        Ran Redfish-Service-Conformance-Check. No additional errors.
Change-Id: Ic2c33080604ea275cf487e5cd5b9f7948af07db9
Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
1 file changed
tree: 3f40001c2a66958928f0d5728f948bdd95b71942
  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.