Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / 2539e69ce10b61cef945d6dc83a1d603050dc2f5
commit2539e69ce10b61cef945d6dc83a1d603050dc2f5[log] [tgz]
authorChanh Nguyen <chanh@os.amperecomputing.com>Tue Aug 27 05:34:53 2024 +0000
committerChanh Nguyen <chanh@os.amperecomputing.com>Wed Aug 28 02:35:21 2024 +0000
treecd312c33472c9d59e9e4ee4f88abf073910b59ad
parentba498310f761b3c0f475ecbdb293cf1386544a33 [diff]
Add message registry for power button long press

When the power button is pressed, it depends on how long
the press takes to cause which event to happen [1].

Add a message registry for the power button long press
event.

[1] https://github.com/openbmc/phosphor-buttons/blob/master/README.md#power-button

Tested:
1. Redfish Validator passed.
2. Verify in Redfish log.
'''
GET: /redfish/v1/Systems/system/LogServices/EventLog/Entries
Response:
{
  "@odata.id": "/redfish/v1/Systems/system/LogServices/EventLog/Entries",
  "@odata.type": "#LogEntryCollection.LogEntryCollection",
  "Description": "Collection of System Event Log Entries",
  "Members": [
    {
      "@odata.id": "/redfish/v1/Systems/system/LogServices/EventLog/Entries/1724214823",
      "@odata.type": "#LogEntry.v1_9_0.LogEntry",
      "Created": "2024-08-21T04:33:43+00:00",
      "EntryType": "Event",
      "Id": "1724214823",
      "Message": "Power Button Long Pressed.",
      "MessageArgs": [],
      "MessageId": "OpenBMC.0.1.PowerButtonLongPressed.OK",
      "Name": "System Event Log Entry",
      "Severity": "OK"
   }
  ],
  "Members@odata.count": 1,
  "Name": "System Event Log Entries"
}
'''

Change-Id: I772c444303c784d086af69e1eab22d9446658d4b
Signed-off-by: Chanh Nguyen <chanh@os.amperecomputing.com>
2 files changed
tree: cd312c33472c9d59e9e4ee4f88abf073910b59ad
  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.