passport-userapp/README.md

Password and token authentication strategy using UserApp for Passport

# Passport-UserApp

Password and token authentication strategy using [UserApp](https://www.userapp.io) for [Passport](http://passportjs.org/).

*UserApp is a cloud-based user management API for web apps with the purpose to relieve developers from having to program logic for user authentication, sign-up, invoicing, feature/property/permission management, and more.*

This module lets you authenticate using either a username and password or a session token in your Node.js
applications. By plugging into Passport, UserApp authentication can be easily and
unobtrusively integrated into any application or framework that supports
[Connect](http://www.senchalabs.org/connect/)-style middleware, including
[Express](http://expressjs.com/).

## Installation

    $ npm install passport-userapp

## Usage

#### Configure Strategy

The userapp authentication strategy authenticates users using either a username and
password or a session token via a REST call to UserApp. The strategy requires a `verify` callback, which accepts these
credentials and calls `done` providing a user. To be able to use this strategy, you need a [UserApp account](https://app.userapp.io/#/sign-up/), with an [App Id](https://help.userapp.io/customer/portal/articles/1322336-how-do-i-find-my-app-id-).

```javascript
passport.use(new UserAppStrategy({
        appId: 'YOU-USERAPP-APP-ID'
    },
    function (userprofile, done) {
        Users.findOrCreate(userprofile, function(err,user) {
            if(err) return done(err);
                return done(null, user);
            });
        }
    ));
```

#### Authenticate Requests Using Username/Password

Use `passport.authenticate()`, specifying the `'userapp'` strategy, to
authenticate requests using a username and password. The username and password should be sent as POST parameters with the request.

For example, as route middleware in an [Express](http://expressjs.com/)
application:

```javascript
app.post('/login', 
    passport.authenticate('userapp', { failureRedirect: '/login' }),
    function(req, res) {
        res.redirect('/');
    });
```

**Stateless Server Sessions**

To make your server stateless (i.e. you could restart your server without logging out your users), just save the UserApp session token in a cookie named `ua_session_token`:

```javascript
app.post('/login', 
    passport.authenticate('userapp', { failureRedirect: '/login' }),
    function(req, res) {
        res.cookie('ua_session_token', req.user.token);
        res.redirect('/');
    });
```

Don't forget to delete it when logging out:

```javascript
app.get('/logout', function (req, res) {
    req.logout();
    res.clearCookie('ua_session_token');
    res.redirect('/');
});
```

And to protect your routes, use the `passport.authenticate()` method, like this:

```javascript
app.get('/account', 
    passport.authenticate('userapp', { failureRedirect: '/login' }), 
    function (req, res) {
        res.render('account', { user:req.user });
    });
```

#### Authenticate Requests Using a Session Token

Use `passport.authenticate()`, specifying the `'userapp'` strategy, to
authenticate requests using a session token. The token should be sent as a cookie named `ua_session_token` (automatically set by the front-end integrations such as the [AngularJS module](https://github.com/userapp-io/userapp-angular)).

For example, as route middleware in an [Express](http://expressjs.com/)
application:

```javascript
app.post('/api/call', passport.authenticate('userapp'),
    function(req, res) {
        // Return some relevant data, for example the logged in user, articles, etc.
        res.send({ user: req.user });
    });
```

#### Authenticate Requests Using HTTP Basic Authentication

Use `passport.authenticate()`, specifying the `'userapp'` strategy, to
authenticate requests using HTTP Basic Authentication. It can be used in two ways; 1) with a username and password, or 2) by leaving username empty and setting password to a token.

#### User Profile

The user profile follows the [Passport Profile Schema](http://passportjs.org/guide/profile/) when available. Some fields are added to contain all information from the [UserApp User entity](https://app.userapp.io/#/docs/user/#properties).

```javascript
{
    provider: 'userapp',
    id: 'user_id',
    username: 'login',
    name: { familyName: 'last_name', givenName: 'first_name' },
    email: 'email',
    emails: [ { value: 'email' } ],
    permissions: { permissionName: { value: boolean, override: boolean } },
    features: { featureName: { value: boolean, override: boolean } },
    properties: { propertyName: { value: mixed, override: boolean } },
    subscription: { price_list_id: 'string', plan_id: 'string', override: boolean },
    lastLoginAt: unix_timestamp,
    updatedAt: unix_timestamp,
    createdAt: unix_timestamp,
    token: 'session token',
    _raw: { /* raw UserApp User profile */ }
}
```
    
Please note that when working with the [UserApp API](https://app.userapp.io/#/docs/), you will need to create a new user object according to the [User entity](https://app.userapp.io/#/docs/user/#properties). For example `username` => `login`.

## Examples

For a complete, working example, refer to the [login example](https://github.com/userapp-io/passport-userapp/tree/master/examples/login) or the [signup-login example](https://github.com/userapp-io/passport-userapp/tree/master/examples/signup-login).

For an example using AngularJS as front-end, refer to the [AngularJS example](https://github.com/userapp-io/passport-userapp/tree/master/examples/angularjs).

For an example with stateless sessions, refer to the [stateless-login example](https://github.com/userapp-io/passport-userapp/tree/master/examples/stateless-login).

For an example with HTTP Basic Authentication, refer to the [http-basic-auth example](https://github.com/userapp-io/passport-userapp/tree/master/examples/http-basic-auth).

## Related Modules

- [userapp-nodejs](https://github.com/userapp-io/userapp-nodejs) — Node.js client for accessing the UserApp API

## Help

Contact us via email at support@userapp.io or visit our [support center](https://help.userapp.io).

## Credits

  - [Timothy E. Johansson](https://github.com/timothyej)
  - [Charlton Roberts](https://github.com/charltoons)

## License

(The MIT License)

Copyright (c) 2014 UserApp

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.