Package io.getlime.security.powerauth.soap.spring.client

Class PowerAuthServiceClient.PowerAuthServiceClientV2

java.lang.Object

io.getlime.security.powerauth.soap.spring.client.PowerAuthServiceClient.PowerAuthServiceClientV2

Enclosing class:

PowerAuthServiceClient

public class PowerAuthServiceClient.PowerAuthServiceClientV2
extends java.lang.Object

Client with PowerAuth version 2.0 methods. This client will be deprecated in future release.

Constructor Summary

Constructors

Constructor	Description
PowerAuthServiceClientV2()

Method Summary

Modifier and Type	Method	Description
CreateActivationResponse	createActivation(CreateActivationRequest request)	Create a new activation directly, using the createActivation method of the PowerAuth 2.0 Server SOAP interface.
CreateActivationResponse	createActivation(java.lang.String applicationKey, java.lang.String userId, java.lang.Long maxFailureCount, java.util.Date timestampActivationExpire, java.lang.String identity, java.lang.String activationOtp, java.lang.String activationName, java.lang.String activationNonce, java.lang.String ephemeralPublicKey, java.lang.String cDevicePublicKey, java.lang.String extras, java.lang.String applicationSignature)	Call the createActivation method of the PowerAuth 2.0 Server SOAP interface.
CreateActivationResponse	createActivation(java.lang.String applicationKey, java.lang.String userId, java.lang.String identity, java.lang.String activationName, java.lang.String activationNonce, java.lang.String ephemeralPublicKey, java.lang.String cDevicePublicKey, java.lang.String extras, java.lang.String applicationSignature)	Call the createActivation method of the PowerAuth 2.0 Server SOAP interface.
CreateTokenResponse	createToken(CreateTokenRequest request)	Create a new token for basic token-based authentication.
CreateTokenResponse	createToken(java.lang.String activationId, java.lang.String ephemeralPublicKey, SignatureType signatureType)	Create a new token for basic token-based authentication.
GetNonPersonalizedEncryptionKeyResponse	generateNonPersonalizedE2EEncryptionKey(GetNonPersonalizedEncryptionKeyRequest request)	Call the generateNonPersonalizedE2EEncryptionKey method of the PowerAuth 2.0 Server SOAP interface.
GetNonPersonalizedEncryptionKeyResponse	generateNonPersonalizedE2EEncryptionKey(java.lang.String applicationKey, java.lang.String ephemeralPublicKeyBase64, java.lang.String sessionIndex)	Call the generateNonPersonalizedE2EEncryptionKey method of the PowerAuth 2.0 Server SOAP interface and get newly generated derived encryption key.
GetPersonalizedEncryptionKeyResponse	generatePersonalizedE2EEncryptionKey(GetPersonalizedEncryptionKeyRequest request)	Call the generatePersonalizedE2EEncryptionKey method of the PowerAuth 2.0 Server SOAP interface.
GetPersonalizedEncryptionKeyResponse	generatePersonalizedE2EEncryptionKey(java.lang.String activationId, java.lang.String sessionIndex)	Call the generatePersonalizedE2EEncryptionKey method of the PowerAuth 2.0 Server SOAP interface and get newly generated derived encryption key.
PrepareActivationResponse	prepareActivation(PrepareActivationRequest request)	Call the prepareActivation method of the PowerAuth 3.0 Server SOAP interface.
PrepareActivationResponse	prepareActivation(java.lang.String activationIdShort, java.lang.String activationName, java.lang.String activationNonce, java.lang.String ephemeralPublicKey, java.lang.String cDevicePublicKey, java.lang.String extras, java.lang.String applicationKey, java.lang.String applicationSignature)	Call the prepareActivation method of the PowerAuth 2.0 Server SOAP interface.
VaultUnlockResponse	unlockVault(VaultUnlockRequest request)	Call the vaultUnlock method of the PowerAuth 2.0 Server SOAP interface.
VaultUnlockResponse	unlockVault(java.lang.String activationId, java.lang.String applicationKey, java.lang.String data, java.lang.String signature, SignatureType signatureType, java.lang.String reason)	Call the vaultUnlock method of the PowerAuth 2.0 Server SOAP interface.

Methods inherited from class java.lang.Object

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

Constructor Detail

PowerAuthServiceClientV2

public PowerAuthServiceClientV2()

Method Detail

prepareActivation

public PrepareActivationResponse prepareActivation(PrepareActivationRequest request)

Call the prepareActivation method of the PowerAuth 3.0 Server SOAP interface.

Parameters:

request - PrepareActivationRequest instance

Returns:

PrepareActivationResponse

prepareActivation

public PrepareActivationResponse prepareActivation(java.lang.String activationIdShort,
                                                   java.lang.String activationName,
                                                   java.lang.String activationNonce,
                                                   java.lang.String ephemeralPublicKey,
                                                   java.lang.String cDevicePublicKey,
                                                   java.lang.String extras,
                                                   java.lang.String applicationKey,
                                                   java.lang.String applicationSignature)

Call the prepareActivation method of the PowerAuth 2.0 Server SOAP interface.

Parameters:

activationIdShort - Short activation ID.

activationName - Name of this activation.

activationNonce - Activation nonce.

applicationKey - Application key of a given application.

applicationSignature - Signature proving a correct application is sending the data.

cDevicePublicKey - Device public key encrypted with activation OTP.

extras - Additional, application specific information.

Returns:

PrepareActivationResponse

createActivation

public CreateActivationResponse createActivation(CreateActivationRequest request)

Create a new activation directly, using the createActivation method of the PowerAuth 2.0 Server SOAP interface.

Parameters:

request - Create activation request.

Returns:

Create activation response.

createActivation

public CreateActivationResponse createActivation(java.lang.String applicationKey,
                                                 java.lang.String userId,
                                                 java.lang.String identity,
                                                 java.lang.String activationName,
                                                 java.lang.String activationNonce,
                                                 java.lang.String ephemeralPublicKey,
                                                 java.lang.String cDevicePublicKey,
                                                 java.lang.String extras,
                                                 java.lang.String applicationSignature)

Call the createActivation method of the PowerAuth 2.0 Server SOAP interface.

Parameters:

userId - User ID.

applicationKey - Application key of a given application.

identity - Identity fingerprint used during activation.

activationName - Name of this activation.

activationNonce - Activation nonce.

applicationSignature - Signature proving a correct application is sending the data.

cDevicePublicKey - Device public key encrypted with activation OTP.

ephemeralPublicKey - Ephemeral public key used for one-time object transfer.

extras - Additional, application specific information.

Returns:

CreateActivationResponse

createActivation

public CreateActivationResponse createActivation(java.lang.String applicationKey,
                                                 java.lang.String userId,
                                                 java.lang.Long maxFailureCount,
                                                 java.util.Date timestampActivationExpire,
                                                 java.lang.String identity,
                                                 java.lang.String activationOtp,
                                                 java.lang.String activationName,
                                                 java.lang.String activationNonce,
                                                 java.lang.String ephemeralPublicKey,
                                                 java.lang.String cDevicePublicKey,
                                                 java.lang.String extras,
                                                 java.lang.String applicationSignature)

Call the createActivation method of the PowerAuth 2.0 Server SOAP interface.

Parameters:

userId - User ID.

maxFailureCount - Maximum failure count.

timestampActivationExpire - Timestamp this activation should expire.

applicationKey - Application key of a given application.

identity - Identity fingerprint used during activation.

activationOtp - Activation OTP.

activationName - Name of this activation.

activationNonce - Activation nonce.

applicationSignature - Signature proving a correct application is sending the data.

cDevicePublicKey - Device public key encrypted with activation OTP.

ephemeralPublicKey - Ephemeral public key.

extras - Additional, application specific information.

Returns:

CreateActivationResponse

unlockVault

public VaultUnlockResponse unlockVault(VaultUnlockRequest request)

Call the vaultUnlock method of the PowerAuth 2.0 Server SOAP interface.

Parameters:

request - VaultUnlockRequest instance

Returns:

VaultUnlockResponse

unlockVault

public VaultUnlockResponse unlockVault(java.lang.String activationId,
                                       java.lang.String applicationKey,
                                       java.lang.String data,
                                       java.lang.String signature,
                                       SignatureType signatureType,
                                       java.lang.String reason)

Call the vaultUnlock method of the PowerAuth 2.0 Server SOAP interface.

Parameters:

activationId - Activation Id of an activation to be used for authentication.

applicationKey - Application Key of an application related to the activation.

data - Data to be signed encoded in format as specified by PowerAuth 2.0 data normalization.

signature - Vault opening request signature.

signatureType - Vault opening request signature type.

reason - Reason why vault is being unlocked.

Returns:

VaultUnlockResponse

generatePersonalizedE2EEncryptionKey

public GetPersonalizedEncryptionKeyResponse generatePersonalizedE2EEncryptionKey(GetPersonalizedEncryptionKeyRequest request)

Call the generatePersonalizedE2EEncryptionKey method of the PowerAuth 2.0 Server SOAP interface.

Parameters:

request - GetPersonalizedEncryptionKeyRequest instance.

Returns:

GetPersonalizedEncryptionKeyResponse

generatePersonalizedE2EEncryptionKey

public GetPersonalizedEncryptionKeyResponse generatePersonalizedE2EEncryptionKey(java.lang.String activationId,
                                                                                 java.lang.String sessionIndex)

Call the generatePersonalizedE2EEncryptionKey method of the PowerAuth 2.0 Server SOAP interface and get newly generated derived encryption key.

Parameters:

activationId - Activation ID used for the key generation.

Returns:

GetPersonalizedEncryptionKeyResponse

generateNonPersonalizedE2EEncryptionKey

public GetNonPersonalizedEncryptionKeyResponse generateNonPersonalizedE2EEncryptionKey(GetNonPersonalizedEncryptionKeyRequest request)

Call the generateNonPersonalizedE2EEncryptionKey method of the PowerAuth 2.0 Server SOAP interface.

Parameters:

request - GetNonPersonalizedEncryptionKeyRequest instance.

Returns:

GetNonPersonalizedEncryptionKeyResponse

generateNonPersonalizedE2EEncryptionKey

public GetNonPersonalizedEncryptionKeyResponse generateNonPersonalizedE2EEncryptionKey(java.lang.String applicationKey,
                                                                                       java.lang.String ephemeralPublicKeyBase64,
                                                                                       java.lang.String sessionIndex)

Call the generateNonPersonalizedE2EEncryptionKey method of the PowerAuth 2.0 Server SOAP interface and get newly generated derived encryption key.

Parameters:

applicationKey - Application key of application used for the key generation.

Returns:

GetNonPersonalizedEncryptionKeyResponse

createToken

public CreateTokenResponse createToken(CreateTokenRequest request)

Create a new token for basic token-based authentication.

Parameters:

request - Request with token information.

Returns:

Response with created token.

createToken

public CreateTokenResponse createToken(java.lang.String activationId,
                                       java.lang.String ephemeralPublicKey,
                                       SignatureType signatureType)

Create a new token for basic token-based authentication.

Parameters:

activationId - Activation ID for the activation that is associated with the token.

ephemeralPublicKey - Ephemeral public key used for response encryption.

signatureType - Type of the signature used for validating the create request.

Returns:

Response with created token.