Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / ff85ed3d82f16f3e23de5ddf9115b429a15bf364
commitff85ed3d82f16f3e23de5ddf9115b429a15bf364[log] [tgz]
authorGunnar Mills <gmills@us.ibm.com>Thu Jun 24 13:30:46 2021 -0500
committerGunnar Mills <gmills@us.ibm.com>Fri Jun 25 13:07:18 2021 -0500
tree63bf2a5de7fd01159e014d043fcff8707b267f21
parent49e429ca172365bd4ba16c924501321c73527cbe [diff]
Add Privileges schema to allow list

The allow list should contain all schemas implemented by bmcweb.

The allow list was missing the Privileges schema. The Privileges schema
is referenced in the Role schema here:

"AssignedPrivileges": {
  "description": "The Redfish privileges for this role.",
  "items": {
    "$ref": "http://redfish.dmtf.org/schemas/v1/Privileges.json#/definitions/PrivilegeType"

https://redfish.dmtf.org/schemas/v1/Role.v1_3_1.json

In OpenBMC CI Redfish Validator testing the following error was hit 3
times:

ERROR - ConnectionError on http://redfish.dmtf.org/schemas/v1/Privileges_v1.xml:
ConnectionError(ProtocolError('Connection aborted.',
RemoteDisconnected('Remote end closed connection without response')))

Network glitch somewhere but inspired this change.

Long term not sure if the allow list makes sense. While still used today
(and for the immediate future) it should attempt to accurately reflect
the implemented schemas in bmcweb.

The allow list was added in 349a2ac3 to save space.

Information on the CI Redfish Validator testing can be found at
https://github.com/openbmc/openbmc-test-automation/search?q=Redfish-Service-Validator
The test redownloads the schemas each time.

Tested: Validator passed.
See the new schema:
{
  "@odata.id": "/redfish/v1/JsonSchemas/Privileges"
},

Change-Id: Iaf3de36b211efab4115a17fd43f0263b8bd3107f
Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
6 files changed
tree: 63bf2a5de7fd01159e014d043fcff8707b267f21
  1. .github/
  2. http/
  3. include/
  4. redfish-core/
  5. scripts/
  6. src/
  7. static/
  8. subprojects/
  9. .clang-format
  10. .clang-ignore
  11. .clang-tidy
  12. .dockerignore
  13. .gitignore
  14. .shellcheck
  15. bmcweb.service.in
  16. bmcweb.socket.in
  17. bmcweb_config.h.in
  18. build_x86.sh
  19. build_x86_docker.sh
  20. COMMON_ERRORS.md
  21. DEVELOPING.md
  22. Dockerfile
  23. Dockerfile.base
  24. LICENCE
  25. MAINTAINERS
  26. meson.build
  27. meson_options.txt
  28. OEM_SCHEMAS.md
  29. OWNERS
  30. pam-webserver
  31. README.md
  32. 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/meson_options.txt and then compiling. For example, meson <builddir> -Dkvm=disabled ... followed by ninja in build directory. The option names become C++ preprocessor symbols that control which code is compiled into the program.

Compile bmcweb with default options:

meson builddir
ninja -C builddir

Compile bmcweb with yocto defaults:

meson builddir -Dbuildtype=minsize -Db_lto=true -Dtests=disabled
ninja -C buildir

If any of the dependencies are not found on the host system during configuration, meson automatically gets them via its wrap dependencies mentioned in bmcweb/subprojects.

Enable/Disable meson wrap feature

meson builddir -Dwrap_mode=nofallback
ninja -C builddir

Enable debug traces

meson builddir -Dbuildtype=debug
ninja -C builddir

Generate test coverage report:

meson builddir -Db_coverage=true -Dtests=enabled
ninja coverage -C builddir test

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.