Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / 4bfefa74dcd12422aa2ab8530e76ec8a9b1557d5
commit4bfefa74dcd12422aa2ab8530e76ec8a9b1557d5[log] [tgz]
authorGunnar Mills <gmills@us.ibm.com>Thu Jul 30 13:54:29 2020 -0500
committerGunnar Mills <gmills@us.ibm.com>Thu Aug 06 16:26:17 2020 -0500
tree959b4d3032cdf0f4bb72759e80040ffdaab7cd66
parentc50e7c68c2a8d08ed799ae28f47395b5a58494bc [diff]
Manager: Support for switching running image

ActiveSoftwareImage was added to Manager in v1_6_0.
It is a Readwrite property.

This supports only switching the BMC running image.
This assumes the BMC updater is
xyz.openbmc_project.Software.BMC.Updater.

This assumes the switch is Immediate and calls a BMC
reboot after setting the priority to 0.

Patch set 1 had a new Redfish.Settings for the Manager at
/redfish/v1/Managers/bmc/Settings and a new setting,
ActiveSoftwareImageApplyTime.

This was removed due to complexity.

A future commit could add support to allow this Setting to be
exposed and PATCHed.

From https://redfish.dmtf.org/schemas/v1/Manager.v1_9_0.json

"ActiveSoftwareImage": {
...
    "description": "The link to the software inventory resource that
represents the active firmware image for this manager.",
    "longDescription": "This property shall contain a link to a resource
of type SoftwareInventory that represents the active firmware image for
this manager.",
    "readonly": false,
    "versionAdded": "v1_6_0"

Tested: Validator passes

curl -k  -X PATCH -d \
'{ "Links": { "ActiveSoftwareImage": { "@odata.id":"/redfish/v1/UpdateService/FirmwareInventory/82d3ec86"}}}' \
https://$bmc/redfish/v1/Managers/bmc
{
  "@Message.ExtendedInfo": [
    {
      "@odata.type": "#Message.v1_0_0.Message",
      "Message": "Successfully Completed Request",

Change-Id: Id9d29af5332f9e76ec172e1e4351980a6772477c
Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
1 file changed
tree: 959b4d3032cdf0f4bb72759e80040ffdaab7cd66
  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.