Skip to content

Commit 01392b5

Browse files
authored
Merge pull request #30 from Peersyst/docs/feat/concepts-authentication
[TA-4995]: concepts/authentication page
2 parents 034450d + fa9ada3 commit 01392b5

File tree

3 files changed

+40
-5
lines changed

3 files changed

+40
-5
lines changed
Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,22 @@
11
# Custom backend
22

3-
:::caution
3+
When integrating FastAuth, you can choose to use a custom backend to handle the authentication and authorization of the user. This is useful if you want to use a different authentication provider or if you want to use a different authorization model.
44

5-
This page is under construction.
5+
:::warning
6+
7+
Implementing a custom backend may require additional development and maintenance, as you will need to implement the authentication and authorization logic for your specific use case.
68

79
:::
10+
11+
## Aspects to consider
12+
13+
When implementing a custom backend, there are several aspects to consider:
14+
15+
- **Custom authentication**: You will need to implement the authentication logic for your specific use case. This may include implementing a login page, a logout page, and a user profile page. In addition, you will need to implement the logic to verify the user's identity and ensure the transaction or delegated action is authorized.
16+
- **Security**: You will need to ensure that no keys or secrets are exposed to the client. This is important to prevent unauthorized access to your resources.
17+
18+
## Example
19+
20+
If you want to integrate a custom backend, you can follow this [integration guide](../integrations/custom-backend.md). It will guide you through the process of integrating a custom backend with FastAuth.
21+
22+
If you are looking for an example of a custom backend, you can check out the [Express](../integrations/custom-backend-express.md) example. It shows how to develop a custom backend using [Express.js](https://expressjs.com/), taking care of the authentication and authorization logic.

docs/docs/concepts/auth0.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,27 @@
11
# Auth0
22

3-
:::caution
3+
FastAuth leverages [Auth0](https://auth0.com/) as its **primary authentication provider**, enabling a seamless and secure social login experience for users. Auth0 provides a robust identity platform that handles user authentication across multiple providers while maintaining high security standards.
44

5-
This page is under construction.
5+
:::info
6+
7+
This authentication method is the default and is used for all transactions and delegated actions by the user. We recommend using this method for the best user experience.
68

79
:::
10+
11+
## Supported Login Providers
12+
13+
FastAuth supports several login methods through Auth0:
14+
15+
- **Google**: Users can sign in using their Google accounts, providing a familiar and convenient authentication method. This integration allows users to leverage their existing Google credentials without creating new accounts.
16+
17+
- **Apple**: Apple Sign-In support ensures iOS users can authenticate securely using their Apple ID. This method provides enhanced privacy features and follows Apple's authentication guidelines.
18+
19+
- **Auth0 Username/Password**: Auth0's native username and password authentication system provides a traditional login option for users who prefer to create dedicated accounts.
20+
21+
- **Passkeys**: Support for passkeys offers a modern, passwordless authentication method that enhances security while simplifying the login experience. Passkeys use public key cryptography to authenticate users across their devices.
22+
23+
## Transaction Authentication
24+
25+
For enhanced security, FastAuth requires authentication through Auth0 for every transaction or delegated action by the user. This ensures that all sensitive operations are properly authorized and authenticated, maintaining a secure environment for users' assets and actions.
26+
27+
Transactions and delegated actions are included in the JWT payload returned by Auth0, which is then verified against the [Auth0Guard](./architecture_contracts_auth0-guard.md) contract, verifying the user's identity and ensuring the transaction is authorized.

docs/docs/concepts/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ FastAuth is a NEAR Protocol authentication system that enables secure transactio
66

77
1. Review the [Architecture Overview](./architecture_overview.md)
88
2. Explore the [Contracts](./architecture_contracts_overview.md)
9-
3. Choose your authentication method
9+
3. Choose your [Authentication method](./auth0.md)
1010

1111
## Learn More
1212

0 commit comments

Comments
 (0)