sahat/satellizer

Satellizer

Live Demo

Satellizer is a simple to use, end-to-end, token-based authentication module for AngularJS with built-in support for Google, Facebook, LinkedIn, Twitter, Instagram, GitHub, Bitbucket, Yahoo, Twitch, Microsoft (Windows Live) OAuth providers, as well as Email and Password sign-in. However, you are not limited to the sign-in options above, in fact you can add any OAuth 1.0 or OAuth 2.0 provider by passing provider-specific information in the app config block.

Backers

Support us with a monthly donation and help us continue our activities. [Become a backer]

Sponsors

Become a sponsor and get your logo on our README on Github with a link to your site. [Become a sponsor]

Table of Contents

• Installation
• Requirements for Mobile Apps
• Usage
• Configuration
• Browser Support
• Authentication Flow
• Login with Email and Password
• Login with OAuth 1.0
• Login with OAuth 2.0
• Logout
• Obtaining OAuth Keys
• API Reference
• FAQ
• Community Resources
• Backers
• Sponsors
• Credits
• License

Installation

Browser

<script src="angular.js"></script>
<script src="satellizer.js"></script>

<!-- Satellizer CDN -->
<script src="https://cdn.jsdelivr.net/satellizer/0.15.5/satellizer.min.js"></script>

NPM

$ npm install satellizer

Bower

$ bower install satellizer

Requirements for Mobile Apps

With any Cordova mobile apps or any framework that uses Cordova, such as Ionic Framework, you will need to add cordova-plugin-inappbrowser plugin:

$ cordova plugin add cordova-plugin-inappbrowser

Make sure that inAppBrowser is listed in your project:

$ cordova plugins
cordova-plugin-console 1.0.2 "Console"
cordova-plugin-device 1.1.1 "Device"
cordova-plugin-inappbrowser 1.3.0 "InAppBrowser"
cordova-plugin-splashscreen 3.2.0 "Splashscreen"
cordova-plugin-statusbar 2.1.1 "StatusBar"
cordova-plugin-whitelist 1.2.1 "Whitelist"
ionic-plugin-keyboard 1.0.8 "Keyboard"

Usage

Step 1. App Module

angular.module('MyApp', ['satellizer'])
  .config(function($authProvider) {

    $authProvider.facebook({
      clientId: 'Facebook App ID'
    });

    // Optional: For client-side use (Implicit Grant), set responseType to 'token' (default: 'code')
    $authProvider.facebook({
      clientId: 'Facebook App ID',
      responseType: 'token'
    });

    $authProvider.google({
      clientId: 'Google Client ID'
    });

    $authProvider.github({
      clientId: 'GitHub Client ID'
    });

    $authProvider.linkedin({
      clientId: 'LinkedIn Client ID'
    });

    $authProvider.instagram({
      clientId: 'Instagram Client ID'
    });

    $authProvider.yahoo({
      clientId: 'Yahoo Client ID / Consumer Key'
    });

    $authProvider.live({
      clientId: 'Microsoft Client ID'
    });

    $authProvider.twitch({
      clientId: 'Twitch Client ID'
    });

    $authProvider.bitbucket({
      clientId: 'Bitbucket Client ID'
    });

    $authProvider.spotify({
      clientId: 'Spotify Client ID'
    });

    // No additional setup required for Twitter

    $authProvider.oauth2({
      name: 'foursquare',
      url: '/auth/foursquare',
      clientId: 'Foursquare Client ID',
      redirectUri: window.location.origin,
      authorizationEndpoint: 'https://foursquare.com/oauth2/authenticate',
    });

  });

Step 2. Controller

angular.module('MyApp')
  .controller('LoginCtrl', function($scope, $auth) {

    $scope.authenticate = function(provider) {
      $auth.authenticate(provider);
    };

  });

Step 3. Template

<button ng-click="authenticate('facebook')">Sign in with Facebook</button>
<button ng-click="authenticate('google')">Sign in with Google</button>
<button ng-click="authenticate('github')">Sign in with GitHub</button>
<button ng-click="authenticate('linkedin')">Sign in with LinkedIn</button>
<button ng-click="authenticate('instagram')">Sign in with Instagram</button>
<button ng-click="authenticate('twitter')">Sign in with Twitter</button>
<button ng-click="authenticate('foursquare')">Sign in with Foursquare</button>
<button ng-click="authenticate('yahoo')">Sign in with Yahoo</button>
<button ng-click="authenticate('live')">Sign in with Windows Live</button>
<button ng-click="authenticate('twitch')">Sign in with Twitch</button>
<button ng-click="authenticate('bitbucket')">Sign in with Bitbucket</button>
<button ng-click="authenticate('spotify')">Sign in with Spotify</button>

Note: For server-side usage please refer to the examples directory.

Configuration

Below is a complete listing of all default configuration options.

$authProvider.httpInterceptor = function() { return true; },
$authProvider.withCredentials = false;
$authProvider.tokenRoot = null;
$authProvider.baseUrl = '/';
$authProvider.loginUrl = '/auth/login';
$authProvider.signupUrl = '/auth/signup';
$authProvider.unlinkUrl = '/auth/unlink/';
$authProvider.tokenName = 'token';
$authProvider.tokenPrefix = 'satellizer';
$authProvider.tokenHeader = 'Authorization';
$authProvider.tokenType = 'Bearer';
$authProvider.storageType = 'localStorage';

// Facebook
$authProvider.facebook({
  name: 'facebook',
  url: '/auth/facebook',
  authorizationEndpoint: 'https://www.facebook.com/v2.5/dialog/oauth',
  redirectUri: window.location.origin + '/',
  requiredUrlParams: ['display', 'scope'],
  scope: ['email'],
  scopeDelimiter: ',',
  display: 'popup',
  oauthType: '2.0',
  popupOptions: { width: 580, height: 400 }
});

// Google
$authProvider.google({
  url: '/auth/google',
  authorizationEndpoint: 'https://accounts.google.com/o/oauth2/auth',
  redirectUri: window.location.origin,
  requiredUrlParams: ['scope'],
  optionalUrlParams: ['display'],
  scope: ['profile', 'email'],
  scopePrefix: 'openid',
  scopeDelimiter: ' ',
  display: 'popup',
  oauthType: '2.0',
  popupOptions: { width: 452, height: 633 }
});

// GitHub
$authProvider.github({
  url: '/auth/github',
  authorizationEndpoint: 'https://github.com/login/oauth/authorize',
  redirectUri: window.location.origin,
  optionalUrlParams: ['scope'],
  scope: ['user:email'],
  scopeDelimiter: ' ',
  oauthType: '2.0',
  popupOptions: { width: 1020, height: 618 }
});

// Instagram
$authProvider.instagram({
  name: 'instagram',
  url: '/auth/instagram',
  authorizationEndpoint: 'https://api.instagram.com/oauth/authorize',
  redirectUri: window.location.origin,
  requiredUrlParams: ['scope'],
  scope: ['basic'],
  scopeDelimiter: '+',
  oauthType: '2.0'
});

// LinkedIn
$authProvider.linkedin({
  url: '/auth/linkedin',
  authorizationEndpoint: 'https://www.linkedin.com/uas/oauth2/authorization',
  redirectUri: window.location.origin,
  requiredUrlParams: ['state'],
  scope: ['r_emailaddress'],
  scopeDelimiter: ' ',
  state: 'STATE',
  oauthType: '2.0',
  popupOptions: { width: 527, height: 582 }
});

// Twitter
$authProvider.twitter({
  url: '/auth/twitter',
  authorizationEndpoint: 'https://api.twitter.com/oauth/authenticate',
  redirectUri: window.location.origin,
  oauthType: '1.0',
  popupOptions: { width: 495, height: 645 }
});

// Twitch
$authProvider.twitch({
  url: '/auth/twitch',
  authorizationEndpoint: 'https://api.twitch.tv/kraken/oauth2/authorize',
  redirectUri: window.location.origin,
  requiredUrlParams: ['scope'],
  scope: ['user_read'],
  scopeDelimiter: ' ',
  display: 'popup',
  oauthType: '2.0',
  popupOptions: { width: 500, height: 560 }
});

// Windows Live
$authProvider.live({
  url: '/auth/live',
  authorizationEndpoint: 'https://login.live.com/oauth20_authorize.srf',
  redirectUri: window.location.origin,
  requiredUrlParams: ['display', 'scope'],
  scope: ['wl.emails'],
  scopeDelimiter: ' ',
  display: 'popup',
  oauthType: '2.0',
  popupOptions: { width: 500, height: 560 }
});

// Yahoo
$authProvider.yahoo({
  url: '/auth/yahoo',
  authorizationEndpoint: 'https://api.login.yahoo.com/oauth2/request_auth',
  redirectUri: window.location.origin,
  scope: [],
  scopeDelimiter: ',',
  oauthType: '2.0',
  popupOptions: { width: 559, height: 519 }
});

// Bitbucket
$authProvider.bitbucket({
  url: '/auth/bitbucket',
  authorizationEndpoint: 'https://bitbucket.org/site/oauth2/authorize',
  redirectUri: window.location.origin + '/',
  optionalUrlParams: ['scope'],
  scope: ['email'],
  scopeDelimiter: ' ',
  oauthType: '2.0',
  popupOptions: { width: 1020, height: 618 }
});

// Spotify
$authProvider.spotify({
  url: '/auth/spotify',
  authorizationEndpoint: 'https://accounts.spotify.com/authorize',
  redirectUri: window.location.origin,
  optionalUrlParams: ['state'],
  requiredUrlParams: ['scope'],
  scope: ['user-read-email'],
  scopePrefix: '',
  scopeDelimiter: ',',
  oauthType: '2.0',
  popupOptions: { width: 500, height: 530 }
});

// Generic OAuth 2.0
$authProvider.oauth2({
  name: null,
  url: null,
  clientId: null,
  redirectUri: null,
  authorizationEndpoint: null,
  defaultUrlParams: ['response_type', 'client_id', 'redirect_uri'],
  requiredUrlParams: null,
  optionalUrlParams: null,
  scope: null,
  scopePrefix: null,
  scopeDelimiter: null,
  state: null,
  oauthType: null,
  popupOptions: null,
  responseType: 'code',
  responseParams: {
    code: 'code',
    clientId: 'clientId',
    redirectUri: 'redirectUri'
  }
});

// Generic OAuth 1.0
$authProvider.oauth1({
  name: null,
  url: null,
  authorizationEndpoint: null,
  redirectUri: null,
  oauthType: null,
  popupOptions: null
});

Browser Support

9+	✓	✓	✓	✓	✓

Authentication Flow

Satellizer relies on token-based authentication using JSON Web Tokens instead of cookies.

Additionally, authorization (obtaining user's information with their permission) and authentication (application sign-in) requires sever-side implementation. See provided examples implemented in multiple languages for your convenience. In other words, you cannot just launch your AngularJS application and expect everything to work. The only exception is when you use OAuth 2.0 Implicit Grant (client-side) authorization by setting responseType: 'token' in provider's configuration.

Login with Email and Password

1. Client: Enter your email and password into the login form.
2. Client: On form submit call $auth.login() with email and password.
3. Client: Send a POST request to /auth/login.
4. Server: Check if email exists, if not - return 401.
5. Server: Check if password is correct, if not - return 401.
6. Server: Create a JSON Web Token and send it back to the client.
7. Client: Parse the token and save it to Local Storage for subsequent use after page reload.

Login with OAuth 1.0

1. Client: Open an empty popup window via $auth.authenticate('provider name').
2. Client: Unlike OAuth 2.0, with OAuth 1.0 you cannot go directly to the authorization screen without a valid request_token.
3. Client: The OAuth 1.0 flow starts with an empty POST request to /auth/provider.
4. Server: Obtain and return request_tokenfor the authorization popup.
5. Client: Set the URL location of a popup to the authorizationEndpoint with a valid request_token query parameter, as well as popup options for height and width. This will redirect a user to the authorization screen. After this point, the flow is very similar to OAuth 2.0.
6. Client: Sign in with your username and password if necessary, then authorize the application.
7. Client: Send a POST request back to the /auth/provider with oauth_token and oauth_verifier query parameters.
8. Server: Do an OAuth-signed POST request to the /access_token URL since we now have oauth_token and oauth_verifier parameters.
9. Server: Look up the user by their unique Provider ID. If user already exists, grab the existing user, otherwise create a new user account.
10. Server: Create a JSON Web Token and send it back to the client.
11. Client: Parse the token and save it to Local Storage for subsequent use after page reload.

Login with OAuth 2.0

1. Client: Open a popup window via $auth.authenticate('provider name').
2. Client: Sign in with that provider, if necessary, then authorize the application.
3. Client: After successful authorization, the popup is redirected back to your app, e.g. http://localhost:3000, with the code (authorization code) query string parameter.
4. Client: The code parameter is sent back to the parent window that opened the popup.
5. Client: Parent window closes the popup and sends a POST request to /auth/provider withcode parameter.
6. Server: Authorization code is exchanged for access token.
7. Server: User information is retrived using the access token from Step 6.
8. Server: Look up the user by their unique Provider ID. If user already exists, grab the existing user, otherwise create a new user account.
9. Server: In both cases of Step 8, create a JSON Web Token and send it back to the client.
10. Client: Parse the token and save it to Local Storage for subsequent use after page reload.

Log out

1. Client: Remove token from Local Storage.

Note: To learn more about JSON Web Tokens visit JWT.io.

Obtaining OAuth Keys

Note: Make sure you have turned on Contacts API and Google+ API in the APIs tab.

Note: Microsoft does not consider localhost or 127.0.0.1 to be a valid URL. As a workaround for local development add 127.0.0.1 mylocalwebsite.net to /etc/hosts file and specify mylocalwebsite.net as your Redirect URL in the API Settings tab.

• Visit https://developer.spotify.com
• Select My Apps on the top menu
• Select Create an App on the right side
• Application Name: Your app name
• Application Description: Your app Description
• Click Create
• Fill out the following:
• Redirect URIs: http://localhost:3000
• Click Save

API Reference

• $auth.login(user, [options])
• $auth.signup(user, [options])
• $auth.authenticate(name, [userData])
• $auth.logout()
• $auth.isAuthenticated()
• $auth.link(name, [userData])
• $auth.unlink(name, [options])
• $auth.getToken()
• $auth.getPayload()
• $auth.setToken(token)
• $auth.removeToken()
• $auth.setStorageType(type)

$auth.login(user, [options])

Sign in using Email and Password.

Parameters

Returns

• response - The HTTP response object from the server.

Usage

var user = {
  email: $scope.email,
  password: $scope.password
};

$auth.login(user)
  .then(function(response) {
    // Redirect user here after a successful log in.
  })
  .catch(function(response) {
    // Handle errors here, such as displaying a notification
    // for invalid email and/or password.
  });

$auth.signup(user, [options])

Create a new account with Email and Password.

Parameters

Returns

• response - The HTTP response object from the server.

Usage

var user = {
  firstName: $scope.firstName,
  lastName: $scope.lastName,
  email: $scope.email,
  password: $scope.password
};

$auth.signup(user)
  .then(function(response) {
    // Redirect user here to login page or perhaps some other intermediate page
    // that requires email address verification before any other part of the site
    // can be accessed.
  })
  .catch(function(response) {
    // Handle errors here.
  });

$auth.authenticate(name, [userData])

Starts the OAuth 1.0 or the OAuth 2.0 authorization flow by opening a popup window. If used client side, responseType: "token" is required in the provider setup to get the actual access token.

Parameters

Returns

• response - The HTTP response object from the server.

Usage

$auth.authenticate('google')
  .then(function(response) {
    // Signed in with Google.
  })
  .catch(function(response) {
    // Something went wrong.
  });

$auth.logout()

Deletes a token from Local Storage (or Session Storage).

Usage

$auth.logout();

$auth.isAuthenticated()

Checks authentication status of a user.

Usage

// Controller
$scope.isAuthenticated = function() {
  return $auth.isAuthenticated();
};

<!-- Template -->
<ul ng-if="!isAuthenticated()">
  <li><a href="/login">Login</a></li>
  <li><a href="/signup">Sign up</a></li>
</ul>
<ul ng-if="isAuthenticated()">
  <li><a href="/logout">Logout</a></li>
</ul>

$auth.link(name, [userData])

Alias for $auth.authenticate(name, [userData]).

:bulb: Note: Account linking (and merging) business logic is handled entirely on the server.

Usage

// Controller
$scope.link = function(provider) {
  $auth.link(provider)
    .then(function(response) {
      // You have successfully linked an account.
    })
    .catch(function(response) {
      // Handle errors here.
    });
};

<!-- Template -->
<button ng-click="link('facebook')">
  Connect Facebook Account
</button>

$auth.unlink(name, [options])

Unlinks an OAuth provider.

By default, sends a POST request to /auth/unlink with the { provider: name } data object.

Parameters

Returns

• response - The HTTP response object from the server.

Usage

$auth.unlink('github')
  .then(function(response) {
    // You have unlinked a GitHub account.
  })
  .catch(function(response) {
    // Handle errors here.
  });

$auth.getToken()

Returns a token from Local Storage (or Session Storage).

$auth.getToken();
// eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOjEyMzQ1Njc4OTAsIm5hbWUiOiJKb2huIERvZSJ9.kRkUHzvZMWXjgB4zkO3d6P1imkdp0ogebLuxnTCiYUU

$auth.getPayload()

Returns a JWT Claims Set, i.e. the middle part of a JSON Web Token.

Usage

$auth.getPayload();
// { exp: 1414978281, iat: 1413765081, userId: "544457a3eb129ee822a38fdd" }

$auth.setToken(token)

Saves a JWT or an access token to Local Storage / Session Storage.

Parameters

$auth.removeToken()

Removes a token from Local Storage / Session Storage. Used internally by $auth.logout().

Usage

$auth.removeToken();

$auth.setStorageType(type)

Sets storage type to Local Storage or Session Storage.

Parameters

Usage

$auth.setStorageType('sessionStorage');

FAQ

:question: How do I set offline_access?

$authProvider.google({
  optionalUrlParams: ['access_type'],
  accessType: 'offline'
});

:question: Can I change redirectUri to something other than base URL?

By default, redirectUri is set to window.location.origin (protocol, hostname, port number of a URL) for all OAuth providers. This redirectUri must match exactly the URL¹ specified in your OAuth app settings.

Facebook (example)

However, you can set redirectUri to any URL path you desire. For instance, you may follow the naming convention of Passport.js:

// Note: Must be absolute path.
window.location.origin + '/auth/facebook/facebook/callback'
window.location.origin + '/auth/facebook/google/callback'
...

Using the example above, a popup window will be redirected to http://localhost:3000/auth/facebook/callback?code=YOUR_AUTHORIZATION_CODE after a successful Facebook authorization. To avoid potential 404 errors, create server routes for each redirectUri URL that return 200 OK. Or alternatively, you may render a custom template with a loading spinner. For the moment, a popup will not stay long enough to see that custom template, due to 20ms interval polling, but in the future I may add support for overriding this polling interval value.

As far as Satellizer is concerned, it does not matter what is the value of redirectUri as long as it matches URL in your OAuth app settings. Satellizer's primary concern is to read URL query/hash parameters, then close a popup.

¹ Note: Depending on the OAuth provider, it may be called Site URL, Callback URL, Redirect URL, and so on.

:question: How can I send a token in a format other than Authorization: Bearer <token>?

If you are unable to send a token to your server in the following format - Authorization: Bearer <token>, then use $authProvider.tokenHeader and $authProvider.tokenType config options to change the header format. The default values are Authorization and Bearer, respectively.

For example, if you need to use Authorization: Basic header, this is where you change it.

:question: How can I avoid sending Authorization header on all HTTP requests?

By default, once user is authenticated, JWT will be sent on every request. If you would like to prevent that, you could use skipAuthorization option in your $http request. For example:

$http({
  method: 'GET',
  url: '/api/endpoint',
  skipAuthorization: true  // `Authorization: Bearer <token>` will not be sent on this request.
});

:question: Is there a way to dynamically change localStorage to sessionStorage?

Yes, you can toggle between localStorage and sessionStorage via the following Satellizer methods:

• $auth.setStorageType('sessionStorage');
• $auth.setStorageType('localStorage');

:question: I am having a problem with Ionic authentication on iOS 9.

First, check what kind of error you are getting by opening the Web Inspector from Develop > Simulator > index.html menu. If you have configured everything correctly, chances are you running into the following error:

Failed to load resource: The resource could not be loaded because the App Transport Security policy requires the use of a secure connection.

Follow instructions on this StackOverflow post by adding NSAppTransportSecurity to info.plist. That should fix the problem.

Community Resources

Tutorials

• Ionic JWT auth with Facebook using Node.js (Part 1 and Part 2)
• Build an Instagram clone with AngularJS, Satellizer, Node.js and MongoDB

Credits

Additionally, I would like to thank all other contributors who have reported bugs, submitted pull requests and suggested new features!

License

The MIT License (MIT)

Copyright (c) 2016 Sahat Yalkabov

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.