ibm-openbmc / bmcweb Goto Github PK

View Code? Open in Web Editor NEW

11.0 13.0 71.0 26.47 MB

Home Page: https://github.com

License: Apache License 2.0

Shell 0.01% C++ 97.97% Python 1.21% CSS 0.01% Meson 0.80%

bmcweb's Introduction

OpenBMC webserver

This component attempts to be a "do everything" embedded webserver for OpenBMC.

Features

The webserver implements a few distinct interfaces:

DBus event websocket. Allows registering on changes to specific dbus paths, properties, and will send an event from the websocket if those filters match.
OpenBMC DBus REST api. Allows direct, low interference, high fidelity access to dbus and the objects it represents.
Serial: A serial websocket for interacting with the host serial console through websockets.
Redfish: A protocol compliant, DBus to Redfish translator.
KVM: A websocket based implementation of the RFB (VNC) frame buffer protocol intended to mate to webui-vue to provide a complete KVM implementation.

Protocols

bmcweb at a protocol level supports http and https. TLS is supported through OpenSSL.

AuthX

Authentication

Bmcweb supports multiple authentication protocols:

Basic authentication per RFC7617
Cookie based authentication for authenticating against webui-vue
Mutual TLS authentication based on OpenSSL
Session authentication through webui-vue
XToken based authentication conformant to Redfish DSP0266

Each of these types of authentication is able to be enabled or disabled both via runtime policy changes (through the relevant Redfish APIs) or via configure time options. All authentication mechanisms supporting username/password are routed to libpam, to allow for customization in authentication implementations.

Authorization

All authorization in bmcweb is determined at routing time, and per route, and conform to the Redfish PrivilegeRegistry.

*Note: Non-Redfish functions are mapped to the closest equivalent Redfish privilege level.

Configuration

bmcweb is configured per the meson build files. Available options are documented in meson_options.txt

Compile bmcweb with default options

meson builddir
ninja -C builddir

If any of the dependencies are not found on the host system during configuration, meson will automatically download them via its wrap dependencies mentioned in bmcweb/subprojects.

Debug logging

bmcweb by default is compiled with runtime logging disabled, as a performance consideration. To enable it in a standalone build, add the

-Dlogging='enabled'

option to your configure flags. If building within Yocto, add the following to your local.conf.

EXTRA_OEMESON:pn-bmcweb:append = "-Dbmcweb-logging='enabled'"

Use of persistent data

bmcweb relies on some on-system data for storage of persistent data that is internal to the process. Details on the exact data stored and when it is read/written can seen from the persistent_data namespace.

TLS certificate generation

When SSL support is enabled and a usable certificate is not found, bmcweb will generate a self-signed a certificate before launching the server. Please see the bmcweb source code for details on the parameters this certificate is built with.

bmcweb's People

Contributors

Stargazers

Watchers

Forkers

gtmills santoshpuranik ratagupt trajeswaran msbarth antwil smccarney anoo1 jaypadath geissonator wistron-corporation joseph-reynolds lxwinspur aahmed-2 patelabhishek9893 rameshiyyar isaacpk joshua-andersen1 vflobo priyangaramasamy zhanghaodi zamiseck cjcain sunnysrivastava1984 lkammath giridharikrishna murali-srinivasan zhanghch05 spinler bjwyman baileysh tomippolito sbteeks fnichols3 baemyung chicagoduan lakshmi-y devenrao ninadpalsule 00mjk manojkiraneda jpallenibm jeaaustx archanakakani patel-kamalkumar ojayanth web-logs2 web-logs2 gcpin dashbaord202401 dashbaord202401 alpana07 sunharis giridharikrishnan cmjishnu asmithakarun swethaparasa nkotania abhilashraju deepakala-k isha309 rfrandse raviteja-b pavithrab7

bmcweb's Issues

redfish/v1/JsonSchemas does not show OEM schemas

Get on redfish/v1/JsonSchema only returns DMTF redfish schemas. No OEM schema are listed.

To reproduce:
Curl -k -H "X-Auth-Token: $token" -X GET "https://$bmc/redfish/v1/JsonSchemas"
Look at output, see if OEMAssembly or other OEM schemas are there.

Note:
Curl -k -H "X-Auth-Token: $token" -X GET "https://$bmc/redfish/v1/JsonSchemas/<OemSchema_Name>" returns valid output.

Failed to get FiremwareVersion property via `redfish/v1/Chassis/chassis`

Unable to get FiremwareVersion attribute using redfish/v1/Chassis/chassis command.
Because when the GetSubTree method is called, the interface parameter passed in is xyz.openbmc_project.Inventory.Item.Chassis, so the service name that can only be obtained is xzy.openbmc_project.Inventory.Manager, but there is no xyz.openbmc_project.Software.Version interface here, so this judgment will never enter.

https://github.com/ibm-openbmc/bmcweb/blob/1020/redfish-core/lib/chassis.hpp#L416-L454

Update Assembly Schema To Populate Status::State

Similar to how we look at Operational Status to set the Status::Health Redfish property (See #202), we can look at the Present property on D-Bus to set the Status::State property

If Present is true, set Status::State to Enabled, else set it to Absent.

Excess traces in the ThermalMetrics Query

ThermalMetrics works but see excess traces in the Journal

curl -k https://$mybmc/redfish/v1/Chassis/chassis/ThermalSubsystem/ThermalMetrics/
{
  "@odata.id": "/redfish/v1/Chassis/chassis/ThermalSubsystem/ThermalMetrics",
  "@odata.type": "#ThermalMetrics.v1_0_0.ThermalMetrics",
  "Id": "ThermalMetrics",
  "Name": "Chassis Thermal Metrics",
  "TemperatureReadingsCelsius": [
    {
      "@odata.id": "/redfish/v1/Chassis/chassis/Sensors/PCIE_1_Temp",
      "DataSourceUri": "/redfish/v1/Chassis/chassis/Sensors/PCIE_1_Temp",
      "DeviceName": "PCIE_1_Temp",
      "Reading": 29.0
    },
    {
      "@odata.id": "/redfish/v1/Chassis/chassis/Sensors/NVMe_JBOF_Card_1_Temp",
      "DataSourceUri": "/redfish/v1/Chassis/chassis/Sensors/NVMe_JBOF_Card_1_Temp",
      "DeviceName": "NVMe_JBOF_Card_1_Temp",
      "Reading": 46.563
    },
    {
      "@odata.id": "/redfish/v1/Chassis/chassis/Sensors/NVMe_JBOF_Card_1_Local_Temp",

(2022-01-27 02:44:35) [ERROR "sensors.hpp":3290] Unsure how to handle sensorType fan_tach
(2022-01-27 02:44:35) [ERROR "sensors.hpp":3290] Unsure how to handle sensorType fan_tach
(2022-01-27 02:44:35) [ERROR "sensors.hpp":3290] Unsure how to handle sensorType fan_tach
(2022-01-27 02:44:35) [ERROR "sensors.hpp":3290] Unsure how to handle sensorType fan_tach
(2022-01-27 02:44:35) [ERROR "sensors.hpp":3290] Unsure how to handle sensorType fan_tach
(2022-01-27 02:44:35) [ERROR "sensors.hpp":3290] Unsure how to handle sensorType fan_tach

Need LocationIndicatorActive defined for fabric adapters

Need LocationIndicatorActive as an OEM property for the fabric adapters.