Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/auth0/lock
Auth0's signin solution
https://github.com/auth0/lock
dx-sdk lock
Last synced: about 2 months ago
JSON representation
Auth0's signin solution
- Host: GitHub
- URL: https://github.com/auth0/lock
- Owner: auth0
- License: other
- Created: 2014-08-12T18:28:41.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2024-05-15T08:41:52.000Z (4 months ago)
- Last Synced: 2024-05-16T23:42:17.316Z (4 months ago)
- Topics: dx-sdk, lock
- Language: JavaScript
- Homepage: https://auth0.com/docs/libraries/lock
- Size: 158 MB
- Stars: 1,124
- Watchers: 88
- Forks: 553
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
- Support: support/callback-cross-auth.html
Awesome Lists containing this project
README
[](https://opensource.org/licenses/MIT)
[](https://github.com/auth0/lock/actions/workflows/test.yml)
> :warning: Lock is built using React 18 from v12 onwards. Getting issues? Please [submit a bug report](https://github.com/auth0/lock/issues/new?assignees=&labels=bug+report,v12&template=report_a_bug.md&title=).
> :warning: From v12 onwards, we no longer publish to Bower.
## Documentation
- [Docs Site](https://auth0.com/docs) - explore our Docs site and learn more about Auth0.
## Getting Started
### Browser Compatibility
We ensure browser compatibility in Chrome, Safari, Firefox and IE >= 11.
### Installation
Install Lock into your project using [npm](https://npmjs.org):
```sh
npm install auth0-lock
```
From CDN
```html
```
### Configure Auth0
Create a **Single Page Application** in the [Auth0 Dashboard](https://manage.auth0.com/#/applications).
> **If you're using an existing application**, verify that you have configured the following settings in your Single Page Application:
>
> - Click on the "Settings" tab of your application's page.
> - Scroll down and click on the "Show Advanced Settings" link.
> - Under "Advanced Settings", click on the "OAuth" tab.
> - Ensure that "JsonWebToken Signature Algorithm" is set to `RS256` and that "OIDC Conformant" is enabled.
> Next, configure the following URLs for your application under the "Application URIs" section of the "Settings" page:
- **Allowed Callback URLs**: `http://localhost:3000`
- **Allowed Logout URLs**: `http://localhost:3000`
- **Allowed Web Origins**: `http://localhost:3000`
> These URLs should reflect the origins that your application is running on. **Allowed Callback URLs** may also include a path, depending on where you're handling the callback (see below).
> Take note of the **Client ID** and **Domain** values under the "Basic Information" section. You'll need these values in the next step.
### Configure the SDK
Create either an `Auth0Lock` or `Auth0LockPasswordless` instance, depending on your use case:
#### Auth0Lock
```js
import { Auth0Lock } from 'auth0-lock';
const lock = new Auth0Lock('{YOUR_AUTH0_CLIENT_ID}', '{YOUR_AUTH0_DOMAIN}');
```
#### Auth0LockPasswordless
```js
import { Auth0LockPasswordless } from 'auth0-lock';
const lock = new Auth0LockPasswordless('{YOUR_AUTH0_CLIENT_ID}', '{YOUR_AUTH0_DOMAIN}');
```
### Logging In
Configure a listener for the `authenticated` event to retrieve an access token and call `show` to display the Lock widget.
```html
Click to Login
```
```js
lock.on('authenticated', function (authResult) {
lock.getUserInfo(authResult.accessToken, function (error, profileResult) {
if (error) {
// Handle error
return;
}
accessToken = authResult.accessToken;
profile = profileResult;
// Update DOM
});
});
// Show the widget when the login button is clicked
document.getElementById('login').addEventListener('click', () => {
lock.show()
});.
```
For other comprehensive examples and documentation on the configuration options, see the [EXAMPLES.md](https://github.com/auth0/lock/blob/master/EXAMPLES.md) document.
## Feedback
### Contributing
We appreciate feedback and contribution to this repo! Before you get started, please see the following:
- [Auth0's general contribution guidelines](https://github.com/auth0/open-source-template/blob/master/GENERAL-CONTRIBUTING.md)
- [Auth0's code of conduct guidelines](https://github.com/auth0/open-source-template/blob/master/CODE-OF-CONDUCT.md)
- [This repo's contribution guide](https://github.com/auth0/lock/blob/master/DEVELOPMENT.md)
### Raise an issue
:warning: Note: We are no longer supporting requests for new features. Only requests for bug fixes or security patches will be considered.
To provide feedback or report a bug, please [raise an issue on our issue tracker](https://github.com/auth0/lock/issues).
### Vulnerability Reporting
Please do not report security vulnerabilities on the public GitHub issue tracker. The [Responsible Disclosure Program](https://auth0.com/whitehat) details the procedure for disclosing security issues.
## What is Auth0?
Auth0 is an easy to implement, adaptable authentication and authorization platform. To learn more checkout Why Auth0?
This project is licensed under the MIT license. See the LICENSE file for more info.