説明   |   インストール   |   ウェブサイト   |   モジュール   |   問題   |   支援

iKy

説明

iKy は OSINT ツールであり、メールアドレスまたは他のセレクタから情報を収集し、結果を視覚的インターフェースに表示します。

インストール

前提条件

• Docker
• Docker Compose（Docker Desktop に含まれます）
• （任意）just タスクランナー

クイックスタート

git clone https://gitlab.com/kennbroorg/iKy.git
cd iKy
just build
just up

ブラウザで http://localhost:4300 を開いてください。

すべてのサービスを停止するには:

just down

just up は backend、iky-frontend、redis を起動します。デフォルトでは他のサービスは起動されません。

Docker なし（ネイティブ）

Docker を実行できない場合、iKy はネイティブで実行可能です: Caddy がプリビルドのフロントエンドを提供し、Redis + Celery + Uvicorn がローカルプロセスとして動作します。ホストに redis-server、Python 3.12、curl、tar が必要です（Caddy は自動的にダウンロードされます）。

just setup          # venv を作成
just up-native      # 依存関係をインストール、Caddy + フロントエンドをダウンロード、すべてを起動

ブラウザで http://localhost:4300 を開いてください。Ctrl-C または just down-native で停止します。

フロントエンドは最新の GitHub リリースから取得されます — Node ビルドは不要です。 ネイティブモードでは tor は起動されません。darkweb モジュールのみ必要です。

アーキテクチャ

モジュール

iKy は backend/module_registry.py を介して 26 のモジュールをルーティングします:

API キー

アプリケーションがブラウザに読み込まれたら、設定パネルに API キーを入力してください。以下は backend/factories/apikeys_default.json の全フィールドの表です:

🍪 マークの API はブラウザセッションクッキーを使用します。それ以外はサービストークンを使用します。

セッションクッキー

一部のモジュール（LinkedIn、Twitter、TikTok）はブラウザのセッションクッキーを必要とします。クッキーは backend/cookies/ に保存され（コンテナ内では /app/cookies としてマウント）、再起動後も保持されます。ロード方法は 2 つあり、いずれも just を介して行います。

クッキーは個人のセッショントークンです。共有したり、リポジトリにコミットしたりしないでください（backend/cookies/ は git で無視されています）。

オプション A: ブラウザのエクスポートをインポート

Cookie-Editor などの拡張機能を使用してサイトのクッキーを JSON ファイルにエクスポートし、インポートします:

just cookies-import linkedin ~/Downloads/linkedin_cookies.json

オプション B: ブラウザから自動的に抽出

ローカルブラウザから直接クッキーを抽出します。実行前にブラウザを閉じてください（開いているブラウザはクッキーデータベースをロックします）:

# インストールされているすべてのブラウザを試す (firefox, chrome, brave, edge)
just cookies-grab linkedin linkedin.com

# または特定のブラウザを指定
just cookies-grab linkedin linkedin.com brave

このコマンドはブラウザごとに読み取り可能なものと不可能なものを報告し、モジュールが必要とするクッキーが見つかった場合のみファイルを書き込みます。たとえば、LinkedIn は li_at と JSESSIONID を必要とします。

クッキーは定期的に期限切れになります（LinkedIn クッキーは 1～3 か月で期限切れ）。モジュールの認証が停止したら、コマンドを再度実行してください。

開発

開発ワークフローでは、リンター/pre-commit フック用の virtualenv と、ビルドおよび実行用の Docker（またはネイティブの just up-native フロー） を使用します。

開発環境のセットアップ

just をインストールしてから:

just setup
source .venv/bin/activate

これにより、pre-commit と ruff を含む Python virtualenv が作成され、git フックがインストールされます。

一般的なレシピ

iKy の更新

最新の変更をプルし、Docker イメージを再ビルドします:

git pull
just rebuild

API キーを更新後も保持するには、グラフィカルインターフェースの apikey メニューでエクスポート/インポートオプションを使用してください。

Wiki

• iKy Wiki

動画デモ

Vimeo

プロジェクトを支援する

このプロジェクトを使用している、何かを学んだ、または単に気に入った場合、私にコーヒーを一杯ごちそうしてプロジェクトを支援することを検討してください。そうすることで、このようなオープンソースプロジェクトにより多くの時間を割くことができます。

免責事項

プロジェクトに貢献した、または貢献しているすべての人（私を含む）は、このツールの使用（合法的な使用も非合法的な使用も、および「その他の」使用も）について責任を負いません。

このソフトウェアは当初ジョークとして書かれ、その後教育目的（自分自身を教育するため）で書かれたものであり、現在の目標はコミュニティと協力して質の高いフリーソフトウェアを提供することであることを認識してください。品質が優れていない（時には良くもない）場合でも、私たちは卓越性を追求するよう努めています。

収集されるすべての情報は無料でオンラインで入手可能であり、ツールはそれを発見、収集、表示しようと努めるだけであることを考慮してください。 多くの場合、ツールは発見と収集の目標を達成できません。必要な API をロードしてから、私の母のことを思い出さないでください。 API をロードしても期待する「素敵な」ものが表示されない場合は、私の母を思い出す前に他のメールアドレスを試してください。 それでも期待する「素敵な」ものが表示されない場合は、Issue を作成するか、メールまたはいずれかのソーシャルメディアで連絡してください。ただし、私の母は作成者でもプロジェクトに貢献しているわけでもないことを認識してください。

ご満足いただけない場合でも、返金はいたしません。 あなたが私たちがこのツールを楽しんでいるのと同じくらい、このツールを楽しんでいただけることを願っています。努力は大きく、今も続いています（時間、知識、コーディング、テスト、レビューなど）が、私たちはもう一度やり直すでしょう。 説明書および/またはこの免責事項を明確に読めない場合は、ツールを使用しないでください。

ちなみに、私の母を思い出し続ける人たちへ、彼女は何年も前に亡くなりましたが、私は彼女がすぐそばにいるかのように愛しています。