#main: comments updated

Author: Coder-Kuldeep-Singh

helper.go

@@ -98,13 +98,10 @@ func GenerateBaseString(httpMethod string, apiURL string, appId string, params P
 	return baseString
 }
 
-/**
- * Get Private Key
- *
- * This methods will decrypt P12 Certificate and retrieve the Private key with the passphrase
-
- * Returns private key from p12
- */
+/*
+This methods will decrypt P12 Certificate and retrieve the Private key with the passphrase.
+Returns private key from p12.
+*/
 func DecryptPrivateKey(secureCertLocation string, passphrase string) (*rsa.PrivateKey, error) {
 	fileData, err := ioutil.ReadFile(secureCertLocation)
 	if err != nil {
@@ -123,13 +120,10 @@ func DecryptPrivateKey(secureCertLocation string, passphrase string) (*rsa.Priva
 	return privateKey, nil
 }
 
-/**
- * Generate Random Hex
- *
- * This method helps to generate unique Transaction ID(txnNo)
- *
- * Returns random hex(txnNo)
- */
+/*
+This method helps to generate unique Transaction ID(txnNo).
+Returns random hex(txnNo).
+*/
 func GenerateRandomHex(count int) (string, error) {
 	bytes := make([]byte, count)
 	_, err := rand.Read(bytes)
@@ -140,14 +134,11 @@ func GenerateRandomHex(count int) (string, error) {
 	return randomHex, nil
 }
 
-/**
- * Generate Authorization Header
- *
- * This method helps to generate the authorization header and sign it
- * using the private key. This is required to be used for both Token and Person API
- *
- * Returns Signed Header
- */
+/*
+This method helps to generate the authorization header and sign it using the private key.
+This is required to be used for both Token and Person API.
+Returns Signed Header
+*/
 func GenerateAuthorizationHeader(apiURL string, params ParamsSort, httpMethod string, contentType string, environment string, appId string, privateKey *rsa.PrivateKey, clientSecret string) (string, error) {
 	nonceValue, err := GenerateRandomHex(20)
 	if err != nil {
@@ -176,13 +167,10 @@ func GenerateAuthorizationHeader(apiURL string, params ParamsSort, httpMethod st
 	}
 }
 
-/**
- * Decode
- *
- * This method helps to decode the payload data into normal form.
- *
- * Returns normalized(decoded) []byte.
- */
+/*
+This method helps to decode the payload data into normal form.
+Returns normalized(decoded) []byte.
+*/
 func Decode(payload string) ([]byte, error) {
 	s := strings.Split(payload, ".")
 	if len(s) < 2 {
@@ -196,16 +184,13 @@ func Decode(payload string) ([]byte, error) {
 	return decodedData, err
 }
 
-/**
- * Verify JWS
- *
- * This method takes in a JSON Web Signature and will check against
- * the public key for its validity and to retrieve the decoded data.
- * This verification is required for the decoding of the access token and
- * response from Person API
- *
- * Returns decoded data
- */
+/*
+This method takes in a JSON Web Signature and will check against
+the public key for its validity and to retrieve the decoded data.
+This verification is required for the decoding of the access token and
+response from Person API.
+Returns decoded data.
+*/
 func VerifyJWS(publicCert string, accessToken string) ([]byte, error) {
 	keyData, err := ioutil.ReadFile(publicCert)
 	if err != nil {
@@ -234,14 +219,11 @@ func VerifyJWS(publicCert string, accessToken string) ([]byte, error) {
 	return claimSet, nil
 }
 
-/**
- * Decypt JWE
- *
- * This method takes in a JSON Web Encrypted string and will decrypt it using the
- * private key. This is required to decrypt the data from Person API
- *
- * Returns decrypted data
- */
+/*
+This method takes in a JSON Web Encrypted string and will decrypt it using the private key.
+This is required to decrypt the data from Person API.
+Returns decrypted data.
+*/
 func DecryptJWE(pemPrivaKey *rsa.PrivateKey, compactJWE string) (string, error) {
 	payload, err := jose.ParseEncrypted(compactJWE)
 	if err != nil {
@@ -263,13 +245,10 @@ func Unmarshal(data []byte, v interface{}) error {
 	return nil
 }
 
-/**
- * AuthHeader
- *
- * This method removes the duplication use of environment based condition for generating auth header.
- *
- * Returns fully generated auth Header as string.
- */
+/*
+This method removes the duplication use of environment based condition for generating auth header.
+Returns fully generated auth Header as string.
+*/
 func AuthHeader(apiURL string, params ParamsSort, httpMethod string, contentType string, environment string, appId string, privateKey *rsa.PrivateKey, clientSecret string) (string, error) {
 	var authHeader string
 	var err error

person.go

@@ -8,16 +8,12 @@ import (
 	"net/http"
 )
 
-/**
- * Get Person Data from MyInfo Person API
- *
- * This method calls the Person API and returns a JSON response with the
- * personal data that was requested. Your application needs to provide a
- * valid "access token" in exchange for the JSON data. Once your application
- * receives this JSON data, you can use this data.
- *
- * Returns the Person Data (Payload decrypted + Signature validated)
- */
+/*
+This method calls the Person API and returns a JSON response with the personal data that was requested.
+Your application needs to provide a valid "access token" in exchange for the JSON data.
+Once your application receives this JSON data, you can use this data.
+Returns the Person Data (Payload decrypted + Signature validated).
+*/
 
 func (appConfig AppConfig) GetPersonData(accessToken, txnNo string) ([]byte, error) {
 	if !isInitialized {
@@ -38,15 +34,12 @@ func (appConfig AppConfig) GetPersonData(accessToken, txnNo string) ([]byte, err
 
 }
 
-/**
- * Get Person Data With Key
- *
- * This method will take in the accessToken from Token API and decode it
- * to get the sub(eg either uinfin or uuid). It will call the Person API using the token and sub.
- * It will verify the Person API data's signature and decrypt the result.
- *
- * Returns decrypted result from calling Person API
- */
+/*
+This method will take in the accessToken from Token API and decode it to get the sub(eg either uinfin or uuid).
+It will call the Person API using the token and sub.
+It will verify the Person API data's signature and decrypt the result.
+Returns decrypted result from calling Person API.
+*/
 func (appConfig AppConfig) GetPersonDataWithKey(accessToken, txnNo string, privateKey *rsa.PrivateKey) ([]byte, error) {
 	if !isInitialized {
 		return nil, errors.New(ERROR_UNKNOWN_NOT_INIT)
@@ -93,14 +86,10 @@ func (appConfig AppConfig) GetPersonDataWithKey(accessToken, txnNo string, priva
 
 }
 
-/**
- * Call Person API
- *
- * This method will generate the Authorization Header and
- * and call the Person API to get the encrypted Person Data
- *
- * Returns result from calling Person API
- */
+/*
+This method will generate the Authorization Header and call the Person API to get the encrypted Person Data.
+Returns result from calling Person API.
+*/
 func (appConfig AppConfig) CallPersonAPI(sub, accessToken, txnNo string, privateKey *rsa.PrivateKey) ([]byte, error) {
 	if !isInitialized {
 		return nil, errors.New(ERROR_UNKNOWN_NOT_INIT)

request.go

@@ -8,13 +8,10 @@ import (
 	"net/http"
 )
 
-/**
- * Send Request
- *
- * This function is a wrapper to make https call
- *
- * Returns the response of the hit api
- */
+/*
+This function is a wrapper to make https call.
+Returns the response of the hit api.
+*/
 func SendRequest(request *http.Request) ([]byte, error) {
 	client := &http.Client{
 		Transport: &http.Transport{

singpass.go

@@ -83,16 +83,13 @@ func (appConfig AppConfig) CheckConfig() error {
 	return nil
 }
 
-/**
-* Get MyInfo Person Data (MyInfo Token + Person API)
-*
-* This method takes in all the required variables, invoke the following APIs.
-* - Get Access Token (Token API) - to get Access Token by using the Auth Code and State
-* - Get Person Data (Person API) - to get Person Data by using the Access Token
-*
-* Returns the Person Data as []byte (Payload decrypted + Signature validated)
-*
- */
+/*
+Get MyInfo Person Data (MyInfo Token + Person API).
+This method takes in all the required variables, invoke the following APIs.
+Get Access Token (Token API) - to get Access Token by using the Auth Code and State.
+Get Person Data (Person API) - to get Person Data by using the Access Token.
+Returns the Person Data as []byte (Payload decrypted + Signature validated).
+*/
 func (appConfig AppConfig) GetMyInfoPersonData(authCode, state string) ([]byte, error) {
 	if !isInitialized {
 		return nil, errors.New(ERROR_UNKNOWN_NOT_INIT)

token.go

@@ -8,16 +8,13 @@ import (
 	"strings"
 )
 
-/**
- * Get Access Token from MyInfo Token API
- *
- * This method calls the Token API and obtain an "access token" from response,
- * which can be used to call the Person API for the actual data.
- * Your application needs to provide a valid "authorisation code"
- * from the authorise API(callback) in exchange for the valid "access token".
- *
- * Returns the Access Token API response as []byte which includes all data sent by Access Token API
- */
+/*
+This method calls the Token API and obtain an "access token" from response,
+which can be used to call the Person API for the actual data.
+Your application needs to provide a valid "authorisation code"
+from the authorise API(callback) in exchange for the valid "access token".
+Returns the Access Token API response as []byte which includes all data sent by Access Token API.
+*/
 
 func (appConfig AppConfig) GetAccessToken(authCode string, state string) ([]byte, error) {
 	if !isInitialized {
@@ -38,14 +35,10 @@ func (appConfig AppConfig) GetAccessToken(authCode string, state string) ([]byte
 	return tokenData, nil
 }
 
-/**
- * Call (Access) Token API
- *
- * This method will generate the Authorization Header
- * and call the Token API to retrieve access token.
- *
- * Returns the full json response as []byte.
- */
+/*
+This method will generate the Authorization Header and call the Token API to retrieve access token.
+Returns the full json response as []byte.
+*/
 func (appConfig AppConfig) CallTokenAPI(authCode string, privateKey *rsa.PrivateKey, state string) ([]byte, error) {
 	if !isInitialized {
 		return nil, errors.New(ERROR_UNKNOWN_NOT_INIT)