sahat/satellizer

Live Demo: https://satellizer.herokuapp.com

Satellizer is a simple to use, end-to-end, token-based authentication module for AngularJS with built-in support for Google, Facebook, LinkedIn, Twitter, Yahoo, Windows Live authentication providers, as well as Email and Password sign-in. 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 during the configuration step.

Table of Contents

Installation

The easiest way to get Satellizer is by running one of the following commands:

# Bower
bower install satellizer

# NPM
npm install satellizer

Note: Alternatively, you may download the latest release or use the CDN:

Note: Sattelizer uses window.btoa and window.atob. If you still need to support IE9, use the Base64 polyfill above.

Usage

Step 1. App Module

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

    $authProvider.facebook({
      clientId: '624059410963642'
    });

    $authProvider.google({
      clientId: '631036554609-v5hm2amv4pvico3asfi97f54sc51ji4o.apps.googleusercontent.com'
    });

    $authProvider.github({
      clientId: '0ba2600b1dbdb756688b'
    });

    $authProvider.linkedin({
      clientId: '77cw786yignpzj'
    });

    $authProvider.yahoo({
      clientId: 'dj0yJmk9dkNGM0RTOHpOM0ZsJmQ9WVdrOVlVTm9hVk0wTkRRbWNHbzlNQS0tJnM9Y29uc3VtZXJzZWNyZXQmeD0wMA--'
    });

    $authProvider.live({
      clientId: '000000004C12E68D'
    });

    $authProvider.twitter({
      url: '/auth/twitter'
    });

    $authProvider.oauth2({
      name: 'foursquare',
      url: '/auth/foursquare',
      redirectUri: window.location.origin,
      clientId: 'MTCEJ3NGW2PNNB31WOSBFDSAD4MTHYVAZ1UKIULXZ2CVFC2K',
      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

Sign in with Facebook
Sign in with Google
Sign in with GitHub
Sign in with LinkedIn
Sign in with Twitter
Sign in with Foursquare
Sign in with Yahoo
Sign in with Windows Live

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

Configuration

Below is a complete listing of all default configuration options.

$authProvider.httpInterceptor = true; // Add Authorization header to HTTP request
$authProvider.loginOnSignup = true;
$authProvider.baseUrl = '/' // API Base URL for the paths below.
$authProvider.loginRedirect = '/';
$authProvider.logoutRedirect = '/';
$authProvider.signupRedirect = '/login';
$authProvider.loginUrl = '/auth/login';
$authProvider.signupUrl = '/auth/signup';
$authProvider.loginRoute = '/login';
$authProvider.signupRoute = '/signup';
$authProvider.tokenRoot = false; // set the token parent element if the token is not the JSON root
$authProvider.tokenName = 'token';
$authProvider.tokenPrefix = 'satellizer'; // Local Storage name prefix
$authProvider.unlinkUrl = '/auth/unlink/';
$authProvider.unlinkMethod = 'get';
$authProvider.authHeader = 'Authorization';
$authProvider.authToken = 'Bearer';
$authProvider.withCredentials = true;
$authProvider.platform = 'browser'; // or 'mobile'
$authProvider.storage = 'localStorage'; // or 'sessionStorage'

// Facebook
$authProvider.facebook({
  url: '/auth/facebook',
  authorizationEndpoint: 'https://www.facebook.com/v2.3/dialog/oauth',
  redirectUri: window.location.origin || window.location.protocol + '//' + window.location.host + '/',
  scope: 'email',
  scopeDelimiter: ',',
  requiredUrlParams: ['display', 'scope'],
  display: 'popup',
  type: '2.0',
  popupOptions: { width: 481, height: 269 }
});

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

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

// Twitter
$authProvider.twitter({
  url: '/auth/twitter',
  type: '1.0',
  popupOptions: { width: 495, height: 645 }
});

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

// Windows Live
$authProvider.live({
  url: '/auth/live',
  authorizationEndpoint: 'https://login.live.com/oauth20_authorize.srf',
  redirectUri: window.location.origin || window.location.protocol + '//' + window.location.host,
  scope: ['wl.basic'],
  scopeDelimiter: ' ',
  requiredUrlParams: ['display', 'scope'],
  display: 'popup',
  type: '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 || window.location.protocol + '//' + window.location.host,
  scope: [],
  scopeDelimiter: ',',
  type: '2.0',
  popupOptions: { width: 559, height: 519 }
});

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

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

Note: If for some reason you are unable to send a token to your server in the following format – Authorization: Bearer , then use $authProvider.authHeader method to override this behavior, e.g. set its value to x-access-token or another custom header that your backend may require.

Not sending the JWT for specific requests

// This request will NOT send the token as it has skipAuthentication
$http({
  url: '/api/endpoint',
  skipAuthorization: true
  method: 'GET'
});

Updating storage

To toggle from localStorage and sessionStorage run $auth.setStorage('sessionStorage'); or $auth.setStorage('localStorage');

Browser Support

9+ ✓ ✓ ✓ ✓

Note: If you stumble upon a browser version that does not work with Satellizer please open an issue so I could update the checkmark with the lowest supported version.

How It Works

Satellizer relies on token-based authentication using JSON Web Tokens instead of cookies. Each Wiki link below goes in-depth into how the authentication process works.

Note: To learn more about JSON Web Token (JWT) visit JWT.io.

Obtaining OAuth Keys

• Visit Google Cloud Console
• Click CREATE PROJECT button
• Enter Project Name, then click CREATE
• Then select APIs & auth from the sidebar and click on Credentials tab
• Click CREATE NEW CLIENT ID button
• Application Type: Web Application
• Authorized Javascript origins: http://localhost:3000
• Authorized redirect URI: http://localhost:3000

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

• Visit Facebook Developers
• Click Apps > Create a New App in the navigation bar
• Enter Display Name, then choose a category, then click Create app
• Click on Settings on the sidebar, then click + Add Platform
• Select Website
• Enter http://localhost:3000 for Site URL

• Sign in at https://apps.twitter.com
• Click on Create New App
• Enter your Application Name, Description and Website
• For Callback URL: http://127.0.0.1:3000
• Go to Settings tab
• Under Application Type select Read and Write access
• Check the box Allow this application to be used to Sign in with Twitter
• Click Update this Twitter’s applications settings

• Visit Live Connect App Management.
• Click on Create application
• Enter an Application name, then click on I accept button
• Go to API Settings tab
• Enter a Redirect URL
• Click Save
• Go to App Settings tab to get Client ID and Client Secret

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 on API Settings tab.

API Reference

$auth.login(user)

Sign in via email and password where:

• user – Plain JavaScript object.

Returns

• response – The $http response object from the server.

$auth.login({
  email: $scope.email,
  password: $scope.password
});

Note: This method returns a promise.

$auth.signup(user)

Creates a local account with email and password. You can use whatever fields you want as long as you implement them on the server.

• user – Plain JavaScript object.

Returns

• response – The $http response object from the server.

Usage

$auth.signup({
  email: $scope.email,
  password: $scope.password
}).then(function(response) {
  console.log(response.data);
});

Note: This method returns a promise.

$auth.authenticate(name, [userData])

Starts the OAuth 1.0 or the OAuth 2.0 authentication flow by opening a popup window:

• provider – One of the built-in provider names or a custom provider name created via $authProvider.oauth1() or $authProvider.oauth2() methods.
• userData – Optional object for sending additional data to the server along with code, clientId, redirectUri (OAuth 2.0) or oauth_token, oauth_verifier (OAuth 1.0).

Returns

• response – The $http response object from the server.

Usage

$auth.authenticate('google').then(function(response) {
  // Signed In.
});

Note: This method returns a promise.

$auth.logout([redirect])

Deletes a JWT from Local Storage.

• redirect – Optional URL string for redirecting after successful logout.

Usage

$auth.logout();

Note: This method returns a promise.

$auth.isAuthenticated()

Returns true if a JWT is present in Local Storage and it is not expired, otherwise returns false.

Note: This method expects the exp claim to check for the expiration time.

Usage

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

• Login
• Sign up

• Logout

$auth.link(provider, [userData])

Links an OAuth provider with the signed-in account. It is practically the same as $auth.authenticate() with the exception that it does not redirect to $authProvider.loginRedirect route path.

• provider – One of the built-in provider names or a custom provider name created via $authProvider.oauth1() or $authProvider.oauth2() methods.
• userData – Optional object for sending additional data to the server along with code, clientId, redirectUri (OAuth 2.0) or oauth_token, oauth_verifier (OAuth 1.0).

Note: Linking accounts business logic is handled entirely on the server.

Usage

$auth.link('github');

Note: This method returns a promise.

$auth.unlink(provider)

Unlinks an OAuth provider from the signed-in account. It sends a GET request to /auth/unlink/:provider.

• provider – One of the built-in provider names or a custom provider name created via $authProvider.oauth1() or $authProvider.oauth2() methods.

Note: You can override the default unlink path above via $authProvider.unlinkUrl configuration property.

Note: It uses GET method by default, but can be changed via $authProvider.unlinkMethod = 'post'. If you are going to use POST, provider obviously should be an object, not a string.

Usage

$auth.unlink('github');

Note: This method returns a promise.

$auth.getToken()

Returns a JWT from Local Storage.

Usage

$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, sub: "544457a3eb129ee822a38fdd" }

$auth.setToken(token, [redirect])

Saves a JWT or an access token to Local Storage. It uses shared.setToken internally.

• token – An object that takes a JWT (response.data[config.tokenName]) or an access token (response.access_token).
• redirect – An optional boolean value that controls whether or not to redirect to loginRedirect route after saving a token. Defaults to false.

$auth.removeToken()

Removes a JWT from Local Storage.

TODO

• [ ] C# (ASP.NET vNext) implementation
• [ ] Go implementation
• [x] Java (Dropwizard) implementation
• [x] Node.js (Express) implementation
• [x] PHP (Laravel) implementation
• [x] Python (Flask) implementation
• [x] Ruby (Ruby on Rails) implementation

Contributing

Found a typo or a bug? Send a pull request. I would especially appreciate pull requests for server-side examples since I do not have much experience with any of the languages on the TODO list.

Credits

A big thanks goes to Alice Chen for all your hard work on the Dropwizard implementation and Jesús Rodríguez for being so proactive and actively reporting bugs.

Additionally, I would like to thank all other contributors who have submitted issues and/or pull requests!

Satellizer was inspired by ng-token-auth and torii and angular-oauth.

License

The MIT License (MIT)

Copyright © 2015 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.