Skip to content

Latest commit

 

History

History
86 lines (56 loc) · 3.37 KB

README.md

File metadata and controls

86 lines (56 loc) · 3.37 KB

Private Key JWT OAuth Flow (Go)

This repo aims to simplify the process of creating a public/private key pair, using the public key to create an application at the identity provider and using the private key to sign JWTs to obtain access tokens from said IdP. At time of writing, this is written for integrating with Okta but I would like to add more IdPs over time.

Dependencies:

Setup

  1. Clone the repo, open terminal and cd into the project root.
  2. In the root folder, create a new .env file and paste the following values into it:
PRIVATE_KEY=
PUBLIC_KEY=
MODULUS=
CLIENT_ID=
OKTA_URL=
API_KEY=
SCOPES=

Scripts will generate values for the first 4 vars. You will need to fill out the other values. Note: the API key is needed for creating the OAuth client in Okta, so make sure the token you use has permissions to create applications.

  • OKTA_URL=https://{your_okta_domain}
  • API_KEY={okta_api_key}
  • SCOPES='okta.users.read okta.users.manage'

The SCOPES var is an string of scopes (seperated by spaces) granted to your eventual access token that you will be using for management tasks. I put in a couple common ones as a placeholder. In your Okta application, it would look like this:

SCOPES_1

Running the Scripts

To run these scripts, make sure you are still in the root folder of the cloned repository. Run the command go run . This will give you a menu of the three tasks to setup and run this flow:

Which task would you like to run?
 
[1] Generate Keys 
[2] Create Okta Service App 
[3] Create PKJ and get Access Token

[1] Generate Keys

In the Private Key JWT flow, the first step you need to take is generating a public/private keypair. The public key is shared with the identity provider to verify the JWT signed with your private key. To generate the keys, type the following command into the terminal:

If you input 1, you should see confirmation printed to the terminal:

///////////////// Keys generated and added to .env file.

Sure enough, you can pop over to the .env file to see the values populated there.

[2] Create Okta Service App

Now that you have the keypair, you can create the OAuth app in Okta with the public key. The scopes you defined above will also be granted in the application. If you input 2, you will get confirmation in the terminal of the created app, that the client ID of the app was updated in your .env file, as well as scopes granted.

///////////////// Okta Service app created: 

{application object}

///////////////// Scope granted: 

{scope(s) granted to the application}

If you navigate to your applications in Okta, you will see this newly created app under the name Private Key JWT Service App (Go). In your .env file you will see this new app's client Id populated in the CLIENT_ID var.

[3] Create PKJ and get Access Token

The above two tasks should only need to be ran once for setup. From hereon out, you can run the third task to get an access token from Okta:

Input 3 and you should see the access token printed to terminal:

///////////////// Access Token:

{access_token}

You can now use this token to perform management tasks on your Okta org based on your defined scopes by passing it in the Authorization header as Bearer {access_token}.