Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / 21c0ba6e6d977a46e957916bb0916f440fccb653
commit21c0ba6e6d977a46e957916bb0916f440fccb653[log] [tgz]
authorMyung Bae <myungbae@us.ibm.com>Wed Dec 04 13:44:08 2024 -0600
committerEd Tanous <ed@tanous.net>Mon Dec 09 16:27:38 2024 +0000
tree2ad58873a00cb345a989d5d04dc845ba8d29c768
parentf7a26073cf8c70dfa1e121540b13c63af77c3dc1 [diff]
Make eventId increment per event

Currently, eventId is incremented for each subscriber even for the same
event. So, this is to increment eventId per event.

Tested:
- Run multiple instance of event listeners
- Generate an event like
```
curl -k -H "X-Auth-Token: $bmc_token" -H "Content-Type: application/json" \
     -X POST https://${bmc}/redfish/v1/Managers/bmc/LogServices/Dump/Actions/LogService.CollectDiagnosticData \
     -d '{"DiagnosticDataType":"Manager"}'
```

- Check the EventId whether it is incremented per event
```
  "@odata.type": "#Event.v1_4_0.Event",
  "Events": [
    {
      ...
      "MessageId": "TaskEvent.1.0.3.TaskStarted",
      "MessageSeverity": "OK",
      "OriginOfCondition": "/redfish/v1/TaskService/Tasks/0",
      "Resolution": "None."
    }
  ],
  "Id": 2,      <===
  "Name": "Event Log"
}
```

Change-Id: I7a1f61cb932068cac5a50838fefeeaf880516a97
Signed-off-by: Myung Bae <myungbae@us.ibm.com>
1 file changed
tree: 2ad58873a00cb345a989d5d04dc845ba8d29c768
  1. .github/
  2. config/
  3. http/
  4. include/
  5. redfish-core/
  6. scripts/
  7. src/
  8. static/
  9. subprojects/
  10. test/
  11. .clang-format
  12. .clang-tidy
  13. .codespell-ignore
  14. .dockerignore
  15. .eslintignore
  16. .gitignore
  17. .markdownlint.yaml
  18. .openbmc-enforce-gitlint
  19. .prettierignore
  20. .shellcheck
  21. AGGREGATION.md
  22. CLIENTS.md
  23. COMMON_ERRORS.md
  24. DBUS_USAGE.md
  25. DEVELOPING.md
  26. HEADERS.md
  27. LICENSE
  28. meson.build
  29. meson.options
  30. OEM_SCHEMAS.md
  31. OWNERS
  32. README.md
  33. Redfish.md
  34. REDFISH_CHECKLIST.md
  35. run-ci
  36. 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, 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 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.

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.