Menu

Expand
Rate this page:

Protect your Function with JSON Web Token

When protecting your public Functions and any sensitive data that they can expose, from unwanted requests and bad actors, it is important to consider some form of authentication to validate that only intended users are making requests. In this example, we'll be covering one of the most common forms of authentication: Bearer Authentication using JSON Web Token (JWT).

If you want to learn an alternative approach, you can also see this example of using Basic Auth.

Let's create a Function that will only accept requests with valid JWTs, and reject all other traffic.

Create and host a Function

In order to run any of the following examples, you will first need to create a Function into which you can paste the example code. You can create a Function using the Twilio Console or the Serverless Toolkit as explained below:

If you prefer a UI-driven approach, creating and deploying a Function can be done entirely using the Twilio Console and the following steps:

  1. Log in to the Twilio Console and navigate to the Functions tab. If you need an account, you can sign up for a free Twilio account here!
  2. Functions are contained within Services. Create a Service by clicking the Create Service button and providing a name such as test-function.
  3. Once you've been redirected to the new Service, click the Add + button and select Add Function from the dropdown.
  4. This will create a new Protected Function for you with the option to rename it. The name of the file will be path it is accessed from.
  5. Copy any one of the example code snippets from this page that you want to experiment with, and paste the code into your newly created Function. You can quickly switch examples by using the dropdown menu of the code rail.
  6. Click Save to save your Function's contents.
  7. Click Deploy All to build and deploy the Function. After a short delay, your Function will be accesible from:
    https://<service-name>-<random-characters>-<optional-domain-suffix>.twil.io/<function-path>​
    For example: test-function-3548.twil.io/hello-world.

The Serverless Toolkit enables you with local development, project deployment, and other functionality via the Twilio CLI. To get up and running with these examples using Serverless Toolkit, follow this process:

  1. From the CLI, run twilio serverless:init <your-service-name> --empty to bootstrap your local environment.
  2. Navigate into your new project directory using cd <your-service-name>
  3. In the /functions directory, create a new JavaScript file that is named respective to the purpose of the Function. For example, sms-reply.protected.js for a Protected Function intended to handle incoming SMS.
  4. Populate the file using the code example of your choice and save.
    Note A Function can only export a single handler. You will want to create separate files if you want to run and/or deploy multiple examples at once.

Once your Function(s) code is written and saved, you can test it either by running it locally (and optionally tunneling requests to it via a tool like ngrok), or by deploying the Function and executing against the deployed url(s).

Run your Function in local development

Run twilio serverless:start from your CLI to start the project locally. The Function(s) in your project will be accesible from http://localhost:3000/sms-reply

  • If you want to test a Function as a Twilio webhook, run:
    twilio phone-numbers:update <your Twilio phone number> --sms-url "http://localhost:3000/sms-reply"​
    This will automatically generate an ngrok tunnel from Twilio to your locally running Function, so you can start sending texts to it. You can apply the same process but with the voice-url flag instead if you want to test with Twilio Voice.
  • If your code does not connect to Twilio Voice/Messages as a webhook, you can start your dev server and start an ngrok tunnel in the same command with the ngrok flag. For example: twilio serverless:start --ngrok=""

Deploy your Function

To deploy your Function and have access to live url(s), run twilio serverless:deploy from your CLI. This will deploy your Function(s) to Twilio under a development environment by default, where they can be accessed from:

https://<service-name>-<random-characters>-dev.twil.io/<function-path>

For example: https://incoming-sms-examples-3421-dev.twil.io/sms-reply

Your Function is now ready to be invoked by HTTP requests, set as the webhook of a Twilio phone number, invoked by a Twilio Studio Run Function Widget, and more!

        
        
        
              
              
              

              Configure your Function to require Bearer Authentication

              First, create a new auth Service and add two Public Functions using the directions above. These will be named:

              • /jwt
              • /bearer

              Delete the default contents of the Functions. Place the JWT generation code into /jwt, and the JWT validation snippet into /bearer. Save both Functions once they contain the new code.

              Remember to change the visibility of your new Function to be Public. By default, the Console UI will create new Functions as Protected, which will prevent access to your Function except by Twilio requests.

              Next, notice that the code snippets require the jsonwebtoken dependency. Be sure to add this as a Dependency to your Service.

              Once all Functions have been saved and your Dependencies have been set, deploy the Function by clicking on Deploy All in the Console UI.

              Verify that Bearer Authentication is working

              We can check that authentication is working first by sending an unauthenticated request to our deployed Function. You can get the URL of your Function by clicking the Copy URL button next to the Function.

              Then, using your client of choice, make a GET or POST request to your Function. It should return a 401 Unauthorized since the request contains no valid Authorization header.

              curl -i -L -X POST 'https://auth-4173-dev.twil.io/bearer'

              Result:

              $ curl -i -L -X POST 'https://auth-4173-dev.twil.io/bearer' -i
              
              HTTP/2 401
              date: Tue, 03 Aug 2021 23:01:55 GMT
              content-type: application/octet-stream
              content-length: 12
              www-authenticate: Bearer realm="Access to read salaries"
              x-shenanigans: none
              
              Unauthorized

              Great! Requests are successfully being blocked from non-authenticated requests.

              To make an authenticated request and get back a 200 OK, we'll need to first generate a valid JWT by calling /jwt. We can then include that token in the Authorization header of our request to /bearer.

              To get a valid JWT, we'll need to submit a valid username and password to the /jwt Function. Right now, these are hardcoded in the Function as twilio and ahoy respectively. The JWT generator Function is expecting the username and password to be passed in the body of the request, so you'll need to create a POST request with a JSON body composed of those values. Using cURL, that would look like this:

              curl -i -L -X POST 'https://auth-4173-dev.twil.io/jwt' \
              -H 'Content-Type: application/json' \
              --data-raw '{
                  "username": "twilio",
                  "password": "ahoy"
              }'

              and the response would be:

              $ curl -i -L -X POST 'https://auth-4173-dev.twil.io/jwt' \
              -H 'Content-Type: application/json' \
              --data-raw '{
                  "username": "twilio",
                  "password": "ahoy"
              }'
              
              HTTP/2 200
              date: Tue, 03 Aug 2021 23:16:35 GMT
              content-type: application/octet-stream
              content-length: 2
              access_token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ0d2lsaW8iLCJpc3MiOiJ0d2lsLmlvIiwib3JnIjoidHdpbGlvIiwicGVybXMiOlsicmVhZCJdLCJpYXQiOjE2MjgwMzI1OTUsImV4cCI6MTYyODExODk5NX0.uZzHuN5PpK6qM5wCu01_S8lkFPDpIcxQJq6A7sDr6gc
              x-shenanigans: none
              x-content-type-options: nosniff
              x-xss-protection: 1; mode=block
              
              OK

              The header access_token contains the valid JWT that was just generated for us. Go ahead and try your request to /bearer again, but this time including the Authorization header including this JWT:

              curl -i -L -X POST 'https://auth-4173-dev.twil.io/bearer' \
              -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ0d2lsaW8iLCJpc3MiOiJ0d2lsLmlvIiwib3JnIjoidHdpbGlvIiwicGVybXMiOlsicmVhZCJdLCJpYXQiOjE2MjgwMzA3ODIsImV4cCI6MTYyODExNzE4Mn0.gBusSFmlRt_o3H3E2UB4GGxjbZJLOOS0bKFXTxAgnlw'

              the response should be:

              $ curl -i -L -X POST 'https://auth-4173-dev.twil.io/bearer' \
              -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ0d2lsaW8iLCJpc3MiOiJ0d2lsLmlvIiwib3JnIjoidHdpbGlvIiwicGVybXMiOlsicmVhZCJdLCJpYXQiOjE2MjgwMzA3ODIsImV4cCI6MTYyODExNzE4Mn0.gBusSFmlRt_o3H3E2UB4GGxjbZJLOOS0bKFXTxAgnlw'
              
              HTTP/2 200
              date: Tue, 03 Aug 2021 23:20:10 GMT
              content-type: application/json
              content-length: 84
              x-shenanigans: none
              x-content-type-options: nosniff
              x-xss-protection: 1; mode=block
              
              [{"username":"jdoe","salary":"$2000.00"},{"username":"mturner","salary":"$2500.00"}]

              At this point, Bearer Authentication is working for your Function!

              To make this example your own, you could experiment with the following:

              • Refactor the common 'secret_key' into an Environment Variable so that it is stored securely and only needs to be changed in one place.
              • Use Environment Variables to store the approved credentials, or even create a database of approved usernames and passwords to support multiple users.
              • Instead of using a hardcoded array of data, retrieve values from a database.
              Rate this page:

              Need some help?

              We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Community Forums or browsing the Twilio tag on Stack Overflow.

                    
                    
                    

                    Thank you for your feedback!

                    We are always striving to improve our documentation quality, and your feedback is valuable to us. Please select the reason(s) for your feedback or provide additional information about how we can improve:

                    Sending your feedback...
                    🎉 Thank you for your feedback!
                    Something went wrong. Please try again.

                    Thanks for your feedback!

                    Refer us and get $10 in 3 simple steps!

                    Step 1

                    Get link

                    Get a free personal referral link here

                    Step 2

                    Give $10

                    Your user signs up and upgrade using link

                    Step 3

                    Get $10

                    1,250 free SMSes
                    OR 1,000 free voice mins
                    OR 12,000 chats
                    OR more