Backend API. Server-side code: this runs in a Codename One backend, not in the app on the device.
public interface SecondFactorPolicy
Known subtypesSecondFactorAuthenticationFilter
Stands between a user passing their first factor and being signed in.
Every way of signing in that ends in a session – the form login, a passkey,
and a sign-in through another identity provider – hands the authentication
it established to the chain’s SessionSignIn rather than storing it. When the
chain has a policy, the policy is asked first, and may take the request
over: http.mfa(...) installs the one that asks for a one-time code.
A policy that takes a request over must leave it anonymous. Nothing has
been stored for the user at this point – no security context, no changed
session id – and the policy keeps only what it needs to finish later, by
calling SessionSignIn.complete once the second factor is in.
Methods
public abstract HttpServer.Response intercept(HttpServer.Request request, Authentication authentication, boolean rememberMe)
throws Exception | Decides whether authentication, whose first factor has just been accepted, must present a second. |
public default boolean requires(Authentication authentication) | Whether authentication is of a user who has a second factor, so that a first factor alone must not make a request theirs. |
public default void satisfied(HttpServer.Request request, Authentication authentication) | Told that authentication signed in with two factors presented in one step – a passkey whose authenticator verified the user – so that intercept was not asked. |
Method details
intercept
public abstract HttpServer.Response intercept(HttpServer.Request request, Authentication authentication, boolean rememberMe)
throws Exceptionauthentication, whose first factor has just been
accepted, must present a second.Parameters
requestHttpServer.Request- Not documented.
authenticationAuthentication- Not documented.
rememberMeboolean- whether the user asked to be remembered: to be handed
back to
SessionSignIn.complete, since the request that finishes the sign-in is not the one that asked
Returns
Throws
requires
public default boolean requires(Authentication authentication)Whether authentication is of a user who has a second factor, so that
a first factor alone must not make a request theirs.
intercept is for a sign-in that can stop and ask. This is for the
ways of presenting a first factor that cannot: credentials sent with
every request, which have no second step to send a code in, and a
remember-me cookie, which has nobody at the keyboard. Each asks here
and refuses the user when the answer is true; see MfaConfigurer for
the rule of each mechanism.
A policy that does not say is taken to require one of everybody.
satisfied
public default void satisfied(HttpServer.Request request, Authentication authentication)Told that authentication signed in with two factors presented in one
step – a passkey whose authenticator verified the user – so that
intercept was not asked.
A policy that counts wrong attempts at its own second factor forgets them here: the user has just proved both factors another way, and whatever was counted against them was not theirs. Nothing unless the policy says more.