Using Mutual TLS on the Client Side with Axios (JS)

How to use TLS, client authentication, and CA certificates in Axios (JS)

Create a private key and request a certificate for your Axios (JS) client

Before you can teach your client to speak TLS, you will need a certificate issued by a trusted certificate authority (CA). If your organization already runs its own CA and you have a private key and certificate for your Axios (JS) client, along with your CA's root certificate, you can skip to the next step.

If your organization does not yet run its own internal CA, you can read more about creating and running a CA using the open source smallstep software here.

To get up and running quickly, we recommend creating a free hosted smallstep Certificate Manager authority.

To request a certificate from your CA using the step CLI, bootstrap your CA with step ca bootstrap and run the following command (sub the client name for the actual name / DNS name of your Axios (JS) client).

$ step ca certificate "myuser" client.crt client.key

Your certificate and private key will be saved in client.crt and client.key respectively.

Request a copy of your CA root certificate, which will be used to make sure each application can trust certificates presented by other applications.

$ step ca root ca.crt

Your certificate will be saved in ca.crt.

Make a request from Axios (JS) using mutual TLS

Now, we need only to configure our Axios (JS) client to make authenticated requests using our certificate and private key. The CA root certificate will be used to verify that the client can trust the certificate presented by the server.

Create a custom https agent configured with your certificate, private key, and root CA certificate. Pass this agent to axios when you call axios.get() (or its respective request method) to authenticate your request over TLS.

const fs = require('fs');
const https = require('https');
const axios = require('axios');

// ...
const httpsAgent = new https.Agent({
  cert: fs.readFileSync('client.crt'),
  key: fs.readFileSync('client.key'),
  ca: fs.readFileSync('ca.crt'),
});

const result = await axios.get('https://myserver.internal.net:443', { httpsAgent });
// do something with the result

// ...

Improve this content

Automate certificate renewal

By default, step-ca issues certificates with a 24 hour expiration. Short-lived certificates have many benefits but also require that you renew your certificates each day before they expire. How you renew certificates is often dependent on how you deploy your application. See the step-ca certificate lifecycle management docs for more information.

All documentation content from the Hello mTLS project is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).