Improve the no-interactive-shell error message over SSH
Present users with a more useful message that explains they have logged in, but aren't able to run commands directly through SSH. Change-Id: I9763ae6f28c2dd2aa7a3f3e41a9b13ef997a1f45 Signed-off-by: Shawn O. Pearce <sop@google.com>
This commit is contained in:
@@ -14,15 +14,28 @@
|
|||||||
|
|
||||||
package com.google.gerrit.sshd;
|
package com.google.gerrit.sshd;
|
||||||
|
|
||||||
|
import com.google.gerrit.reviewdb.Account;
|
||||||
|
import com.google.gerrit.server.IdentifiedUser;
|
||||||
|
import com.google.gerrit.server.config.CanonicalWebUrl;
|
||||||
|
import com.google.gerrit.server.ssh.SshInfo;
|
||||||
|
import com.google.gerrit.sshd.SshScope.Context;
|
||||||
|
import com.google.inject.Inject;
|
||||||
|
import com.google.inject.Provider;
|
||||||
|
|
||||||
import org.apache.sshd.common.Factory;
|
import org.apache.sshd.common.Factory;
|
||||||
import org.apache.sshd.server.Command;
|
import org.apache.sshd.server.Command;
|
||||||
import org.apache.sshd.server.Environment;
|
import org.apache.sshd.server.Environment;
|
||||||
import org.apache.sshd.server.ExitCallback;
|
import org.apache.sshd.server.ExitCallback;
|
||||||
|
import org.apache.sshd.server.SessionAware;
|
||||||
|
import org.apache.sshd.server.session.ServerSession;
|
||||||
import org.eclipse.jgit.lib.Constants;
|
import org.eclipse.jgit.lib.Constants;
|
||||||
|
import org.eclipse.jgit.util.SystemReader;
|
||||||
|
|
||||||
import java.io.IOException;
|
import java.io.IOException;
|
||||||
import java.io.InputStream;
|
import java.io.InputStream;
|
||||||
import java.io.OutputStream;
|
import java.io.OutputStream;
|
||||||
|
import java.net.MalformedURLException;
|
||||||
|
import java.net.URL;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Dummy shell which prints a message and terminates.
|
* Dummy shell which prints a message and terminates.
|
||||||
@@ -32,12 +45,30 @@ import java.io.OutputStream;
|
|||||||
* cannot continue further.
|
* cannot continue further.
|
||||||
*/
|
*/
|
||||||
class NoShell implements Factory<Command> {
|
class NoShell implements Factory<Command> {
|
||||||
|
private final Provider<SendMessage> shell;
|
||||||
|
|
||||||
|
@Inject
|
||||||
|
NoShell(Provider<SendMessage> shell) {
|
||||||
|
this.shell = shell;
|
||||||
|
}
|
||||||
|
|
||||||
public Command create() {
|
public Command create() {
|
||||||
return new Command() {
|
return shell.get();
|
||||||
|
}
|
||||||
|
|
||||||
|
static class SendMessage implements Command, SessionAware {
|
||||||
|
private final Provider<MessageFactory> messageFactory;
|
||||||
|
|
||||||
private InputStream in;
|
private InputStream in;
|
||||||
private OutputStream out;
|
private OutputStream out;
|
||||||
private OutputStream err;
|
private OutputStream err;
|
||||||
private ExitCallback exit;
|
private ExitCallback exit;
|
||||||
|
private Context context;
|
||||||
|
|
||||||
|
@Inject
|
||||||
|
SendMessage(Provider<MessageFactory> messageFactory) {
|
||||||
|
this.messageFactory = messageFactory;
|
||||||
|
}
|
||||||
|
|
||||||
public void setInputStream(final InputStream in) {
|
public void setInputStream(final InputStream in) {
|
||||||
this.in = in;
|
this.in = in;
|
||||||
@@ -55,8 +86,19 @@ class NoShell implements Factory<Command> {
|
|||||||
this.exit = callback;
|
this.exit = callback;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public void setSession(final ServerSession session) {
|
||||||
|
this.context = new Context(session.getAttribute(SshSession.KEY), "");
|
||||||
|
}
|
||||||
|
|
||||||
public void start(final Environment env) throws IOException {
|
public void start(final Environment env) throws IOException {
|
||||||
err.write(Constants.encodeASCII("gerrit: no shell available\r\n"));
|
Context old = SshScope.set(context);
|
||||||
|
String message;
|
||||||
|
try {
|
||||||
|
message = messageFactory.get().getMessage();
|
||||||
|
} finally {
|
||||||
|
SshScope.set(old);
|
||||||
|
}
|
||||||
|
err.write(Constants.encodeASCII(message.toString()));
|
||||||
err.flush();
|
err.flush();
|
||||||
|
|
||||||
in.close();
|
in.close();
|
||||||
@@ -67,6 +109,71 @@ class NoShell implements Factory<Command> {
|
|||||||
|
|
||||||
public void destroy() {
|
public void destroy() {
|
||||||
}
|
}
|
||||||
};
|
}
|
||||||
|
|
||||||
|
static class MessageFactory {
|
||||||
|
private final IdentifiedUser user;
|
||||||
|
private final SshInfo sshInfo;
|
||||||
|
private final Provider<String> urlProvider;
|
||||||
|
|
||||||
|
@Inject
|
||||||
|
MessageFactory(IdentifiedUser user, SshInfo sshInfo,
|
||||||
|
@CanonicalWebUrl Provider<String> urlProvider) {
|
||||||
|
this.user = user;
|
||||||
|
this.sshInfo = sshInfo;
|
||||||
|
this.urlProvider = urlProvider;
|
||||||
|
}
|
||||||
|
|
||||||
|
String getMessage() {
|
||||||
|
StringBuilder msg = new StringBuilder();
|
||||||
|
|
||||||
|
msg.append("\r\n");
|
||||||
|
msg.append(" **** Welcome to Gerrit Code Review ****\r\n");
|
||||||
|
msg.append("\r\n");
|
||||||
|
|
||||||
|
Account account = user.getAccount();
|
||||||
|
String name = account.getFullName();
|
||||||
|
if (name == null || name.isEmpty()) {
|
||||||
|
name = user.getUserName();
|
||||||
|
}
|
||||||
|
msg.append(" Hi ");
|
||||||
|
msg.append(name);
|
||||||
|
msg.append(", you have successfully connected over SSH.");
|
||||||
|
msg.append("\r\n");
|
||||||
|
msg.append("\r\n");
|
||||||
|
|
||||||
|
msg.append(" Unfortunately, interactive shells are disabled.\r\n");
|
||||||
|
msg.append(" To clone a hosted Git repository, use:\r\n");
|
||||||
|
msg.append("\r\n");
|
||||||
|
|
||||||
|
if (!sshInfo.getHostKeys().isEmpty()) {
|
||||||
|
String host = sshInfo.getHostKeys().get(0).getHost();
|
||||||
|
if (host.startsWith("*:")) {
|
||||||
|
host = getGerritHost() + host.substring(1);
|
||||||
|
}
|
||||||
|
|
||||||
|
msg.append(" git clone ssh://");
|
||||||
|
msg.append(user.getUserName());
|
||||||
|
msg.append("@");
|
||||||
|
msg.append(host);
|
||||||
|
msg.append("/");
|
||||||
|
msg.append("REPOSITORY_NAME.git");
|
||||||
|
msg.append("\r\n");
|
||||||
|
}
|
||||||
|
|
||||||
|
msg.append("\r\n");
|
||||||
|
return msg.toString();
|
||||||
|
}
|
||||||
|
|
||||||
|
private String getGerritHost() {
|
||||||
|
String url = urlProvider.get();
|
||||||
|
if (url != null) {
|
||||||
|
try {
|
||||||
|
return new URL(url).getHost();
|
||||||
|
} catch (MalformedURLException e) {
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return SystemReader.getInstance().getHostname();
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -124,7 +124,7 @@ public class SshDaemon extends SshServer implements SshInfo, LifecycleListener {
|
|||||||
private volatile IoAcceptor acceptor;
|
private volatile IoAcceptor acceptor;
|
||||||
|
|
||||||
@Inject
|
@Inject
|
||||||
SshDaemon(final CommandFactory commandFactory,
|
SshDaemon(final CommandFactory commandFactory, final NoShell noShell,
|
||||||
final PublickeyAuthenticator userAuth,
|
final PublickeyAuthenticator userAuth,
|
||||||
final KeyPairProvider hostKeyProvider, final IdGenerator idGenerator,
|
final KeyPairProvider hostKeyProvider, final IdGenerator idGenerator,
|
||||||
@GerritServerConfig final Config cfg, final SshLog sshLog) {
|
@GerritServerConfig final Config cfg, final SshLog sshLog) {
|
||||||
@@ -169,7 +169,7 @@ public class SshDaemon extends SshServer implements SshInfo, LifecycleListener {
|
|||||||
initUserAuth(userAuth);
|
initUserAuth(userAuth);
|
||||||
setKeyPairProvider(hostKeyProvider);
|
setKeyPairProvider(hostKeyProvider);
|
||||||
setCommandFactory(commandFactory);
|
setCommandFactory(commandFactory);
|
||||||
setShellFactory(new NoShell());
|
setShellFactory(noShell);
|
||||||
setSessionFactory(new SessionFactory() {
|
setSessionFactory(new SessionFactory() {
|
||||||
@Override
|
@Override
|
||||||
protected ServerSession createSession(final IoSession io)
|
protected ServerSession createSession(final IoSession io)
|
||||||
|
|||||||
Reference in New Issue
Block a user