JWT

Dev Phase

How to test

Prerequisites

• Install Postman for testing purposes
• Install Postgres

  • Start postgres service

    • Using brew - "brew services start postgres@version"
    • In Linux - docker run --name jwt-postgres -e POSTGRES_PASSWORD=dbpass -d -p 5432:5432 postgres
      • The PostGres client can be installed with sudo apt-get install -y postgresql-client (on ubuntu)

  • Run the following SQL Commands (You can use any sql client or run "psql postgre" command)

    CREATE ROLE goalert WITH LOGIN PASSWORD 'root';
    
    # if a DB does not already exist then ...
    CREATE DATABASE goalert;
    
    GRANT ALL PRIVILEGES ON DATABASE goalert TO goalert;
    
    # If a DB already exists then you can grant access with...
    ALTER ROLE goalert CREATEDB;
    
    # For postgres 15+, you will also need to grant access to the public schema on the affected database
    \connect goalert                        # may be needed if you are connected to a different database
    GRANT ALL ON SCHEMA PUBLIC TO goalert;
    

  • Login as goalert (via sql client or using the command "psql -U goalert" command)

  • Run the following commands:

    CREATE TABLE goa_api_key ( api_key VARCHAR PRIMARY KEY, api_user VARCHAR(100) NOT NULL, status VARCHAR(10) NOT NULL, created_time timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP );
    

1. Go to the project directory and run the following command:

   go run *.go
   

2. Open postman and import the .json file from the project directory (jwt -> postman)
   • After importing the .json file, postman will load requests
     • The "jwt" request will be be used to request new token
     • The "hello" will be used for testing the new token
     • The "new/apikey" will be used for adding new api keys
     • THe "apikeys" will be used for retrieving existing api keys
3. Open the "new/apikey" request. From the url, make sure to add "?api_key=&api_user=
4. Click the "Send" button and you'll see a response "The new API Key has been added." if it's succefull. Note remember your api_key and api_user as these information will be used for getting tokens.
5. Open the "jwt" request. From the Headers tab, you'll see the "Access" and the "Token-No-Expiry" headers.
   • "Access" header is used for validating that the user is listed in the "goa_api_key" table as a valid user.
     • Default Value: the api_key you entered when requesting a new api key
   • "Token-No-Expiry" header is used as flag to tell the JWT request to be a non expirty token. Note that this is an optional header. If this header is not set, the Token is set to expired after 24hrs
     • Default Value: empty
6. Add your api_user to the URL: ?api_user=
7. Click the "Send" button and you'll see a response "token" values or a "Not Authorized" value if user is not authorized/valid.
8. Now, open the "hello" request. From the Header tab, you'll see the "Token" header. This header will be used for sending the token value from the "jwt" request.
9. Click the "Send" button and you should be able to see a response "Hello World" value or "Not Authorized" if token is invalid.