shc_vaccination_test_kit 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 1c23c78ef1451bcc51f3633dd1c0d20ba64368e126ad0eeb4be8fcd1b8becc29
4
+ data.tar.gz: 7698e4dc844ffc7e5e4f036f806f240cc74021be0a7a2333b2099d5c8eda04fa
5
+ SHA512:
6
+ metadata.gz: fe7b22402868e2a3c8e46b034ab143d073dec02680038236a33c52bc346d4cd21f974afb7096d4d7d84a20fe689d74fced392b9849cfba2fd2694a8b614da8e3
7
+ data.tar.gz: 3e0e040010f37e656910b7a0a1265583977ed6a9f29f720d0188568ea2c75db2c0cd54fc425d9fc2300afb8c4ddcdada6df255347ed1ab30f145bc9726592d5c
data/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "{}"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright {yyyy} {name of copyright owner}
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,105 @@
1
+ require_relative 'vc_fhir_validation'
2
+ require_relative 'vc_headers'
3
+ require_relative 'vc_payload_verification'
4
+ require_relative 'vc_signature_verification'
5
+
6
+ module Covid19VCI
7
+ class FHIROperation < Inferno::TestGroup
8
+ id 'vci_fhir_operation'
9
+ title 'Download and validate a health card via FHIR $health-cards-issue operation'
10
+
11
+ input :base_fhir_url, :patient_id
12
+
13
+ fhir_client do
14
+ url :base_fhir_url
15
+ end
16
+
17
+ test do
18
+ title 'Server advertises health card support in its SMART configuration'
19
+ id 'vci-fhir-01'
20
+
21
+ run do
22
+ get("#{base_fhir_url}/.well-known/smart-configuration")
23
+
24
+ assert_response_status(200)
25
+ assert_valid_json(response[:body])
26
+
27
+ smart_configuration = JSON.parse(response[:body])
28
+
29
+ assert smart_configuration['capabilities']&.include?('health-cards'),
30
+ "SMART configuration does not list support for 'health-cards' capability"
31
+ end
32
+ end
33
+
34
+ test do
35
+ title 'Server advertises $health-cards-issue operation support in its CapabilityStatement'
36
+ id 'vci-fhir-02'
37
+
38
+ run do
39
+ fhir_get_capability_statement
40
+
41
+ assert_response_status(200)
42
+
43
+ operations = resource.rest&.flat_map do |rest|
44
+ rest.resource
45
+ &.select { |r| r.type == 'Patient' && r.respond_to?(:operation) }
46
+ &.flat_map(&:operation)
47
+ end&.compact
48
+
49
+ operation_defined = operations.any? { |operation| operation.name == 'health-cards-issue' }
50
+
51
+ assert operation_defined,
52
+ 'Server CapabilityStatement did not declare support for $health-cards-issue operation ' \
53
+ 'on the Patient resource.'
54
+ end
55
+ end
56
+
57
+ test do
58
+ title 'Server returns a health card from the $health-cards-issue operation'
59
+ id 'vci-fhir-03'
60
+ output :credential_strings
61
+
62
+ run do
63
+ request_params = FHIR::Parameters.new(
64
+ parameter: [
65
+ {
66
+ name: 'credentialType',
67
+ valueUri: 'https://smarthealth.cards#covid19'
68
+ }
69
+ ]
70
+ )
71
+ fhir_operation("/Patient/#{patient_id}/$health-cards-issue", body: request_params)
72
+
73
+ assert_response_status((200..207).to_a)
74
+ assert_resource_type(:parameters)
75
+
76
+ hc_parameters = resource.parameter.select { |parameter| parameter.name == 'verifiableCredential' }
77
+
78
+ assert hc_parameters.present?, 'No COVID-19 health cards were returned'
79
+ credential_strings = hc_parameters.map(&:value).join(',')
80
+
81
+ output credential_strings: credential_strings
82
+
83
+ count = hc_parameters.length
84
+
85
+ pass "#{count} verifiable #{'credential'.pluralize(count)} received"
86
+ end
87
+ end
88
+
89
+ test from: :vc_headers do
90
+ id 'vci-fhir-04'
91
+ end
92
+
93
+ test from: :vc_signature_verification do
94
+ id 'vci-fhir-05'
95
+ end
96
+
97
+ test from: :vc_payload_verification do
98
+ id 'vci-fhir-06'
99
+ end
100
+
101
+ test from: :vc_fhir_verification do
102
+ id 'vci-fhir-07'
103
+ end
104
+ end
105
+ end
@@ -0,0 +1,109 @@
1
+ require_relative 'vc_fhir_validation'
2
+ require_relative 'vc_headers'
3
+ require_relative 'vc_payload_verification'
4
+ require_relative 'vc_signature_verification'
5
+
6
+ module Covid19VCI
7
+ class FileDownload < Inferno::TestGroup
8
+ id 'vci_file_download'
9
+ title 'Download and validate a health card via file download'
10
+
11
+ input :file_download_url
12
+
13
+ test do
14
+ id 'vci-file-01'
15
+ title 'Health card can be downloaded'
16
+ description 'The health card can be downloaded and is a valid JSON object'
17
+ makes_request :vci_file_download
18
+
19
+ run do
20
+ get(file_download_url, name: :vci_file_download)
21
+
22
+ assert_response_status(200)
23
+ assert_valid_json(response[:body])
24
+ end
25
+ end
26
+
27
+ test do
28
+ id 'vci-file-02'
29
+ title 'Response contains correct Content-Type of application/smart-health-card'
30
+ uses_request :vci_file_download
31
+
32
+ run do
33
+ skip_if request.status != 200, 'Health card not successfully downloaded'
34
+
35
+ content_type = request.response_header('Content-Type')
36
+
37
+ assert content_type.present?, 'Response did not include a Content-Type header'
38
+ assert content_type.value.match?(%r{\Aapplication/smart-health-card(\z|\W)}),
39
+ "Content-Type header was '#{content_type.value}' instead of 'application/smart-health-card'"
40
+ end
41
+ end
42
+
43
+ test do
44
+ id 'vci-file-03'
45
+ title 'Health card is provided as a file download with a .smart-health-card extension'
46
+ uses_request :vci_file_download
47
+
48
+ run do
49
+ skip_if request.status != 200, 'Health card not successfully downloaded'
50
+
51
+ pass_if request.url.ends_with?('.smart-health-card')
52
+
53
+ content_disposition = request.response_header('Content-Disposition')
54
+ assert content_disposition.present?,
55
+ "Url did not end with '.smart-health-card' and response did not include a Content-Disposition header"
56
+
57
+ attachment_pattern = /\Aattachment;/
58
+ assert content_disposition.value.match?(attachment_pattern),
59
+ "Url did not end with '.smart-health-card' and " \
60
+ "Content-Disposition header does not indicate file should be downloaded: '#{content_disposition}'"
61
+
62
+ extension_pattern = /filename=".*\.smart-health-card"/
63
+ assert content_disposition.value.match?(extension_pattern),
64
+ "Url did not end with '.smart-health-card' and Content-Disposition header does not indicate " \
65
+ "file should have a '.smart-health-card' extension: '#{content_disposition}'"
66
+ end
67
+ end
68
+
69
+ test do
70
+ id 'vci-file-04'
71
+ title 'Response contains an array of Verifiable Credential strings'
72
+ uses_request :vci_file_download
73
+ output :credential_strings
74
+
75
+ run do
76
+ skip_if request.status != 200, 'Health card not successfully downloaded'
77
+
78
+ body = JSON.parse(response[:body])
79
+ assert body.include?('verifiableCredential'),
80
+ "Health card does not contain 'verifiableCredential' field"
81
+
82
+ vc = body['verifiableCredential']
83
+
84
+ assert vc.is_a?(Array), "'verifiableCredential' field must contain an Array"
85
+ assert vc.length.positive?, "'verifiableCredential' field must contain at least one verifiable credential"
86
+
87
+ output credential_strings: vc.join(',')
88
+
89
+ pass "Received #{vc.length} verifiable #{'credential'.pluralize(vc.length)}"
90
+ end
91
+ end
92
+
93
+ test from: :vc_headers do
94
+ id 'vci-file-05'
95
+ end
96
+
97
+ test from: :vc_signature_verification do
98
+ id 'vci-file-06'
99
+ end
100
+
101
+ test from: :vc_payload_verification do
102
+ id 'vci-file-07'
103
+ end
104
+
105
+ test from: :vc_fhir_verification do
106
+ id 'vci-file-08'
107
+ end
108
+ end
109
+ end
@@ -0,0 +1,75 @@
1
+ module Covid19VCI
2
+ class VCFHIRVerification < Inferno::Test
3
+ title 'Health Card payloads conform to the Vaccination Credential Bundle Profiles'
4
+ input :credential_strings
5
+
6
+ id :vc_fhir_verification
7
+
8
+ run do
9
+ skip_if credential_strings.blank?, 'No Verifiable Credentials received'
10
+
11
+ credential_strings.split(',').each do |credential|
12
+ raw_payload = HealthCards::JWS.from_jws(credential).payload
13
+ assert raw_payload&.length&.positive?, 'No payload found'
14
+
15
+ decompressed_payload =
16
+ begin
17
+ Zlib::Inflate.new(-Zlib::MAX_WBITS).inflate(raw_payload)
18
+ rescue Zlib::DataError
19
+ assert false, 'Payload compression error. Unable to inflate payload.'
20
+ end
21
+
22
+ assert decompressed_payload.length.positive?, 'Payload compression error. Unable to inflate payload.'
23
+
24
+ payload_length = decompressed_payload.length
25
+ health_card = HealthCards::COVIDHealthCard.from_jws(credential)
26
+ health_card_length = health_card.to_json.length
27
+
28
+ assert_valid_json decompressed_payload, 'Payload is not valid JSON'
29
+
30
+ payload = JSON.parse(decompressed_payload)
31
+ vc = payload['vc']
32
+ assert vc.is_a?(Hash), "Expected 'vc' claim to be a JSON object, but found #{vc.class}"
33
+
34
+ subject = vc['credentialSubject']
35
+ assert subject.is_a?(Hash), "Expected 'vc.credentialSubject' to be a JSON object, but found #{subject.class}"
36
+
37
+ raw_bundle = subject['fhirBundle']
38
+ assert raw_bundle.is_a?(Hash), "Expected 'vc.fhirBundle' to be a JSON object, but found #{raw_bundle.class}"
39
+
40
+ bundle = FHIR::Bundle.new(raw_bundle)
41
+
42
+ # assert bundle.entry.any? { |r| r.resource.is_a?(FHIR::Immunization) } || bundle.entry.any? { |r| r.resource.is_a?(FHIR::Observation) },
43
+ # "Bundle must have either Immunization entries or Observation entries"
44
+
45
+ # if bundle.entry.any? { |r| r.resource.is_a?(FHIR::Immunization) }
46
+ assert_valid_resource(
47
+ resource: bundle,
48
+ profile_url: 'http://hl7.org/fhir/uv/smarthealthcards-vaccination/StructureDefinition/vaccination-credential-bundle'
49
+ )
50
+
51
+ warning do
52
+ assert_valid_resource(
53
+ resource: bundle,
54
+ profile_url: 'http://hl7.org/fhir/uv/smarthealthcards-vaccination/StructureDefinition/vaccination-credential-bundle-dm'
55
+ )
56
+ end
57
+ # end
58
+
59
+ if bundle.entry.any? { |r| r.resource.is_a?(FHIR::Observation) }
60
+ assert_valid_resource(
61
+ resource: bundle,
62
+ profile_url: 'http://hl7.org/fhir/uv/smarthealthcards-vaccination/StructureDefinition/covid19-laboratory-bundle'
63
+ )
64
+
65
+ warning do
66
+ assert_valid_resource(
67
+ resource: bundle,
68
+ profile_url: 'http://hl7.org/fhir/uv/smarthealthcards-vaccination/StructureDefinition/covid19-laboratory-bundle-dm'
69
+ )
70
+ end
71
+ end
72
+ end
73
+ end
74
+ end
75
+ end
@@ -0,0 +1,21 @@
1
+ module Covid19VCI
2
+ class VCHeaders < Inferno::Test
3
+ title 'Health Cards contain the correct headers'
4
+ input :credential_strings
5
+
6
+ id :vc_headers
7
+
8
+ run do
9
+ skip_if credential_strings.blank?, 'No Verifiable Credentials received'
10
+ credential_strings.split(',').each do |credential|
11
+ header = HealthCards::JWS.from_jws(credential).header
12
+
13
+ assert header['zip'] == 'DEF', "Expected 'zip' header to equal 'DEF', but found '#{header['zip']}'"
14
+ assert header['alg'] == 'ES256', "Expected 'alg' header to equal 'ES256', but found '#{header['alg']}'"
15
+ assert header['kid'].present?, "No 'kid' header was present"
16
+ rescue StandardError => e
17
+ assert false, "Error decoding credential: #{e.message}"
18
+ end
19
+ end
20
+ end
21
+ end
@@ -0,0 +1,115 @@
1
+ module Covid19VCI
2
+ class VCPayloadVerification < Inferno::Test
3
+ title 'Health Card payloads follow the spec requirements'
4
+ input :credential_strings
5
+
6
+ id :vc_payload_verification
7
+
8
+ run do
9
+ skip_if credential_strings.blank?, 'No Verifiable Credentials received'
10
+
11
+ credential_strings.split(',').each do |credential|
12
+ raw_payload = HealthCards::JWS.from_jws(credential).payload
13
+ assert raw_payload&.length&.positive?, 'No payload found'
14
+
15
+ decompressed_payload =
16
+ begin
17
+ Zlib::Inflate.new(-Zlib::MAX_WBITS).inflate(raw_payload)
18
+ rescue Zlib::DataError
19
+ assert false, 'Payload compression error. Unable to inflate payload.'
20
+ end
21
+
22
+ assert decompressed_payload.length.positive?, 'Payload compression error. Unable to inflate payload.'
23
+
24
+ payload_length = decompressed_payload.length
25
+ health_card = HealthCards::HealthCard.from_jws(credential)
26
+ health_card_length = health_card.to_json.length
27
+
28
+ warning do
29
+ assert payload_length <= health_card_length,
30
+ "Payload may not be properly minified. Received a payload with length #{payload_length}, " \
31
+ "but was able to generate a payload with length #{health_card_length}"
32
+ end
33
+
34
+ assert_valid_json decompressed_payload, 'Payload is not valid JSON'
35
+
36
+ payload = JSON.parse(decompressed_payload)
37
+
38
+ warning do
39
+ nbf = payload['nbf']
40
+ assert nbf.present?, "Payload does not include an 'nbf' claim"
41
+ assert nbf.is_a?(Numeric), "Expected 'nbf' claim to be Numeric, but found #{nbf.class}"
42
+ issue_time = Time.at(nbf).to_datetime
43
+ assert issue_time < DateTime.now, "'nbf' is in the future: #{issue_time.rfc822}"
44
+ end
45
+
46
+ vc = payload['vc']
47
+ assert vc.is_a?(Hash), "Expected 'vc' claim to be a JSON object, but found #{vc.class}"
48
+ type = vc['type']
49
+
50
+ warning do
51
+ assert type.is_a?(Array), "Expected 'vc.type' to be an array, but found #{type.class}"
52
+ assert type.include?('https://smarthealth.cards#health-card'),
53
+ "'vc.type' does not include 'https://smarthealth.cards#health-card'"
54
+ end
55
+
56
+ subject = vc['credentialSubject']
57
+ assert subject.is_a?(Hash), "Expected 'vc.credentialSubject' to be a JSON object, but found #{subject.class}"
58
+
59
+ warning do
60
+ assert subject['fhirVersion'].present?, "'vc.credentialSubject.fhirVersion' not provided"
61
+ end
62
+
63
+ raw_bundle = subject['fhirBundle']
64
+ assert raw_bundle.is_a?(Hash), "Expected 'vc.fhirBundle' to be a JSON object, but found #{raw_bundle.class}"
65
+
66
+ resource_scheme_regex = /\Aresource:\d+\z/
67
+ warning do
68
+ urls = raw_bundle['entry'].map { |entry| entry['fullUrl'] }
69
+ bad_urls = urls.reject { |url| url.match?(resource_scheme_regex) }
70
+ assert bad_urls.empty?,
71
+ "The following Bundle entry urls do not use short resource-scheme URIs: #{bad_urls.join(', ')}"
72
+ end
73
+
74
+ bundle = FHIR::Bundle.new(raw_bundle)
75
+ resources = bundle.entry.map(&:resource)
76
+ bundle.entry.each { |entry| entry.resource = nil }
77
+ resources << bundle
78
+
79
+ resources.each do |resource|
80
+ warning { assert resource.id.nil?, "#{resource.resourceType} resource should not have an 'id' element" }
81
+
82
+ if resource.respond_to? :text
83
+ warning { assert resource.text.nil?, "#{resource.resourceType} resource should not have a 'text' element" }
84
+ end
85
+
86
+ walk_resource(resource) do |value, meta, path|
87
+ case meta['type']
88
+ when 'CodeableConcept'
89
+ warning { assert value.text.nil?, "#{resource.resourceType} should not have a #{path}.text element" }
90
+ when 'Coding'
91
+ warning do
92
+ assert value.display.nil?, "#{resource.resourceType} should not have a #{path}.display element"
93
+ end
94
+ when 'Reference'
95
+ warning do
96
+ next if value.reference.nil?
97
+
98
+ assert value.reference.match?(resource_scheme_regex),
99
+ "#{resource.resourceType}.#{path}.reference is not using the short resource URI scheme: " \
100
+ "#{value.reference}"
101
+ end
102
+ when 'Meta'
103
+ hash = value.to_hash
104
+ warning do
105
+ assert hash.length == 1 && hash.include?('security'),
106
+ "If present, Bundle 'meta' field should only include 'security', " \
107
+ "but found: #{hash.keys.join(', ')}"
108
+ end
109
+ end
110
+ end
111
+ end
112
+ end
113
+ end
114
+ end
115
+ end
@@ -0,0 +1,69 @@
1
+ module Covid19VCI
2
+ class VCSignatureVerification < Inferno::Test
3
+ title 'Verifiable Credential signatures can be verified'
4
+ input :credential_strings
5
+
6
+ id :vc_signature_verification
7
+
8
+ run do
9
+ skip_if credential_strings.blank?, 'No Verifiable Credentials received'
10
+ credential_strings.split(',').each do |credential|
11
+ card = HealthCards::HealthCard.from_jws(credential)
12
+ iss = card.issuer
13
+
14
+ jws = HealthCards::JWS.from_jws(credential)
15
+
16
+ assert iss.present?, 'Credential contains no `iss`'
17
+ warning { assert iss.start_with?('https://'), "`iss` SHALL use the `https` scheme: #{iss}" }
18
+ assert !iss.end_with?('/'), "`iss` SHALL NOT include a trailing `/`: #{iss}"
19
+
20
+ key_set_url = "#{card.issuer}/.well-known/jwks.json"
21
+
22
+ get(key_set_url)
23
+
24
+ assert_response_status(200)
25
+ assert_valid_json(response[:body])
26
+
27
+ cors_header = request.response_header('Control-Allow-Origin')
28
+ warning do
29
+ assert cors_header.present?,
30
+ 'No CORS header received. Issuers SHALL publish their public keys with CORS enabled'
31
+ assert cors_header.value == '*',
32
+ "Expected CORS header value of `*`, but actual value was `#{cors_header.value}`"
33
+ end
34
+
35
+ key_set = JSON.parse(response[:body])
36
+
37
+ public_key = key_set['keys'].find { |key| key['kid'] == jws.kid }
38
+ key_object = HealthCards::Key.from_jwk(public_key)
39
+
40
+ assert public_key.present?, "Key set did not contain a key with a `kid` of #{jws.kid}"
41
+
42
+ warning { assert public_key['kty'] == 'EC', "Key had a `kty` value of `#{public_key['kty']}` instead of `EC`" }
43
+ warning do
44
+ assert public_key['use'] == 'sig', "Key had a `use` value of `#{public_key['use']}` instead of `sig`"
45
+ end
46
+ warning do
47
+ assert public_key['alg'] == 'ES256', "Key had an `alg` value of `#{public_key['alg']}` instead of `ES256`"
48
+ end
49
+ warning do
50
+ assert public_key['crv'] == 'P-256', "Key had a `crv` value of `#{public_key['crv']}` instead of `P-256`"
51
+ end
52
+ warning { assert !public_key.include?('d'), 'Key SHALL NOT have the private key parameter `d`' }
53
+ warning do
54
+ assert public_key['kid'] == key_object.kid,
55
+ "'kid' SHALL be equal to the base64url-encoded SHA-256 JWK Thumbprint of the key. " \
56
+ "Received: '#{public_key['kid']}', Expected: '#{key_object.kid}'"
57
+ end
58
+
59
+ verifier = HealthCards::Verifier.new(keys: key_object, resolve_keys: false)
60
+
61
+ begin
62
+ assert verifier.verify(jws), 'JWS signature invalid'
63
+ rescue StandardError => e
64
+ assert false, "Error decoding credential: #{e.message}"
65
+ end
66
+ end
67
+ end
68
+ end
69
+ end
@@ -0,0 +1,3 @@
1
+ module Covid19VCI
2
+ VERSION = '0.0.1'.freeze
3
+ end
@@ -0,0 +1,13 @@
1
+ require 'health_cards'
2
+ require_relative 'covid19_vci/file_download'
3
+ require_relative 'covid19_vci/fhir_operation'
4
+
5
+ module Covid19VCI
6
+ class Suite < Inferno::TestSuite
7
+ id 'c19-vci'
8
+ title 'SMART Health Cards: Vaccination & Testing'
9
+
10
+ group from: :vci_file_download
11
+ group from: :vci_fhir_operation
12
+ end
13
+ end
metadata ADDED
@@ -0,0 +1,140 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: shc_vaccination_test_kit
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ platform: ruby
6
+ authors:
7
+ - Stephen MacVicar
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2021-06-23 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: health_cards
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: '0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: '0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: inferno_core
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: 0.0.2
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ">="
39
+ - !ruby/object:Gem::Version
40
+ version: 0.0.2
41
+ - !ruby/object:Gem::Dependency
42
+ name: database_cleaner-sequel
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '1.8'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '1.8'
55
+ - !ruby/object:Gem::Dependency
56
+ name: factory_bot
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '6.1'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '6.1'
69
+ - !ruby/object:Gem::Dependency
70
+ name: rspec
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: '3.10'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: '3.10'
83
+ - !ruby/object:Gem::Dependency
84
+ name: webmock
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - "~>"
88
+ - !ruby/object:Gem::Version
89
+ version: '3.11'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - "~>"
95
+ - !ruby/object:Gem::Version
96
+ version: '3.11'
97
+ description: 'A collection of tests for the SMART Health Cards: Vaccination & Testing
98
+ FHIR Implementation Guide'
99
+ email:
100
+ - vci-ig@mitre.org
101
+ executables: []
102
+ extensions: []
103
+ extra_rdoc_files: []
104
+ files:
105
+ - LICENSE
106
+ - lib/covid19_vci/fhir_operation.rb
107
+ - lib/covid19_vci/file_download.rb
108
+ - lib/covid19_vci/vc_fhir_validation.rb
109
+ - lib/covid19_vci/vc_headers.rb
110
+ - lib/covid19_vci/vc_payload_verification.rb
111
+ - lib/covid19_vci/vc_signature_verification.rb
112
+ - lib/covid19_vci/version.rb
113
+ - lib/shc_vaccination_test_kit.rb
114
+ homepage: https://github.com/inferno_community/shc-vaccination-test-kit
115
+ licenses:
116
+ - Apache-2.0
117
+ metadata:
118
+ homepage_uri: https://github.com/inferno_community/shc-vaccination-test-kit
119
+ source_code_uri: https://github.com/inferno_community/shc-vaccination-test-kit
120
+ post_install_message:
121
+ rdoc_options: []
122
+ require_paths:
123
+ - lib
124
+ required_ruby_version: !ruby/object:Gem::Requirement
125
+ requirements:
126
+ - - ">="
127
+ - !ruby/object:Gem::Version
128
+ version: 2.7.0
129
+ required_rubygems_version: !ruby/object:Gem::Requirement
130
+ requirements:
131
+ - - ">="
132
+ - !ruby/object:Gem::Version
133
+ version: '0'
134
+ requirements: []
135
+ rubygems_version: 3.1.4
136
+ signing_key:
137
+ specification_version: 4
138
+ summary: 'A collection of tests for the SMART Health Cards: Vaccination & Testing
139
+ FHIR Implementation Guide'
140
+ test_files: []