Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / 01caf624211197a993dbbd186149293f7053f9d8
commit01caf624211197a993dbbd186149293f7053f9d8[log] [tgz]
authorEd Tanous <edtanous@google.com>Tue Feb 08 12:28:37 2022 -0800
committerEd Tanous <ed@tanous.net>Mon Feb 14 23:23:11 2022 +0000
tree46262531eac12fd1836924e1647039868c199e73
parent0a4304cf40247771c63dc6be9b36d120a29fcb6d [diff]
Regenerate generated code as part of the build

There are a number of cases where people don't realize that the schemas
are owned by Redfish, and that some of the generated files (registries,
indexes) are in fact generated, and shouldn't be modified by hand.

This commit forces a regeneration of all those files within Jenkins,
each time we do a local build, then does a git diff to compare if the
upstream schema files and generated files are different than what is
checked in, it will print the diff immediately in the Jenkins build.
This should hopefully give much faster feedback to users that their
change needs to modify the right files.

As part of this commit, we also need to take the version string out of
clang-format.  CI/the system should own the clang-format version.

Related commit:
https://gerrit.openbmc-project.xyz/c/openbmc/openbmc-build-scripts/+/51041]

Tested:  Ran script, build passed.  Removed the schema fixes from patch
series, saw build failed.  Did the same with running the
openbmc-build-scripts unit test script.

Signed-off-by: Ed Tanous <edtanous@google.com>
Change-Id: I17eb0e106be267e8dbba7053b0b07ec617893c86
2 files changed
tree: 46262531eac12fd1836924e1647039868c199e73
  1. .github/
  2. http/
  3. include/
  4. redfish-core/
  5. scripts/
  6. src/
  7. static/
  8. subprojects/
  9. .clang-format
  10. .clang-ignore
  11. .clang-tidy
  12. .dockerignore
  13. .gitignore
  14. .shellcheck
  15. bmcweb.service.in
  16. bmcweb.socket.in
  17. bmcweb_config.h.in
  18. build_x86.sh
  19. build_x86_docker.sh
  20. COMMON_ERRORS.md
  21. DEVELOPING.md
  22. Dockerfile
  23. Dockerfile.base
  24. LICENSE
  25. MAINTAINERS
  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
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

Enable debug traces

meson builddir -Dbuildtype=debug
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.