https://github.com/futurestudio/hapi-authorized-scope
Finds the scope that authorizes a user on a route
https://github.com/futurestudio/hapi-authorized-scope
auth authorization future-studio-university hapi hapi-plugin hapijs scope
Last synced: 7 months ago
JSON representation
Finds the scope that authorizes a user on a route
- Host: GitHub
- URL: https://github.com/futurestudio/hapi-authorized-scope
- Owner: futurestudio
- License: mit
- Created: 2019-10-13T17:53:05.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-01-25T12:42:43.000Z (about 2 years ago)
- Last Synced: 2025-06-15T05:35:46.353Z (8 months ago)
- Topics: auth, authorization, future-studio-university, hapi, hapi-plugin, hapijs, scope
- Language: JavaScript
- Homepage:
- Size: 179 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
------
The Future Studio University supports development of this hapi plugin 🚀
Join the Future Studio University and Skyrocket in Node.js
------
## Introduction
The `hapi-authorized-scope` plugin determines and stores the scope that authorized an authenticated request. You'll find the scope authorizing the request in `request.auth.authorizedScope`.
In hapi, you’ll find all auth-related details in `request.auth`, that’s the reason this plugin adds the `authorizedScope` property there:
```js
{
isAuthenticated: true,
isAuthorized: true,
credentials: { username: 'marcus', scope: ['admin', 'user'] },
artifacts: null,
strategy: 'test',
mode: 'required',
error: null,
isInjected: true,
authorizedScope: 'user' // <-- added: the authorized scope that let the user access a route
}
```
## Requirements
> **hapi v19 (or later)** and **Node.js v12 (or newer)**
This plugin requires **hapi v19** (or later) and **Node.js v12 or newer**.
### Compatibility
| Major Release | [hapi.js](https://github.com/hapijs/hapi) version | Node.js version |
| --- | --- | --- |
| `v2` | `>=17 hapi` | `>=12` |
| `v1` | `>=17 hapi` | `>=8` |
## Installation
Add `hapi-authorized-scope` as a dependency to your project:
```bash
npm i hapi-authorized-scope
```
## Usage
The usage is pretty straightforward: register the plugin to your hapi server and that’s it:
```js
await server.register({
plugin: require('hapi-authorized-scope')
})
// went smooth like chocolate :)
```
`hapi-authorized-scope` extends the request lifecycle `onPostAuth` and finds the first scope in the authenticated credentials that authorizes the request to access the route.
In your route handlers or request lifecycle extension points, you may access the authorized scope like this:
```js
{
method: 'GET',
path: '/profile',
options: {
handler: async (request, h) {
const authorizedScope = request.auth.authorizedScope
Logger.debug(`Scope authorizing the user to access this route: ${authorizedScope}`)
return h.view('profile')
}
}
}
```
Enjoy!
## Links & Resources
- [hapi tutorial series](https://futurestud.io/tutorials/hapi-get-your-server-up-and-running) with 100+ tutorials
## Contributing
1. Create a fork
2. Create your feature branch: `git checkout -b my-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request 🚀
## License
MIT © [Future Studio](https://futurestud.io)
---
> [futurestud.io](https://futurestud.io) ·
> GitHub [@futurestudio](https://github.com/futurestudio/) ·
> Twitter [@futurestud_io](https://twitter.com/futurestud_io)
