Commit 61235c7f authored by Jose San Juan's avatar Jose San Juan
Browse files

Rebase Data Agreement VUI Spec

parent 95379be9
# These owners will be the default owners for everything in
# the repo. Unless a later match takes precedence,
# they will be requested for review when someone opens a
# pull request.
* @jose-gataca
# See CODEOWNERS syntax here: https://help.github.com/articles/about-codeowners/#codeowners-syntax
\ No newline at end of file
# Status of Integrator 1 WPNAME features
| Case | Integration developed | Implementor 1 Tested | Implementor 2 Tested | ... Implementor N Tested |
|---|---|---|---|---|
| Case 1 | [ ] | [ ] | [ ] | [ ] |
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 [2021-2022] [LCubed AB, Sweden (iGrant.io)]
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.
# WP-VUI-DataAgreement
# Working Package Summary
Working Package: 3
Working Package Name: Verifiable Data Agreements
Status: Implementation
Start date: 01/08/2021
## Participants
> A Working Package must have at least two implementors and one integrator
Type | Name | Contact Name | Contact email
--- | --- | --- | ---
Coordinator | GATACA | Irene Hernández | irene@gataca.io
Implementor | GATACA | José San Juan | jose@gataca.io
Implementor | IGrant.io | Jan Lindquist | jan@linaltec.com
Integrator | TBD | TBD | TBD
## Terminology
* **Decentralized Identifier (DID)** as defined in [DID-CORE](https://gataca-io.github.io/verifier-apis/#bib-did-core)
* **DID document** as defined in [DID-CORE](https://gataca-io.github.io/verifier-apis/#bib-did-core)
* **DID resolution** as defined in [DID-RESOLUTION](https://gataca-io.github.io/verifier-apis/#bib-did-resolution)
* **Revocation List 2020** as defined in [REVOCATION-LIST-2020](https://w3c-ccg.github.io/vc-status-rl-2020/)
* **Verifier** as defined in [VC-DATA-MODEL](https://gataca-io.github.io/verifier-apis/#bib-vc-data-model)
* **Verifiable Credential (VC)** as defined in [VC-DATA-MODEL](https://gataca-io.github.io/verifier-apis/#bib-vc-data-model)
* **Verifiable Presentation (VP)** as defined in [VC-DATA-MODEL](https://gataca-io.github.io/verifier-apis/#bib-vc-data-model)
## Scope
TBD
## Standard drafts and interoperability specs to be consulted
Refs to previous/existing work
## Participate:
* **Apply as Implementor to this WP**: Create a Merge Request on GitLab editing the ReadMe of the corresponding WP. Set the existing WP Coordinator as reviewer.
* **Apply as Integrator to this WP**: Create a Merge Request on GitLab editing the ReadMe of the corresponding WP. Set the existing WP Coordinator as reviewer.
* **File a bug or comments to the WP**:
- Create new Issues
- Comment on existing Issues
- Suggest improvement by opening a Merge Requests of the repository (publicly available for reading, need a Gitlab account for writing)
- Or else [Mail To: vui@groups.io](mailto://vui@groups.io)
* **Request Access to GitLab**, or any other issue or process if no existing access to GitLab: [Mail To: vui@groups.io](mailto://vui@groups.io)
Standard specification for the WG Data Agreement inside the VUI spec.
Related to https://github.com/decentralised-dataexchange/automated-data-agreements standards.
\ No newline at end of file
{
"@context": "https://schema.igrant.io/data-agreements/v1",
"id": "d7216cb1-aedb-471e-96f7-7fef51dedb76",
"version": "v1.0",
"template_id": "91be609a-4acd-468f-b37a-0f379893b65c",
"template_version": "v1.0",
"usage_purposes": [{
"id": "Customized shopping experience",
"description": "Collecting user data for offering custom tailored shopping experience",
"legal_basis": "<consent/legal_obligation/contract/vital_interest/public_task/legitimate_interest>",
"category": "Marketing"
}],
"data_policy": {
"policy_URL": "https://clarifyhealth.com/privacy-policy/",
"jurisdiction": "Stockholm, Sweden",
"industry_scope": "Healthcare",
"data_retention_period": 31536000000, //duration in ms
"geographic_restriction": "Europe, Not restricted", //optional
"geo_location": "Europe", //optional
"privacy_rights_URL": "https://dataAgreeements.org/withdraw", //optional
"code_of_conduct": "https://example.org/CodeOfConduct" //optional
},
"personal_data": [{
"attribute_id": "f216cb1-aedb-571e-46f7-2fef51dedb54",
"attribute_name": "Name",
"attribute_mandatory": false,
"attribute_category": "General",
"purposes": ["Customized shopping experience"],
"exchange": true,
"third_party_name": ["*", "did:example:456"] //List of receivers identified by their unique ids
},
{
"attribute_id": "f216cb1-aedb-571e-46f7-2fef51dedb54",
"attribute_name": "Age",
"attribute_mandatory": true,
"attribute_category": "General",
"purposes": ["Customized shopping experience"],
"exchange": false
}
],
"dpia": { //optional
"dpia_conducted": true,
"dpia_passed": true,
"dpia_date": "2021-05-08T08:41:59+0000",
"dpia_verification_url": "https://org.com/dpia_results.html" //optional
},
"data_receiver": {
"id": "did:example:123",
"url": "",
"postal": "", //optional
"email": "", //optional
"phone": "" //optional
},
"data_subject": "did:example:987",
"timestamp": "1629463540",
"service": "Example Service", //Description of the service provided with the usage of this data
"consent_duration": 365,
"form_of_consent": "explicit | implicit",
"termination_timestamp": "1660992340", // Optional: if present, this would mean this consent has been terminated at that point
"proofChain": [{ //Usage of linked data proofs
"type": "Ed25519Signature2018",
"created": "2020-04-02T18:28:08Z",
"verificationMethod": "did:example:987#z6MksHh7qHWvybLg5QTPPdG2DgEjjduBDArV9EF9mRiRzMBN",
"proofPurpose": "assertionMethod",
"jws": "eyJhbGciOiJFZERTQSIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..YtqjEYnFENT7fNW-COD0HAACxeuQxPKAmp4nIl8jYAu__6IH2FpSxv81w-l5PvE1og50tS9tH8WyXMlXyo45CA"
}]
}
\ No newline at end of file
openapi: 3.0.0
info:
title: Data Agreement Audit API
description: Proposed Audit API for a Verifier to offer Data Agreement auditing capabilities. Intended for interop testing. Not needed to implement to conform to VUI
version: 1.0.0
servers:
- url: https://vui.gataca.io/api/v1
description: Gataca's implementor server
- url: http://data-agreements.igrant.io/api/v1
description: IGrantio Data Agreements Server
paths:
/health:
get:
summary: Returns if the service is up and running.
description: Optional extended description in CommonMark or HTML.
tags:
- Integration
responses:
'200': # status code
description: Server UP
/version:
get:
summary: Returns the current version of the service.
description: Optional extended description in CommonMark or HTML.
tags:
- Integration
responses:
'200': # status code
description: A JSON array of user names
content:
application/json:
schema:
type: object
properties:
version:
type: string
releaseDate:
type: string
format: date
components:
schemas:
data_agreement:
type: object
data_agreement_offer:
type: object
data_agreement_acceptance:
type: object
data_agreement_declination:
type: object
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header # can be "header", "query" or "cookie"
name: X-API-KEY # name of the header, query parameter or cookie
basicAuth:
type: http
scheme: basic
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
\ No newline at end of file
openapi: 3.0.0
info:
title: VUI Data Agreement API
description: Proposed API for a Verifier to offer Data Agreement capabilities that must be implemented for holders to interact with them. Intended for interop testing
version: 1.0.0
servers:
- url: https://vui.gataca.io/api/v1
description: Gataca's implementor server
- url: http://data-agreements.igrant.io/api/v1
description: IGrantio Data Agreements Server
paths:
/health:
get:
summary: Returns if the service is up and running.
description: Optional extended description in CommonMark or HTML.
tags:
- Integration
responses:
'200': # status code
description: Server UP
/version:
get:
summary: Returns the current version of the service.
description: Optional extended description in CommonMark or HTML.
tags:
- Integration
responses:
'200': # status code
description: A JSON array of user names
content:
application/json:
schema:
type: object
properties:
version:
type: string
releaseDate:
type: string
format: date
/data-agreements/templates/{template_id}/negotiation:
get:
summary: Request a data agreement offer
description: For interop testing, start the negotiation by requesting a data agreement offer
tags:
- Negotiation
responses:
'200':
description: Offered data agreement with a specific negotiation id
content:
application/json:
schema:
$ref: '#/components/schemas/data_agreement_offer'
/data-agreements/accept/{negotiation_id}:
post:
summary: Accept a data agreement offer
description: After receiving an offer, the user may accept it by sending the signed and filled data agreement
tags:
- Negotiation
security:
- {}
- bearerAuth: [] #optional
requestBody:
description: Submitted data_agreement matching the requested proposal
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/data_agreement_acceptance'
responses:
'200': # status code
description: Accepted data agreement offer
content:
application/json:
schema:
$ref: '#/components/schemas/data_agreement_acceptance'
'400':
description: "Request body malformed"
'403': #optional
description: "Data agreement acceptanced can't be trusted from that source"
'404':
description: "No data agreement negotiation associated to that id"
'409': #optional
description: "Data Agreement on that negotiation already accepted or rejected"
'413': #optional
description: "Request body too large to be processed"
'429': #optional
description: "Rate limit to accept data agreements is exceeded"
'500':
description: "Server error processing the request"
/data-agreements/decline/{negotiation_id}:
post:
summary: Decline a data agreement offer
description: After receiving an offer, the user may decline it by sending a declination response, indicating the causes for declination.
tags:
- Negotiation
security:
- {}
- bearerAuth: [] #optional
requestBody:
description: Declination of the offer with the causes
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/data_agreement_declination'
responses:
'200': # status code
description: Rejected data agreement
content:
application/json:
schema:
$ref: '#/components/schemas/data_agreement_acceptance'
'400':
description: "Request body malformed"
'403': #optional
description: "Data agreement rejection can't be trusted from that source"
'404':
description: "No data agreement negotiation associated to that id"
'409': #optional
description: "Data Agreement on that negotiation already accepted or rejected"
'413': #optional
description: "Request body too large to be processed"
'429': #optional
description: "Rate limit to reject data agreements is exceeded"
'500':
description: "Server error processing the request"
components:
schemas:
data_agreement:
type: object
data_agreement_offer:
type: object
data_agreement_acceptance:
type: object
data_agreement_declination:
type: object
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header # can be "header", "query" or "cookie"
name: X-API-KEY # name of the header, query parameter or cookie
basicAuth:
type: http
scheme: basic
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
\ No newline at end of file
# VUI - Presentation Exchange v1.0
* Authors:
* Status: draft
* Start date:
* Last update:
## Table of contents
* [Summary](#summary)
* [Assumptions](#assumptions)
* [Normative references](#normative-references)
* [Definitions](#definitions)
* [Data Model](#data-model)
* [Features](#features)
* [Protocols](#protocols)
* [Implementation Guidelines](#implementation-guidelines)
\ No newline at end of file
# Test Suite
This Test Suite tests the implementation of the services provided by the different implementors.
## Getting Started
> TBD - Instructions, how to setup and launch the test suite.
## Test Status
| Case | Implementor 1 Status | Implementor 2 Status | ... Implementor N Status |All Implementors|
|---|---|---|---|---|
| Case 1 | [ ] | [ ] | [ ] | [ ] |
## Test Cases for WP-NAME
### Case 1
#### Case 1 succeeds
- should return ``200`` on assumption X
```json
{
"field": "value"
}
```