Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / 8b564558bafdf3e7a3babaafc29b0e5f904f4363
commit8b564558bafdf3e7a3babaafc29b0e5f904f4363[log] [tgz]
authorEd Tanous <edtanous@google.com>Fri Sep 23 12:03:18 2022 -0700
committerEd Tanous <ed@tanous.net>Wed Sep 28 16:37:11 2022 +0000
treea003c08212abadfd82b218c0d22c28ca760646e0
parent49aa131f718000ddd5fce833487f72b14990aa04 [diff]
Sort schema list alphabetically

New versions of the DMTF schema pack seem to make this list parse in
less-than-ideal order.  Previously, the schema pack zip file had an
order that was at least semi-alphabetical, but 2022.2 seems to cause
that to change.

This commit makes the update_schemas.py script explicitly alphabetize
the list.  This changes the order of two keys that have common prefixes,
but leaves the rest of the order the same.  Both are arguably correct.

This commit also exposes that this script seemed to have lots of
problems in its version number detection logic.  To make all this work
properly, a fairly invasive change is required.

Tested: Running the script on 2021.4 produces the same result as
previously.  See later commits for 2022.2 where result is now correct.

Signed-off-by: Ed Tanous <edtanous@google.com>
Change-Id: Ia2365daee1d91de142652161bf752600f3109115
1 file changed
tree: a003c08212abadfd82b218c0d22c28ca760646e0
  1. .github/
  2. http/
  3. include/
  4. redfish-core/
  5. scripts/
  6. src/
  7. static/
  8. subprojects/
  9. test/
  10. .clang-format
  11. .clang-ignore
  12. .clang-tidy
  13. .dockerignore
  14. .gitignore
  15. .openbmc-enforce-gitlint
  16. .shellcheck
  17. bmcweb.service.in
  18. bmcweb.socket.in
  19. bmcweb_config.h.in
  20. build_x86.sh
  21. build_x86_docker.sh
  22. CLIENTS.md
  23. COMMON_ERRORS.md
  24. DEVELOPING.md
  25. Dockerfile
  26. Dockerfile.base
  27. HEADERS.md
  28. LICENSE
  29. meson.build
  30. meson_options.txt
  31. OEM_SCHEMAS.md
  32. OWNERS
  33. pam-webserver
  34. README.md
  35. Redfish.md
  36. run-ci
  37. setup.cfg
  38. TESTING.md
README.md

OpenBMC webserver

This component attempts to be a "do everything" embedded webserver for OpenBMC.

Features

The webserver implements a few distinct interfaces:

  • DBus event websocket. Allows registering on changes to specific dbus paths, properties, and will send an event from the websocket if those filters match.
  • OpenBMC DBus REST api. Allows direct, low interference, high fidelity access to dbus and the objects it represents.
  • Serial: A serial websocket for interacting with the host serial console through websockets.
  • Redfish: A protocol compliant, (Redfish.md)[DBus to Redfish translator].
  • KVM: A websocket based implementation of the RFB (VNC) frame buffer protocol intended to mate to webui-vue to provide a complete KVM implementation.

Protocols

bmcweb at a protocol level supports http and https. TLS is supported through OpenSSL.

AuthX

Authentication

Bmcweb supports multiple authentication protocols:

  • Basic authentication per RFC7617
  • Cookie based authentication for authenticating against webui-vue
  • Mutual TLS authentication based on OpenSSL
  • Session authentication through webui-vue
  • XToken based authentication conformant to Redfish DSP0266

Each of these types of authentication is able to be enabled or disabled both via runtime policy changes (through the relevant Redfish APIs) or via configure time options. All authentication mechanisms supporting username/password are routed to libpam, to allow for customization in authentication implementations.

Authorization

All authorization in bmcweb is determined at routing time, and per route, and conform to the Redfish PrivilegeRegistry.

*Note: Non-Redfish functions are mapped to the closest equivalent Redfish privilege level.

Configuration

bmcweb is configured per the meson build files. Available options are documented in meson_options.txt

Compile bmcweb with default options:

meson builddir
ninja -C builddir

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

Debug logging

bmcweb by default is compiled with runtime logging disabled, as a performance consideration. To enable it in a standalone build, add the

-Dlogging='enabled'

option to your configure flags. If building within Yocto, add the following to your local.conf.

EXTRA_OEMESON:pn-bmcweb:append = "-Dbmcweb-logging='enabled'"

Use of persistent data

bmcweb relies on some on-system data for storage of persistent data that is internal to the process. Details on the exact data stored and when it is read/written can seen from the persistent_data namespace.

TLS certificate generation

When SSL support is enabled and a usable certificate is not found, bmcweb will generate a self-signed a certificate before launching the server. Please see the bmcweb source code for details on the parameters this certificate is built with.