Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / 73ec8304734d10b81781fb3aa6611873cdb5bcb1
commit73ec8304734d10b81781fb3aa6611873cdb5bcb1[log] [tgz]
authorGunnar Mills <gmills@us.ibm.com>Tue Apr 14 16:02:42 2020 -0500
committerGunnar Mills <gmills@us.ibm.com>Thu Apr 16 16:52:26 2020 +0000
tree6903759d8db068fcae8f69a02c196bfc2fa109e5
parente5aaf047b6b41b0837ef0846cf5356c9a6bcb030 [diff]
Change EventLog Id to match odata.id

Could not find a hard rule to require the Id to match the last segment
of the URL/@odata.id but all Redfish mockups match this way, other bmcweb
resources do as well, and redfishtool is easier to use if this is true.

Before:
$ python redfishtool.py -r xxxxxx -u xxxx -p xxxxxxx -S Always \
Systems Logs -i EventLog
5 Transport:getPathBy2:Match: failed match: matchProp=Id, matchValue=EventLog, readValue=Event Log

Tested:
Validator passed.

 curl -k https://${bmc}/redfish/v1/Systems/system/LogServices/EventLog
{
  "@odata.id": "/redfish/v1/Systems/system/LogServices/EventLog",
  "@odata.type": "#LogService.v1_1_0.LogService",
  "Actions": {
    "#LogService.ClearLog": {
      "target": "/redfish/v1/Systems/system/LogServices/EventLog/Actions/LogService.ClearLog"
    }
  },
  "Description": "System Event Log Service",
  "Entries": {
    "@odata.id": "/redfish/v1/Systems/system/LogServices/EventLog/Entries"
  },
  "Id": "EventLog",
  "Name": "Event Log Service",
  "OverWritePolicy": "WrapsWhenFull"

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