Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / 97d57aaa0b95a110c71016d190f95f853051126a
commit97d57aaa0b95a110c71016d190f95f853051126a[log] [tgz]
authorCarol Wang <wangkair@cn.ibm.com>Tue Nov 26 13:27:15 2019 +0800
committerCarol Wang <wangkair@cn.ibm.com>Thu Dec 12 02:57:07 2019 +0000
tree644f9a8f23ba6212f6838cc9920e2291d4a30e24
parent96b39e02ba160cda74b70b4cd9bac34c760e1701 [diff]
Redfish: Support health status of firmware inventory objects

Support health status of firmware inventory objects based on the mapping
relationship:
 [dbus status]     [redfish state]     [redfish health]
 Ready             Disabled            OK
 Activating        Updating            OK
 Active            Enabled             OK
 NotReady          Disabled            Warning
 Invalid           Disabled            Warning
 Failed            Disabled            Warning

Tested:
 [dbus status] --> [redfish state] --> [redfish health]
 1. Ready --> Disabled --> OK
 $ curl -k -H "X-Auth-Token: $token" https://$bmc/xyz/openbmc_project/software/enumerate
 {
    ...
    "/xyz/openbmc_project/software/9557fe67": {
       "Activation": "xyz.openbmc_project.Software.Activation.Activations.Ready",
    ...
 }
 $curl -k -H "X-Auth-Token: $token" https://${bmc}/redfish/v1/UpdateService/FirmwareInventory/9557fe67
 {
   "@odata.context": "/redfish/v1/$metadata#SoftwareInventory.SoftwareInventory",
   "@odata.id": "/redfish/v1/UpdateService/FirmwareInventory/9557fe67",
   ...
   "Status": {
     "Health": "OK",
     "HealthRollup": "OK",
     "State": "Disabled"
   },
   ...
 }
 2. Activating  --> Updating  --> OK
 $ curl -k -H "X-Auth-Token: $token" https://$bmc/xyz/openbmc_project/software/enumerate
 {
    ...
    "/xyz/openbmc_project/software/9557fe67": {
       "Activation": "xyz.openbmc_project.Software.Activation.Activations.Activating",
    ...
 }
 $curl -k -H "X-Auth-Token: $token" https://${bmc}/redfish/v1/UpdateService/FirmwareInventory/9557fe67
 {
   "@odata.context": "/redfish/v1/$metadata#SoftwareInventory.SoftwareInventory",
   "@odata.id": "/redfish/v1/UpdateService/FirmwareInventory/9557fe67",
   ...
   "Status": {
     "Health": "OK",
     "HealthRollup": "OK",
     "State": "Updating"
   },
   ...
 }
 3. Active --> Enabled --> OK
 $ curl -k -H "X-Auth-Token: $token" https://$bmc/xyz/openbmc_project/software/enumerate
 {
    "data": {
     "/xyz/openbmc_project/software/9557fe67": {
       "Activation": "xyz.openbmc_project.Software.Activation.Activations.Active",
    ...
 }
 $ curl -k -H "X-Auth-Token: $token" https://${bmc}/redfish/v1/UpdateService/FirmwareInventory/9557fe67
 {
   "@odata.context": "/redfish/v1/$metadata#SoftwareInventory.SoftwareInventory",
   "@odata.id": "/redfish/v1/UpdateService/FirmwareInventory/9557fe67",
   ...
   "Status": {
     "Health": "OK",
     "HealthRollup": "OK",
     "State": "Enabled"
   },
   ...
 }
 4. Invalid --> Disabled --> Warning
 # busctl call xyz.openbmc_project.Software.BMC.Updater /xyz/openbmc_project/software/c0bbba12 \
   org.freedesktop.DBus.Properties Set ssv xyz.openbmc_project.Software.Activation Activation s \
   xyz.openbmc_project.Software.Activation.Activations.Invalid
 $ curl -k -H "X-Auth-Token: $token" https://$bmc/xyz/openbmc_project/software/enumerate
 {
    ...
    "/xyz/openbmc_project/software/c0bbba12": {
       "Activation": "xyz.openbmc_project.Software.Activation.Activations.Invalid",
    ...
 }
 $ curl -k -H "X-Auth-Token: $token" https://${bmc}/redfish/v1/UpdateService/FirmwareInventory/c0bbba12
 {
   "@odata.context": "/redfish/v1/$metadata#SoftwareInventory.SoftwareInventory",
   "@odata.id": "/redfish/v1/UpdateService/FirmwareInventory/c0bbba12",
   ...
   "Status": {
     "Health": "Warning",
     "HealthRollup": "OK",
     "State": "Disabled"
   },
   ...
 }
 5. NotReady --> Disabled --> Warning
 # busctl call xyz.openbmc_project.Software.BMC.Updater /xyz/openbmc_project/software/c0bbba12 \
   org.freedesktop.DBus.Properties Set ssv xyz.openbmc_project.Software.Activation Activation s \
   xyz.openbmc_project.Software.Activation.Activations.NotReady
 $ curl -k -H "X-Auth-Token: $token" https://$bmc/xyz/openbmc_project/software/enumerate
 {
    ...
    "/xyz/openbmc_project/software/c0bbba12": {
       "Activation": "xyz.openbmc_project.Software.Activation.Activations.NotReady",
    ...
 }
 $ curl -k -H "X-Auth-Token: $token" https://${bmc}/redfish/v1/UpdateService/FirmwareInventory/c0bbba12
 {
   "@odata.context": "/redfish/v1/$metadata#SoftwareInventory.SoftwareInventory",
   "@odata.id": "/redfish/v1/UpdateService/FirmwareInventory/c0bbba12",
   ...
   "Status": {
     "Health": "Warning",
     "HealthRollup": "OK",
     "State": "Disabled"
   },
   ...
 }
 6. Failed --> Disabled --> Warning
 # busctl call xyz.openbmc_project.Software.BMC.Updater /xyz/openbmc_project/software/c0bbba12 \
   org.freedesktop.DBus.Properties Set ssv xyz.openbmc_project.Software.Activation Activation s \
    xyz.openbmc_project.Software.Activation.Activations.Failed
 $ curl -k -H "X-Auth-Token: $token" https://$bmc/xyz/openbmc_project/software/enumerate
 {
    ...
    "/xyz/openbmc_project/software/c0bbba12": {
       "Activation": "xyz.openbmc_project.Software.Activation.Activations.Failed",
    ...
 }
 $ curl -k -H "X-Auth-Token: $token" https://${bmc}/redfish/v1/UpdateService/FirmwareInventory/c0bbba12
 {
   "@odata.context": "/redfish/v1/$metadata#SoftwareInventory.SoftwareInventory",
   "@odata.id": "/redfish/v1/UpdateService/FirmwareInventory/c0bbba12",
   ...
   "Status": {
     "Health": "Warning",
     "HealthRollup": "OK",
     "State": "Disabled"
   },
   ...
 }

Validator tool result:
 Counter({'pass': 2992, 'skipOptional': 2470, 'metadataNamespaces': 1605,
 'passGet': 189, 'serviceNamespaces': 71, 'invalidPropertyValue': 10,
 'warningPresent': 6, 'passAction': 6, 'optionalAction': 5, 'warnDeprecated':
 2, 'unverifiedComplexAdditional': 1})
 Validation has succeeded.

Change-Id: Ic475f56d19c0be01ca7aebf67a3f6814d35bcacd
Signed-off-by: Carol Wang <wangkair@cn.ibm.com>
2 files changed
tree: 644f9a8f23ba6212f6838cc9920e2291d4a30e24
  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.