docs/designs/redfish-resource-supplement-for-pfr.md

1 # Redfish resource supplement for Platform Firmware Resilience (PFR)
7 Created: 2019-09-12
11 The platform is a collection of fundamental hardware and firmware components
12 needed to boot and operate a system. The Platform Firmware Resiliency(PFR) in
13 NIST SP 800-193 provides technical guidelines and recommendations supporting
14 resiliency of platform firmware and data against potentially destructive
21 represent the PFR provisioning status such as platform firmware is provisioned
27 Platform Firmware Resilience technology in NIST SP 800-93 provide common
31 resiliency by protecting, detecting and recovering platform assets. Management
32 controller running on server platform can be used to indicate the status of
35 - [NIST.SP.180-193](https://nvlpubs.nist.gov/nistpubs/SpecialPublications/NIST.SP.800-193.pdf)
36 - [Redfish schema supplement](https://www.dmtf.org/sites/default/files/standards/documents/DSP0268_…
37 - [Redfish Logging in bmcweb](https://github.com/openbmc/docs/blob/master/architecture/redfish-logg…
43 - BMC shall provide the way to represent Platform Firmware Resilience
46 - Event logs should be logged to redfish for Platform Firmware Resilience.
50 Different OEM's has there own way of implementing the Platform Firmware
51 Resilience by using guidelines provided by NIST SP 800-193. Some of the
53 Processors, Trusted Platform Modules(TPM), PSU's, Memory etc... For example
54 Intel uses the "Intel PFR" design to resiliency platform components.
57 Platform Firmware Resilience. It covers only generic redfish ComputerSystem OEM
64 Platform Firmware Resilience but it provides OEM objects for
65 manufacturer/provider specific extension moniker.
67 Below are property is defined to represent the Platform Firmware Resilience
70 - ProvisiongStatus: The value of this property indicates the provisioning status
71   of platform firmware. It is of Enum Type with below values.
73   1. NotProvisioned: Indicates platform firmware is not provisioned. This is an
76   2. ProvisionedButNotLocked: Indicates that the platform firmware is
77      provisioned but not locked. So re-provisioning is allowed in this state.
79   3. ProvisionedAndLocked: Indicates that the platform firmware is provisioned
80      and locked. So re-provisioning is not allowed in this state.
82 PFR enabled platforms can provision or re-provision the platform resilience
84 states. But once the platform is transitioned to "ProvisionedAndLocked" state,
85 it can not be re-provisioned.
94 [Redfish logging in bmcweb ](https://github.com/openbmc/docs/blob/master/redfish-logging-in-bmcweb.…
100 1. Platform Firmware Resiliency Errors: This is used to log the platform
105    - BIOSFirmwareResiliencyError
106    - BMCFirmwareResiliencyError
107    - CPLDFirmwareResiliencyError
108    - MEFirmwareResiliencyError
109    - FirmwareResiliencyError Severity: Critical
112    specific components.
114    - Boot failure
115    - Update Failure
117 2. Platform Firmware Panic reason: This is used to log the reason for platform
122    - BIOSFirmwarePanicReason
123    - BMCFirmwarePanicReason
124    - CPLDFirmwarePanicReason
125    - MEFirmwarePanicReason Severity: Warning
129    - Boot time watchdog expired
130    - Firmware authentication failure
132 3. Platform Firmware Recovery reasons: This is used to log the reason for last
133    platform firmware component recovery.
137    - BIOSFirmwareRecoveryReason
138    - BMCFirmwareRecoveryReason
139    - CPLDFirmwareRecoveryReason
140    - MEFirmwareRecoveryReason Severity: Warning
144    - Launch failures
145    - Update failures
146    - Authentication failures
198 - User can provision the PFR in OEM specific way and test using below URI and
228 - User can induce security attack and validate the panic event logs as well as