index.js

var Resource = require('deployd/lib/resource'),
    Script = require('deployd/lib/script'),
    UserCollection = require('deployd/lib/resources/user-collection'),
    internalClient = require('deployd/lib/internal-client'),
    util = require('util'),
    url = require('url'),
    debug = require('debug')('dpd-passport'),

    // Stetegies
    LocalStrategy = require('passport-local').Strategy,
    TwitterStrategy = require('passport-twitter').Strategy,
    FacebookStrategy = require('passport-facebook').Strategy,
    GitHubStrategy = require('passport-github').Strategy,
    GoogleStrategy = require('passport-google-oauth').OAuth2Strategy,
    DribbbleStrategy = require('passport-dribbble').Strategy,
    WeiboStrategy = require('passport-weibo').Strategy,

    // Globals
    DEFAULT_SALT_LEN = 256,
    CALLBACK_URL = 'callback',
    DEFAULT_USERS_COLLECTION = 'users';

// Helper function to get the user collection instance given a name
function getUserCollectionInstance(userCollectionName) {
    return process.server.resources.filter(function(res) {
        return res.config.type === 'UserCollection' && res.name === userCollectionName;
    })[0];
}

function AuthResource() {
    Resource.apply(this, arguments);

    // read and parse config
    var config = this.config;
    config.SALT_LEN = config.SALT_LEN || DEFAULT_SALT_LEN;
    config.baseURL = config.baseURL || process.env.DPD_PASSPORT_BASEURL;
    if(!config.baseURL) {
        debug('baseURL missing, cannot enable any OAuth Module')
    }
    config.usersCollection = config.usersCollection || DEFAULT_USERS_COLLECTION;

    config.allowTwitter = config.allowTwitter && config.baseURL && config.twitterConsumerKey && config.twitterConsumerSecret;
    config.allowFacebook = config.allowFacebook && config.baseURL && config.facebookAppId && config.facebookAppSecret;
    config.allowGitHub = config.allowGitHub && config.baseURL && config.githubClientId && config.githubClientSecret;
    config.allowGoogle = config.allowGoogle && config.baseURL && config.googleClientId && config.googleClientSecret;
    config.allowDribbble = config.allowDribbble && config.baseURL && config.dribbbbleClientId && config.dribbbbleClientSecret;
    config.allowWeibo = config.allowWeibo && config.baseURL && config.weiboClientId && config.weiboClientSecret;
}
util.inherits(AuthResource, Resource);

AuthResource.label = "Passport-Auth";
AuthResource.defaultPath = '/auth';
module.exports = AuthResource;

AuthResource.prototype.clientGeneration = false;

AuthResource.prototype.initPassport = function() {
    if(this.initialized) return;

    var config = this.config,
        dpd = internalClient.build(process.server, {isRoot: true}, []),
        userCollection = getUserCollectionInstance(config.usersCollection);
        passport = (this.passport = require('passport'));

    // Will be called when socialLogins are done
    // Check for existing user and update
    // or create new user and insert
    var socialAuthCallback = function(token, tokenSecret, profile, done) {
        debug('Login callback - profile: %j', profile);

        userCollection.store.first({socialAccountId: String(profile.id)}, function(err, user) {
            if(err) { return done(err); }

            // we need to fake the password here, because deployd will force us to on create
            // There is no other way around the required checks for username and password.
            var fakeLogin = {
                    username: profile.provider + '_' + profile.id,
                    password: 'invalidHash '+profile.id
                },
                saveUser = user || {
                    // these properties will only be set on first insert
                    socialAccountId: String(profile.id),
                    socialAccount: profile.provider,
                    name: profile.displayName,
                    username: fakeLogin.username,
                    password: fakeLogin.password
                };

            // update the profile on every login, so that we always have the latest info available
            saveUser.profile = profile;

            if(user) {
                debug('updating existing user w/ id %s', user.id, profile);
                var update = {profile: profile};

                // backwards compatibility
                if(!user.password) update.password = fakeLogin.password;
                if(!user.username) update.username = fakeLogin.username;

                userCollection.store.update(user.id, update, function(err, res){
                    debug('updated profile for user');

                    done(null, saveUser);
                });
            } else {
                // new user
                debug('creating new user w/ socialAccountId %s', saveUser.socialAccountId, profile);
                saveUser.$limitRecursion = 1000;

                // will run deployd post events
                dpd[config.usersCollection].post(saveUser, function(res, err) {
                    if(err) { return done(err); }

                    // set the password hash to something that is not a valid hash which bypasses deployds checks (i.e. user can never login via password)
                    userCollection.store.update({id: res.id}, {password: saveUser.password}, function() {
                        debug('created profile for user');

                        // cleanup before responding
                        saveUser.id = res.id;

                        done(null, saveUser);
                    });
                });
            }
        });
    };

    if(config.allowLocal) {
        passport.use(new LocalStrategy(
          function(username, password, done) {
            userCollection.store.first({username: username}, function(err, user) {
                if(err) { return done(err); }

                if(user) {
                    var salt = user.password.substr(0, config.SALT_LEN),
                        hash = user.password.substr(config.SALT_LEN);

                    if(hash === UserCollection.prototype.hash(password, salt)) {
                        return done(null, user);
                    }
                }

                return done(null, false, { message: 'Invalid password' });
            });
          }
        ));
    }

    if(config.allowTwitter) {
        var cbURL = url.resolve(config.baseURL, this.path + '/twitter/' + CALLBACK_URL);

        debug('Initializing Twitter Login, cb: %s', cbURL);
        passport.use(new TwitterStrategy({
            consumerKey: config.twitterConsumerKey,
            consumerSecret: config.twitterConsumerSecret,
            callbackURL: cbURL,
            sessionKey: 'data'
          },
          socialAuthCallback
        ));
    }

    if(config.allowFacebook) {
        var cbURL = url.resolve(config.baseURL, this.path + '/facebook/' + CALLBACK_URL);

        debug('Initializing Facebook Login, cb: %s', cbURL);
        passport.use(new FacebookStrategy({
            clientID: config.facebookAppId,
            clientSecret: config.facebookAppSecret,
            profileFields: ['id', 'displayName', 'photos', 'emails'],
            callbackURL: cbURL
          },
          socialAuthCallback
        ));
    }

    if(config.allowGitHub) {
        var cbURL = url.resolve(config.baseURL, this.path + '/github/' + CALLBACK_URL);

        debug('Initializing GitHub Login, cb: %s', cbURL);
        passport.use(new GitHubStrategy({
            clientID: config.githubClientId,
            clientSecret: config.githubClientSecret,
            callbackURL: cbURL
          },
          socialAuthCallback
        ));
    }

    if(config.allowGoogle) {
        var cbURL = url.resolve(config.baseURL, this.path + '/google/' + CALLBACK_URL);

        debug('Initializing Google Login, cb: %s', cbURL);
        passport.use(new GoogleStrategy({
            clientID: config.googleClientId,
            clientSecret: config.googleClientSecret,
            callbackURL: cbURL
          },

          socialAuthCallback
        ));
    }

    if(config.allowDribbble) {
        var cbURL = url.resolve(config.baseURL, this.path + '/dribbble/' + CALLBACK_URL);

        debug('Initializing Dribbble Login, cb: %s', cbURL);
        passport.use(new DribbbleStrategy({
            clientID: config.dribbbbleClientId,
            clientSecret: config.dribbbbleClientSecret,
            callbackURL: cbURL
          },
          socialAuthCallback
        ));
    }

    if(config.allowWeibo) {
        var cbURL = url.resolve(config.baseURL, this.path + '/weibo/' + CALLBACK_URL);

        debug('Initializing Weibo Login, cb: %s', cbURL);
        passport.use(new WeiboStrategy({
            clientID: config.weiboClientId,
            clientSecret: config.weiboClientSecret,
            callbackURL: cbURL
          },
          socialAuthCallback
        ));
    }

    this.initialized = true;
};

var sendResponse = function(ctx, err, config) {
    var sessionData = ctx.session.data;
    var returnUrl = (ctx.req.cookies && ctx.req.cookies.get('_passportReturnUrl')) || null;

    if(returnUrl) {
        var redirectURL = url.parse(returnUrl, true);

        // only append if not disabled
        if(!config.disableReturnParams) {
            // delete search so that query is used
            delete redirectURL.search;

            // make sure query is inited
            redirectURL.query = redirectURL.query || {};
            if(err) {
                redirectURL.query.success = false;
                redirectURL.query.error = err;
            } else {
                // append user + session id to the redirect url
                redirectURL.query.success = true;

                if(!config.disableSessionId) {
                    redirectURL.query.sid = sessionData.id;
                    redirectURL.query.uid = sessionData.uid;
                }
            }
        }

        var redirectURLString = '';
        try {
            redirectURLString = url.format(redirectURL);
        } catch(ex) {
            console.warn('An error happened while formatting the redirectURL', ex);
        }

        // redirect the user
        ctx.res.setHeader("Location", redirectURLString);
        ctx.res.statusCode = 302;

        ctx.done(null, 'This page has moved to ' + redirectURLString);
    } else {
        if(err) {
            ctx.res.statusCode = 401;
            console.error(err);
            return ctx.done('bad credentials');
        } else {
            ctx.done(err, { path: sessionData.path, id: sessionData.id, uid: sessionData.uid });
        }
    }
};

AuthResource.prototype.handle = function(ctx, next) {
    var config = this.config;

    // globally handle logout
    if(ctx.url === '/logout') {
        if (ctx.res.cookies) ctx.res.cookies.set('sid', null, {overwrite: true});
        ctx.session.remove(ctx.done);
        return;
    }

    var parts = ctx.url.split('/').filter(function(p) {
        // filters out all empty parts
        return p;
    });

    // determine requested module
    var requestedModule, options = {};
    switch(parts[0]) {
        case 'login':
            if(ctx.method === 'POST' && this.config.allowLocal) {
                requestedModule = 'local';
            }
            break;
        case 'twitter':
            if(this.config.allowTwitter) {
                requestedModule = 'twitter';
            }
            break;
        case 'facebook':
            if(this.config.allowFacebook) {
                requestedModule = 'facebook';
                if(this.config.facebookScope) {
                    try {
                        options.scope = JSON.parse(this.config.facebookScope);
                    } catch(ex) {
                        debug('Error parsing the facebookScope');
                    }
                }
            }
            break;
        case 'github':
            if(this.config.allowGitHub) {
                requestedModule = 'github';
                if(this.config.githubScope) {
                    try {
                        options.scope = JSON.parse(this.config.githubScope);
                    } catch(ex) {
                        debug('Error parsing the githubScope');
                    }
                }
            }
            break;
        case 'google':
            if(this.config.allowGoogle) {
                requestedModule = 'google';
                options.scope = this.config.googleScope || 'profile email';
            }
            break;
        case 'dribbble':
            if(this.config.allowDribbble) {
                requestedModule = 'dribbble';
            }
            break;
        case 'weibo':
            if(this.config.allowWeibo) {
                requestedModule = 'weibo';
            }
            break;
        default:
            break;
    }

    if(requestedModule) {
        // save the redirectURL for later use
        if(ctx.query.redirectURL && this.config.allowedRedirectURLs) {
            try {
                this.regEx = this.regEx || new RegExp(this.config.allowedRedirectURLs, 'i');

                if(ctx.query.redirectURL.match(this.regEx)) {
                    // save this info into the users session, so that we can access it later (even if the user was redirected to facebook)
                    if (ctx.res.cookies) ctx.res.cookies.set('_passportReturnUrl', ctx.query.redirectURL);
                } else {
                    debug(ctx.query.redirectURL, 'did not match', this.config.allowedRedirectURLs);
                }
            } catch(ex) {
                debug('Error parsing RedirectURL Regex!', ex);
            }
        }

        this.initPassport();
        this.passport.authenticate(requestedModule, options, function(err, user, info) {
            var userCollection = getUserCollectionInstance(config.usersCollection);
            var domain =  userCollection.domain;

            if (err || !user) {
                debug('passport reported error: ', err, user, info);
                console.error(err);
                if (!user) {
                    // If the specified user collection has a login event, then run it before returning
                    if (userCollection.events.Login) {
                        domain.success = false;
                        userCollection.events.Login.run(ctx, domain, function() {
                            return sendResponse(ctx, 'bad credentials', config);
                        });
                    }
                }
                return sendResponse(ctx, 'bad credentials', config);
            }

            var sessionData = {
                path: '/' + config.usersCollection,
                uid: user.id
            };

            // be backwards compatible here, check if the function already exists
            if(typeof UserCollection.prototype.getUserAndPasswordHash === 'function') {
                sessionData.userhash = UserCollection.prototype.getUserAndPasswordHash(user);
            }
            delete user.password;

            function setSession() {
                ctx.session.set(sessionData).save(function(err, session) {
                    // apply the sid manually to the session, since only now do we have the id
                    ctx.res.cookies.set('sid', session.id, { overwrite: true });

                    return sendResponse(ctx, err, config);
                });
            }

            // If the specified user collection has a login event, then run it before returning
            if (userCollection.events.Login) {
                domain.success = true;
                userCollection.events.Login.run(ctx, domain, setSession);
            } else {
                setSession();
            }

        })(ctx.req, ctx.res, ctx.next||ctx.done);
    } else {
        // nothing matched, sorry
        console.error('no module found: %s', parts[0]);
        return sendResponse(ctx, 'bad credentials', config);
    }
};

AuthResource.basicDashboard = {
  settings: [{
    name        : 'usersCollection',
    type        : 'text',
    description : 'This is the name of the Users Collection, make sure the Collection exists before changing! Defaults to users.'
  },{
    name        : 'SALT_LEN',
    type        : 'numeric',
    description : 'Length of the Password salt that is used by deployd. Do not change if you don\'t know what this is or your users may not login anymore! Defaults to 256.'
  },{
    name        : 'baseURL',
    type        : 'text',
    description : 'Specify the Base URL of your site (http://www.your-page.com/) that is used for callbacks. *Required when using any OAuth Login!* Defaults to env variable DPD_PASSPORT_BASEURL.'
  },{
    name        : 'allowedRedirectURLs',
    type        : 'text',
    description : 'Specify a regular expression for which redirect URLs you want to allow. Supply as JS-Regex: "^http://www\.your-page.com/.*$", matching is always done case-insensitive. Defaults to "" (i.e. NO redirects will be allowed!)'
  },{
    name        : 'disableSessionId',
    type        : 'checkbox',
    description : 'Disable appending the Session Id to the redirect URL. This is a security measure for the web. You can access the Session Id from the Cookie-Header.'
  },{
    name        : 'disableReturnParams',
    type        : 'checkbox',
    description : 'Disable appending the success/error to your URL. This is for the times you have a framework like AngularJS that controls your routing. You can access the user from the Users Collection\'s "/me".'
  },{
    name        : 'allowLocal',
    type        : 'checkbox',
    description : 'Allow users to login via Username + Password'
  },{
    name        : 'allowTwitter',
    type        : 'checkbox',
    description : 'Allow users to login via Twitter (requires Twitter Key and Secret!)'
  },{
    name        : 'allowFacebook',
    type        : 'checkbox',
    description : 'Allow users to login via Facebook (requires Facebook Id and Secret!)'
  },{
    name        : 'allowGitHub',
    type        : 'checkbox',
    description : 'Allow users to login via GitHub (requires GitHub Id and Secret!)'
  },{
    name        : 'allowGoogle',
    type        : 'checkbox',
    description : 'Allow users to login via Google'
  },{
    name        : 'allowDribbble',
    type        : 'checkbox',
    description : 'Allow users to login via Dribbble'
  },{
    name        : 'allowWeibo',
    type        : 'checkbox',
    description : 'Allow users to login via Weibo'
  }, {
    name        : 'twitterConsumerKey',
    type        : 'text'/*,
    description : 'TWITTER_CONSUMER_KEY'*/
  }, {
    name        : 'twitterConsumerSecret',
    type        : 'text'/*,
    description : 'TWITTER_CONSUMER_SECRET'*/
  },{
    name        : 'facebookAppId',
    type        : 'text'/*,
    description : 'TWITTER_CONSUMER_KEY'*/
  }, {
    name        : 'facebookAppSecret',
    type        : 'text'/*,
    description : 'TWITTER_CONSUMER_SECRET'*/
  }, {
    name        : 'facebookScope',
    type        : 'text',
    description : 'If your application needs extended permissions, they can be requested here. Supply as JS-Array: "[\'read_stream\']"'
  }, {
    name        : 'githubClientId',
    type        : 'text'/*,
    description : 'TODO'*/
  }, {
    name        : 'githubClientSecret',
    type        : 'text'/*,
    description : 'TODO'*/
  }, {
    name        : 'githubScope',
    type        : 'text',
    description : 'If your application needs extended permissions, they can be requested here. Supply as JS-Array: "[\'repo\']"'
  }, {
    name        : 'googleClientId',
    type        : 'text'
  }, {
    name        : 'googleClientSecret',
    type        : 'text'
  }, {
    name        : 'googleScope',
    type        : 'text',
    description : 'defaults to "profile email"'
  } ,{
    name        : 'dribbbbleClientId',
    type        : 'text'
  }, {
    name        : 'dribbbbleClientSecret',
    type        : 'text'
  } ,{
    name        : 'weiboClientId',
    type        : 'text'
  }, {
    name        : 'weiboClientSecret',
    type        : 'text'
  }]
};