Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / 3e082749f3301116de14ac61661a625897a75971
commit3e082749f3301116de14ac61661a625897a75971[log] [tgz]
authorAsmitha Karunanithi <asmitk01@in.ibm.com>Tue Nov 24 12:41:42 2020 +0530
committerAsmitha Karunanithi <asmitk01@in.ibm.com>Tue Nov 24 12:41:42 2020 +0530
treeb6631767056cb4865ffa177c5cffe412adb34d5f
parenta8fe54f09be1deefc119d8dcf100da922496d46d [diff]
Pointing to the latest Message schema in JSON error response

The odata.type of the message, included in the error response JSON
is changed to point to the latest one (Message.v1_1_1) as there was
conflict in the code, where it points to v1_0_0 schema and a property
- MessageSeverity has been used (introduced in v1_1_0)

Tested By:

{
  "error": {
    "@Message.ExtendedInfo": [
      {
        "@odata.type": "#Message.v1_1_1.Message",
        "Message": "The request failed due to an internal service error.  The service is still operational.",
        .
        .
        .
      }
    ],
    "code": "Base.1.4.0.InternalError",
    "message": "The request failed due to an internal service error.  The service is still operational."
  }
}

Signed-off-by: Asmitha Karunanithi <asmitk01@in.ibm.com>
Change-Id: I57546adaffc2370c0314a2c2184799c387ec7272
1 file changed
tree: b6631767056cb4865ffa177c5cffe412adb34d5f
  1. http/
  2. include/
  3. redfish-core/
  4. scripts/
  5. src/
  6. static/
  7. subprojects/
  8. .clang-format
  9. .clang-ignore
  10. .clang-tidy
  11. .dockerignore
  12. .gitignore
  13. .shellcheck
  14. bmcweb.service.in
  15. bmcweb.socket
  16. build_x86.sh
  17. build_x86_docker.sh
  18. COMMON_ERRORS.md
  19. DEVELOPING.md
  20. Dockerfile
  21. Dockerfile.base
  22. JenkinsFile
  23. LICENCE
  24. MAINTAINERS
  25. meson.build
  26. meson_options.txt
  27. pam-webserver
  28. README.md
  29. 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/meson_options.txt and then compiling. For example, meson <builddir> -Dkvm=disabled ... followed by ninja in build directory. The option names become C++ preprocessor symbols that control which code is compiled into the program.

Compile bmcweb with default options:

meson builddir
ninja -C builddir

Compile bmcweb with yocto defaults:

meson builddir -Dbuildtype=minsize -Db_lto=true -Dtests=disabled
ninja -C buildir

If any of the dependencies are not found on the host system during configuration, meson automatically gets them via its wrap dependencies mentioned in bmcweb/subprojects.

Enable/Disable meson wrap feature

meson builddir -Dwrap_mode=nofallback
ninja -C builddir

Generate test coverage report:

meson builddir -Db_coverage=true -Dtests=enabled
ninja coverage -C builddir test

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.