aaa-shiro/impl/src/main/java/org/opendaylight/aaa/impl/shiro/realm/ODLJndiLdapRealmAuthNOnly.java

   1 /*
   2  * Copyright (c) 2016 Brocade Communications Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8
   9 package org.opendaylight.aaa.shiro.realm;
  10
  11 import org.apache.shiro.authc.AuthenticationException;
  12 import org.apache.shiro.authc.AuthenticationInfo;
  13 import org.apache.shiro.authc.AuthenticationToken;
  14 import org.apache.shiro.realm.ldap.JndiLdapRealm;
  15 import org.opendaylight.aaa.shiro.accounting.Accounter;
  16 import org.slf4j.Logger;
  17 import org.slf4j.LoggerFactory;
  18
  19 /**
  20  * Wrapper class for <code>org.apache.shiro.realm.ldap.JndiLdapRealm</code>.
  21  * This implementation disables Authorization so any LDAP user is able to access
  22  * server resources. This is particularly useful for quickly prototyping ODL
  23  * without worrying about resolving LDAP attributes (groups) to OpenDaylight
  24  * roles.
  25  *
  26  * The motivation for subclassing Shiro's implementation is two-fold: 1) Enhance
  27  * the default logging of Shiro. This allows us to more easily log incoming
  28  * connections, providing some security auditing. 2) Provide a common package in
  29  * the classpath for ODL supported Realm implementations (i.e.,
  30  * <code>org.opendaylight.aaa.shiro.realm</code>), which consolidates the number
  31  * of <code>Import-Package</code> statements consumers need to enumerate. For
  32  * example, the netconf project only needs to import
  33  * <code>org.opendaylight.aaa.shiro.realm</code>, and does not need to worry
  34  * about importing Shiro packages.
  35  *
  36  * @author Ryan Goulding (ryandgoulding@gmail.com)
  37  *
  38  */
  39 public class ODLJndiLdapRealmAuthNOnly extends JndiLdapRealm {
  40
  41     private static final Logger LOG = LoggerFactory.getLogger(ODLJndiLdapRealmAuthNOnly.class);
  42
  43     private static final String LDAP_CONNECTION_MESSAGE = "AAA LDAP connection from ";
  44
  45     /*
  46      * Adds debugging information surrounding creation of ODLJndiLdapRealm
  47      */
  48     public ODLJndiLdapRealmAuthNOnly() {
  49         LOG.debug("Creating ODLJndiLdapRealmAuthNOnly");
  50     }
  51
  52     /*
  53      * (non-Javadoc) Overridden to expose important audit trail information for
  54      * accounting.
  55      *
  56      * @see
  57      * org.apache.shiro.realm.ldap.JndiLdapRealm#doGetAuthenticationInfo(org
  58      * .apache.shiro.authc.AuthenticationToken)
  59      */
  60     @Override
  61     protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken token)
  62             throws AuthenticationException {
  63
  64         try {
  65             final String username = getUsername(token);
  66             logIncomingConnection(username);
  67             return super.doGetAuthenticationInfo(token);
  68         } catch (ClassCastException e) {
  69             LOG.info("Couldn't service the LDAP connection", e);
  70         }
  71         return null;
  72     }
  73
  74     /**
  75      * Logs an incoming LDAP connection
  76      *
  77      * @param username
  78      *            the requesting user
  79      */
  80     protected void logIncomingConnection(final String username) {
  81         final String message = LDAP_CONNECTION_MESSAGE + username;
  82         LOG.info(message);
  83         Accounter.output(message);
  84     }
  85
  86     /**
  87      * Extracts the username from <code>token</code>
  88      *
  89      * @param token Which possibly contains a username
  90      * @return the username if it can be extracted
  91      * @throws ClassCastException
  92      *             The incoming token is not username/password (i.e., X.509
  93      *             certificate)
  94      */
  95     public static String getUsername(AuthenticationToken token) throws ClassCastException {
  96         if (null == token) {
  97             return null;
  98         }
  99         return (String) token.getPrincipal();
 100     }
 101 }