{"id":18368741,"url":"https://github.com/openbmc/bmcweb","last_synced_at":"2025-04-06T20:09:06.970Z","repository":{"id":37484656,"uuid":"116327333","full_name":"openbmc/bmcweb","owner":"openbmc","description":"A do everything Redfish, KVM, GUI, and DBus webserver for OpenBMC","archived":false,"fork":false,"pushed_at":"2024-04-13T21:13:30.000Z","size":124075,"stargazers_count":141,"open_issues_count":20,"forks_count":125,"subscribers_count":41,"default_branch":"master","last_synced_at":"2024-04-14T05:37:46.691Z","etag":null,"topics":["boost-asio","boost-beast","dbus","openbmc","redfish","redfish-api","ssl","webserver","websocket-connection"],"latest_commit_sha":null,"homepage":"","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openbmc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2018-01-05T01:50:42.000Z","updated_at":"2024-04-15T16:14:41.136Z","dependencies_parsed_at":"2023-12-25T10:28:59.043Z","dependency_job_id":"cb1a5af7-a2c3-4195-a477-4fffdca45f2f","html_url":"https://github.com/openbmc/bmcweb","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openbmc%2Fbmcweb","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openbmc%2Fbmcweb/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openbmc%2Fbmcweb/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openbmc%2Fbmcweb/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openbmc","download_url":"https://codeload.github.com/openbmc/bmcweb/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247543589,"owners_count":20955865,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["boost-asio","boost-beast","dbus","openbmc","redfish","redfish-api","ssl","webserver","websocket-connection"],"created_at":"2024-11-05T23:27:12.839Z","updated_at":"2025-04-06T20:09:06.919Z","avatar_url":"https://github.com/openbmc.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OpenBMC webserver\n\nThis component attempts to be a \"do everything\" embedded webserver for OpenBMC.\n\n## Features\n\nThe webserver implements a few distinct interfaces:\n\n- DBus event websocket. Allows registering on changes to specific dbus paths,\n  properties, and will send an event from the websocket if those filters match.\n- OpenBMC DBus REST api. Allows direct, low interference, high fidelity access\n  to dbus and the objects it represents.\n- Serial: A serial websocket for interacting with the host serial console\n  through websockets.\n- Redfish: A protocol compliant, [DBus to Redfish translator](Redfish.md).\n- KVM: A websocket based implementation of the RFB (VNC) frame buffer protocol\n  intended to mate to webui-vue to provide a complete KVM implementation.\n\n## Protocols\n\nbmcweb at a protocol level supports http and https. TLS is supported through\nOpenSSL.\n\n## AuthX\n\n### Authentication\n\nBmcweb supports multiple authentication protocols:\n\n- Basic authentication per RFC7617\n- Cookie based authentication for authenticating against webui-vue\n- Mutual TLS authentication based on OpenSSL\n- Session authentication through webui-vue\n- XToken based authentication conformant to Redfish DSP0266\n\nEach of these types of authentication is able to be enabled or disabled both via\nruntime policy changes (through the relevant Redfish APIs) or via configure time\noptions. All authentication mechanisms supporting username/password are routed\nto libpam, to allow for customization in authentication implementations.\n\n### Authorization\n\nAll authorization in bmcweb is determined at routing time, and per route, and\nconform to the Redfish PrivilegeRegistry.\n\n\\*Note: Non-Redfish functions are mapped to the closest equivalent Redfish\nprivilege level.\n\n## Configuration\n\nbmcweb is configured per the\n[meson build files](https://mesonbuild.com/Build-options.html). Available\noptions are documented in `meson_options.txt`\n\n## Compile bmcweb with default options\n\n```ascii\nmeson setup builddir\nninja -C builddir\n```\n\nIf any of the dependencies are not found on the host system during\nconfiguration, meson will automatically download them via its wrap dependencies\nmentioned in `bmcweb/subprojects`.\n\n## Use of persistent data\n\nbmcweb relies on some on-system data for storage of persistent data that is\ninternal to the process. Details on the exact data stored and when it is\nread/written can seen from the `persistent_data` namespace.\n\n## TLS certificate generation\n\nWhen SSL support is enabled and a usable certificate is not found, bmcweb will\ngenerate a self-signed a certificate before launching the server. Please see the\nbmcweb source code for details on the parameters this certificate is built with.\n\n## Redfish Aggregation\n\nbmcweb is capable of aggregating resources from satellite BMCs. Refer to\n[AGGREGATION.md](https://github.com/openbmc/bmcweb/blob/master/AGGREGATION.md)\nfor more information on how to enable and use this feature.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenbmc%2Fbmcweb","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenbmc%2Fbmcweb","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenbmc%2Fbmcweb/lists"}