Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / fc76b8ac6c2d9907ffd4618d22753db95c40953d
commitfc76b8ac6c2d9907ffd4618d22753db95c40953d[log] [tgz]
authorEd Tanous <ed@tanous.net>Mon Sep 28 17:21:52 2020 -0700
committerEd Tanous <ed@tanous.net>Fri Oct 09 17:21:49 2020 +0000
treebcf5ce6b44c5b1f9e761b6115a2b300c6f577d86
parente436008377fbcf287be02c9e9e1b59c6627d7673 [diff]
Move Openssl Generator

This commit moves the openssl random number generator into its own file,
so it can be used in EventService, and moves it to its own file.  Seeding a
random number generator with time is bad practice in general, so much so
that there's a CERT rule about it as well as a clang-tidy check.
https://clang.llvm.org/extra/clang-tidy/checks/cert-msc51-cpp.html

This doesn't matter much in this case, as we're generating a randomized
int for an ID, but it will matter in other cases, and we'd like to have
the check on to verify that.

Change-Id: I8e6aebb7962d259045ffd558eea22f07f9c23821
Signed-off-by: Ed Tanous <ed@tanous.net>
3 files changed
tree: bcf5ce6b44c5b1f9e761b6115a2b300c6f577d86
  1. http/
  2. include/
  3. redfish-core/
  4. scripts/
  5. src/
  6. static/
  7. subprojects/
  8. .clang-format
  9. .clang-tidy
  10. .dockerignore
  11. .gitignore
  12. bmcweb.service.in
  13. bmcweb.socket
  14. build_x86.sh
  15. build_x86_docker.sh
  16. COMMON_ERRORS.md
  17. DEVELOPING.md
  18. Dockerfile
  19. Dockerfile.base
  20. JenkinsFile
  21. LICENCE
  22. MAINTAINERS
  23. meson.build
  24. meson_options.txt
  25. pam-webserver
  26. README.md
  27. 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.