Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / c00500bcb9c5145f5cacb78bbe3dd694fb85ba0a
commitc00500bcb9c5145f5cacb78bbe3dd694fb85ba0a[log] [tgz]
authorJan Sowinski <jan.sowinski@intel.com>Tue Dec 03 10:37:06 2019 +0100
committerJan Sowinski <jan.sowinski@intel.com>Thu Dec 19 13:01:38 2019 +0000
tree0aa8d2616be800b68fe7091e3e67b50f7b3326c9
parentcac94c55c59a397524a04786f4d699e2bd7f21bf [diff]
Connection and websockets fixes

This commit fixes issue around Connection class and websockets
  - controlling connection lifetime by shared_ptr instead of manual new/delete
  - fixed memory leak when upgrading connection to websockets
  - removed dangling reference to conn.req in websockets
  - fixed lack of reponse for invalid websockets URLs
  - fixed not working connections deadline timer

There is no noticable performance impact after switching connection management
to shared pointers. Benchmark results using: wrk https://${bmc}
	shared_ptr: 144.29 Requests/sec
	new/delete: 144.41 Requests/sec

Tested manually:
	performance: wrk https://${bmc}
	memory leaks: top
	websockets: webui- KVM and VirtualMedia
	HTTP GET on random Redfish schemas: postman

Signed-off-by: Jan Sowinski <jan.sowinski@intel.com>
Change-Id: I63f7395ba081a68e7900eae2ed204acd50f58689
4 files changed
tree: 0aa8d2616be800b68fe7091e3e67b50f7b3326c9
  1. cmake/
  2. http/
  3. include/
  4. redfish-core/
  5. scripts/
  6. src/
  7. static/
  8. .clang-format
  9. .gitignore
  10. bmcweb.service.in
  11. bmcweb.socket
  12. build_x86.sh
  13. cmake-format.json
  14. CMakeLists.txt
  15. CMakeLists.txt.in
  16. DEVELOPING.md
  17. JenkinsFile
  18. LICENCE
  19. MAINTAINERS
  20. pam-webserver
  21. README.md
  22. 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 prime256v1 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.