opendaylight/netconf/netconf-ssh/src/main/java/org/opendaylight/controller/netconf/ssh/osgi/AuthProviderTracker.java

   1 /*
   2  * Copyright (c) 2014 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
   9 package org.opendaylight.controller.netconf.ssh.osgi;
  10
  11 import com.google.common.base.Preconditions;
  12 import org.apache.sshd.server.PasswordAuthenticator;
  13 import org.apache.sshd.server.session.ServerSession;
  14 import org.opendaylight.controller.netconf.auth.AuthConstants;
  15 import org.opendaylight.controller.netconf.auth.AuthProvider;
  16 import org.osgi.framework.BundleContext;
  17 import org.osgi.framework.ServiceReference;
  18 import org.osgi.util.tracker.ServiceTracker;
  19 import org.osgi.util.tracker.ServiceTrackerCustomizer;
  20 import org.slf4j.Logger;
  21 import org.slf4j.LoggerFactory;
  22
  23 final class AuthProviderTracker implements ServiceTrackerCustomizer<AuthProvider, AuthProvider>, PasswordAuthenticator {
  24     private static final Logger LOG = LoggerFactory.getLogger(AuthProviderTracker.class);
  25
  26     private final BundleContext bundleContext;
  27
  28     private Integer maxPreference;
  29     private final ServiceTracker<AuthProvider, AuthProvider> listenerTracker;
  30     private AuthProvider authProvider;
  31
  32     public AuthProviderTracker(final BundleContext bundleContext) {
  33         this.bundleContext = bundleContext;
  34         listenerTracker = new ServiceTracker<>(bundleContext, AuthProvider.class, this);
  35         listenerTracker.open();
  36     }
  37
  38     @Override
  39     public AuthProvider addingService(final ServiceReference<AuthProvider> reference) {
  40         LOG.trace("Service {} added", reference);
  41         final AuthProvider authService = bundleContext.getService(reference);
  42         final Integer newServicePreference = getPreference(reference);
  43         if(isBetter(newServicePreference)) {
  44             maxPreference = newServicePreference;
  45             this.authProvider = authService;
  46         }
  47         return authService;
  48     }
  49
  50     private Integer getPreference(final ServiceReference<AuthProvider> reference) {
  51         final Object preferenceProperty = reference.getProperty(AuthConstants.SERVICE_PREFERENCE_KEY);
  52         return preferenceProperty == null ? Integer.MIN_VALUE : Integer.valueOf(preferenceProperty.toString());
  53     }
  54
  55     private boolean isBetter(final Integer newServicePreference) {
  56         Preconditions.checkNotNull(newServicePreference);
  57         if(maxPreference == null) {
  58             return true;
  59         }
  60
  61         return newServicePreference > maxPreference;
  62     }
  63
  64     @Override
  65     public void modifiedService(final ServiceReference<AuthProvider> reference, final AuthProvider service) {
  66         final AuthProvider authService = bundleContext.getService(reference);
  67         final Integer newServicePreference = getPreference(reference);
  68         if(isBetter(newServicePreference)) {
  69             LOG.trace("Replacing modified service {} in netconf SSH.", reference);
  70             this.authProvider = authService;
  71         }
  72     }
  73
  74     @Override
  75     public void removedService(final ServiceReference<AuthProvider> reference, final AuthProvider service) {
  76         LOG.trace("Removing service {} from netconf SSH. {}", reference,
  77                 " SSH won't authenticate users until AuthProvider service will be started.");
  78         maxPreference = null;
  79         this.authProvider = null;
  80     }
  81
  82     public void stop() {
  83         listenerTracker.close();
  84         // sshThread should finish normally since sshServer.close stops processing
  85     }
  86
  87     @Override
  88     public boolean authenticate(final String username, final String password, final ServerSession session) {
  89         return authProvider == null ? false : authProvider.authenticated(username, password);
  90     }
  91 }