Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / cb13a39253848ece442971301ade9c09d98bf08e
commitcb13a39253848ece442971301ade9c09d98bf08e[log] [tgz]
authorEd Tanous <ed@tanous.net>Sat Jul 25 19:02:03 2020 +0000
committerEd Tanous <ed@tanous.net>Mon Aug 17 20:54:37 2020 +0000
tree62f2a64fbc98d8ee635a0a81f3ef07afa541981d
parent23a21a1cbed23ace4174664950e595df961e9e69 [diff]
Enable unused variable warnings and resolve

This commit enables the "unused variables" warning in clang.  Throughout
this, it did point out several issues that would've been functional
bugs, so I think it was worthwhile.  It also cleaned up several unused
variable from old constructs that no longer exist.

Tested:
Built with clang.  Code no longer emits warnings.

Downloaded bmcweb to system and pulled up the webui, observed webui
loads and logs in properly.

Change-Id: I51505f4222cc147d6f2b87b14d7e2ac4a74cafa8
Signed-off-by: Ed Tanous <ed@tanous.net>
44 files changed
tree: 62f2a64fbc98d8ee635a0a81f3ef07afa541981d
  1. cmake/
  2. http/
  3. include/
  4. redfish-core/
  5. scripts/
  6. src/
  7. static/
  8. .clang-format
  9. .dockerignore
  10. .gitignore
  11. bmcweb.service.in
  12. bmcweb.socket
  13. build_x86.sh
  14. build_x86_docker.sh
  15. cmake-format.json
  16. CMakeLists.txt
  17. CMakeLists.txt.in
  18. config.h.in
  19. DEVELOPING.md
  20. Dockerfile
  21. Dockerfile.base
  22. JenkinsFile
  23. LICENCE
  24. MAINTAINERS
  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/CMakeLists.txt and then compiling. For example, cmake -DBMCWEB_ENABLE_KVM=NO ... followed by make. The option names become C++ preprocessor symbols that control which code is compiled into the program.

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.