Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / 525fc07224884d3640e5c4a1b6a551aee024f7bd
commit525fc07224884d3640e5c4a1b6a551aee024f7bd[log] [tgz]
authorSunitha Harish <sunithaharish04@gmail.com>Tue Aug 09 02:34:30 2022 -0500
committerSunitha Harish <sunithaharish04@gmail.com>Fri Oct 14 03:31:47 2022 +0000
treeb92f8df261b37af601d12682744549a7457cbdc8
parent77665bdac1063ae547890a983daeab7f4320457d [diff]
NetworkProtocol: Support NetworkSuppliedServers property

There was no way to differentiate between the static and DHCP assigned
NTP servers. Networkd and Dbus has added support for StaticNTPServers to
save the static configuration.

PATCH command will now set the StaticNTPServers property at the backend.
NTPServers property will contain network supplied dynamic NTP Servers at
the system.

Tested by:
 1. PATCH /redfish/v1/Managers/bmc/NetworkProtocol -d
    '{"NTP":{"NTPServers": [<ip>]}}'
    Verify that this adds the NTPs server to the NetworkProtocol
 2. Enable DHCP to fetch NTP servers list from the DHCP server. Verify
    that they are listed when GET on NetworkProtocol as below
    "NTP": {
        "NTPServers": [
        <static ntp server ip>
      ],
      "NetworkSuppliedServers": [
        <dynamic ntp server ip>
      ],
      "ProtocolEnabled": true
    },
 3. Redfish validator run

Signed-off-by: sunharis <sunithaharish04@gmail.com>
Change-Id: Ifac77485485839292b770d36def35da17d723c4e
1 file changed
tree: b92f8df261b37af601d12682744549a7457cbdc8
  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. CLIENTS.md
  21. COMMON_ERRORS.md
  22. DBUS_USAGE.md
  23. DEVELOPING.md
  24. HEADERS.md
  25. LICENSE
  26. meson.build
  27. meson_options.txt
  28. OEM_SCHEMAS.md
  29. OWNERS
  30. pam-webserver
  31. README.md
  32. Redfish.md
  33. run-ci
  34. setup.cfg
  35. 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.