es.gob.jmulticard.ui.passwordcallback.gui.JSecurePasswordLabel Maven / Gradle / Ivy

Go to download
/*
 * Controlador Java de la Secretaria de Estado de Administraciones Publicas
 * para el DNI electronico.
 *
 * El Controlador Java para el DNI electronico es un proveedor de seguridad de JCA/JCE
 * que permite el acceso y uso del DNI electronico en aplicaciones Java de terceros
 * para la realizacion de procesos de autenticacion, firma electronica y validacion
 * de firma. Para ello, se implementan las funcionalidades KeyStore y Signature para
 * el acceso a los certificados y claves del DNI electronico, asi como la realizacion
 * de operaciones criptograficas de firma con el DNI electronico. El Controlador ha
 * sido disenado para su funcionamiento independiente del sistema operativo final.
 *
 * Copyright (C) 2012 Direccion General de Modernizacion Administrativa, Procedimientos
 * e Impulso de la Administracion Electronica
 *
 * Este programa es software libre y utiliza un licenciamiento dual (LGPL 2.1+
 * o EUPL 1.1+), lo cual significa que los usuarios podran elegir bajo cual de las
 * licencias desean utilizar el codigo fuente. Su eleccion debera reflejarse
 * en las aplicaciones que integren o distribuyan el Controlador, ya que determinara
 * su compatibilidad con otros componentes.
 *
 * El Controlador puede ser redistribuido y/o modificado bajo los terminos de la
 * Lesser GNU General Public License publicada por la Free Software Foundation,
 * tanto en la version 2.1 de la Licencia, o en una version posterior.
 *
 * El Controlador puede ser redistribuido y/o modificado bajo los terminos de la
 * European Union Public License publicada por la Comision Europea,
 * tanto en la version 1.1 de la Licencia, o en una version posterior.
 *
 * Deberia recibir una copia de la GNU Lesser General Public License, si aplica, junto
 * con este programa. Si no, consultelo en .
 *
 * Deberia recibir una copia de la European Union Public License, si aplica, junto
 * con este programa. Si no, consultelo en .
 *
 * Este programa es distribuido con la esperanza de que sea util, pero
 * SIN NINGUNA GARANTIA; incluso sin la garantia implicita de comercializacion
 * o idoneidad para un proposito particular.
 */
package es.gob.jmulticard.ui.passwordcallback.gui;

import java.awt.Color;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.FocusEvent;
import java.awt.event.FocusListener;
import java.awt.event.InputEvent;
import java.awt.event.KeyAdapter;
import java.awt.event.KeyEvent;
import java.awt.event.MouseAdapter;
import java.awt.event.MouseEvent;

import javax.swing.BorderFactory;
import javax.swing.JLabel;
import javax.swing.Timer;

/** Componente basado en JLabel para capturar contraseñas usando
 * únicamente arrays de char y restringiendo los caracteres aceptados.
 * @author Jose Luis Escanciano. */
final class JSecurePasswordLabel extends JLabel {

	private static final long serialVersionUID = -4343328489072897605L;

	private transient final int delay = 500;

	final char[] pass;
	char[] getPass() {
	    return this.pass;
	}

	private final int maxChars;
	transient int passwordLength;

	private final Timer timer;
	Timer getTimer() {
	    return this.timer;
	}

	private boolean showCursor;

	int getMaxChars() {
		return this.maxChars;
	}

	/** Constructor.
	 * @param maxLength Longitud máxima que puede tener la contraseña. */
	JSecurePasswordLabel(final int maxLength) {
		this.maxChars = maxLength;
		this.pass = new char[maxLength];
		clearPassword();
		addKeyListener(
			new KeyAdapter() {

				@Override
				public void keyTyped(final KeyEvent ke) {
					// Caracteres validos y con longitud valida de password.
					if (getPasswordLength() < getMaxChars()) {
						// No se escriben: Back space, Supr, Enter, Tab y CTRL+Letra
						if(ke.getKeyChar() != KeyEvent.VK_BACK_SPACE &&
						   ke.getKeyChar() != KeyEvent.VK_DELETE &&
						   ke.getKeyChar() != KeyEvent.VK_ENTER &&
						   ke.getKeyChar() != KeyEvent.VK_TAB &&
						   ke.getModifiersEx() != InputEvent.CTRL_DOWN_MASK &&
						   ke.getModifiersEx() != InputEvent.ALT_DOWN_MASK) {
							JSecurePasswordLabel.this.getPass()[JSecurePasswordLabel.this.passwordLength++] = ke.getKeyChar();
							ke.setKeyChar('\0');
						}
					}
					updateText();
				}

				@Override
				public void keyPressed(final KeyEvent arg0) {
					//Borrar
					if (arg0.getKeyCode() == KeyEvent.VK_BACK_SPACE && getPasswordLength() > 0) {
						clearPassword(getPasswordLength() - 1);
					}
					//Supr
					else if(arg0.getKeyCode() == KeyEvent.VK_DELETE) {
						clearPassword();
					}
					updateText();
				}
			}
		);
		addFocusListener(
			new FocusListener() {
				@Override
				public void focusGained(final FocusEvent arg0) {
					JSecurePasswordLabel.this.setBackground(Color.WHITE);
					JSecurePasswordLabel.this.getTimer().start();
				}

				@Override
				public void focusLost(final FocusEvent arg0) {
					JSecurePasswordLabel.this.setShowCursor(false);
					JSecurePasswordLabel.this.setBackground(getParent().getBackground());
					JSecurePasswordLabel.this.getTimer().stop();
					JSecurePasswordLabel.this.updateText();
				}
			}
		);
		addMouseListener(
			new MouseAdapter() {
				@Override
				public void mouseClicked(final MouseEvent e) {
					JSecurePasswordLabel.this.requestFocus();
				}
			}
		);
		setFocusable(true);
		setOpaque(true);
		setBackground(Color.WHITE);
		setBorder(BorderFactory.createLoweredBevelBorder());
		setShowCursor(false);
		this.timer = new Timer(
			this.delay,
			new ActionListener() {
				@Override
				public void actionPerformed(final ActionEvent arg0) {
					if (arg0.getSource().equals(getTimer()) && hasFocus()) {
						JSecurePasswordLabel.this.setShowCursor(!getShowCursor());
						JSecurePasswordLabel.this.updateText();
					}
				}
			}
		);
		this.timer.stop();
	}

	/** Muestra un asterisco por cada caracter de la contraseña. */
	synchronized void updateText() {
		final StringBuilder text = new StringBuilder(" "); //$NON-NLS-1$
		for(int i = 0; i < this.passwordLength; i++) {
			text.append('*');
		}
		text.append(getShowCursor() ? "|" : " "); //$NON-NLS-1$ //$NON-NLS-2$
		setText(text.toString());
	}

	/** Establece a ceros ('\0') toda la contraseña. */
	void clearPassword() {
		clearPassword(0);
	}

	/** Establece a ceros ('\0') toda la contraseña a partir de una posición inicial
	 * @param position Posición inicial */
	void clearPassword(final int position) {
		for(int i = position; i < this.pass.length; i++) {
			this.pass[i] = '\0';
		}
		this.passwordLength = position;
		updateText();
	}

	/** Retorna la contraseña introducida. Tras llamar a este método, el Password del componente se vacía.
	 * @return Contraseña introducida en el componente. */
	char[] getPassword() {
		//Nos quedamos con el password valido, el resto lo descartamos
		final char[] returned = new char[this.passwordLength];
		for(int i = 0; i < this.passwordLength; i++){
			returned[i] = this.pass[i];
		}
		clearPassword();
		return returned;
	}

	/** Retorna la longitud de la contraseña introducida.
	 * @return Longitud de la contraseña introducida. */
	int getPasswordLength(){
		return this.passwordLength;
	}

	/** Setter privado para el campo showCursor que indica si ha de mostrarse el cursor o no.
	 * @param show Si ha de mostrarse el cursor o no. */
	synchronized void setShowCursor(final boolean show){
		this.showCursor = show;
	}

	/** Getter privado para el campo showCursor que indica si ha de mostrarse el cursor o no.
	 * @return Si ha de mostrarse el cursor o no. */
	synchronized boolean getShowCursor(){
		return this.showCursor;
	}
}