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