Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / 1eb779d10a6ac0f77ded4067b7f2b4514f1e2bce
commit1eb779d10a6ac0f77ded4067b7f2b4514f1e2bce[log] [tgz]
authorEd Tanous <ed@tanous.net>Fri Sep 11 09:44:49 2020 -0700
committerEd Tanous <ed@tanous.net>Sat Sep 19 15:50:04 2020 +0000
tree7696261a75d04d633ef73b5d3f59b09989f1b891
parent23e64207a6668319df1f273641febdeab4c09148 [diff]
Add Ed back as a maintainer

I seem to be doing more and more architectural work these days on
bmcweb, so I might as well make it slightly more official by editing
this powerful text file.  I really would've prefered pulling a sword
from a stone, or been given a 2 factor encryption key by the lady of the
lake, but as monty python says "strange women lying in ponds
distributing swords is no basis for a system of government. Supreme
executive power derives from a mandate from the masses, not from some
farcical aquatic ceremony."

As such, I submit this to the masses for approval.

Change-Id: Ie9767c58980855bf63ef94524553c08fcc202980
Signed-off-by: Ed Tanous <ed@tanous.net>
1 file changed
tree: 7696261a75d04d633ef73b5d3f59b09989f1b891
  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. COMMON_ERRORS.md
  19. config.h.in
  20. DEVELOPING.md
  21. Dockerfile
  22. Dockerfile.base
  23. JenkinsFile
  24. LICENCE
  25. MAINTAINERS
  26. pam-webserver
  27. README.md
  28. 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.