Skip to content

Commit 4dee169

Browse files
Add ecosystem wallet security documentation (#4911)
Signed-off-by: Ian Mukherjee <ian@thirdweb.com> Signed-off-by: Joaquim Verges <joaquim.verges@gmail.com> Co-authored-by: Joaquim Verges <joaquim.verges@gmail.com>
1 parent 5dfde0f commit 4dee169

File tree

4 files changed

+64
-8
lines changed

4 files changed

+64
-8
lines changed
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
import { DocImage, Callout, createMetadata } from "@doc";
2+
3+
export const metadata = createMetadata({
4+
image: {
5+
title: "Ecosystem Wallet Security",
6+
icon: "wallets",
7+
},
8+
title: "Ecosystem Wallet Security",
9+
description:
10+
"Learn how thirdweb protects your user's private keys across an ecosystem using nitro Enclaves",
11+
});
12+
13+
# Ecosystem Wallet Security
14+
15+
## Wallet Creation
16+
17+
When a user signs into an application using their email or social logins for the first time, a wallet is generated within a secure enclave on the server after verifying the user's legitimacy. The enclave provides a trusted execution environment, ensuring the wallet creation process is isolated and protected from external interference.
18+
19+
- The wallet and its corresponding private key are generated entirely within the enclave, never leaving its secure confines.
20+
- User authentication data is verified within the enclave, ensuring that only legitimate, authenticated users can initiate wallet creation.
21+
22+
## Security Measures
23+
24+
- The enclave's cryptographic properties ensure that even the server operators cannot access the contents or operations within the enclave.
25+
- The enclave provides a verifiable hash of the image of the code that is being run on the device, allowing anyone to verify the contents of the code.
26+
- The wallet's private key never exists in an unencrypted form outside of the enclave.
27+
- All sensitive operations, such as transaction signing, occur within the enclave, ensuring the wallet's security.
28+
29+
## Wallet Usage
30+
31+
### General Usage
32+
33+
- When users interact with their wallet via the the enclave, all communications are encrypted and only the legitimate user can access their wallet.
34+
- All traffic is encrypted with TLS and HSTS. Services are run in private VPCs on AWS and accessible only from a single entry point via our Cloudflare DNS.
35+
- Applications can [link multiple authentication methods](/connect/in-app-wallet/guides/link-multiple-profiles) to the same enclave. Any of these methods can be used to authenticate into the users wallet.
36+
37+
### Ecosystem Usage
38+
39+
- Ecosystem wallets are controlled by the ecosystem owner.
40+
- We moved away from the shamir secret sharing model and replaced it with Encalves. This ensures no-one can extract the private key from the client, including other developers in the ecosystem.
41+
- With enclave and partner policies, ecosystem owners are able to place restrictions on what individual partners are able to do. Since the private key is never re-constructed on the client, the ecosystem partner must submit the request to the enclave which would be able to verify the request and block requests that are out of scope or denied by the ecosystem owner.
42+
43+
## Recoverability
44+
45+
- Users can export their private key at any time.
46+
- Thirdweb wallets support three categories of authentication: socials, custom authentication, and email / phone authentication. If a user ever loses access to their authentication method:
47+
48+
1. **For socials and email / phone authentication,** users can utilize the recovery flow of their providers to regain access to their account.
49+
2. **In the case of custom authentication,** the developer managing their authentication flow will be able to re-instate the users account upon successful verification.
50+
3. Application providers **do not have direct access** to user accounts or private keys, as these remain secured within the enclave. The enclave's design ensures that only verified user requests can trigger wallet operations.
51+
52+
- Users are able to link their authentication methods which will provide them multiple ways to access their account if they ever lose access to any one of their authentication method.

apps/portal/src/app/connect/in-app-wallet/guides/get-user-details/page.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import { Tabs, TabsList, TabsContent, TabsTrigger, DocImage } from "@doc";
22

3-
# Retrieving In-App Wallet User Details on the Server
3+
# Fetching User Details from the Server
44

55
## Using the thirdweb TypeScript SDK
66

apps/portal/src/app/connect/in-app-wallet/security/page.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ import { DocImage, Callout, createMetadata } from "@doc";
44

55
export const metadata = createMetadata({
66
image: {
7-
title: "How In-App Wallet works",
7+
title: "In-App Wallet Security",
88
icon: "wallets",
99
},
10-
title: "How In-App Wallet works",
10+
title: "In-App Wallet Security",
1111
description:
12-
"When a user signs into an application using their email or social logins for the first time, a wallet is generated on the user's device. The corresponding wallet key for this wallet is securely split into three shards using Shamir's Secret Sharing algorithm",
12+
"Learn how thirdweb protects your user's private keys using Shamir's Secret Sharing algorithm",
1313
});
1414

1515
# How it works

apps/portal/src/app/connect/sidebar.tsx

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -225,10 +225,6 @@ export const sidebar: SideBar = {
225225
name: "Retrieving Linked Profiles",
226226
href: `${inAppSlug}/guides/retrieve-linked-profiles`,
227227
},
228-
{
229-
name: "Retrieving User Info",
230-
href: `${inAppSlug}/guides/get-user-details`,
231-
},
232228
],
233229
},
234230
{
@@ -261,6 +257,10 @@ export const sidebar: SideBar = {
261257
},
262258
],
263259
},
260+
{
261+
name: "Backend APIs",
262+
href: `${inAppSlug}/guides/get-user-details`,
263+
},
264264
{
265265
name: "FAQs",
266266
href: `${inAppSlug}/faqs`,
@@ -276,6 +276,10 @@ export const sidebar: SideBar = {
276276
name: "Overview",
277277
href: `${ecosystemSlug}/overview`,
278278
},
279+
{
280+
name: "Security",
281+
href: `${ecosystemSlug}/security`,
282+
},
279283
{
280284
name: "Get Started",
281285
href: `${ecosystemSlug}/get-started`,

0 commit comments

Comments
 (0)