Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / 1b6ba8e2ca9f5e1687ce1d4b1db017ae348d2d1c
commit1b6ba8e2ca9f5e1687ce1d4b1db017ae348d2d1c[log] [tgz]
authorMichal Orzel <michalx.orzel@intel.com>Fri Jul 25 13:01:06 2025 +0200
committerMichal Orzel <michalx.orzel@intel.com>Wed Jul 30 16:17:50 2025 +0000
treef38cde549dd01dd7a576e194f7c3c0705279dcc8
parent8d9cf72d00ccbbdd070849601ce8f37bc01cb8c8 [diff]
Correct determination of Trigger's MetricType

Determining triggers type only by checking existence of either
`DiscreteThresholds` or `NumericThresholds` is wrong, because both
properties are always present in their dbus interface representation.
This leads to situations, where:
- `Trigger` resources, which were supposed to be numeric, contain
properties exclusive to discrete ones (like `DiscreteTriggerCondition`),
- `Trigger` resources, which were supposed to be discrete, have
`MetricType` set to `Numeric` (because `NumericThresholds` property
exists as an empty array).

To fully determine trigger's type, a check for `Discrete` property value
need to be made.

Tested:

1. POST three different triggers on
/redfish/v1/TelemetryService/Triggers:
- simple numeric trigger (`MetricType` set to `Numeric`, non-empty
`NumericThresholds`)
- simple discrete trigger (`MetricType` set to `Discrete`,
`DiscreteTriggerCondition` set to `Specified`, non-empty
`DiscreteTriggers`)
- simple discrete on-change trigger (`MetricType` set to `Discrete`,
`DiscreteTriggerCondition` set to `Changed`, empty `DiscreteTriggers`)

2. Verified `MetricType` value of created `Trigger` resources:
- simple numeric trigger has `MetricType` set to `Numeric`,
- simple discrete trigger has `MetricType` set to `Discrete`,
- simple discrete on-change trigger has `MetricType` set to `Discrete`.

Change-Id: Ifc7033eda0fb52fa42e292e1dc36dc433e9ea022
Signed-off-by: Michal Orzel <michalx.orzel@intel.com>
1 file changed
tree: f38cde549dd01dd7a576e194f7c3c0705279dcc8
  1. .github/
  2. config/
  3. docs/
  4. features/
  5. http/
  6. include/
  7. redfish-core/
  8. scripts/
  9. src/
  10. static/
  11. subprojects/
  12. test/
  13. .clang-format
  14. .clang-tidy
  15. .codespell-ignore
  16. .dockerignore
  17. .eslintignore
  18. .gitignore
  19. .markdownlint.yaml
  20. .openbmc-enforce-gitlint
  21. .prettierignore
  22. .shellcheck
  23. DEVELOPING.md
  24. LICENSE
  25. meson.build
  26. meson.options
  27. OWNERS
  28. README.md
  29. run-ci
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, 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. Http1 and http2 are supported using ALPN registration for TLS connections and h2c upgrade header for http connections.

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 setup 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.

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.

Compression

bmcweb supports various forms of http compression, including zstd and gzip. Client headers are observed to determine whether compressed payloads are supported.

Redfish Aggregation

bmcweb is capable of aggregating resources from satellite BMCs. Refer to AGGREGATION.md for more information on how to enable and use this feature.