opendaylight/netconf/netconf-usermanager/src/main/java/org/opendaylight/controller/netconf/auth/usermanager/AuthProviderImpl.java

   1 /*
   2  * Copyright (c) 2013 Cisco 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 package org.opendaylight.controller.netconf.auth.usermanager;
   9
  10 import com.google.common.annotations.VisibleForTesting;
  11 import org.opendaylight.controller.netconf.auth.AuthProvider;
  12 import org.opendaylight.controller.sal.authorization.AuthResultEnum;
  13 import org.opendaylight.controller.usermanager.IUserManager;
  14 import org.osgi.framework.BundleContext;
  15 import org.osgi.framework.ServiceReference;
  16 import org.osgi.util.tracker.ServiceTracker;
  17 import org.osgi.util.tracker.ServiceTrackerCustomizer;
  18 import org.slf4j.Logger;
  19 import org.slf4j.LoggerFactory;
  20
  21 /**
  22  * AuthProvider implementation delegating to AD-SAL UserManager instance.
  23  */
  24 public class AuthProviderImpl implements AuthProvider {
  25     private static final Logger LOG = LoggerFactory.getLogger(AuthProviderImpl.class);
  26
  27     private IUserManager nullableUserManager;
  28
  29     public AuthProviderImpl(final BundleContext bundleContext) {
  30
  31         final ServiceTrackerCustomizer<IUserManager, IUserManager> customizer = new ServiceTrackerCustomizer<IUserManager, IUserManager>() {
  32             @Override
  33             public IUserManager addingService(final ServiceReference<IUserManager> reference) {
  34                 LOG.trace("UerManager {} added", reference);
  35                 nullableUserManager = bundleContext.getService(reference);
  36                 return nullableUserManager;
  37             }
  38
  39             @Override
  40             public void modifiedService(final ServiceReference<IUserManager> reference, final IUserManager service) {
  41                 LOG.trace("Replacing modified UerManager {}", reference);
  42                 nullableUserManager = service;
  43             }
  44
  45             @Override
  46             public void removedService(final ServiceReference<IUserManager> reference, final IUserManager service) {
  47                 LOG.trace("Removing UerManager {}. This AuthProvider will fail to authenticate every time", reference);
  48                 synchronized (AuthProviderImpl.this) {
  49                     nullableUserManager = null;
  50                 }
  51             }
  52         };
  53         final ServiceTracker<IUserManager, IUserManager> listenerTracker = new ServiceTracker<>(bundleContext, IUserManager.class, customizer);
  54         listenerTracker.open();
  55     }
  56
  57     /**
  58      * Authenticate user. This implementation tracks IUserManager and delegates the decision to it. If the service is not
  59      * available, IllegalStateException is thrown.
  60      */
  61     @Override
  62     public synchronized boolean authenticated(final String username, final String password) {
  63         if (nullableUserManager == null) {
  64             LOG.warn("Cannot authenticate user '{}', user manager service is missing", username);
  65             throw new IllegalStateException("User manager service is not available");
  66         }
  67         final AuthResultEnum authResult = nullableUserManager.authenticate(username, password);
  68         LOG.debug("Authentication result for user '{}' : {}", username, authResult);
  69         return authResult.equals(AuthResultEnum.AUTH_ACCEPT) || authResult.equals(AuthResultEnum.AUTH_ACCEPT_LOC);
  70     }
  71
  72     @VisibleForTesting
  73     synchronized void setNullableUserManager(final IUserManager nullableUserManager) {
  74         this.nullableUserManager = nullableUserManager;
  75     }
  76 }