com.yubico.u2f

Class U2fPrimitives

java.lang.Object

com.yubico.u2f.U2fPrimitives

public class U2fPrimitives
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AUTHENTICATE_TYP
static java.lang.String	REGISTER_TYPE
static java.lang.String	U2F_VERSION

Constructor Summary

Constructors

Constructor and Description
U2fPrimitives()
U2fPrimitives(Crypto crypto, ChallengeGenerator challengeGenerator)

Method Summary

Methods

Modifier and Type	Method and Description
void	finishAuthentication(AuthenticateRequest authenticateRequest, AuthenticateResponse response, DeviceRegistration deviceRegistration)
void	finishAuthentication(AuthenticateRequest authenticateRequest, AuthenticateResponse response, DeviceRegistration deviceRegistration, java.util.Set<java.lang.String> facets) Finishes a previously started authentication.
DeviceRegistration	finishRegistration(RegisterRequest registerRequest, RegisterResponse response)
DeviceRegistration	finishRegistration(RegisterRequest registerRequest, RegisterResponse response, java.util.Set<java.lang.String> facets) Finishes a previously started registration.
AuthenticateRequest	startAuthentication(java.lang.String appId, DeviceRegistration deviceRegistration) Initiates the authentication process.
AuthenticateRequest	startAuthentication(java.lang.String appId, DeviceRegistration deviceRegistration, byte[] challenge) Initiates the authentication process.
RegisterRequest	startRegistration(java.lang.String appId)
RegisterRequest	startRegistration(java.lang.String appId, byte[] challenge) Initiates the registration of a device.

Methods inherited from class java.lang.Object

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

Field Detail

AUTHENTICATE_TYP

public static final java.lang.String AUTHENTICATE_TYP

See Also:

Constant Field Values

REGISTER_TYPE

public static final java.lang.String REGISTER_TYPE

See Also:

Constant Field Values

U2F_VERSION

public static final java.lang.String U2F_VERSION

See Also:

Constant Field Values

Constructor Detail

U2fPrimitives

public U2fPrimitives(Crypto crypto,
             ChallengeGenerator challengeGenerator)

U2fPrimitives

public U2fPrimitives()

Method Detail

startRegistration

public RegisterRequest startRegistration(java.lang.String appId)

See Also:

startRegistration(String, byte[])

startRegistration

public RegisterRequest startRegistration(java.lang.String appId,
                                byte[] challenge)

Initiates the registration of a device.

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.

challenge - the challenge to use

Returns:

a RegisterRequest, which should be sent to the client and temporary saved by the server.

finishRegistration

public DeviceRegistration finishRegistration(RegisterRequest registerRequest,
                                    RegisterResponse response)
                                      throws U2fException

Throws:

U2fException

See Also:

finishRegistration(com.yubico.u2f.data.messages.RegisterRequest, com.yubico.u2f.data.messages.RegisterResponse, java.util.Set)

finishRegistration

public DeviceRegistration finishRegistration(RegisterRequest registerRequest,
                                    RegisterResponse response,
                                    java.util.Set<java.lang.String> facets)
                                      throws U2fException

Finishes a previously started registration.

Parameters:

registerRequest -

response - the response from the device/client.

Returns:

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

Throws:

U2fException

startAuthentication

public AuthenticateRequest startAuthentication(java.lang.String appId,
                                      DeviceRegistration deviceRegistration)

Initiates the authentication process.

See Also:

startAuthentication(String, com.yubico.u2f.data.DeviceRegistration, byte[])

startAuthentication

public AuthenticateRequest startAuthentication(java.lang.String appId,
                                      DeviceRegistration deviceRegistration,
                                      byte[] challenge)

Initiates the authentication process.

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.

deviceRegistration - the DeviceRegistration for which to initiate authentication.

challenge - the challenge to use

Returns:

an AuthenticateRequest which should be sent to the client and temporary saved by the server.

finishAuthentication

public void finishAuthentication(AuthenticateRequest authenticateRequest,
                        AuthenticateResponse response,
                        DeviceRegistration deviceRegistration)
                          throws U2fException

Throws:

U2fException

See Also:

finishAuthentication(com.yubico.u2f.data.messages.AuthenticateRequest, com.yubico.u2f.data.messages.AuthenticateResponse, com.yubico.u2f.data.DeviceRegistration, java.util.Set)

finishAuthentication

public void finishAuthentication(AuthenticateRequest authenticateRequest,
                        AuthenticateResponse response,
                        DeviceRegistration deviceRegistration,
                        java.util.Set<java.lang.String> facets)
                          throws U2fException

Finishes a previously started authentication.

Parameters:

authenticateRequest -

response - the response from the device/client.

Throws:

U2fException