SFTPでのファイル送受信が行えるまでを構築していきます。

LaravelからSFTP転送でのファイル操作を行う（league/flysystem-sftp）

<hr>
Laravel ファイル操作
<ol>
<li><a href="/posts/7">local/public ディスク編</a></li>
<li><a href="/posts/8">Amazon S3 編</a></li>
<li>SFTP 編</li>
</ol>
<hr>
Laravel5.6.7（2018 年 2 月 28 日リリース）から、SFTP でのファイル操作がサポートされました。 
<a href="https://github.com/laravel/framework/pull/23308" rel="noopener noreferrer" target="_blank">[5.6] SFTP driver #23308</a>
今回は Laravel を使い、SFTP でのファイル送受信が行えるまでを構築していきます。
<h2 id="contents">Contents</h2>
<ol>
<li><a href="#%E9%96%8B%E7%99%BA%E7%92%B0%E5%A2%83">開発環境</a></li>
<li><a href="#sftp-%E3%81%A8%E3%81%AF">SFTP とは</a></li>
<li><a href="#sftp-%E3%83%89%E3%83%A9%E3%82%A4%E3%83%90%E3%81%AE%E3%82%A4%E3%83%B3%E3%82%B9%E3%83%88%E3%83%BC%E3%83%AB">SFTP ドライバのインストール</a></li>
<li><a href="#%E8%A8%AD%E5%AE%9A%E6%83%85%E5%A0%B1%E3%81%AE%E8%BF%BD%E5%8A%A0">設定情報の追加</a></li>
<li><a href="#%E3%82%B5%E3%83%BC%E3%83%93%E3%82%B9%E3%83%97%E3%83%AD%E3%83%91%E3%82%A4%E3%83%80%E3%81%AE%E4%BD%9C%E6%88%90">サービスプロパイダの作成</a>
<ol>
<li><a href="#%E3%82%B5%E3%83%BC%E3%83%93%E3%82%B9%E3%83%97%E3%83%AD%E3%83%91%E3%82%A4%E3%83%80%E7%94%9F%E6%88%90">サービスプロパイダ生成</a></li>
<li><a href="#sftp-%E3%82%B5%E3%83%BC%E3%83%93%E3%82%B9%E3%83%97%E3%83%AD%E3%83%91%E3%82%A4%E3%83%80%E5%AE%9F%E8%A3%85">SFTP サービスプロパイダ実装</a></li>
</ol>
</li>
<li><a href="#%E5%8B%95%E4%BD%9C%E7%A2%BA%E8%AA%8D">動作確認</a>
<ol>
<li><a href="#%E3%82%B3%E3%83%B3%E3%83%88%E3%83%AD%E3%83%BC%E3%83%A9%E4%BD%9C%E6%88%90">コントローラ作成</a></li>
<li><a href="#%E3%83%AB%E3%83%BC%E3%83%86%E3%82%A3%E3%83%B3%E3%82%B0">ルーティング</a></li>
</ol>
</li>
</ol>
<h2 id="開発環境">開発環境</h2>
今回の開発環境は以下の通りです。
<ul>
<li>Linux CentOS 7</li>
<li>Apache 2.4</li>
<li>PHP 7.2</li>
<li>Laravel 5.6</li>
</ul>
Laravel のバージョンは 5.6.7 以上です。
Laravel のルートディレクトリを「laravel/」とします。
<h2 id="sftp-とは">SFTP とは</h2>
SFTP（SSH File Transfer Protocol）は、SSH 接続にて暗号化や認証を行い、安全かつ高速にファイル転送を実現する転送プロトコルです。クライアントソフトでは Windows の WinSCP などが有名です。
<h2 id="sftp-ドライバのインストール">SFTP ドライバのインストール</h2>
SFTP ドライバを使う為には、league/flysystem-sftp パッケージを導入する必要があります。以下の composer コマンドを叩きインストールします。
<pre><code class="hljs language-shell"># Laravel ルートディレクトリへ移動する
cd /path/to/laravel

# league/flysystem-sftp パッケージをインストール
composer require league/flysystem-sftp

# 実行結果
[demo@localhost laravel]# composer require league/flysystem-sftp
Using version ^1.0 for league/flysystem-sftp
./composer.json has been updated
Loading composer repositories with package information
Updating dependencies (including require-dev)
Package operations: 2 installs, 0 updates, 0 removals
 - Installing phpseclib/phpseclib (2.0.10): Downloading (100%)
 - Installing league/flysystem-sftp (1.0.15): Downloading (100%)
phpseclib/phpseclib suggests installing ext-libsodium (SSH2/SFTP can make use of some algorithms provided by the libsodium-php extension.)
phpseclib/phpseclib suggests installing ext-mcrypt (Install the Mcrypt extension in order to speed up a few other cryptographic operations.)
phpseclib/phpseclib suggests installing ext-gmp (Install the GMP (GNU Multiple Precision) extension in order to speed up arbitrary precision integer arithmetic operations.)
Writing lock file
Generating optimized autoload files
> Illuminate\Foundation\ComposerScripts::postAutoloadDump
> @php artisan package:discover
Discovered Package: fideloper/proxy
Discovered Package: laravel/tinker
Discovered Package: nunomaduro/collision
Package manifest generated successfully.
</code></pre>
もしくは、composer.json に以下を追加して、composer update でも導入できます。
<pre><code class="hljs language-json">"require": {
 "php": ">=7.1.3",
 "fideloper/proxy": "~4.0",
 "laravel/framework": "5.6.*",
 "laravel/tinker": "~1.0",
 "league/flysystem-sftp": "^1.0" // ← ここを追加
},
</code></pre>
<h2 id="設定情報の追加">設定情報の追加</h2>
インストールが完了したら、設定ファイルへ SFTP の設定を追加します。
<dl class="description_setting">
<dt>laravel/config/filesystems.php</dt>
<dd>
<pre><code class="hljs language-php">'sftp' => [
 'driver' => 'sftp',
 'host' => '192.168.99.99',
 'port' => 22,
 'username' => 'myname',
 'password' => 'mypass',
 'privateKey' => '/path/to/privatekey',
 'root' => '/tmp',
 'timeout' => 10,
],
</code></pre>
</dd>
</dl>
各項目は以下の通りです。
<ul>
<li>driver
<ul>
<li>ドライバ種別</li>
</ul>
</li>
<li>host
<ul>
<li>ホスト名</li>
</ul>
</li>
<li>port
<ul>
<li>ポート番号</li>
</ul>
</li>
<li>username
<ul>
<li>ユーザ名</li>
</ul>
</li>
<li>password
<ul>
<li>パスワード</li>
</ul>
</li>
<li>privateKey
<ul>
<li>秘密鍵までのパス（使用しない場合は空白）</li>
</ul>
</li>
<li>root
<ul>
<li>ログイン後の初期パス</li>
</ul>
</li>
<li>timeout
<ul>
<li>接続できない時間がどれくらい続いたら切断するか（秒）</li>
</ul>
</li>
</ul>
<h2 id="サービスプロパイダの作成">サービスプロパイダの作成</h2>
次に、サービスプロパイダを作成します。
<h3 id="サービスプロパイダ生成">サービスプロパイダ生成</h3>
artisan コマンドでサービスプロパイダクラスを生成します。 Laravel ルートディレクトリへ移動し、以下のコマンドを叩きます。
<pre><code class="hljs language-shell"># Laravel ルートディレクトリへ移動
cd /path/to/laravel

# サービスプロパイダファイルを生成する
php artisan make:provider SftpServiceProvider

# 実行結果
[demo@localhost laravel]# php artisan make:provider SftpServiceProvider
Provider created successfully.
</code></pre>
laravel/app/Providers 配下に SftpServiceProvider.php が生成されます。
<pre><code class="hljs language-shell">laravel
├─ app
│   ├─ Providers
│   │   ├─ SftpServiceProvider.php
</code></pre>
<dl class="description_setting">
<dt>laravel/app/Providers/SftpServiceProvider.php</dt>
<dd>
<pre><code class="hljs language-php">&#x3C;?php

namespace App\Providers;

use Illuminate\Support\ServiceProvider;

class SftpServiceProvider extends ServiceProvider
{
 /**
 * Bootstrap services.
 *
 * @return void
 */
 public function boot()
 {
//
 }

 /**
 * Register services.
 *
 * @return void
 */
 public function register()
 {
//
 }
}
</code></pre>
</dd>
</dl>
<h3 id="sftp-サービスプロパイダ実装">SFTP サービスプロパイダ実装</h3>
それでは生成した SFTP サービスプロパイダクラスを実装していきます。以下のようになります。
<dl class="description_setting">
<dt>laravel/app/Providers/SftpServiceProvider.php</dt>
<dd>
<pre><code class="hljs language-php">&#x3C;?php

namespace App\Providers;

use Storage;
use League\Flysystem\Filesystem;
use Illuminate\Support\ServiceProvider;
use League\Flysystem\Sftp\SftpAdapter;

class SftpServiceProvider extends ServiceProvider
{
 /**
 * Bootstrap services.
 *
 * @return void
 */
 public function boot()
 {
 Storage::extend('sftp', function ($app, $config) {
 return new Filesystem(new SftpAdapter([
 'host' => $config['host'],
 'port' => $config['port'],
 'username' => $config['username'],
 'password' => $config['password'],
 'privateKey' => $config['privateKey'],
 'root' => $config['root'],
 'timeout' => $config['timeout'],
 ]));
 });
 }

 /**
 * Register services.
 *
 * @return void
 */
 public function register()
 {
 //
 }
}
</code></pre>
</dd>
</dl>
Storage ファサードの extend() メソッドで、第一引数には登録する種別 sftp を渡しつつ、第二引数でクロージャを定義しています。
各設定変数を SftpAdapter インスタンス化の際に渡し、それらを Filesystem のインスタンスに渡します。
これで、Filesystem で SFTP が使えるようになりました。
<h2 id="動作確認">動作確認</h2>
実装が完了したので、実際に動かして試してみます。
<h3 id="コントローラ作成">コントローラ作成</h3>
コントローラに Storage ファサードを使ってファイル操作を記述します。
<dl class="description_setting">
<dt>laravel/app/Http/Controllers/SampleController.php</dt>
<dd>
<pre><code class="hljs language-php">&#x3C;?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;
use Illuminate\Support\Facades\Storage;

class SampleController extends Controller
{
public function index()
 {
 $contents = file_get_contents(storage_path('test.txt'));
 Storage::disk('sftp')->put('file.txt', $contents);
 }
}
</code></pre>
</dd>
</dl>
アプリケーション側の Storage/app配下にある test.txt を読み込み、SFTP にて接続先の/tmp ディレクトリへ file.txt として保存します。
ちなみにコントローラには記述がありませんが、.env に初期ディレクトリを/tmp と記述したので、接続先の初期ディレクトリは/tmp となり、put() メソッドでファイル名だけを記述した場合の保存先パスは/tmp/file.txt となります。
<h3 id="ルーティング">ルーティング</h3>
最後にルーティングを記述します。
<dl class="description_setting">
<dt>laravel/routes/web.php</dt>
<dd>
<pre><code class="hljs language-php">Route::get('/sample/sftp', 'SampleController@index');
</code></pre>
</dd>
</dl>
準備も終わったので、ブラウザから 
http<a href=""></a>://YOURDOMAIN/sample/sftp 
にアクセスして一連の処理を動かし、保存先であるサーバを確認してみます。
<div class="img_wrap"><amp-img layout="responsive" src="/images/posts/87/SfE5W3DPaIHcxRq4XMEE.png" width="400" height="135" alt="アップロード先サーバファイル一覧画面"></div>
問題なくファイルが保存されました。これで SFTP でのファイル操作は完了です。
<h2 id="まとめ">まとめ</h2>
接続までできてしまえば、あとは通常のファイル操作と変わらないので、Storage ファサードから取得などのメソッドを叩いてみてください。

<hr>
Laravel ファイル操作
<ol>
<li><a href="/posts/7">local/public ディスク編</a></li>
<li><a href="/posts/8">Amazon S3 編</a></li>
<li>SFTP 編</li>
</ol>
<hr>
Laravel5.6.7（2018 年 2 月 28 日リリース）から、SFTP でのファイル操作がサポートされました。 
<a href="https://github.com/laravel/framework/pull/23308" rel="noopener noreferrer" target="_blank">[5.6] SFTP driver #23308</a>
今回は Laravel を使い、SFTP でのファイル送受信が行えるまでを構築していきます。
<h2 id="contents">Contents</h2>
<ol>
<li><a href="#%E9%96%8B%E7%99%BA%E7%92%B0%E5%A2%83">開発環境</a></li>
<li><a href="#sftp-%E3%81%A8%E3%81%AF">SFTP とは</a></li>
<li><a href="#sftp-%E3%83%89%E3%83%A9%E3%82%A4%E3%83%90%E3%81%AE%E3%82%A4%E3%83%B3%E3%82%B9%E3%83%88%E3%83%BC%E3%83%AB">SFTP ドライバのインストール</a></li>
<li><a href="#%E8%A8%AD%E5%AE%9A%E6%83%85%E5%A0%B1%E3%81%AE%E8%BF%BD%E5%8A%A0">設定情報の追加</a></li>
<li><a href="#%E3%82%B5%E3%83%BC%E3%83%93%E3%82%B9%E3%83%97%E3%83%AD%E3%83%91%E3%82%A4%E3%83%80%E3%81%AE%E4%BD%9C%E6%88%90">サービスプロパイダの作成</a>
<ol>
<li><a href="#%E3%82%B5%E3%83%BC%E3%83%93%E3%82%B9%E3%83%97%E3%83%AD%E3%83%91%E3%82%A4%E3%83%80%E7%94%9F%E6%88%90">サービスプロパイダ生成</a></li>
<li><a href="#sftp-%E3%82%B5%E3%83%BC%E3%83%93%E3%82%B9%E3%83%97%E3%83%AD%E3%83%91%E3%82%A4%E3%83%80%E5%AE%9F%E8%A3%85">SFTP サービスプロパイダ実装</a></li>
</ol>
</li>
<li><a href="#%E5%8B%95%E4%BD%9C%E7%A2%BA%E8%AA%8D">動作確認</a>
<ol>
<li><a href="#%E3%82%B3%E3%83%B3%E3%83%88%E3%83%AD%E3%83%BC%E3%83%A9%E4%BD%9C%E6%88%90">コントローラ作成</a></li>
<li><a href="#%E3%83%AB%E3%83%BC%E3%83%86%E3%82%A3%E3%83%B3%E3%82%B0">ルーティング</a></li>
</ol>
</li>
</ol>
<h2 id="開発環境">開発環境</h2>
今回の開発環境は以下の通りです。
<ul>
<li>Linux CentOS 7</li>
<li>Apache 2.4</li>
<li>PHP 7.2</li>
<li>Laravel 5.6</li>
</ul>
Laravel のバージョンは 5.6.7 以上です。
Laravel のルートディレクトリを「laravel/」とします。
<h2 id="sftp-とは">SFTP とは</h2>
SFTP（SSH File Transfer Protocol）は、SSH 接続にて暗号化や認証を行い、安全かつ高速にファイル転送を実現する転送プロトコルです。クライアントソフトでは Windows の WinSCP などが有名です。
<h2 id="sftp-ドライバのインストール">SFTP ドライバのインストール</h2>
SFTP ドライバを使う為には、league/flysystem-sftp パッケージを導入する必要があります。以下の composer コマンドを叩きインストールします。
<pre><code class="hljs language-shell"># Laravel ルートディレクトリへ移動する
cd /path/to/laravel

# league/flysystem-sftp パッケージをインストール
composer require league/flysystem-sftp

# 実行結果
[demo@localhost laravel]# composer require league/flysystem-sftp
Using version ^1.0 for league/flysystem-sftp
./composer.json has been updated
Loading composer repositories with package information
Updating dependencies (including require-dev)
Package operations: 2 installs, 0 updates, 0 removals
 - Installing phpseclib/phpseclib (2.0.10): Downloading (100%)
 - Installing league/flysystem-sftp (1.0.15): Downloading (100%)
phpseclib/phpseclib suggests installing ext-libsodium (SSH2/SFTP can make use of some algorithms provided by the libsodium-php extension.)
phpseclib/phpseclib suggests installing ext-mcrypt (Install the Mcrypt extension in order to speed up a few other cryptographic operations.)
phpseclib/phpseclib suggests installing ext-gmp (Install the GMP (GNU Multiple Precision) extension in order to speed up arbitrary precision integer arithmetic operations.)
Writing lock file
Generating optimized autoload files
> Illuminate\Foundation\ComposerScripts::postAutoloadDump
> @php artisan package:discover
Discovered Package: fideloper/proxy
Discovered Package: laravel/tinker
Discovered Package: nunomaduro/collision
Package manifest generated successfully.
</code></pre>
もしくは、composer.json に以下を追加して、composer update でも導入できます。
<pre><code class="hljs language-json">"require": {
 "php": ">=7.1.3",
 "fideloper/proxy": "~4.0",
 "laravel/framework": "5.6.*",
 "laravel/tinker": "~1.0",
 "league/flysystem-sftp": "^1.0" // ← ここを追加
},
</code></pre>
<h2 id="設定情報の追加">設定情報の追加</h2>
インストールが完了したら、設定ファイルへ SFTP の設定を追加します。
<dl class="description_setting">
<dt>laravel/config/filesystems.php</dt>
<dd>
<pre><code class="hljs language-php">'sftp' => [
 'driver' => 'sftp',
 'host' => '192.168.99.99',
 'port' => 22,
 'username' => 'myname',
 'password' => 'mypass',
 'privateKey' => '/path/to/privatekey',
 'root' => '/tmp',
 'timeout' => 10,
],
</code></pre>
</dd>
</dl>
各項目は以下の通りです。
<ul>
<li>driver
<ul>
<li>ドライバ種別</li>
</ul>
</li>
<li>host
<ul>
<li>ホスト名</li>
</ul>
</li>
<li>port
<ul>
<li>ポート番号</li>
</ul>
</li>
<li>username
<ul>
<li>ユーザ名</li>
</ul>
</li>
<li>password
<ul>
<li>パスワード</li>
</ul>
</li>
<li>privateKey
<ul>
<li>秘密鍵までのパス（使用しない場合は空白）</li>
</ul>
</li>
<li>root
<ul>
<li>ログイン後の初期パス</li>
</ul>
</li>
<li>timeout
<ul>
<li>接続できない時間がどれくらい続いたら切断するか（秒）</li>
</ul>
</li>
</ul>
<h2 id="サービスプロパイダの作成">サービスプロパイダの作成</h2>
次に、サービスプロパイダを作成します。
<h3 id="サービスプロパイダ生成">サービスプロパイダ生成</h3>
artisan コマンドでサービスプロパイダクラスを生成します。 Laravel ルートディレクトリへ移動し、以下のコマンドを叩きます。
<pre><code class="hljs language-shell"># Laravel ルートディレクトリへ移動
cd /path/to/laravel

# サービスプロパイダファイルを生成する
php artisan make:provider SftpServiceProvider

# 実行結果
[demo@localhost laravel]# php artisan make:provider SftpServiceProvider
Provider created successfully.
</code></pre>
laravel/app/Providers 配下に SftpServiceProvider.php が生成されます。
<pre><code class="hljs language-shell">laravel
├─ app
│   ├─ Providers
│   │   ├─ SftpServiceProvider.php
</code></pre>
<dl class="description_setting">
<dt>laravel/app/Providers/SftpServiceProvider.php</dt>
<dd>
<pre><code class="hljs language-php">&#x3C;?php

namespace App\Providers;

use Illuminate\Support\ServiceProvider;

class SftpServiceProvider extends ServiceProvider
{
 /**
 * Bootstrap services.
 *
 * @return void
 */
 public function boot()
 {
//
 }

 /**
 * Register services.
 *
 * @return void
 */
 public function register()
 {
//
 }
}
</code></pre>
</dd>
</dl>
<h3 id="sftp-サービスプロパイダ実装">SFTP サービスプロパイダ実装</h3>
それでは生成した SFTP サービスプロパイダクラスを実装していきます。以下のようになります。
<dl class="description_setting">
<dt>laravel/app/Providers/SftpServiceProvider.php</dt>
<dd>
<pre><code class="hljs language-php">&#x3C;?php

namespace App\Providers;

use Storage;
use League\Flysystem\Filesystem;
use Illuminate\Support\ServiceProvider;
use League\Flysystem\Sftp\SftpAdapter;

class SftpServiceProvider extends ServiceProvider
{
 /**
 * Bootstrap services.
 *
 * @return void
 */
 public function boot()
 {
 Storage::extend('sftp', function ($app, $config) {
 return new Filesystem(new SftpAdapter([
 'host' => $config['host'],
 'port' => $config['port'],
 'username' => $config['username'],
 'password' => $config['password'],
 'privateKey' => $config['privateKey'],
 'root' => $config['root'],
 'timeout' => $config['timeout'],
 ]));
 });
 }

 /**
 * Register services.
 *
 * @return void
 */
 public function register()
 {
 //
 }
}
</code></pre>
</dd>
</dl>
Storage ファサードの extend() メソッドで、第一引数には登録する種別 sftp を渡しつつ、第二引数でクロージャを定義しています。
各設定変数を SftpAdapter インスタンス化の際に渡し、それらを Filesystem のインスタンスに渡します。
これで、Filesystem で SFTP が使えるようになりました。
<h2 id="動作確認">動作確認</h2>
実装が完了したので、実際に動かして試してみます。
<h3 id="コントローラ作成">コントローラ作成</h3>
コントローラに Storage ファサードを使ってファイル操作を記述します。
<dl class="description_setting">
<dt>laravel/app/Http/Controllers/SampleController.php</dt>
<dd>
<pre><code class="hljs language-php">&#x3C;?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;
use Illuminate\Support\Facades\Storage;

class SampleController extends Controller
{
public function index()
 {
 $contents = file_get_contents(storage_path('test.txt'));
 Storage::disk('sftp')->put('file.txt', $contents);
 }
}
</code></pre>
</dd>
</dl>
アプリケーション側の Storage/app配下にある test.txt を読み込み、SFTP にて接続先の/tmp ディレクトリへ file.txt として保存します。
ちなみにコントローラには記述がありませんが、.env に初期ディレクトリを/tmp と記述したので、接続先の初期ディレクトリは/tmp となり、put() メソッドでファイル名だけを記述した場合の保存先パスは/tmp/file.txt となります。
<h3 id="ルーティング">ルーティング</h3>
最後にルーティングを記述します。
<dl class="description_setting">
<dt>laravel/routes/web.php</dt>
<dd>
<pre><code class="hljs language-php">Route::get('/sample/sftp', 'SampleController@index');
</code></pre>
</dd>
</dl>
準備も終わったので、ブラウザから 
http<a href=""></a>://YOURDOMAIN/sample/sftp 
にアクセスして一連の処理を動かし、保存先であるサーバを確認してみます。
<div class="img_wrap"><img src="/images/posts/87/SfE5W3DPaIHcxRq4XMEE.png" width="400" height="135" alt="アップロード先サーバファイル一覧画面"></div>
問題なくファイルが保存されました。これで SFTP でのファイル操作は完了です。
<h2 id="まとめ">まとめ</h2>
接続までできてしまえば、あとは通常のファイル操作と変わらないので、Storage ファサードから取得などのメソッドを叩いてみてください。

Author