Skip to content

Latest commit

 

History

History
120 lines (71 loc) · 6.84 KB

README.md

File metadata and controls

120 lines (71 loc) · 6.84 KB
Raw

OWND Project Logo

OWND Project

The OWND Project is a non-profit project that aims to realize more trustworthy communication through the social implementation of individual-centered digital identities.

This project was created as part of the "Trusted Web" use case demonstration project promoted by the Digital Market Competition Headquarters, Cabinet Secretariat.

We will develop a white-label digital identity wallet that complies with international standards and a federated messaging application that supports E2E encryption as open source software, and discuss governance to ensure trust.

OWND Project Briefing Material

Learn more about Trusted Web

Project List

Digital Identity Wallet

Issuance of Verifiable Credentials

Messaging Services

OWND Wallet iOS

Overview

OWND Wallet iOS is an implementation of a white-label digital identity wallet that complies with international standards. It aims to serve as a foundation for creating various wallet applications and use cases based on the OWND wallet framework, with a strong emphasis on ensuring interoperability among different wallets. The goal is to enable seamless integration and interaction across a diverse range of digital identity applications, fostering innovation and utility in the digital identity space.

Terminology

  • Verifiable Credential (VC): A digital identity that can be cryptographically verified.
  • Verifiable Presentation (VP): A data format used to present VCs to a verifier.
  • OpenID for Verifiable Credential Issuance (OID4VCI): A standard protocol for issuing VCs. For more information, visit OID4VCI Specification.
  • Self-Issued OpenID Provider v2 (SIOPv2): A standard protocol for issuing self-signed identities. More details can be found at SIOPv2 Specification.
  • OpenID for Verifiable Presentations (OID4VP): A standard protocol for issuing VPs. Read more at OID4VP Specification.

Features

OWND Wallet iOS incorporates a wide array of functionalities designed to enhance the interoperability and usability of digital identities. Below are some of the key features:

  • VC Issuance through OID4VCI Compliance: Integrates with services compliant with OpenID for Verifiable Credential Issuance (OID4VCI) to issue Verifiable Credentials, ensuring adherence to established digital identity standards.

  • SIOPv2 Compliant Login: Facilitates login operations with services that are compliant with Self-Issued OpenID Provider v2 (SIOPv2), offering users a secure and standardized method for identity verification and authentication.

  • VP Provision through OID4VP Compliance: Works with services following the OpenID for Verifiable Presentations (OID4VP) standards to provide Verifiable Presentations, enhancing the trustworthiness and verifiability of shared digital credentials.

  • Account Export/Import for SIOPv2 Logged-in Accounts: Allows users to export or import their accounts logged in via SIOPv2, enabling easy migration between devices or wallets without compromising the security of the digital identity.

These features underscore OWND Wallet iOS's commitment to security, interoperability, and user-centric design, providing a solid foundation for building diverse digital identity ecosystems.

Installation and Building

Cloning the Repository

First, clone the repository to your local machine:

git clone https://github.com/OWND-Project/OWND-Wallet-iOS.git
cd OWND-Wallet-iOS

Building the Project

To build the project, you can use the built-in build functionality of Xcode:

  1. Select the target device or simulator from the device dropdown menu at the top of the Xcode window.
  2. Click the "Build and run" icon (represented by a play button) or press Command (⌘) + R to build and run the project.

Running the App

After successfully building the project, the app will automatically run on the selected emulator or connected physical device:

  • If using a simulator, choose your preferred device from the device dropdown menu in Xcode.
  • If using a physical device, ensure the device is connected to your computer and selected in the device dropdown menu.

Contributing

Development Workflow

We use Git-Flow for our development process. Here is the step-by-step guide:

1. Fork the Repository

  • Start by forking the repository to your own GitHub account.

2. Create a Feature Branch

  • Create a new branch from the develop branch in your forked repository. Name your branch descriptively to indicate the feature or fix you are working on.

3. Make Your Changes

  • Make your changes in your feature branch. Ensure your code adheres to our coding standards and includes appropriate tests.

4. Submit a Pull Request

  • Push your changes to your forked repository and open a pull request (PR) to the develop branch of this repository. Provide a clear and detailed description of your changes in the PR.

5. Code Review and Approval

  • Your PR will be reviewed by the core contributors. They may request changes or provide feedback. Once your PR is approved, it will be merged into the develop branch.

6. Release Preparation

  • At appropriate intervals, a release branch will be created from the develop branch. This branch is used to finalize the release, including bug fixes and version number increments.

7. Merge to Main

  • Once the release is ready, the release branch will be merged into the main branch. A version tag will be created based on the version number.

8. Back-Merge to Develop

  • Finally, the main branch changes will be merged back into the develop branch to ensure that the develop branch includes the latest updates.

License

This project is licensed under the MIT License. See the LICENSE file for details.

The MIT License is a permissive license that is short and to the point. It lets people do anything they want with your code as long as they provide attribution back to you and don’t hold you liable.

For more information on the MIT License, please visit MIT License.