pywebexec 1.8.4__py3-none-any.whl → 1.9.0__py3-none-any.whl

pywebexec/pywebexec.py

@@ -28,6 +28,8 @@ import logging
 from pathlib import Path
 import pyte
 from . import host_ip
+from flask_swagger_ui import get_swaggerui_blueprint  # new import
+import yaml  # new import
 
 if os.environ.get('PYWEBEXEC_LDAP_SERVER'):
     from ldap3 import Server, Connection, ALL, SIMPLE, SUBTREE, Tls
@@ -35,7 +37,6 @@ if os.environ.get('PYWEBEXEC_LDAP_SERVER'):
 app = Flask(__name__)
 app.secret_key = os.urandom(24)  # Secret key for session management
 app.config['SESSION_COOKIE_SAMESITE'] = 'Lax'  # Add SameSite attribute to session cookies
-app.config['SESSION_COOKIE_SECURE'] = True
 app.config['SESSION_COOKIE_HTTPONLY'] = True
 auth = HTTPBasicAuth()
 
@@ -46,6 +47,7 @@ app.config['LDAP_BASE_DN'] = os.environ.get('PYWEBEXEC_LDAP_BASE_DN')
 app.config['LDAP_BIND_DN'] = os.environ.get('PYWEBEXEC_LDAP_BIND_DN')
 app.config['LDAP_BIND_PASSWORD'] = os.environ.get('PYWEBEXEC_LDAP_BIND_PASSWORD')
 
+
 # Get the Gunicorn error logger
 gunicorn_logger = logging.getLogger('gunicorn.error')
 app.logger.handlers = gunicorn_logger.handlers
@@ -590,7 +592,23 @@ def check_processes():
                         'exit_code': -1,
                     })
 
-parseargs()
+args = parseargs()
+if args.cert:
+    app.config['SESSION_COOKIE_SECURE'] = True
+app.config['TITLE'] = f"{args.title} API"
+
+# Register Swagger UI blueprint with safe token included in API_URL
+SWAGGER_URL = '/v0/documentation'
+API_URL = '/swagger.yaml'
+swaggerui_blueprint = get_swaggerui_blueprint(
+    SWAGGER_URL,
+    API_URL,
+    config={
+        'app_name': f"{args.title} API",
+        'layout': 'BaseLayout'
+    }
+)
+app.register_blueprint(swaggerui_blueprint, url_prefix=SWAGGER_URL)
 
 def log_info(fromip, user, message):
     app.logger.info(f"{user} {fromip}: {message}")
@@ -625,10 +643,10 @@ def stop_command(command_id):
 
 @app.before_request
 def check_authentication():
-    # Check for token in URL if TOKEN_URL is set
     token = app.config.get('TOKEN_URL')
     if token and request.endpoint not in ['login', 'static']:
-        if request.args.get('token') == token:
+        if request.args.get('token') == token or session.get('token') == token:
+            session['token'] = token
             return
         return jsonify({'error': 'Forbidden'}), 403
 
@@ -830,6 +848,20 @@ def do_popup(command_id):
     </html>
     """
 
+@app.route('/swagger.yaml')
+def swagger_yaml():
+    swagger_path = os.path.join(os.path.dirname(__file__), 'swagger.yaml')
+    try:
+        with open(swagger_path, 'r') as f:
+            swagger_spec_str = f.read()
+        swagger_spec = yaml.safe_load(swagger_spec_str)
+        # Set title dynamically using the app configuration
+        swagger_spec['info']['title'] = app.config.get('TITLE', 'PyWebExec API')
+        swagger_spec_str = yaml.dump(swagger_spec)
+        return Response(swagger_spec_str, mimetype='application/yaml')
+    except Exception as e:
+        return Response(f"Error reading swagger spec: {e}", status=500)
+
 def main():
     global COMMAND_STATUS_DIR
     basef = f"{CONFDIR}/pywebexec_{args.listen}:{args.port}"

pywebexec/static/css/style.css

@@ -95,6 +95,7 @@ form {
     height: 30px;
     background-image: url("/static/images/favicon.svg");
     vertical-align: bottom;
+    text-indent: 35px;
 }
 #thStatus {
     cursor: pointer;
@@ -383,4 +384,8 @@ span {
 
 .xterm-accessibility {
     display: none;
+}
+.swaggerlink {
+    text-decoration: none;
+    font-size: 10px;
 }

pywebexec/swagger.yaml

@@ -0,0 +1,54 @@
+swagger: "2.0"
+info:
+  title: PyWebExec API
+  version: "1.0"
+paths:
+  /run_command:
+    post:
+      summary: "Run a command"
+      consumes:
+        - application/json
+      produces:
+        - application/json
+      parameters:
+        - in: body
+          name: commandRequest
+          schema:
+            type: object
+            properties:
+              command:
+                type: string
+              params:
+                type: array
+                items:
+                  type: string
+              rows:
+                type: integer
+              cols:
+                type: integer
+      responses:
+        "200":
+          description: "Command started"
+  /command_status/{command_id}:
+    get:
+      summary: "Get command status"
+      parameters:
+        - in: path
+          name: command_id
+          required: true
+          type: string
+      responses:
+        "200":
+          description: "Command status returned"
+  /commands:
+    get:
+      summary: "List commands"
+      responses:
+        "200":
+          description: "List of all commands"
+  /executables:
+    get:
+      summary: "List executables"
+      responses:
+        "200":
+          description: "List of executables returned as an array of executable names"

pywebexec/templates/index.html

@@ -11,7 +11,7 @@
     <div id="dimmer" class="dimmer">
         <div class="dimmer-text">Server not available</div>
     </div>
-    <h2><span class="status-icon title-icon"></span>{{ title }}</h2>
+    <h2><span class="status-icon title-icon">{{ title }}&nbsp;<a class="swaggerlink" href="/v0/documentation" target="_blank">swagger</a></span></h2>
     <form id="launchForm" class="form-inline">
         <label for="command">Command</label>
         <div class="input-group">

pywebexec/version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '1.8.4'
-__version_tuple__ = version_tuple = (1, 8, 4)
+__version__ = version = '1.9.0'
+__version_tuple__ = version_tuple = (1, 9, 0)

{pywebexec-1.8.4.dist-info → pywebexec-1.9.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: pywebexec
-Version: 1.8.4
+Version: 1.9.0
 Summary: Simple Python HTTP Exec Server
 Home-page: https://github.com/joknarf/pywebexec
 Author: Franck Jouvanceau
@@ -56,6 +56,7 @@ Requires-Dist: python-daemon>=2.3.2
 Requires-Dist: cryptography>=40.0.2
 Requires-Dist: Flask>=2.0.3
 Requires-Dist: Flask-HTTPAuth>=4.8.0
+Requires-Dist: flask-swagger-ui>=4.11.1
 Requires-Dist: pexpect>=4.9.0
 Requires-Dist: gunicorn>=21.2.0
 Requires-Dist: ldap3>=2.9.1

{pywebexec-1.8.4.dist-info → pywebexec-1.9.0.dist-info}/RECORD

@@ -1,8 +1,9 @@
 pywebexec/__init__.py,sha256=197fHJy0UDBwTTpGCGortZRr-w2kTaD7MxqdbVmTEi0,61
 pywebexec/host_ip.py,sha256=Ud_HTflWVQ8789aoQ2RZdT1wGI-ccvrwSWGz_c7T3TI,1241
-pywebexec/pywebexec.py,sha256=Pwsjq9VpM19l10-suEZ5nEXBv-LOaJNZy91ubuAkBos,32541
-pywebexec/version.py,sha256=p_0hDBrc9f-T772HiFHRsyrcnjBKkPgfVRYmFuXiLTo,511
-pywebexec/static/css/style.css,sha256=0hnO7QUqms5XMPkD_veYzcy1FcThuG8Lo13FRkotv-0,7986
+pywebexec/pywebexec.py,sha256=VJH7C8MI18Ybx0KHrPiBsVy17xpO4pfd_KXoNIkVBxg,33724
+pywebexec/swagger.yaml,sha256=0AI4KfQI5ezTF8PP4E_ER6dfiseBi3SiOk6OUj5DjcA,1253
+pywebexec/version.py,sha256=tVZQLc6Xa3Jx-HIvXI86M5yyd0Rhm5eJba4TOa0TXm0,511
+pywebexec/static/css/style.css,sha256=EJ5EqaTPoMMNVwKMKVnElyX_1DnrJGVjrRbeHGGws9c,8074
 pywebexec/static/css/xterm.css,sha256=uo5phWaUiJgcz0DAzv46uoByLLbJLeetYosL1xf68rY,5559
 pywebexec/static/fonts/CommitMonoNerdFontMono-Regular.ttf,sha256=v6nZdSx5cs_TIic8Fujrjzg9u9glWjorDIr7RlwNceM,2370228
 pywebexec/static/fonts/LICENSE,sha256=gsBdbFPfoMkCWYXBnjcYEAILdO0sYdUdNw8qirJQbVI,4395
@@ -37,11 +38,11 @@ pywebexec/static/js/xterm/addon-unicode11.js.map,sha256=paDj5KKtTIUGedQn2x7CaUTD
 pywebexec/static/js/xterm/xterm.js,sha256=H5kaw7Syg-v5bmCuI6AKUnZd06Lkb6b92p8aqwMvdJU,289441
 pywebexec/static/js/xterm/xterm.js.map,sha256=Y7O2Pb-fIS7Z8AC1D5s04_aiW_Jf1f4mCfN0U_OI6Zw,1118392
 pywebexec/templates/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pywebexec/templates/index.html,sha256=Hqranqut5gaZrY3nWmfRmVPQgcfnkV1Jndppkj4PK30,3025
+pywebexec/templates/index.html,sha256=VLcuC0RUkwefDugXWcXsjd5C3owKk5wCJoYIo48xbgk,3106
 pywebexec/templates/popup.html,sha256=3kpMccKD_OLLhJ4Y9KRw6Ny8wQWjVaRrUfV9y5-bDiQ,1580
-pywebexec-1.8.4.dist-info/LICENSE,sha256=gRJf0JPT_wsZJsUGlWPTS8Vypfl9vQ1qjp6sNbKykuA,1064
-pywebexec-1.8.4.dist-info/METADATA,sha256=6ybiOn5xV8duhm7D_QiV7R413JWzUi64ZmACjT4Asv0,8146
-pywebexec-1.8.4.dist-info/WHEEL,sha256=jB7zZ3N9hIM9adW7qlTAyycLYW9npaWKLRzaoVcLKcM,91
-pywebexec-1.8.4.dist-info/entry_points.txt,sha256=l52GBkPCXRkmlHfEyoVauyfBdg8o-CAtC8qQpOIjJK0,55
-pywebexec-1.8.4.dist-info/top_level.txt,sha256=vHoHyzngrfGdm_nM7Xn_5iLmaCrf10XO1EhldgNLEQ8,10
-pywebexec-1.8.4.dist-info/RECORD,,
+pywebexec-1.9.0.dist-info/LICENSE,sha256=gRJf0JPT_wsZJsUGlWPTS8Vypfl9vQ1qjp6sNbKykuA,1064
+pywebexec-1.9.0.dist-info/METADATA,sha256=FcgU6PaxvsLkhP7ppsjb6qDkmb-C7xUrwp7oK2WLSbU,8186
+pywebexec-1.9.0.dist-info/WHEEL,sha256=jB7zZ3N9hIM9adW7qlTAyycLYW9npaWKLRzaoVcLKcM,91
+pywebexec-1.9.0.dist-info/entry_points.txt,sha256=l52GBkPCXRkmlHfEyoVauyfBdg8o-CAtC8qQpOIjJK0,55
+pywebexec-1.9.0.dist-info/top_level.txt,sha256=vHoHyzngrfGdm_nM7Xn_5iLmaCrf10XO1EhldgNLEQ8,10
+pywebexec-1.9.0.dist-info/RECORD,,