tpm-key_attestation 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b370d3aabc86bde782bf8cf6a6507f85edf56a676875fd4511c30dd4ddff1da
-  data.tar.gz: 53ce92d16a1ab22b573236c0a859c8ebec4c6172679b22d957e6ebf3347d4531
+  metadata.gz: 060cbdfedb9cd4519611fb5d388035957e57adafaad608de0d98c4448a4dda51
+  data.tar.gz: 34dd516159fe8fe5d761c8fbbd263b43db23ed2976911fc36dc847b54d18b5e7
 SHA512:
-  metadata.gz: 407f2c3dadf408a90c536cb5723e52ebc28e12f89231b93c6915ba182b7773960c256c7a2d5cc087bb3af02bf14522518cdafc279783321e3f0812daafe7b405
-  data.tar.gz: '0787cf34b0c204ed54391766fceafdf28fb1fcc5a453887b0a8f671f13f6c4b89f9f562e6ec6b72e996b3668f4b797ec0a53acdee87174a8cb0ae97c6dbdf91f'
+  metadata.gz: 7f4da510b00f75763df1aa60bcdac51ae261be6384756f6476f4810314e9b61bc545c5d9c61b6aa93e8b09c94ba22fe2d436a085b788eea0ee0af226be006878
+  data.tar.gz: b4a4fb61c649f023033c5938171ec4d57e1df0044a40d1e994210f2da0ffaa6bd36439492526378ce9b9f433ced1d39ec9f30d0cb948c102243129c172c1b817

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## [v0.7.0] - 2020-02-25
+
+### Added
+
+- `TPM::KeyAttestation#valid?` performs certificate path validation. In other words, it verifies trust up
+to an acceptable trusted root certificate.
+
+### Changed
+
+- Rename `TPM::EKCertificate` to `TPM::AIKCertificate` to fix semantics
+
 ## [v0.6.0] - 2020-01-30
 
 ### Changed
@@ -38,6 +49,7 @@ replacement of `JOSE` format `algorithm` string
 - `TPM::EKCertificate` wrapper
 - `TPM::SAttest` wrapper
 
+[v0.7.0]: https://github.com/cedarcode/tpm-key_attestation/compare/v0.6.0...v0.7.0/
 [v0.6.0]: https://github.com/cedarcode/tpm-key_attestation/compare/v0.5.0...v0.6.0/
 [v0.5.0]: https://github.com/cedarcode/tpm-key_attestation/compare/v0.4.0...v0.5.0/
 [v0.4.0]: https://github.com/cedarcode/tpm-key_attestation/compare/v0.3.0...v0.4.0/

data/Gemfile

@@ -9,5 +9,4 @@ gem "appraisal", "~> 2.2.0"
 gem "byebug", "~> 11.0"
 gem "rake", "~> 12.0"
 gem "rspec", "~> 3.0"
-
-gem "rubocop"
+gem "rubocop", "~> 0.79.0"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    tpm-key_attestation (0.6.0)
+    tpm-key_attestation (0.7.0)
       bindata (~> 2.4)
       openssl-signature_algorithm (~> 0.3.0)
 
@@ -13,7 +13,7 @@ GEM
       rake
       thor (>= 0.14.0)
     ast (2.4.0)
-    bindata (2.4.4)
+    bindata (2.4.5)
     byebug (11.1.0)
     diff-lcs (1.3)
     jaro_winkler (1.5.4)
@@ -55,7 +55,7 @@ DEPENDENCIES
   byebug (~> 11.0)
   rake (~> 12.0)
   rspec (~> 3.0)
-  rubocop
+  rubocop (~> 0.79.0)
   tpm-key_attestation!
 
 BUNDLED WITH

data/README.md

@@ -2,7 +2,7 @@
 
 TPM Key Attestation utitlies
 
-[![Gem](https://img.shields.io/gem/v/tpm-key_attestation.svg?style=flat-square)](https://rubygems.org/gems/tpm-key_attestation)
+[![Gem](https://img.shields.io/gem/v/tpm-key_attestation.svg?style=flat-square&color=informational)](https://rubygems.org/gems/tpm-key_attestation)
 [![Travis](https://img.shields.io/travis/cedarcode/tpm-key_attestation.svg?style=flat-square)](https://travis-ci.org/cedarcode/tpm-key_attestation)
 
 ## Installation

data/gemfiles/openssl_2_0.gemfile

@@ -3,9 +3,10 @@
 source "https://rubygems.org"
 
 gem "appraisal", "~> 2.2.0"
+gem "byebug", "~> 11.0"
 gem "rake", "~> 12.0"
 gem "rspec", "~> 3.0"
-gem "rubocop"
+gem "rubocop", "~> 0.79.0"
 gem "openssl", "~> 2.0.0"
 
 gemspec path: "../"

data/gemfiles/openssl_2_1.gemfile

@@ -3,9 +3,10 @@
 source "https://rubygems.org"
 
 gem "appraisal", "~> 2.2.0"
+gem "byebug", "~> 11.0"
 gem "rake", "~> 12.0"
 gem "rspec", "~> 3.0"
-gem "rubocop"
+gem "rubocop", "~> 0.79.0"
 gem "openssl", "~> 2.1.0"
 
 gemspec path: "../"

data/gemfiles/openssl_default.gemfile

@@ -3,8 +3,9 @@
 source "https://rubygems.org"
 
 gem "appraisal", "~> 2.2.0"
+gem "byebug", "~> 11.0"
 gem "rake", "~> 12.0"
 gem "rspec", "~> 3.0"
-gem "rubocop"
+gem "rubocop", "~> 0.79.0"
 
 gemspec path: "../"

data/gemfiles/openssl_head.gemfile

@@ -3,9 +3,10 @@
 source "https://rubygems.org"
 
 gem "appraisal", "~> 2.2.0"
+gem "byebug", "~> 11.0"
 gem "rake", "~> 12.0"
 gem "rspec", "~> 3.0"
-gem "rubocop"
+gem "rubocop", "~> 0.79.0"
 gem "openssl", git: "https://github.com/ruby/openssl"
 
 gemspec path: "../"

data/lib/tpm/{ek_certificate.rb → aik_certificate.rb}

@@ -6,14 +6,15 @@ require "tpm/constants"
 
 module TPM
   # Section 3.2 in https://www.trustedcomputinggroup.org/wp-content/uploads/Credential_Profile_EK_V2.0_R14_published.pdf
-  class EKCertificate < SimpleDelegator
+  class AIKCertificate < SimpleDelegator
     ASN_V3 = 2
     EMPTY_NAME = OpenSSL::X509::Name.new([]).freeze
     SAN_DIRECTORY_NAME = 4
-    OID_TCG_AT_TPM_MANUFACTURER = "2.23.133.2.1"
-    OID_TCG_AT_TPM_MODEL = "2.23.133.2.2"
-    OID_TCG_AT_TPM_VERSION = "2.23.133.2.3"
-    OID_TCG_KP_AIK_CERTIFICATE = "2.23.133.8.3"
+    OID_TCG = "2.23.133"
+    OID_TCG_AT_TPM_MANUFACTURER = "#{OID_TCG}.2.1"
+    OID_TCG_AT_TPM_MODEL = "#{OID_TCG}.2.2"
+    OID_TCG_AT_TPM_VERSION = "#{OID_TCG}.2.3"
+    OID_TCG_KP_AIK_CERTIFICATE = "#{OID_TCG}.8.3"
 
     def self.from_der(certificate_der)
       new(OpenSSL::X509::Certificate.new(certificate_der))
@@ -24,13 +25,10 @@ module TPM
         valid_version? &&
         valid_extended_key_usage? &&
         valid_basic_constraints? &&
+        empty_subject? &&
         valid_subject_alternative_name?
     end
 
-    def empty_subject?
-      subject.eql?(EMPTY_NAME)
-    end
-
     private
 
     def in_use?
@@ -55,31 +53,60 @@ module TPM
       extended_key_usage && extended_key_usage.value == OID_TCG_KP_AIK_CERTIFICATE && !extended_key_usage.critical?
     end
 
+    def empty_subject?
+      subject.eql?(EMPTY_NAME)
+    end
+
     def valid_subject_alternative_name?
-      extension = extensions.detect { |ext| ext.oid == "subjectAltName" }
-      return unless extension
-
-      san_asn1 =
-        OpenSSL::ASN1.decode(extension).find do |val|
-          val.tag_class == :UNIVERSAL && val.tag == OpenSSL::ASN1::OCTET_STRING
-        end
-      directory_name =
-        OpenSSL::ASN1.decode(san_asn1.value).find do |val|
-          val.tag_class == :CONTEXT_SPECIFIC && val.tag == SAN_DIRECTORY_NAME
-        end
-      name = OpenSSL::X509::Name.new(directory_name.value.first).to_a
-      manufacturer = name.assoc(OID_TCG_AT_TPM_MANUFACTURER).at(1)
-      model = name.assoc(OID_TCG_AT_TPM_MODEL).at(1)
-      version = name.assoc(OID_TCG_AT_TPM_VERSION).at(1)
-
-      TPM::VENDOR_IDS[manufacturer] &&
-        !model.empty? &&
-        !version.empty? &&
-        (empty_subject? && extension.critical? || !empty_subject? && !extension.critical?)
+      if san_extension
+        san_extension.critical? &&
+          !tpm_manufacturer.empty? &&
+          TPM::VENDOR_IDS[tpm_manufacturer] &&
+          !tpm_model.empty? &&
+          !tpm_version.empty?
+      end
     end
 
     def extension(oid)
       extensions.detect { |ext| ext.oid == oid }
     end
+
+    def tpm_manufacturer
+      if san_name
+        san_name.assoc(OID_TCG_AT_TPM_MANUFACTURER).at(1)
+      end
+    end
+
+    def tpm_model
+      if san_name
+        san_name.assoc(OID_TCG_AT_TPM_MODEL).at(1)
+      end
+    end
+
+    def tpm_version
+      if san_name
+        san_name.assoc(OID_TCG_AT_TPM_VERSION).at(1)
+      end
+    end
+
+    def san_name
+      if san_extension
+        san_asn1 =
+          OpenSSL::ASN1.decode(san_extension).find do |val|
+            val.tag_class == :UNIVERSAL && val.tag == OpenSSL::ASN1::OCTET_STRING
+          end
+
+        directory_name =
+          OpenSSL::ASN1.decode(san_asn1.value).find do |val|
+            val.tag_class == :CONTEXT_SPECIFIC && val.tag == SAN_DIRECTORY_NAME
+          end
+
+        OpenSSL::X509::Name.new(directory_name.value.first).to_a
+      end
+    end
+
+    def san_extension
+      extension("subjectAltName")
+    end
   end
 end

data/lib/tpm/certificates/NationZ/RootCA/EkRootCA.crt

@@ -0,0 +1,15 @@
+-----BEGIN CERTIFICATE-----
+MIICRDCCAcqgAwIBAgIBATAKBggqhkjOPQQDAzBrMQswCQYDVQQGEwJDTjEhMB8G
+A1UECgwYTmF0aW9ueiBUZWNobm9sb2dpZXMgSW5jMRswGQYDVQQLDBJOYXRpb256
+IFRQTSBEZXZpY2UxHDAaBgNVBAMME05hdGlvbnogVFBNIFJvb3QgQ0EwHhcNMTcw
+NTEyMDAwMDAwWhcNNDcwNTEzMDAwMDAwWjBrMQswCQYDVQQGEwJDTjEhMB8GA1UE
+CgwYTmF0aW9ueiBUZWNobm9sb2dpZXMgSW5jMRswGQYDVQQLDBJOYXRpb256IFRQ
+TSBEZXZpY2UxHDAaBgNVBAMME05hdGlvbnogVFBNIFJvb3QgQ0EwdjAQBgcqhkjO
+PQIBBgUrgQQAIgNiAATvuDTN8TNvp3A9fSjWpDARLmvz7ItQrDq/mmuzvzInwQfs
+YKUUJza4MXB3yS0PH1jjv1YMvaIBIalAgc+kahScQUy6W2fy6hd36pazmc/vQfG3
+Gdhw56gGwRHx4rn4TuqjQjBAMB0GA1UdDgQWBBQ6vP8I314BDCtkB4vHzpUG9Aj9
+5DAPBgNVHRMBAf8EBTADAQH/MA4GA1UdDwEB/wQEAwIBBjAKBggqhkjOPQQDAwNo
+ADBlAjApzqSmd4cCMKC7slJ4NE/7zweXZx89JzSEnEWGcq78jbbXCw6yM+R4nCNX
+phflI9QCMQCeFOAvyR+DQvThfGFINABej+1zeDVIjuZHat3FHVyV0UQVClPgMlZu
+TntipXwGOVY=
+-----END CERTIFICATE-----

data/lib/tpm/certify_validator.rb

@@ -2,7 +2,6 @@
 
 require "openssl/signature_algorithm"
 require "tpm/constants"
-require "tpm/public_area"
 require "tpm/s_attest"
 
 module TPM
@@ -39,7 +38,7 @@ module TPM
       attest.attested_type == TPM::ST_ATTEST_CERTIFY &&
         attest.extra_data.buffer == nonce &&
         attest.magic == TPM::GENERATED_VALUE &&
-        attest.attested.name.buffer == TPM::PublicArea.new(object).name
+        attest.attested.name.valid_for?(object)
     end
 
     def valid_signature?(verify_key)

data/lib/tpm/key_attestation.rb

@@ -1,50 +1,66 @@
 # frozen_string_literal: true
 
+require "openssl"
 require "tpm/key_attestation/version"
+require "tpm/aik_certificate"
 require "tpm/certify_validator"
 require "tpm/constants"
 
 module TPM
   class KeyAttestation
+    # https://docs.microsoft.com/en-us/windows-server/security/guarded-fabric-shielded-vm/guarded-fabric-install-trusted-tpm-root-certificates
+    ROOT_CERTIFICATES =
+      begin
+        pattern = File.expand_path(File.join(__dir__, "certificates", "*", "RootCA", "*.*"))
+        Dir.glob(pattern).map do |filename|
+          File.open(filename) { |file| OpenSSL::X509::Certificate.new(file) }
+        end
+      end
+
     class Error < StandardError; end
 
     attr_reader(
       :certify_info,
       :signature,
-      :certified_object,
-      :signing_key,
+      :certified_key,
+      :certificates,
       :signature_algorithm,
       :hash_algorithm,
-      :qualifying_data
+      :qualifying_data,
+      :root_certificates
     )
 
     def initialize(
       certify_info,
       signature,
-      certified_object,
-      signing_key,
+      certified_key,
+      certificates,
       qualifying_data,
       signature_algorithm: ALG_RSASSA,
-      hash_algorithm: ALG_SHA256
+      hash_algorithm: ALG_SHA256,
+      root_certificates: ROOT_CERTIFICATES
     )
       @certify_info = certify_info
       @signature = signature
 
-      @certified_object = certified_object
-      @signing_key = signing_key
+      @certified_key = certified_key
+      @certificates = certificates
       @signature_algorithm = signature_algorithm
       @hash_algorithm = hash_algorithm
       @qualifying_data = qualifying_data
+      @root_certificates = root_certificates
     end
 
     def key
-      if certify_validator.valid?(signing_key)
+      if valid?
         public_area.key
       end
     end
 
     def valid?
-      !!key
+      certify_validator.valid?(aik_certificate.public_key) &&
+        aik_certificate.conformant? &&
+        trustworthy?
     end
 
     private
@@ -55,14 +71,31 @@ module TPM
           certify_info,
           signature,
           qualifying_data,
-          certified_object,
+          certified_key,
           signature_algorithm: signature_algorithm,
           hash_algorithm: hash_algorithm
         )
     end
 
+    def trustworthy?
+      x509_certificates = certificates.map { |c| OpenSSL::X509::Certificate.new(c) }
+
+      trust_store.verify(x509_certificates[0], x509_certificates[1..-1])
+    end
+
+    def trust_store
+      @trust_store ||=
+        OpenSSL::X509::Store.new.tap do |trust_store|
+          root_certificates.each { |root_certificate| trust_store.add_cert(root_certificate) }
+        end
+    end
+
+    def aik_certificate
+      @aik_certificate ||= TPM::AIKCertificate.from_der(certificates.first)
+    end
+
     def public_area
-      @public_area ||= TPM::PublicArea.new(certified_object)
+      @public_area ||= TPM::PublicArea.new(certified_key)
     end
   end
 end

data/lib/tpm/key_attestation/version.rb

@@ -2,6 +2,6 @@
 
 module TPM
   class KeyAttestation
-    VERSION = "0.6.0"
+    VERSION = "0.7.0"
   end
 end

data/lib/tpm/s_attest/s_certify_info.rb

@@ -2,12 +2,13 @@
 
 require "bindata"
 require "tpm/sized_buffer"
+require "tpm/tpm2b_name"
 
 module TPM
   class SAttest < BinData::Record
     # Section 10.12.3 in https://trustedcomputinggroup.org/wp-content/uploads/TPM-Rev-2.0-Part-2-Structures-01.38.pdf
     class SCertifyInfo < BinData::Record
-      sized_buffer :name
+      tpm2b_name :name
       sized_buffer :qualified_name
     end
   end

data/lib/tpm/tpm2b_name.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "bindata"
+require "tpm/public_area"
+require "tpm/tpmt_ha"
+
+module TPM
+  class Tpm2bName < BinData::Record
+    endian :big
+
+    uint16 :name_size, value: lambda { name.to_binary_s.size }
+    tpmt_ha :name, read_length: :name_size
+
+    def valid_for?(object)
+      name.to_binary_s == TPM::PublicArea.new(object).name
+    end
+  end
+end

data/lib/tpm/tpmt_ha.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "bindata"
+
+module TPM
+  class TpmtHa < BinData::Record
+    BYTE_LENGTH = 8
+    DIGEST_LENGTH_SHA1 = 160
+    DIGEST_LENGTH_SHA256 = 256
+
+    endian :big
+
+    uint16 :hash_alg
+
+    choice :digest, selection: :hash_alg do
+      string TPM::ALG_SHA1, length: DIGEST_LENGTH_SHA1 / BYTE_LENGTH
+      string TPM::ALG_SHA256, length: DIGEST_LENGTH_SHA256 / BYTE_LENGTH
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tpm-key_attestation
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Gonzalo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-30 00:00:00.000000000 Z
+date: 2020-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bindata
@@ -62,9 +62,37 @@ files:
 - gemfiles/openssl_2_1.gemfile
 - gemfiles/openssl_default.gemfile
 - gemfiles/openssl_head.gemfile
+- lib/tpm/aik_certificate.rb
+- lib/tpm/certificates/AMD/RootCA/AMD-fTPM-ECC-RootCA.crt
+- lib/tpm/certificates/AMD/RootCA/AMD-fTPM-RSA-RootCA.crt
+- lib/tpm/certificates/Atmel/RootCA/Atmel TPM Root Signing Module.der
+- lib/tpm/certificates/Infineon/RootCA/IFX TPM EK Root CA.cer
+- lib/tpm/certificates/Infineon/RootCA/IFX-RootCA.cer
+- lib/tpm/certificates/Infineon/RootCA/IFX_TPM_RootCert_008.crt
+- lib/tpm/certificates/Infineon/RootCA/Infineon OPTIGA(TM) ECC Root CA.crt
+- lib/tpm/certificates/Infineon/RootCA/Infineon OPTIGA(TM) RSA Root CA.crt
+- lib/tpm/certificates/Intel/RootCA/EKRootPublicKey.cer
+- lib/tpm/certificates/Microsoft/RootCA/Microsoft TPM Root Certificate Authority 2014.cer
+- lib/tpm/certificates/NationZ/RootCA/EkRootCA.crt
+- lib/tpm/certificates/Nuvoton/RootCA/NTC TPM EK Root CA 01.cer
+- lib/tpm/certificates/Nuvoton/RootCA/NTC TPM EK Root CA 02.cer
+- lib/tpm/certificates/Nuvoton/RootCA/NTC TPM EK Root CA ARSUF 01.cer
+- lib/tpm/certificates/Nuvoton/RootCA/Nuvoton TPM Root CA 1013.cer
+- lib/tpm/certificates/Nuvoton/RootCA/Nuvoton TPM Root CA 1014.cer
+- lib/tpm/certificates/Nuvoton/RootCA/Nuvoton TPM Root CA 1110.cer
+- lib/tpm/certificates/Nuvoton/RootCA/Nuvoton TPM Root CA 1111.cer
+- lib/tpm/certificates/Nuvoton/RootCA/Nuvoton TPM Root CA 2010.cer
+- lib/tpm/certificates/Nuvoton/RootCA/Nuvoton TPM Root CA 2011.cer
+- lib/tpm/certificates/Nuvoton/RootCA/Nuvoton TPM Root CA 2110.cer
+- lib/tpm/certificates/Nuvoton/RootCA/Nuvoton TPM Root CA 2111.cer
+- lib/tpm/certificates/QC/RootCA/Microsoft TPM Root Certificate Authority 2014.cer
+- lib/tpm/certificates/STMicro/RootCA/GlobalSign Trusted Computing CA.crt
+- lib/tpm/certificates/STMicro/RootCA/GlobalSign Trusted Platform Module ECC Root
+  CA.crt
+- lib/tpm/certificates/STMicro/RootCA/ST TPM Root Certificate.crt
+- lib/tpm/certificates/STMicro/RootCA/STM TPM ECC Root CA 01.crt
 - lib/tpm/certify_validator.rb
 - lib/tpm/constants.rb
-- lib/tpm/ek_certificate.rb
 - lib/tpm/key_attestation.rb
 - lib/tpm/key_attestation/version.rb
 - lib/tpm/public_area.rb
@@ -74,6 +102,8 @@ files:
 - lib/tpm/t_public.rb
 - lib/tpm/t_public/s_ecc_parms.rb
 - lib/tpm/t_public/s_rsa_parms.rb
+- lib/tpm/tpm2b_name.rb
+- lib/tpm/tpmt_ha.rb
 - tpm-key_attestation.gemspec
 homepage: https://github.com/cedarcode/tpm-key_attestation
 licenses: