Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / c6a620f2e01ce5f1551ecc4455624654282d79c7
commitc6a620f2e01ce5f1551ecc4455624654282d79c7[log] [tgz]
authorGeorge Liu <liuxiwei@inspur.com>Fri Apr 10 17:18:11 2020 +0800
committerGeorge Liu <liuxiwei@inspur.com>Fri Apr 24 09:28:00 2020 +0000
treed4d5e2a65a64874806ffae6c6b390243265684cf
parent3946028d2d3143109bb562841efce3e094c70c0b [diff]
Map policy restore D-Bus interface to Redfish

Tested:
 curl -k -H "X-Auth-Token: $token" https://${bmc}/redfish/v1/Systems/system
 {
  "@odata.id": "/redfish/v1/Systems/system",
  "@odata.type": "#ComputerSystem.v1_6_0.ComputerSystem",
  ... ...
  "PowerRestorePolicy": "AlwaysOff",
  ... ...
 }

 curl -k -H "X-Auth-Token: $token" -X PATCH -d '{"PowerRestorePolicy":"AlwaysOn"}' https://${bmc}/redfish/v1/Systems/system

 curl -k -H "X-Auth-Token: $token" https://${bmc}/redfish/v1/Systems/system
 {
  "@odata.id": "/redfish/v1/Systems/system",
  "@odata.type": "#ComputerSystem.v1_6_0.ComputerSystem",
  ... ...
  "PowerRestorePolicy": "AlwaysOn",
  ... ...
 }

 curl -k -H "X-Auth-Token: $token" -X PATCH -d '{"PowerRestorePolicy":"TestPolicy"}' https://${bmc}/redfish/v1/Systems/system
 {
  "error": {
    "@Message.ExtendedInfo": [
      {
        "@odata.type": "#Message.v1_0_0.Message",
        "Message": "The request failed due to an internal service error.  The service is still operational.",
        "MessageArgs": [],
        "MessageId": "Base.1.4.0.InternalError",
        "Resolution": "Resubmit the request.  If the problem persists, consider resetting the service.",
        "Severity": "Critical"
      }
    ],
    "code": "Base.1.4.0.InternalError",
    "message": "The request failed due to an internal service error.  The service is still operational."
  }
 }

Passed the validator:
VERBO - ServiceRoot -> Systems.Systems -> Members.ComputerSystem#0, ComputerSystem.v1_10_0, ComputerSystem
VERBO - @odata.id                                               PASS
VERBO - @odata.type                                             PASS
VERBO - Actions                                              complex
VERBO - Bios                                                    PASS
VERBO - Boot                                                 complex
VERBO - Description                                             PASS
VERBO - Id                                                      PASS
VERBO - Links                                                complex
VERBO - LogServices                                             PASS
VERBO - Memory                                                  PASS
VERBO - MemorySummary                                        complex
VERBO - Name                                                    PASS
VERBO - PowerRestorePolicy                                      PASS
... ...

Signed-off-by: George Liu <liuxiwei@inspur.com>
Change-Id: I75155c5cb930d6c4d9d5aad39f3315506db28e38
1 file changed
tree: d4d5e2a65a64874806ffae6c6b390243265684cf
  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. config.h.in
  17. DEVELOPING.md
  18. JenkinsFile
  19. LICENCE
  20. MAINTAINERS
  21. pam-webserver
  22. README.md
  23. 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.