WebScripts 1.3.3

This package implements a web server to run scripts or executables from the command line and display the result in a web interface.

WebScripts

Description

This package implements a web server to run scripts or executables from the command line and display the result in a web interface.

Goals

Create a safe, secure and easy way to share console scripts and scripting environnments with your team or people without IT knowledge.

• Secure
  • SAST - Static Application Security Testing using bandit and semgrep
  • Web pentest using Kali Linux Web tools and my little experience in Web Hacking
  • Centralization of logs (using Syslog on Linux and Event Viewer on Windows)
  • Easy to update and patch security issues on Linux (critical functions are implemented in Standard Library and are updated with your system) (WebScripts does not require any python package)
  • Easy to deploy securely
    • Apache and mod_wsgi
    • Nginx as HTTPS proxy
  • Easy to configure securely (read the documentation)
    • INI/CFG syntax
    • JSON syntax
  • Unittest

Requirements

This package require:

• python3
• python3 Standard Library

Optional on Windows:

• pywin32 (to centralize logs in Event Viewer)

Installation

pip install WebScripts

Basic Usages

Command line

WebScripts
python3 -m WebScripts

WebScripts --help
WebScripts -h # Print help message and command line options

WebScripts --interface "192.168.1.2" --port 80
WebScripts -i "192.168.1.2" -p 80 # Change interface and port

# /!\ do not use the --debug option on the production environment
WebScripts --debug
WebScripts -d # Print informations about server configuration in errors pages (404 and 500)

# /!\ do not use the --security option on the production environment
WebScripts --security
WebScripts -s # Do not use HTTP security headers (for debugging)

WebScripts --accept-unauthenticated-user --accept-unknow-user
# Accept unauthenticated user

Python script

import WebScripts
WebScripts.main()

from WebScripts import Configuration, Server, main
from wsgiref import simple_server

config = Configuration()
config.add_conf(
    interface="", 
    port=8000, 
    scripts_path = [
        "./scripts/account",
        "./scripts/passwords"
    ],
    json_scripts_config = [
        "./config/scripts/*.json"
    ],
    ini_scripts_config = [
        "./config/scripts/*.ini"
    ],
    documentations_path = [
        "./doc/*.html"
    ],
    js_path = [
        "./static/js/*.js"
    ],
    statics_path = [
        "./static/html/*.html",
        "./static/css/*.css",
        "./static/images/*.jpg",
        "./static/pdf/*.pdf"
    ],
)
config.set_defaults()
config.check_required()
config.get_unexpecteds()
config.build_types()

server = Server(config)
httpd = simple_server.make_server(server.interface, server.port, server.app)
httpd.serve_forever()

Documentation

Wiki

• Installation
• Usages
• Server Configuration
• Script Configuration
• Argument Configuration
• Logs
• Authentication
• Default Database
• Access and Permissions
• Security Considerations
• API
• Custom WEB Interface
• Modules (Custom responses and code)
• Code analysis for security (SAST)
• Security checks and tests (pentest tools)

Examples

• Deployment
• Add a bash script (for authentication)
• Add a module
• Make a custom API client

PyDoc

• Index
• WebScripts
• Pages
• commons
• utils
• Errors
• Default Database Manager
• Default Upload Manager
• Default Request Manager
• Default module errors

Links

• Pypi
• Github
• RSS feed

Pictures

Index page (dark) Text script (dark) HTML script (light)

License

Licensed under the GPL, version 3.

Run tests

python -m unittest discover -s test -p Test*.py -v

File	Statements	missing	coverage
WebScripts.py	472	7	99%
utils.py	297	7	98%
Errors.py	27	0	100%