https://github.com/karkason/pywinsandbox

Windows Sandbox Utillities Python Package
https://github.com/karkason/pywinsandbox

Last synced: 3 months ago
JSON representation

Windows Sandbox Utillities Python Package

• Host: GitHub
• URL: https://github.com/karkason/pywinsandbox
• Owner: karkason
• License: mit
• Created: 2020-03-21T12:31:40.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-06-26T05:23:51.000Z (5 months ago)
• Last Synced: 2024-07-06T13:43:37.293Z (4 months ago)
• Language: Python
• Size: 51.8 KB
• Stars: 130
• Watchers: 7
• Forks: 17
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# PyWinSandbox

Python [Windows Sandbox](https://techcommunity.microsoft.com/t5/windows-kernel-internals/windows-sandbox/ba-p/301849) library.

Create a new Windows Sandbox machine, control it with a simple RPyC interface.

A good usage for this library would be to easily run sandboxed tests in a controlled envionment.

Quick Start

------------

PyWinSandbox can be installed using pip:

```sh

$ pip3 install -U pywinsandbox

```

If you want to run the latest version of the code, you can install from git:

```sh

$ pip3 install -U git+git://github.com/karkason/pywinsandbox.git

```

Note that the Windows Sandbox should be enabled in your system in order to use PyWinSandbox. [See the following Microsoft article on how to do that.](https://techcommunity.microsoft.com/t5/windows-kernel-internals/windows-sandbox/ba-p/301849)

Examples

-------

```python

import winsandbox

sandbox = winsandbox.new_sandbox()

sandbox.rpyc.modules.subprocess.run('explorer .')

# Create a sandbox with a mapped directory.

# Directories are mapped under desktop.

sandbox = winsandbox.new_sandbox(folder_mappers=[winsandbox.FolderMapper(r'C:\users\public')])

tree = sandbox.rpyc.modules.subprocess.check_output(r'cmd /c tree %userprofile%\Desktop\public')

# Create an offline sandbox with a logon script.

sandbox = winsandbox.new_sandbox(networking=False, logon_script="explorer .")

```

Also a console script is available:

```sh

# wsb / winsandbox are aliases

# Create an interactive sandbox session. Spawns an IPython shell.

wsb -i

# Spawn an "offline" Windows Sandbox instance, with a command line.

wsb -s "explorer C:\windows\system32" 

```

Windows Shell Extension

-------

A shell extension is also available to easily sandbox executables with the right click menu:

![Shell Extension](https://i.imgur.com/WXrE1du.png)

```sh

# Run these commands with Administrator privileges

# Register the shell extension

wsb -r

# Unregister the shell extension

wsb -u

```