middleware making it easy to use github as authentication
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:
errif the login attempt errored
- OR calls
nextwith no arguments
req.github_access_tokenis available if the login succeeded, and also
- OR neither of those are available, if no login was attempted (
options.login_path, for example)
client_id(String, required) - client ID of your github app
client_secret(String, required) - client secret of your github app
scope(String) - comma-separated scopes to include in the authorization
login_path(String) - a specific path such as
/login/githubto trigger OAuth redirect on. By default, path is not checked.
true) - Fetch the logged-in github user and expose it on
https://github.com/login/oauth/authorize) - github endpoint for authorization
https://github.com/login/oauth/access_token) - github endpoint for access token
https://api.github.com/user) - github endpoint to fetch current user
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;
Developed by Terra Eclipse
Terra Eclipse, Inc. is a nationally recognized political technology and strategy firm located in Aptos, CA and Washington, D.C.
- 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.