express-oauth(WIP)

minimal oauth implementation for express

Note: It highly advice to use TLS

Requirements

• NodeJS v9.3.0+
• mongoose v5.0.9+

Install

$ npm install --save @lykmapipo/express-oauth

Usage

'use strict';

//ensure mongo uri
process.env.MONGODB_URI =
  (process.env.MONGODB_URI || 'mongodb://localhost/express-oauth');

//dependencies
const path = require('path');
const mongoose = require('mongoose');
const { app } = require('@lykmapipo/express-oauth');

//connect to mongoose
mongoose.connect(process.env.MONGODB_URI);

//fire oauth app
app.start();

curl /v1/users
curl /v1/clients
curl /v1/tokens
curl /v1/clients/:client/tokens
curl /v1/oauth/athenticate
curl /v1/oauth/authorize
curl /v1/oauth/token

Testing

• Clone this repository

• Install all development dependencies

$ npm install

• Then run test

$ npm test

Contribute

It will be nice, if you open an issue first so that we can know what is going on, then, fork this repo and push in your ideas. Do not forget to add a bit of test(s) of what value you adding.

References

• oauth.net
• oauth-2-simplified
• oauthbible
• expressjs
• Production Best Practices
• Production Best Practices
• Using Middleware
• Health Checks and Graceful Shutdown
• The Twelve Factors App
• node-oauth2-server
• refresh-token-with-jwt-authentication-node-js
• Github
• Google
• an-introduction-to-oauth-2
• ory fosite

Licence

The MIT License (MIT)

Copyright (c) 2018 lykmapipo & Contributors

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.