Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / 4cde5d90f690fad956407fb759c03c09da002026
commit4cde5d90f690fad956407fb759c03c09da002026[log] [tgz]
authorJames Feist <james.feist@linux.intel.com>Thu Jun 11 10:39:55 2020 -0700
committerJames Feist <james.feist@linux.intel.com>Fri Jun 26 23:04:23 2020 +0000
treeed1b109249eef4081b960368eb2ac09005aa5b72
parenta0ec28b671391473a6dbe1258fb5216311861396 [diff]
Update Service: Change error message based on error logs

THis adds support for better error responses based on
the logs generated by phosphor-software-manager.

Tested: Got 400 error with different messages based
on failure type

{
    "error": {
        "@Message.ExtendedInfo": [
            {
                "@odata.type": "/redfish/v1/$metadata#Message.v1_0_0.Message",
                "Message": "Invalid file uploaded to /redfish/v1/UpdateService: Invalid archive.",
                "MessageArgs": [
                    "/redfish/v1/UpdateService",
                    "invalid archive"
                ],
                "MessageId": "OpenBMC.0.1.0.InvalidUpload",
                "Resolution": "None.",
                "Severity": "Warning"
            }
        ],
        "code": "OpenBMC.0.1.0.InvalidUpload",
        "message": "Invalid file uploaded to /redfish/v1/UpdateService: Invalid archive."
    }
}

{
    "error": {
        "@Message.ExtendedInfo": [
            {
                "@odata.type": "/redfish/v1/$metadata#Message.v1_0_0.Message",
                "Message": "Invalid file uploaded to /redfish/v1/UpdateService: Invalid image format.",
                "MessageArgs": [
                    "/redfish/v1/UpdateService",
                    "invalid image format"
                ],
                "MessageId": "OpenBMC.0.1.0.InvalidUpload",
                "Resolution": "None.",
                "Severity": "Warning"
            }
        ],
        "code": "OpenBMC.0.1.0.InvalidUpload",
        "message": "Invalid file uploaded to /redfish/v1/UpdateService: Invalid image format."
    }
}

{
    "error": {
        "@Message.ExtendedInfo": [
            {
                "@odata.type": "#Message.v1_0_0.Message",
                "Message": "The resource /redfish/v1/UpdateService was unable to satisfy the request due to unavailability of resources.",
                "MessageArgs": [
                    "/redfish/v1/UpdateService"
                ],
                "MessageId": "Base.1.4.0.ResourceExhaustion",
                "Resolution": "Ensure that the resources are available and resubmit the request.",
                "Severity": "Critical"
            }
        ],
        "code": "Base.1.4.0.ResourceExhaustion",
        "message": "The resource /redfish/v1/UpdateService was unable to satisfy the request due to unavailability of resources."
    }
}

Change-Id: Ida9a23c10aedbf9a48c96f4050a04e06bddff284
Signed-off-by: James Feist <james.feist@linux.intel.com>
4 files changed
tree: ed1b109249eef4081b960368eb2ac09005aa5b72
  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.