MyPage is a personalized page based on your interests.The page is customized to help you to find content that matters you the most.


I'm not curious

JSON Web Token Tutorial: An Example in Laravel and AngularJS

Published on 20 March 17
1823
0
0

With the rising popularity of single page applications, mobile applications, and RESTful API services, the way web developers write back-end code has changed significantly. With technologies like AngularJS and BackboneJS, we are no longer spending much time building markup, instead we are building APIs that our front-end applications consume. Our back-end is more about business logic and data, while presentation logic is moved exclusively to the front-end or mobile applications. These changes have led to new ways of implementing authentication in modern applications.

Authentication is one of the most important parts of any web application. For decades, cookies and server-based authentication were the easiest solution. However, handling authentication in modern Mobile and Single Page Applications can be tricky, and demand a better approach. The best known solutions to authentication problems for APIs are the OAuth 2.0 and the JSON Web Token (JWT).
3
What is a JSON Web Token?

A JSON Web Token, or JWT, is used to send information that can be verified and trusted by means of a digital signature. It comprises a compact and URL-safe JSON object, which is cryptographically signed to verify its authenticity, and which can also be encrypted if the payload contains sensitive information.

Because of it’s compact structure, JWT is usually used in HTTP Authorization headers or URL query parameters.
1
Structure of a JSON Web Token
JSON Web Token Tutorial: An Example in Laravel and AngularJS - Image 1
Header
The header contains the metadata for the token and it minimally contains the type of signature and the encryption algorithm. (You can use a JSON formatter tool to prettify the JSON object.)
1
JSON Web Token Tutorial: An Example in Laravel and AngularJS - Image 2
Payload (claims)

In the context of JWT, a claim can be defined as a statement about an entity (typically, the user), as well as additional meta data about the token itself. The claim contains the information we want to transmit, and that the server can use to properly handle authentication. There are multiple claims we can provide; these include registered claim names, public claim names and private claim names.

Registered Claims

These are the claims that are registered in the IANA JSON Web Token Claims registry. These claims are not intended to be mandatory but rather to provide a starting point for a set of useful, interoperable claims.

These include:

  • iss: The issuer of the token
  • sub: The subject of the token
  • aud: The audience of the token
  • exp: Token expiration time defined in Unix time
  • nbf: Not before time that identifies the time before which the JWT must not be accepted for processing
  • iat: Issued at time, in Unix time, at which the token was issued
  • jti: JWT ID claim provides a unique identifier for the JWT

Public Claims

Public claims need to have collision-resistant names. By making the name a URI or URN naming collisions are avoided for JWTs where the sender and receiver are not part of a closed network.

An example of a public claim name could be: https://www.toptal.com/jwt_claims/is_admin, and the best practice is to place a file at that location describing the claim so that it can be dereferenced for documentation.

Private Claims

Private claim-names may be used in places where JWTs are only exchanged in a closed environment between known systems, such as inside an enterprise. These are claims that we can define ourselves, like user IDs, user roles, or any other information.

Using claim-names that might have conflicting semantic meanings outside of a closed or private system are subject to collision, so use them with caution.

It is important to note that we want to keep a web token as small as possible, so use only necessary data inside public and private claims.

Example Payload
10
JSON Web Token Tutorial: An Example in Laravel and AngularJS - Image 3
Security and Encryption with JWT

It is critical to use TLS/SSL in conjunction with JWT, to prevent man-in-the-middle attacks. In most cases, this will be sufficient to encrypt the JWT payload if it contains sensitive information. However, if we want to add an additional layer of protection, we can encrypt the JWT payload itself using the JSON Web Encryption (JWE) specification.

Of course, if we want to avoid the additional overhead of using JWE, another option is to simply keep sensitive information in our database, and use our token for additional API calls to the server whenever we need to access sensitive data.

Why the Need for Web Tokens?

Before we can see all the benefits of using token authentication, we have to look at the way authentication has been done in the past.

Server-Based Authentication

JSON Web Token Tutorial: An Example in Laravel and AngularJS - Image 4

Because the HTTP protocol is stateless, there needs to be a mechanism for storing user information and a way to authenticate the user on every subsequent request after login. Most websites use cookies for storing user’s session ID.

How it Works

The browser makes a POST request to the server that contains the user’s identification and password. The server responds with a cookie, which is set on the user’s browser, and includes a session ID to identify the user.

On every subsequent request, the server needs to find that session and deserialize it, because user data is stored on the server.

1

Drawbacks of Server-Based Authentication

  • Hard to scale: The server needs to create a session for a user and persist it somewhere on the server. This can be done in memory or in a database. If we have a distributed system, we have to make sure that we use a separate session storage that is not coupled to the application server.

  • Cross-origin request sharing (CORS): When using AJAX calls to fetch a resource from another domain (cross-origin) we could run into problems with forbidden requests because, by default, HTTP requests don’t include cookies on cross-origin requests.

  • Coupling with the web framework: When using server-based authentication we are tied to our framework’s authentication scheme. It is really hard, or even impossible, to share session data between different web frameworks written in different programming languages.

Token-Based Authentication

JSON Web Token Tutorial: An Example in Laravel and AngularJS - Image 5

Token based authentication is stateless, so there is no need to store user information in the session. This gives us the ability to scale our application without worrying where the user has logged in. We can easily use the same token for fetching a secure resource from a domain other than the one we are logged in to.

How JSON Web Tokens Work

A browser or mobile client makes a request to the authentication server containing user login information. The authentication server generates a new JWT access token and returns it to the client. On every request to a restricted resource, the client sends the access token in the query string or Authorization header. The server then validates the token and, if it’s valid, returns the secure resource to the client.

The authentication server can sign the token using any secure signature method. For example, a symmetric key algorithm such as HMAC SHA-256 can be used if there is a secure channel to share the secret key among all parties. Alternatively, an asymmetric, public-key system, such as RSA, can be used as well, eliminating the need for further key-sharing.
Advantages of Token-Based Authentication

Stateless, easier to scale: The token contains all the information to identify the user, eliminating the need for the session state. If we use a load balancer, we can pass the user to any server, instead of being bound to the same server we logged in on.

Reusability: We can have many separate servers, running on multiple platforms and domains, reusing the same token for authenticating the user. It is easy to build an application that shares permissions with another application.

Security: Since we are not using cookies, we don’t have to protect against cross-site request forgery (CSRF) attacks. We should still encrypt our tokens using JWE if we have to put any sensitive information in them, and transmit our tokens over HTTPS to prevent man-in-the-middle attacks.

Performance: There is no server side lookup to find and deserialize the session on each request. The only thing we have to do is calculate the HMAC SHA-256 to validate the token and parse its content.
1
A JSO Web Token Example Using Laravel 5 and AngularJS

In this tutorial I am going to demonstrate how to implement the basic authentication using JSON Web Tokens in two popular web technologies: Laravel 5 for the backend code and AngularJS for the frontend Single Page Application (SPA) example. (You can find the entire demo here, and the source code in this GitHub repository so that you can follow along with the tutorial.)

This JSON web token example will not use any kind of encryption to ensure the confidentiality of the information transmitted in the claims. In practice this is often okay, because TLS/SSL encrypts the request. However, if the token is going to contain sensitive information, such as the user’s social security number, it should also be encrypted using JWE.

Laravel Backend Example

We will use Laravel to handle user registration, persisting user data to a database and providing some restricted data that needs authentication for the Angular app to consume. We will create an example API subdomain to simulate Cross-origin resource sharing (CORS) as well.

Installation and Project Bootstrapping

In order to use Laravel, we have to install the Composer package manager on our machine. When developing in Laravel I recommend using the Laravel Homestead pre-packaged box of Vagrant. It provides us with a complete development environment regardless of our operating system.

The easiest way to bootstrap our Laravel application is to use a Composer package Laravel Installer.

3
JSON Web Token Tutorial: An Example in Laravel and AngularJS - Image 6

After we’ve booted up our Vagrant box with the vagrant up command and logged into it using vagrant ssh, we navigate to the previously defined project directory. In the example above this would be /home/vagrant/coding/jwt. We can now run php artisan migratecommand in order to create the necessary user tables in our database.

Installing Composer Dependencies

Fortunately, there is a community of developers working on Laravel and maintaining many great packages that we can reuse and extend our application with. In this example we will use tymon/jwt-auth, by Sean Tymon, for handling tokens on the server side, and barryvdh/laravel-cors, by Barry vd. Heuvel, for handling CORS.

jwt-auth
10
JSON Web Token Tutorial: An Example in Laravel and AngularJS - Image 7
JSON Web Token Tutorial: An Example in Laravel and AngularJS - Image 8
User Registration
When we make a POST request to /signup with a username and password, we will try to create a new user and save it to the database. After the user has been created, a JWT is created and returned via JSON response.
1
JSON Web Token Tutorial: An Example in Laravel and AngularJS - Image 9
Fetching a Restricted Resource on the same Domain
Once the user is signed in, we can fetch the restricted resource. I’ve created a route /restricted that simulates a resource that needs an authenticated user. In order to do this, the request Authorization header or query string needs to provide the JWT for the backend to verify.
2
JSON Web Token Tutorial: An Example in Laravel and AngularJS - Image 10
Fetching a Restricted Resource from the API Subdomain
In the next JSON web token example, we’ll take a different approach for token validation. Instead of using jwt-auth middleware, we will handle exceptions manually. When we make a POST request to an API server api.jwt.dev/v1/restricted, we are making a cross-origin request, and have to enable CORS on the backend. Fortunately, we have already configured CORS in the config/cors.php file.
3
JSON Web Token Tutorial: An Example in Laravel and AngularJS - Image 11
AngularJS Frontend Example

We are using AngularJS as a front-end, relying on the API calls to the Laravel back-end authentication server for user authentication and sample data, plus the API server for cross-origin example data. Once we go to the homepage of our project, the backend will serve the resources/views/spa.blade.php view that will bootstrap the Angular application.

Here is the folder structure of the Angular app:

1
JSON Web Token Tutorial: An Example in Laravel and AngularJS - Image 12

We are using ngStoragelibrary for AngularJS, to save tokens into the browser’s local storage, so that we can send it on each request via the Authorization header.

In the production environment, of course, we would minify and combine all our script files and stylesheets in order to improve performance.

I’ve created a navigation bar using Bootstrap that will change the visibility of appropriate links, depending on the sign-in status of the user. The sign-in status is determined by the presence of a token variable in the controller’s scope.
4
JSON Web Token Tutorial: An Example in Laravel and AngularJS - Image 13
Controllers
In the controllers.js file, we have defined two controllers for our application: HomeController and RestrictedController.HomeController handles sign-in, sign-up and logout functionality. It passes the username and password data from the sign-in and sign-up forms to the Auth service, which sends HTTP requests to the backend. It then saves the token to local storage, or shows an error message, depending on the response from the backend.
4
JSON Web Token Tutorial: An Example in Laravel and AngularJS - Image 14
JSON Web Token Tutorial: An Example in Laravel and AngularJS - Image 15

The backend is responsible for serving the restricted data only if the user is authenticated. This means that in order to respond with the restricted data, the request for that data needs to contain a valid JWT inside its Authorization header or query string. If that is not the case, the server will respond with a 401 Unauthorized error status code.

Auth Service

The Auth service is responsible for making the sign in and sign up HTTP requests to the backend. If the request is successful, the response contains the signed token, which is then base64 decoded, and the enclosed token claims information is saved into a tokenClaims variable. This is passed to the controller via thegetTokenClaimsfunction.
3
JSON Web Token Tutorial: An Example in Laravel and AngularJS - Image 16
Data Service
JSON Web Token Tutorial: An Example in Laravel and AngularJS - Image 17
Conclusion

Token-based authentication enables us to construct decoupled systems that are not tied to a particular authentication scheme. The token might be generated anywhere and consumed on any system that uses the same secret key for signing the token. They are mobile ready, and do not require us to use cookies.

JSON Web Tokens work across all popular programming languages and are quickly gaining in popularity. They are backed by companies like Google, Microsoft and Zendesk. Their standard specification by Internet Engineering Task Force (IETF) is still in the draft version and may change slightly in the future.

There is still a lot to cover about JWTs, such with how to handle the security details, and refreshing tokens when they expire, but the examples above should demonstrate the basic usage and, more importantly, advantages of using JSON Web Tokens.
2
BY TINO TKALEC

With the rising popularity of single page applications, mobile applications, and RESTful API services, the way web developers write back-end code has changed significantly. With technologies like AngularJS and BackboneJS, we are no longer spending much time building markup, we are building APIs that our front-end applications consume. Our back-end is more about business logic and data, while presentation logic is moved exclusively to the front-end or mobile applications. These changes have led to new ways of implementing authentication in modern applications.

Authentication is one of the most important parts of any web application. For decades, cookies and server-based authentication were the easiest . However, handling authentication in modern Mobile and Single Page Applications can be tricky, and demand a better approach. The solutions to authentication problems for APIs are the OAuth 2.0 and the JSON Web Token (JWT).

compact structure, JWT is usually used in HTTP Authorization headers or URL query parameters.

tool to prettify the JSON object.)

: The issuer of the token
  • sub: The subject of the token
  • : The audience of the token
  • : Token expiration time defined in Unix time
  • : Not before time that identifies the time before which the JWT must not be accepted for processing
  • : Issued at time, in Unix time, at which the token was issued
  • : JWT ID claim provides a unique identifier for the JWT
  • Public Claims

    Public claims need to have collision-resistant names. By making the name a URI or URN naming collisions are avoided for JWTs where the sender and receiver are not part of a closed network.

    An example of a public claim name could https://www.toptal.com/jwt_claims/is_admin and the best practice is to place a file at that location describing the claim so that it can be dereferenced for documentation.

    Private Claims

    Private claim-names may be used in places where JWTs are only exchanged in a closed environment between known systems, such as inside an enterprise. These are claims that we can define ourselves, like user IDs, user roles, or any other information.

    Using claim-names that might have conflicting semantic meanings outside of a closed or private system are subject to , so use them with caution.

    It is important to note that we want to keep a web token as small as possible, so use only necessary data inside public and private claims.

    Example Payload

    and includes a session ID to identify the user.

    On every subsequent request, the server needs to find that session and deserialize it, because user data is stored on the server.

    lookup to find and deserialize the session on each request. The only thing we have to do is calculate the HMAC SHA-256 to validate the token and parse its content.

    Single Page Application (SPA) example. (You can find the entire demo here, and the source code in this GitHub repository so that you can follow along with the tutorial.)

    This JSON web token example will not use any kind of encryption to ensure the confidentiality of the information transmitted in the claims. In this is often because TLS/SSL encrypts the request. However, if the token is going to contain sensitive information, such as the user’s social security number, it should also be encrypted using JWE.

    Laravel Backend Example

    We will use Laravel to handle user registration, persisting user data to a database and providing some restricted data that needs authentication for the Angular app to consume. We will create an example API subdomain to simulate Cross-origin resource sharing (CORS) as well.

    Installation and Project Bootstrapping

    In order to use Laravel, we have to install the Composer package manager on our machine. When developing in Laravel I recommend using the Laravel Homestead pre-packaged box of Vagrant. It provides us with a complete development environment regardless of our operating system.

    The easiest way to bootstrap our Laravel application is to use a Composer package Laravel Installer.

    vagrant up and logged into it vagrant ssh we navigate to the previously defined project directory. In the example above this would /home/vagrant/coding/jwt We can now php artisan migrate in order to create the necessary user tables in our database.

    Installing Composer Dependencies

    Fortunately, there is a community of developers working on Laravel and maintaining many great packages that we can reuse and extend our application with. In this we will tymon/jwt-auth by Sean Tymon, for handling tokens on the server side, barryvdh/laravel-cors by Barry . Heuvel, for handling CORS.

    -auth

    /signup a username and password, we will try to create a new user and save it to the database. After the user has been created, a JWT is created and returned via JSON response.

    /restricted simulates a resource that needs an authenticated user. In order to do this, the Authorization or query string needs to provide the JWT for the backend to verify.

    jwt-auth, we will handle exceptions manually. When we make a POST request to an API api.jwt.dev/v1/restricted we are making a cross-origin request, and have to enable CORS on the backend. Fortunately, we have already configured CORS in config/cors.php.

    resources/views/spa.blade.php that will bootstrap the Angular application.

    Here is the folder structure of the Angular app:

    ngStorage for AngularJS, to save tokens into the browser’s local storage, so that we can send it on each request via Authorization.

    In the production environment, of course, we would minify and combine all our script files and stylesheets in order to improve performance.

    I’ve created a navigation bar using Bootstrap that will change the visibility of appropriate links, depending on the sign-in status of the user. The sign-in status is determined by the presence of a token variable in the controller’s scope.

    controllers.js, we have defined two controllers for our application: HomeController RestrictedControllerHomeController handles sign-in, sign-up and logout functionality. It passes the username and password data from the sign-in and sign-up forms to Auth, which sends HTTP requests to the backend. It then saves the token to local or shows an error message, depending on the response from the backend.

    Authorization or query string. If that is not the case, the server will respond with a 401 Unauthorized error status code.

    Service

    The Auth service is responsible for making the sign in and sign up HTTP requests to the backend. If the request is successful, the response contains the signed token, which is then base64 decoded, and the enclosed token claims information is saved into a tokenClaims variable. This is passed to the controller via getTokenClaims.

    and do not require us to use cookies.

    JSON Web Tokens work across all popular programming languages and are quickly gaining in popularity. They are backed by companies like Google, and Zendesk. Their standard specification by Internet Engineering Task Force (IETF) is still in the draft version and may change slightly in the future.

    There is still a lot to cover about JWTs, such with how to handle the security details, and refreshing tokens when they expire, but the examples above should demonstrate the basic usage and, more importantly, advantages of using JSON Web Tokens.

    2

    JSON Web Token Tutorial: An Example in Laravel and AngularJS - Image 18

    JSON Web Token Tutorial: Example using AngularJS & Laravel | Toptal

    https://www.toptal.com/web/cookie-free-authentication-with-json-web-tokens-an-example-in-laravel-and-angularjs

    Cookies are stale. These days there are better solutions for user authentication, which solve the headaches cookies cause with today's mobile and single-page applications. Toptal engineer Tino Tkalec delivers this demonstration of a Laravel and Angularjs application making use of one of the best authentication methods available today: the JSON Web ...

    This blog is listed under Open Source and Development & Implementations Community

    Related Posts:
    Post a Comment

    Please notify me the replies via email.

    Important:
    • We hope the conversations that take place on MyTechLogy.com will be constructive and thought-provoking.
    • To ensure the quality of the discussion, our moderators may review/edit the comments for clarity and relevance.
    • Comments that are promotional, mean-spirited, or off-topic may be deleted per the moderators' judgment.
    You may also be interested in
    Awards & Accolades for MyTechLogy
    Winner of
    REDHERRING
    Top 100 Asia
    Finalist at SiTF Awards 2014 under the category Best Social & Community Product
    Finalist at HR Vendor of the Year 2015 Awards under the category Best Learning Management System
    Finalist at HR Vendor of the Year 2015 Awards under the category Best Talent Management Software
    Hidden Image Url

    Back to Top