Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / 988fb7b26942a8ddbaa6be4ce34aa4efe4044b43
commit988fb7b26942a8ddbaa6be4ce34aa4efe4044b43[log] [tgz]
authorAdrian Ambrożewicz <adrian.ambrozewicz@linux.intel.com>Mon Jan 13 18:52:46 2020 +0100
committerAgata Olender <agata.olender@intel.com>Tue Mar 31 07:41:12 2020 +0000
tree25bb7bed1c0e2800b63a4b27147c4a1c401c0ba4
parent09d02f87cf3e976a97010baede551d342325f239 [diff]
    Authentication support for Legacy mode

    This change introduces new 'Mount' API argument - UNIX_FD for unnamed pipe.
    This unnamed pipe is utilized to securely send secret data over D-Bus.
    Currently data consists of null-terminated char buffers with username and
    password, that are passed as InsertMedia action parameters.

    Data on receiving side is encapsulated into classes whose role is to:
    - keep secret as short-lived as possible
    - erase secret from memory when it's not needed
    - pass secrets (and format them) to another secure container with above
      capabilities

    New classes:
    - Credentials: is a class encapsulating login and password. It zeroes them
      at destruction.
    - CredentialProvider: contains Credentials, specifies SecureBuffer, allows
      to store credentials in SecureBuffer

    New behavior:
    - When credentials are provided they are encapsulated as char array of two
      null-terminated strings
    - Pipe is opened as a medium to send this buffer
    - UNIX_FD of the pipe source is passed in ‘Mount’ call. Virtual-Media
      service reads from credentials over the pipe

    Tested:
    Manual and automated tests:
    - positive and negative tests for authentication on both CIFS and HTTPS
      resources
    - error injection (ill-formed data transfered over pipe, pipe broken etc.)

Signed-off-by: Agata Olender <agata.olender@intel.com>
Change-Id: I5b330b18c4bff222eab3062abfe27b5adaebf877
1 file changed
tree: 25bb7bed1c0e2800b63a4b27147c4a1c401c0ba4
  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.