Python 3「Violent Python」ソースコード

TJ O'Connor 著の書籍「Violent Python」のソースコードです。コードは完全に Python 3 に変換され、PEP8 標準に準拠するようにフォーマットされ、非推奨ライブラリの実装に伴う依存関係の問題を解消するためにリファクタリングされています。

これと同様の変換を、Justin Seitz 著の書籍「Black Hat Python」のソースコードについても私自身が行っています。まだご覧になっていない方は、こちらをご確認ください。

使用方法

プロジェクト用の新しいディレクトリ (DIR) を作成し、その中に仮想環境または venv を作成することを推奨します。その後、git clone でこのリポジトリをクローンし、pip install で要件をインストールします。

user@host:~/DIR$ git clone https://github.com/EONRaider/violent-python3
user@host:~/DIR$ python3 -m venv venv
user@host:~/DIR$ source venv/bin/activate
(venv) user@host:~/DIR$ pip install -r requirements.txt

注意点

• ディレクトリとファイルは、各章で提示されている内容と容易に関連付けられるように命名されています。
• 著者による文字列連結の頻繁な使用は、可読性を高め、より現代的な標準に適合させるために、文字列補間に置き換えられました。
• ファイル、変数、関数、クラス、メソッドの名前は、PEP 8 の命名規則に準拠するようになりました。
• 非推奨の optparse ライブラリは、ソースコード全体で argparse に置き換えられました。すべての引数解析は、各ファイルの __main__ 実行スコープに含まれています。元のコードではオプションとして扱われていた、スクリプト実行に必須だった CLI 引数は、すべて位置引数として実装されています。-h 引数を CLI に指定することで、argparse を使用するすべてのスクリプトで使用法のプロンプトが利用可能になりました。CLI パーサーに境界オブジェクトと制御オブジェクトの両方の役割を任せることは、ソフトウェアアーキテクチャの観点からは決して最善の選択ではありませんが、元のコーダーの意図に準拠する必要があるため、そのままにしています。
• PEP 8: E722 do not use bare except 違反のすべての発生箇所は、より具体的な例外句でリファクタリングされています。
• 著者はファイル/データベースを開いたままにして、開いたファイル/データベースオブジェクトに対して close() メソッドを呼び出さない習慣があります。そのため、ファイルおよびデータベース操作のすべてのインスタンスは、コンテキストマネージャーを使用してリファクタリングされています。
• インタプリタが使用するエンコーディングを参照するコメント（すなわち、# -*- coding: utf-8 -*-）の使用は、Python 3 のデフォルトエンコーディングとして UTF-8 が標準化された（Python 2 の ASCII から置き換え）ため、削除されました。
• ベストプラクティスの観点からは完全に不適切ですが、グローバル変数の使用は、元のコードのロジックから大きく逸脱することを避けるために、そのまま残されています。
• 本書の第 5 章に含まれるコードは、実用的にはせいぜい歴史的なものであるため、リファクタリングされています。その機能の多くは、著者が例として示した非常に特殊なケースだけでなく、ここ数年で現実的でなくなった脆弱性（例えば、トラフィック暗号化に依然として WEP セキュリティアルゴリズムに依存している、あるいは最悪の場合、まったくセキュリティを維持していない 802.11 無線ネットワークからのトラフィックスニッフィング）や、読者がコードの動作を確認しようとする場合に特定の UAV モデルを入手するという不合理な期待に依存しています。この章を読む労力はほぼ無駄であると真っ向から言うのを避けるために、プローブ要求やビーコン要求のスニッフィングに関連するコードからはある程度の有用性を抽出できる可能性があることを付け加えておきます。
• Google と Twitter を扱う第 6 章のコードは、現在の API の処理方法においてあまりにも時代遅れであり、リファクタリングする価値がありません。それらを扱いたい場合は、リファクタリングを行い、このリポジトリにプルリクエストを送信してください。

リファクタリング

以下にリストされていないファイルは、「注意点」セクションで確立されたように、何らかの形でリファクタリングされているものとみなされます。

• chapter01/vuln_scanner.py は、存在しないファイルが実行時に OSError 例外を引き起こすような構造になっていました。そのため、check_vulns() を呼び出す反復制御は、メイン関数で定義された条件文に移動されました。
• chapter02/nmap_scan.py は、非推奨の optparse ライブラリを呼び出すためだけにメイン関数を実装していましたが、これは argparse に置き換えられました。そのため、メイン関数は削除されました。元のコードの optparse 呼び出しの一部であった反復制御構造は、スキャンされたポートごとに nmap への新しい呼び出しが実行されるように実装されていました。サイクルの無駄を防ぐために、反復は nmap_scan 関数に移動されました。
• chapter02/ssh_command.py は、初期化コードが __main__ 実行スコープに移動されました。関数のパラメータ名と衝突していた外部スコープで使用されていた変数名が変更されました。返されるプロンプト情報は元々エンコードされていましたが、可読性を高めるためにデコードされました。
• chapter02/ssh_brute.py は、pxssh をスタンドアロンライブラリとしてインポートしていましたが、実際には pexpect ライブラリの下のライブラリです。このバグにより が発生していましたが、修正されました。本に掲載されているコードそのものは、インデントエラーが蔓延しており、使用不可能でしたが、動作可能な状態に修正されました。

翻訳

他の言語でのコントリビューションはこちらで確認できます：

• トルコ語に翻訳されました（Bedirhan Budak による）

コントリビューション

常識として、まずは Issue を介して、このリポジトリに加えたい変更について議論してください。

1. 導入しようとしている修正が実際にプルリクエストにつながることを確認してください。1 行か 2 行の変更は、代わりに Issue でリクエストする必要があります。
2. 必要に応じて、プロジェクト構造の変更に関連する詳細を README.md ファイルで更新してください。
3. 修正を含むコミットメッセージが標準に従っていることを確認してください。方法がわからない場合は、こちら が優れた参考資料です。
4. リクエストはできるだけ早く（通常 48 時間以内）レビューされます。