Package org.cyclos.security.access

Class DeviceConfirmationServiceSecurity

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.security.BaseServiceSecurity

org.cyclos.security.access.DeviceConfirmationServiceSecurity

All Implemented Interfaces:

DeviceConfirmationService, Service

@Security
public class DeviceConfirmationServiceSecurity
extends BaseServiceSecurity
implements DeviceConfirmationService

Security for DeviceConfirmationService

Field Summary

Fields inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

authHandler, conversionHandler, customFieldValueHandler, entityManagerHandler, groupsHandler, productsHandler, restBeanPropertyMapping, userLocatorHandler

Fields inherited from class org.cyclos.impl.AbstractServerComponent

accountHandler, configurationHandler, dataTranslationHandler, notificationHandler, profileFieldHandler, transactionHandler, translationHandler

Fields inherited from interface org.cyclos.services.access.DeviceConfirmationService

DEVICE_CONFIRMATION_VALUE_PREFIX

Constructor Summary

Constructors

Constructor	Description
DeviceConfirmationServiceSecurity()

Method Summary

Modifier and Type	Method	Description
void	approve(long id, long deviceId, String hmac)	Approves a confirmation through a trusted device.
SerializableInputStream	barcode(DeviceConfirmationBarcodeParams params)	Generates a two-dimensional barcode (QR code), only if the confirmation was not already approved nor rejected, containing a URL of the form: cyclos://confirm?id=confirmation_id&op=i18n_confirmation_type&fields=Label1:Value1|Label2:Value2... If any of the labels / values contains a ':' or '|' char then they are escaped with a '\' (e.i 'Business One | Big' -> 'Business One \| Big') E.g cyclos://confirm?id=-6959640208566238428&op=Payment confirmation&fields=from:b1|to:b2|amount:50 units)
DeviceConfirmationVO	create(CreateDeviceConfirmationParams params)	Creates a new pending for approval device confirmation for the logged user.
DeviceConfirmationApprovalData	getApprovalData(long deviceId)	Return data for approve / reject device confirmations for the given device id
DeviceConfirmationVO	load(Long id)	Load a device confirmation by id for the logged user.
void	reject(long id, long deviceId, String hmac)	Same as DeviceConfirmationService.approve(long, long, String) but for confirmation rejection.
void	remove(Long id)	Removes a confirmation for the logged user.
protected EntityCheck<?>	resolveEntityCheck()	Must be implemented in order to return the EntityCheck managed by this security component, or null if none

Methods inherited from class org.cyclos.security.BaseServiceSecurity

checkGuest, checkId, checkIds, checkInternalName, checkLoggedIn, checkManagesUser, checkRelatesToUser, checkScope, checkVO, checkVOs, doInitialize, getEntityCheckRegistry, getUser, initialize

Methods inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

canManage, checkManagesUser, checkPermission, checkRelatesToUser, checkValue, clearAlreadyValidated, getBaseEntityManagerHandler, getConfiguration, getLoggedBasicUser, getLoggedUser, getProducts, getTranslatedName, getTranslatedValue, hasPermission, hasValue, inSameNetwork, inSameNetworkOrGlobal, isAdmin, isAlreadyValidated, isBroker, isGlobalAdmin, isGlobalAdminInNetwork, isGuest, isLoggedIn, isMember, isMemberOnly, isNetworkAdmin, isOperator, isRelatedToUser, isSystem, isUserManager, isUserManagerOf, message, message, permission, permission, permissionOptionalValue, permissionOptionalValue, toDate, toDateTime, validate

Methods inherited from class org.cyclos.impl.AbstractServerComponent

dataTranslationProxy, delete, detach, find, flush, from, getApplicationContext, getFormatter, getFormatter, getFormatter, getLogger, getRemoteAddress, getSessionData, mailContentBuilder, message, message, persist, processBatch, processBatch, refresh, remove, selectFrom, subQuery, update

Methods inherited from class java.lang.Object

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

Constructor Detail

DeviceConfirmationServiceSecurity

public DeviceConfirmationServiceSecurity()

Method Detail

approve

public void approve(long id,
                    long deviceId,
                    String hmac)

Description copied from interface: DeviceConfirmationService

Approves a confirmation through a trusted device. This operation can be invoked as guests or with a logged user, if guest the final user running the approve will be the device's owner.

Specified by:

approve in interface DeviceConfirmationService

Parameters:

id - the identification of the confirmation being approved.

deviceId - the identification of the trusted device used to approve.

hmac - the Hash-based Message Authentication Code used to verify the authentication of the confirmation and device.
The cryptographic hash function used to compute the HMAC is SHA-256.

barcode

public SerializableInputStream barcode(DeviceConfirmationBarcodeParams params)

Description copied from interface: DeviceConfirmationService

Generates a two-dimensional barcode (QR code), only if the confirmation was not already approved nor rejected, containing a URL of the form:
cyclos://confirm?id=confirmation_id&op=i18n_confirmation_type&fields=Label1:Value1|Label2:Value2...

If any of the labels / values contains a ':' or '|' char then they are escaped with a '\' (e.i 'Business One | Big' -> 'Business One \| Big') E.g
cyclos://confirm?id=-6959640208566238428&op=Payment confirmation&fields=from:b1|to:b2|amount:50 units)

Specified by:

barcode in interface DeviceConfirmationService

create

public DeviceConfirmationVO create(CreateDeviceConfirmationParams params)

Description copied from interface: DeviceConfirmationService

Creates a new pending for approval device confirmation for the logged user.

Specified by:

create in interface DeviceConfirmationService

getApprovalData

public DeviceConfirmationApprovalData getApprovalData(long deviceId)

Description copied from interface: DeviceConfirmationService

Return data for approve / reject device confirmations for the given device id

Specified by:

getApprovalData in interface DeviceConfirmationService

Returns:

load

public DeviceConfirmationVO load(Long id)
                          throws FrameworkException

Description copied from interface: DeviceConfirmationService

Load a device confirmation by id for the logged user.

Specified by:

load in interface DeviceConfirmationService

Throws:

FrameworkException

reject

public void reject(long id,
                   long deviceId,
                   String hmac)

Description copied from interface: DeviceConfirmationService

Same as DeviceConfirmationService.approve(long, long, String) but for confirmation rejection.

Specified by:

reject in interface DeviceConfirmationService

remove

public void remove(Long id)

Description copied from interface: DeviceConfirmationService

Removes a confirmation for the logged user.

Specified by:

remove in interface DeviceConfirmationService

resolveEntityCheck

protected EntityCheck<?> resolveEntityCheck()

Description copied from class: BaseServiceSecurity

Must be implemented in order to return the EntityCheck managed by this security component, or null if none

Specified by:

resolveEntityCheck in class BaseServiceSecurity