Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / b477fd4408bc0602cc86147121f03791d3f4824a
commitb477fd4408bc0602cc86147121f03791d3f4824a[log] [tgz]
authorP Dheeraj Srujan Kumar <p.dheeraj.srujan.kumar@intel.com>Thu Dec 16 07:17:51 2021 +0530
committerP Dheeraj Srujan Kumar <p.dheeraj.srujan.kumar@intel.com>Fri Dec 24 10:58:23 2021 +0000
treec67956a1eea672824d6676ec6df5feba883f0c4d
parentd1a648140e3cadd0ea6b0014c4d61ec880742000 [diff]
Enable encoding/decoding object paths of User Name

Any string used to form a Dbus object path needs to be encoded.
This commit enables encoding the User Name before it is used as
Object path and decodes the object path to get the user readable
text.

The encoding is essemtial while getting details of a user,
deleting user and modifying properties of user as we need
the object path for these actions.
Decoding and getting the User name using object_path.filename()
is essential to display the user name in human readable format.

Tested:
 - Successfully created new user using POST to
   /redfish/v1/AccountService/Accounts
   with body
   {
     "UserName": "_test_6566",
     "Password": "openbmc123",
     "RoleId": "NoAccess",
     "Enabled": true
   }
   and it created a Dbus Object:
   /xyz/openbmc_project/user/_5ftest_5f6566

 - GET on
   displayed all user names in correct human redable
   format.
   Example: The user name for
   /xyz/openbmc_project/user/_5ftest_5f6566
   was displayed as "_test_6566"

 - Successfully fetched user Detais by GET to
   /redfish/v1/AccountService/Accounts/<UserName>

 - Successfully modified user details by PATCH to
   /redfish/v1/AccountService/Accounts/<UserName>
   Example body:
   {
     Enabled: false
   }

 - Successfully removed user by DELETE to
   /redfish/v1/AccountService/Accounts/<UserName>
   removed the user with given name
   Example: Deleting _test_6566 actually removed
   /xyz/openbmc_project/user/_5ftest_5f6566 object
   path successfully.

Signed-off-by: P Dheeraj Srujan Kumar <p.dheeraj.srujan.kumar@intel.com>
Change-Id: I6e7559f7543ee504e2f8c137911f42887eb4cf16
1 file changed
tree: c67956a1eea672824d6676ec6df5feba883f0c4d
  1. .github/
  2. http/
  3. include/
  4. redfish-core/
  5. scripts/
  6. src/
  7. static/
  8. subprojects/
  9. .clang-format
  10. .clang-ignore
  11. .clang-tidy
  12. .dockerignore
  13. .gitignore
  14. .shellcheck
  15. bmcweb.service.in
  16. bmcweb.socket.in
  17. bmcweb_config.h.in
  18. build_x86.sh
  19. build_x86_docker.sh
  20. COMMON_ERRORS.md
  21. DEVELOPING.md
  22. Dockerfile
  23. Dockerfile.base
  24. LICENSE
  25. MAINTAINERS
  26. meson.build
  27. meson_options.txt
  28. OEM_SCHEMAS.md
  29. OWNERS
  30. pam-webserver
  31. README.md
  32. Redfish.md
  33. setup.cfg
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

Enable debug traces

meson builddir -Dbuildtype=debug
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.