Biblioteca SSH para Java [fechada]

190

Alguém sabe de uma boa biblioteca para login SSH a partir de Java.

rperez
fonte
Eu costumava usar o Trilead SSH, mas quando chequei o site hoje, parece que eles estão desistindo dele. :( Foi o meu favorito absoluto.
Peter D
1
BTW, parece que o Trilead SSH2 está sendo mantido ativamente (em outubro de 2013): [ github.com/jenkinsci/trilead-ssh2]
Mike Godin
O Trilead SSH2 tem uma bifurcação em github.com/connectbot/sshlib
user7610

Respostas:

120

O Java Secure Channel (JSCH) é uma biblioteca muito popular, usada por maven, ant e eclipse. É de código aberto com uma licença no estilo BSD.

David Rabinowitz
fonte
2
Você eed para baixar o fonte de sourceforge.net/projects/jsch/files/jsch/jsch-0.1.42.zip/... e executar "javadoc formiga"
David Rabinowitz
73
Eu tentei usar JSch há algum tempo e não consigo entender como ficou tão popular. Ele oferece absolutamente nenhuma documentação (nem mesmo dentro da fonte) e um design API horrível ( techtavern.wordpress.com/2008/09/30/... resume tudo muito bem)
rluba
15
Sim Jsch é horrível, isso é melhor: github.com/shikhar/sshj
anio
3
Uma variante de JSch com javadoc para os métodos públicos: github.com/ePaul/jsch-documentation
user423430
4
stackoverflow.com/questions/2405885/any-good-jsch-examples/… contém um exemplo para usar o JSCH para executar comandos e obter a saída.
Charity Leschinski
65

Atualização: o projeto GSOC e o código não estão ativos, mas este é: https://github.com/hierynomus/sshj

hierynomus assumiu o cargo de mantenedor desde o início de 2015. Aqui está o link do Github mais antigo, que não é mais mantido:

https://github.com/shikhar/sshj


Havia um projeto GSOC:

http://code.google.com/p/commons-net-ssh/

A qualidade do código parece ser melhor que o JSch, que, embora seja uma implementação completa e funcional, carece de documentação. A página do projeto identifica uma próxima versão beta, a última confirmação no repositório foi em meados de agosto.

Compare as APIs:

http://code.google.com/p/commons-net-ssh/

    SSHClient ssh = new SSHClient();
    //ssh.useCompression(); 
    ssh.loadKnownHosts();
    ssh.connect("localhost");
    try {
        ssh.authPublickey(System.getProperty("user.name"));
        new SCPDownloadClient(ssh).copy("ten", "/tmp");
    } finally {
        ssh.disconnect();
    }

http://www.jcraft.com/jsch/

Session session = null;
Channel channel = null;

try {

JSch jsch = new JSch();
session = jsch.getSession(username, host, 22);
java.util.Properties config = new java.util.Properties();
config.put("StrictHostKeyChecking", "no");
session.setConfig(config);
session.setPassword(password);
session.connect();

// exec 'scp -f rfile' remotely
String command = "scp -f " + remoteFilename;
channel = session.openChannel("exec");
((ChannelExec) channel).setCommand(command);

// get I/O streams for remote scp
OutputStream out = channel.getOutputStream();
InputStream in = channel.getInputStream();

channel.connect();

byte[] buf = new byte[1024];

// send '\0'
buf[0] = 0;
out.write(buf, 0, 1);
out.flush();

while (true) {
    int c = checkAck(in);
    if (c != 'C') {
        break;
    }

    // read '0644 '
    in.read(buf, 0, 5);

    long filesize = 0L;
    while (true) {
        if (in.read(buf, 0, 1) < 0) {
            // error
            break;
        }
        if (buf[0] == ' ') {
            break;
        }
        filesize = filesize * 10L + (long) (buf[0] - '0');
    }

    String file = null;
    for (int i = 0;; i++) {
        in.read(buf, i, 1);
        if (buf[i] == (byte) 0x0a) {
            file = new String(buf, 0, i);
            break;
        }
    }

    // send '\0'
    buf[0] = 0;
    out.write(buf, 0, 1);
    out.flush();

    // read a content of lfile
    FileOutputStream fos = null;

    fos = new FileOutputStream(localFilename);
    int foo;
    while (true) {
        if (buf.length < filesize) {
            foo = buf.length;
        } else {
            foo = (int) filesize;
        }
        foo = in.read(buf, 0, foo);
        if (foo < 0) {
            // error
            break;
        }
        fos.write(buf, 0, foo);
        filesize -= foo;
        if (filesize == 0L) {
            break;
        }
    }
    fos.close();
    fos = null;

    if (checkAck(in) != 0) {
        System.exit(0);
    }

    // send '\0'
    buf[0] = 0;
    out.write(buf, 0, 1);
    out.flush();

    channel.disconnect();
    session.disconnect();
}

} catch (JSchException jsche) {
    System.err.println(jsche.getLocalizedMessage());
} catch (IOException ioe) {
    System.err.println(ioe.getLocalizedMessage());
} finally {
    channel.disconnect();
    session.disconnect();
}

}
miku
fonte
2
Obrigado! Eu usei o código Apache SSHD (que oferece uma API assíncrona) como semente, o que deu ao projeto um kickstart.
21009 shikhar
1
Ótimo. Comecei um projeto usando JSch, mas gosto muito de mudar, se ouvir um feedback mais positivo sobre o commons-net-ssh.
Miku
5
Eu deveria ter mencionado que eu era o estudante GSOC :)
Shikhar
2
felizes em anunciar github.com/shikhar/sshj - você pode encontrar frasco de lá, para descobrir como obtê-lo em um maven repo
Shikhar
1
O SFTP do jsch é muito mais simples do que o que é fornecido aqui. Talvez esse seja um código antigo, mas certamente não é um exemplo da API moderna.
Charles Duffy
24

Acabei de descobrir o sshj , que parece ter uma API muito mais concisa que o JSCH (mas requer o Java 6). A documentação é principalmente de exemplos no repositório neste momento, e geralmente isso é o suficiente para eu procurar em outro lugar, mas parece bom o suficiente para eu dar uma chance em um projeto que acabei de iniciar.

Ed Brannin
fonte
3
SSHJ é realmente viável por alguém do mundo exterior. JSCH é uma bagunça de documentação ruim e design de API com dependências ocultas e amplamente indecifráveis. A menos que você queira gastar muito tempo percorrendo o código para tentar descobrir o que está acontecendo, use o SSHJ. (E eu desejo que eu estava sendo severo ou jocoso sobre jsch eu realmente fazer..)
Robert Fischer
1
Sim, sshj. Tudo o que tentei com ele funcionou: SCP, execução remota de processo, encaminhamento de porta local e remoto, proxy de agente com jsch-agent-proxy . JSCH estava uma bagunça.
Laurent Caillette
1
O problema com o SSHJ é que é muito difícil executar vários comandos. O SSHJ pode ser ótimo para acionar e esquecer comandos, mas é uma dor se você deseja programar uma interação mais complicada. (Eu só desperdicei meio dia nele)
bvdb
18

Dê uma olhada no SSHD lançado recentemente , baseado no projeto Apache MINA.

mshafrir
fonte
2
Utilizando-o, no entanto, faltam documentação e exemplos.
Andreas Mattisson
Parece que a falta de documentação está colocando de ânimo leve: /
Amalgovinus
5

Há uma nova versão do Jsch no github: https://github.com/vngx/vngx-jsch Algumas das melhorias incluem: javadoc abrangente, desempenho aprimorado, manipulação aprimorada de exceções e melhor aderência às especificações RFC. Se você deseja contribuir de alguma forma, abra um problema ou envie uma solicitação de recebimento.

Scott
fonte
4
Pena que não há um novo commit há mais de 3 anos.
Mike Lowery
0

Peguei a resposta de miku e o código de exemplo jsch. Eu tive que baixar vários arquivos durante a sessão e preservar os carimbos de data e hora originais . Este é o meu exemplo de código de como fazê-lo, provavelmente muitas pessoas o consideram útil. Por favor, ignore a função filenameHack (), é o meu próprio caso.

package examples;

import com.jcraft.jsch.*;
import java.io.*;
import java.util.*;

public class ScpFrom2 {

    public static void main(String[] args) throws Exception {
        Map<String,String> params = parseParams(args);
        if (params.isEmpty()) {
            System.err.println("usage: java ScpFrom2 "
                    + " user=myid password=mypwd"
                    + " host=myhost.com port=22"
                    + " encoding=<ISO-8859-1,UTF-8,...>"
                    + " \"remotefile1=/some/file.png\""
                    + " \"localfile1=file.png\""
                    + " \"remotefile2=/other/file.txt\""
                    + " \"localfile2=file.txt\""

            );
            return;
        }

        // default values
        if (params.get("port") == null)
            params.put("port", "22");
        if (params.get("encoding") == null)
            params.put("encoding", "ISO-8859-1"); //"UTF-8"

        Session session = null;
        try {
            JSch jsch=new JSch();
            session=jsch.getSession(
                    params.get("user"),  // myuserid
                    params.get("host"),  // my.server.com
                    Integer.parseInt(params.get("port")) // 22
            );
            session.setPassword( params.get("password") );
            session.setConfig("StrictHostKeyChecking", "no"); // do not prompt for server signature

            session.connect();

            // this is exec command and string reply encoding
            String encoding = params.get("encoding");

            int fileIdx=0;
            while(true) {
                fileIdx++;

                String remoteFile = params.get("remotefile"+fileIdx);
                String localFile = params.get("localfile"+fileIdx);
                if (remoteFile == null || remoteFile.equals("")
                        || localFile == null || localFile.equals("") )
                    break;

                remoteFile = filenameHack(remoteFile);
                localFile  = filenameHack(localFile);

                try {
                    downloadFile(session, remoteFile, localFile, encoding);
                } catch (Exception ex) {
                    ex.printStackTrace();
                }
            }

        } catch(Exception ex) {
            ex.printStackTrace();
        } finally {
            try{ session.disconnect(); } catch(Exception ex){}
        }
    }

    private static void downloadFile(Session session, 
            String remoteFile, String localFile, String encoding) throws Exception {
        // send exec command: scp -p -f "/some/file.png"
        // -p = read file timestamps
        // -f = From remote to local
        String command = String.format("scp -p -f \"%s\"", remoteFile); 
        System.console().printf("send command: %s%n", command);
        Channel channel=session.openChannel("exec");
        ((ChannelExec)channel).setCommand(command.getBytes(encoding));

        // get I/O streams for remote scp
        byte[] buf=new byte[32*1024];
        OutputStream out=channel.getOutputStream();
        InputStream in=channel.getInputStream();

        channel.connect();

        buf[0]=0; out.write(buf, 0, 1); out.flush(); // send '\0'

        // reply: T<mtime> 0 <atime> 0\n
        // times are in seconds, since 1970-01-01 00:00:00 UTC 
        int c=checkAck(in);
        if(c!='T')
            throw new IOException("Invalid timestamp reply from server");

        long tsModified = -1; // millis
        for(int idx=0; ; idx++){
            in.read(buf, idx, 1);
            if(tsModified < 0 && buf[idx]==' ') {
                tsModified = Long.parseLong(new String(buf, 0, idx))*1000;
            } else if(buf[idx]=='\n') {
                break;
            }
        }

        buf[0]=0; out.write(buf, 0, 1); out.flush(); // send '\0'

        // reply: C0644 <binary length> <filename>\n
        // length is given as a text "621873" bytes
        c=checkAck(in);
        if(c!='C')
            throw new IOException("Invalid filename reply from server");

        in.read(buf, 0, 5); // read '0644 ' bytes

        long filesize=-1;
        for(int idx=0; ; idx++){
            in.read(buf, idx, 1);
            if(buf[idx]==' ') {
                filesize = Long.parseLong(new String(buf, 0, idx));
                break;
            }
        }

        // read remote filename
        String origFilename=null;
        for(int idx=0; ; idx++){
            in.read(buf, idx, 1);
            if(buf[idx]=='\n') {
                origFilename=new String(buf, 0, idx, encoding); // UTF-8, ISO-8859-1
                break;
            }
        }

        System.console().printf("size=%d, modified=%d, filename=%s%n"
                , filesize, tsModified, origFilename);

        buf[0]=0; out.write(buf, 0, 1); out.flush(); // send '\0'

        // read binary data, write to local file
        FileOutputStream fos = null;
        try {
            File file = new File(localFile);
            fos = new FileOutputStream(file);
            while(filesize > 0) {
                int read = Math.min(buf.length, (int)filesize);
                read=in.read(buf, 0, read);
                if(read < 0)
                    throw new IOException("Reading data failed");

                fos.write(buf, 0, read);
                filesize -= read;
            }
            fos.close(); // we must close file before updating timestamp
            fos = null;
            if (tsModified > 0)
                file.setLastModified(tsModified);               
        } finally {
            try{ if (fos!=null) fos.close(); } catch(Exception ex){}
        }

        if(checkAck(in) != 0)
            return;

        buf[0]=0; out.write(buf, 0, 1); out.flush(); // send '\0'
        System.out.println("Binary data read");     
    }

    private static int checkAck(InputStream in) throws IOException {
        // b may be 0 for success
        //          1 for error,
        //          2 for fatal error,
        //          -1
        int b=in.read();
        if(b==0) return b;
        else if(b==-1) return b;
        if(b==1 || b==2) {
            StringBuilder sb=new StringBuilder();
            int c;
            do {
                c=in.read();
                sb.append((char)c);
            } while(c!='\n');
            throw new IOException(sb.toString());
        }
        return b;
    }


    /**
     * Parse key=value pairs to hashmap.
     * @param args
     * @return
     */
    private static Map<String,String> parseParams(String[] args) throws Exception {
        Map<String,String> params = new HashMap<String,String>();
        for(String keyval : args) {
            int idx = keyval.indexOf('=');
            params.put(
                    keyval.substring(0, idx),
                    keyval.substring(idx+1)
            );
        }
        return params;
    }

    private static String filenameHack(String filename) {
        // It's difficult reliably pass unicode input parameters 
        // from Java dos command line.
        // This dirty hack is my very own test use case. 
        if (filename.contains("${filename1}"))
            filename = filename.replace("${filename1}", "Korilla ABC ÅÄÖ.txt");
        else if (filename.contains("${filename2}"))
            filename = filename.replace("${filename2}", "test2 ABC ÅÄÖ.txt");           
        return filename;
    }

}
Quem eu
fonte
Você conseguiu reutilizar uma sessão e evitar a sobrecarga de conectar / desconectar?
Sridhar Sarnobat