1038c52e0SEd Tanous# OpenBMC webserver # 2038c52e0SEd Tanous 3038c52e0SEd TanousThis component attempts to be a "do everything" embedded webserver for openbmc. 4038c52e0SEd Tanous 5038c52e0SEd Tanous 6038c52e0SEd Tanous## Capabilities ## 7038c52e0SEd TanousAt this time, the webserver implements a few interfaces: 8038c52e0SEd Tanous+ Authentication middleware that supports cookie and token based authentication, as well as CSRF prevention backed by linux PAM authentication credentials. 9038c52e0SEd Tanous+ 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. 10038c52e0SEd Tanous+ Replication of the rest-dbus backend interfaces to allow bmc debug to logged in users. 11038c52e0SEd Tanous+ 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. 12976596bcSJoseph Reynolds+ SSL key generation at runtime. See the configuration section for details. 13038c52e0SEd Tanous+ 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. 14038c52e0SEd Tanous+ 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. 15038c52e0SEd Tanous 16976596bcSJoseph Reynolds## Configuration 17976596bcSJoseph Reynolds 18976596bcSJoseph ReynoldsBMCWeb is configured by setting `-D` flags that correspond to options 19976596bcSJoseph Reynoldsin `bmcweb/CMakeLists.txt` and then compiling. For example, `cmake 20976596bcSJoseph Reynolds-DBMCWEB_ENABLE_KVM=NO ...` followed by `make`. The option names 21976596bcSJoseph Reynoldsbecome C++ preprocessor symbols that control which code is compiled 22976596bcSJoseph Reynoldsinto the program. 23976596bcSJoseph Reynolds 24976596bcSJoseph ReynoldsWhen BMCWeb starts running, it reads persistent configuration data 25976596bcSJoseph Reynolds(such as UUID and session data) from a local file. If this is not 26976596bcSJoseph Reynoldsusable, it generates a new configuration. 27976596bcSJoseph Reynolds 28976596bcSJoseph ReynoldsWhen BMCWeb SSL support is enabled and a usable certificate is not 29976596bcSJoseph Reynoldsfound, it will generate a self-sign a certificate before launching the 30976596bcSJoseph Reynoldsserver. The keys are generated by the `prime256v1` algorithm. The 31976596bcSJoseph Reynoldscertificate 32*85d2bb5bSBrad Bishop - is issued by `C=US, O=OpenBMC, CN=testhost`, 33976596bcSJoseph Reynolds - is valid for 10 years, 34976596bcSJoseph Reynolds - has a random serial number, and 35976596bcSJoseph Reynolds - is signed using the `SHA-256` algorithm. 36038c52e0SEd Tanous 37038c52e0SEd Tanous## Crow patches ## 38038c52e0SEd TanousThe 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. 39038c52e0SEd Tanous 40038c52e0SEd Tanous+ 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. 41038c52e0SEd Tanous+ Crow server now calls stop before destruction of the Crow app object. 42038c52e0SEd Tanous+ 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. 43038c52e0SEd Tanous+ Added a TestSocketAdapter class that could be used to unit test server behavior without utilizing a socket. 4455c7b7a2SEd Tanous+ 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. 45038c52e0SEd Tanous+ Hardcoded the websocket implementation for binary mode, instead of leaving protocol unspecified. 46038c52e0SEd Tanous+ Move most uses of std::unordered_map to boost::flat_map to lower memory consumption, and (in some cases) to improve memory locality. 4755c7b7a2SEd Tanous+ 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. 48038c52e0SEd Tanous+ Change server name header from Crow/0.1 to iBMC 498f626357SEd Tanous+ Starts the http server io_context inside the main thread, instead of creating a new thread. 5055c7b7a2SEd Tanous+ Removes all BMCWEB_MSVC_WORKAROUND flags. 51038c52e0SEd Tanous+ 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. 52038c52e0SEd Tanous+ Removes the built in crow/json.hpp package and adds nlohmann json package as the first class json package for crow. 53038c52e0SEd Tanous+ Move uses of boost::array to std::array where possible. 5455c7b7a2SEd Tanous+ Add the ability to get a reference to the crow::Request object on websocket connection to allow checking header values. 55038c52e0SEd Tanous+ Patch http handler to call middlewares on websocket connections to allow authentication to be applied appropriately. 56038c52e0SEd Tanous+ Adds an is_secure flag to provide information about whether or not the payload was delivered over ssl. 57038c52e0SEd Tanous 58