From 4c1d614135e6f20592cd613e634e4766ac06cc01 Mon Sep 17 00:00:00 2001 From: Filippos Sakellaropoulos Date: Thu, 9 Nov 2023 16:24:49 +0200 Subject: [PATCH 1/2] add github workflow --- .github/workflows/swift.yml | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 .github/workflows/swift.yml diff --git a/.github/workflows/swift.yml b/.github/workflows/swift.yml new file mode 100644 index 0000000..065709d --- /dev/null +++ b/.github/workflows/swift.yml @@ -0,0 +1,27 @@ +# This workflow will build a Swift project +# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-swift + +name: Swift + +on: [push] + +jobs: + build: + + runs-on: macos-latest-xlarge + + steps: + - uses: maxim-lobanov/setup-xcode@v1 + with: + xcode-version: latest + - uses: swift-actions/setup-swift@v1 + - name: Get swift version + run: swift --version + - uses: actions/checkout@v3 + - name: Fix Up Private GitHub URLs + # Add personal access token to all private repo URLs + run: find . -type f \( -name 'Package.swift' -o -name 'Package.resolved' \) -exec sed -i '' "s/https:\/\/github.com\/eu-digital-identity-wallet/https:\/\/${{ secrets.USER_NAME }}:${{ secrets.USER_GITHUB_TOKEN }}@github.com\/eu-digital-identity-wallet/g" {} \; + - name: Build + run: swift build + - name: Run tests + run: swift test From 1402c1e09874f61af17c0d6431011bf589c05be0 Mon Sep 17 00:00:00 2001 From: Filippos Sakellaropoulos Date: Thu, 9 Nov 2023 16:50:19 +0200 Subject: [PATCH 2/2] Created readme and documentation --- .devcontainer/devcontainer.json | 45 ++++ CODE_OF_CONDUCT.md | 137 +++++++++++ CONTRIBUTING.md | 113 +++++++++ Documentation/Reference/README.md | 2 +- .../classes/KeyChainStorageService.md | 44 ++-- .../Reference/structs/IssueRequest.md | 15 +- LICENSE.txt | 132 +++++++++++ NOTICE.txt | 220 ++++++++++++++++++ README.md | 25 +- SECURITY.md | 62 +++++ .../KeyChainStorageService.swift | 14 +- 11 files changed, 764 insertions(+), 45 deletions(-) create mode 100644 .devcontainer/devcontainer.json create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE.txt create mode 100644 NOTICE.txt create mode 100644 SECURITY.md diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json new file mode 100644 index 0000000..41a5104 --- /dev/null +++ b/.devcontainer/devcontainer.json @@ -0,0 +1,45 @@ +{ + "name": "Swift", + "image": "swift:5.9", + "features": { + "ghcr.io/devcontainers/features/common-utils:2": { + "installZsh": "false", + "username": "vscode", + "userUid": "1000", + "userGid": "1000", + "upgradePackages": "false" + }, + "ghcr.io/devcontainers/features/git:1": { + "version": "os-provided", + "ppa": "false" + }, + "ghcr.io/nikitakurpas/features/vapor-toolbox:1": {} + }, + "runArgs": [ + "--cap-add=SYS_PTRACE", + "--security-opt", + "seccomp=unconfined" + ], + // Configure tool-specific properties. + "customizations": { + // Configure properties specific to VS Code. + "vscode": { + // Set *default* container specific settings.json values on container create. + "settings": { + "lldb.library": "/usr/lib/liblldb.so" + }, + // Add the IDs of extensions you want installed when the container is created. + "extensions": [ + "sswg.swift-lang" + ] + } + }, + // Use 'forwardPorts' to make a list of ports inside the container available locally. + // "forwardPorts": [], + + // Use 'postCreateCommand' to run commands after the container is created. + "postCreateCommand": "swift --version", + + // Set `remoteUser` to `root` to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root. + "remoteUser": "vscode" +} \ No newline at end of file diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..4f53d92 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,137 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported at [cnect-eudiw-development@ec.europa.eu](mailto:cnect-eudiw-development@ec.europa.eu). +to the community leaders responsible for enforcement. + +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0]. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available +at [https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org + +[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html + +[Mozilla CoC]: https://github.com/mozilla/diversity + +[FAQ]: https://www.contributor-covenant.org/faq + +[translations]: https://www.contributor-covenant.org/translations diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..31d4b0c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,113 @@ +# Contribution Guidelines + +We welcome contributions to this project. To ensure that the process is smooth for everyone +involved, please follow the guidelines below. + +If you encounter a bug in the project, check if the bug has already been reported. If the +bug has not been reported, you can open an issue to report the bug. + +Before making any changes, it's a good practice to create an issue to describe the changes +you plan to make and the reasoning behind them. + +You can +read [Finding ways to contribute to open source on GitHub](https://docs.github.com/en/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github) +for more information. + +## GitHub Flow + +We use the [GitHub Flow](https://guides.github.com/introduction/flow/) workflow for making +contributions to this project. This means that: + +1. Fork the repository and create a new branch from `main` for your changes. + + ```bash + git checkout main + git pull + git checkout -b my-branch + ``` + +2. Make changes to the code, documentation, or any other relevant files. +3. Commit your changes and push them to your forked repository. + + ```bash + git add . + git commit -m "Add a new feature" + git push origin my-branch + ``` + +4. Create a pull request from your branch to the `main` branch of this repository. + +## Pull Request Checklist + +* Branch from the main branch and, if needed, rebase to the current main branch before submitting + your pull request. If it doesn't merge cleanly with main you may be asked to rebase your changes. + +* Commits should be as small as possible while ensuring that each commit is correct independently ( + i.e., each commit should compile and pass tests). + +* Test your changes as thoroughly as possible before you commit them. Preferably, automate your test + by unit/integration tests. If tested manually, provide information about the test scope in the PR + description (e.g. “Test passed: Upgrade version from 0.42 to 0.42.23.”). + +* Create _Work In Progress [WIP]_ pull requests only if you need clarification or an explicit review + before you can continue your work item. + +* If your patch is not getting reviewed or you need a specific person to review it, you can @-reply + a reviewer asking for a review in the pull request or a comment. + +* Post review: + * If a review requires you to change your commit(s), please test the changes again. + * Amend the affected commit(s) and force push onto your branch. + * Set respective comments in your GitHub review to resolved. + * Create a general PR comment to notify the reviewers that your amendments are ready for another + round of review. + +## Branch Name Rules + +Please name your branch using the following convention: + +```text +/ +``` + +- `type` should be one of the following: + - `feat` for a new feature, + - `fix` for a bug fix, + - `docs` for documentation changes, + - `style` for changes that do not affect the code, such as formatting or whitespace, + - `refactor` for code refactoring, + - `test` for adding or updating tests, or + - `chore` for any other miscellaneous tasks. +- `short-description` should be a short, descriptive name of the changes you are making. + +For example: + +```text +feat/add-new-button +fix/typo-in-readme +docs/update-contributing-guide +style/format-code +refactor/extract-method +test/add-unit-tests +chore/update-dependencies +``` + +## Issues and Planning + +* We use GitHub issues to track bugs and enhancement requests. + +* Please provide as much context as possible when you open an issue. The information you provide + must be comprehensive enough to reproduce that issue for the assignee. Therefore, contributors may + use but aren't restricted to the issue template provided by the project maintainers. + +* When creating an issue, try using one of our issue templates which already contain some guidelines + on which content is expected to process the issue most efficiently. If no template applies, you + can of course also create an issue from scratch. + +* Please apply one or more applicable [labels](/../../labels) to your issue so that all community + members are able to cluster the issues better. + +## Code of Conduct + +Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). +By participating in this project, you agree to abide by its terms. \ No newline at end of file diff --git a/Documentation/Reference/README.md b/Documentation/Reference/README.md index 7cc9361..957ff9b 100644 --- a/Documentation/Reference/README.md +++ b/Documentation/Reference/README.md @@ -14,4 +14,4 @@ - [KeyChainStorageService](classes/KeyChainStorageService.md) -This file was generated by [SourceDocs](https://github.com/eneko/SourceDocs) on 2023-11-08 22:44:40 +0000 \ No newline at end of file +This file was generated by [SourceDocs](https://github.com/eneko/SourceDocs) on 2023-11-09 14:49:54 +0000 \ No newline at end of file diff --git a/Documentation/Reference/classes/KeyChainStorageService.md b/Documentation/Reference/classes/KeyChainStorageService.md index 0a21e08..17c5fe1 100644 --- a/Documentation/Reference/classes/KeyChainStorageService.md +++ b/Documentation/Reference/classes/KeyChainStorageService.md @@ -8,8 +8,8 @@ - `serviceName` - `accessGroup` - [Methods](#methods) + - `init(serviceName:accessGroup:)` - `loadDocument(id:)` - - `init()` - `loadDocuments()` - `saveDocument(_:)` - `deleteDocument(id:)` @@ -27,7 +27,7 @@ Implements key-chain storage ### `serviceName` ```swift -public var serviceName: String = "eudiw" +public var serviceName: String ``` ### `accessGroup` @@ -37,34 +37,37 @@ public var accessGroup: String? ``` ## Methods -### `loadDocument(id:)` +### `init(serviceName:accessGroup:)` ```swift -public func loadDocument(id: String) throws -> Document? +public init(serviceName: String, accessGroup: String? = nil) ``` -### `init()` +### `loadDocument(id:)` ```swift -public init() +public func loadDocument(id: String) throws -> Document? ``` +Gets the secret document by id passed in parameter +- Parameter id: Document identifier +- Returns: The document if exists + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| id | Document identifier | + ### `loadDocuments()` ```swift public func loadDocuments() throws -> [Document]? ``` -Gets the secret with the id passed in parameter +Gets all documents - Parameters: - - label: The label (docType) of the secret -- Returns: The secret - -#### Parameters - -| Name | Description | -| ---- | ----------- | -| label | The label (docType) of the secret | +- Returns: The documents stored in keychain under the serviceName ### `saveDocument(_:)` @@ -75,19 +78,13 @@ public func saveDocument(_ document: Document) throws Save the secret to keychain Note: the value passed in will be zeroed out after the secret is saved - Parameters: - - id: The Id of the secret - - accessGroup: The access group to use to save secret. - - value: The value of the secret - - label: label of the document + - document: The document to save #### Parameters | Name | Description | | ---- | ----------- | -| id | The Id of the secret | -| accessGroup | The access group to use to save secret. | -| value | The value of the secret | -| label | label of the document | +| document | The document to save | ### `deleteDocument(id:)` @@ -113,7 +110,6 @@ public func deleteDocuments() throws ``` Delete all documents from keychain -Note: the value passed in will be zeroed out after the secret is deleted - Parameters: - id: The Id of the secret diff --git a/Documentation/Reference/structs/IssueRequest.md b/Documentation/Reference/structs/IssueRequest.md index f21cf6a..ef99cb0 100644 --- a/Documentation/Reference/structs/IssueRequest.md +++ b/Documentation/Reference/structs/IssueRequest.md @@ -7,9 +7,8 @@ - [Properties](#properties) - `secureKey` - `publicKey` - - `certificate` - [Methods](#methods) - - `init(certificate:savedKey:)` + - `init(savedKey:)` - `signData(_:)` ```swift @@ -23,29 +22,23 @@ Issue request structure ### `publicKey` -### `certificate` - -```swift -let certificate: SecCertificate? -``` +DER representation of public key ## Methods -### `init(certificate:savedKey:)` +### `init(savedKey:)` ```swift -public init(certificate: SecCertificate? = nil, savedKey: Data? = nil) throws +public init(savedKey: Data? = nil) throws ``` Initialize issue request - Parameters: - - certificate: Root certificate (optional) - savedKey: saved key representation (optional) #### Parameters | Name | Description | | ---- | ----------- | -| certificate | Root certificate (optional) | | savedKey | saved key representation (optional) | ### `signData(_:)` diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..3d556f2 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,132 @@ +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: + + You must give any other recipients of the Work or Derivative Works a copy of this License; and + You must cause any modified files to carry prominent notices stating that You changed the files; and + 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 + 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 diff --git a/NOTICE.txt b/NOTICE.txt new file mode 100644 index 0000000..27f4609 --- /dev/null +++ b/NOTICE.txt @@ -0,0 +1,220 @@ +EU Digital Identity Wallet +Copyright (c) 2023 European Commission + +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. + +(1) google/identity-credential (available at https://github.com/google/identity-credential) +Certain file packages were originally created under the Apache License, Version 2.0. These files have been copied into this project and modified. All modifications are Copyright 2023 European Commission, and are licensed under the Apache License, Version 2.0. + +Original License: + 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. diff --git a/README.md b/README.md index cf068d5..5d4de3b 100644 --- a/README.md +++ b/README.md @@ -1 +1,24 @@ -# eudi-lib-ios-wallet-storage +# EUDI Wallet Reference Implementation + +:heavy_exclamation_mark: **Important!** Before you proceed, please read the [EUDI Wallet Reference Implementation project description](wiki/EUDI_Wallet_Reference_Implementation.md) + +---- + +# EUDI ISO 18013-5 iOS Wallet Storage library +[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0) +[![Swift](https://github.com/eu-digital-identity-wallet/eudi-lib-ios-wallet-storage/actions/workflows/swift.yml/badge.svg)](https://github.com/eu-digital-identity-wallet/eudi-lib-ios-wallet-storage/actions/workflows/swift.yml) +[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=eu-digital-identity-wallet_eudi-lib-ios-wallet-storage&metric=ncloc&token=830355e3188e340a2ac40960135f0418bdab2513)](https://sonarcloud.io/summary/new_code?id=eu-digital-identity-wallet_eudi-lib-ios-wallet-storage) +[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=eu-digital-identity-wallet_eudi-lib-ios-wallet-storage&metric=duplicated_lines_density&token=830355e3188e340a2ac40960135f0418bdab2513)](https://sonarcloud.io/summary/new_code?id=eu-digital-identity-wallet_eudi-lib-ios-wallet-storage) +[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=eu-digital-identity-wallet_eudi-lib-ios-wallet-storage&metric=reliability_rating&token=830355e3188e340a2ac40960135f0418bdab2513)](https://sonarcloud.io/summary/new_code?id=eu-digital-identity-wallet_eudi-lib-ios-wallet-storage) +[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=eu-digital-identity-wallet_eudi-lib-ios-wallet-storage&metric=vulnerabilities&token=830355e3188e340a2ac40960135f0418bdab2513)](https://sonarcloud.io/summary/new_code?id=eu-digital-identity-wallet_eudi-lib-ios-wallet-storage) + + +The initial implementation provides keychain storage for wallet documents + +## Getting Started +The [KeyChainStorageService](Documentation/Reference/classes/KeyChainStorageService.md) class provides functionality for [document](Documentation/Reference/structs/Document.md) storage in iOS keychain. +```swift + // serviceName - the name of the service (container) to be used for keychain storage + // accessGroup - the access group to be used for keychain storage. If nil, the default access group will be used. It can be not null to share storage access with other applications. + let keyChainObj = KeyChainStorageService(serviceName: serviceName, accessGroup: accessGroup) +``` diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..b61e270 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,62 @@ +# EU Digital Identity Wallet Vulnerability Disclosure Policy (VDP) + +At the European Commission, we treat the security of our Communication and Information Systems as a +top priority, in line with Commission Decision EC 2017/46. However, vulnerabilities can never be +completely eliminated, despite all efforts. If exploited, such vulnerabilities can harm the +confidentiality, integrity or availability of the Commission's systems and of the information +processed therein. To identify and remediate vulnerabilities as soon as possible, we value the input +of external entities acting in good faith, and we encourage responsible vulnerability research and +disclosure. This document sets out our definition of good faith in the context of finding and +reporting vulnerabilities, as well as what you can expect from us in return. + +## Scope + +- Architecture and Reference Framework +- Source code in [eu-digital-identity-wallet](https://github.com/eu-digital-identity-wallet) public + repositories + +## If you have identified a vulnerability, please do the following: + +* E-mail your findings to EC-VULNERABILITY-DISCLOSURE@ec.europa.eu, specifying whether or not you + agree to your name or pseudonym being made publicly available as the discoverer of the problem. +* Encrypt your findings using + our [PGP key](https://sks.hnet.se/pks/lookup?search=EC-VULNERABILITY-DISCLOSURE%40ec.europa.eu&fingerprint=on&op=index) + to prevent this critical information from falling into the wrong hands. +* Provide us sufficient information to reproduce the problem so that we can resolve it as quickly as + possible. Usually, the IP address or the URL of the affected system and a description of the + vulnerability will be sufficient, but complex vulnerabilities may require further explanation in + terms of technical information or potential proof-of-concept code. +* Provide your report in English, preferably, or in any other official language of the European + Union. +* Inform us if you agree to make your name/pseudonym publicly available as the discoverer of the + vulnerability. + +## Please do not do the following + +* Do not take advantage of the vulnerability or problem you have discovered, for example by + downloading more data than necessary to demonstrate the vulnerability, deleting, or modifying + other people’s data. +* Do not reveal any data downloaded during the discovery to any other parties. +* Do not reveal the problem to others until it has been resolved. +* Do not perform the following actions: + * Placing malware (virus, worm, Trojan horse, etc.) within the system. + * Reading, copying, modifying or deleting data from the system. + * Making changes to the system. + * Repeatedly accessing the system or sharing access with others. + * Using any access obtained to attempt to access other systems. + * Changing access rights for any other users. + * Using automated scanning tools. + * Using the so-called "brute force" of access to the system. + * Using denial-of-service or social engineering (phishing, vishing, spam etc.). +* Do not use attacks on physical security. + +## What we promise: + +* We will respond to your report within three business days with our evaluation of the report. +* We will handle your report with strict confidentiality. +* Where possible, we will inform you when the vulnerability has been remedied. +* We will process the personal data that you provide (such as your e-mail address and name) in + accordance with the applicable data protection legislation and will not pass on your personal + details to third parties without your permission. +* In the public information concerning the problem reported, we will publish your name as the + discoverer of the problem if you have agreed to this in your initial e-mail diff --git a/Sources/eudi-lib-ios-wallet-storage/KeyChainStorageService.swift b/Sources/eudi-lib-ios-wallet-storage/KeyChainStorageService.swift index a6b2cb8..d1f2cea 100644 --- a/Sources/eudi-lib-ios-wallet-storage/KeyChainStorageService.swift +++ b/Sources/eudi-lib-ios-wallet-storage/KeyChainStorageService.swift @@ -25,6 +25,9 @@ public class KeyChainStorageService: DataStorageService { public var serviceName: String public var accessGroup: String? + /// Gets the secret document by id passed in parameter + /// - Parameter id: Document identifier + /// - Returns: The document if exists public func loadDocument(id: String) throws -> Document? { let query = makeQuery(id: nil, bAll: false) var result: CFTypeRef? @@ -37,10 +40,9 @@ public class KeyChainStorageService: DataStorageService { let dict = result as! NSDictionary return makeDocument(dict: dict) } - /// Gets the secret with the id passed in parameter + /// Gets all documents /// - Parameters: - /// - label: The label (docType) of the secret - /// - Returns: The secret + /// - Returns: The documents stored in keychain under the serviceName public func loadDocuments() throws -> [Document]? { let query = makeQuery(id: nil, bAll: true) var result: CFTypeRef? @@ -58,10 +60,7 @@ public class KeyChainStorageService: DataStorageService { /// Save the secret to keychain /// Note: the value passed in will be zeroed out after the secret is saved /// - Parameters: - /// - id: The Id of the secret - /// - accessGroup: The access group to use to save secret. - /// - value: The value of the secret - /// - label: label of the document + /// - document: The document to save public func saveDocument(_ document: Document) throws { // kSecAttrAccount is used to store the secret Id so that we can look it up later // kSecAttrService is always set to serviceName to enable us to lookup all our secrets later if needed @@ -101,7 +100,6 @@ public class KeyChainStorageService: DataStorageService { } /// Delete all documents from keychain - /// Note: the value passed in will be zeroed out after the secret is deleted /// - Parameters: /// - id: The Id of the secret public func deleteDocuments() throws {