org.opendaylight.aaa.shiro.realm.ODLJndiLdapRealmAuthNOnly Maven / Gradle / Ivy
/*
* Copyright (c) 2016 - 2017 Brocade Communications Systems, Inc. and others. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v1.0 which accompanies this distribution,
* and is available at http://www.eclipse.org/legal/epl-v10.html
*/
package org.opendaylight.aaa.shiro.realm;
import org.apache.shiro.authc.AuthenticationException;
import org.apache.shiro.authc.AuthenticationInfo;
import org.apache.shiro.authc.AuthenticationToken;
import org.apache.shiro.realm.ldap.DefaultLdapRealm;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Wrapper class for org.apache.shiro.realm.ldap.JndiLdapRealm.
* This implementation disables Authorization so any LDAP user is able to access
* server resources. This is particularly useful for quickly prototyping ODL
* without worrying about resolving LDAP attributes (groups) to OpenDaylight
* roles.
*
*
* The motivation for subclassing Shiro's implementation is two-fold: 1) Enhance
* the default logging of Shiro. This allows us to more easily log incoming
* connections, providing some security auditing. 2) Provide a common package in
* the classpath for ODL supported Realm implementations (i.e.,
* org.opendaylight.aaa.shiro.realm), which consolidates the number
* of Import-Package statements consumers need to enumerate. For
* example, the netconf project only needs to import
* org.opendaylight.aaa.shiro.realm, and does not need to worry
* about importing Shiro packages.
*/
public class ODLJndiLdapRealmAuthNOnly extends DefaultLdapRealm {
private static final Logger LOG = LoggerFactory.getLogger(ODLJndiLdapRealmAuthNOnly.class);
/*
* Adds debugging information surrounding creation of ODLJndiLdapRealm
*/
public ODLJndiLdapRealmAuthNOnly() {
LOG.info("ODLJndiLdapRealmAuthNOnly realm created");
}
/*
* (non-Javadoc) Overridden to expose important audit trail information for
* accounting.
*
* @see
* org.apache.shiro.realm.ldap.JndiLdapRealm#doGetAuthenticationInfo(org
* .apache.shiro.authc.AuthenticationToken)
*/
@Override
protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken token)
throws AuthenticationException {
try {
final String username = getUsername(token);
logIncomingConnection(username);
return super.doGetAuthenticationInfo(token);
} catch (ClassCastException e) {
LOG.info("Couldn't service the LDAP connection", e);
}
return null;
}
/**
* Logs an incoming LDAP connection.
*
* @param username
* the requesting user
*/
protected void logIncomingConnection(final String username) {
LOG.info("AAA LDAP connection from {}", username);
}
/**
* Extracts the username from token.
*
* @param token Which possibly contains a username
* @return the username if it can be extracted
* @throws ClassCastException
* The incoming token is not username/password (i.e., X.509
* certificate)
*/
public static String getUsername(AuthenticationToken token) throws ClassCastException {
if (null == token) {
return null;
}
return (String) token.getPrincipal();
}
}