/*
* JBoss, Home of Professional Open Source.
* Copyright 2006, Red Hat Middleware LLC, and individual contributors
* as indicated by the @author tags. See the copyright.txt file in the
* distribution for a full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.picketbox.datasource.security;
import java.security.Principal;
import java.security.acl.Group;
import java.util.Map;
import javax.resource.spi.security.PasswordCredential;
import javax.security.auth.Subject;
import javax.security.auth.callback.CallbackHandler;
import javax.security.auth.login.LoginException;
import org.jboss.security.PicketBoxLogger;
import org.jboss.security.PicketBoxMessages;
import org.jboss.security.SimplePrincipal;
import org.jboss.security.vault.SecurityVaultException;
import org.jboss.security.vault.SecurityVaultUtil;
/**
* A simple login module that simply associates the principal specified
* in the module options with any subject authenticated against the module.
* The type of Principal class used is
* <code>org.jboss.security.SimplePrincipal.</code>
* <p>
* If no principal option is specified a principal with the name of 'guest'
* is used.
*
* @see org.jboss.security.SimpleGroup
* @see org.jboss.security.SimplePrincipal
*
* @author Scott.Stark@jboss.org
* @author <a href="mailto:d_jencks@users.sourceforge.net">David Jencks</a>
* @version $Revision: 71545 $
*/
@SuppressWarnings("unchecked")
public class ConfiguredIdentityLoginModule extends AbstractPasswordCredentialLoginModule
{
private String principalName;
private String userName;
private String password;
public ConfiguredIdentityLoginModule()
{
}
@Override
public void initialize(Subject subject, CallbackHandler handler, Map<String, ?> sharedState, Map<String, ?> options)
{
super.initialize(subject, handler, sharedState, options);
principalName = (String) options.get("principal");
if (principalName == null)
{
throw new IllegalArgumentException(PicketBoxMessages.MESSAGES.missingRequiredModuleOptionMessage("principal"));
}
userName = (String) options.get("userName");
if (userName == null)
{
userName = (String) options.get("username");
if (userName == null)
throw new IllegalArgumentException(PicketBoxMessages.MESSAGES.missingRequiredModuleOptionMessage("username"));
}
password = (String) options.get("password");
if (password == null)
{
PicketBoxLogger.LOGGER.warnModuleCreationWithEmptyPassword();
password = "";
}
else
{
if(SecurityVaultUtil.isVaultFormat(password))
{
try
{
password = SecurityVaultUtil.getValueAsString(password);
}
catch (SecurityVaultException e)
{
throw new RuntimeException(e);
}
}
}
PicketBoxLogger.LOGGER.debugModuleOption("principal", principalName);
PicketBoxLogger.LOGGER.debugModuleOption("username", userName);
PicketBoxLogger.LOGGER.debugModuleOption("password", password);
}
@Override
public boolean login() throws LoginException
{
PicketBoxLogger.LOGGER.traceBeginLogin();
if (super.login())
return true;
Principal principal = new SimplePrincipal(principalName);
SubjectActions.addPrincipals(subject, principal);
// Put the principal name into the sharedState map
sharedState.put("javax.security.auth.login.name", principalName);
PasswordCredential cred = new PasswordCredential(userName, password.toCharArray());
SubjectActions.addCredentials(subject, cred);
super.loginOk = true;
return true;
}
protected Principal getIdentity()
{
PicketBoxLogger.LOGGER.traceBeginGetIdentity(principalName);
Principal principal = new SimplePrincipal(principalName);
return principal;
}
/** This method simply returns an empty array of Groups which means that
no role based permissions are assigned.
*/
protected Group[] getRoleSets() throws LoginException
{
PicketBoxLogger.LOGGER.traceBeginGetRoleSets();
return new Group[] {};
}
}