login-with-github
middleware making it easy to use github as authentication
Usage
Call require('login-with-github')(options)
which returns a middleware handler
suitable to use with express/connect or middler.
The handler takes the parameters req, res, next
and:
- calls
next
with anerr
if the login attempt errored - OR calls
next
with no argumentsreq.github_access_token
is available if the login succeeded, and alsoreq.github_user
(ifoptions.fetch_user
is set)- OR neither of those are available, if no login was attempted (
req.url
didn't matchoptions.login_path
, for example)
Requirements
- github app credentials
req.session
either provided by express/connect or sess.
Options
client_id
(String, required) - client ID of your github appclient_secret
(String, required) - client secret of your github appscope
(String) - comma-separated scopes to include in the authorizationlogin_path
(String) - a specific path such as/login/github
to trigger OAuth redirect on. By default, path is not checked.fetch_user
(Boolean, default:true
) - Fetch the logged-in github user and expose it onreq.github_user
Endpoint options
authorize_url
(String, default:https://github.com/login/oauth/authorize
) - github endpoint for authorizationaccess_token_url
(String, default:https://github.com/login/oauth/access_token
) - github endpoint for access tokenuser_url
(String, default:https://api.github.com/user
) - github endpoint to fetch current user
Example
Without using a framework:
var loginHandler = client_id: 'your-client-id' client_secret: 'your-client-secret' login_path: '/login/github'; var server = sess = server; server;
Also see this example using the motley framework.
Terra Eclipse
Developed byTerra Eclipse, Inc. is a nationally recognized political technology and strategy firm located in Aptos, CA and Washington, D.C.
License: MIT
- Copyright (C) 2013 Carlos Rodriguez (http://s8f.org/)
- Copyright (C) 2013 Terra Eclipse, Inc. (http://www.terraeclipse.com/)
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.