com.yubico.u2f

Class U2F

java.lang.Object

com.yubico.u2f.U2F

public class U2F
extends Object

Constructor Summary

Constructors

Constructor and Description
U2F()

Method Summary

Modifier and Type	Method and Description
DeviceRegistration	finishAuthentication(AuthenticateRequestData authenticateRequestData, AuthenticateResponse response, Iterable<? extends DeviceRegistration> devices)
DeviceRegistration	finishAuthentication(AuthenticateRequestData authenticateRequestData, AuthenticateResponse response, Iterable<? extends DeviceRegistration> devices, Set<String> facets) Finishes a previously started high-level authentication.
DeviceRegistration	finishRegistration(RegisterRequestData registerRequestData, RegisterResponse response)
DeviceRegistration	finishRegistration(RegisterRequestData registerRequestData, RegisterResponse response, Set<String> facets) Finishes a previously started high-level registration.
AuthenticateRequestData	startAuthentication(String appId, Iterable<? extends DeviceRegistration> devices)
RegisterRequestData	startRegistration(String appId, Iterable<? extends DeviceRegistration> devices) Initiates a high-level registration of a device, given a set of already registered devices.

Methods inherited from class java.lang.Object

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

Constructor Detail

U2F

public U2F()

Method Detail

startRegistration

public RegisterRequestData startRegistration(String appId,
                                             Iterable<? extends DeviceRegistration> devices)

Initiates a high-level registration of a device, given a set of already registered devices.

Parameters:

appId - the U2F AppID. Set this to the Web Origin of the login page, unless you need to support logging in from multiple Web Origins.

devices - the devices currently registered to the user.

Returns:

a RegisterRequestData, which should be sent to the client and temporarily saved by the server.

startAuthentication

public AuthenticateRequestData startAuthentication(String appId,
                                                   Iterable<? extends DeviceRegistration> devices)
                                            throws U2fBadInputException,
                                                   NoEligableDevicesException

Throws:

U2fBadInputException

NoEligableDevicesException

finishRegistration

public DeviceRegistration finishRegistration(RegisterRequestData registerRequestData,
                                             RegisterResponse response)
                                      throws U2fBadInputException

Throws:

U2fBadInputException

finishRegistration

public DeviceRegistration finishRegistration(RegisterRequestData registerRequestData,
                                             RegisterResponse response,
                                             Set<String> facets)
                                      throws U2fBadInputException

Finishes a previously started high-level registration.

Parameters:

registerRequestData - the RegisterResponseData created by calling startRegistration

response - The response from the device/client.

facets - A list of valid facets to verify against.

Returns:

a DeviceRegistration object, holding information about the registered device. Servers should persist this.

Throws:

U2fBadInputException

finishAuthentication

public DeviceRegistration finishAuthentication(AuthenticateRequestData authenticateRequestData,
                                               AuthenticateResponse response,
                                               Iterable<? extends DeviceRegistration> devices)
                                        throws U2fBadInputException,
                                               DeviceCompromisedException

Throws:

U2fBadInputException

DeviceCompromisedException

See Also:

finishAuthentication(com.yubico.u2f.data.messages.AuthenticateRequestData, com.yubico.u2f.data.messages.AuthenticateResponse, Iterable, java.util.Set)

finishAuthentication

public DeviceRegistration finishAuthentication(AuthenticateRequestData authenticateRequestData,
                                               AuthenticateResponse response,
                                               Iterable<? extends DeviceRegistration> devices,
                                               Set<String> facets)
                                        throws U2fBadInputException,
                                               DeviceCompromisedException

Finishes a previously started high-level authentication.

Parameters:

authenticateRequestData - the AuthenticateRequestData created by calling startAuthentication

response - the response from the device/client.

devices - the devices currently registered to the user.

facets - A list of valid facets to verify against.

Returns:

The (updated) DeviceRegistration that was authenticated against.

Throws:

U2fBadInputException

DeviceCompromisedException