RFID解析、エミュレーション、およびペネトレーションテストのためのハードウェアツール。125kHz、13.56MHzプロトコル(MIFARE、iClass、ISO14443/15693)をサポートし、セキュリティ研究向けの鍵回復、スニッフィング、スクリプティング機能を備えています。
# Iceman Fork - Proxmark
ProxmarkはRFIDのスイスアーミーナイフのようなツールであり、世界中の大多数のRFIDタグとやり取りすることができます。元々はJonathan Westhuesによって製作されたこのデバイスは、現在では愛好家によるRFID分析のための定番ツールとなっています。
Icemanリポジトリは機能と性能の頂点と考えられており、チップの識別、ペネトレーションテスト、プログラミングを自動化する非常に有用で便利な多数のコマンドやPython/LUAスクリプトを幅広く提供しています。
| 最新リリース | Coverity | コントリビューター |
|:--------------:|:--------:|:------------:|
| [](https://github.com/RfidResearchGroup/proxmark3/releases/latest) | [](https://scan.coverity.com/projects/proxmark3-rrg-iceman-repo)|  |
| Actions OSX CI | Actions Ubuntu CI | Actions Windows CI |
|:--------------:|:------------------:|:------------------:|
| [](https://github.com/RfidResearchGroup/proxmark3/actions/workflows/macos.yml) | [](https://github.com/RfidResearchGroup/proxmark3/actions/workflows/ubuntu.yml) | [](https://github.com/RfidResearchGroup/proxmark3/actions/workflows/windows.yml) |
# 目次
- [Iceman Fork - Proxmark](#iceman-fork---proxmark)
- [目次](#table-of-contents)
- [PROXMARK3のインストールと概要](#proxmark3-installation-and-overview)
- [注意事項 / 役立つドキュメント](#notes--helpful-documents)
- [ビルド方法](#how-to-build)
- [Proxmark5](#proxmark5)
- [Proxmark3 RDV4](#proxmark3-rdv4)
- [汎用Proxmark3プラットフォーム](#generic-proxmark3-platforms)
- [何が変わったか](#what-has-changed)
- [開発](#development)
- [対応オペレーティングシステム](#supported-operating-systems)
- [コンパイル済みバイナリ](#precompiled-binaries)
- [GUI](https://github.com/rfidresearchgroup/proxmark3/blob/master/doc/md/Use_of_Proxmark/Promark-GUIs.md)
- [公式チャンネル](#official-channels)
- [メンテナー](#maintainers)
- [引用](#citation)
- [著作権およびライセンス条項](#copyright-and-licensing-terms)
# PROXMARK3 のインストールと概要
| インストール | Proxmark3の使用方法 |
| :------------------: | :------------------: |
| [Linux - セットアップとビルド](https://github.com/rfidresearchgroup/proxmark3/blob/master/doc/md/Installation_Instructions/Linux-Installation-Instructions.md) | [コンパイル手順](https://github.com/rfidresearchgroup/proxmark3/blob/master/doc/md/Use_of_Proxmark/0_Compilation-Instructions.md)|
| [Linux - ModemManagerに関する重要な注意事項](https://github.com/rfidresearchgroup/proxmark3/blob/master/doc/md/Installation_Instructions/ModemManager-Must-Be-Discarded.md) | [Proxmark3クライアント機能の検証](https://github.com/rfidresearchgroup/proxmark3/blob/master/doc/md/Use_of_Proxmark/1_Validation.md)|
| [macOS - Homebrew & HomeBrew Tap Formulaのアップグレード](https://github.com/rfidresearchgroup/proxmark3/blob/master/doc/md/Installation_Instructions/macOS-Homebrew-Installation-Instructions.md) | [初回使用と検証](https://github.com/rfidresearchgroup/proxmark3/blob/master/doc/md/Use_of_Proxmark/2_Configuration-and-Verification.md)|
| [macOS - MacPorts](https://github.com/rfidresearchgroup/proxmark3/blob/master/doc/md/Installation_Instructions/macOS-MacPorts-Installation-Instructions.md) | [コマンドと機能](https://github.com/rfidresearchgroup/proxmark3/blob/master/doc/md/Use_of_Proxmark/3_Commands-and-Features.md)|
| [macOS - セットアップとビルド](https://github.com/rfidresearchgroup/proxmark3/blob/master/doc/md/Installation_Instructions/macOS-Compile-From-Source-Instructions.md) |[スタンドアロンモード](https://github.com/rfidresearchgroup/proxmark3/blob/master/doc/standalone)|
| [Windows - セットアップとビルド](https://github.com/rfidresearchgroup/proxmark3/blob/master/doc/md/Installation_Instructions/Windows-Installation-Instructions.md) ||
| [Termux / Android - セットアップとビルド](https://github.com/rfidresearchgroup/proxmark3/blob/master/doc/termux_notes.md) ||
| [iOS - セットアップとビルド](https://github.com/rfidresearchgroup/proxmark3/blob/master/doc/md/Installation_Instructions/iOS-Installation-Instructions.md)
| [Blue Sharkマニュアル](https://github.com/rfidresearchgroup/proxmark3/blob/master/doc/bt_manual_v10.md) | [コマンドチートシート](https://github.com/rfidresearchgroup/proxmark3/blob/master/doc/cheatsheet.md)|
| [高度なコンパイルパラメータ](https://github.com/rfidresearchgroup/proxmark3/blob/master/doc/md/Use_of_Proxmark/4_Advanced-compilation-parameters.md) | [その他のチートシート](https://github.com/RfidResearchGroup/proxmark3/wiki/More-cheat-sheets)|
| [トラブルシューティング](https://github.com/rfidresearchgroup/proxmark3/blob/master/doc/md/Installation_Instructions/Troubleshooting.md) | [クライアントコマンドセット完全版](https://github.com/rfidresearchgroup/proxmark3/blob/master/doc/commands.md) |
| [JTAG](https://github.com/rfidresearchgroup/proxmark3/blob/master/doc/jtag_notes.md) | [T5577入門ガイド](https://github.com/rfidresearchgroup/proxmark3/blob/master/doc/T5577_Guide.md)|
## ノート / 役立つドキュメント
| ノート |||
| ------------------- |:-------------------:| -------------------:|
|[UARTに関するノート](https://github.com/rfidresearchgroup/proxmark3/blob/master/doc/uart_notes.md)|[Termux / Androidに関するノート](https://github.com/rfidresearchgroup/proxmark3/blob/master/doc/termux_notes.md)|[パスに関するノート](https://github.com/rfidresearchgroup/proxmark3/blob/master/doc/path_notes.md)|
|[フレームフォーマットに関するノート](https://github.com/rfidresearchgroup/proxmark3/blob/master/doc/new_frame_format.md)|[トレースログ / wiresharkに関するノート](https://github.com/rfidresearchgroup/proxmark3/blob/master/doc/trace_notes.md)|[EMVに関するノート](https://github.com/rfidresearchgroup/proxmark3/blob/master/doc/emv_notes.md)|
|[外部フラッシュに関するノート](https://github.com/rfidresearchgroup/proxmark3/blob/master/doc/ext_flash_notes.md)|[loclassに関するノート](https://github.com/rfidresearchgroup/proxmark3/blob/master/doc/loclass_notes.md)|[Coverity Scanの設定と実行に関するノート](https://github.com/rfidresearchgroup/proxmark3/blob/master/doc/md/Development/Coverity-Scan-Config-and-Run.md)|
|[Proxmark3で使用されるファイルフォーマットに関するノート](https://github.com/rfidresearchgroup/proxmark3/blob/master/doc/extensions_notes.md)|[MFUバイナリフォーマットに関するノート](https://github.com/rfidresearchgroup/proxmark3/blob/master/doc/mfu_binary_format_notes.md)|[FPGA & ARMに関するノート](https://github.com/rfidresearchgroup/proxmark3/blob/master/doc/fpga_arm_notes.md)|
|[スタンドアロンモードの開発](https://github.com/rfidresearchgroup/proxmark3/blob/master/armsrc/Standalone/readme.md)|[スタンドアロンモードに関するWiki](https://github.com/RfidResearchGroup/proxmark3/wiki/Standalone-mode)|[マジックUIDカードに関するノート](https://github.com/rfidresearchgroup/proxmark3/blob/master/doc/magic_cards_notes.md)|
|[色の使用に関するノート](https://github.com/rfidresearchgroup/proxmark3/blob/master/doc/colors_notes.md)|[Makefile vs CMake](https://github.com/rfidresearchgroup/proxmark3/blob/master/doc/md/Development/Makefile-vs-CMake.md)|[クローナーガンに関するノート](https://github.com/rfidresearchgroup/proxmark3/blob/master/doc/cloner_notes.md)|
|[cliparserの使用に関するノート](https://github.com/rfidresearchgroup/proxmark3/blob/master/doc/cliparser.md)|[クロックに関するノート](https://github.com/rfidresearchgroup/proxmark3/blob/master/doc/clocks.md)|[MIFARE DESFireに関するノート](https://github.com/rfidresearchgroup/proxmark3/blob/master/doc/desfire.md)|
|[CIPURSEに関するノート](https://github.com/rfidresearchgroup/proxmark3/blob/master/doc/cipurse.md)|[NDEF type4aに関するノート](https://github.com/rfidresearchgroup/proxmark3/blob/master/doc/ndef_type4a.md)|[非公式MIFARE DESFireバイブル](https://github.com/rfidresearchgroup/proxmark3/blob/master/doc/unofficial_desfire_bible.md)|[iClass legrec-legbruteキーリカバリに関するノート](https://github.com/rfidresearchgroup/proxmark3/blob/master/doc/iclass_legrec_legbrute_key_recovery.md)|[ダウングレード攻撃に関するノート](https://github.com/rfidresearchgroup/proxmark3/blob/master/doc/hid_downgrade.md)|||
# ビルド方法
## Proxmark5
最新のハードウェア世代はProxmark5と呼ばれています。搭載機能は以下の通りです。
- MCU: AT32F435、288 MHzのArtery Cortex-M4
- Gowin FPGA
- TypeC拡張ポート (CEP)
- BLE / Wifi / バッテリーアドオン (Esp32c2経由)
- 交換可能なアンテナ (LF、HF、UHF)
- 125、134、250、375、500 KHz低周波アンテナ (LF)
- 13.56 MHz高周波アンテナ (HF)
- アドオンとして: 860-960 MHz超高周波アンテナ (UHF)、**未開発**
現時点では、Proxmark5 固有の手順はすべて[単一の Getting Started ガイド](https://github.com/rfidresearchgroup/proxmark3/blob/master/doc/md/PM5_Start_Here/Getting_Started_With_PM5.md)にまとめられています。
Proxmark5 デバイスのビルド、フラッシュ、実行についてはそちらをお読みください。コンパイル環境の構築については、上記の表にある手順リンクを参照してください。
- ⚠ ファームウェアは現時点では安定しておらず、活発に開発が進められています。
## Proxmark3 RDV4
Proxmark3 RDV4 デバイスのビルド、フラッシュ、実行については、上記の表にある手順リンクを参照してください。
## 汎用 Proxmark3 プラットフォーム
このリポジトリを汎用 Proxmark3 プラットフォーム向けにビルドするには、[高度なコンパイルパラメータ](https://github.com/rfidresearchgroup/proxmark3/blob/master/doc/md/Use_of_Proxmark/4_Advanced-compilation-parameters.md)を読むことを強くお勧めします。
ここでは、以下のデバイスを汎用 Proxmark3 プラットフォームとして定義します。
**サポート対象**
- RDV1、RDV2、RDV3 easy
- Ryscorp 製グリーン PCB バージョン
- Radiowar 製ブラック PCB バージョン
- 多数の中国製 RDV3 easy 互換バージョン(kkmoon、PiSwords など)
- Proxmark3 SE(Special Edition)(BLE 対応)
- Proxmark3 X
- **注**: コミュニティによるテスト済み
- **注**: デバイスのハードウェアは不明
- iCopy-X
- **注**: [iCopy-X オープンソースファームウェア](https://github.com/lab-401/icopy-x)をインストールした場合**のみ**互換性があります
- 工場出荷ファームウェアは**互換性がありません**(クライアントコマンドが異なる/工場出荷 UI はクローズドソース/工場出荷ファームウェアはタグ DRM を強制します)
**非サポート**
- ⚠ Proxmark Evolution(EVO)
- **注**: ピン配置が不明です。
- ⚠ Ryscorp Proxmark3 Pro
- **注**: デバイスの fpga が異なり、ピン配置が不明です。
- **注**: 同社は消滅し、顧客は何の情報も得られていません。
**実験的サポート**
- ⚠ Proxmark3 Ultimate
- **注**: デバイスのハードウェアは不明
- **注**: このデバイス向けの FPGA イメージがビルドされています。自己責任で使用してください。
**サポート状況不明**
- ⚠ VX
- **注**: デバイスのハードウェアは不明
これらの新しい未知のモデルについては、このリポジトリが動作するかどうか、また動作させるために何を行ったかをコミュニティから報告していただく必要があります。
**汎用 Proxmark3 プラットフォームの 256KB フラッシュメモリサイズ**
> ⚠ **注**:
> ARM チップに内蔵されているフラッシュメモリのサイズに注意を払う必要があります。
> 512KB であれば問題ありませんが、256KB の場合はこのリポジトリをさらに機能を削ってコンパイルする必要があります。
> このリポジトリのブートローダーがインストールされていれば、`./pm3-flash-all` を実行したときにデバイスのサイズを確認できます。
> そうでない場合は、Proxmark3 クライアント `./pm3` を実行したときの開始メッセージにサイズが報告されます。
>
> [注意! 256KB フラッシュメモリに関する注意事項をお読みください](https://github.com/rfidresearchgroup/proxmark3/blob/master/doc/md/Use_of_Proxmark/4_Advanced-compilation-parameters.md#256KB-versions)
# 変更点
更新を維持するよう努めている[変更履歴ファイル](https://github.com/rfidresearchgroup/proxmark3/blob/master/CHANGELOG.md)を参照してください。
# 開発
> ⚠ **注**: これは最先端のリポジトリです。メンテナーはこのリポジトリで活発に作業しており、コードをより理解しやすく、ナビゲートしやすく、ビルドしやすく、テストしやすく、貢献しやすくするために定期的にコードを再構成します。そのため、**コードレイアウトに定期的に大きな変更が加えられることを想定してください**。
> 👉 **忘れないでください!** コードに貢献する予定がある場合は、まず[コーディングスタイルの注意事項](https://github.com/rfidresearchgroup/proxmark3/blob/master/CONTRIBUTING.md)をお読みください。
私たちは Proxmark3 に機能を追加し、その後でバグを取り除くという考え方が好きなので、通常は皆さんの貢献を迅速にマージします。
貢献に興味がある方は、[公開ロードマップ](https://github.com/RfidResearchGroup/proxmark3/wiki/Public-Roadmap)から読み始めるのが最適です。
## 対応オペレーティングシステム
このリポジトリは以下で問題なくコンパイルできます
- Windows 10 上の WSL1
- Windows 10/11 上の WSL2
- Proxspace 環境 [リリース v3.xx](https://github.com/Gator96100/ProxSpace/releases)
- Windows/MinGW 環境
- Ubuntu、ParrotOS、Gentoo、Pentoo、Kali、NetHunter、Arch Linux、Fedora、Debian、Raspbian
- Android / Termux
- macOS / Homebrew(または MacPorts、実験的) / Apple Silicon M1
- iOS(脱獄済み、rootful)
- Docker コンテナ
- [ Iceman リポジトリベースの ubuntu 18.04 コンテナ ](https://hub.docker.com/r/secopsconsult/proxmark3)
- [ Iceman フォークベースのコンテナ v1.7 ](https://hub.docker.com/r/iceman1001/proxmark3/)
## コンパイル済みバイナリ
[Proxmark3 コンパイル済みビルド](https://www.proxmarkbuilds.org/) を参照してください
## 公式チャンネル
コミュニティはどこで見つけられますか?
- [RFID Hacking コミュニティ Discord サーバー](https://t.ly/d4_C)
- [Proxmark3 IRC チャンネル](https://web.libera.chat/?channels=#proxmark3)
- [Proxmark3 subreddit](https://www.reddit.com/r/proxmark3/)
## メンテナー
すべてのディストリビューションおよびパッケージのメンテナーの皆様へ、私たちは皆様の作業を容易にしようと努めました。
`make install` が利用可能になりました。詳細を知りたい場合は、
このドキュメントがお役に立ちます
- [メンテナー向けの注意事項](https://github.com/rfidresearchgroup/proxmark3/blob/master/doc/md/Development/Maintainers.md)
## 引用
このリポジトリを全体的に引用するには、この bibtex を使用してください:
```
@misc{proxmark3,
author = {C. {Herrmann} and P. {Teuwen} and O. {Moiseenko} and M. {Walker} and others},
title = {{Proxmark3 -- Iceman repo}},
howpublished = {\url{https://github.com/RfidResearchGroup/proxmark3}},
keywords = {rfid nfc iceman proxmark3 125khz 134khz 13.56mhz},
}
```
リポジトリの特定の状態を参照する必要がある場合は、コミット番号またはアクセス日を使用してください。例:
```
note = {Accessed: commit 12327f71a27da23831901847886aaf20e8ad3ca0}
note = {Accessed: 2021-01-01}
```
## 著作権およびライセンス条項
各貢献はその著作者の著作権に帰属します。[AUTHORS](https://github.com/rfidresearchgroup/proxmark3/blob/master/AUTHORS.md) を参照してください。
Proxmark3 のソースコードは、通常 **GPLv3 以降** と呼ばれる以下のライセンス条項に基づいています。
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
GPLv3 のコピーは [LICENSE](https://github.com/rfidresearchgroup/proxmark3/blob/master/LICENSE.txt) で入手できます。
一部の依存関係は、Proxmark3 のライセンス条項と互換性のある他の自由ライセンス条項に基づいている場合があります。それぞれの説明を参照してください。