Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / 4f50ae4b71fc0821f0013cbf586579f7c9a17a2c
commit4f50ae4b71fc0821f0013cbf586579f7c9a17a2c[log] [tgz]
authorGunnar Mills <gmills@us.ibm.com>Thu Feb 06 15:29:57 2020 -0600
committerGunnar Mills <gmills@us.ibm.com>Fri Feb 07 19:07:33 2020 +0000
treecef7d7434207cffbe18f8b85c006d2edd62310cc
parentcd17b26c893ba9dd1dcb0d56d725f2892c57e125 [diff]
Move Crashdump to OemCrashdump

All other Oem Schemas start with Oem.
This is used by the update_schemas.py to determine an Oem
schema and is a reasonable requirement for Oem schemas.

https://github.com/openbmc/bmcweb/blob/a3268f98f308ca7c8660b1ace44d5b9a40be204b/scripts/update_schemas.py#L43

Tested: Ran the validator against this change on a Witherspoon
        with BMCWEB_ENABLE_REDFISH_CPU_LOG enabled and OemCheck
        true. Validator passed. Might be worth running on a
        system that actually uses BMCWEB_ENABLE_REDFISH_CPU_LOG.

curl -k https://${bmc}/redfish/v1/Systems/system/LogServices/Crashdump
{
  "@odata.context": "/redfish/v1/$metadata#LogService.LogService",
  "@odata.id": "/redfish/v1/Systems/system/LogServices/Crashdump",
  "@odata.type": "#LogService.v1_1_0.LogService",
  "Actions": {
    "#LogService.ClearLog": {
      "target": "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/LogService.ClearLog"
    },
    "Oem": {
      "#Crashdump.OnDemand": {
        "target": "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/Oem/Crashdump.OnDemand"
      }
    }
  },
  "Description": "Oem Crashdump Service",
  "Entries": {
    "@odata.id": "/redfish/v1/Systems/system/LogServices/Crashdump/Entries"
  },
  "Id": "Oem Crashdump",
  "MaxNumberOfRecords": 3,
  "Name": "Open BMC Oem Crashdump Service",
  "OverWritePolicy": "WrapsWhenFull"
}

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