HN 日本語サマリー

← 一覧へ戻る
プログラミング

Croc: 2台のコンピュータ間で安全にファイルやフォルダを転送する

Croc: Securely transfer files and folders between two computers (github.com)

27 pointsby gregsadetsky14 コメント

要約

Crocは、コマンドラインインターフェース(CLI)を使用して、任意の2台のコンピュータ間でファイルやフォルダを安全かつ簡単に転送できるツールです。エンドツーエンド暗号化、クロスプラットフォーム対応、中断した転送の再開機能などを備えており、ローカルサーバーやポートフォワーディングなしで利用できます。インストール方法や詳細な使用方法、リレーサーバーの自己ホストについても解説されています。

全文翻訳

フォルダとファイル

[画像: croc]
[画像: Version] [画像: Build Status] [画像: GitHub Sponsors]

このプロジェクトの将来はコミュニティのサポートにかかっています。今すぐスポンサーになりましょう。

概要

crocは、任意の2台のコンピュータ間でファイルやフォルダをシンプルかつ安全に転送できるツールです。私の知る限り、crocは以下の機能をすべて備えた唯一のCLIファイル転送ツールです。

  • 任意の2台のコンピュータ間でデータを転送可能(P2P、リレーフォールバックあり)
  • エンドツーエンド暗号化(PAKEを使用)
  • 簡単なクロスプラットフォーム転送(Windows、Linux、Mac、ブラウザ)
  • 複数ファイルの転送が可能
  • 中断された転送を再開可能
  • ローカルサーバーやポートフォワーディングが不要
  • IPv4フォールバック付きのIPv6ファースト
  • Torのようなプロキシを使用可能

crocの詳細については、私のブログ記事をご覧いただくか、最近のインタビューをお読みください。

[画像: Example]

インストール不要

getcroc.comで、何もインストールせずにcrocを使用できます。

ブラウザ版はCLIと完全に互換性があるため、それらの間でファイルを送受信できます。

インストール

お使いのシステム用の最新リリースをダウンロードするか、コマンドラインからリリースをインストールできます。

curl https://getcroc.com | bash

CLIが転送を送受信する際、24時間に1回、より新しいcrocリリースがないかチェックします。このチェックはバックグラウンドで実行され、更新通知は転送完了後に表示されます。いつでもcroc update --checkを実行して明示的にチェックできます。上記のコマンドでインストールされたものはcroc update(croc upgradeはエイリアス)を使用して、実行可能ファイルがユーザー書き込み可能であれば安定リリースを確認してインストールできます。確認をスキップするには--yesを渡してください。パッケージマネージャーで管理されたインストールやその他のインストールは上書きされることはありません。コマンドは適切なアップグレードガイダンスを表示します。バックグラウンドチェックでのネットワークおよびリリースサービスのエラーは無視されます。--quietは通知を抑制します。

macOSの場合

Homebrewを使用する場合:

brew install croc

MacPortsを使用する場合:

sudo port selfupdate
sudo port install croc
Windowsの場合

ScoopまたはChocolateyで最新リリースをインストールできます。

scoop install croc
choco install croc
nix-envを使用する場合

Nix:

nix-env -i croc
NixOSの場合

これをconfiguration.nixに追加できます。

environment.systemPackages = [
  pkgs.croc
];
Alpine Linuxの場合

Alpineリリースでコミュニティリポジトリを有効にしてからインストールします。

apk add croc

お使いのブランチのバージョンについては、Alpineパッケージインデックスを確認してください。安定版ブランチには古いリリースが含まれている場合があります。選択する前に、ディストリビューションステータスを参照してください。

DebianおよびUbuntuの場合

pkg.hausアーカイブはサードパーティのDebianパッケージを提供しています。リポジトリ設定とサポート対象リリース手順に従ってから実行してください。

sudo apt install croc

アップストリームの.debダウンロードを含むリリースの場合、リリースページからdpkg --print-architectureに一致するファイル(例: croc_VERSION-1_ARCH.deb)をダウンロードします。以下でVERSIONとARCHをダウンロードしたファイル名に置き換えてください。

sudo apt install ./croc_VERSION-1_ARCH.deb

このダウンロードパッケージ方式は、設定済みリポジトリにcrocを提供していない古いDebianおよびUbuntuリリースにも適用されます。APTリポジトリは追加されません。アップグレードするには、新しいパッケージをダウンロードしてください。

FedoraおよびopenSUSEの場合

アップストリームの.rpmダウンロードを含むリリースの場合、リリースページからrpm --eval '%{_arch}'に一致するファイルを選択します。以下でVERSIONとARCHをダウンロードしたファイル名に置き換えてください。

sudo dnf install ./croc-VERSION-1.ARCH.rpm
# openSUSEの場合:
sudo zypper install ./croc-VERSION-1.ARCH.rpm

これらのダウンロードは、CLI、マニュアル、ライセンス通知、シェル補完をインストールします。これらはca-certificatesを必要とし、バックグラウンドサービスは起動しません。パッケージマネージャーを通じてアップグレードしてください。croc updateはパッケージ所有のバイナリを変更しません。アーキテクチャと検証については、Linuxパッケージングを参照してください。

Arch Linuxの場合

pacmanでインストールします。

pacman -S croc
Termuxの場合

pkgでインストールします。

pkg install croc
FreeBSDの場合

pkgでインストールします。

pkg install croc
Conda経由のLinux、macOS、Windows

pixiでグローバルにインストールできます。

pixi global install croc

またはcondaで特定の環境にインストールします。

conda install --channel conda-forge croc
Docker経由のLinux、macOS

以下のワンライナー関数を~/.profileに追加します(任意のPOSIX準拠シェルで動作します)。

croc() { [ $# -eq 0 ] && set -- ""; mkdir -p "$HOME/.config/croc"; docker run --rm -it --user "$(id -u):$(id -g)" -v "$(pwd):/c" -v "$HOME/.config/croc:/.config/croc" -w /c -e CROC_SECRET docker.io/schollz/croc "$@"; }

現在のセッションのためにターミナルに貼り付けることもできます。初回実行時にDockerはイメージをプルします。Docker経由のcrocは、現在のディレクトリとそのサブディレクトリ内でのみ機能します。

ソースからビルド

必要であれば、Goをインストールしてソースからビルドできます(Go 1.27.1+が必要です)。

go install github.com/schollz/croc/v11@latest
Androidの場合

F-Droidアプリが利用可能です。

  • crocgui — オリジナルのポート(Go、基本的なUI)
  • croc-app — ネイティブKotlin/Jetpack Composeクライアント、モダンでモバイルファーストなインターフェース
  • FlCroc — クロスプラットフォームFlutter GUI(Android、Windows、Linux)、転送コアとしてcrocバイナリをラップします。
デスクトップの場合

コミュニティ製のデスクトップアプリ:

  • Croc GUI — macOS、Windows、Linux向けの非公式デスクトップGUI、ドラッグ&ドロップ転送、QRコード、LANモード、リレー/プロキシオプションのためにcrocバイナリをバンドルします。
  • croc-desktop — Linux、macOS、Windows(実験的なiOS/Android)向けの非公式デスクトップGUI、Wails v3で構築。crocをインプロセスで埋め込み、送受信、QRコード、履歴、ログ、オプションのリレーホスティングを提供します。
  • Swamp Swap — 非公式PyQt6 GUIデスクトップアプリ(macOS、Windows、Linux)、通常通りcrocをインストールする必要があります。コンパクトでシンプルになるように作られています。

使用方法

ファイルを送信するには、次のようにします。

$ croc send [ファイル(またはフォルダ)]
Sending 'file-or-folder' (X MB)
Code is: code-phrase

次に、別のコンピュータでファイル(またはフォルダ)を受信するには、次を実行します。

croc code-phrase

コードフレーズは、パスワード認証鍵合意(PAKE)を確立するために使用され、送信者と受信者がエンドツーエンド暗号化に使用する秘密鍵を生成します。

croc sshでターミナルを共有する

Linux、macOS、FreeBSD、OpenBSDで、共有ターミナルを開始するには:

croc ssh

ホストは、読み取り/書き込み参加者と読み取り専用参加者それぞれに、6単語の招待を受け取ります。Unixでは、参加者はコマンドで参加することでプロセスリストから招待を削除します。

CROC_SECRET='six-word-invitation' croc ssh

全員が1つの永続的なターミナルを見ます。複数の読み取り/書き込み参加者が入力できます。読み取り専用参加者は同じ出力を受信しますが、入力は破棄されます。

これはSSHデーモンを公開せず、アカウント、パブリックIP、インバウンドポート、またはSSHキーの設定を必要としません。招待は一時的なTailcat WireGuardパスを認証し、一時的なSSHホストキーをピン留めします。Tailcatは直接パスを確立できない場合にDERPを使用します。Tailcat自体が利用できない場合、クライアントは再認証し、ピン留めされたSSHストリームを通常のcrocリレーで伝送します。リモートコマンド、フォワーディング、SFTPは無効です。招待を受け取った人は誰でも、ホストが停止するまでその横に表示される役割を持ちます。したがって、両方の招待を秘密として扱ってください。

プロトコル、再接続、プラットフォーム、リレー、脅威モデルの詳細については、SSH共有の設計とセキュリティガイドを参照してください。

カスタマイズとオプション
暗号化された一時ストレージ

直接のピアツーピア転送が不便な場合、crocはクライアントサイドで暗号化された暗号文として通常のファイルをアップロードできます。

croc store [ファイル1] [ファイル2]
croc store --downloads 3 --expiration 3d [ファイル1] [ファイル2]
croc store --url https://files.example.com [ファイル1] [ファイル2]

元のcroc send --store構文も引き続きサポートされており、--store-downloads、--store-expiration、--store-url設定があります。

コマンドはブラウザリンクとCLIトークンを表示します。転送は、選択された有効期間(正常なアップロード完了から測定)または設定された受信者数がすべてのファイルをダウンロード、認証、検証した後(いずれか早い方)に期限切れになります。有効期間はデフォルトで1日であり、全体(分 m、時間 h、日 d、週 w)を受け入れます。ダウンロード制限はデフォルトで1です。両方の値はサーバーポリシーの対象となります。引数なしでcrocを実行し、プロンプトでトークンを貼り付けて受信します。自動化のために、プロセスリストからトークンを削除しないでください。

CROC_STORE_TOKEN='croc-store-v1....' croc --out ./downloads

ブラウザリンクはhttps://host/s/id#v1.decryption-keyの形式です。復号鍵は#の後ろにあります。これはURLフラグメントがHTTPリクエストに含まれないため、ストレージサービスは不透明な転送IDは取得しますが、鍵は取得しません。完全なリンクは依然として秘密です。それを持っている人は誰でもファイルを復号し、許可されたダウンロードの1つを請求できます。

転送が利用可能な間、送信者はローカルに保存された取り消しレシートを使用して削除できます。

croc --revoke [transfer-id]

保存モードはオプトインであり、crocの通常のライブリレー転送とは別です。セルフホストされたサービスはcroc store --url(またはcroc send --store --store-url)またはCROC_STORE_URLで選択できます。プロトコル、プライバシー、制限、デプロイメントの詳細については、保存転送の設計とオペレーターガイドを参照してください。

LinuxまたはmacOSでcrocを使用する

LinuxとmacOSでは、送信および受信プロセスは、プロセス名経由での秘密情報の漏洩を避けるために若干異なります。秘密情報を環境変数としてcrocを実行する必要があります。たとえば、秘密情報***で受信するには:

CROC_SECRET=*** croc

シングルユーザーシステムでは、デフォルトの動作を永続的に有効にするには、次を実行します。

croc --classic
カスタムコードフレーズ

独自のコードフレーズ(6文字以上)で送信できます。

croc send --code [コードフレーズ] [ファイル(またはフォルダ)]

デフォルトのパブリック転送では、正確なコードのSHA-256を順序付けられた3つのリレープールで割ったものが、どちらのデプロイメントが両方のピアで使用されるかを決定します。自動生成された送信者は3つのリレーすべてをプローブし、応答した最初の正常なリレーにマッピングされる通常のEFFコードを生成します。カスタムコードはプローブやフォールバックなしで直接マッピングされます。--relay、CROC_RELAY、--ip、およびローカルのみの転送はこのパブリックルーティングルールをバイパスします。生成された送信者は、best-relayに勝ったアドレスをcrocの他の設定ファイルと共にキャッシュし、プローブなしで再利用します。リレー接続の失敗はキャッシュを削除するため、次の送信でプールが再測定されます。ファイルを削除すると、新しい測定が強制されます。

プロンプトなしで上書きを許可する

プロンプトなしでファイルを自動的に上書きするには、--overwriteフラグを使用します。

croc --yes --overwrite <code>
プロンプトなしで両方のファイルを保持する

既存のファイルを保持し、受信ファイルを新しい名前(例: video (1).mkv)で受信するには、--renameフラグを使用します。

croc --yes --rename <code>
フォルダを除外する

フォルダを送信から除外するには、カンマ区切りの除外リストとともに--excludeフラグを使用します。これは、各ファイルの相対パスに対して大文字小文字を区別しない部分文字列マッチングを行うため、指定された文字列のいずれかを含むパスはすべて除外されます。

croc send --exclude "node_modules,.venv" [フォルダ]

部分文字列を含むすべてのパスではなく、特定の1つのファイルを除外する必要がある場合(たとえば、異なる深さにある2つのファイルが同じ名前を共有しており、1つだけ除外したい場合)は、代わりに--exclude-fileを使用します。これはカンマ区切りの相対パスを受け取り、正確にマッチングします。

croc send --exclude-file "subfolder/image.jpg" [フォルダ]
パイプを使用する - stdinとstdout

crocにパイプできます。

cat [ファイル名] | croc send

ファイルを受信してstdoutに出力するには、次を使用できます。

croc --yes [コードフレーズ] > out
テキストを送信する

URLや短いテキストを送信するには、次を使用します。

croc send --text "hello world"
複数ファイルを送信する

ファイルやフォルダを直接リストすることで、複数ファイルを送信できます。

croc send [ファイル1] [ファイル2] [ファイル3] [フォルダ1] [フォルダ2]
QRコードを表示する

QRコード(モバイルデバイス用)を表示するには、次を使用します。

croc send --qr [ファイル(またはフォルダ)]

QRコードはhttps://getcroc.com/?code=...を開き、Webクライアントが受信専用モードで自動的に接続します。

プロキシを使用する

--socks5を追加することで、プロキシ経由でファイルを送信できます。

croc --socks5 "127.0.0.1:9050" send SOMEFILE

リレーホスト名はプロキシによって解決されるため、クライアントはリレーに到達するために動作するDNSサーバーを必要としません。ベアなhost:port、socks5://host:port、およびsocks5h://host:portはすべてプロキシ側のリレーDNSを使用します。ローカルDNSが利用できない場合は、プロキシ自体のIPアドレスを使用してください。両方のピアに--socks5を設定するか(またはSOCKS5_PROXY環境変数を使用)、ブラウザクライアントはブラウザのプロキシ設定を使用します。ネイティブCLIフラグはブラウザを設定しません。

プロキシトラフィックのみを許可するネットワークの場合、送信者で--transport relayを使用して、ファイルデータにSOCKS5対応リレー転送を使用します。

データ転送の選択

ネイティブCLIはデフォルトで--transport autoを使用します。通常の3単語コードPAKEハンドシェイクの後、互換性のある2つのネイティブクライアントはPAKEバウンドTailcatノードIDを作成し、インプロセスTailscaleユーザー空間WireGuardネットワーク上で1つ以上のTCPストリームを開きます。MagicsockはDERPを介して開始し、NATトラバーサルが成功すると接続を直接UDPパスに昇格させます。ピアがブラウザ、古いクライアント、またはTailcatの設定に失敗した場合、両方のクライアントはcrocの既存のリレーデータポートを使用します。パブリックスペル--transport derpは保持されており、厳密モードではTailcatサポートを要求し、croc-relayフォールバックを無効にします。パブリックDERPはベストエフォートであり、公平性制限が適用される場合があります。TailscaleのDERPリファレンスとパフォーマンスガイダンスを参照してください。

暗号化曲線を変更する

暗号化に使用する楕円曲線を選択するには、--curveフラグを使用します。

croc --curve p521 <コードフレーズ>
ハッシュアルゴリズムを変更する

より高速なハッシュには、imohashアルゴリズムを使用します。

croc send --hash imohash SOMEFILE
クリップボードオプション

デフォルトでは、コードフレーズはクリップボードにコピーされます。これを無効にするには:

croc --disable-clipboard send [ファイル名]

秘密情報を環境変数として含む完全なコマンドをコピーするには(Linux/macOSで便利):

croc --extended-clipboard send [ファイル名]

これは、CROC_SECRET="code-phrase" croc(リレー/パスフラグを含む)のような完全なコマンドをコピーします。

クワイエットモード

すべての出力を抑制するには(スクリプトや自動化に便利):

croc --quiet send [ファイル名]
リレーサーバーのセルフホスティング

独自のサーバーを実行できます。

croc relay

デフォルトでは、TCPポート9009-9013を使用します。ポートをカスタマイズできます(例: croc relay --ports 1111,1112)が、少なくとも2つのポートが必要です。

各リレーポートは合計64件の保留中のハンドシェイクと、ソースIPあたり32件を許可します。クライアントは60秒以内に最初の完全なプロトコルメッセージを送信し、5分以内にハンドシェイクを完了する必要があります。Crocは最初のメッセージを自動的に送信します。これらの期限は、認証済み送信者が受信者を待つ時間や転送が実行される時間には影響しません。既存のルームと接続のタイムアウトは引き続き適用されます。

--max-pending-handshakes、--max-pending-handshakes-per-source、--first-message-timeout、--handshake-timeoutを使用してこれらの制限を調整できます。それらの環境変数はCROC_MAX_PENDING_HANDSHAKES、CROC_MAX_PENDING_HANDSHAKES_PER_SOURCE、CROC_FIRST_MESSAGE_TIMEOUT、CROC_HANDSHAKE_TIMEOUTです。すべての値は正である必要があります。合計制限と全体的なタイムアウトは常にソースごとの許可と最初のメッセージタイムアウトをバインドします。

同じNATまたはプロキシの後ろにいるユーザーは、ソース制限を共有します。これには、同じcroc-webブリッジを介して接続するブラウザユーザーも含まれます。ソースごとの制限を合計制限に引き上げると、1つのソースがプールを埋めることに対する保護が無効になります。これらの同時ハンドシェイク制限は、ソースとルーム参加率制限とは別です。高速承認トークンもバウンドハンドシェイクプールを使用します。複数のソースIPがプールを埋めることができます。

自分のリレーを使用してファイルを送信するには:

croc --relay "myrelay.example.com:9009" send [ファイル名]
Dockerでリレーサーバーをセルフホスティング

Dockerでもリレーを実行できます。

docker run -d -p 9009-9013:9009-9013 -e CROC_PASS='YOURPASSWORD' docker.io/schollz/croc

カスタムリレーを使用してファイルを送信するには:

croc --pass YOURPASSWORD --relay "myreal.example.com:9009" send [ファイル名]

カスタムポートを使用するには、CROC_PORTS(カンマ区切り)またはCROC_PORT(ベースポート)を設定します。

docker run -d -p 9010-9011:9010-9011 -e CROC_PORTS='9010,9011' -e CROC_PASS='YOURPASSWORD' docker.io/schollz/croc
Webクライアント

web/のReact/Viteクライアントは、複数のファイルを送受信し、通常のCLIピアによってホストされるcroc sshセッションに参加できます。本番クライアントとWebAssemblyプロトコルランタイムは、スタンドアロンのcroc-webサーバーにのみバンドルされており、生成されたアセットとWebサーバーコードをクロスプラットフォームのcrocバイナリから除外しています。croc-webのLinux amd64ビルドは、各リリースで個別に公開されます。これはサイトとその同一オリジンWebSocketリレーの両方をサービスします。

croc-web getcroc.com

これはデフォルトで127.0.0.1:9014にバインドされ、HTTPSリバースプロキシとして機能します。/はウェブサイトをサービスし、/wsはコード選択されたパブリックリレー(1.getcroc.com、2.getcroc.com、3.getcroc.com、または4.getcroc.com)にブリッジします。直接アクセス可能なローカル開発サーバーの場合、croc-web localhost:5173はlocalhost:5173でバインドしてサービスを提供します。ローカルリスナーまたはアップストリームのcrocリレーをカスタマイズするには、ウェブサイトアドレスの前に--bind、--relays、--portsを使用します。

make build-webを実行すると、無視された本番アセットが生成され、ローカルサーバーがビルドされます。フロントエンド開発、カスタムリレー、リバースプロキシの手順については、web/README.mdを参照してください。

デプロイメント

Disco

Discoがデプロイに使用されます。ルートのDockerfileとdisco.jsonは、同じイメージからビルドされた2つのDiscoサービスとしてcroc-web Webクライアントとcroc TCPリレーをデプロイします。DiscoはHTTPS経由でウェブサイトをサービスし、リレーポート9009-9017はTCPポートとして直接公開されます。

次を使用してデプロイメント環境変数を設定します。

disco env:set \
  SITE_URL=yoururl.com \
  CROC_RELAY_PORTS=9009,9010,9011,9012,9013,9014,9015,9016,9017 \
  CROC_PASS=yourpass \
  --project croc

SITE_URLはhttps://なしのパブリックウェブサイトホスト名である必要があります。プロジェクト名がcrocでない場合は変更してください。webサービスは名前付きcroc-storeボリュームを/www/croc/storageにマウントします。これは設定された--store-dirでもあり、保存された暗号文とメタデータはコンテナの交換や再デプロイメント後も持続します。webサービスは公開TCPポート9020も予約し、未使用のコンテナポート65535にマッピングします。この意図的なポートの衝突により、Discoはストアへの同時アクセスを回避するために、ボリュームを所有する前のWebサービスを停止してから、その置き換えを開始します。ポート9020はアプリケーショントラフィックを運びません。サーバーファイアウォールによってブロックされたままにする必要があります。

保存アップロードポリシーは、disco.jsonを編集せずにデプロイメントごとに設定できます。

disco env:set \
  CROC_STORE_CREATE_RATE=60 \
  CROC_STORE_ACTIVE_UPLOADS=10 \
  CROC_STORE_UPLOAD_TIMEOUT=5m \
  CROC_STORE_TRUSTED_PROXY=VERIFIED_PROXY_IP/32 \
  --project croc --disco YOUR_DISCO_HOST

プロキシプレースホルダーを、crocが見るソケットソースアドレスに置き換えてください。Docker Swarmルーティングでは、これはCaddyのコンテナアドレスではなく、docker network inspect disco-mainによって表示されるlb-disco-mainエンドポイントになる場合があります。各インスタンスでソースを確認し、Dockerネットワークの変更後にも再度確認してください。Caddyの通常のフォワーディング設定はX-Forwarded-Forを提供します。異なる外部クライアントが個別にカウントされ、偽装された着信ヘッダーがそれらのアカウンティングIPを選択できないことを確認してください。Disco生成のCaddy設定を編集したり、不一致を回避するためにプライベートネットワーク全体を信頼したりしないでください。

上記の値はデプロイメントのオーバーライドです。crocのデフォルトは、1時間あたり5回の作成試行とIPあたり2回の未完了アップロードのままです。CROC_STORE_DOWNLOADSは各リンクからのダウンロードを制御し、アップロード制限を引き上げません。タイムアウト、クリーンアップ、レート制限の応答動作については、保存転送オペレーターガイドを参照してください。

CROC_RELAY_PORTSのポートは、disco.jsonのrelayサービスのエントリpublishedPortsと一致する必要があります。Webサービスのデプロイメント専用ポート9020は含めないでください。Discoは環境変数からホストポートマッピングを生成できません。リレーTCPポートがサーバーファイアウォールまたはクラウドセキュリティグループでも開いていることを確認してください。

謝辞

crocは多くのイテレーションを経て進化してきました。貢献に感謝します!特に感謝するのは以下の人々です。

そして、他にも多くの人々がいます!