Document Identifier: DSP0270 Date: 2020-08-04 Version: 1.3.0 Redfish Host Interface Specification Supersedes: 1.2.0 Document Class: Normative Document Status: Published Document Language: en-US Redfish Host Interface Specification DSP0270 Copyright Notice Copyright © 2014-2020 DMTF. All rights reserved. DMTF is a not-for-profit association of industry members dedicated to promoting enterprise and systems management and interoperability. Members and non-members may reproduce DMTF specifications and documents, provided that correct attribution is given. As DMTF specifications may be revised from time to time, the particular version and release date should always be noted. Implementation of certain elements of this standard or proposed standard may be subject to third party patent rights, including provisional patent rights (herein "patent rights"). DMTF makes no representations to users of the standard as to the existence of such rights, and is not responsible to recognize, disclose, or identify any or all such third party patent right, owners or claimants, nor for any incomplete or inaccurate identification or disclosure of such rights, owners or claimants. DMTF shall have no liability to any party, in any manner or circumstance, under any legal theory whatsoever, for failure to recognize, disclose, or identify any such third party patent rights, or for such party's reliance on the standard or incorporation thereof in its product, protocols or testing procedures. DMTF shall have no liability to any party implementing such standard, whether such implementation is foreseeable or not, nor to any patent owner or claimant, and shall have no liability or responsibility for costs or losses incurred if a standard is withdrawn or modified after publication, and shall be indemnified and held harmless by any party implementing the standard from any and all claims of infringement by a patent owner for such implementations. For information about patents held by third-parties which have notified the DMTF that, in their opinion, such patent may relate to or impact implementations of DMTF standards, visit http://www.dmtf.org/about/ policies/disclosures.php. This document's normative language is English. Translation into other languages is permitted. 2 Published Version 1.3.0 DSP0270 Redfish Host Interface Specification CONTENTS 1 Foreword . 5 1.1 Acknowledgments . 5 2 Abstract . 6 3 Normative references. 7 4 Terms and definitions . 8 5 Symbols and abbreviated terms . 9 6 Introduction . 10 6.1 Scope . 10 6.2 Goals . 10 7 Protocol details . 12 7.1 Network Host Interface protocol details. 12 8 SMBIOS support . 14 8.1 SMBIOS Type 42 structure general layout . 14 8.2 Table 1: SMBIOS Type 42 structure definition for Redfish Host Interfaces . 15 . 8.3 Table 2: Interface Specific Data (for Interface Type 40h) . 15 . 8.3.1 Table 3: Device Type values . 15 . 8.3.2 Table 4: Device Descriptor Data for Device Type 02h (USB Network Interface). 16 . 8.3.3 Table 5: Device Descriptor Data for Device Type 03h (PCI/PCIe Network Interface) . 17 . 8.3.4 Table 6: Device Descriptor Data for Device Type 04h (USB Network Interface v2) . 17 . 8.3.5 Table 7: Device Descriptor Data for Device Type 05h (PCI/PCIe Network Interface v2) . 18 . 8.3.6 Table 8: Device Descriptor Data for Device Types 80h-FFh (OEM) . 19 . 8.3.7 Table 9: Device Characteristics. 19 . 8.4 Table 10: Protocol Records data format . 19 . 8.4.1 Table 11: "Redfish over IP" Protocol Specific Record Data. 19 . 8.4.2 Table 12: Assignment/Discovery Type values. 21 . 8.4.3 Table 13: IP Address Format values . 21 . 8.5 Multiple Protocol Records . 21 9 Credential bootstrapping via IPMI commands . 23 9.1 IPMI command definitions . 23 9.1.1 Get Manager Certificate Fingerprint (NetFn 2Ch, Command 01h) . 23 . 9.1.2 Get Bootstrap Account Credentials (NetFn 2Ch, Command 02h) . 24 . 9.2 Account life cycle. 25 9.3 Recommendations for hosts . 26 10 Delivery of credentials via UEFI runtime variables . 27 10.1 Credential generation and management for use by firmware and OS kernel . 27 10.2 Security considerations for protecting auto-generated credentials . 28 10.3 UEFI implementation . 28 10.3.1 Prototype. 28 10.3.2 Related definitions. 28 10.3.3 Description . 29 10.3.4 Variable format . 29 Version 1.3.0 Published 3 Redfish Host Interface Specification DSP0270 11 ANNEX A (informative) Change log . 31 4 Published Version 1.3.0 DSP0270 Redfish Host Interface Specification 1 Foreword The Redfish Host Interface Specification was prepared by the Redfish Forum of the DMTF. DMTF is a not-for-profit association of industry members dedicated to promoting enterprise and systems management and interoperability. For information about the DMTF, see http://www.dmtf.org. 1.1 Acknowledgments The DMTF acknowledges the following individuals for their contributions to this document: • Jeff Autor - Hewlett Packard Enterprise • Jeff Bobzin - Insyde Software Corp • Patrick Caporale - Lenovo • Phil Chidester - Dell Inc. • Chris Davenport - Hewlett Packard Enterprise • Samer El-Haj-Mahmoud - Lenovo • Jeff Hilland - Hewlett Packard Enterprise • John Leung - Intel Corporation • Edward Newman - Hewlett Packard Enterprise • Michael Raineri - Dell Inc. • Hemal Shah - Broadcom Limited • Paul Vancil - Dell Inc. Version 1.3.0 Published 5 Redfish Host Interface Specification DSP0270 2 Abstract This specification defines functional requirements for Redfish Host Interfaces. In the context of this document, the term "Host Interface" refers to interfaces that can be used by software running on a computer system to access the Redfish Service that is used to manage that computer system. The target audience for this specification is system manufacturers that are providing Redfish Host Interfaces within computer systems, system and component manufactures that are providing devices or firmware that include or support Redfish Host Interfaces, and system firmware and software writers that are creating software or firmware that uses Redfish Host Interfaces. 6 Published Version 1.3.0 DSP0270 Redfish Host Interface Specification 3 Normative references The following referenced documents are indispensable for the application of this document. For dated or versioned references, only the edition cited (including any corrigenda or DMTF update versions) applies. For references without a date or version, the latest published edition of the referenced document (including any corrigenda or DMTF update versions) applies. • DMTF DSP0134 System Management BIOS Reference Specification (SMBIOS), https://www.dmtf.org/standards/ smbios • UEFI Unified Extensible Firmware Interface Specifications (UEFI), http://www.uefi.org/specifications • DMTF DSP0239 Management Component Transport Protocol (MCTP) IDs and Codes, Version 1.4, http://www.dmtf.org/sites/default/files/standards/documents/DSP0239_1.4.pdf • DMTF DSP0266 Redfish Scalable Platforms Management API Specification, http://www.dmtf.org/sites/default/ files/standards/documents/DSP0266_1.0.pdf • ISO/IEC Directives, Part 2 Rules for the structure and drafting of International Standards, http://isotc.iso.org/ livelink/livelink.exe?func=ll&objId=4230456&objAction=browse&sort=subtype • PCI Firmware Specification, PCI SIG http://pcisig.com/specifications/conventional/pci_firmware • IETF RFC4122, A Universally Unique IDentifier (UUID) URN Namespace, The Internet Society, July 2005, http://www.ietf.org/rfc/rfc4122.txt Version 1.3.0 Published 7 Redfish Host Interface Specification DSP0270 4 Terms and definitions In this document, some terms have a specific meaning beyond the normal English meaning. Those terms are defined in this clause. The terms "shall" ("required"), "shall not", "should" ("recommended"), "should not" ("not recommended"), "may", "need not" ("not required"), "can" and "cannot" in this document are to be interpreted as described in ISO/IEC Directives, Part 2, Clause 7. The terms in parenthesis are alternatives for the preceding term, for use in exceptional cases when the preceding term cannot be used for linguistic reasons. Note that ISO/IEC Directives, Part 2, Clause 7 specifies additional alternatives. Occurrences of such additional alternatives shall be interpreted in their normal English meaning. The terms "clause", "subclause", "paragraph", and "annex" in this document are to be interpreted as described in ISO/ IEC Directives, Part 2, Clause 6. The terms "normative" and "informative" in this document are to be interpreted as described in ISO/IEC Directives, Part 2, Clause 3. In this document, clauses, subclauses, or annexes labeled "(informative)" do not contain normative content. Notes and examples are always informative elements. The following additional terms are used in this document. Term Definition Host The Computer System that is managed by a Redfish Service Host The software running on the Host Computer System, including Operating System and its Software components (such as Software drivers or applications), as well as pre-boot software such as UEFI or BIOS drivers and applications. Redfish Also referred to as the "Service". The collection of functionality that implements the protocols, resources, and functions that Service deliver the interface defined by the Redfish API specification and its associated behaviors for one or more managed systems. Redfish Also referred to as "Service Entry Point". The interface through which a particular instance of a Redfish Service is accessed. A Service Entry Redfish Service may have more than one Service Entry Point. Point Redfish Also referred to as "Manager". The