org.opendaylight.netconf.shaded.sshd.server.ServerAuthenticationManager Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.opendaylight.netconf.shaded.sshd.server;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import org.opendaylight.netconf.shaded.sshd.common.NamedFactory;
import org.opendaylight.netconf.shaded.sshd.common.auth.UserAuthFactoriesManager;
import org.opendaylight.netconf.shaded.sshd.common.keyprovider.HostKeyCertificateProvider;
import org.opendaylight.netconf.shaded.sshd.common.keyprovider.KeyPairProviderHolder;
import org.opendaylight.netconf.shaded.sshd.common.util.GenericUtils;
import org.opendaylight.netconf.shaded.sshd.common.util.ValidateUtils;
import org.opendaylight.netconf.shaded.sshd.server.auth.BuiltinUserAuthFactories;
import org.opendaylight.netconf.shaded.sshd.server.auth.UserAuth;
import org.opendaylight.netconf.shaded.sshd.server.auth.UserAuthFactory;
import org.opendaylight.netconf.shaded.sshd.server.auth.gss.GSSAuthenticator;
import org.opendaylight.netconf.shaded.sshd.server.auth.gss.UserAuthGSSFactory;
import org.opendaylight.netconf.shaded.sshd.server.auth.hostbased.HostBasedAuthenticator;
import org.opendaylight.netconf.shaded.sshd.server.auth.keyboard.KeyboardInteractiveAuthenticator;
import org.opendaylight.netconf.shaded.sshd.server.auth.keyboard.UserAuthKeyboardInteractiveFactory;
import org.opendaylight.netconf.shaded.sshd.server.auth.password.PasswordAuthenticator;
import org.opendaylight.netconf.shaded.sshd.server.auth.password.UserAuthPasswordFactory;
import org.opendaylight.netconf.shaded.sshd.server.auth.pubkey.PublickeyAuthenticator;
import org.opendaylight.netconf.shaded.sshd.server.auth.pubkey.UserAuthPublicKeyFactory;
import org.opendaylight.netconf.shaded.sshd.server.session.ServerSession;
/**
* Holds providers and helpers related to the server side authentication process
*
* @author Apache MINA SSHD Project
*/
public interface ServerAuthenticationManager
extends UserAuthFactoriesManager,
KeyPairProviderHolder {
UserAuthPublicKeyFactory DEFAULT_USER_AUTH_PUBLIC_KEY_FACTORY = UserAuthPublicKeyFactory.INSTANCE;
UserAuthGSSFactory DEFAULT_USER_AUTH_GSS_FACTORY = UserAuthGSSFactory.INSTANCE;
UserAuthPasswordFactory DEFAULT_USER_AUTH_PASSWORD_FACTORY = UserAuthPasswordFactory.INSTANCE;
UserAuthKeyboardInteractiveFactory DEFAULT_USER_AUTH_KB_INTERACTIVE_FACTORY = UserAuthKeyboardInteractiveFactory.INSTANCE;
@Override
default void setUserAuthFactoriesNames(Collection names) {
BuiltinUserAuthFactories.ParseResult result = BuiltinUserAuthFactories.parseFactoriesList(names);
List factories = ValidateUtils.checkNotNullAndNotEmpty(
result.getParsedFactories(), "No supported cipher factories: %s", names);
Collection unsupported = result.getUnsupportedFactories();
ValidateUtils.checkTrue(
GenericUtils.isEmpty(unsupported), "Unsupported cipher factories found: %s", unsupported);
setUserAuthFactories(factories);
}
/**
* Retrieve the PublickeyAuthenticator to be used by SSH server. If no authenticator has been
* configured (i.e. this method returns {@code null}), then client authentication requests based on keys will be
* rejected.
*
* @return the {@link PublickeyAuthenticator} or {@code null}
*/
PublickeyAuthenticator getPublickeyAuthenticator();
void setPasswordAuthenticator(PasswordAuthenticator passwordAuthenticator);
/**
* Retrieve the PasswordAuthenticator to be used by the SSH server. If no authenticator has been
* configured (i.e. this method returns {@code null}), then client authentication requests based on passwords will
* be rejected.
*
* @return the {@link PasswordAuthenticator} or {@code null}
*/
PasswordAuthenticator getPasswordAuthenticator();
void setPublickeyAuthenticator(PublickeyAuthenticator publickeyAuthenticator);
/**
* Retrieve the KeyboardInteractiveAuthenticator to be used by the SSH server. If no authenticator has
* been configured (i.e. this method returns {@code null}), then client authentication requests based on this method
* will be rejected.
*
* @return The {@link KeyboardInteractiveAuthenticator} or {@code null}
*/
KeyboardInteractiveAuthenticator getKeyboardInteractiveAuthenticator();
void setKeyboardInteractiveAuthenticator(KeyboardInteractiveAuthenticator interactiveAuthenticator);
/**
* Retrieve the GSSAuthenticator to be used by the SSH server. If no authenticator has been configured
* (i.e. this method returns {@code null}), then client authentication requests based on gssapi will be rejected.
*
* @return the {@link GSSAuthenticator} or {@code null}
*/
GSSAuthenticator getGSSAuthenticator();
void setGSSAuthenticator(GSSAuthenticator gssAuthenticator);
/**
* Retrieve the {@code HostBasedAuthenticator} to be used by the SSH server. If no authenticator has been configured
* (i.e. this method returns {@code null}), then client authentication requests based on this method will be
* rejected.
*
* @return the {@link HostBasedAuthenticator} or {@code null}
*/
HostBasedAuthenticator getHostBasedAuthenticator();
void setHostBasedAuthenticator(HostBasedAuthenticator hostBasedAuthenticator);
/**
* @return a {@link HostKeyCertificateProvider} if available, null as default
*/
HostKeyCertificateProvider getHostKeyCertificateProvider();
void setHostKeyCertificateProvider(HostKeyCertificateProvider provider);
/**
* If user authentication factories already set, then simply returns them. Otherwise, builds the factories list from
* the individual authenticators available for the manager - password public key, keyboard-interactive, GSS, etc...
*
* @param manager The {@link ServerAuthenticationManager} - ignored if {@code null}
* @return The resolved {@link List} of {@link NamedFactory} for the {@link UserAuth}s
* @see #resolveUserAuthFactories(ServerAuthenticationManager, List)
*/
static List resolveUserAuthFactories(ServerAuthenticationManager manager) {
if (manager == null) {
return Collections.emptyList();
} else {
return resolveUserAuthFactories(manager, manager.getUserAuthFactories());
}
}
/**
* If user authentication factories already set, then simply returns them. Otherwise, builds the factories list from
* the individual authenticators available for the manager - password public key, keyboard-interactive, GSS, etc...
*
* @param manager The {@link ServerAuthenticationManager} - ignored if {@code null}
* @param userFactories The currently available {@link UserAuth} factories - if not {@code null}/empty then they
* are used as-is.
* @return The resolved {@link List} of {@link NamedFactory} for the {@link UserAuth}s
*/
static List resolveUserAuthFactories(
ServerAuthenticationManager manager, List userFactories) {
if (GenericUtils.size(userFactories) > 0) {
return userFactories; // use whatever the user decided
}
if (manager == null) {
return Collections.emptyList();
}
List factories = new ArrayList<>();
if (manager.getPasswordAuthenticator() != null) {
factories.add(DEFAULT_USER_AUTH_PASSWORD_FACTORY);
factories.add(DEFAULT_USER_AUTH_KB_INTERACTIVE_FACTORY);
} else if (manager.getKeyboardInteractiveAuthenticator() != null) {
factories.add(DEFAULT_USER_AUTH_KB_INTERACTIVE_FACTORY);
}
if (manager.getPublickeyAuthenticator() != null) {
factories.add(DEFAULT_USER_AUTH_PUBLIC_KEY_FACTORY);
}
if (manager.getGSSAuthenticator() != null) {
factories.add(DEFAULT_USER_AUTH_GSS_FACTORY);
}
return factories;
}
}