Permalink
Find file
Fetching contributors…
Cannot retrieve contributors at this time
89 lines (54 sloc) 4.51 KB

Angular 2 Tour of Secret Heroes

This is a fork of John Papa's Angular 2 Tour of Heroes repo. The aim of it is to show how to add authenticaton to the heroes app using JSON Web Tokens. JSON Web Tokens (JWT) are retrieved for users with Auth0 and are saved in local storage on a successful login. The user's JWT is then sent to the server in HTTP requests as an Authorization header.

Running the App

Install the dependencies in both the client and server directories.

cd client && npm install
npm start

Then in a new console tab:

cd server && npm install
npm start

You will need to remove the placeholder AUTH0_CLIENT_ID, AUTH0_DOMAIN, and AUTH0_SECRET strings in components/auth/auth.service.ts and server.js and put in your Auth0 credentials.

Do I Need to Use Auth0?

Auth0 provides an extremely easy way to retrieve JWTs for your users so that you don't need to code any identity verification or token signing logic yourself. With Auth0 you can also use any social identity provider at the flip of a switch--no need to write any code.

You can by all means write your own authentication layer for this demo too. Simply modify the express-jwt middleware (more on that below) to use your own secret key.

Differences from the Original

To demonstrate a full authentication setup, there are a number of differences between this fork and the original.

1. Login and Logout Controls

Two new controls--one for logging in and the other for logging out--have been added to the navbar in app.component.ts. Clicking these buttons will call methods that are exposed by another new addition: an AuthService. This service provides logic for opening up the Auth0 Lock widget and saving the user's profile object and JWT in local storage.

2. Express Server

Instead of storing the heroes data locally, it is now being served from a NodeJS app that uses Express. This app is in the server directory and it exposes endpoints for doing CRUD on the public and private heroes.

The server uses express-jwt to protect the secret hero endpoints. The middleware needs to be configured with your Auth0 (or your own) secret key and client ID.

const authCheck = jwt({
  secret: new Buffer('AUTH0_SECRET', 'base64'),
  audience: 'AUTH0_CLIENT_ID'
});

3. Additional Components and Routes

There are a few additional components and corresponding routes to handle the secret heroes. They are:

  • SecretHeroesComponent
  • SecretHeroDetailComponent

These routes are restricted with the AuthGuard provided in auth/auth-guard.service.ts.

4. No More In-Memory Data Service

The in-memory-data.service.ts file has been removed because heroes are now being retrieved from the server.

What is Auth0?

Auth0 helps you to:

  • Add authentication with multiple authentication sources, either social like Google, Facebook, Microsoft Account, LinkedIn, GitHub, Twitter, Box, Salesforce, amont others, or enterprise identity systems like Windows Azure AD, Google Apps, Active Directory, ADFS or any SAML Identity Provider.
  • Add authentication through more traditional username/password databases.
  • Add support for linking different user accounts with the same user.
  • Support for generating signed Json Web Tokens to call your APIs and flow the user identity securely.
  • Analytics of how, when and where users are logging in.
  • Pull data from other sources and add it to the user profile, through JavaScript rules.

Create a free Auth0 account

  1. Go to Auth0 and click Sign Up.
  2. Use Google, GitHub or Microsoft Account to login.

Issue Reporting

If you have found a bug or if you have a feature request, please report them at this repository issues section. Please do not report security vulnerabilities on the public GitHub issue tracker. The Responsible Disclosure Program details the procedure for disclosing security issues.

Author

Auth0

License

This project is licensed under the MIT license. See the LICENSE file for more info.