HTTP Client: Improve handling operation timeouts

Now that we are using timer.async_wait() with the async http
operations we need to account for the scenario where the timer fails
before the operation fails.  When that occurs we need to abort the
operation once its callback gets called.

Currently we proceed as if the timer doesn't exist.  This causes a
fault if one of the operations times out.  This patch adds a check
to the start of each async operation so that we do not continue with
the normal message sending flow when an operation times out.

Tested:
In order to create a connection timeout I created a dummy interface
and set the IP of my satellite BMC to route to the interface:
ip link add dummy0 type dummy
ip link set dev dummy0 up
ip route add 120.60.30.15 dev dummy0

All packets sent to 120.60.30.15 will get dropped and thus connection
attempts will timeout.  This does not cause bmcweb to crash.

To make the satellite reachable again I used
this command to delete the routing:
ip route del 120.60.31.15 dev dummy0

After doing so messages were once again able to be forwarded correctly
to the satellite.

Signed-off-by: Carson Labrado <clabrado@google.com>
Change-Id: Ie8d022c2195838e383eefcd0e12ae8cfab76e3e1
1 file changed
tree: e5bb73f1410da5afb8d15981c7f3ac1624110aa4
  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-ignore
  13. .clang-tidy
  14. .dockerignore
  15. .gitignore
  16. .openbmc-enforce-gitlint
  17. .shellcheck
  18. CLIENTS.md
  19. COMMON_ERRORS.md
  20. DBUS_USAGE.md
  21. DEVELOPING.md
  22. HEADERS.md
  23. LICENSE
  24. meson.build
  25. meson_options.txt
  26. OEM_SCHEMAS.md
  27. OWNERS
  28. README.md
  29. Redfish.md
  30. run-ci
  31. setup.cfg
  32. 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.