Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / 349a2ac3921e17ff0e2bce47ba6698112d586e67
commit349a2ac3921e17ff0e2bce47ba6698112d586e67[log] [tgz]
authorGunnar Mills <gmills@us.ibm.com>Wed Jan 20 22:29:16 2021 -0600
committerGunnar Mills <gmills@us.ibm.com>Tue Jan 26 09:39:13 2021 -0600
treee6a97c4b6f89d42d1cfc310e5a3ee280a95a24d7
parent262d7d4ba6b43ede7edde97765f7d710f29c862f [diff]
Exclude not used schemas

Created a list of all used schemas, and a few being added for use in reviews
now. Exclude all other schemas.

Developers if they wish to use a new schema will have to add it to this
list and rerun update_schemas.py.

Size of obmc-phosphor-image-witherspoon-<date>.rootfs.squashfs-xz:
Before 2020.4: 19451904
With 2020.4, before this commit: 19492864
With this commit: 19275776

Tested: Validator passes.
Change-Id: I23272049aa38c51ac7af0d3b0f5b4641a349a487
Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
233 files changed
tree: e6a97c4b6f89d42d1cfc310e5a3ee280a95a24d7
  1. http/
  2. include/
  3. redfish-core/
  4. scripts/
  5. src/
  6. static/
  7. subprojects/
  8. .clang-format
  9. .clang-ignore
  10. .clang-tidy
  11. .dockerignore
  12. .gitignore
  13. .shellcheck
  14. bmcweb.service.in
  15. bmcweb.socket
  16. build_x86.sh
  17. build_x86_docker.sh
  18. COMMON_ERRORS.md
  19. DEVELOPING.md
  20. Dockerfile
  21. Dockerfile.base
  22. LICENCE
  23. MAINTAINERS
  24. meson.build
  25. meson_options.txt
  26. OEM_SCHEMAS.md
  27. pam-webserver
  28. README.md
  29. Redfish.md
README.md

OpenBMC webserver

This component attempts to be a "do everything" embedded webserver for openbmc.

Capabilities

At this time, the webserver implements a few interfaces:

  • Authentication middleware that supports cookie and token based authentication, as well as CSRF prevention backed by linux PAM authentication credentials.
  • An (incomplete) attempt at replicating phosphor-dbus-rest interfaces in C++. Right now, a few of the endpoint definitions work as expected, but there is still a lot of work to be done. The portions of the interface that are functional are designed to work correctly for phosphor-webui, but may not yet be complete.
  • Replication of the rest-dbus backend interfaces to allow bmc debug to logged in users.
  • An initial attempt at a read-only redfish interface. Currently the redfish interface targets ServiceRoot, SessionService, AccountService, Roles, and ManagersService. Some functionality here has been shimmed to make development possible. For example, there exists only a single user role.
  • SSL key generation at runtime. See the configuration section for details.
  • Static file hosting. Currently, static files are hosted from the fixed location at /usr/share/www. This is intended to allow loose coupling with yocto projects, and allow overriding static files at build time.
  • Dbus-monitor over websocket. A generic endpoint that allows UIs to open a websocket and register for notification of events to avoid polling in single page applications. (this interface may be modified in the future due to security concerns.

Configuration

BMCWeb is configured by setting -D flags that correspond to options in bmcweb/meson_options.txt and then compiling. For example, meson <builddir> -Dkvm=disabled ... followed by ninja in build directory. The option names become C++ preprocessor symbols that control which code is compiled into the program.

Compile bmcweb with default options:

meson builddir
ninja -C builddir

Compile bmcweb with yocto defaults:

meson builddir -Dbuildtype=minsize -Db_lto=true -Dtests=disabled
ninja -C buildir

If any of the dependencies are not found on the host system during configuration, meson automatically gets them via its wrap dependencies mentioned in bmcweb/subprojects.

Enable/Disable meson wrap feature

meson builddir -Dwrap_mode=nofallback
ninja -C builddir

Generate test coverage report:

meson builddir -Db_coverage=true -Dtests=enabled
ninja coverage -C builddir test

When BMCWeb starts running, it reads persistent configuration data (such as UUID and session data) from a local file. If this is not usable, it generates a new configuration.

When BMCWeb SSL support is enabled and a usable certificate is not found, it will generate a self-sign a certificate before launching the server. The keys are generated by the secp384r1 algorithm. The certificate

  • is issued by C=US, O=OpenBMC, CN=testhost,
  • is valid for 10 years,
  • has a random serial number, and
  • is signed using the SHA-256 algorithm.