com.licensespring.api

Class AuthorizationService

java.lang.Object

com.licensespring.api.AuthorizationService

public class AuthorizationService
extends Object

Authorization service used for adding Authorization headers to to RequestInterceptor.

Field Summary

Fields

Modifier and Type	Field and Description
static DateTimeFormatter	DONT_TRUNCATE_ZERO_MILLIS The constant DONT_TRUNCATE_ZERO_MILIS.

Constructor Summary

Constructors

Constructor and Description
AuthorizationService(BaseConfiguration configuration) Instantiates a new Authorization service.
AuthorizationService(BaseConfiguration configuration, com.licensespring.internal.services.DateProvider provider) Instantiates a new Authorization service.

Method Summary

Modifier and Type	Method and Description
Map<String,String>	addSignatureToHeaders(Map<String,String> headers) Adds "Authorization" and "Content-Type" headers and adds them to provided Map.
PublicKey	buildPublicKey() Build public key from saved .pem file
void	changeOAuthClientSecret(String clientSecret) Changes the OAuth client secret
boolean	checkSignature(LicenseData data, String hardwareId, LicenseIdentity licenseIdentity) Checks if signature is valid.
boolean	checkSignature(String signature, String dataToVerify)
String	createOfflineSignature(String date, String licenseKey, String hardwareId, String signingKey) Creates signature by joining provided parameters with "\n".
String	createSignature(Map<String,String> params) Creates signature from the given parameters map.
String	createSignature(String date, String licenseKey, String hardwareId, String idKey) Creates signature from provided parameters
String	createSignatureString(Map<String,String> params) Creates signature by joining all params with "\n"
Map<String,String>	generateHeaders() Generates "Authorization" and "Content-Type" headers.
OAuthTokenRequest	getOAuthCredentials() Gets the current OAuth credentials.
String	hmac(String stringToSign) Sign String with HMAC Algorithm
byte[]	readPemFile() Read .pem file from resources folder
void	setDateProvider(com.licensespring.internal.services.DateProvider dateProvider) Provider of the current date.
void	updateOAuthCredentials(String clientId, String clientSecret) Updates OAuth credentials (both client ID and secret)
void	verify(LicenseIdentity identity, String hardwareId, LicenseData licenseData) Method for verifying signature that was used to sign request.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DONT_TRUNCATE_ZERO_MILLIS

public static final DateTimeFormatter DONT_TRUNCATE_ZERO_MILLIS

The constant DONT_TRUNCATE_ZERO_MILIS.

Constructor Detail

AuthorizationService

public AuthorizationService(BaseConfiguration configuration,
                            com.licensespring.internal.services.DateProvider provider)

Instantiates a new Authorization service.

Parameters:

configuration - the configuration

provider - the provider

AuthorizationService

public AuthorizationService(BaseConfiguration configuration)

Instantiates a new Authorization service.

Parameters:

configuration - the configuration

Method Detail

changeOAuthClientSecret

public void changeOAuthClientSecret(String clientSecret)

Changes the OAuth client secret

Parameters:

clientSecret - the new client secret

updateOAuthCredentials

public void updateOAuthCredentials(String clientId,
                                   String clientSecret)

Updates OAuth credentials (both client ID and secret)

getOAuthCredentials

public OAuthTokenRequest getOAuthCredentials()

Gets the current OAuth credentials.

Returns:

The OAuthTokenRequest containing the clientId and clientSecret

generateHeaders

public Map<String,String> generateHeaders()

Generates "Authorization" and "Content-Type" headers. If OAuth is enabled, returns a header with the Bearer token. Otherwise, generates HMAC signature-based headers.

Returns:

Map of headers

addSignatureToHeaders

public Map<String,String> addSignatureToHeaders(Map<String,String> headers)

Adds "Authorization" and "Content-Type" headers and adds them to provided Map.

Parameters:

headers - Headers map

Returns:

Map with generated headers

createSignature

public String createSignature(Map<String,String> params)

Creates signature from the given parameters map.

Parameters:

params - Parameters map

Returns:

Generated signature

createSignature

public String createSignature(String date,
                              String licenseKey,
                              String hardwareId,
                              String idKey)

Creates signature from provided parameters

Parameters:

date - Date

licenseKey - License key

hardwareId - Hardware ID

idKey - API key or client id

Returns:

Created signature

createOfflineSignature

public String createOfflineSignature(String date,
                                     String licenseKey,
                                     String hardwareId,
                                     String signingKey)

Creates signature by joining provided parameters with "\n".

Parameters:

date - Date

licenseKey - License key

hardwareId - Hardware ID

signingKey - API key or client id

Returns:

Signature string

createSignatureString

public String createSignatureString(Map<String,String> params)

Creates signature by joining all params with "\n"

Parameters:

params - Params map

Returns:

Signature string

verify

public void verify(LicenseIdentity identity,
                   String hardwareId,
                   LicenseData licenseData)

Method for verifying signature that was used to sign request.

Parameters:

identity - License identity

hardwareId - Hardware ID

licenseData - License data

checkSignature

public boolean checkSignature(LicenseData data,
                              String hardwareId,
                              LicenseIdentity licenseIdentity)
                       throws GeneralSecurityException

Checks if signature is valid. Returns true if signature is valid, false otherwise.

Parameters:

data - License data

hardwareId - Hardware ID

licenseIdentity - License identity

Returns:

True or false

Throws:

GeneralSecurityException - a problem with verification data

checkSignature

public boolean checkSignature(String signature,
                              String dataToVerify)
                       throws NoSuchAlgorithmException,
                              InvalidKeyException,
                              InvalidKeySpecException,
                              SignatureException

Throws:

NoSuchAlgorithmException

InvalidKeyException

InvalidKeySpecException

SignatureException

buildPublicKey

public PublicKey buildPublicKey()
                         throws NoSuchAlgorithmException,
                                InvalidKeySpecException

Build public key from saved .pem file

Returns:

Public key

Throws:

NoSuchAlgorithmException - the no such algorithm exception

InvalidKeySpecException - the invalid key spec exception

readPemFile

public byte[] readPemFile()

Read .pem file from resources folder

Returns:

Byte array of .pem file

hmac

public String hmac(String stringToSign)

Sign String with HMAC Algorithm

Parameters:

stringToSign - String to sign

Returns:

Signed String

setDateProvider

public void setDateProvider(com.licensespring.internal.services.DateProvider dateProvider)

Provider of the current date.