Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / 49aa131f718000ddd5fce833487f72b14990aa04
commit49aa131f718000ddd5fce833487f72b14990aa04[log] [tgz]
authorNan Zhou <nanzhoumails@gmail.com>Tue Sep 20 18:41:37 2022 +0000
committerEd Tanous <ed@tanous.net>Wed Sep 28 16:35:22 2022 +0000
tree8ab8e10501d9667544afed021883f2a0afdc5492
parent41713dd7a72743affa0c7ff28c00680f7eb36489 [diff]
parse_registry: make the script more flexible

Now it supports updating individual registry. Run parse_registries.py to
see all the options. This speeds up development of the script itself:
e.g., when developing privilege related generator, we don't want to
regenerate other headers every time during development.

```
usage: parse_registries.py [-h] [--registries REGISTRIES]

options:
  -h, --help            show this help message and exit
  --registries REGISTRIES
                        Comma delimited list of registries to update
```

```
[hi on] nanzhou@nanzhou:~/Desktop/bmcweb$ time scripts/parse_registries.py

real    0m1.493s
user    0m0.401s
sys     0m0.046s
[hi on] nanzhou@nanzhou:~/Desktop/bmcweb$ time scripts/parse_registries.py --registries privilege

real    0m0.667s
user    0m0.213s
sys     0m0.030s
```

This saves 50% of the time. Though the absolute time to generate a full
list if small.

By default, it generates all the registries.

Tested: tested the script, it can update headers correctly.

Signed-off-by: Nan Zhou <nanzhoumails@gmail.com>
Change-Id: If13748a605a462f5dc7d83bad52360942b7dc6b7
1 file changed
tree: 8ab8e10501d9667544afed021883f2a0afdc5492
  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. build_x86.sh
  21. build_x86_docker.sh
  22. CLIENTS.md
  23. COMMON_ERRORS.md
  24. DEVELOPING.md
  25. Dockerfile
  26. Dockerfile.base
  27. HEADERS.md
  28. LICENSE
  29. meson.build
  30. meson_options.txt
  31. OEM_SCHEMAS.md
  32. OWNERS
  33. pam-webserver
  34. README.md
  35. Redfish.md
  36. run-ci
  37. setup.cfg
  38. 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.