/* * Copyright 2016 Red Hat, Inc. and/or its affiliates * and other contributors as indicated by the @author tags. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package org.keycloak.authentication.authenticators.browser; import org.keycloak.authentication.AuthenticationFlowContext; import org.keycloak.authentication.AuthenticationFlowError; import org.keycloak.authentication.Authenticator; import org.keycloak.events.Errors; import org.keycloak.forms.login.LoginFormsProvider; import org.keycloak.models.KeycloakSession; import org.keycloak.models.RealmModel; import org.keycloak.models.UserCredentialModel; import org.keycloak.models.UserModel; import org.keycloak.representations.idm.CredentialRepresentation; import org.keycloak.services.messages.Messages; import javax.ws.rs.core.MultivaluedMap; import javax.ws.rs.core.Response; /** * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a> * @version $Revision: 1 $ */ public class OTPFormAuthenticator extends AbstractUsernameFormAuthenticator implements Authenticator { @Override public void action(AuthenticationFlowContext context) { validateOTP(context); } @Override public void authenticate(AuthenticationFlowContext context) { Response challengeResponse = challenge(context, null); context.challenge(challengeResponse); } public void validateOTP(AuthenticationFlowContext context) { MultivaluedMap<String, String> inputData = context.getHttpRequest().getDecodedFormParameters(); if (inputData.containsKey("cancel")) { context.resetFlow(); return; } String password = inputData.getFirst(CredentialRepresentation.TOTP); if (password == null) { Response challengeResponse = challenge(context, null); context.challenge(challengeResponse); return; } boolean valid = context.getSession().userCredentialManager().isValid(context.getRealm(), context.getUser(), UserCredentialModel.otp(context.getRealm().getOTPPolicy().getType(), password)); if (!valid) { context.getEvent().user(context.getUser()) .error(Errors.INVALID_USER_CREDENTIALS); Response challengeResponse = challenge(context, Messages.INVALID_TOTP); context.failureChallenge(AuthenticationFlowError.INVALID_CREDENTIALS, challengeResponse); return; } context.success(); } @Override public boolean requiresUser() { return true; } protected Response challenge(AuthenticationFlowContext context, String error) { LoginFormsProvider forms = context.form(); if (error != null) forms.setError(error); return forms.createLoginTotp(); } @Override public boolean configuredFor(KeycloakSession session, RealmModel realm, UserModel user) { return session.userCredentialManager().isConfiguredFor(realm, user, realm.getOTPPolicy().getType()); } @Override public void setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user) { if (!user.getRequiredActions().contains(UserModel.RequiredAction.CONFIGURE_TOTP.name())) { user.addRequiredAction(UserModel.RequiredAction.CONFIGURE_TOTP.name()); } } @Override public void close() { } }