smart_health_cards_test_kit 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8dcd02e218c20c7df4ac05da3a491653ea9cf69f8c2f86471407a68d0582bbd5
+  data.tar.gz: 801a9e6c1301ce4daf3c1a126e9a00537dd4871e7786f664f1591daeea7e43a0
+SHA512:
+  metadata.gz: a45f4aead162a4ba9dfb363310eca1e36cc09a7c289e0f7659a06a19c2d4b3c1217b3c48269d858ba0c75af99ffc937081541075db7b93715a22b12ecda73c56
+  data.tar.gz: fb75562a3a42290e637434d3b96782e51d79081343b5c50722b9fbf912e90602d21eaf91e025fe01bbc22858d9c7953cc343cc5c3c6ac3e4ce3cfe424c47faf5

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/lib/smart_health_cards_test_kit/fhir_operation_group.rb

@@ -0,0 +1,105 @@
+module SmartHealthCardsTestKit
+  class FHIROperation < Inferno::TestGroup
+    id :shc_fhir_operation_group
+    title 'Download and validate a health card via FHIR $health-cards-issue operation'
+    run_as_group
+
+    input :base_fhir_url, :patient_id
+
+    fhir_client do
+      url :base_fhir_url
+    end
+
+    test do
+      title 'Server advertises health card support in its SMART configuration'
+      description %(
+        A SMART on FHIR Server capable of issuing VCs according to this specification SHALL
+        advertise its support by adding the health-cards capability to its /.well-known/smart-configuration
+        JSON file.
+      )
+      id :smart_configuration_test
+
+      run do
+        get("#{base_fhir_url}/.well-known/smart-configuration")
+
+        assert_response_status(200)
+        assert_valid_json(response[:body])
+
+        smart_configuration = JSON.parse(response[:body])
+
+        assert smart_configuration['capabilities']&.include?('health-cards'),
+               "SMART configuration does not list support for 'health-cards' capability"
+      end
+    end
+
+    test do
+      title 'Server advertises $health-cards-issue operation support in its CapabilityStatement'
+      description %(
+        A SMART on FHIR Server capable of issuing VCs according to this specification SHOULD
+        advertise its support of $health-cards-issue operation by adding the operation to its
+        CapabilityStatement.
+      )
+      id :capabilitystatement_test
+      optional
+
+      run do
+        fhir_get_capability_statement
+
+        assert_response_status(200)
+
+        operations = resource.rest&.flat_map do |rest|
+          rest.resource
+            &.select { |r| r.type == 'Patient' && r.respond_to?(:operation) }
+            &.flat_map(&:operation)
+        end&.compact
+
+        operation_defined = operations.any? { |operation| operation.name == 'health-cards-issue' }
+
+        assert operation_defined,
+               'Server CapabilityStatement did not declare support for $health-cards-issue operation ' \
+               'on the Patient resource.'
+      end
+    end
+
+    test do
+      title 'Server returns a health card from the $health-cards-issue operation'
+      description %(
+        For a more seamless user experience when FHIR API connections are already in place,
+        results may also be conveyed through a FHIR API $health-cards-issue operation
+      )
+      id :health_cards_issue_operation_test
+      output :credential_strings
+
+      run do
+        request_params = FHIR::Parameters.new(
+          parameter: [
+            {
+              name: 'credentialType',
+              valueUri: 'https://smarthealth.cards#covid19'
+            }
+          ]
+        )
+        fhir_operation("/Patient/#{patient_id}/$health-cards-issue", body: request_params)
+
+        assert_response_status((200..207).to_a)
+        assert_resource_type(:parameters)
+
+        hc_parameters = resource.parameter.select { |parameter| parameter.name == 'verifiableCredential' }
+
+        assert hc_parameters.present?, 'No COVID-19 health cards were returned'
+        credential_strings = hc_parameters.map(&:value).join(',')
+
+        output credential_strings: credential_strings
+
+        count = hc_parameters.length
+
+        pass "#{count} verifiable #{'credential'.pluralize(count)} received"
+      end
+    end
+
+    test from: :shc_header_verification_test
+    test from: :shc_payload_verification_test
+    test from: :shc_signature_verification_test
+    test from: :shc_fhir_validation_test
+  end
+end

data/lib/smart_health_cards_test_kit/file_download_group.rb

@@ -0,0 +1,108 @@
+module SmartHealthCardsTestKit
+  class FileDownloadGroup < Inferno::TestGroup
+    id :shc_file_download_group
+    title 'Download and validate a health card via file download'
+    run_as_group
+
+    input :file_download_url
+
+    test do
+      id :health_card_download_test
+      title 'Health card can be downloaded'
+      description %(
+        To facilitate User Retrieves Health Cards workflow, the issuer can include a
+        link to help the user download the credentials directly. Contents should be a JSON object.
+      )
+      makes_request :shc_file_download
+
+
+      run do
+        get(file_download_url, name: :shc_file_download)
+        assert_response_status(200)
+        assert_valid_json(response[:body])
+      end
+    end
+
+    test do
+      id :content_type_test
+      title 'Response contains correct Content-Type of application/smart-health-card'
+      description %(
+        The downloded file SHALL be provided with a MIME type of application/smart-health-card.
+        (e.g., web servers SHALL include Content-Type: application/smart-health-card as
+        an HTTP Response containing a Health Card)
+      )
+      uses_request :shc_file_download
+
+      run do
+        skip_if request.status != 200, 'Health card not successfully downloaded'
+
+        content_type = request.response_header('Content-Type')
+
+        assert content_type.present?, 'Response did not include a Content-Type header'
+        assert content_type.value.match?(%r{\Aapplication/smart-health-card(\z|\W)}),
+               "Content-Type header was '#{content_type.value}' instead of 'application/smart-health-card'"
+      end
+    end
+
+    test do
+      id :file_extension_test
+      title 'Health card is provided as a file download with a .smart-health-card extension'
+      description %(
+        The downloaded file SHALL be served with a .smart-health-card file extension.
+      )
+      uses_request :shc_file_download
+
+      run do
+        skip_if request.status != 200, 'Health card not successfully downloaded'
+
+        pass_if request.url.ends_with?('.smart-health-card')
+
+        content_disposition = request.response_header('Content-Disposition')
+        assert content_disposition.present?,
+               "Url did not end with '.smart-health-card' and response did not include a Content-Disposition header"
+
+        attachment_pattern = /\Aattachment;/
+        assert content_disposition.value.match?(attachment_pattern),
+               "Url did not end with '.smart-health-card' and " \
+               "Content-Disposition header does not indicate file should be downloaded: '#{content_disposition}'"
+
+        extension_pattern = /filename=".*\.smart-health-card"/
+        assert content_disposition.value.match?(extension_pattern),
+               "Url did not end with '.smart-health-card' and Content-Disposition header does not indicate " \
+               "file should have a '.smart-health-card' extension: '#{content_disposition}'"
+      end
+    end
+
+    test do
+      id :verifiable_credential_test
+      title 'Response contains an array of Verifiable Credential strings'
+      description %(
+        Contents of the downloaded file should be a JSON object containing an array of Verifiable Credential JWS strings.
+      )
+      uses_request :shc_file_download
+      output :credential_strings
+
+      run do
+        skip_if request.status != 200, 'Health card not successfully downloaded'
+
+        body = JSON.parse(response[:body])
+        assert body.include?('verifiableCredential'),
+               "Health card does not contain 'verifiableCredential' field"
+
+        vc = body['verifiableCredential']
+
+        assert vc.is_a?(Array), "'verifiableCredential' field must contain an Array"
+        assert vc.length.positive?, "'verifiableCredential' field must contain at least one verifiable credential"
+
+        output credential_strings: vc.join(',')
+
+        pass "Received #{vc.length} verifiable #{'credential'.pluralize(vc.length)}"
+      end
+    end
+
+    test from: :shc_header_verification_test
+    test from: :shc_payload_verification_test
+    test from: :shc_signature_verification_test
+    test from: :shc_fhir_validation_test
+  end
+end

data/lib/smart_health_cards_test_kit/health_card.rb

@@ -0,0 +1,33 @@
+module SmartHealthCardsTestKit
+  module HealthCard
+    def payload_from_jws(jws)
+      return nil unless jws.present?
+
+      raw_payload = jws.payload
+      assert raw_payload&.length&.positive?, 'No payload found'
+
+      decompressed_payload =
+        begin
+          Zlib::Inflate.new(-Zlib::MAX_WBITS).inflate(raw_payload)
+        rescue Zlib::DataError
+          assert false, 'Payload compression error. Unable to inflate payload.'
+        end
+
+      assert decompressed_payload.length.positive?, 'Payload compression error. Unable to inflate payload.'
+
+      payload_length = decompressed_payload.length
+      raw_payload_length = raw_payload.length
+      decompressed_payload_length = decompressed_payload.length
+
+      warning do
+        assert raw_payload_length <= decompressed_payload_length,
+              "Payload may not be properly minified. Received a payload with length #{raw_payload_length}, " \
+              "but was able to generate a payload with length #{decompressed_payload_length}"
+      end
+
+      assert_valid_json decompressed_payload, 'Payload is not valid JSON'
+
+      JSON.parse(decompressed_payload)
+    end
+  end
+end