elementals 1.3.1__tar.gz → 1.3.2__tar.gz

{elementals-1.3.1 → elementals-1.3.2}/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2022 Eyal Itkin.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+MIT License
+
+Copyright (c) 2022 Eyal Itkin.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.

elementals-1.3.2/PKG-INFO

@@ -0,0 +1,49 @@
+Metadata-Version: 2.1
+Name: elementals
+Version: 1.3.2
+Summary: Basic utilities for CTF (or exploit) scripts
+Home-page: https://github.com/eyalitki/elementals
+Author: Eyal Itkin
+Author-email: eyal.itkin@gmail.com
+License: MIT
+Classifier: Programming Language :: Python
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: colorama
+Requires-Dist: hexdump
+Requires-Dist: pydocstyle
+Requires-Dist: flake8
+Requires-Dist: six
+
+# elementals
+Python package with basic utilities for CTF scripts (works well for exploit PoCs too).
+
+## Install
+```pip install elementals```
+
+## Read The Docs
+https://elementals.readthedocs.io/
+
+## Github
+https://github.com/eyalitki/elementals
+
+## Brief
+The **elementals** python package is a utility package with handy tools for CTF scripts and PoC-style scripts. What was first implemented for personal use in small research scripts was now upgraded to be used by security researchers as a lightweight substitute to the famous pwntools package.
+
+The features included in **elementals** are:
+* **Logger:** Basic (logging based) logger - configured and ready to use 
+* **Prompter:** Metasploit based stdout wrapper for the logger
+* **ProgressBar:** User-friendly graphical progress bar
+* **StatusBar:** User-friendly graphical status bar
+* **createAnchor:** Creates a time-stamped output directory for all script outputs
+* **hexDump:** Stylized hex dump for binary blobs / strings
+
+## Used by
+The **elementals** package is used in most of my scripts and also in my public Github projects:
+* **Scout Debugger** - https://github.com/CheckPointSW/Scout
+* **Karta (IDA Plugin)** - https://github.com/CheckPointSW/Karta
+
+## References
+* E-mail: eyal dot itkin at gmail dot com

{elementals-1.3.1 → elementals-1.3.2}/README.md

@@ -33,5 +33,4 @@ The **elementals** package is used in most of my scripts and also in my public G
 * **Karta (IDA Plugin)** - https://github.com/CheckPointSW/Karta
 
 ## References
-* Twitter: [@EyalItkin](https://twitter.com/EyalItkin)
 * E-mail: eyal dot itkin at gmail dot com

{elementals-1.3.1 → elementals-1.3.2}/elementals/logger.py

@@ -101,28 +101,62 @@ class Logger(logging.Logger):
         pass
 
     @staticmethod
-    def _fixLines(message, prefix):
+    def _stripLine(line):
+        """Remove color escape codes from a (possibly) colored line.
+
+        Args:
+            line (str): log record line
+
+        Return Value:
+            stripped line.
+        """
+        if "\033" not in line:
+            return line
+        result = ''
+        for part in line.split("\033"):
+            if len(result) == '':
+                result += part
+                continue
+            if part.find('m') == -1:
+                result += part
+                continue
+            result += part[part.find('m')+1:]
+        return result
+
+    @staticmethod
+    def _fixLines(message, prefix, is_ui=False):
         """Update a (possibly) multiline record, to better print the prefix.
 
         Args:
-            message (str): log record message
-            prefix  (str): string prefix to be added
+            message            (str): log record message
+            prefix             (str): string prefix to be added
+            is_ui   (bool, optional): is a UI related (colored) formatter? (False by default)
 
         Return Value:
             styled to prefix (possibly multiline) message
         """
+        # Remove possible color coding
+        if not is_ui:
+            message = Logger._stripLine(message)
         if "\n" not in message:
             return prefix + message
-        else:
-            prefix_length = len(prefix)
-            result = ''
-            for line in message.split("\n"):
-                if len(result) == 0:
-                    result += prefix + line + "\n"
-                else:
-                    result += prefix_length * " " + line + "\n"
-            # chop the last new line
-            return result[:-1]
+        prefix_length = len(prefix)
+        result = ''
+        first_line = True
+        for line in message.split("\n"):
+            # If this isn't the first line, the handling is simple
+            if not first_line:
+                result += prefix_length * " " + line + "\n"
+                continue
+            first_line = False
+            # If the first line is empty and this is a UI prompt, don't print anything
+            if is_ui and len(line.strip()) == 0:
+                result += ""
+            else:
+                result += prefix + line + "\n"
+
+        # chop the last new line
+        return result[:-1]
 
 class ColorFormatter(logging.Formatter):
     """Custom color formatter to be used by the std output handler of the Logger class.
@@ -174,7 +208,7 @@ class ColorFormatter(logging.Formatter):
         prefix = super(ColorFormatter, self).format(record)
         record.msg = raw_msg
         record.args = msg_args
-        return self._log_styles[record.levelno] + Logger._fixLines(super(ColorFormatter, self).format(record)[len(prefix):], prefix) + Style.RESET_ALL
+        return self._log_styles[record.levelno] + Logger._fixLines(super(ColorFormatter, self).format(record)[len(prefix):], prefix, is_ui=True) + Style.RESET_ALL
 
 class LinesFormatter(logging.Formatter):
     """Custom formatter to add support for multiline records."""

{elementals-1.3.1 → elementals-1.3.2}/elementals/prompter.py

@@ -141,7 +141,7 @@ class PrompterFormatter(ColorFormatter):
         record.msg  = raw_msg
         record.args = msg_args
         # avoid a double prefix
-        record.msg  = Logger._fixLines(super(ColorFormatter, self).format(record)[len(prefix) - len(self_prefix):], prefix)
+        record.msg  = Logger._fixLines(super(ColorFormatter, self).format(record)[len(prefix) - len(self_prefix):], prefix, is_ui=True)
         record.args = []
         result = super(PrompterFormatter, self).format(record)
         record.msg  = raw_msg

elementals-1.3.2/elementals.egg-info/PKG-INFO

@@ -0,0 +1,49 @@
+Metadata-Version: 2.1
+Name: elementals
+Version: 1.3.2
+Summary: Basic utilities for CTF (or exploit) scripts
+Home-page: https://github.com/eyalitki/elementals
+Author: Eyal Itkin
+Author-email: eyal.itkin@gmail.com
+License: MIT
+Classifier: Programming Language :: Python
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: colorama
+Requires-Dist: hexdump
+Requires-Dist: pydocstyle
+Requires-Dist: flake8
+Requires-Dist: six
+
+# elementals
+Python package with basic utilities for CTF scripts (works well for exploit PoCs too).
+
+## Install
+```pip install elementals```
+
+## Read The Docs
+https://elementals.readthedocs.io/
+
+## Github
+https://github.com/eyalitki/elementals
+
+## Brief
+The **elementals** python package is a utility package with handy tools for CTF scripts and PoC-style scripts. What was first implemented for personal use in small research scripts was now upgraded to be used by security researchers as a lightweight substitute to the famous pwntools package.
+
+The features included in **elementals** are:
+* **Logger:** Basic (logging based) logger - configured and ready to use 
+* **Prompter:** Metasploit based stdout wrapper for the logger
+* **ProgressBar:** User-friendly graphical progress bar
+* **StatusBar:** User-friendly graphical status bar
+* **createAnchor:** Creates a time-stamped output directory for all script outputs
+* **hexDump:** Stylized hex dump for binary blobs / strings
+
+## Used by
+The **elementals** package is used in most of my scripts and also in my public Github projects:
+* **Scout Debugger** - https://github.com/CheckPointSW/Scout
+* **Karta (IDA Plugin)** - https://github.com/CheckPointSW/Karta
+
+## References
+* E-mail: eyal dot itkin at gmail dot com

{elementals-1.3.1 → elementals-1.3.2}/elementals.egg-info/not-zip-safe

@@ -1 +1 @@
-
+

{elementals-1.3.1 → elementals-1.3.2}/setup.cfg

@@ -1,12 +1,12 @@
-[bdist_wheel]
-universal = 1
-
-[flake8]
-exclude = .git,__init__.py
-max-line-length = 119
-ignore = E272, E501, E221, E302, E241, E126
-
-[egg_info]
-tag_build = 
-tag_date = 0
-
+[bdist_wheel]
+universal = 1
+
+[flake8]
+exclude = .git,__init__.py
+max-line-length = 119
+ignore = E272, E501, E221, E302, E241, E126
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

{elementals-1.3.1 → elementals-1.3.2}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup, find_packages
 from codecs     import open
 from os         import path
 
-# Different from the README.md, because PyPi struggles with shwoing PNG images
+# Different from the README.md, because PyPi struggles with showing PNG images
 long_description = '''# elementals
 Python package with basic utilities for CTF scripts (works well for exploit PoCs too).
 
@@ -32,11 +32,10 @@ The **elementals** package is used in most of my scripts and also in my public G
 * **Karta (IDA Plugin)** - https://github.com/CheckPointSW/Karta
 
 ## References
-* Twitter: [@EyalItkin](https://twitter.com/EyalItkin)
 * E-mail: eyal dot itkin at gmail dot com'''
 
 setup(name='elementals',
-      version='1.3.1',
+      version='1.3.2',
       description='Basic utilities for CTF (or exploit) scripts',
       author='Eyal Itkin',
       author_email='eyal.itkin@gmail.com',

{elementals-1.3.1 → elementals-1.3.2}/test/test_all.py

@@ -17,6 +17,7 @@ prompt.info("Started the script")
 prompt.info("Phase #1 - collecting the data")
 prompt.addIndent()
 prompt.info("Searching for the tool")
+prompt.debug("Search will take 10 seconds")
 
 s = StatusBar('Searching for the ELF\'s start', 30, time_format = "Elapsed %M:%S -")
 s.start()
@@ -42,9 +43,9 @@ time.sleep( 0.5 )
 p.advance( 200 )
 p.finish( )
 
-prompt.debug("The leaked data is:")
+prompt.info('\033[36m' + "The leaked data is:" + '\033[0m')
 prompt.addIndent()
-prompt.debug(hexDump("".join(map(chr, range(250)))))
+prompt.info('\n' + hexDump(b"".join(map(lambda x: chr(x).encode(), range(250)))))
 prompt.removeIndent()
 
 prompt.removeIndent()

elementals-1.3.1/PKG-INFO

@@ -1,44 +0,0 @@
-Metadata-Version: 2.1
-Name: elementals
-Version: 1.3.1
-Summary: Basic utilities for CTF (or exploit) scripts
-Home-page: https://github.com/eyalitki/elementals
-Author: Eyal Itkin
-Author-email: eyal.itkin@gmail.com
-License: MIT
-Description: # elementals
-        Python package with basic utilities for CTF scripts (works well for exploit PoCs too).
-        
-        ## Install
-        ```pip install elementals```
-        
-        ## Read The Docs
-        https://elementals.readthedocs.io/
-        
-        ## Github
-        https://github.com/eyalitki/elementals
-        
-        ## Brief
-        The **elementals** python package is a utility package with handy tools for CTF scripts and PoC-style scripts. What was first implemented for personal use in small research scripts was now upgraded to be used by security researchers as a lightweight substitute to the famous pwntools package.
-        
-        The features included in **elementals** are:
-        * **Logger:** Basic (logging based) logger - configured and ready to use 
-        * **Prompter:** Metasploit based stdout wrapper for the logger
-        * **ProgressBar:** User-friendly graphical progress bar
-        * **StatusBar:** User-friendly graphical status bar
-        * **createAnchor:** Creates a time-stamped output directory for all script outputs
-        * **hexDump:** Stylized hex dump for binary blobs / strings
-        
-        ## Used by
-        The **elementals** package is used in most of my scripts and also in my public Github projects:
-        * **Scout Debugger** - https://github.com/CheckPointSW/Scout
-        * **Karta (IDA Plugin)** - https://github.com/CheckPointSW/Karta
-        
-        ## References
-        * Twitter: [@EyalItkin](https://twitter.com/EyalItkin)
-        * E-mail: eyal dot itkin at gmail dot com
-Platform: UNKNOWN
-Classifier: Programming Language :: Python
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Description-Content-Type: text/markdown

elementals-1.3.1/elementals.egg-info/PKG-INFO

@@ -1,44 +0,0 @@
-Metadata-Version: 2.1
-Name: elementals
-Version: 1.3.1
-Summary: Basic utilities for CTF (or exploit) scripts
-Home-page: https://github.com/eyalitki/elementals
-Author: Eyal Itkin
-Author-email: eyal.itkin@gmail.com
-License: MIT
-Description: # elementals
-        Python package with basic utilities for CTF scripts (works well for exploit PoCs too).
-        
-        ## Install
-        ```pip install elementals```
-        
-        ## Read The Docs
-        https://elementals.readthedocs.io/
-        
-        ## Github
-        https://github.com/eyalitki/elementals
-        
-        ## Brief
-        The **elementals** python package is a utility package with handy tools for CTF scripts and PoC-style scripts. What was first implemented for personal use in small research scripts was now upgraded to be used by security researchers as a lightweight substitute to the famous pwntools package.
-        
-        The features included in **elementals** are:
-        * **Logger:** Basic (logging based) logger - configured and ready to use 
-        * **Prompter:** Metasploit based stdout wrapper for the logger
-        * **ProgressBar:** User-friendly graphical progress bar
-        * **StatusBar:** User-friendly graphical status bar
-        * **createAnchor:** Creates a time-stamped output directory for all script outputs
-        * **hexDump:** Stylized hex dump for binary blobs / strings
-        
-        ## Used by
-        The **elementals** package is used in most of my scripts and also in my public Github projects:
-        * **Scout Debugger** - https://github.com/CheckPointSW/Scout
-        * **Karta (IDA Plugin)** - https://github.com/CheckPointSW/Karta
-        
-        ## References
-        * Twitter: [@EyalItkin](https://twitter.com/EyalItkin)
-        * E-mail: eyal dot itkin at gmail dot com
-Platform: UNKNOWN
-Classifier: Programming Language :: Python
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Description-Content-Type: text/markdown