org.apache.sshd.client.config.hosts.DefaultConfigFileHostEntryResolver Maven / Gradle / Ivy
Go to download
This artifact provides a single jar that contains all classes required to use remote EJB and JMS, including
all dependencies. It is intended for use by those not using maven, maven users should just import the EJB and
JMS BOM's instead (shaded JAR's cause lots of problems with maven, as it is very easy to inadvertently end up
with different versions on classes on the class path).
The newest version!
/*
* 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.apache.sshd.client.config.hosts;
import java.io.IOException;
import java.nio.file.LinkOption;
import java.nio.file.Path;
import java.util.Collections;
import java.util.List;
import java.util.Map;
/**
* Monitors the {@code ~/.ssh/config} file of the user currently running the client, re-loading it if necessary. It also
* (optionally) enforces the same permissions regime as {@code OpenSSH}
*
* @author Apache MINA SSHD Project
*/
public class DefaultConfigFileHostEntryResolver extends ConfigFileHostEntryResolver {
/**
* The default instance that enforces the same permissions regime as {@code OpenSSH}
*/
public static final DefaultConfigFileHostEntryResolver INSTANCE = new DefaultConfigFileHostEntryResolver(true);
private final boolean strict;
/**
* @param strict If {@code true} then makes sure that the containing folder has 0700 access and the file 0644.
* Note: for Windows it does not check these permissions
* @see #validateStrictConfigFilePermissions(Path, LinkOption...)
*/
public DefaultConfigFileHostEntryResolver(boolean strict) {
this(HostConfigEntry.getDefaultHostConfigFile(), strict);
}
public DefaultConfigFileHostEntryResolver(Path path, boolean strict, LinkOption... options) {
super(path, options);
this.strict = strict;
}
/**
* @return If {@code true} then makes sure that the containing folder has 0700 access and the file 0644.
* Note: for Windows it does not check these permissions
* @see #validateStrictConfigFilePermissions(Path, LinkOption...)
*/
public final boolean isStrict() {
return strict;
}
@Override
protected List reloadHostConfigEntries(Path path, String host, int port, String username, String proxyJump)
throws IOException {
if (isStrict()) {
if (log.isDebugEnabled()) {
log.debug("reloadHostConfigEntries({}@{}:{}/{}) check permissions of {}", username, host, port, proxyJump,
path);
}
Map.Entry violation = validateStrictConfigFilePermissions(path);
if (violation != null) {
log.warn("reloadHostConfigEntries({}@{}:{}/{}) invalid file={} permissions: {}",
username, host, port, proxyJump, path, violation.getKey());
updateReloadAttributes();
return Collections.emptyList();
}
}
return super.reloadHostConfigEntries(path, host, port, username, proxyJump);
}
}