Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kuzzleio/kuzzle-plugin-auth-passport-oauth
Authentication plugin with oauth services
https://github.com/kuzzleio/kuzzle-plugin-auth-passport-oauth
facebook-authentication google-authentication kuzzle-plugin oauth-authentication oauth2 passport-oauth
Last synced: 3 months ago
JSON representation
Authentication plugin with oauth services
- Host: GitHub
- URL: https://github.com/kuzzleio/kuzzle-plugin-auth-passport-oauth
- Owner: kuzzleio
- License: apache-2.0
- Created: 2016-01-07T11:02:22.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2022-07-25T14:40:24.000Z (over 2 years ago)
- Last Synced: 2024-04-25T00:01:37.932Z (9 months ago)
- Topics: facebook-authentication, google-authentication, kuzzle-plugin, oauth-authentication, oauth2, passport-oauth
- Language: JavaScript
- Homepage:
- Size: 230 KB
- Stars: 5
- Watchers: 14
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://travis-ci.org/kuzzleio/kuzzle-plugin-auth-passport-oauth)
# Plugin Passport OAUTH Authentication
This plugin provides OAUTH2 authentication using [Passport.js strategies](http://passportjs.org/docs).
## Compatibility matrice
| Kuzzle Version | Plugin Version |
| -------------- | -------------- |
| 1.x.x | 4.x.x |
| 2.x.x | 5.x.x |
# Configuration
To edit the configuration of a plugin see [custom plugin configuration](https://docs.kuzzle.io/core/2/guides/essentials/configuration).
List of available configurations:
| Name | Default value | Type | Description |
|------|---------------|-----------|-----------------------------|
| ``strategies`` | ``{}`` | Object | List of the providers you want to use with passport |
| ``credentials`` | ``{}`` | Object | Credentials provided by the provider |
| ``persist`` | ``{}`` | Object | Attributes you want to persist in the user credentials object if the user doesn't exist |
| ``scope`` | ``[]`` | Array | List of fields in the OAUTH 2.0 scope of access |
| ``identifierAttribute`` | | String | Attribute from the profile of the provider to use as unique identifier if you want to persist the user in Kuzzle |
| ``defaultProfile`` | ``["default"]`` | Array | Profiles of the new persisted user |
| ``kuzzleAttributesMapping`` | ``{}`` | Object | Mapping of attributes to persist in the user persisted in Kuzzle |
| ``passportStrategy`` | ``''`` | String | Strategy name for passport (eg. google-oauth20 while the name of the provider is google)
Here is an example of a configuration:
```js
{
"strategies": {
"facebook": {
"passportStrategy": "facebook",
"credentials": {
"clientID": "",
"clientSecret": "",
"callbackURL": "http://localhost:7512/_login/facebook",
"profileFields": ["id", "name", "picture", "email", "gender"]
},
"persist": [
"picture.data.url",
"last_name",
"first_name",
"email"
],
"scope": [
"email",
"public_profile"
],
"kuzzleAttributesMapping": {
"userMail": "email" // will store the attribute "email" as "userEmail" into the user credentials object
},
"identifierAttribute": "email"
}
},
"defaultProfiles": [
"default"
]
}
```
## identifierAttribute
This attribute will be used to identify your users. It has to be unique.
You need to choose an attribute declared in the `persist` array.
## Attribute persistence
Attributes declared in the `persist` array will be persisted in the credentials object and not in the user content.
For example, if you have the following configuration:
```js
{
"strategies": {
"facebook": {
"persist": ["email", "first_name", "picture.data.url"],
"kuzzleAttributesMapping": {
"picture.data.url": "avatar_url"
}
}
}
}
```
And your OAuth provider will send you the following `_json` payload:
```js
{
"email": "[email protected]",
"first_name": "gordon",
"last_name": "freeman",
"picture": {
"data": {
"url": "http://avatar.url"
}
}
}
```
The created user content will be:
```js
{
"content": {
"profileIds": ["default"]
},
"credentials": {
"facebook": {
"email": "[email protected]",
"first_name": "gordon",
"avatar_url": "http://avatar.url"
}
}
}
```
# Usage
The easiest way to implement an oauth authentication in your front-end is to use the [sdk login oauth popup module](https://github.com/kuzzleio/kuzzle-sdk-login-oauth-popup)
See [Kuzzle API Documentation](https://docs.kuzzle.io/core/2/guides/essentials/user-authentication/) for more details about Kuzzle authentication mechanism.
# How to create a plugin
See [Kuzzle documentation](https://docs.kuzzle.io/core/2/guides/write-plugins/start-writing-plugins/) for more information about how to create your own plugin.