com.sun.xml.wss.impl.misc.DefaultRealmAuthenticationAdapter Maven / Gradle / Ivy
/*
* Copyright (c) 1997, 2021 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Distribution License v. 1.0, which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
/*
* DefaultRealmAuthenticationProvider.java
*
* Created on November 12, 2006, 10:22 AM
*
* To change this template, choose Tools | Template Manager
* and open the template in the editor.
*/
package com.sun.xml.wss.impl.misc;
import com.sun.xml.wss.RealmAuthenticationAdapter;
import com.sun.xml.wss.WSITXMLFactory;
import com.sun.xml.wss.XWSSecurityException;
import com.sun.xml.wss.impl.MessageConstants;
import java.io.File;
import java.io.IOException;
import java.security.AccessController;
import java.security.Principal;
import java.security.PrivilegedAction;
import java.util.HashMap;
import javax.security.auth.Subject;
import javax.security.auth.callback.Callback;
import javax.security.auth.callback.CallbackHandler;
import jakarta.security.auth.message.callback.CallerPrincipalCallback;
import jakarta.security.auth.message.callback.PasswordValidationCallback;
import javax.security.auth.x500.X500Principal;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import org.w3c.dom.Document;
import org.w3c.dom.NamedNodeMap;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/**
*
* @author kumar jayanti
*/
public class DefaultRealmAuthenticationAdapter extends RealmAuthenticationAdapter {
private CallbackHandler gfCallbackHandler = null;
private HashMap tomcatUsersXML = null;
private static DocumentBuilderFactory dbf = WSITXMLFactory.createDocumentBuilderFactory(WSITXMLFactory.DISABLE_SECURE_PROCESSING);
private static String classname = "com.sun.enterprise.security.jmac.callback.ContainerCallbackHandler";
/*
static {
dbf.setNamespaceAware(true);
}*/
/** Creates a new instance of DefaultRealmAuthenticationProvider */
public DefaultRealmAuthenticationAdapter() {
if (isGlassfish()) {
gfCallbackHandler = this.loadGFHandler();
} else if (isTomcat()) {
populateTomcatUsersXML();
}
}
private boolean isGlassfish() {
String val = System.getProperty("com.sun.aas.installRoot");
if (val != null) {
return true;
}
return false;
}
private boolean isTomcat() {
String val = System.getProperty("catalina.home");
String val1 = System.getProperty("com.sun.aas.installRoot");
if ((val1 == null) && (val != null)) {
return true;
}
return false;
}
private boolean authenticateFromTomcatUsersXML(
final Subject callerSubject, final String username, final String password)
throws XWSSecurityException {
if (tomcatUsersXML != null) {
String pass = tomcatUsersXML.get(username);
if (pass == null) {
return false;
}
if (pass.equals(password)) {
//populate the subject
AccessController.doPrivileged(new PrivilegedAction<>() {
@Override
public Object run() {
String x500Name = "CN=" + username;
Principal principal = new X500Principal(x500Name);
callerSubject.getPrincipals().add(principal);
// if (password != null) {
// callerSubject.getPrivateCredentials().add(password);
// }
return null; // nothing to return
}
});
return true;
}else {
return false;
}
} else {
throw new XWSSecurityException(
"Internal Error: Username Authentication Failed: Could not Load/Locate tomcat-users.xml, Possible Cause is Application is Not Running on TOMCAT ?");
}
}
private boolean authenticateWithGFCBH(Subject callerSubject, String username, String password)throws XWSSecurityException {
if (gfCallbackHandler != null) {
char[] pwd = (password == null) ? null : password.toCharArray();
PasswordValidationCallback pvCallback =
new PasswordValidationCallback(callerSubject,username, pwd);
Callback[] callbacks = new Callback[] { pvCallback };
try {
gfCallbackHandler.handle(callbacks);
} catch (Exception e) {
throw new XWSSecurityException(e);
}
// zero the password
if (pwd != null)
pvCallback.clearPassword();
boolean result = pvCallback.getResult();
if (result) {
//invoke the CallerPrincipalCallback
CallerPrincipalCallback pCallback = new CallerPrincipalCallback(callerSubject, username);
callbacks = new Callback[] { pCallback };
try {
gfCallbackHandler.handle(callbacks);
} catch (Exception e) {
throw new XWSSecurityException(e);
}
return result;
} else {
return result;
}
} else {
throw new XWSSecurityException(
"Internal Error: Username Authentication Failed: Could not Locate/Load CallbackHandler: " + classname);
}
}
@Override
public boolean authenticate(Subject callerSubject, String username, String password) throws XWSSecurityException {
if (isGlassfish()) {
return authenticateWithGFCBH(callerSubject, username, password);
} else if (isTomcat()) {
return authenticateFromTomcatUsersXML(callerSubject, username, password);
} else {
throw new XWSSecurityException("Error: Could not locate default username validator for the container");
}
}
@Override
public boolean authenticate(Subject callerSubject, String username, String passwordDigest, String nonce, String created) throws XWSSecurityException {
// this is the place from where i can go to GF JDBC Realm
throw new XWSSecurityException("Not Yet Supported: Digest Authentication not yet supported in DefaultRealmAuthenticationAdapter");
}
protected CallbackHandler loadGFHandler() {
Class ret = null;
try {
ClassLoader loader = Thread.currentThread().getContextClassLoader();
try {
if (loader != null) {
ret = loader.loadClass(classname);
}
}catch(ClassNotFoundException e) {
// throw new RuntimeException(e);
}
if (ret == null) {
// if context classloader didnt work, try this
loader = this.getClass().getClassLoader();
ret = loader.loadClass(classname);
}
if (ret != null) {
CallbackHandler handler = (CallbackHandler)ret.newInstance();
return handler;
}
} catch (ClassNotFoundException e) {
// ignore
//throw new RuntimeException(e);
} catch(InstantiationException e) {
//throw new RuntimeException(e);
} catch(IllegalAccessException ex) {
//throw new RuntimeException(ex);
}
//throw new RuntimeException("Internal Error: Could Not Load CallbackHandler Class: " + classname);
return null;
}
private void populateTomcatUsersXML() {
String catalinaHome = System.getProperty("catalina.home");
String tomcat_user_xml =
catalinaHome + File.separator + "conf" + File.separator + "tomcat-users.xml";
try {
File tomcatUserXML = new File(tomcat_user_xml);
if (!tomcatUserXML.exists()) {
// this may not be a TOMCAT system although catalina.home is set.
//TODO Issue a FINE LOG here
return;
}
DocumentBuilder builder = dbf.newDocumentBuilder();
Document doc = builder.parse(tomcatUserXML);
NodeList nl = doc.getElementsByTagName("user");
tomcatUsersXML = new HashMap<>();
for (int i=0; i