Single Sign On (SSO)

This endpoint is used to authenticate the user using your own existing authentication system.

HTTP Request

GET /sso_login/?sig=<hmac-signature>&sso=<payload>

To generate SSO URL, you need to generate

  1. Payload

  2. HMAC signature.

Payload

The payload is a special string which is generated as follows

  • Concatenate the parameters in the following table with &

  • Encode the concatenated string with base64 encoding.

Parameter

Type

Description

email/username

string

Email Address or username of the user respectively

time

string

Time since epoch

Example with email

[email protected]&time=1554879681

Example with username

[email protected]&time=1554879681

Python
NodeJS
Python
import base64, time
epoch_time = int(time.time())
query_string = "[email protected]&time={}".format(epoch_time)
payload = base64.b64encode(query_string)
print(payload)

The above snippet returns payload as shown below

ZW1haWw9ZGVtb0B0ZXN0cHJlc3MuaW4mdGltZT0xNTU0ODc5Njgx
NodeJS
let epochTime = Math.floor((new Date).getTime()/1000);
queryString = "[email protected]&time=" + epochTime
payload = btoa(queryString)
console.log(payload)

The above snippet returns payload as shown below

ZW1haWw9ZGVtb0B0ZXN0cHJlc3MuaW4mdGltZT0xNTU0ODc5Njgx

HMAC Signature

HMAC (Hash-based message authentication code) is used to avoid tampering during the request flow. We use a time-based HMAC algorithm to limit the lifetime of the HMAC.

To generate the HMAC signature, the following are need

  • payload - Generate from the above step

  • secret_key - Obtained from Testpress Team

The final step is to encrypt the payload using the HMAC-SHA256 algorithm with the secret key.

Python
NodeJS
Python
import hashlib, hmac, time
epoch_time = int(time.time())
query_string = "[email protected]&time={}".format(epoch_time)
payload = base64..b64encode(query_string)
secret_key = "abcxyzqwerty"
hmac_signature = hmac.new(secret_key, payload, hashlib.sha256).hexdigest()
print(hmac_signature)

The above snippet returns HMAC signature as shown below

aa747c502a898200f9e4fa21bac68136f886a0e27aec70ba06daf2e2a5cb5597
NodeJS
var CryptoJS = require("crypto-js")
let epochTime = Math.floor((new Date).getTime()/1000);
queryString = "[email protected]&time=" + epochTime
payload = btoa(queryString)
let secreteKey = "abcxyzqwerty"
let hmacSignature = CryptoJS.HmacSHA256(payload, secreteKey).toString(CryptoJS.enc.Hex);
console.log(hmacSignature)

The above snippet returns payload as shown below

aa747c502a898200f9e4fa21bac68136f886a0e27aec70ba06daf2e2a5cb5597

SSO URL

The SSO URL format is as shown below

https://demo.testpress.in/sso_login/?sig=<hmac-signature>&sso=<payload>

In the above URL replace the <hmac-signature> and <payload> with your hmac signature and payload values generated using the above steps.

E.g. https://demo.testpress.in/sso_login/?sig=aa747c502a898200f9e4fa21bac68136f886a0e27aec70ba06daf2e2a5cb5597&sso=ZW1haWw9ZGVtb0B0ZXN0cHJlc3MuaW4mdGltZT0xNTU0ODc5Njgx

The epoch time limits the validity of the HMAC. We have a *30 minute* delta to ensure the validity of the HMAC. For e.g. if the HMAC was generated at 10.30 AM, it will be valid only for the next 30 minutes and expires after 11.00 AM.