Skip to content

Commit 4abc6bb

Browse files
committed
rename client to wallet sdk and add DID auth
1 parent 8641e21 commit 4abc6bb

24 files changed

+24054
-194
lines changed

.python-version

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
3.8.1

content/assets/catalyst-site-icon.png

-170 KB
Binary file not shown.

content/assets/catalyst-site-logo.png

-170 KB
Binary file not shown.
-151 KB
Binary file not shown.

content/assets/did-authN-protocol.png

178 KB
Loading

content/assets/didecosystem.png

-40 KB
Binary file not shown.

content/assets/image1.jpg

-281 KB
Binary file not shown.

content/assets/keysignparty.jpg

-358 KB
Binary file not shown.

content/assets/unid-logo.png

-7.89 KB
Binary file not shown.
Binary file not shown.

content/assets/unidcore.png

-167 KB
Binary file not shown.

content/client.mdx

-80
This file was deleted.

content/client/1-did-operation.mdx

+7-7
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ UNiD Core supports a variety of DID operations, all of which require the DID own
1111

1212
UNiD Core computes hash from the public key document. The hash with [Multihash](https://multiformats.io/multihash/) format and SHA2-256 (which code is 18 or 0x12) is used for generating hashes of protocol-related values. And then, it generates the base64-encoded entity including these hash values and document are submitted to [Sidetree](https://github.com/decentralized-identity/sidetree) by HTTP POST method. -->
1313

14-
With UNiD SDKs, you can easily generate key pairs using [SECP256K1](https://w3c-ccg.github.io/lds-ecdsa-secp256k1-2019/) with ECDSA algorithm and the payload required for DID register operation.
14+
With the SDK, you can easily generate key pairs using SECP256K1 with ECDSA algorithm and the payload required for DID register operation.
1515

1616
```js
1717
import { Unid } from "@unid/react-native-unid-client-sdk";
@@ -37,7 +37,7 @@ Unid.registerDid(payload);
3737
-->
3838
<!-- You can select a DID method type, signature algorithm type, and key recovery method. -->
3939

40-
After a while, the queued operation will be periodically extracted and executed by Sidetree scheduler and is submitted into the underlying ledger system. If you want to know more detailed the operating principle, please refer to [the specification](https://identity.foundation/sidetree/spec/).
40+
After a while, the queued operation will be periodically extracted and executed by [sidetree batch scheduler]() and is submitted into the underlying ledger system. If you want to know more detailed the operating principle, please refer to [the specification](https://identity.foundation/sidetree/spec/).
4141

4242

4343
### Resolve DID
@@ -54,9 +54,7 @@ Unid.getDidDocument({
5454

5555
<!-- 唯一解けてないこと:holderがDID生成後にbatch処理されるまでの間、RPとAuthNすることができない。RP側で名前解決することができない。holder側のIF制御、署名から復元する。 -->
5656

57-
Great! Now that you've completed to create and register a DID. However, it is just a globally unique identifier so far. Next is to create a verifiable credential for trusted data exchange. [verifiable credential](./3-verifiable-credential).
58-
59-
57+
Great! Now that you've completed to create and register new DID. Next is to issue and exchange a verifiable credential. [VC Operations](./2-verifiable-credential).
6058

6159

6260
### Update DID
@@ -131,7 +129,9 @@ Unid.updateDidDocument({
131129

132130
To replace:
133131
```js
134-
{
132+
import { Unid } from "@unid/react-native-unid-sdk";
133+
134+
Unid.replaceDidDocument({
135135
"action": "replace",
136136
"document": {
137137
"publicKeys": [
@@ -150,5 +150,5 @@ To replace:
150150
}
151151
]
152152
}
153-
}
153+
});
154154
```

content/client/3-did-auth.mdx

-76
This file was deleted.

content/index.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Any subject (e.g., a person, organization, thing, data model, abstract entity, e
3535
3636
> ![DID Ecosystem Overview](./assets/did-architecture.png)
3737
38-
[UNiD Platform](./unid) provides fundermental capabilities of operating DIDs, verifiable credentials, encrypted data storage, communications bwtween DIDs in a privacy-preserving manner.
38+
[UNiD Platform](./unid) provides fundermental capabilities of operating DIDs, verifiable credentials, encrypted data storage, communications between DIDs in a privacy-preserving manner.
3939

4040
### Use Cases
4141

content/intro.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Any subject (e.g., a person, organization, thing, data model, abstract entity, e
3535
3636
> ![DID Ecosystem Overview](./assets/did-architecture.png)
3737
38-
[UNiD Platform](./unid) provides fundermental capabilities of operating DIDs, verifiable credentials, encrypted data storage, communications bwtween DIDs in a privacy-preserving manner.
38+
[UNiD Platform](./unid) provides fundermental capabilities of operating DIDs, verifiable credentials, encrypted data storage, communications between DIDs in a privacy-preserving manner.
3939

4040
### Use Cases
4141

content/unid.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: "description"
55

66
### Intro to UNiD Platform
77

8-
The UNiD Platform provides developers with a means to build **digital trust** in a scalable manner.UNiD implementation is composed of a collection of microservices, allowing developers to combine pluggable and extensible modular for flexibility and freedom of choice without compromising security.
8+
The UNiD Platform provides developers with a means to build **digital trust** in a scalable manner. UNiD implementation is composed of a collection of microservices, allowing developers to combine pluggable and extensible modular for flexibility and freedom of choice without compromising security.
99

1010
As in the diagram below, our platform consists of three components: **UNiD Extensions and SDKs**, **UNiD Core**, and **UNiD Drivers** on the top of Public Trust Layer.
1111

content/unid/3-extensions.mdx

+11-3
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,18 @@ title: "UNiD Extensions"
33
description: "description"
44
---
55

6-
### DID Authentication/Authorization
6+
### DID AuthN
77

8-
- OIDC SIOP
9-
- ZCAPS3.0 https://w3c-ccg.github.io/zcap-ld/
8+
**SIOP DID**
9+
10+
SIOP DID Profile is a DID AuthN flavor to use OpenID Connect together with the strong decentralized, privacy and security guarantees of DID for everyone who wants to have a generic way to integrate identity wallet into their web applications.
11+
12+
The work on [DIF SIOP DID Profile v1 specification](https://identity.foundation/did-siop/) has moved to OIDF AB WG to work on a new SIOP v2 specification that will either introduce breaking changes to the DIF SIOP DID Profile specification or will replace it with an implementation guide document on how to use SIOP v2 in an SSI context.
13+
14+
15+
**ZCAP3.0**
16+
17+
- https://w3c-ccg.github.io/zcap-ld/
1018

1119
### Verifiable Credential Extensions
1220

content/wallet.mdx

+70
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
---
2+
title: "Wallet SDKs"
3+
description: "description"
4+
---
5+
6+
### Getting Started
7+
8+
UNiD Wallet SDKs offer easy-to-use javascript module for DID operations, VC operations, and DID Comm through the underlying UNiD Core APIs and Drivers.
9+
10+
On this page, we get you up and running with React Native SDK for embedding these capabilities into mobile wallet application.
11+
12+
**Prerequisites**
13+
14+
Before we begin, make sure you have the following installed:
15+
- `Node.js v10.x or later`
16+
- `npm v5.x or later`
17+
18+
If you don't already have an account and UNiD tenant established, head over to [here](https://getunid.io), then return to this page.
19+
20+
### Install
21+
22+
Add the `@unid/react-native-unid-wallet-sdk` dependency:
23+
```bash
24+
npm install --save @unid/react-native-unid-wallet-sdk
25+
```
26+
27+
### Linking
28+
29+
Since UNiD wallet SDKs also support a local authentication and key management at OS native layer, we need to link the SDK to your native projects.
30+
31+
Above `react-native >= 0.60` you need to do:
32+
33+
```bash
34+
npx @unid/wizard -i reactNative -p ios
35+
36+
cd ios
37+
pod install
38+
```
39+
Since UNiD wallet SDKs support `auto-linking` and iOS relies on CocoaPods, you need to install dependencies.
40+
If you are running a project with `react-native < 0.60` you sitll need to call `react-native link`.
41+
42+
```bash
43+
react-native link @unid/react-native-unid-wallet-sdk
44+
```
45+
The link step or the `unid-wizard` call with patch your project accordingly.
46+
The UNiD Wizard will guide you through the process of setting everything up correctly. This has to be done only once, and the files created can go into your version control system.
47+
48+
The following changes will be performed:
49+
50+
- add the unid-cocoa package for native local authentication and key management on iOS
51+
- configure Unid for the supplied DSN in your ***index.js/App.js*** files
52+
- store build credentials in ***ios/unid.properties*** and ***android/unid.properties***.
53+
54+
55+
### Configure
56+
57+
After you've completed setting up a tenant and a wallet application in UNiD, UNiD will give you values: `tenant_id` and `client_id` and `client_secret`. These values are used for authetication when wallet application communicates with UNiD SDS or relying parties.
58+
59+
```js
60+
import { Unid } from "@unid/react-native-unid-wallet-sdk";
61+
62+
Unid.init({
63+
client_id: "client_id_token",
64+
env_network: "testnet"
65+
});
66+
```
67+
68+
<!-- The `unid-wizard` will try to add it to your `App.js`. -->
69+
70+
Great! Now that you've completed setting up the wallet SDK. You can step forward to [Generate New DID](./wallet/1-did-operation).

0 commit comments

Comments
 (0)