A virtual shell implementation
Project description
Fakeshell
Fakeshellは仮想的なシェル環境を提供するパッケージです。
標準で提供されているLinuxコマンドの代わりに、Pythonで実装されたコマンドを実行できます。
fakeshellを使用することで、Linuxシステムのようなサンドボックス環境を再現することができます。
インストール方法
pipを使ってfakeshellをインストールできます。
$ pip install fakeshell
使い方
fakeshellを使うには、PythonからFakeShellクラスをインポートしてインスタンスを作成する必要があります。
FakeShellクラスは、次のように作成できます。
from fakeshell.shell import FakeShell
fake_sh = FakeShell(cwd="/tmp")
FakeShellクラスは、次のようなメソッドを提供しています。
run_command(command: str) -> Generator[str]: FakeShellクラスのrun_commandメソッドを使用すると、指定したコマンドを実行することができます。 コマンドを実行すると、実行結果のジェネレータが返されます。
for result in fake_sh.run_command("ls -l > hoge.txt"):
print(result)
run_commandメソッドによって実行される関数には、以下のような仮想のファイルシステムが提供されます。
仮想ファイルシステム上ではホストマシンのファイルシステムと同じ内容が参照されますが、
ファイルシステムへの読み書きはホストマシンへは影響しません。
- ファイルの読み書き
- ディレクトリの作成、削除
- ファイル、ディレクトリのパーミッション変更
- シンボリックリンクの作成、削除
- ファイルシステムの使用率の確認
独自コマンドを実装する
独自コマンドを実装するには、register_commandを使って関数を登録します。
from fakeshell.interpreter import register_command
def hello(args="", stdin=""):
stdout = f"Hello, {args}"
return stdout
register_command("hello", hello)
登録したコマンドは、以下のようにして実行できます。
for result in fake_sh.run_command("hello John"):
print(result)
FakeSSHサーバを構築する
$ docker pull ghcr.io/phishing-hunter/fakeshell:main
$ docker run --rm -it -d -p 2222:2222 ghcr.io/phishing-hunter/fakeshell:main
$ ssh root@localhost -p 2222 # root/password
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for fakeshell-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b895dc11cd81e1a1ee1ca3b668b868e6bf690bb4f115de304e158bdfc026288c |
|
MD5 | d5a81f4e453d22dd0e56edc02918dac3 |
|
BLAKE2b-256 | acbb7374b91d1409ab9e6cbe3833346635c10da3d30dbef8db9507ed61a64f37 |