Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / 017848263e97e6eb9f7d486071a616626fec0591
commit017848263e97e6eb9f7d486071a616626fec0591[log] [tgz]
authorJohnathan Mantey <johnathanx.mantey@intel.com>Tue Jun 18 12:44:21 2019 -0700
committerEd Tanous <ed.tanous@intel.com>Fri Sep 13 21:31:32 2019 +0000
tree03b73816878a4499df62e29a8478c38634ff43b2
parentdac62eefae32e5a2be5fc918af2ec39c7ca39ea6 [diff]
Redfish: Make NIC HW reflect PATCH changes

PATCH commands only changed the state of the DBus database. The PATCH
did not actually change the state of the NIC settings. IPMITOOL and
"ip addr" both delete the specific hash entry, and then create a new
entry using the requested state. This change aligns Redfish with that
behavior. The requested element is deleted, and subsequently recreated
with the new values. This guarantees the NIC HW is actually updated,
and in sync with the DBus database.

Tested by:
From eth1 modify eth0 state:
IPv4 tests:
Delete all addresses
Create five new addresses
Add a new entry to the end of the collection
Delete the new entry just added
Send a "keep" command that does not modify any state, and "keeps" more
  entries than are actually in the IPv4Addresses collection
Keep all entries, and delete entries that do not exist
Delete all entries except self assigned
Send a PATCH with an empty IPv4StaticAddresses array

IPv6 tests:
Delete all entries except SLAAC
Create five static entries
Modify only the prefix for one entry
Modify only the address for one entry
Add an additional entry
Delete the new entry
Keep all entries, plus a few that don't exist
Keep all entries, delete a few that don't exist
Delete all entries except SLAAC
Send a PATCH with an empty IPv6StaticAddresses array

Change-Id: Id5f733f795588ba36b5d3ab3b0017a01ee3f2da7
Signed-off-by: Johnathan Mantey <johnathanx.mantey@intel.com>
1 file changed
tree: 03b73816878a4499df62e29a8478c38634ff43b2
  1. cmake/
  2. crow/
  3. include/
  4. redfish-core/
  5. scripts/
  6. src/
  7. static/
  8. .clang-format
  9. .clang-tidy
  10. .gitignore
  11. aspeed_purley.cmake
  12. bmcweb.service.in
  13. bmcweb.socket
  14. build_x86.sh
  15. cmake-format.json
  16. CMakeLists.txt
  17. CMakeLists.txt.in
  18. DEVELOPING.md
  19. JenkinsFile
  20. LICENCE
  21. MAINTAINERS
  22. pam-webserver
  23. README.md
  24. 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 prime256v1 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.

Crow patches

The crow project has had a number of additions to make it more useful for use in the OpenBmc Project. A non-exhaustive list is below. At the time of this writing, the crow project is not accepting patches, so for the time being crow will simply be checked in as is.

  • Applied clang-format to the whole crow tree. This was done without regard for arrays and fixed data structures, but was deemed to be overall better than the inconsistent formatting that existed in upstream previously.
  • Crow server now calls stop before destruction of the Crow app object.
  • Fixed a bug where timed out websockets would seg fault the system by accessing a destroyed socket object without null checks when in SSL mode.
  • Added a TestSocketAdapter class that could be used to unit test server behavior without utilizing a socket.
  • Added the "getRoutes" call to both the app and the routing Trie class that allows consumers to poll the server for all (or a subset of) registered web routes in the system.
  • Hardcoded the websocket implementation for binary mode, instead of leaving protocol unspecified.
  • Move most uses of std::unordered_map to boost::flat_map to lower memory consumption, and (in some cases) to improve memory locality.
  • Adjust the addHeaders mechanism to use a fixed string instead of a full map implementation to avoid unnecessary mallocs and reduce the number of scatter gather buffers on an http response.
  • Change server name header from Crow/0.1 to iBMC
  • Starts the http server io_context inside the main thread, instead of creating a new thread.
  • Removes all BMCWEB_MSVC_WORKAROUND flags.
  • Removes the behavior that causes a 301 redirect for paths that end in "/", and simply returns the endpoint requested. This was done for redfish compatibility.
  • Removes the built in crow/json.hpp package and adds nlohmann json package as the first class json package for crow.
  • Move uses of boost::array to std::array where possible.
  • Add the ability to get a reference to the crow::Request object on websocket connection to allow checking header values.
  • Patch http handler to call middlewares on websocket connections to allow authentication to be applied appropriately.
  • Adds an is_secure flag to provide information about whether or not the payload was delivered over ssl.