SFTP経由でサーバーからファイルを取得する方法

228

Javaを使用して（FTPSではなく）SFTPを使用してサーバーからファイルを取得しようとしています。これどうやってするの？

java  ftp  sftp  security 
— デビッド・ヘイズ
ソース

回答:

198

別のオプションは、JSchライブラリを検討することです。JSchは、とりわけEclipse、Ant、Apache Commons HttpClientなど、いくつかの大規模なオープンソースプロジェクトに推奨されるライブラリのようです。

ユーザー/パスと証明書ベースのログインの両方、およびその他のおいしいSSH2機能のホスト全体をすべてサポートします。

これは、SFTPを介した単純なリモートファイル取得です。エラー処理は読者の練習問題として残します:-)

JSch jsch = new JSch();

String knownHostsFilename = "/home/username/.ssh/known_hosts";
jsch.setKnownHosts( knownHostsFilename );

Session session = jsch.getSession( "remote-username", "remote-host" );    
{
  // "interactive" version
  // can selectively update specified known_hosts file 
  // need to implement UserInfo interface
  // MyUserInfo is a swing implementation provided in 
  //  examples/Sftp.java in the JSch dist
  UserInfo ui = new MyUserInfo();
  session.setUserInfo(ui);

  // OR non-interactive version. Relies in host key being in known-hosts file
  session.setPassword( "remote-password" );
}

session.connect();

Channel channel = session.openChannel( "sftp" );
channel.connect();

ChannelSftp sftpChannel = (ChannelSftp) channel;

sftpChannel.get("remote-file", "local-file" );
// OR
InputStream in = sftpChannel.get( "remote-file" );
  // process inputstream as needed

sftpChannel.exit();
session.disconnect();
— Cheekysoft
ソース
1
Cheekysoft、私が気付いた-Jschの使用中-sftp-server上のファイルの削除が機能しない。また、ファイル名の変更も機能しません。どんなアイデアでもください??? アンディ
1
申し訳ありませんが、現在私が使用しているものではありません。（これらの種類の応答は、このメッセージのように、コメントとして残してください。元の質問に対する新しい回答ではありません）
— Cheekysoft
1
セッションの割り当て後のコードブロックは何ですか？それは私が今まで見たことのない派手なJava構文ですか？もしそうなら-それはそのように書かれて何を達成しますか？
— Michael Peterson
3
@ p1x3l5標準のJava構文では、ブロックをどこにでも挿入できます。必要に応じて、変数スコープをより細かく制御するために使用できます。ただし、この場合は、ユーザーからのパスワードを要求する対話型バージョンを使用するか、ユーザーの介入を必要としないハードコーディングされたパスワードを使用するか、おそらく追加のセキュリティリスクの2つの実装の選択肢を示すための視覚的な支援にすぎません。
— Cheekysoft 2014年
109

次に、sshキーのチェックを気にすることなく、JSchを使用した例の完全なソースコードを示します。

import com.jcraft.jsch.*;

public class TestJSch {
    public static void main(String args[]) {
        JSch jsch = new JSch();
        Session session = null;
        try {
            session = jsch.getSession("username", "127.0.0.1", 22);
            session.setConfig("StrictHostKeyChecking", "no");
            session.setPassword("password");
            session.connect();

            Channel channel = session.openChannel("sftp");
            channel.connect();
            ChannelSftp sftpChannel = (ChannelSftp) channel;
            sftpChannel.get("remotefile.txt", "localfile.txt");
            sftpChannel.exit();
            session.disconnect();
        } catch (JSchException e) {
            e.printStackTrace();  
        } catch (SftpException e) {
            e.printStackTrace();
        }
    }
}
— イラクリス
ソース
15
finallyブロックは、それが常に実行されることを保証するために、チャネルのクリーンアップコードを含めるために使用されるべきです。
— hotshot309
私は今、この例外を受けています： com.jcraft.jsch.JSchException: Session.connect: java.security.InvalidAlgorithmParameterException: Prime size must be multiple of 64, and can only range from 512 to 2048 (inclusive)
— anon58192932
JSCHには0または1の追加の依存関係があることがわかりました。圧縮を無効にすると、JZLIB依存関係を無視できます。//圧縮を無効にしますsession.setConfig（ "compression.s2c"、 "none"）; session.setConfig（ "compression.c2s"、 "none"）;
— englebart
1
厳密なホストチェックを行わないと、中間者攻撃を受ける可能性があります。
— rustyx
44

以下は、Apache Common VFSの使用例です。

FileSystemOptions fsOptions = new FileSystemOptions();
SftpFileSystemConfigBuilder.getInstance().setStrictHostKeyChecking(fsOptions, "no");
FileSystemManager fsManager = VFS.getManager();
String uri = "sftp://user:password@host:port/absolute-path";
FileObject fo = fsManager.resolveFile(uri, fsOptions);
— クリス・J
ソース
5
タイムアウトを設定すると、リモートシステムがオフラインの場合にハングアップし続けることがなくなります。これは、ホストキーチェックを無効にする場合と同じように行うことができます。SftpFileSystemConfigBuilder.getInstance（）。setTimeout（fsOptions、5000）;
— スコットジョーンズ
複数のSFTPクライアントを同時に使用する場合、この接続を閉じるにはどうすればよいですか。
— 2Big2BeSmall
2
パスワードに@記号が含まれている場合はどうなりますか？
— User3
23

これは私がhttp://sourceforge.net/projects/sshtools/で思いついた解決策でした （ほとんどのエラー処理は明確にするために省略されています）。これは私のブログからの抜粋です

SshClient ssh = new SshClient();
ssh.connect(host, port);
//Authenticate
PasswordAuthenticationClient passwordAuthenticationClient = new PasswordAuthenticationClient();
passwordAuthenticationClient.setUsername(userName);
passwordAuthenticationClient.setPassword(password);
int result = ssh.authenticate(passwordAuthenticationClient);
if(result != AuthenticationProtocolState.COMPLETE){
     throw new SFTPException("Login to " + host + ":" + port + " " + userName + "/" + password + " failed");
}
//Open the SFTP channel
SftpClient client = ssh.openSftpClient();
//Send the file
client.put(filePath);
//disconnect
client.quit();
ssh.disconnect();
— デビッド・ヘイズ
ソース
7
私は（遅々として）同意しましたが、元のサイト/ダウンロードでは問題なく機能しましたが、新しいサイトでは機能しませんでした。私はJSchへの切り替えの最中です
— David Hayes
23

Jschの優れた抽象化は、Apache commons-vfsです。これは、SFTPファイルへのアクセスと書き込みをほぼ透過的にする仮想ファイルシステムAPIを提供します。私たちにとってはうまくいきました。

— ボリス・テルジッチ
ソース
1
commons-vfsと組み合わせて事前共有キーを使用することは可能ですか？
— Benedikt Waldvogel、2009年
2
はい、そうです。非標準のIDが必要な場合は、SftpFileSystemConfigBuilder.getInstance（）。setIdentities（...）を呼び出すことができます。
— ラスヘイワード
事前共有鍵を使用できます。ただし、このキーにはパスワードが必要です。OtrosLogViewerはVFSでSSHキー認証を使用していますが、キー（code.google.com/p/otroslogviewer/wiki/SftpAuthPubKey）からパスフレーズを削除する必要があります
— KrzyH
19

SFTP向けの3つの成熟したJavaライブラリー（Commons VFS、SSHJ、JSch）の優れた比較があります。

まとめると、SSHJには最も明確なAPIがあり、Commons VFSが提供する他のストレージサポートが必要ない場合は、それらのAPIが最適です。

以下はgithubからのSSHJの編集例です：

final SSHClient ssh = new SSHClient();
ssh.loadKnownHosts(); // or, to skip host verification: ssh.addHostKeyVerifier(new PromiscuousVerifier())
ssh.connect("localhost");
try {
    ssh.authPassword("user", "password"); // or ssh.authPublickey(System.getProperty("user.name"))
    final SFTPClient sftp = ssh.newSFTPClient();
    try {
        sftp.get("test_file", "/tmp/test.tmp");
    } finally {
        sftp.close();
    }
} finally {
    ssh.disconnect();
}
— サーシャ
ソース
2
ファイルをInputStreamとして取得する方法はありますか？
— ヨハン
2
2019年のsshjはまだ十分に維持されており、Alpakka（Akka）プロジェクトで使用されています
— Maxence
13

Apache Commons SFTPライブラリ

すべての例に共通のJavaプロパティファイル

serverAddress = 111.222.333.444

userId = myUserId

password = myPassword

remoteDirectory = products /

localDirectory = import /

SFTPを使用してリモートサーバーにファイルをアップロードする

import java.io.File;
import java.io.FileInputStream;
import java.util.Properties;

import org.apache.commons.vfs2.FileObject;
import org.apache.commons.vfs2.FileSystemOptions;
import org.apache.commons.vfs2.Selectors;
import org.apache.commons.vfs2.impl.StandardFileSystemManager;
import org.apache.commons.vfs2.provider.sftp.SftpFileSystemConfigBuilder;

public class SendMyFiles {

 static Properties props;

 public static void main(String[] args) {

  SendMyFiles sendMyFiles = new SendMyFiles();
  if (args.length < 1)
  {
   System.err.println("Usage: java " + sendMyFiles.getClass().getName()+
     " Properties_file File_To_FTP ");
   System.exit(1);
  }

  String propertiesFile = args[0].trim();
  String fileToFTP = args[1].trim();
  sendMyFiles.startFTP(propertiesFile, fileToFTP);

 }

 public boolean startFTP(String propertiesFilename, String fileToFTP){

  props = new Properties();
  StandardFileSystemManager manager = new StandardFileSystemManager();

  try {

   props.load(new FileInputStream("properties/" + propertiesFilename));
   String serverAddress = props.getProperty("serverAddress").trim();
   String userId = props.getProperty("userId").trim();
   String password = props.getProperty("password").trim();
   String remoteDirectory = props.getProperty("remoteDirectory").trim();
   String localDirectory = props.getProperty("localDirectory").trim();

   //check if the file exists
   String filepath = localDirectory +  fileToFTP;
   File file = new File(filepath);
   if (!file.exists())
    throw new RuntimeException("Error. Local file not found");

   //Initializes the file manager
   manager.init();

   //Setup our SFTP configuration
   FileSystemOptions opts = new FileSystemOptions();
   SftpFileSystemConfigBuilder.getInstance().setStrictHostKeyChecking(
     opts, "no");
   SftpFileSystemConfigBuilder.getInstance().setUserDirIsRoot(opts, true);
   SftpFileSystemConfigBuilder.getInstance().setTimeout(opts, 10000);

   //Create the SFTP URI using the host name, userid, password,  remote path and file name
   String sftpUri = "sftp://" + userId + ":" + password +  "@" + serverAddress + "/" + 
     remoteDirectory + fileToFTP;

   // Create local file object
   FileObject localFile = manager.resolveFile(file.getAbsolutePath());

   // Create remote file object
   FileObject remoteFile = manager.resolveFile(sftpUri, opts);

   // Copy local file to sftp server
   remoteFile.copyFrom(localFile, Selectors.SELECT_SELF);
   System.out.println("File upload successful");

  }
  catch (Exception ex) {
   ex.printStackTrace();
   return false;
  }
  finally {
   manager.close();
  }

  return true;
 }


}

SFTPを使用してリモートサーバーからファイルをダウンロードする

import java.io.File;
import java.io.FileInputStream;
import java.util.Properties;

import org.apache.commons.vfs2.FileObject;
import org.apache.commons.vfs2.FileSystemOptions;
import org.apache.commons.vfs2.Selectors;
import org.apache.commons.vfs2.impl.StandardFileSystemManager;
import org.apache.commons.vfs2.provider.sftp.SftpFileSystemConfigBuilder;

public class GetMyFiles {

 static Properties props;

 public static void main(String[] args) {

  GetMyFiles getMyFiles = new GetMyFiles();
  if (args.length < 1)
  {
   System.err.println("Usage: java " + getMyFiles.getClass().getName()+
   " Properties_filename File_To_Download ");
   System.exit(1);
  }

  String propertiesFilename = args[0].trim();
  String fileToDownload = args[1].trim();
  getMyFiles.startFTP(propertiesFilename, fileToDownload);

 }

 public boolean startFTP(String propertiesFilename, String fileToDownload){

  props = new Properties();
  StandardFileSystemManager manager = new StandardFileSystemManager();

  try {

   props.load(new FileInputStream("properties/" + propertiesFilename));
   String serverAddress = props.getProperty("serverAddress").trim();
   String userId = props.getProperty("userId").trim();
   String password = props.getProperty("password").trim();
   String remoteDirectory = props.getProperty("remoteDirectory").trim();
   String localDirectory = props.getProperty("localDirectory").trim();


   //Initializes the file manager
   manager.init();

   //Setup our SFTP configuration
   FileSystemOptions opts = new FileSystemOptions();
   SftpFileSystemConfigBuilder.getInstance().setStrictHostKeyChecking(
     opts, "no");
   SftpFileSystemConfigBuilder.getInstance().setUserDirIsRoot(opts, true);
   SftpFileSystemConfigBuilder.getInstance().setTimeout(opts, 10000);

   //Create the SFTP URI using the host name, userid, password,  remote path and file name
   String sftpUri = "sftp://" + userId + ":" + password +  "@" + serverAddress + "/" + 
     remoteDirectory + fileToDownload;

   // Create local file object
   String filepath = localDirectory +  fileToDownload;
   File file = new File(filepath);
   FileObject localFile = manager.resolveFile(file.getAbsolutePath());

   // Create remote file object
   FileObject remoteFile = manager.resolveFile(sftpUri, opts);

   // Copy local file to sftp server
   localFile.copyFrom(remoteFile, Selectors.SELECT_SELF);
   System.out.println("File download successful");

  }
  catch (Exception ex) {
   ex.printStackTrace();
   return false;
  }
  finally {
   manager.close();
  }

  return true;
 }

}

SFTPを使用してリモートサーバー上のファイルを削除する

import java.io.FileInputStream;
import java.util.Properties;

import org.apache.commons.vfs2.FileObject;
import org.apache.commons.vfs2.FileSystemOptions;
import org.apache.commons.vfs2.impl.StandardFileSystemManager;
import org.apache.commons.vfs2.provider.sftp.SftpFileSystemConfigBuilder;

public class DeleteRemoteFile {

 static Properties props;

 public static void main(String[] args) {

  DeleteRemoteFile getMyFiles = new DeleteRemoteFile();
  if (args.length < 1)
  {
   System.err.println("Usage: java " + getMyFiles.getClass().getName()+
   " Properties_filename File_To_Delete ");
   System.exit(1);
  }

  String propertiesFilename = args[0].trim();
  String fileToDownload = args[1].trim();
  getMyFiles.startFTP(propertiesFilename, fileToDownload);

 }

 public boolean startFTP(String propertiesFilename, String fileToDownload){

  props = new Properties();
  StandardFileSystemManager manager = new StandardFileSystemManager();

  try {

   props.load(new FileInputStream("properties/" + propertiesFilename));
   String serverAddress = props.getProperty("serverAddress").trim();
   String userId = props.getProperty("userId").trim();
   String password = props.getProperty("password").trim();
   String remoteDirectory = props.getProperty("remoteDirectory").trim();


   //Initializes the file manager
   manager.init();

   //Setup our SFTP configuration
   FileSystemOptions opts = new FileSystemOptions();
   SftpFileSystemConfigBuilder.getInstance().setStrictHostKeyChecking(
     opts, "no");
   SftpFileSystemConfigBuilder.getInstance().setUserDirIsRoot(opts, true);
   SftpFileSystemConfigBuilder.getInstance().setTimeout(opts, 10000);

   //Create the SFTP URI using the host name, userid, password,  remote path and file name
   String sftpUri = "sftp://" + userId + ":" + password +  "@" + serverAddress + "/" + 
     remoteDirectory + fileToDownload;

   //Create remote file object
   FileObject remoteFile = manager.resolveFile(sftpUri, opts);

   //Check if the file exists
   if(remoteFile.exists()){
    remoteFile.delete();
    System.out.println("File delete successful");
   }

  }
  catch (Exception ex) {
   ex.printStackTrace();
   return false;
  }
  finally {
   manager.close();
  }

  return true;
 }

}
— AZ_
ソース
— AZ_
サーバー上のファイルをコピーするためのssh-key（公開鍵）を持っている間に設定する方法。私のサーバーとリモートサーバー間でssh_trustを作成する必要があるためです。
— MSパルマー
7

hierynomus / sshjには、SFTPバージョン3（OpenSSHが実装するもの）の完全な実装があります。

SFTPUpload.javaのサンプルコード

package net.schmizz.sshj.examples;

import net.schmizz.sshj.SSHClient;
import net.schmizz.sshj.sftp.SFTPClient;
import net.schmizz.sshj.xfer.FileSystemFile;

import java.io.File;
import java.io.IOException;

/** This example demonstrates uploading of a file over SFTP to the SSH server. */
public class SFTPUpload {

    public static void main(String[] args)
            throws IOException {
        final SSHClient ssh = new SSHClient();
        ssh.loadKnownHosts();
        ssh.connect("localhost");
        try {
            ssh.authPublickey(System.getProperty("user.name"));
            final String src = System.getProperty("user.home") + File.separator + "test_file";
            final SFTPClient sftp = ssh.newSFTPClient();
            try {
                sftp.put(new FileSystemFile(src), "/tmp");
            } finally {
                sftp.close();
            }
        } finally {
            ssh.disconnect();
        }
    }

}
— シカール
ソース
2
良くやった！！メインページの例も参考になります。
— OhadR
4

JSchライブラリは、SFTPサーバーからファイルを読み取るために使用できる強力なライブラリです。以下は、SFTPロケーションから1行ずつファイルを読み取るためのテスト済みコードです

JSch jsch = new JSch();
        Session session = null;
        try {
            session = jsch.getSession("user", "127.0.0.1", 22);
            session.setConfig("StrictHostKeyChecking", "no");
            session.setPassword("password");
            session.connect();

            Channel channel = session.openChannel("sftp");
            channel.connect();
            ChannelSftp sftpChannel = (ChannelSftp) channel;

            InputStream stream = sftpChannel.get("/usr/home/testfile.txt");
            try {
                BufferedReader br = new BufferedReader(new InputStreamReader(stream));
                String line;
                while ((line = br.readLine()) != null) {
                    System.out.println(line);
                }

            } catch (IOException io) {
                System.out.println("Exception occurred during reading file from SFTP server due to " + io.getMessage());
                io.getMessage();

            } catch (Exception e) {
                System.out.println("Exception occurred during reading file from SFTP server due to " + e.getMessage());
                e.getMessage();

            }

            sftpChannel.exit();
            session.disconnect();
        } catch (JSchException e) {
            e.printStackTrace();
        } catch (SftpException e) {
            e.printStackTrace();
        }

プログラム全体については、ブログを参照してください。

— アンクルジャイン
ソース
3

Andy、リモートシステム上のファイルを削除するには(channelExec)、JSch を使用し、unix / linuxコマンドを渡してファイルを削除する必要があります。

— Pushpinder籐
ソース
2

接続プールと非同期操作をサポートする、成熟した堅牢なSFTPクライアントライブラリであるedtFTPj / PROを試してください。FTPとFTPSもサポートしているため、安全なファイル転送のすべての基盤がカバーされます。

— ブルース・ブラックショー
ソース
2

上記の回答は非常に役に立ちましたが、「壊れたチャネル」、「rsaキーが不明」、「パケットが壊れている」などのさまざまな例外に直面して、それらを機能させるために1日を費やしました。

以下は、JSchライブラリを使用したSFTPファイルのアップロード/ダウンロード用の再利用可能なクラスです。

アップロードの使用：

SFTPFileCopy upload = new SFTPFileCopy(true, /path/to/sourcefile.png", /path/to/destinationfile.png");

ダウンロードの使用：

SFTPFileCopy download = new SFTPFileCopy(false, "/path/to/sourcefile.png", "/path/to/destinationfile.png");

クラスコード：

import com.jcraft.jsch.Channel;
import com.jcraft.jsch.ChannelSftp;
import com.jcraft.jsch.JSch;
import com.jcraft.jsch.Session;
import com.jcraft.jsch.UIKeyboardInteractive;
import com.jcraft.jsch.UserInfo;
import java.io.BufferedInputStream;
import java.io.BufferedOutputStream;
import java.io.ByteArrayInputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import javax.swing.JOptionPane;
import menue.Menue;

public class SFTPFileCopy1 {

    public SFTPFileCopy1(boolean upload, String sourcePath, String destPath) throws FileNotFoundException, IOException {
        Session session = null;
        Channel channel = null;
        ChannelSftp sftpChannel = null;
        try {
            JSch jsch = new JSch();
            //jsch.setKnownHosts("/home/user/.putty/sshhostkeys");
            session = jsch.getSession("login", "mysite.com", 22);
            session.setPassword("password");

            UserInfo ui = new MyUserInfo() {
                public void showMessage(String message) {

                    JOptionPane.showMessageDialog(null, message);

                }

                public boolean promptYesNo(String message) {

                    Object[] options = {"yes", "no"};

                    int foo = JOptionPane.showOptionDialog(null,
                            message,
                            "Warning",
                            JOptionPane.DEFAULT_OPTION,
                            JOptionPane.WARNING_MESSAGE,
                            null, options, options[0]);

                    return foo == 0;

                }
            };
            session.setUserInfo(ui);

            session.setConfig("StrictHostKeyChecking", "no");
            session.connect();
            channel = session.openChannel("sftp");
            channel.setInputStream(System.in);
            channel.setOutputStream(System.out);
            channel.connect();
            sftpChannel = (ChannelSftp) channel;

            if (upload) { // File upload.
                byte[] bufr = new byte[(int) new File(sourcePath).length()];
                FileInputStream fis = new FileInputStream(new File(sourcePath));
                fis.read(bufr);
                ByteArrayInputStream fileStream = new ByteArrayInputStream(bufr);
                sftpChannel.put(fileStream, destPath);
                fileStream.close();
            } else { // File download.
                byte[] buffer = new byte[1024];
                BufferedInputStream bis = new BufferedInputStream(sftpChannel.get(sourcePath));
                OutputStream os = new FileOutputStream(new File(destPath));
                BufferedOutputStream bos = new BufferedOutputStream(os);
                int readCount;
                while ((readCount = bis.read(buffer)) > 0) {
                    bos.write(buffer, 0, readCount);
                }
                bis.close();
                bos.close();
            }
        } catch (Exception e) {
            System.out.println(e);
        } finally {
            if (sftpChannel != null) {
                sftpChannel.exit();
            }
            if (channel != null) {
                channel.disconnect();
            }
            if (session != null) {
                session.disconnect();
            }
        }
    }

    public static abstract class MyUserInfo
            implements UserInfo, UIKeyboardInteractive {

        public String getPassword() {
            return null;
        }

        public boolean promptYesNo(String str) {
            return false;
        }

        public String getPassphrase() {
            return null;
        }

        public boolean promptPassphrase(String message) {
            return false;
        }

        public boolean promptPassword(String message) {
            return false;
        }

        public void showMessage(String message) {
        }

        public String[] promptKeyboardInteractive(String destination,
                String name,
                String instruction,
                String[] prompt,
                boolean[] echo) {

            return null;
        }
    }
}
— ゾン
ソース
1

また、SFTPアドオン付きのJFileUpload（Javaも）があります。http：//www.jfileupload.com/products/sftp/index.html

JFileUploadはアプレットであり、libではありません。ライセンスは商用です。アクティブにも見えません。
— のRu-
1

私はZehonと呼ばれるこのSFTP APIを使用しています。これはすばらしいので、多くのサンプルコードで簡単に使用できます。こちらはサイトhttp://www.zehon.comです

2
Zehonは死んだようです。そして、ソースはどこですか？「無料」の背後にある「ライセンス」は何ですか？
— のRu-
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.