1 /*
2 * Copyright (C) 2018, Thomas Wolf <thomas.wolf@paranor.ch>
3 * and other copyright owners as documented in the project's IP log.
4 *
5 * This program and the accompanying materials are made available
6 * under the terms of the Eclipse Distribution License v1.0 which
7 * accompanies this distribution, is reproduced below, and is
8 * available at http://www.eclipse.org/org/documents/edl-v10.php
9 *
10 * All rights reserved.
11 *
12 * Redistribution and use in source and binary forms, with or
13 * without modification, are permitted provided that the following
14 * conditions are met:
15 *
16 * - Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 *
19 * - Redistributions in binary form must reproduce the above
20 * copyright notice, this list of conditions and the following
21 * disclaimer in the documentation and/or other materials provided
22 * with the distribution.
23 *
24 * - Neither the name of the Eclipse Foundation, Inc. nor the
25 * names of its contributors may be used to endorse or promote
26 * products derived from this software without specific prior
27 * written permission.
28 *
29 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
30 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
31 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
32 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
34 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
35 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
36 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
37 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
38 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
40 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
41 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42 */
43 package org.eclipse.jgit.internal.transport.sshd;
44
45 import static org.eclipse.jgit.internal.transport.ssh.OpenSshConfigFile.flag;
46 import static org.eclipse.jgit.internal.transport.ssh.OpenSshConfigFile.positive;
47
48 import java.io.File;
49 import java.io.IOException;
50 import java.util.Map;
51 import java.util.TreeMap;
52
53 import org.apache.sshd.client.config.hosts.HostConfigEntry;
54 import org.apache.sshd.client.config.hosts.HostConfigEntryResolver;
55 import org.apache.sshd.common.util.net.SshdSocketAddress;
56 import org.eclipse.jgit.annotations.NonNull;
57 import org.eclipse.jgit.internal.transport.ssh.OpenSshConfigFile;
58 import org.eclipse.jgit.internal.transport.ssh.OpenSshConfigFile.HostEntry;
59 import org.eclipse.jgit.transport.SshConstants;
60
61 /**
62 * A {@link HostConfigEntryResolver} adapted specifically for JGit.
63 * <p>
64 * We use our own config file parser and entry resolution since the default
65 * {@link org.apache.sshd.client.config.hosts.ConfigFileHostEntryResolver
66 * ConfigFileHostEntryResolver} has a number of problems:
67 * </p>
68 * <ul>
69 * <li>It does case-insensitive pattern matching. Matching in OpenSsh is
70 * case-sensitive! Compare also bug 531118.</li>
71 * <li>It only merges values from the global items (before the first "Host"
72 * line) into the host entries. Otherwise it selects the most specific match.
73 * OpenSsh processes <em>all</em> entries in the order they appear in the file
74 * and whenever one matches, it updates values as appropriate.</li>
75 * <li>We have to ensure that ~ replacement uses the same HOME directory as
76 * JGit. Compare bug bug 526175.</li>
77 * </ul>
78 * Therefore, this re-uses the parsing and caching from
79 * {@link OpenSshConfigFile}.
80 *
81 * @since 5.2
82 */
83 public class JGitSshConfig implements HostConfigEntryResolver {
84
85 private OpenSshConfigFile configFile;
86
87 /**
88 * Creates a new {@link OpenSshConfigFile} that will read the config from
89 * file {@code config} use the given file {@code home} as "home" directory.
90 *
91 * @param home
92 * user's home directory for the purpose of ~ replacement
93 * @param config
94 * file to load.
95 * @param localUserName
96 * user name of the current user on the local host OS
97 */
98 public JGitSshConfig(@NonNull File home, @NonNull File config,
99 @NonNull String localUserName) {
100 configFile = new OpenSshConfigFile(home, config, localUserName);
101 }
102
103 @Override
104 public HostConfigEntry resolveEffectiveHost(String host, int port,
105 String username) throws IOException {
106 HostEntry entry = configFile.lookup(host, port, username);
107 JGitHostConfigEntry config = new JGitHostConfigEntry();
108 // Apache MINA conflates all keys, even multi-valued ones, in one map
109 // and puts multiple values separated by commas in one string. See
110 // the javadoc on HostConfigEntry.
111 Map<String, String> allOptions = new TreeMap<>(
112 String.CASE_INSENSITIVE_ORDER);
113 allOptions.putAll(entry.getOptions());
114 // And what if a value contains a comma??
115 entry.getMultiValuedOptions().entrySet().stream()
116 .forEach(e -> allOptions.put(e.getKey(),
117 String.join(",", e.getValue()))); //$NON-NLS-1$
118 config.setProperties(allOptions);
119 // The following is an extension from JGitHostConfigEntry
120 config.setMultiValuedOptions(entry.getMultiValuedOptions());
121 // Also make sure the underlying properties are set
122 String hostName = entry.getValue(SshConstants.HOST_NAME);
123 if (hostName == null || hostName.isEmpty()) {
124 hostName = host;
125 }
126 config.setHostName(hostName);
127 config.setProperty(SshConstants.HOST_NAME, hostName);
128 config.setHost(SshdSocketAddress.isIPv6Address(hostName) ? "" : hostName); //$NON-NLS-1$
129 String user = username != null && !username.isEmpty() ? username
130 : entry.getValue(SshConstants.USER);
131 if (user == null || user.isEmpty()) {
132 user = configFile.getLocalUserName();
133 }
134 config.setUsername(user);
135 config.setProperty(SshConstants.USER, user);
136 int p = port >= 0 ? port : positive(entry.getValue(SshConstants.PORT));
137 config.setPort(p >= 0 ? p : SshConstants.SSH_DEFAULT_PORT);
138 config.setProperty(SshConstants.PORT,
139 Integer.toString(config.getPort()));
140 config.setIdentities(entry.getValues(SshConstants.IDENTITY_FILE));
141 config.setIdentitiesOnly(
142 flag(entry.getValue(SshConstants.IDENTITIES_ONLY)));
143 return config;
144 }
145
146 }