Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / c80fee55c3663e5ac620a4d11378799c91867b76
commitc80fee55c3663e5ac620a4d11378799c91867b76[log] [tgz]
authorAppaRao Puli <apparao.puli@linux.intel.com>Wed Oct 16 14:49:36 2019 +0530
committerAppaRao Puli <apparao.puli@linux.intel.com>Tue Oct 22 02:44:48 2019 +0000
treed7b54d8b6b5208bd2ee11c703b31f5a479384f6f
parent41d1d1833f476766f88cfb624e66eef7906bdf8c [diff]
Renamed User role name to ReadOnly

As per redfish specification (DSP0266), there are
set of predefined privilege roles. In OpenBMC code
has "User" as role name instead of "ReadOnly".
So corrected the same. Updated Redfish.md accordingly.

Spec says:
Role Name = "ReadOnly"
▪ AssignedPrivileges = Login, ConfigureSelf

Tested:
 - Role collection shows new role.
 - GET on /redfish/v1/AccountService/Roles/ReadOnly
   URI shows correct AssignedPrivileges.
 - Ran negative test with /redfish/v1/AccountService/Roles/User
   and observed error(404 - Not Found).
 - Ran Redfish validator and no new issues observed.

Signed-off-by: AppaRao Puli <apparao.puli@linux.intel.com>
Change-Id: I7b0132c628fb4950b6ec095269cd1a12e92aea9a
3 files changed
tree: d7b54d8b6b5208bd2ee11c703b31f5a479384f6f
  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.