pywebexec 0.1.1__py3-none-any.whl → 1.1.0__py3-none-any.whl

{pywebexec-0.1.1.dist-info → pywebexec-1.1.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: pywebexec
-Version: 0.1.1
+Version: 1.1.0
 Summary: Simple Python HTTP Exec Server
 Home-page: https://github.com/joknarf/pywebexec
 Author: Franck Jouvanceau
@@ -58,6 +58,7 @@ Requires-Dist: cryptography>=40.0.2
 Requires-Dist: Flask>=2.0.3
 Requires-Dist: Flask-HTTPAuth>=4.8.0
 Requires-Dist: gunicorn>=21.2.0
+Requires-Dist: ldap3>=2.9.1
 
 [![Pypi version](https://img.shields.io/pypi/v/pywebexec.svg)](https://pypi.org/project/pywebexec/)
 ![example](https://github.com/joknarf/pywebexec/actions/workflows/python-publish.yml/badge.svg)
@@ -75,59 +76,93 @@ $ pip install pywebexec
 
 ## Quick start
 
+* put in a directory the scripts/commands/links to commands you want to expose
 * start http server serving current directory executables listening on 0.0.0.0 port 8080
-```
+```shell
 $ pywebexec
 ```
 
 * Launch commands with params/view live output/Status using browser
-![image](https://github.com/user-attachments/assets/921da56f-6d4b-46e3-b16c-e01a2dc9accf)
+![pywebexec](https://github.com/user-attachments/assets/1bfec34f-8e3b-4ad0-b6c4-c03c957c070a)
 
 ## features
 
-* Serve executables in current directory
+* Serve executables in a directory
 * Launch commands with params from web browser or API call
 * Follow live output
 * Stop command
 * Relaunch command
 * HTTPS support
 * HTTPS self-signed certificate generator
+* Basic Auth
+* LDAP(S)
 * Can be started as a daemon (POSIX)
 * uses gunicorn to serve http/https
+* compatible Linux/MacOS
 
 ## Customize server
-```
-$ pywebexec --listen 0.0.0.0 --port 8080
-$ pywebexec -l 0.0.0.0 -p 8080
+```shell
+$ pywebexec --dir ~/myscripts --listen 0.0.0.0 --port 8080
+$ pywebexec -d ~/myscripts -l 0.0.0.0 -p 8080
 ```
 
-## Basic auth user/password
-```
+## Basic auth 
+
+* single user/password
+```shell
 $ pywebexec --user myuser [--password mypass]
-$ pywebfs -u myuser [-P mypass]
+$ pywebexec -u myuser [-P mypass]
 ```
 Generated password is given if no `--pasword` option
 
+* ldap(s) password check / group member
+```shell
+$ export PYWEBEXEC_LDAP_SERVER=ldap.forumsys.com
+$ export PYWEBEXEC_LDAP_USE_SSL=0
+$ export PYWEBEXEC_LDAP_BIND_DN="cn=read-only-admin,dc=example,dc=com"
+$ export PYWEBEXEC_LDAP_BIND_PASSWORD="password"
+$ export PYWEBEXEC_LDAP_GROUPS=mathematicians,scientists
+$ export PYWEBEXEC_LDAP_USER_ID="uid"
+$ export PYWEBEXEC_LDAP_BASE_DN="dc=example,dc=com"
+$ pywebexec
+```
 ## HTTPS server
 
 * Generate auto-signed certificate and start https server
-```
+```shell
 $ pywebfs --gencert
 $ pywebfs --g
 ```
 
 * Start https server using existing certificate
-```
+```shell
 $ pywebfs --cert /pathto/host.cert --key /pathto/host.key
 $ pywebfs -c /pathto/host.cert -k /pathto/host.key
 ```
 
-## Launch server as a daemon (Linux)
+## Launch server as a daemon
 
-```
+```shell
 $ pywebexec start
 $ pywebexec status
 $ pywebexec stop
 ```
 * log of server are stored in directory `[.config/].pywebexec/pywebexec_<listen>:<port>.log`
 
+## Launch command through API
+
+```shell
+$ curl http://myhost:8080/run_script -H 'Content-Type: application/json' -X POST -d '{ "script_name":"myscript", "param":["param1", ...]}
+```
+
+## API reference
+
+
+| method    | route                       | params/payload     | returns
+|-----------|-----------------------------|--------------------|---------------------|
+| POST      | /run_command                | command: str<br>params: array[str]       | command_id: uuid<br>message: str    |
+| POST      | /stop_command/command_id    |                    | message: str        |
+| GET       | /command_status/command_id  |                    | command_id: uuid<br>command: str<br>params: array[str]<br>start_time: isotime<br>end_time: isotime<br>status: str<br>exit_code: int      |
+| GET       | /command_output/command_id  |                    | output: str<br>status: str         |
+| GET       | /commands                   |                    | array of<br>command_id: uuid<br>command: str<br>start_time: isotime<br>end_time: isotime<br>status: str<br>exit_code: int      |
+| GET       | /executables                |                    | array of str        |

pywebexec-1.1.0.dist-info/RECORD

@@ -0,0 +1,20 @@
+pywebexec/__init__.py,sha256=4spIsVaF8RJt8S58AG_wWoORRNkws9Iwqprj27C3ljM,99
+pywebexec/pywebexec.py,sha256=KyKJcadzuXWh1Im0bkbu0ScEBMwsWTPQg5xPN2jDMdQ,21174
+pywebexec/version.py,sha256=CqDGE4B1ZqZ-56mxeOFcXRTmlxrdOh4ayrjbcPjziE4,411
+pywebexec/static/css/style.css,sha256=NiBoOzZ35eBM1ZP2HFNda-dzOsAv4xRPh3vsvVgLL9c,2513
+pywebexec/static/images/aborted.svg,sha256=_mP43hU5QdRLFZIknBgjx-dIXrHgQG23-QV27ApXK2A,381
+pywebexec/static/images/copy.svg,sha256=d9OwtGh5GzzZHzYcDrLfNxZYLth1Q64x7bRyYxu4Px0,622
+pywebexec/static/images/copy_ok.svg,sha256=mEqUVUhSq8xaJK2msQkxRawnz_KwlCZ-tok8QS6hJ3g,451
+pywebexec/static/images/failed.svg,sha256=ADZ7IKrUyOXtqpivnz3VcH0-Wru-I5MOi3OJAkI3hxk,1439
+pywebexec/static/images/favicon.svg,sha256=ti80IfuDZwIvQcmJxkOeUaB1iMsiyOPmQmVO-h0y1IU,1126
+pywebexec/static/images/running.svg,sha256=vBpiG6ClNUNCArkwsyqK7O-qhIKJX1NI7MSjclNSp_8,1537
+pywebexec/static/images/success.svg,sha256=PJDcCSTevJh7rkfSFLtc7P0pbeh8PVQBS8DaOLQemmc,489
+pywebexec/static/js/script.js,sha256=d16MohpBSvw5evamC4o3_MWayQ1B8Cj9TePNclroUvo,7093
+pywebexec/templates/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pywebexec/templates/index.html,sha256=70yLF1zTrNG4cVFsi9gvy9WYurLXvvMdeR5EFIDafBA,1306
+pywebexec-1.1.0.dist-info/LICENSE,sha256=gRJf0JPT_wsZJsUGlWPTS8Vypfl9vQ1qjp6sNbKykuA,1064
+pywebexec-1.1.0.dist-info/METADATA,sha256=yeelN08_hUHw_GyZIb9oGFmfqr8KhSNJS1zEEnDOWGk,6567
+pywebexec-1.1.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+pywebexec-1.1.0.dist-info/entry_points.txt,sha256=l52GBkPCXRkmlHfEyoVauyfBdg8o-CAtC8qQpOIjJK0,55
+pywebexec-1.1.0.dist-info/top_level.txt,sha256=vHoHyzngrfGdm_nM7Xn_5iLmaCrf10XO1EhldgNLEQ8,10
+pywebexec-1.1.0.dist-info/RECORD,,

pywebexec-0.1.1.dist-info/RECORD

@@ -1,17 +0,0 @@
-pywebexec/__init__.py,sha256=4spIsVaF8RJt8S58AG_wWoORRNkws9Iwqprj27C3ljM,99
-pywebexec/pywebexec.py,sha256=IyNVTDepd5UPfKBHqctIyNez9McNb7z9xN01rXGIK44,12928
-pywebexec/version.py,sha256=PKIMyjdUACH4-ONvtunQCnYE2UhlMfp9su83e3HXl5E,411
-pywebexec/static/images/aborted.svg,sha256=_mP43hU5QdRLFZIknBgjx-dIXrHgQG23-QV27ApXK2A,381
-pywebexec/static/images/copy.svg,sha256=d9OwtGh5GzzZHzYcDrLfNxZYLth1Q64x7bRyYxu4Px0,622
-pywebexec/static/images/copy_ok.svg,sha256=mEqUVUhSq8xaJK2msQkxRawnz_KwlCZ-tok8QS6hJ3g,451
-pywebexec/static/images/failed.svg,sha256=ADZ7IKrUyOXtqpivnz3VcH0-Wru-I5MOi3OJAkI3hxk,1439
-pywebexec/static/images/running.svg,sha256=vBpiG6ClNUNCArkwsyqK7O-qhIKJX1NI7MSjclNSp_8,1537
-pywebexec/static/images/success.svg,sha256=PJDcCSTevJh7rkfSFLtc7P0pbeh8PVQBS8DaOLQemmc,489
-pywebexec/templates/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pywebexec/templates/index.html,sha256=0628YJ1TIH7WPA-UJPfYqEjBo8joYn9685R9Zm5Zz30,12356
-pywebexec-0.1.1.dist-info/LICENSE,sha256=gRJf0JPT_wsZJsUGlWPTS8Vypfl9vQ1qjp6sNbKykuA,1064
-pywebexec-0.1.1.dist-info/METADATA,sha256=83vtZn2DbTfVaOFejyAiKhef_rYEiE6-ko_LMi8yPhg,4770
-pywebexec-0.1.1.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-pywebexec-0.1.1.dist-info/entry_points.txt,sha256=l52GBkPCXRkmlHfEyoVauyfBdg8o-CAtC8qQpOIjJK0,55
-pywebexec-0.1.1.dist-info/top_level.txt,sha256=vHoHyzngrfGdm_nM7Xn_5iLmaCrf10XO1EhldgNLEQ8,10
-pywebexec-0.1.1.dist-info/RECORD,,