--- 1/draft-ietf-rats-yang-tpm-charra-01.txt 2020-06-24 08:13:33.100452142 -0700 +++ 2/draft-ietf-rats-yang-tpm-charra-02.txt 2020-06-24 08:13:33.172453974 -0700 @@ -1,29 +1,29 @@ RATS Working Group H. Birkholz Internet-Draft M. Eckel Intended status: Standards Track Fraunhofer SIT -Expires: September 12, 2020 S. Bhandari +Expires: December 26, 2020 S. Bhandari B. Sulzen E. Voit Cisco L. Xia Huawei T. Laffey HPE G. Fedorkow Juniper - March 11, 2020 + June 24, 2020 A YANG Data Model for Challenge-Response-based Remote Attestation Procedures using TPMs - draft-ietf-rats-yang-tpm-charra-01 + draft-ietf-rats-yang-tpm-charra-02 Abstract This document defines a YANG RPC and a minimal datastore tree required to retrieve attestation evidence about integrity measurements from a composite device with one or more roots of trust for reporting. Complementary measurement logs are also provided by the YANG RPC originating from one or more roots of trust of measurement. The module defined requires at least one TPM 1.2 or TPM 2.0 and corresponding Trusted Software Stack included in the device @@ -37,21 +37,21 @@ Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet- Drafts is at https://datatracker.ietf.org/drafts/current/. Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress." - This Internet-Draft will expire on September 12, 2020. + This Internet-Draft will expire on December 26, 2020. Copyright Notice Copyright (c) 2020 IETF Trust and the persons identified as the document authors. All rights reserved. This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents @@ -60,29 +60,31 @@ include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License. Table of Contents 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 1.1. Requirements notation . . . . . . . . . . . . . . . . . . 3 2. The YANG Module for Basic Remote Attestation Procedures . . . 3 2.1. Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 3 - 2.2. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 8 - 3. IANA considerations . . . . . . . . . . . . . . . . . . . . . 32 - 4. Security Considerations . . . . . . . . . . . . . . . . . . . 32 - 5. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 32 - 6. Change Log . . . . . . . . . . . . . . . . . . . . . . . . . 32 - 7. References . . . . . . . . . . . . . . . . . . . . . . . . . 32 - 7.1. Normative References . . . . . . . . . . . . . . . . . . 32 - 7.2. Informative References . . . . . . . . . . . . . . . . . 33 - Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 33 + 2.2. YANG Modules . . . . . . . . . . . . . . . . . . . . . . 7 + 2.2.1. ietf-tpm-remote-attestation . . . . . . . . . . . . . 7 + 2.3. ietf-asymmetric-algs . . . . . . . . . . . . . . . . . . 32 + 3. IANA considerations . . . . . . . . . . . . . . . . . . . . . 42 + 4. Security Considerations . . . . . . . . . . . . . . . . . . . 42 + 5. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 42 + 6. Change Log . . . . . . . . . . . . . . . . . . . . . . . . . 43 + 7. References . . . . . . . . . . . . . . . . . . . . . . . . . 43 + 7.1. Normative References . . . . . . . . . . . . . . . . . . 43 + 7.2. Informative References . . . . . . . . . . . . . . . . . 44 + Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 44 1. Introduction This document is based on the terminology defined in the [I-D.ietf-rats-architecture] and uses the interaction model and information elements defined in the [I-D.birkholz-rats-reference-interaction-model] document. The currently supported hardware security modules (HWM) - sometimes also referred to as an embedded secure element (eSE) - is the Trusted Platform Module (TPM) version 1.2 and 2.0 specified by the Trusted @@ -116,246 +118,206 @@ [I-D.birkholz-rats-reference-interaction-model] document. A fresh nonce with an appropriate amount of entropy MUST be supplied by the YANG client in order to enable a proof-of-freshness with respect to the attestation evidence provided by the attester running the YANG datastore. The functions of this YANG module are restricted to 0-1 TPMs per hardware component. 2.1. Tree Diagram module: ietf-tpm-remote-attestation - +--ro rats-support-structures - +--ro supported-algos* uint16 + +--rw rats-support-structures + +--rw supported-algos* identityref +--ro compute-nodes* [node-id] - +--ro node-id string - +--ro node-physical-index? int32 {ietfhw:entity-mib}? - +--ro node-name? string - +--ro node-location? string - +--ro tpms* [tpm-name] - +--ro tpm-name string + | +--ro node-id string + | +--ro node-physical-index? int32 {ietfhw:entity-mib}? + | +--ro node-name? string + | +--ro node-location? string + +--rw tpms* [tpm-name] + +--rw tpm-name string + +--ro hardware-based? boolean +--ro tpm-physical-index? int32 {ietfhw:entity-mib}? + +--ro tpm-path? string + +--ro compute-node compute-node-ref +--ro tpm-manufacturer? string +--ro tpm-firmware-version? string - +--ro tpm-specification-version? string + +--ro tpm-specification-version identityref +--ro tpm-status? string - +--ro certificates* [] - +--ro certificate - +--ro certificate-name? string - +--ro certificate-type? enumeration - +--ro certificate-value? ietfct:end-entity-cert-cms - +--ro lak-public-structure? binary + +--rw certificates + +--rw certificate* [certificate-name] + +--rw certificate-name string + +--rw certificate-ref? leafref + +--rw certificate-type? enumeration rpcs: - +---x tpm12-challenge-response-attestation + +---x tpm12-challenge-response-attestation {TPM12}? | +---w input | | +---w tpm1-attestation-challenge - | | +---w pcr-indices* uint8 + | | +---w pcr-index* pcr | | +---w nonce-value binary - | | +---w TPM_SIG_SCHEME-value uint8 + | | +---w TPM12_Algo? identityref | | +---w (key-identifier)? | | | +--:(public-key) | | | | +---w pub-key-id? binary | | | +--:(TSS_UUID) | | | +---w TSS_UUID-value | | | +---w ulTimeLow? uint32 | | | +---w usTimeMid? uint16 | | | +---w usTimeHigh? uint16 | | | +---w bClockSeqHigh? uint8 | | | +---w bClockSeqLow? uint8 | | | +---w rgbNode* uint8 | | +---w add-version? boolean - | | +---w tpm-name? string - | | +---w tpm-physical-index? int32 {ietfhw:entity-mib}? + | | +---w tpm-name* string | +--ro output - | +--ro tpm12-attestation-response* [tpm-name] - | +--ro tpm-name string - | +--ro tpm-physical-index? int32 {ietfhw:entity-mib}? + | +--ro tpm12-attestation-response* [] + | +--ro certificate-name? string | +--ro up-time? uint32 | +--ro node-id? string - | +--ro node-physical-index? int32 {ietfhw:entity-mib}? + | +--ro node-physical-index? int32 + | | {ietfhw:entity-mib}? | +--ro fixed? binary | +--ro external-data? binary | +--ro signature-size? uint32 | +--ro signature? binary | +--ro (tpm12-quote) | +--:(tpm12-quote1) | | +--ro version* [] | | | +--ro major? uint8 | | | +--ro minor? uint8 | | | +--ro revMajor? uint8 | | | +--ro revMinor? uint8 | | +--ro digest-value? binary | | +--ro TPM_PCR_COMPOSITE* [] - | | +--ro pcr-indices* uint8 + | | +--ro pcr-index* pcr | | +--ro value-size? uint32 | | +--ro tpm12-pcr-value* binary | +--:(tpm12-quote2) | +--ro tag? uint8 - | +--ro pcr-indices* uint8 + | +--ro pcr-index* pcr | +--ro locality-at-release? uint8 | +--ro digest-at-release? binary - +---x tpm20-challenge-response-attestation + +---x tpm20-challenge-response-attestation {TPM20}? | +---w input | | +---w tpm20-attestation-challenge | | +---w nonce-value binary - | | +---w challenge-objects* [node-id tpm-name] - | | +---w node-id string - | | +---w node-physical-index? int32 {ietfhw:entity-mib}? - | | +---w tpm-name string - | | +---w tpm-physical-index? int32 {ietfhw:entity-mib}? - | | +---w pcr-list* [] - | | | +---w pcr - | | | +---w pcr-indices* uint8 - | | | +---w (algo-registry-type) - | | | +--:(tcg) - | | | | +---w tcg-hash-algo-id? uint16 - | | | +--:(ietf) - | | | +---w ietf-ni-hash-algo-id? uint8 - | | +---w (signature-identifier-type) - | | | +--:(TPM_ALG_ID) - | | | | +---w TPM_ALG_ID-value? uint16 - | | | +--:(COSE_Algorithm) - | | | +---w COSE_Algorithm-value? int32 + | | +---w challenge-objects* [] + | | +---w pcr-list* [TPM2_Algo] + | | | +---w TPM2_Algo identityref + | | | +---w pcr-index* tpm:pcr + | | +---w TPM2_Algo? identityref | | +---w (key-identifier)? - | | +--:(public-key) - | | | +---w pub-key-id? binary - | | +--:(uuid) - | | +---w uuid-value? binary + | | | +--:(public-key) + | | | | +---w pub-key-id? binary + | | | +--:(uuid) + | | | +---w uuid-value? binary + | | +---w tpm-name* string | +--ro output - | +--ro tpm20-attestation-response* [node-id tpm-name] - | +--ro tpm-name string - | +--ro tpm-physical-index? int32 {ietfhw:entity-mib}? + | +--ro tpm20-attestation-response* [] + | +--ro certificate-name? string | +--ro up-time? uint32 - | +--ro node-id string - | +--ro node-physical-index? int32 {ietfhw:entity-mib}? + | +--ro node-id? string + | +--ro node-physical-index? int32 + | | {ietfhw:entity-mib}? | +--ro quote? binary | +--ro quote-signature? binary - | +--ro pcr-bank-values* [algo-registry-type] - | | +--ro (algo-registry-type) - | | | +--:(tcg) - | | | | +--ro tcg-hash-algo-id? uint16 - | | | +--:(ietf) - | | | +--ro ietf-ni-hash-algo-id? uint8 + | +--ro pcr-bank-values* [] + | | +--ro TPM2_Algo? identityref | | +--ro pcr-values* [pcr-index] - | | +--ro pcr-index uint16 + | | +--ro pcr-index pcr | | +--ro pcr-value? binary | +--ro pcr-digest-algo-in-quote - | +--ro (algo-registry-type) - | +--:(tcg) - | | +--ro tcg-hash-algo-id? uint16 - | +--:(ietf) - | +--ro ietf-ni-hash-algo-id? uint8 + | +--ro TPM2_Algo? identityref +---x basic-trust-establishment | +---w input | | +---w nonce-value binary - | | +---w (signature-identifier-type) - | | | +--:(TPM_ALG_ID) - | | | | +---w TPM_ALG_ID-value? uint16 - | | | +--:(COSE_Algorithm) - | | | +---w COSE_Algorithm-value? int32 - | | +---w tpm-name? string - | | +---w tpm-physical-index? int32 {ietfhw:entity-mib}? + | | +---w TPM2_Algo? identityref + | | +---w tpm-name* string | | +---w certificate-name? string | +--ro output - | +--ro attestation-certificates* [tpm-name] - | +--ro tpm-name string - | +--ro tpm-physical-index? int32 {ietfhw:entity-mib}? - | +--ro up-time? uint32 - | +--ro node-id? string - | +--ro node-physical-index? int32 {ietfhw:entity-mib}? - | +--ro certificate-name? string - | +--ro attestation-certificate? ietfct:end-entity-cert-cms + | +--ro attestation-certificates* [] + | +--ro attestation-certificate? ct:end-entity-cert-cms | +--ro (key-identifier)? | +--:(public-key) | | +--ro pub-key-id? binary | +--:(uuid) | +--ro uuid-value? binary +---x log-retrieval +---w input - | +---w log-selector* [node-id tpm-name] - | | +---w node-id string - | | +---w node-physical-index? int32 {ietfhw:entity-mib}? - | | +---w tpm-name string - | | +---w tpm-physical-index? int32 {ietfhw:entity-mib}? + | +---w log-selector* [] + | | +---w tpm-name* string | | +---w (index-type)? | | | +--:(last-entry) | | | | +---w last-entry-value? binary | | | +--:(index) | | | | +---w last-index-number? uint64 | | | +--:(timestamp) | | | +---w timestamp? yang:date-and-time | | +---w log-entry-quantity? uint16 - | | +---w pcr-list* [] - | | +---w pcr - | | +---w pcr-indices* uint8 - | | +---w (algo-registry-type) - | | +--:(tcg) - | | | +---w tcg-hash-algo-id? uint16 - | | +--:(ietf) - | | +---w ietf-ni-hash-algo-id? uint8 | +---w log-type identityref +--ro output +--ro system-event-logs - +--ro node-data* [node-id tpm-name] - +--ro node-id string - +--ro node-physical-index? int32 {ietfhw:entity-mib}? + +--ro node-data* [] +--ro up-time? uint32 - +--ro tpm-name string - +--ro tpm-physical-index? int32 {ietfhw:entity-mib}? + +--ro certificate-name? string +--ro log-result - +--ro (log-type) + +--ro (attested-event-log-type) +--:(bios) | +--ro bios-event-logs | +--ro bios-event-entry* [event-number] | +--ro event-number uint32 | +--ro event-type? uint32 - | +--ro pcr-index? uint16 + | +--ro pcr-index? pcr | +--ro digest-list* [] - | | +--ro (algo-registry-type) - | | | +--:(tcg) - | | | | +--ro tcg-hash-algo-id? uint16 - | | | +--:(ietf) - | | | +--ro ietf-ni-hash-algo-id? uint8 + | | +--ro hash-algo? identityref | | +--ro digest* binary | +--ro event-size? uint32 | +--ro event-data* uint8 +--:(ima) +--ro ima-event-logs +--ro ima-event-entry* [event-number] +--ro event-number uint64 +--ro ima-template? string +--ro filename-hint? string +--ro filedata-hash? binary +--ro filedata-hash-algorithm? string +--ro template-hash-algorithm? string +--ro template-hash? binary - +--ro pcr-index? uint16 + +--ro pcr-index? pcr +--ro signature? binary -2.2. YANG Module +2.2. YANG Modules - This YANG module imports modules from [RFC6991], [RFC8348], and - [I-D.ietf-netconf-crypto-types]. +2.2.1. ietf-tpm-remote-attestation - file ietf-tpm-remote-attestation@2019-01-07.yang + This YANG module imports modules from [RFC6991], [RFC8348], + [I-D.ietf-netconf-crypto-types], ietf-asymmetric-algs.yang. + + file ietf-tpm-remote-attestation@2020-06-23.yang module ietf-tpm-remote-attestation { namespace "urn:ietf:params:xml:ns:yang:ietf-tpm-remote-attestation"; - prefix "yang-rats-charra"; + prefix "tpm"; import ietf-yang-types { prefix yang; } import ietf-hardware { prefix ietfhw; } import ietf-crypto-types { - prefix ietfct; + prefix ct; + } + import ietf-keystore { + prefix ks; + } + import ietf-asymmetric-algs { + prefix aa; } organization "IETF RATS (Remote ATtestation procedureS) Working Group"; contact "WG Web : WG List : Author : Henk Birkholz Author : Michael Eckel @@ -365,106 +327,162 @@ Author : Liang Xia (Frank) Author : Tom Laffey Author : Guy Fedorkow "; description "A YANG module to enable a TPM 1.2 and TPM 2.0 based remote attestation procedure using a challenge-response interaction model and the TPM 1.2 and TPM 2.0 Quote primitive operations. - Copyright (c) 2020 IETF Trust and the persons identified - as authors of the code. All rights reserved. + Copyright (c) 2020 IETF Trust and the persons identified as + authors of the code. All rights reserved. - Redistribution and use in source and binary forms, with - or without modification, is permitted pursuant to, and - subject to the license terms contained in, the Simplified - BSD License set forth in Section 4.c of the IETF Trust's - Legal Provisions Relating to IETF Documents + Redistribution and use in source and binary forms, with or + without modification, is permitted pursuant to, and subject to + the license terms contained in, the Simplified BSD License set + forth in Section 4.c of the IETF Trust's Legal Provisions + Relating to IETF Documents + (https://trustee.ietf.org/license-info). + + Redistribution and use in source and binary forms, with or + without modification, is permitted pursuant to, and subject to + the license terms contained in, the Simplified BSD License set + forth in Section 4.c of the IETF Trust's Legal Provisions + Relating to IETF Documents (https://trustee.ietf.org/license-info). This version of this YANG module is part of RFC XXXX - (https://www.rfc-editor.org/info/rfcXXXX); see the RFC - itself for full legal notices. + (https://www.rfc-editor.org/info/rfcXXXX); see the RFC itself + for full legal notices. - The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', - 'SHALL NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', - 'NOT RECOMMENDED', 'MAY', and 'OPTIONAL' in this document - are to be interpreted as described in BCP 14 (RFC 2119) - (RFC 8174) when, and only when, they appear in all - capitals, as shown here."; + The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL + NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'NOT RECOMMENDED', + 'MAY', and 'OPTIONAL' in this document are to be interpreted as + described in BCP 14 (RFC 2119) (RFC 8174) when, and only when, + they appear in all capitals, as shown here."; - revision "2020-03-09" { + revision "2020-06-23" { description "Initial version"; reference "draft-ietf-rats-yang-tpm-charra"; } /*****************/ - /* Groupings */ + /* Features */ /*****************/ - grouping hash-algo { - description - "A selector for the hashing algorithm"; - choice algo-registry-type { - mandatory true; + feature TPM12 { description - "Unfortunately, both IETF and TCG have registries here. - Choose your weapon wisely."; - case tcg { + "This feature indicates that an Attester includes cryptoprocessors + capable of supporting the TPM 1.2 API."; + } + + feature TPM20 { description - "You chose the east door, the tcg space opens up to - you."; - leaf tcg-hash-algo-id { - type uint16; + "This feature indicates that an Attester includes cryptoprocessors + capable of supporting the TPM 2 API."; + + } + + /*****************/ + /* Typedefs */ + /*****************/ + + typedef pcr { + type uint8 { + range "0..31"; + } description - "This is an index referencing the TCG Algorithm - Registry based on TPM_ALG_ID."; + "Valid index number for a PCR. At this point 0-31 is viable."; } + + typedef compute-node-ref { + type leafref { + path "/tpm:rats-support-structures/tpm:compute-nodes/tpm:node-name"; } - case ietf { description - "You chose the west door, the ietf space opens up to - you."; + "This type is used to reference a hardware node. It is quite possible + this leafref will eventually point to another YANG module's node."; + } - leaf ietf-ni-hash-algo-id { - type uint8; + /******************/ + /* Identities */ + /******************/ + + identity attested-event-log-type { description - "This is an index referencing the Named Information - Hash Algorithm Registry."; + "Base identity allowing categorization of the reasons why and + attested measurement has been taken on an Attester."; } + + identity ima { + base attested-event-log-type; + description + "An event type recorded in IMA."; } + + identity bios { + base attested-event-log-type; + description + "An event type associated with BIOS/UEFI."; } + + identity cryptoprocessor { + description + "Base identity identifying a crytoprocessor."; } - grouping hash { + identity tpm12 { + base cryptoprocessor; description - "The hash value including hash-algo identifier"; - list hash-digests { + "A cryptoprocessor capable of supporting the TPM 1.2 API."; + } + + identity tpm20 { + base cryptoprocessor; description - "The list of hashes."; - container hash-digest { + "A cryptoprocessor capable of supporting the TPM 2.0 API."; + } + + /*****************/ + /* Groupings */ + /*****************/ + + grouping TPM2_Algo { description - "A hash value based on a hash algorithm registered by an - SDO."; - uses hash-algo; - leaf hash-value { - type binary; + "The signature scheme that is used to sign the TPM2 Quote + information response."; + leaf TPM2_Algo { + type identityref { + base aa:tpm2-asymmetric-algorithm; + } description - "The binary representation of the hash value."; + "The signature scheme that is used to sign the TPM + Quote information response."; } } + + grouping TPM12_Algo { + description + "The signature scheme that is used to sign the TPM2 Quote + information response."; + leaf TPM12_Algo { + type identityref { + base aa:tpm12-asymmetric-algorithm; + } + description + "The signature scheme that is used to sign the TPM1.2 + Quote information response."; } } - grouping nonce { description "A nonce to show freshness and counter replays."; leaf nonce-value { type binary; mandatory true; description "This nonce SHOULD be generated via a registered cryptographic-strength algorithm. In consequence, the length of the nonce depends on the hash algorithm @@ -475,128 +493,48 @@ } grouping tpm12-pcr-selection { description "A Verifier can request one or more PCR values using its individually created Attestation Key Certificate (AC). The corresponding selection filter is represented in this grouping. Requesting a PCR value that is not in scope of the AC used, detailed exposure via error msg should be avoided."; - leaf-list pcr-indices { - type uint8; + leaf-list pcr-index { + type pcr; description "The numbers/indexes of the PCRs. At the moment this is limited to 32."; } } grouping tpm20-pcr-selection { description - "A Verifier can request one or more PCR values uses its - individually created AC. The corresponding selection filter is - represented in this grouping. Requesting a PCR value that is not - in scope of the AC used, detailed exposure via error msg should - be avoided."; - list pcr-list { - description - "For each PCR in this list an individual list of banks - (hash-algo) can be requested. It depends on the datastore, if - every bank in this grouping is included per PCR (crude), or if - each requested bank set is returned for each PCR individually - (elegant)."; - container pcr { - description - "The composite of a PCR number and corresponding bank - numbers."; - leaf-list pcr-indices { - type uint8; - description - "The number of the PCR. At the moment this is limited - 32"; - } - uses hash-algo; - } - } - } - - grouping pcr-selector { - description - "A Verifier can request the generation of an attestation - certificate (a signed public attestation key - (non-migratable, tpm-resident) wrt one or more PCR values. - - The corresponding creation input is represented in this grouping. - Requesting a PCR value that is not supported results in an error, - detailed exposure via error msg should be avoided."; + "A Verifier can acquire one or more PCR values, which are hashed + together in a TPM2B_DIGEST coming from the TPM2. The selection + list of desired PCRs and the Hash Algorithm is represented in this + grouping."; list pcr-list { + key "TPM2_Algo"; description - "For each PCR in this list an individual hash-algo can be - requested."; - container pcr { - description - "The composite of a PCR number and corresponding bank - numbers."; + "Specifies the list of PCRs and Hash Algorithms used for the + latest returned TPM2B_DIGEST."; + reference + "https://www.trustedcomputinggroup.org/wp-content/uploads/ + TPM-Rev-2.0-Part-2-Structures-01.38.pdf Section 10.9.7"; + uses tpm:TPM2_Algo; leaf-list pcr-index { - type uint8; + type tpm:pcr; description "The numbers of the PCRs that are associated with - the created key. At the moment the highest number is 32"; - } - uses hash-algo; - } - } - } - - grouping tpm12-signature-scheme { - description - "The signature scheme used to sign the evidence via a TPM 1.2."; - leaf TPM_SIG_SCHEME-value { - type uint8; - mandatory true; - description - "Selects the signature scheme that is used to sign the TPM - Quote information response. Allowed values can be found in - the table at the bottom of page 32 in the TPM 1.2 Structures - specification (Level 2 Revision 116, 1 March 2011)."; - } - } - - grouping tpm20-signature-scheme { - description - "The signature scheme used to sign the evidence."; - choice signature-identifier-type { - mandatory true; - description - "There are multiple ways to reference a signature type. - This used to select the signature algo to sign the quote - information response."; - case TPM_ALG_ID { - description - "This references the indices of table 9 in the TPM 2.0 - structure specification."; - leaf TPM_ALG_ID-value { - type uint16; - description - "The TCG Algorithm Registry ID value."; - } - } - case COSE_Algorithm { - description - "This references the IANA COSE Algorithms Registry indices. - Every index of this registry to be used must be mapable to a - TPM_ALG_ID value."; - leaf COSE_Algorithm-value { - type int32; - description - "The IANA COSE Algorithms ID value."; - } + the created key."; } } } grouping tpm12-attestation-key-identifier { description "A selector for a suitable key identifier for a TPM 1.2."; choice key-identifier { description "Identifier for the attestation key to use for signing @@ -676,43 +613,57 @@ description "Use a YANG agent generated (and maintained) attestation key UUID."; leaf uuid-value { type binary; description "The UUID identifying the corresponding public key."; } } } + } - grouping tpm-identifier { + grouping certificate-name { description - "In a system with multiple-TPMs get the data from a specific TPM - identified by the name and physical-index."; + "An arbitrary name for the identity certificate chain requested."; + leaf certificate-name { + type string; + description + "An arbitrary name for the identity certificate chain requested."; + } + } + + grouping tpm-name { + description + "Path to a unique TPM on a device."; leaf tpm-name { type string; description - "Name value of a single TPM or 'All'"; + "Unique system generated name for a TPM on a device."; } - leaf tpm-physical-index { - if-feature ietfhw:entity-mib; - type int32 { - range "1..2147483647"; } + + grouping tpm-name-selector { + description + "One or more TPM on a device."; + leaf-list tpm-name { + type string; config false; description - "The entPhysicalIndex for the TPM."; - reference - "RFC 6933: Entity MIB (Version 4) - entPhysicalIndex"; + "Name of one or more unique TPMs on a device. If this object exists, + a selection should pull only the objects related to these TPM(s). If + it does not exist, all qualifying TPMs that are 'hardware-based' + equals true on the device are selected."; } } + grouping compute-node-identifier { description "In a distributed system with multiple compute nodes this is the node identified by name and physical-index."; leaf node-id { type string; description "ID of the compute node, such as Board Serial Number."; } leaf node-physical-index { @@ -855,21 +806,21 @@ leaf-list tpm12-pcr-value { type binary; description "The list of TPM_PCRVALUEs from each PCR selected in sequence of tpm12-pcr-selection."; } list version-info { description "An optional output parameter from a TPM 1.2 TPM_Quote2."; leaf tag { - type uint16; + type uint16; /* This should be converted into an ENUM */ description "The TPM 1.2 version and revision (TPM 1.2 type TPM_STRUCTURE_TAG). This MUST be TPM_CAP_VERSION_INFO (0x0030)"; } uses tpm12-version; leaf spec-level { type uint16; description "A number indicating the level of ordinals supported."; @@ -926,49 +877,104 @@ grouping node-uptime { description "Uptime in seconds of the node."; leaf up-time { type uint32; description "Uptime in seconds of this node reporting its data"; } } - identity log-type { + grouping tpm12-attestation { description - "The type of logs available."; + "Contains an instance of TPM1.2 style signed cryptoprocessor + measurements. It is supplemented by unsigned Attester information."; + uses certificate-name; + uses node-uptime; + uses compute-node-identifier; + uses tpm12-quote-info-common; + choice tpm12-quote { + mandatory true; + description + "Either a tpm12-quote-info or tpm12-quote-info2, depending + on whether TPM_Quote or TPM_Quote2 was used + (cf. input field add-verson)."; + case tpm12-quote1 { + description + "BIOS/UEFI event logs"; + uses tpm12-quote-info; + uses tpm12-pcr-composite; } - - identity bios { - base log-type; + case tpm12-quote2 { description - "Measurement log created by the BIOS/UEFI."; + "BIOS/UEFI event logs"; + uses tpm12-quote-info2; } - - identity ima { - base log-type; + } + } + grouping tpm20-attestation { description - "Measurement log created by IMA."; + "Contains an instance of TPM2 style signed cryptoprocessor + measurements. It is supplemented by unsigned Attester information."; + uses certificate-name; + uses node-uptime; + uses compute-node-identifier; + leaf quote { + type binary; + description + "Quote data returned by TPM Quote, including PCR selection, + PCR digest and etc."; + } + leaf quote-signature { + type binary; + description + "Quote signature returned by TPM Quote."; + } + list pcr-bank-values { + /* This often should not be necessary for TPM2, as the information + if validated will need to be coming from the 'quote' leaf */ + description + "PCR values in each PCR bank."; + uses TPM2_Algo; + list pcr-values { + key pcr-index; + description + "List of one PCR bank."; + leaf pcr-index { + type pcr; + description + "PCR index number."; + } + leaf pcr-value { + type binary; + description + "PCR value."; + } + } + } + container pcr-digest-algo-in-quote { + uses TPM2_Algo; + description + "The hash algorithm for PCR value digest in Quote output."; + } } - grouping log-identifier { description "Identifier for type of log to be retrieved."; leaf log-type { type identityref { - base log-type; + base attested-event-log-type; } mandatory true; description "The corresponding measurement log type identity."; } - } grouping boot-event-log { description "Defines an event log corresponding to the event that extended the PCR"; leaf event-number { type uint32; description "Unique event number of this event"; @@ -972,32 +978,41 @@ type uint32; description "Unique event number of this event"; } leaf event-type { type uint32; description "log event type"; } leaf pcr-index { - type uint16; + type pcr; description "Defines the PCR index that this event extended"; } list digest-list { - description "Hash of event data"; - uses hash-algo; + description + "Hash of event data"; + leaf hash-algo { + type identityref { + base aa:asymmetric-algorithm-type; + } + description + "The hash scheme that is used to compress the event data in each of + the leaf-list digest items."; + } leaf-list digest { type binary; description "The hash of the event data"; } + } leaf event-size { type uint32; description "Size of the event data"; } leaf-list event-data { type uint8; description "The event data size determined by event-size"; @@ -1037,21 +1052,21 @@ type string; description "Algorithm used for template-hash"; } leaf template-hash { type binary; description "hash(filedata-hash, filename-hint)"; } leaf pcr-index { - type uint16; + type pcr; description "Defines the PCR index that this event extended"; } leaf signature { type binary; description "The file signature"; } } @@ -1075,21 +1090,21 @@ "Ordered list of ima event logs by event-number"; uses ima-event; } description "Measurement log created by IMA."; } grouping event-logs { description "A selector for the log and its type."; - choice log-type { + choice attested-event-log-type { mandatory true; description "Event log type determines the event logs content."; case bios { description "BIOS/UEFI event logs"; container bios-event-logs { description "This is an index referencing the TCG Algorithm Registry based on TPM_ALG_ID."; @@ -1099,218 +1114,158 @@ case ima { description "IMA event logs"; container ima-event-logs { description "This is an index referencing the TCG Algorithm Registry based on TPM_ALG_ID."; uses ima-event-log; } } - } } /**********************/ /* RPC operations */ /**********************/ rpc tpm12-challenge-response-attestation { + if-feature "TPM12"; description "This RPC accepts the input for TSS TPM 1.2 commands of the managed device. ComponentIndex from the hardware manager YANG module to refer to dedicated TPM in composite devices, e.g. smart NICs, is still a TODO."; input { container tpm1-attestation-challenge { description "This container includes every information element defined in the reference challenge-response interaction model for remote attestation. Corresponding values are based on TPM 1.2 structure definitions"; uses tpm12-pcr-selection; uses nonce; - uses tpm12-signature-scheme; + uses TPM12_Algo; uses tpm12-attestation-key-identifier; leaf add-version { type boolean; description "Whether or not to include TPM_CAP_VERSION_INFO; if true, then TPM_Quote2 must be used to create the response."; } - uses tpm-identifier; + uses tpm-name-selector; + /* if this scheme is desired, we should define XPATH to limit + selection to just 'tpm-name' that are '../tpm-specification-version' + equals 'TPM12' and where '../hardware-based' equals 'true' */ } } output { list tpm12-attestation-response { - key tpm-name; description "The binary output of TPM 1.2 TPM_Quote/TPM_Quote2, including the PCR selection and other associated attestation evidence metadata"; - uses tpm-identifier; - uses node-uptime; - uses compute-node-identifier; - uses tpm12-quote-info-common; - choice tpm12-quote { - mandatory true; - description - "Either a tpm12-quote-info or tpm12-quote-info2, depending - on whether TPM_Quote or TPM_Quote2 was used - (cf. input field add-verson)."; - case tpm12-quote1 { - description - "BIOS/UEFI event logs"; - uses tpm12-quote-info; - uses tpm12-pcr-composite; - } - case tpm12-quote2 { - description - "BIOS/UEFI event logs"; - uses tpm12-quote-info2; - } - } + uses tpm12-attestation; } } } rpc tpm20-challenge-response-attestation { + if-feature "TPM20"; description "This RPC accepts the input for TSS TPM 2.0 commands of the managed device. ComponentIndex from the hardware manager YANG module to refer to dedicated TPM in composite devices, e.g. smart NICs, is still a TODO."; input { container tpm20-attestation-challenge { description "This container includes every information element defined in the reference challenge-response interaction model for remote attestation. Corresponding values are based on TPM 2.0 structure definitions"; uses nonce; list challenge-objects { - key "node-id tpm-name"; description "Nodes to fetch attestation information, PCR selection and AK identifier."; - uses compute-node-identifier; - uses tpm-identifier; uses tpm20-pcr-selection; - uses tpm20-signature-scheme; + uses TPM2_Algo; uses tpm20-attestation-key-identifier; + uses tpm-name-selector; + /* if this scheme is desired, we should define XPATH to limit + selection to just 'tpm-name' that are '../tpm-specification-version' + equals 'TPM2' and where '../hardware-based' equals 'true' */ } } } output { list tpm20-attestation-response { - key "node-id tpm-name"; + unique "certificate-name"; /* should have XPATH making this mandatory + when there is more than one list entry */ description "The binary output of TPM2b_Quote in one TPM chip of the node which identified by node-id. An TPMS_ATTEST structure including a length, encapsulated in a signature"; - uses tpm-identifier; - uses node-uptime; - uses compute-node-identifier; - leaf quote { - type binary; - description - "Quote data returned by TPM Quote, including PCR selection, - PCR digest and etc."; - } - leaf quote-signature { - type binary; - description - "Quote signature returned by TPM Quote."; - } - list pcr-bank-values { - key algo-registry-type; - description - "PCR values in each PCR bank."; - uses hash-algo; - list pcr-values { - key pcr-index; - description - "List of one PCR bank."; - leaf pcr-index { - type uint16; - description - "PCR index number."; - } - leaf pcr-value { - type binary; - description - "PCR value."; - } - } - } - container pcr-digest-algo-in-quote { - uses hash-algo; - description - "The hash algorithm for PCR value digest in - Quote output."; - } + uses tpm20-attestation; } } } + rpc basic-trust-establishment { description "This RPC creates a tpm-resident, non-migratable key to be used in TPM_Quote commands, an attestation certificate."; input { uses nonce; - uses tpm20-signature-scheme; - uses tpm-identifier; - leaf certificate-name { + uses TPM2_Algo; + leaf-list tpm-name { + when "not(../certificate-name)"; /* ensures both are not populated */ type string; description - "An arbitrary name for the identity certificate chain - requested."; + "Path to a unique TPM on a device. If there are no elements in the + leaf-list, all TPMs which are 'hardware-based' should have keys + established."; + } + uses certificate-name { + description + "It is possible to request a new certificate using the old one as a + reference."; } } output { list attestation-certificates { - key tpm-name; description "Attestation Certificate data from a TPM identified by the TPM name"; - uses tpm-identifier; - uses node-uptime; - uses compute-node-identifier; - leaf certificate-name { - type string; - description - "An arbitrary name for this identity certificate or - certificate chain."; - } leaf attestation-certificate { - type ietfct:end-entity-cert-cms; + type ct:end-entity-cert-cms; description "The binary signed certificate chain data for this identity certificate."; } uses tpm20-attestation-key-identifier; } } + } rpc log-retrieval { description "Logs Entries are either identified via indices or via providing the last line received. The number of lines returned can be limited. The type of log is a choice that can be augmented."; input { list log-selector { - key "node-id tpm-name"; description "Selection of log entries to be reported."; - uses compute-node-identifier; - uses tpm-identifier; + uses tpm-name-selector; choice index-type { description "Last log entry received, log index number, or timestamp."; case last-entry { description "The last entry of the log already retrieved."; leaf last-entry-value { type binary; description "Content of an log event which matches 1:1 with a @@ -1342,183 +1297,746 @@ description "Timestamp from which to start the extraction."; } } leaf log-entry-quantity { type uint16; description "The number of log entries to be returned. If omitted, it means all of them."; } - uses tpm20-pcr-selection; } uses log-identifier; } output { container system-event-logs { description "The requested data of the measurement event logs"; list node-data { - key "node-id tpm-name"; + unique "certificate-name"; description "Event logs of a node in a distributed system identified by the node name"; - uses compute-node-identifier; uses node-uptime; - uses tpm-identifier; + uses certificate-name; container log-result { description "The requested entries of the corresponding log."; uses event-logs; } } } } } - /*********************************/ - /* Protocol accessible nodes */ - /*********************************/ + /**************************************/ + /* Config & Oper accessible nodes */ + /**************************************/ container rats-support-structures { - config false; description "The datastore definition enabling verifiers or relying parties to discover the information necessary to use the remote attestation RPCs appropriately."; leaf-list supported-algos { - type uint16; + config true; + type identityref { + base aa:asymmetric-algorithm-type; + } description - "Supported TPM_ALG_ID values for the TPM in question. - Will include ComponentIndex soon."; + "Supported algorithms values for an Attester."; } list compute-nodes { + config false; key node-id; uses compute-node-identifier; description - "A list names of hardware componnets in this composite + "A list names of hardware components in this composite device that RATS can be conducted with."; leaf node-name { type string; description "Name of the compute node."; } leaf node-location { type string; description "Location of the compute node, such as slot number."; } + } list tpms { key tpm-name; - uses tpm-identifier; + unique "tpm-path"; description "A list of TPMs in this composite device that RATS can be conducted with."; + uses tpm-name; + leaf hardware-based { + config false; + type boolean; + description + "Answers the question: is this TPM is a hardware based TPM?"; + } + leaf tpm-physical-index { + if-feature ietfhw:entity-mib; + config false; + type int32 { + range "1..2147483647"; + } + description + "The entPhysicalIndex for the TPM."; + reference + "RFC 6933: Entity MIB (Version 4) - entPhysicalIndex"; + } + leaf tpm-path { + type string; + config false; + description + "Path to a unique TPM on a device. This can change agross reboots."; + } + + leaf compute-node { + when "../../compute-nodes"; + config false; + mandatory true; + type compute-node-ref; + description + "When there is more that one TPM, this indicates for which + compute node this TPM services."; + } leaf tpm-manufacturer { + config false; type string; description "TPM manufacturer name."; } leaf tpm-firmware-version { + config false; type string; description "TPM firmware version."; } leaf tpm-specification-version { - type string; + type identityref { + base cryptoprocessor; + } + config false; + mandatory true; description - "TPM1.2 or TPM2.0."; + "Identifies the cryptoprocessor API set supported"; } leaf tpm-status { type string; + config false; description "TPM chip self-test status, normal or abnormal."; } - list certificates { + container certificates { description "The TPM's certificates, including EK certificates and AK certificates."; - container certificate { + list certificate { + config true; + key "certificate-name"; description "Three types of certificates can be accessed via this statement, including Initial Attestation Key Cert, Local Attestation Key Cert or Endorsement Key Cert."; - leaf certificate-name { - type string; + uses certificate-name; + leaf certificate-ref { + type leafref { + path "/ks:keystore/ks:asymmetric-keys/ks:asymmetric-key" + + "/ks:certificates/ks:certificate/ks:name"; + } description - "An arbitrary name for this identity certificate - or certificate chain."; + "A reference to a specific certificate of an + asymmetric key in the Keystore."; + /* Note: It is also possible to import a grouping which allows + local definition via an imported keystore schema. */ } leaf certificate-type { type enumeration { enum endorsement-cert { value 0; description - "EK Cert type."; + "Endorsement Key (EK) Certificate type."; } enum initial-attestation-cert { value 1; description - "IAK Cert type."; + "Initial Attestation key (IAK) Certificate type."; } enum local-attestation-cert { value 2; description - "LAK Cert type."; + "Local Attestation Key (LAK) Certificate type."; } } description "Type of this certificate"; } - leaf certificate-value { - type ietfct:end-entity-cert-cms; + } + } + } + } +} + +2.3. ietf-asymmetric-algs + + Cryptographic algorithm types were initially included within -v14 + NETCONF's iana-crypto-types.yang. Unfortunately all this content + including the algorithms needed here failed to make the -v15 used + WGLC. Therefore a modified version of this draft is included here. + Perhaps someone will steward this list as a separate draft. + + ietf-asymmetric-algs@2020-06-12.yang +module ietf-asymmetric-algs { + yang-version 1.1; + namespace "urn:ietf:params:xml:ns:yang:ietf-asymmetric-algs"; + prefix aa; + + organization + "IETF NETCONF (Network Configuration) Working Group"; + + contact + "WG Web: + WG List: + Author: Eric Voit + Author: Kent Watsen + Author: Wang Haiguang "; + description - "The binary signed public endorsement key (EK), - attestation key(AK) and corresponding claims - (EK,AK Certificate). In a TPM 2.0 the EK, - AK Certificate resides in a well-defined NVRAM - location by the TPM vendor. Maybe certificate-value - defined as binary type is a simple way."; + "This module defines a identities for asymmetric algorithms. + + Copyright (c) 2020 IETF Trust and the persons identified + as authors of the code. All rights reserved. + Redistribution and use in source and binary forms, with + or without modification, is permitted pursuant to, and + subject to the license terms contained in, the Simplified + BSD License set forth in Section 4.c of the IETF Trust's + Legal Provisions Relating to IETF Documents + (https://trustee.ietf.org/license-info). + This version of this YANG module is part of RFC XXXX + (https://www.rfc-editor.org/info/rfcXXXX); see the RFC + itself for full legal notices. + The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', + 'SHALL NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', + 'NOT RECOMMENDED', 'MAY', and 'OPTIONAL' in this document + are to be interpreted as described in BCP 14 (RFC 2119) + (RFC 8174) when, and only when, they appear in all + capitals, as shown here."; + + revision 2020-06-12 { + description + "Initial version"; + + reference + "RFC XXXX: tbd + initial draft: draft-voit-rats-trusted-path-routing + concepts from ietf-asymmetric-algs.yang which did not progress to + WGLC in NETCONF."; } - leaf lak-public-structure { - type binary; + + /*****************/ + /* Features */ + /*****************/ + + feature TPM12 { description - "Marshalled LAK public structure, used for LAK - Certificate verification"; + "This feature indicates support for the TPM 1.2 API."; + } + + feature TPM20 { + description + "This feature indicates support for the TPM 2.0 API."; + } + + feature iana { + description + "This feature indicates support for the IANA algorithms defined + in Registry xxxxx"; + } + + /*****************/ + /* Identities */ + /*****************/ + + /* There needs to be collasping/verification of some of the identity types + between the various algorithm types listed below */ + + identity asymmetric-algorithm-type { + description + "Base identity identityerating various asymmetric key algorithms."; + } + + identity iana-asymmetric-algorithm { + base asymmetric-algorithm-type; + description + "Base identity identityerating various asymmetric key algorithms."; + } + + identity tpm12-asymmetric-algorithm { + base asymmetric-algorithm-type; + description + "Base identity identityerating various asymmetric key algorithms."; + reference + "TPM-Main-Part-2-TPM-Structures_v1.2_rev116_01032011.pdf + TPM_ALGORITHM_ID values, page 18"; + } + + identity tpm2-asymmetric-algorithm { + base asymmetric-algorithm-type; + description + "Base identity identityerating various asymmetric key algorithms."; + reference + "TPM-Rev-2.0-Part-2-Structures-01.38.pdf + The TCG Algorithm Registry ID value. Table 9"; + } + + identity rsa { + base tpm12-asymmetric-algorithm; + base tpm2-asymmetric-algorithm; + description + "RFC 3447 - the RSA algorithm"; + } + + identity rsa1024 { + if-feature "iana"; + base iana-asymmetric-algorithm; + base rsa; + description + "The RSA algorithm using a 1024-bit key."; + reference + "RFC 8017: PKCS #1: RSA Cryptography Specifications Version 2.2."; + } + + identity rsa2048 { + if-feature "iana"; + base iana-asymmetric-algorithm; + base rsa; + description + "The RSA algorithm using a 2048-bit key."; + reference + "RFC 8017: PKCS #1: RSA Cryptography Specifications Version 2.2."; + } + + identity rsa3072 { + if-feature "iana"; + base iana-asymmetric-algorithm; + base rsa; + description + "The RSA algorithm using a 3072-bit key."; + + reference + "RFC 8017: PKCS #1: RSA Cryptography Specifications Version 2.2."; + } + + identity rsa4096 { + if-feature "iana"; + base iana-asymmetric-algorithm; + base rsa; + description + "The RSA algorithm using a 4096-bit key."; + reference + "RFC 8017: PKCS #1: RSA Cryptography Specifications Version 2.2."; + } + + identity rsa7680 { + if-feature "iana"; + base iana-asymmetric-algorithm; + base rsa; + description + "The RSA algorithm using a 7680-bit key."; + reference + "RFC 8017: PKCS #1: RSA Cryptography Specifications Version 2.2."; + } + + identity rsa15360 { + if-feature "iana"; + base iana-asymmetric-algorithm; + base rsa; + description + "The RSA algorithm using a 15360-bit key."; + reference + "RFC 8017: PKCS #1: RSA Cryptography Specifications Version 2.2."; + } + + identity secp192r1 { + if-feature "iana"; + base iana-asymmetric-algorithm; + description + "The asymmetric algorithm using a NIST P192 Curve."; + reference + "RFC 6090: Fundamental Elliptic Curve Cryptography Algorithms. + RFC 5480: Elliptic Curve Cryptography Subject Public Key + Information."; + } + + identity secp224r1 { + if-feature "iana"; + base iana-asymmetric-algorithm; + description + "The asymmetric algorithm using a NIST P224 Curve."; + reference + "RFC 6090: Fundamental Elliptic Curve Cryptography Algorithms. + RFC 5480: Elliptic Curve Cryptography Subject Public Key + Information."; + } + + identity secp256r1 { + if-feature "iana"; + base iana-asymmetric-algorithm; + description + "The asymmetric algorithm using a NIST P256 Curve."; + reference + "RFC 6090: Fundamental Elliptic Curve Cryptography Algorithms. + RFC 5480: Elliptic Curve Cryptography Subject Public Key + Information."; + } + + identity secp384r1 { + base iana-asymmetric-algorithm; + description + "The asymmetric algorithm using a NIST P384 Curve."; + reference + "RFC 6090: Fundamental Elliptic Curve Cryptography Algorithms. + RFC 5480: Elliptic Curve Cryptography Subject Public Key + Information."; + } + + identity secp521r1 { + if-feature "iana"; + base iana-asymmetric-algorithm; + description + "The asymmetric algorithm using a NIST P521 Curve."; + reference + "RFC 6090: Fundamental Elliptic Curve Cryptography Algorithms. + RFC 5480: Elliptic Curve Cryptography Subject Public Key + Information."; + } + + identity x25519 { + if-feature "iana"; + base iana-asymmetric-algorithm; + description + "The asymmetric algorithm using a x.25519 Curve."; + reference + "RFC 7748: Elliptic Curves for Security."; + } + identity x448 { + if-feature "iana"; + base iana-asymmetric-algorithm; + description + "The asymmetric algorithm using a x.448 Curve."; + reference + "RFC 7748: Elliptic Curves for Security."; + } + + identity SHA1 { + if-feature "TPM20 or TPM12"; + base tpm12-asymmetric-algorithm; + base tpm2-asymmetric-algorithm; + description + "ISO/IEC 10118-3 - SHA1 algorithm"; + } + + identity HMAC { + if-feature "TPM20 or TPM12"; + base tpm12-asymmetric-algorithm; + base tpm2-asymmetric-algorithm; + description + "ISO/IEC 9797-2 - Hash Message Authentication Code (HMAC) algorithm + also RFC2014. + we need to verify if NMAC implementation isn't different in the two."; + } + + identity AES { + if-feature "TPM20 or TPM12"; + base tpm2-asymmetric-algorithm; + description + "ISO/IEC 18033-3 - the AES algorithm"; + } + + identity AES128 { + if-feature "TPM12"; + base tpm12-asymmetric-algorithm; + base AES; + description + "ISO/IEC 18033-3 - the AES algorithm, key size 128"; + } + + identity AES192 { + if-feature "TPM12"; + base tpm12-asymmetric-algorithm; + base AES; + description + "ISO/IEC 18033-3 - the AES algorithm, key size 192"; + + } + + identity AES256 { + if-feature "TPM12"; + base tpm12-asymmetric-algorithm; + base AES; + description + "ISO/IEC 18033-3 - the AES algorithm, key size 256"; + } + + identity MGF1 { + if-feature "TPM20"; + base tpm2-asymmetric-algorithm; + description + "IEEE Std 1363a -2004 - hash-based mask-generation function"; + } + identity KEYEDHASH { + if-feature "TPM20"; + base tpm2-asymmetric-algorithm; + description + "TPM2 KEYEDHASH - an encryption or signing algorithm using a keyed hash"; + } + + identity XOR { + if-feature "TPM20 or TPM12"; + base tpm12-asymmetric-algorithm; + base tpm2-asymmetric-algorithm; + description + "TPM2 XOR"; + } + + identity SHA256 { + if-feature "TPM20"; + base tpm2-asymmetric-algorithm; + description + "ISO/IEC 10118-3 - the SHA 256 algorithm"; + } + + identity SHA384 { + if-feature "TPM20"; + base tpm2-asymmetric-algorithm; + description + "ISO/IEC 10118-3 - the SHA 384 algorithm"; + } + + identity SHA512 { + if-feature "TPM20"; + base tpm2-asymmetric-algorithm; + description + "ISO/IEC 10118-3 - the SHA 512 algorithm"; + } + + identity NULL { + if-feature "TPM20"; + base tpm2-asymmetric-algorithm; + description + "TPM2 NULL"; + } + + identity SM3_256 { + if-feature "TPM20"; + base tpm2-asymmetric-algorithm; + description + "GM/T 0004-2012 - SM3_256"; + } + + identity SM4 { + if-feature "TPM20"; + base tpm2-asymmetric-algorithm; + description + "GM/T 0004-2012 - SM4 symmetric block cipher"; } + + identity RSASSA { + if-feature "TPM20"; + base tpm2-asymmetric-algorithm; + description + "RFC 3447 - defined in section 8.2 (RSASSAPKCS1-v1_5)"; } + + identity RSAES { + if-feature "TPM20"; + base tpm2-asymmetric-algorithm; + description + "RFC 3447 - defined in section 7.2 (RSAES-PKCS1-v1_5)"; } + + identity RSAPSS { + if-feature "TPM20"; + base tpm2-asymmetric-algorithm; + description + "RFC 3447 - defined in section 8.1 (RSASSA PSS)"; } + + identity OAEP { + if-feature "TPM20"; + base tpm2-asymmetric-algorithm; + description + "RFC 3447 - defined in section 7.1 (RSASSA OAEP)"; } + identity ECDSA { + if-feature "TPM20"; + base tpm2-asymmetric-algorithm; + description + "ISO/IEC 14888-3 - elliptic curve cryptography (ECC)"; } + + identity ECDH { + if-feature "TPM20"; + base tpm2-asymmetric-algorithm; + description + "NIST SP800-56A - secret sharing using ECC"; + } + + identity ECDAA { + if-feature "TPM20"; + base tpm2-asymmetric-algorithm; + description + "TPM2 - elliptic-curve based anonymous signing scheme"; + } + + identity SM2 { + if-feature "TPM20"; + base tpm2-asymmetric-algorithm; + description + "A GM/T 0003.1-2012, GM/T 0003.2-2012, GM/T 0003.3-2012, + GM/T 0003.5-2012 SM2"; + } + + identity ECSCHNORR { + if-feature "TPM20"; + base tpm2-asymmetric-algorithm; + description + "TPM2 - elliptic-curve based Schnorr signature"; + } + + identity ECMQV { + if-feature "TPM20"; + base tpm2-asymmetric-algorithm; + description + "NIST SP800-56A - two-phase elliptic-curve key"; + } + identity KDF1_SP800_56A { + if-feature "TPM20"; + base tpm2-asymmetric-algorithm; + description + "NIST SP800-56A - concatenation key derivation function, + (approved alternative1) section 5.8.1"; + } + + identity KDF2 { + if-feature "TPM20"; + base tpm2-asymmetric-algorithm; + description + "IEEE 1363a-2004 - key derivation function KDF2 section 13.2"; + } + + identity KDF1_SP800_108 { + if-feature "TPM20"; + base tpm2-asymmetric-algorithm; + description + "NIST SP800-108 - Section 5.1 KDF in Counter Mode"; + } + + identity ECC { + if-feature "TPM20"; + base tpm2-asymmetric-algorithm; + description + "ISO/IEC 15946-1 - prime field ECC"; + } + + identity SYMCIPHER { + if-feature "TPM20"; + base tpm2-asymmetric-algorithm; + description + "TPM2 - object type for a symmetric block cipher"; + } + + identity CAMELLIA { + if-feature "TPM20"; + base tpm2-asymmetric-algorithm; + description + "ISO/IEC 18033-3 - the Camellia algorithm"; + } + + identity CTR { + if-feature "TPM20"; + base tpm2-asymmetric-algorithm; + description + "ISO/IEC 10116 - Counter mode"; + + } + + identity OFB { + if-feature "TPM20"; + base tpm2-asymmetric-algorithm; + description + "ISO/IEC 10116 - Output Feedback mode"; + } + + identity CBC { + if-feature "TPM20"; + base tpm2-asymmetric-algorithm; + description + "ISO/IEC 10116 - Cipher Block Chaining mode"; + } + + identity CFB { + if-feature "TPM20"; + base tpm2-asymmetric-algorithm; + description + "ISO/IEC 10116 - Cipher Feedback mode"; + } + + identity ECB { + if-feature "TPM20"; + base tpm2-asymmetric-algorithm; + description + "ISO/IEC 10116 - Electronic Codebook mode"; + } + } 3. IANA considerations This document will include requests to IANA: To be defined yet. 4. Security Considerations There are always some. 5. Acknowledgements Not yet. 6. Change Log + Changes from version 01 to version 02: + + o Extracted Crypto-types into a separate YANG file + + o Mades the algorithms explicit, not strings + + o Hash Algo as key the selected TPM2 PCRs + + o PCR numbers are their own type + + o Eliminated nested keys for node-id plus tpm-name + + o Eliminated TPM-Name of "ALL" + + o Added TPM-Path + Changes from version 00 to version 01: o Addressed author's comments o Extended complementary details about attestation-certificates o Relabeled chunk-size to log-entry-quantity o Relabeled location with compute-node or tpm-name where appropriate @@ -1533,23 +2051,23 @@ 7.1. Normative References [I-D.birkholz-rats-reference-interaction-model] Birkholz, H. and M. Eckel, "Reference Interaction Models for Remote Attestation Procedures", draft-birkholz-rats- reference-interaction-model-02 (work in progress), January 2020. [I-D.ietf-netconf-crypto-types] - Watsen, K. and H. Wang, "Common YANG Data Types for - Cryptography", draft-ietf-netconf-crypto-types-14 (work in - progress), March 2020. + Watsen, K., "Common YANG Data Types for Cryptography", + draft-ietf-netconf-crypto-types-15 (work in progress), May + 2020. [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/RFC2119, March 1997, . [RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types", RFC 6991, DOI 10.17487/RFC6991, July 2013, . @@ -1560,21 +2078,21 @@ [RFC8348] Bierman, A., Bjorklund, M., Dong, J., and D. Romascanu, "A YANG Data Model for Hardware Management", RFC 8348, DOI 10.17487/RFC8348, March 2018, . 7.2. Informative References [I-D.ietf-rats-architecture] Birkholz, H., Thaler, D., Richardson, M., Smith, N., and W. Pan, "Remote Attestation Procedures Architecture", - draft-ietf-rats-architecture-02 (work in progress), March + draft-ietf-rats-architecture-04 (work in progress), May 2020. Authors' Addresses Henk Birkholz Fraunhofer SIT Rheinstrasse 75 Darmstadt 64295 Germany