org.apereo.cas.adaptors.u2f.storage

Interface U2FDeviceRepository

All Known Implementing Classes:

BaseResourceU2FDeviceRepository, BaseU2FDeviceRepository, U2FGroovyResourceDeviceRepository, U2FInMemoryDeviceRepository, U2FJsonResourceDeviceRepository, U2FRestResourceDeviceRepository

public interface U2FDeviceRepository

This is U2FDeviceRepository.

Since:

5.1.0

Method Summary

Modifier and Type	Method and Description
void	authenticateDevice(java.lang.String username, com.yubico.u2f.data.DeviceRegistration registration) Deliver authenticated device upon successful authentication events.
void	clean() Clean up repository to remove expired records.
java.lang.String	getDeviceAuthenticationRequest(java.lang.String requestId, java.lang.String username) Gets device authentication request.
java.lang.String	getDeviceRegistrationRequest(java.lang.String requestId, java.lang.String username) Gets device registration request.
java.util.Collection<com.yubico.u2f.data.DeviceRegistration>	getRegisteredDevices(java.lang.String username) Gets registrations.
boolean	isDeviceRegisteredFor(java.lang.String username) Is registered ?
void	registerDevice(java.lang.String username, com.yubico.u2f.data.DeviceRegistration registration) Add registration.
void	requestDeviceAuthentication(java.lang.String requestId, java.lang.String username, java.lang.String registrationJsonData) Request device authentication.
void	requestDeviceRegistration(java.lang.String requestId, java.lang.String username, java.lang.String registrationJsonData) Request device registration.

Method Detail

getRegisteredDevices

java.util.Collection<com.yubico.u2f.data.DeviceRegistration> getRegisteredDevices(java.lang.String username)

Gets registrations.

Parameters:

username - the username

Returns:

the registrations

registerDevice

void registerDevice(java.lang.String username,
                    com.yubico.u2f.data.DeviceRegistration registration)

Add registration.

Parameters:

username - the username

registration - the registration

authenticateDevice

void authenticateDevice(java.lang.String username,
                        com.yubico.u2f.data.DeviceRegistration registration)

Deliver authenticated device upon successful authentication events.

Parameters:

username - the username

registration - the registration

isDeviceRegisteredFor

boolean isDeviceRegisteredFor(java.lang.String username)

Is registered ?

Parameters:

username - the username

Returns:

the boolean

getDeviceRegistrationRequest

java.lang.String getDeviceRegistrationRequest(java.lang.String requestId,
                                              java.lang.String username)

Gets device registration request.

Parameters:

requestId - the request id

username - the username

Returns:

the device registration request in JSON

getDeviceAuthenticationRequest

java.lang.String getDeviceAuthenticationRequest(java.lang.String requestId,
                                                java.lang.String username)

Gets device authentication request.

Parameters:

requestId - the request id

username - the username

Returns:

the device authentication request

requestDeviceRegistration

void requestDeviceRegistration(java.lang.String requestId,
                               java.lang.String username,
                               java.lang.String registrationJsonData)

Request device registration.

Parameters:

requestId - the request id

username - the username

registrationJsonData - the registration json data

requestDeviceAuthentication

void requestDeviceAuthentication(java.lang.String requestId,
                                 java.lang.String username,
                                 java.lang.String registrationJsonData)

Request device authentication.

Parameters:

requestId - the request id

username - the username

registrationJsonData - the registration json data

clean

void clean()

Clean up repository to remove expired records.