Skip to content

Commit 17b799b

Browse files
Merge branch 'master' into sfa-android/v4.0.1
2 parents 2d8726d + d82b1c1 commit 17b799b

File tree

104 files changed

+620
-11968
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

104 files changed

+620
-11968
lines changed

docs/auth-provider-setup/aggregate-verifier.mdx

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -38,25 +38,30 @@ combined. The following table shows all possible combinations of login providers
3838

3939
:::
4040

41-
| First Sub-Verifier | Google | Facebook | Twitch | Discord | Auth0 | Email Passwordless | SMS Passwordless |
42-
| :----------------- | :----: | :------: | :----: | :-----: | :---: | :----------------: | :--------------: |
43-
| **Google** ||||||||
44-
| **Facebook** ||||||||
45-
| **Twitch** ||||||||
46-
| **Discord** ||||||||
47-
| **Email P'less** ||||||||
48-
| **SMS P'less** ||||||||
49-
| **Auth0** ||||||||
41+
| First Sub-Verifier | Google | Twitch | Discord | Email Passwordless | Auth0\* |
42+
| :----------------- | :----: | :----: | :-----: | :----------------: | :-----: |
43+
| **Google** ||||||
44+
| **Twitch** ||||||
45+
| **Discord** ||||||
46+
| **Email P'less** ||||||
47+
| **Auth0\*** ||||||
48+
49+
\*Auth0 column also includes Custom JWT, AWS Cognito, and Firebase providers when the JWT verifier
50+
identifier is email.
5051

5152
:::info Important
5253

53-
Some login methods (like Twitch and Discord) cannot be combined with others because they lack a
54-
**common identifier**, such as an email. This identifier is crucial for connecting user accounts
55-
across different authentication methods and ensuring reliable user recognition when switching
56-
between login methods.
54+
- **Twitch** and **Discord** can only be aggregated with themselves (self-aggregate).
55+
- **Google** and **Email Passwordless** can always be aggregated with each other.
56+
- **Google** and **Email Passwordless** can also be aggregated with Auth0, Custom JWT, AWS Cognito,
57+
and Firebase providers, but only when the JWT user identifier is set to email.
5758

5859
:::
5960

61+
Some login methods cannot be combined with others because they lack a **common identifier**, such as
62+
an email. This identifier is crucial for connecting user accounts across different authentication
63+
methods and ensuring reliable user recognition when switching between login methods.
64+
6065
### Auth0 Special Capabilities
6166

6267
When using Auth0 as a verifier, you have access to a wide range of authentication methods. After

docs/connect-blockchain/connect-blockchain.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,10 @@ transactions, smart contract wallets, different elliptic curve pairs and even RS
4141

4242
## Private Key Providers (PnP & SFA)
4343

44-
The Private Key Providers work with the majority of Web3Auth products, including Plug and Play SDKs,
45-
Single Factor Auth SDKs, and tKey SSS (v1) SDKs. As the name suggests these providers are a wrapper
46-
around the user's private key, which is dynamically reconstructed with Shamir's Secret Sharing and
47-
is present in the user's frontend.
44+
The Private Key Providers work with the majority of Web3Auth products, including Plug and Play SDKs
45+
and Single Factor Auth SDKs. As the name suggests these providers are a wrapper around the user's
46+
private key, which is dynamically reconstructed with Shamir's Secret Sharing and is present in the
47+
user's frontend.
4848

4949
Once the authentication happens, the returned result from the Web3Auth network is taken up by the
5050
provider to give a common interface to interact with the blockchain of your choice. Currently,

docs/infrastructure/mpc-architecture.mdx

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,11 @@ import TkeyMpcFlowDark from "@site/static/images/tkey-mpc-flow-dark.png";
1212
import TkeyMpcFlowLight from "@site/static/images/tkey-mpc-flow-light.png";
1313

1414
This document provides an in-depth exploration of the technical architecture of the MPC-based SDKs,
15-
this includes the tKey MPC SDK and CoreKit MPC SDK (a rundown of our SDKs
16-
[here](/how-web3auth-works/)).
15+
this includes the MPC Core Kit SDKs.
1716

1817
The only difference between the SSS-based SDKs and MPC SDKs are that during usage/login MPC SDKs do
1918
not reconstruct user private keys.
2019

21-
While the tKey MPC SDK, supports multiple configurations like 2/n, 2/2 flows, this documentation,
22-
for simplicity, focuses on a 2/3 setup.
23-
2420
## Overview of Cryptographic and Blockchain Support (compatibility and implementations)
2521

2622
Web3Auth supports most popular blockchains & elliptic curves out there. In particular, out of the
@@ -58,8 +54,8 @@ much more convienent. Notably, but non-exhaustively, Web3Auth supports:
5854

5955
## User Key Overview
6056

61-
Web3Auth uses tKey MPC to manage user wallets in a distributed fashion, leveraging various factors
62-
or shares managed by users, including their devices, private inputs, backup locations, and cloud
57+
Web3Auth uses MPC to manage user wallets in a distributed fashion, leveraging various factors or
58+
shares managed by users, including their devices, private inputs, backup locations, and cloud
6359
service providers. As long as a user can access 2 out of n (2/n) of these shares, they can access
6460
their key. This distributedly secure key is called the $TSSKey$.
6561

@@ -99,8 +95,7 @@ $z_1,z_2 \in \mathbb{Z}_q$.
9995

10096
This key's storage process mirrors that of the TSSKey, with the primary difference being that the
10197
metadataKey is always reconstructed and used for encryption/decryption tasks. It's based on the
102-
fundamental Shamir’s Secret Sharing scheme and initially generated on the user's front-end. Readers
103-
can further reference tKey v1 flows used by the metadataKey in our SSS Infrastructure Documentation.
98+
fundamental Shamir’s Secret Sharing scheme and initially generated on the user's front-end.
10499

105100
## Other components
106101

@@ -188,7 +183,7 @@ Signaures.
188183

189184
The TSS signing requires information from two sections:
190185

191-
- shared information (eg. public key, share commitments, theshold, unique identifiers)
186+
- shared information (eg. public key, share commitments, theeshold, unique identifiers)
192187
- local information (eg. TSS key share).
193188

194189
The shared information is stored on metadata and replicated, whereas the local information is kept

docs/infrastructure/sss-architecture.mdx

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,13 @@ import KeyReconstructionFlow from "@site/static/images/key-reconstruction-sss-fl
1111
import SSSArchitectureFlow from "@site/static/images/sss-architecture-flow.png";
1212

1313
This document provides an in-depth exploration of the technical architecture of the Shamir's Secret
14-
Sharing(SSS)-based SDKs, this includes the current Plug and Play SDKs, tKey SSS SDKs (a rundown of
15-
our SDKs [here](/how-web3auth-works/)).
14+
Sharing(SSS)-based SDKs, this includes the current Plug and Play & Single Factor Auth SDKs.
1615

1716
Shamir's Secret Sharing is a base form of MPC that splits a secret into $n$ shares, of which
1817
threshold $t$ are required to reconstruct the secret. You maybe looking for the
1918
[MPC Architecture documentation](/infrastructure/mpc-architecture/) instead which does not require
2019
the key to be reconstructed on usage.
2120

22-
While the tKey SSS SDK, supports multiple configurations like 2/n, 2/2 flows, or m/n flows, this
23-
documentation, for simplicity, focuses on a 2/3 setup.
24-
2521
## Components
2622

2723
The accompanying image illustrates the typical flow of wallet management within the SSS

0 commit comments

Comments
 (0)