Ember Simple Auth Token

This Ember addon is an extension of the Ember Simple Auth library which provides a basic token authenticator and a JSON Web Tokens (jwt) token authenticator with automatic refresh capability. You can find more about why JSON Web Tokens are so awesome in this blog and here as well.

Because users' credentials and tokens are exchanged between the Ember.js app and the server, you must use HTTPS for this connection!

Demo

The test-app has an example of implementing jwt with auto-refresh. It can be run by cloning the repo, then:

cd ember-simple-auth-token
npm i
npm start // express server
// or
npm run mirage // mirage api mock
// navigate to http://localhost:4201

Compatibility

| Library | Compatible Versions | | - | - | | node | v16, v18, v20 | | ember | v4.4, v4.8, v4.12, v5.4, v5.8 | | ember-simple-auth | v6 | | ember-auto-import | v2 | | webpack | v5 |

Installation

Ember Simple Auth Token can be installed with Ember CLI by running:

ember install ember-simple-auth-token

You must manually install a compatible version of ember-simple-auth.

Setup

Calling session.setup() on ember-simple-auth session service

ember-simple-auth no longer uses an initializer to wire up the session service. Your applicaton must implement an application route to call session.setup() on the ember-simple-auth session service:

// app/routes/application.js
import Route from '@ember/routing/route';
import { inject } from '@ember/service';

export default class ApplicationRoute extends Route {
  @inject session;

  async beforeModel() {
    await this.session.setup();
  }
}

Routing

It is recommended by ember-simple-auth to use an authenticated route in your application, placing all secure routes under it, and employing session.requireAuthentication() in beforeModel.

// app/router.js
import EmberRouter from '@ember/routing/router';
import config from 'test-app/config/environment';

export default class Router extends EmberRouter {
  location = config.locationType;
  rootURL = config.rootURL;
}

Router.map(function () {
  this.route('login');
  this.route('authenticated', { path: '' }, function() {
    // all routes that require the session to be authenticated
    this.route('index', { path: '' });
    this.route('secure');
  });
});

// app/routes/authenticated.js
import Route from '@ember/routing/route';
import { inject as service } from '@ember/service';

export default class AuthenticatedRoute extends Route {
  @service session;

  beforeModel(transition) {
    this.session.requireAuthentication(transition, 'login');
  }
}

Leaving path: '' in your router for the authenticated root will keep all secure roots at the top-level, without an extra added path segment. You can also use a path, such as path: 'application', etc. to separate the secured routes from non-secured routes in your URL structure. EG: myapp/application/secure and myapp/login.

All authenticated routes can then inherit the authenticated route:

// app/routes/authenticated/secure.js
import Route from '../authenticated';

export default class SecureRoute extends Route {}

Your project's folder structure would look like this:

project
│
└───app
    │   router.js
    │
    └───routes
        │   application.js
        │   authenticated.js
        │   login.js
        │
        └───authenticated
                secure.js
                index.js

Make sure ember-simple-auth is configured to utilize this route structure in your environment file:

// config/environment.js
ENV['ember-simple-auth'] = {
  routeAfterAuthentication: 'authenticated.index',
  routeAfterInvalidation: 'login',
};

Authenticator

In order to use the token authenticator or the JSON Web Token authenticator, the application should have a route for login. In most cases, the login route will display a form with a username and password field. On form submit, the authenticate action will be called on the session:

// app/router.js
Router.map(function() {
  this.route('login');
});

{{! app/templates/login.hbs }}
<form {{on "submit" this.authenticate}}>
  <label for="username">Login</label>
  {{input id='username' placeholder='Enter Login' value=username}}
  <label for="password">Password</label>
  {{input id='password' placeholder='Enter Password' type='password' value=password}}
  <button type="submit">Login</button>
</form>

// app/controllers/login.js
import Controller from '@ember/controller';
import { service } from '@ember/service';
import { action } from '@ember/object';

export default class LoginController extends Controller {
  @service session;
  @service router;
  username = 'username';
  password = 'password';

  @action
  async authenticate(e) {
    e.preventDefault();
    e.stopPropagation();
    const authenticator = 'authenticator:jwt'; // or 'authenticator:token'
    this.session.authenticate(authenticator, {username: this.username, password: this.password}).catch(err => {
      if (err.status === 401) {
        alert('Incorrect username or password');
        return;
      }
      let errorMessage = '';
      if (err.text) {
        try {
          if (this.isJsonResponse(err.text)) {
            errorMessage = JSON.parse(err.text).errors[0].message;
          } else {
            errorMessage = err.text;
          }
        } catch(er) {
          alert('An unexpected error occurred. ' + er.toString());
        }
      } else {
        errorMessage = err;
      }
      alert(errorMessage);
    });
  }

  isJsonResponse(response) {
    if (typeof response !== 'string') return false;
    try {
      const result = JSON.parse(response);
      const type = Object.prototype.toString.call(result);
      return type === '[object Object]' || type === '[object Array]';
    } catch (err) {
      return false;
    }
  }
}

JSON Web Token Authenticator

The JSON Web Token authenticator will decode the token and look for the expiration time. The difference in the current time and the token expiration time is calculated. The refreshLeeway is subtracted from this value to determine when the automatic token refresh request should be made.

// config/environment.js
ENV['ember-simple-auth-token'] = {
  refreshAccessTokens: true,
  refreshLeeway: 300 // refresh 5 minutes (300 seconds) before expiration
};

The refreshLeeway can be specified to send the requests before the token expires to account for clock skew. Some libraries like PyJWT, ruby-jwt, and node-jsonwebtoken also support specifying a clock tolerance when verifying the token. Leaving refreshLeeway undefined (or zero) could result in the addon's invalidate() function firing at the same time or immediately before the refreshAccessToken() api request. In this case, the user would be invalidated and logged out regardless of setting refreshAccessTokens: true. Setting a value for refreshLeeway (in seconds or decimals of a second) longer than your expected api response time should prevent this situation.

Sample JSON Web Token:

const encodedToken = eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImpvaG4iLCJleHAiOjk4MzQzMjM0fQ.FKuPdB7vmkRfR2fqaWEyltlgOt57lYQ2vC_vFXtlMMJfpCMMq0BEoXEC6rLC5ygORcKHprupi06Zmx0D8nChPQ;
const decodedHeader = {
  'alg': 'HS512',
  'typ': 'JWT'
};
const decodedPayload = {
  'username': 'username',
  'exp': 98343234 // <ISO-8601> UTC seconds
};

To debug JSON Web Token issues, see jwt.

The JSON Web Token authenticator supports both separate access tokens and refresh tokens. By specifying the tokenPropertyName and the refreshTokenPropertyName to the same value, the same token will be used for both access and refresh requests. For more information about refresh tokens, see this blog.

Adapter

In order to send the token with all API requests made to the server, set the headers object in the adapter:

// app/adapters/application.js
import JSONAPIAdapter from '@ember-data/adapter/json-api';
import { service } from '@ember/service';

export default class ApplicationAdapter extends JSONAPIAdapter {
  namespace = 'api';

  @service session;

  get headers() {
    if (this.session.isAuthenticated) {
      return {
        Authorization: `Bearer ${this.session.data.authenticated.token}`,
      };
    } else {
      return {};
    }
  }

  handleResponse(status) {
    if (status === 401 && this.session.isAuthenticated) {
      this.session.invalidate();
    }
  }
}

Mixins

Mixin support has been removed from ember-simple-auth v6. Mixins are therefore no longer supported in ember-simple-auth-token. If you need mixin support, please use the pre Ember 5, non Embroider version of ember-simple-auth-token.

Customization Options

Token Authenticator

// config/environment.js
ENV['ember-simple-auth-token'] = {
  serverTokenEndpoint: '/api/token-auth/', // Server endpoint to send authenticate request
  tokenPropertyName: 'token', // Key in server response that contains the access token
  headers: {} // Headers to add to the authenticate request
};

JSON Web Token Authenticator

In addition to all the customization options available to the token authenticator:

// config/environment.js
ENV['ember-simple-auth-token'] = {
  tokenDataPropertyName: 'tokenData', // Key in session to store token data
  refreshAccessTokens: true, // Enables access token refreshing
  tokenExpirationInvalidateSession: true, // Enables session invalidation on token expiration
  serverTokenRefreshEndpoint: '/api/token-refresh/', // Server endpoint to send refresh request
  refreshTokenPropertyName: 'refresh_token', // Key in server response that contains the refresh token
  tokenExpireName: 'exp', // Field containing token expiration
  refreshLeeway: 0, // Amount of time in seconds to send refresh request before token expiration
  tokenRefreshInvalidateSessionResponseCodes: [401, 403], // Array of response codes that cause an immediate session invalidation if received when attempting to refresh the token
  refreshAccessTokenRetryAttempts: 0, // Number of token retry attempts to make
  refreshAccessTokenRetryTimeout: 1000, // Amount of time in milliseconds to wait between token refresh retry attempts
  tokenRefreshFailInvalidateSession: false // Enables session invalidation if all token refresh retry requests fail
};

mirage

The test-app now uses mirage.js via ember-cli-mirage to simulate a server response to the /token-auth and /token-refresh api endpoints. Run the test-app with mirage support (ember s --environment=mirage) from within the cloned repo:

cd ember-simple-auth-token
npm run mirage

Launching the test-app with npm run mirage or npm run mirage-test will prevent the express server from running. The mirage mock server runs in test mode (ember s --environment=test) simply because the api responses are logged in the browser console and can more easily be inspected. If using FastBoot in the cloned repo, the mirage api mock will not run. You must instead use the express server via npm start.

express server

The test-app also ships with an express server which is run with ember s --environment=development from within the cloned repo:

cd ember-simple-auth-token
npm start

Launching the test-app with npm start will prevent the mirage api mock from running.

Both mirage and express have a /api/helloworld GET endpoint to verify the backend service is running. A call to this endpoint is commented out in test-app/app/routes/application.js.

Testing Configuration

For acceptance testing, token refresh must be disabled to allow the test to exit. Therefore, the following configuration should be set:

// config/environment.js
if (environment === 'test') {
  ENV['ember-simple-auth-token'] = {
    refreshAccessTokens: false,
    tokenExpirationInvalidateSession: false,
  };
}

If your tests are still timing out due to a setTimeout(), you can manually end the timers used in ember-simple-auth-token at the end of each of your tests:

import { module, test } from 'qunit';
import { setupTest } from 'test-app/tests/helpers';
import { getSettledState } from '@ember/test-helpers';

module('Unit | Authenticator | authenticators/jwt.js', function (hooks) {
  setupTest(hooks);

  hooks.beforeEach(function() {
    this.owner.application.jwt = this.owner.lookup('authenticator:jwt');
  });

  const clearState = jwt => {
    let state = getSettledState();
    if (state.hasPendingTimers || state.hasRunLoop) {
      jwt.cancelAllTimers();
    }
  };

  test('your test message`', function(assert) {
    assert.expect(1);
    // ... tests
    clearState(this.owner.application.jwt);
  });
});

Running tests in a cloned repo

ember-cli / qunit tests can be run via the command line from within the cloned repo:

cd ember-simple-auth-token
npm run test

Tests can also be run in the browser, which will refresh and rerun all tests after any change to a test:

cd ember-simple-auth-token
npm run mirage-test
// visit http://localhost:4201/tests

Upgrade Notes

Version 6:

• mixins are no longer supported by ember-simple-auth-token

• ember-simple-auth requires calling session.setup() in your app's routes/application.js

• if refreshLeeway is not set in your app's config/environment.js, it will default to 0 seconds. This may create a race condition where handleAccessTokenExpiration() could be called before refreshAccessToken() completes, even if refreshAccessTokens = true. If this happens, you can set refreshLeeway to a positive number in your config/environment.js to prevent the user being logged out.