Adding client

Author: glondhe

AuthenticationSDK/authentication/http/GetSignatureParameter.rb

@@ -0,0 +1,62 @@
+require_relative '../../util/Constants.rb'
+require_relative '.././payloadDigest/digest.rb'
+require 'openssl'
+# This function returns value for paramter Signature which is then passed to Signature header
+# paramter 'Signature' is calucated based on below key values and then signed with SECRET KEY -
+# host: Sandbox (apitest.cybersource.com) or Production (api.cybersource.com) hostname
+# date: "HTTP-date" format as defined by RFC7231.
+# (request-target): Should be in format of httpMethod: path
+# Example: "post /pts/v2/payments"
+# Digest: Only needed for POST calls.
+# digestString = BASE64( HMAC-SHA256 ( Payload ));
+# Digest: “SHA-256=“ + digestString;
+# v-c-merchant-id: set value to Cybersource Merchant ID
+# This ID can be found on EBC portal*/
+class SignatureParameter
+  def generateSignatureParameter(merchantconfig_obj, gmtdatetime, log_obj)
+    request_type = merchantconfig_obj.requestType.upcase
+    merchantSecretKey = merchantconfig_obj.merchantSecretKey
+    signatureString = Constants::HOST + ': ' + merchantconfig_obj.requestHost
+    signatureString << "\n"+ Constants::DATE + ': ' + gmtdatetime
+    signatureString << "\n(request-target): "
+    if request_type == Constants::GET_REQUEST_TYPE || request_type == Constants::DELETE_REQUEST_TYPE
+      targetUrl=gettargetUrlForGetDelete(request_type,merchantconfig_obj)
+      signatureString << targetUrl + "\n"
+    elsif request_type == Constants::POST_REQUEST_TYPE || request_type == Constants::PUT_REQUEST_TYPE
+      targetUrl=gettargetUrlForPutPost(request_type,merchantconfig_obj)
+      signatureString << targetUrl + "\n"
+      payload = merchantconfig_obj.requestJsonData
+      digest = DigestGeneration.new.generateDigest(payload, log_obj)
+      digest_payload = Constants::SHA256 + digest
+      signatureString << Constants::DIGEST + ': ' + digest_payload + "\n"
+    end
+    signatureString << Constants::V_C_MERCHANT_ID + ': ' + merchantconfig_obj.merchantId
+    encodedSignatureString = signatureString.force_encoding(Encoding::UTF_8)
+    decodedKey = Base64.decode64(merchantSecretKey)
+    base64EncodedSignature = Base64.strict_encode64(OpenSSL::HMAC.digest('sha256', decodedKey, encodedSignatureString))
+    return base64EncodedSignature
+  rescue StandardError => err
+    log_obj.logger.error(err.message)
+    log_obj.logger.error(err.backtrace)
+    puts 'Check log for more details.'
+    exit!
+  end
+  def gettargetUrlForGetDelete(request_type, merchantconfig_obj)
+    targetUrlForGetDelete = ''
+    if request_type == Constants::DELETE_REQUEST_TYPE
+      targetUrlForGetDelete = Constants::DELETE_REQUEST_TYPE_LOWER + ' ' + merchantconfig_obj.requestTarget
+    elsif request_type == Constants::GET_REQUEST_TYPE
+      targetUrlForGetDelete = Constants::GET_REQUEST_TYPE_LOWER + ' ' + merchantconfig_obj.requestTarget
+    end
+    return targetUrlForGetDelete
+  end
+  def gettargetUrlForPutPost(request_type, merchantconfig_obj)
+    targetUrlForPutPost = ''
+    if request_type == Constants::POST_REQUEST_TYPE
+      targetUrlForPutPost = Constants::POST_REQUEST_TYPE_LOWER + ' ' + merchantconfig_obj.requestTarget
+    elsif request_type == Constants::PUT_REQUEST_TYPE
+      targetUrlForPutPost = Constants::PUT_REQUEST_TYPE_LOWER + ' ' + merchantconfig_obj.requestTarget
+    end
+    return targetUrlForPutPost
+  end
+end

AuthenticationSDK/authentication/http/HttpSignatureHeader.rb

@@ -0,0 +1,50 @@
+require 'base64'
+require_relative '../../core/ITokenGeneration.rb'
+require_relative '../../util/Constants.rb'
+require_relative '../../util/ApiException.rb'
+require_relative '.././payloadDigest/digest.rb'
+require_relative '.././http/GetSignatureParameter.rb'
+public
+#  SignatureHeader return SignatureHeader Value that contains following paramters
+#  * keyid     -- Merchant ID obtained from EBC portal
+#  * algorithm -- Should have value as "HmacSHA256"
+#  * headers   -- List of all header name passed in the Signature paramter below
+#                 String getHeaders = "host date (request-target)" + " " + "v-c-merchant-id";
+#                 String postHeaders = "host date (request-target) digest v-c-merchant-id";
+#                 Note: Digest is not passed for GET calls
+#  * signature -- Signature header has paramter called signature
+#                 Paramter 'Signature' must contain all the paramters mentioned in header above in given order
+class GenerateHttpSignature
+  # Generates Signature based on the requestType
+  def getToken(merchantconfig_obj, gmtdatetime, log_obj)
+    request_type = merchantconfig_obj.requestType.upcase
+    signatureHeaderValue =''
+    signatureHeaderValue << Constants::KEY_ID + merchantconfig_obj.merchantKeyId + "\""
+    # Algorithm should be always HmacSHA256 for http signature
+    signatureHeaderValue << ', ' + Constants::ALGORITHM + Constants::SIGNATURE_ALGORITHM + "\""
+    # Headers - list is choosen based on HTTP method
+    signatureheader=getsignatureHeader(request_type)
+    signatureHeaderValue << ', ' + Constants::HEADERS_PARAM + signatureheader + "\""
+    # Get Value for parameter 'Signature' to be passed to Signature Header
+    signature_value = SignatureParameter.new.generateSignatureParameter(merchantconfig_obj, gmtdatetime, log_obj)
+    signatureHeaderValue << ', ' + Constants::SIGNATURE_PARAM + signature_value + "\""
+    return signatureHeaderValue
+  rescue StandardError => err
+    ApiException.new.apiexception(err,log_obj)
+    exit!
+  end
+  def getsignatureHeader(request_type)
+    headers = ''
+    if request_type == Constants::POST_REQUEST_TYPE
+      headers = 'host date (request-target) digest ' + Constants::V_C_MERCHANT_ID
+    elsif request_type == Constants::GET_REQUEST_TYPE || request_type == Constants::DELETE_REQUEST_TYPE
+      headers = 'host date (request-target)' + ' ' + Constants::V_C_MERCHANT_ID
+    elsif request_type == Constants::PUT_REQUEST_TYPE
+      headers = 'host date (request-target) digest ' + Constants::V_C_MERCHANT_ID
+     else
+      raise StandardError.new(Constants::ERROR_PREFIX + Constants::INVALID_REQUEST_TYPE_METHOD)
+    end
+    return headers
+  end
+  implements TokenInterface
+end

AuthenticationSDK/authentication/jwt/JwtToken.rb

@@ -0,0 +1,62 @@
+require 'base64'
+require 'openssl'
+require 'jwt'
+require 'json'
+require 'active_support'
+require_relative '../../core/ITokenGeneration.rb'
+require_relative '../../util/Constants.rb'
+require_relative '../../util/ApiException.rb'
+require_relative '../../util/Cache.rb'
+require_relative '../../authentication/payloadDigest/digest.rb'
+public
+#JWT Token-generated based  on the Request type
+class GenerateJwtToken
+  def getToken(merchantconfig_obj,gmtDatetime,log_obj)
+    jwtBody = ''
+    request_type = merchantconfig_obj.requestType.upcase
+    filePath = merchantconfig_obj.keysDirectory + '/' + merchantconfig_obj.keyFilename + '.p12'
+    if (!File.exist?(filePath))
+      raise Constants::ERROR_PREFIX + Constants::FILE_NOT_FOUND + filePath
+    end
+    p12File = File.binread(filePath)
+    jwtBody=getJwtBody(request_type, gmtDatetime, merchantconfig_obj, log_obj)
+    claimSet = JSON.parse(jwtBody)
+    p12FilePath = OpenSSL::PKCS12.new(p12File, merchantconfig_obj.keyPass)
+    # Generating certificate.
+    cacheObj = ActiveSupport::Cache::MemoryStore.new
+    x5Cert = Cache.new.fetchCachedCertificate(filePath, p12File, merchantconfig_obj.keyPass, cacheObj)
+    # Generating Public key.
+    publicKey = OpenSSL::PKey::RSA.new(p12FilePath.key.public_key)
+    #Generating Private Key
+    privateKey = OpenSSL::PKey::RSA.new(p12FilePath.key)
+    # JWT token-Generates using RS256 algorithm only
+    x5clist = [x5Cert]
+    customHeaders = {}
+    customHeaders['v-c-merchant-id'] = merchantconfig_obj.keyAlias
+    customHeaders['x5c'] = x5clist
+    # Generating JWT token
+    token = JWT.encode(claimSet, privateKey, 'RS256', customHeaders)
+    return token
+  rescue StandardError => err
+    if err.message.include? 'PKCS12_parse: mac verify failure'
+      ApiException.new.customerror(Constants::ERROR_PREFIX + Constants::INCORRECT_KEY_PASS,log_obj)
+      exit!
+    else
+      ApiException.new.apiexception(err,log_obj)
+      exit!
+    end
+  end
+  def getJwtBody(request_type, gmtDatetime, merchantconfig_obj,log_obj)
+    if request_type == Constants::POST_REQUEST_TYPE || request_type == Constants::PUT_REQUEST_TYPE
+      payload = merchantconfig_obj.requestJsonData
+      # Note: Digest is not passed for GET calls
+      digest = DigestGeneration.new.generateDigest(payload, log_obj)
+      jwtBody = "{\n      \"digest\":\"" + digest + "\", \"digestAlgorithm\":\"SHA-256\", \"iat\":\"" + gmtDatetime + "\"}"
+    elsif request_type == Constants::GET_REQUEST_TYPE || request_type == Constants::DELETE_REQUEST_TYPE
+      jwtBody = "{\n \"iat\":\"" + gmtDatetime + "\"\n} \n\n"
+    else 
+      raise StandardError.new(Constants::ERROR_PREFIX + Constants::INVALID_REQUEST_TYPE_METHOD)
+    end
+  end
+  implements TokenInterface
+end

AuthenticationSDK/authentication/payloadDigest/digest.rb

@@ -0,0 +1,10 @@
+require 'digest'
+public
+# This method return Digest value which is SHA-256 
+# hash of payload that is BASE64 encoded
+class DigestGeneration
+  def generateDigest(payload, log_obj)
+    digest = Digest::SHA256.base64digest(payload)
+    return digest
+  end
+end

AuthenticationSDK/core/Authorization.rb

@@ -0,0 +1,24 @@
+require_relative '../authentication/http/HttpSignatureHeader.rb'
+require_relative '../authentication/jwt/JwtToken.rb'
+require_relative '../util/Constants.rb'
+require_relative '../util/ApiException.rb'
+public
+# This function calls for the generation of Signature message depending on the authentication type.
+class Authorization
+  def getToken(merchantconfig_obj, gmtdatetime, log_obj)
+    authenticationType = merchantconfig_obj.authenticationType.upcase
+    if merchantconfig_obj.requestType.to_s.empty?
+      raise StandardError.new(Constants::ERROR_PREFIX + Constants::REQUEST_TYPE_EMPTY)
+    end
+    if authenticationType == Constants::AUTH_TYPE_HTTP
+      token = GenerateHttpSignature.new.getToken(merchantconfig_obj, gmtdatetime, log_obj)
+    elsif authenticationType == Constants::AUTH_TYPE_JWT
+      token = GenerateJwtToken.new.getToken(merchantconfig_obj, gmtdatetime, log_obj)
+    elsif authenticationType != Constants::AUTH_TYPE_HTTP || authenticationType != Constants::AUTH_TYPE_JWT
+      raise StandardError.ner(Constants::ERROR_PREFIX + Constants::AUTH_ERROR)
+    end
+  rescue StandardError => err
+    ApiException.new.apiexception(err,log_obj)
+    exit!
+  end
+end

AuthenticationSDK/core/ITokenGeneration.rb

@@ -0,0 +1,4 @@
+require 'interface'
+TokenInterface = interface {
+  required_methods :getToken
+}

AuthenticationSDK/core/Logger.rb

@@ -0,0 +1,26 @@
+require_relative '../util/ApiException.rb'
+require 'logger'
+public 
+# Logger Class
+class Log
+  def initialize(logDirectory, logFilename, logSize, enableLog)
+    #log
+    if enableLog == true
+      filename = logDirectory + '/' + logFilename + '.log'
+      datetime = DateTime.now
+      if File.exist?(filename) && File.size(filename) >= logSize
+        updatedFileName = logDirectory + '/' + logFilename + '_' + datetime.strftime('%Y%m%d%H%M%S') + '.log'
+        File.rename(filename, updatedFileName)
+      end
+      @logger = Logger.new(STDOUT)
+      @logger = Logger.new(filename, logSize)
+      @logger.datetime_format = datetime.strftime('%Y-%m-%d %H:%M:%S')
+    else
+      @logger = Logger.new(false)
+    end
+  rescue StandardError => err
+    puts err
+    exit!
+  end
+  attr_accessor :logger
+end