com.oneandone.sshconfig.file.SSHConfig Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of SSHConfig Show documentation
Show all versions of SSHConfig Show documentation
Automatically maintain SSH configuration
/*
* Copyright 2018 1&1 Internet SE.
*
* Licensed 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 com.oneandone.sshconfig.file;
import java.io.IOException;
import java.nio.charset.Charset;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.Comparator;
import java.util.List;
import java.util.regex.Pattern;
import java.util.stream.Stream;
import com.oneandone.sshconfig.bind.Host;
import com.oneandone.sshconfig.validation.ValidationDelegate;
import lombok.extern.slf4j.Slf4j;
import org.jboss.logging.MDC;
/**
* The SSH configuration file. Separates the tool-maintained part
* and the original human-maintained part.
* @author Stephan Fuhrmann
*/
@Slf4j
public final class SSHConfig {
/** The charset to encode the config on disc with. */
private static final String CHARSET = "UTF-8";
/** The file in which the config is located. */
private Path file;
/** Configuration file lines not to process. */
private List lines;
/** Configuration file lines to process. */
private List own;
/** Pattern for each entry start.
* @see #ENTRY_BEGIN_FORMAT
*/
private static final String ENTRY_BEGIN_PATTERN =
"# <<< BEGIN\\{[a-fA-F0-9-]*\\}";
/** Pattern for each entry end.
* @see #ENTRY_END_FORMAT
*/
private static final String ENTRY_END_PATTERN =
"# >>> END\\{[a-fA-F0-9-]*\\}";
/** Format for each entry start.
* @see #ENTRY_BEGIN_PATTERN
*/
private static final String ENTRY_BEGIN_FORMAT =
"# <<< BEGIN{%s}";
/** Format for each entry end.
* @see #ENTRY_END_PATTERN
*/
private static final String ENTRY_END_FORMAT =
"# >>> END{%s}";
/** Java beans validation delegate. */
private ValidationDelegate validationDelegate;
/** Private constructor. */
private SSHConfig() {
this.validationDelegate = new ValidationDelegate();
}
/**
* Load the ssh configuration from hard disk.
* @param f the path to load the config from.
* @return the parsed config.
* @throws IOException if reading the configuration goes wrong.
*/
public static SSHConfig fromPath(
final Path f) throws IOException {
SSHConfig config = new SSHConfig();
config.file = f;
if (Files.exists(f)) {
List lines = Files.readAllLines(
f,
Charset.forName(CHARSET));
config.lines = lines;
} else {
config.lines = new ArrayList<>();
}
return config;
}
/** Save the file to the pre-configured location.
* @throws IOException if writing the configuration goes wrong.
* */
public void save() throws IOException {
save(true, true, file);
}
/** Save the file to the defined location.
* @param includeOwnPart include the generated host entries.
* @param includePlainPart include the non-generated ssh config directives.
* @param out the path to store the data in.
* @throws IOException if writing the configuration goes wrong.
* */
public void save(final boolean includeOwnPart,
final boolean includePlainPart,
final Path out) throws IOException {
Backup.moveToBackup(out);
List allLines = new ArrayList<>();
if (includePlainPart) {
allLines.addAll(lines);
}
if (includeOwnPart) {
allLines.addAll(own);
}
Files.write(out, allLines, Charset.forName(CHARSET));
}
/**
* Set the own configured hosts.
* @param hosts the hosts to set.
*/
public void pushOwn(
final List hosts) {
removeOwnEntries();
validationDelegate.verify(hosts);
own = generateOwnEntries(hosts);
}
/**
* Generate the own configured entries.
* @param hosts the hosts to generate.
* @return the list of lines for the own entries.
*/
private static List generateOwnEntries(
final List hosts) {
List result = new ArrayList<>();
for (Host h : hosts) {
MDC.put("id", h.getId());
MDC.put("name", h.getName());
if (!h.getEnabled()) {
log.info("Skipping {}, disabled", h.getName());
continue;
}
List hostData = new ArrayList<>();
hostData.add(String.format(ENTRY_BEGIN_FORMAT,
h.getId().toString()));
hostData.add(String.format("Host %s", h.getName()));
hostData.add(String.format("\tHostname %s", h.getFqdn()));
Stream.of(h.getIps()).forEach(
ip -> hostData.add(String.format("\tHostname %s", ip)));
if (h.getUser() != null) {
hostData.add(String.format("\tUser %s", h.getUser()));
}
hostData.add(String.format(ENTRY_END_FORMAT, h.getId().toString()));
log.debug("Host entry: {}", hostData);
result.addAll(hostData);
}
MDC.remove("id");
MDC.remove("name");
return result;
}
/** Remove own entries from {@link #lines}. */
private void removeOwnEntries() {
List removeIndexes = new ArrayList<>();
List ownEntries = new ArrayList<>();
Pattern begin = Pattern.compile(ENTRY_BEGIN_PATTERN);
Pattern end = Pattern.compile(ENTRY_END_PATTERN);
boolean inEntry = false;
for (int i = 0; i < lines.size(); i++) {
String line = lines.get(i);
if (begin.matcher(line).matches()) {
inEntry = true;
log.debug("Found start: {}", line);
}
if (inEntry) {
ownEntries.add(line);
removeIndexes.add(i);
}
if (end.matcher(line).matches()) {
inEntry = false;
log.debug("Found end: {}", line);
}
}
log.debug("Found {} lines to remove", removeIndexes.size());
removeIndexes
.stream()
.sorted(Comparator.comparingInt(a -> -a))
.forEach(i -> lines.remove(i.intValue()));
own = ownEntries;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy