Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / e7808c93f01081ca12e1b4769691b5ae673f9017
commite7808c93f01081ca12e1b4769691b5ae673f9017[log] [tgz]
authorGunnar Mills <gmills@us.ibm.com>Wed Jul 08 21:17:44 2020 -0500
committerSunitha Harish <sunharis@in.ibm.com>Mon Jul 13 00:28:17 2020 -0500
tree5071323a0a0e15081c760b157e7f3ae10c3d54b0
parenta502de3d661acf95613d4e4d27c9611f2c8148ea [diff]
Move registries to v1_4_0.MessageRegistry

This implements the MessageSeverity property which tools and users
should use instead of the deprecated Severity property.

Since the registries use common infrastructure, easiest if just
bumped together and now allows grabbing the latest when implementing
a new registry, e.g. ResourceEvent.

Implement this new required property, MessageSeverity, in the openbmc
registry. Follow Redfish registries in having both MessageSeverity
and Severity.

Modified parse_registries.py to look at latest Base and
TaskEvent registries and ran parse_registries.py.

Tested: Built and validator passes. See new registries:
curl -k https://$bmc/redfish/v1/Registries/Base
{
  "@odata.id": "/redfish/v1/Registries/Base",
  "@odata.type": "#MessageRegistryFile.v1_1_0.MessageRegistryFile",
  "Description": "DMTF Base Message Registry File Location",
  "Id": "Base",
  "Languages": [
    "en"
  ],
  "Languages@odata.count": 1,
  "Location": [
    {
      "Language": "en",
      "PublicationUri": "https://redfish.dmtf.org/registries/Base.1.8.1.json",
      "Uri": "/redfish/v1/Registries/Base/Base"
    }
  ],
...

curl -k https://$bmc/redfish/v1/Registries/Base/Base
{
  "@Redfish.Copyright": "Copyright 2014-2020 DMTF. All rights reserved.",
  "@odata.type": "#MessageRegistry.v1_4_0.MessageRegistry",
  "Description": "This registry defines the base messages for Redfish",
  "Id": "Base.1.8.1",
  "Language": "en",
  "Messages": {
    "AccessDenied": {
      "Description": "Indicates that while attempting to access, connect to or transfer to/from another resource, the service denied access.",
      "Message": "While attempting to establish a connection to %1, the service denied access.",
      "MessageSeverity": "Critical",
      "NumberOfArgs": 1,
      "ParamTypes": [
        "string"
      ],
      "Resolution": "Attempt to ensure that the URI is correct and that the service has the appropriate credentials.",
      "
...

Change-Id: I6495af0e02036ea527036d942d6b6b5f55178bb2
Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
6 files changed
tree: 5071323a0a0e15081c760b157e7f3ae10c3d54b0
  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 secp384r1 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.