Merge branch 'master' into stable

Author: bugy

README.md

@@ -8,8 +8,8 @@ For system administrators it's a possibility to share their scripts with users,
 
 No script modifications are needed - you add a configuration for each script to the script-server and it takes care of proper UI, validation, execution, etc.  
 
-Example of the user interface during script execution:
-![Example of user interface](https://cloud.githubusercontent.com/assets/1275813/26519407/f0318706-42c0-11e7-8328-34ded505839c.png)
+
+[DEMO server](https://script-server.net)
 
 ## Features
 - Interactive output/input web console
@@ -27,7 +27,7 @@ The features can be configured [per-script](https://github.com/bugy/script-serve
 ## Requirements
 ### Server-side
 Python 3.4 or higher with the following modules:
-* Tornado 4/5
+* Tornado 4 / 5 / 6
 * typing *(for python 3.4 only)*
 
 Some features can require additional modules. Such requirements are specified in a corresponding feature description.
@@ -108,3 +108,6 @@ If you like the project and think you could help with making it better, there ar
 
 Any contribution would be of great help and I will highly appreciate it! 
 If you have any questions, please create a new issue, or concact me via buggygm@gmail.com
+
+## Special thanks
+![JetBrains logo](https://github.com/JetBrains/logos/blob/master/web/jetbrains/jetbrains.svg)

requirements.txt

@@ -1,2 +1,2 @@
 typing
-tornado<6
+tornado>=4

samples/configs/destroy_world.json

@@ -1,5 +1,6 @@
 {
+  "name": "destroy_world",
   "script_path": "./samples/scripts/destroy_world.py",
   "description": "This is a very dangerous script, please be careful when running. Don't forget your protective helmet.",
-  "requires_terminal": true
+  "requires_terminal": false
 }

samples/configs/mult_words.json

@@ -1,8 +1,8 @@
 {
   "name": "Multiple words",
   "script_path": "'mult words.py' 1 'word 2' '' 'word4'",
-  "description": "Executes a complex command specified as a scripts path and prints all incoming parameters",
   "working_directory": "./samples/scripts/",
+  "description": "Executes a complex command specified as a scripts path and prints all incoming parameters",
   "parameters": [
     {
       "name": "Param1",
@@ -15,4 +15,4 @@
       "default": "a single parameter"
     }
   ]
-}
+}

samples/configs/parameterized.json

@@ -1,12 +1,12 @@
 {
   "name": "Very parameterized",
   "script_path": "scripts/parameterized.sh",
+  "working_directory": "./samples",
   "description": "This script does nothing except accepting a lot of parameters and printing them",
   "allowed_users": [
     "*"
   ],
   "include": "${Simple Text}.json",
-  "working_directory": "./samples",
   "parameters": [
     {
       "name": "Simple Int",
@@ -21,14 +21,15 @@
     },
     {
       "name": "Simple Text",
+      "required": true,
       "param": "--simple_text",
       "description": "Parameter Four"
     },
     {
       "name": "Simple List",
       "param": "--simple_list",
-      "description": "Parameter Five",
       "type": "list",
+      "description": "Parameter Five",
       "values": [
         "val1",
         "val3",
@@ -37,15 +38,15 @@
     },
     {
       "name": "File upload",
-      "description": "File upload testing",
+      "param": "--file_upload",
       "type": "file_upload",
-      "param": "--file_upload"
+      "description": "File upload testing"
     },
     {
       "name": "Multiple selection",
-      "description": "Multiselect list",
-      "type": "multiselect",
       "param": "--multiselect",
+      "type": "multiselect",
+      "description": "Multiselect list",
       "values": [
         "Black cat",
         "Brown dog",
@@ -55,74 +56,75 @@
     },
     {
       "name": "Required Text",
+      "required": true,
       "param": "--required_text",
       "description": "Parameter One",
-      "required": true
+      "env_var": "Req_Text"
     },
     {
       "name": "Required List",
+      "required": true,
       "param": "--required_list",
-      "description": "List with required value",
       "type": "list",
-      "required": true,
+      "description": "List with required value",
       "values": [
         "v1",
         "v2"
       ]
     },
     {
       "name": "Constrained Int",
+      "required": "true",
       "param": "--constrained_int",
-      "description": "Parameter Three",
       "type": "int",
-      "required": "true",
       "default": "5",
+      "description": "Parameter Three",
       "min": "-1",
       "max": "123"
     },
     {
       "name": "Default Text",
-      "param": "--def_text",
-      "description": "Text with default value and required",
       "required": true,
-      "default": "some_text"
+      "param": "--def_text",
+      "default": "some_text",
+      "description": "Text with default value and required"
     },
     {
       "name": "Default Boolean",
       "param": "--def_bool",
       "no_value": true,
-      "description": "Boolean Two",
-      "default": true
+      "default": true,
+      "description": "Boolean Two"
     },
     {
       "name": "Constant Text",
-      "description": "Constant value",
       "param": "--const_text",
+      "default": "constOne",
       "constant": true,
-      "default": "constOne"
+      "description": "Constant value"
     },
     {
       "name": "Command-based list",
       "param": "--var_file",
-      "description": "List parameter 2",
       "type": "list",
+      "description": "List parameter 2",
       "values": {
         "script": "ls /var"
       }
     },
     {
       "name": "Secure Int",
+      "type": "int",
       "description": "Parameter Nine",
-      "secure": true,
-      "type": "int"
+      "secure": true
     },
     {
       "name": "Secure List",
-      "description": "Parameter Ten",
-      "secure": true,
+      "param": "--secure_list",
       "type": "list",
       "default": "qwerty",
-      "param": "--secure_list",
+      "description": "Parameter Ten",
+      "secure": true,
       "values": [
         "qwerty",
         "12345678",
@@ -131,9 +133,9 @@
     },
     {
       "name": "Very long list",
-      "description": "List with very long values",
-      "type": "list",
       "param": "--very_long_list",
+      "type": "list",
+      "description": "List with very long values",
       "values": [
         "some quite long line",
         "short",
@@ -145,25 +147,25 @@
     },
     {
       "name": "Multiselect as secure arguments",
-      "description": "Multiselect list as multiple arguments",
-      "type": "multiselect",
       "required": true,
-      "multiple_arguments": true,
-      "secure": true,
+      "type": "multiselect",
       "default": [
         "multi1",
         "multi 3"
       ],
+      "description": "Multiselect list as multiple arguments",
+      "secure": true,
       "values": [
         "multi1",
         "multi2",
         "multi 3"
-      ]
+      ],
+      "multiple_arguments": true
     },
     {
       "name": "Dependant list",
-      "description": "A list with values depending on other parameters",
       "type": "list",
+      "description": "A list with values depending on other parameters",
       "values": {
         "script": "ls /var/${Command-based list}/${Required Text}"
       }
@@ -175,9 +177,9 @@
     },
     {
       "name": "Audit name",
-      "constant": true,
       "param": "--audit_name",
-      "default": "${auth.audit_name}"
+      "default": "${auth.audit_name}",
+      "constant": true
     },
     {
       "name": "Any IP",
@@ -199,28 +201,28 @@
       "name": "Server file",
       "param": "--server_file",
       "type": "server_file",
+      "secure": true,
       "file_dir": "/var/log",
       "file_extensions": [
         "log"
-      ],
-      "secure": true
+      ]
     },
     {
       "name": "Recursive file",
       "param": "--recurs_file",
       "type": "server_file",
+      "default": [
+        "samples",
+        "configs",
+        "parameterized.json"
+      ],
+      "secure": true,
       "file_dir": "..",
       "file_recursive": true,
       "file_extensions": [
         "json",
         ".log",
         "TXT"
-      ],
-      "secure": true,
-      "default": [
-        "samples",
-        "configs",
-        "parameterized.json"
       ]
     }
   ]

samples/configs/write_file.json

@@ -7,6 +7,14 @@
     "@admin_users",
     "127.0.0.1"
   ],
+  "output_files": [
+    "##any_path#",
+    "~/${filename}",
+    {
+      "type": "inline-image",
+      "path": "##any_path.png#"
+    }
+  ],
   "parameters": [
     {
       "name": "text",
@@ -17,8 +25,8 @@
       "name": "repeats",
       "param": "-r",
       "type": "int",
-      "min": 1,
-      "description": "How many times the text should be written to the file"
+      "description": "How many times the text should be written to the file",
+      "min": 1
     },
     {
       "name": "clear file",
@@ -31,9 +39,5 @@
       "param": "-f",
       "description": "Custom filename"
     }
-  ],
-  "output_files": [
-    "##any_path#",
-    "~/${filename}"
   ]
 }

samples/scripts/parameterized.sh

@@ -48,4 +48,9 @@ else
     echo "--file_upload: "`md5sum "$my_file"`
 fi
 
+echo
+echo 'Environment variables:'
+echo 'Req_Text='"$Req_Text"
+printenv | grep -P '^PARAM_'
+
 sleep 5

src/auth/auth_base.py

@@ -13,7 +13,7 @@ def authenticate(self, request_handler):
     def get_client_visible_config(self):
         return self._client_visible_config
 
-    def get_groups(self, user):
+    def get_groups(self, user, known_groups=None):
         return []
 
 

src/auth/auth_ldap.py

@@ -4,6 +4,7 @@
 from string import Template
 
 from ldap3 import Connection, SIMPLE
+from ldap3.core.exceptions import LDAPAttributeError
 
 from auth import auth_base
 from model import model_helper
@@ -62,6 +63,13 @@ def _load_multiple_entries_values(dn, search_filter, attribute_name, connection)
     return result
 
 
+def get_entry_dn(entry):
+    try:
+        return entry.entry_dn
+    except LDAPAttributeError:
+        return entry._dn
+
+
 class LdapAuthenticator(auth_base.Authenticator):
     def __init__(self, params_dict, temp_folder):
         super().__init__()
@@ -158,7 +166,7 @@ def _get_groups(self, user):
         self._user_groups[user] = groups
         return groups
 
-    def get_groups(self, user):
+    def get_groups(self, user, known_groups=None):
         return self._get_groups(user)
 
     def _fetch_user_groups(self, user_dn, user_uid, connection):
@@ -203,7 +211,7 @@ def _get_user_ids(self, full_username, connection):
             return full_username, None
 
         entry = entries[0]
-        return entry.entry_dn, entry.uid.value
+        return get_entry_dn(entry), entry.uid.value
 
     def _load_groups(self, groups_file):
         if not os.path.exists(groups_file):