com.rapidclipse.framework.security.authentication.InMemoryAuthenticator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of rap-security-auth Show documentation
Rapid Application Platform / Security / Authentication and Authorization
There is a newer version: 14.0.0
/*
 * Copyright (C) 2013-2023 by XDEV Software, All Rights Reserved.
 *
 * This file is part of the RapidClipse Application Platform (RAP).
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see .
 *
 * SPDX-License-Identifier: AGPL-3.0-or-later
 *
 * Contributors:
 *     XDEV Software - initial API and implementation
 */
package com.rapidclipse.framework.security.authentication;

import java.nio.charset.StandardCharsets;
import java.util.Arrays;
import java.util.Map;
import java.util.stream.Collectors;

import com.rapidclipse.framework.security.util.KeyValue;


/**
 * Trivial in-memory implementation of an {@link Authenticator}.
 * 
 * Note that this implementation stores passwords in plain text in memory and is
 * therefor only suitable for examples or very trivial, non-security-critical
 * use cases.
 *
 * @author XDEV Software (TM)
 */
public final class InMemoryAuthenticator
	implements Authenticator
{
	///////////////////////////////////////////////////////////////////////////
	// static methods //
	///////////////////
	
	/**
	 * Creates a new {@link InMemoryAuthenticator} instance using a copy of the
	 * passed username/password map. The entries are interpreted as the keys
	 * representing the key and the associated value representing the associated
	 * password.
	 *
	 * @param usernamePasswords
	 *            the username/password data.
	 * @return a new {@link InMemoryAuthenticator} instance using the passed
	 *         data as a user inventory.
	 */
	public static final InMemoryAuthenticator New(final Map usernamePasswords)
	{
		// immure to ensure immutability for central, potentially concurrently
		// used instance
		return new InMemoryAuthenticator(usernamePasswords);
	}
	
	/**
	 * Creates a new {@link InMemoryAuthenticator} instance using a copy of the
	 * passed username/password array. The entries are interpreted as the keys
	 * representing the key and the associated value representing the associated
	 * password.
	 *
	 * @param usernamePasswords
	 *            the username/password data.
	 * @return a new {@link InMemoryAuthenticator} instance using the passed
	 *         data as a user inventory.
	 */
	@SafeVarargs
	public static final InMemoryAuthenticator New(
		final KeyValue... usernamePasswords)
	{
		final Map map = Arrays.stream(usernamePasswords)
			.collect(Collectors.toMap(up -> up.key(), up -> up.value()));
		return new InMemoryAuthenticator(map);
	}
	
	///////////////////////////////////////////////////////////////////////////
	// instance fields //
	////////////////////
	
	/**
	 * The internally used authentication map.
	 */
	final Map usernamePasswords;
	
	///////////////////////////////////////////////////////////////////////////
	// constructors //
	/////////////////
	
	/**
	 * Internal implementation-detail constructor.
	 *
	 * @param usernamePasswords
	 */
	InMemoryAuthenticator(final Map usernamePasswords)
	{
		super();
		this.usernamePasswords = usernamePasswords;
	}
	
	///////////////////////////////////////////////////////////////////////////
	// declared methods //
	/////////////////////
	
	public final boolean authenticate(final String username, final String password)
		throws AuthenticationFailedException
	{
		return this.authenticate(CredentialsUsernamePassword.New(
			username,
			password.getBytes(StandardCharsets.UTF_8)));
	}
	
	///////////////////////////////////////////////////////////////////////////
	// override methods //
	/////////////////////
	
	/**
	 * Returns {@link Boolean#FALSE} if the attempt to authenticate the passed
	 * credentials fails, {@link Boolean#TRUE} otherwise.
	 *
	 * @param credentials
	 *            the credentials instance to be authenticated.
	 * @return a non-null {@link Boolean} instance indicating the result of the
	 *         authentication attempt.
	 * @throws AuthenticationFailedException
	 *             never gets thrown in this simple implementation.
	 */
	@Override
	public final Boolean authenticate(final CredentialsUsernamePassword credentials)
		throws AuthenticationFailedException
	{
		// lookup stored password
		final String storedPassword = this.usernamePasswords.get(credentials.username());
		
		/*
		 * if no password found for the given username or passwords don't match,
		 * the authentication failed. Note that authentication logic does
		 * intentionally NOT give any clue about why username and password are
		 * not valid.
		 */
		return storedPassword != null
			&& storedPassword.equals(new String(credentials.password(), StandardCharsets.UTF_8));
	}
	
	/**
	 * An {@link InMemoryAuthenticator}-specific provider type.
	 *
	 * @author XDEV Software (TM)
	 */
	public interface Provider extends AuthenticatorProvider
	{
		/**
		 * {@inheritDoc}
		 */
		@Override
		public InMemoryAuthenticator provideAuthenticator();
	}
	
}