switch to poetry build system, set new version 1.0.0

Author: hellman

LICENSE

@@ -0,0 +1,31 @@
+[tool.poetry]
+name = "xortool"
+version = "1.0.0"
+description = "A tool to analyze multi-byte xor cipher"
+authors = ["hellman"]
+license = "MIT"
+readme = "README.md"
+keywords = ["xor", "xortool", "cryptanalysis"]
+classifiers = [
+    'Intended Audience :: Information Technology',
+    'Intended Audience :: Science/Research',
+    'Topic :: Security :: Cryptography',
+]
+
+[tool.poetry.scripts]
+xortool = 'xortool.tool_main:main'
+xortool-xor = 'xortool.tool_xor:main'
+
+[tool.poetry.urls]
+homepage = "http://github.com/hellman/xortool"
+
+[tool.poetry.dependencies]
+python = "^3.4"
+docopt = "^0.6.2"
+
+[tool.poetry.dev-dependencies]
+docopt = "^0.6.2"
+
+[build-system]
+requires = ["poetry-core>=1.0.0a5"]
+build-backend = "poetry.core.masonry.api"

MANIFEST.in

@@ -11,8 +11,12 @@ set -epux -o pipefail
 shopt -s inherit_errexit
 
 if [ $# -gt 0 ] && [ "dist" = "$1" ]; then
-    export PATH="./xortool/:$PATH"
     export PYTHONPATH="."
+    xortool="xortool/tool_main.py"
+    xortool_xor="xortool/tool_xor.py"
+else
+    xortool="xortool"
+    xortool_xor="xortool-xor"
 fi
 
 binary_xored_ok() {
@@ -27,49 +31,49 @@ binary_xored() {
     local f="$1"; shift
 
     hexdump -Cv "$f" |cut -s -d' ' -f 3-20 | \
-    xortool --hex -b
+    $xortool --hex -b
     binary_xored_ok
 
     hexdump -Cv "$f" |cut -s -d' ' -f 3-20 | \
-    xortool -x -l 10 -c 00
+    $xortool -x -l 10 -c 00
     binary_xored_ok
 
     rm -rf xortool_out
-    ! xortool -x "$f"
+    ! $xortool -x "$f"
     [ ! -d xortool_out ]
 
     rm -rf xortool_out
-    ! xortool --hex "$f"
+    ! $xortool --hex "$f"
     [ ! -d xortool_out ]
 
-    xortool -c 00 "$f"
+    $xortool -c 00 "$f"
     binary_xored_ok
 
-    xortool --char=00 "$f"
+    $xortool --char=00 "$f"
     binary_xored_ok
 
-    xortool -b "$f"
+    $xortool -b "$f"
     binary_xored_ok
 
-    xortool -b -l 10 "$f"
+    $xortool -b -l 10 "$f"
     binary_xored_ok
 
-    xortool --brute-chars --key-length=10 "$f"
+    $xortool --brute-chars --key-length=10 "$f"
     binary_xored_ok
 
-    xortool -c 00 --key-length=10 "$f"
+    $xortool -c 00 --key-length=10 "$f"
     binary_xored_ok
 
-    xortool -b --max-keylen=9 "$f"
+    $xortool -b --max-keylen=9 "$f"
     ! binary_xored_ok
 
-    xortool -b --key-length=16 "$f"
+    $xortool -b --key-length=16 "$f"
     ! binary_xored_ok
 
-    xortool -o "$f"
+    $xortool -o "$f"
     ! binary_xored_ok
 
-    xortool --brute-printable "$f"
+    $xortool --brute-printable "$f"
     ! binary_xored_ok
 }
 
@@ -83,48 +87,48 @@ ls_xored() {
     local f="$1"; shift
 
     hexdump -Cv "$f" |cut -s -d' ' -f 3-20 | \
-    xortool --hex -b
+    $xortool --hex -b
     ls_xored_ok
 
     hexdump -Cv "$f" |cut -s -d' ' -f 3-20 | \
-    xortool -x -l 33 -c 00
+    $xortool -x -l 33 -c 00
     ls_xored_ok
 
     rm -rf xortool_out
-    ! xortool -x "$f"
+    ! $xortool -x "$f"
     [ ! -d xortool_out ]
 
     rm -rf xortool_out
-    ! xortool --hex "$f"
+    ! $xortool --hex "$f"
     [ ! -d xortool_out ]
 
-    xortool -c 00 "$f"
+    $xortool -c 00 "$f"
     ls_xored_ok
-    xortool --char=00 "$f"
+    $xortool --char=00 "$f"
     ls_xored_ok
 
-    xortool -b "$f"
+    $xortool -b "$f"
     ls_xored_ok
 
-    xortool -b -l 33 "$f"
+    $xortool -b -l 33 "$f"
     ls_xored_ok
 
-    xortool --brute-chars --key-length=33 "$f"
+    $xortool --brute-chars --key-length=33 "$f"
     ls_xored_ok
 
-    xortool -c 00 --key-length=33 "$f"
+    $xortool -c 00 --key-length=33 "$f"
     ls_xored_ok
 
-    xortool -b --max-keylen=32 "$f"
+    $xortool -b --max-keylen=32 "$f"
     ! ls_xored_ok
 
-    xortool -b --key-length=35 "$f"
+    $xortool -b --key-length=35 "$f"
     ! ls_xored_ok
 
-    xortool -o "$f"
+    $xortool -o "$f"
     ! ls_xored_ok
 
-    xortool --brute-printable "$f"
+    $xortool --brute-printable "$f"
     ! ls_xored_ok
 }
 
@@ -135,36 +139,36 @@ text_xored_ok() {
 }
 
 text_xored() {
-    xortool -o "$1"
+    $xortool -o "$1"
     text_xored_ok
 
-    xortool -o -t printable "$1"
+    $xortool -o -t printable "$1"
     text_xored_ok
 
-    xortool -o -t base32 "$1"
+    $xortool -o -t base32 "$1"
     text_xored_ok
 
-    xortool -o -t base64 "$1"
+    $xortool -o -t base64 "$1"
     text_xored_ok
 
-    xortool -o -t a "$1"
+    $xortool -o -t a "$1"
     text_xored_ok
 
-    xortool -o -t A "$1"
+    $xortool -o -t A "$1"
     text_xored_ok
 
-    xortool -o -t 1 "$1"
+    $xortool -o -t 1 "$1"
     text_xored_ok
 
-    xortool -o -t '!' "$1"
+    $xortool -o -t '!' "$1"
     text_xored_ok
 
-    xortool -o -t '*' "$1"
+    $xortool -o -t '*' "$1"
     text_xored_ok
 
-    ! xortool -o -t Z "$1"
+    ! $xortool -o -t Z "$1"
 
-    xortool -o -t '' "$1"
+    $xortool -o -t '' "$1"
     text_xored_ok
 }
 
@@ -175,7 +179,7 @@ tool_xored_ok() {
 }
 
 tool_xored() {
-    xortool -o "$1"
+    $xortool -o "$1"
     tool_xored_ok
 }
 
@@ -184,16 +188,16 @@ ls_xored test/data/ls_xored
 text_xored test/data/text_xored
 tool_xored test/data/tool_xored
 
-[ "$(./xortool/xortool-xor -n -s '\x3012345' -r 'A' | ./xortool/xortool-xor -r 'A' -f-)" = "012345" ]
-[ "$(./xortool/xortool-xor -n -s '\x3012345' -r 'A')" = "qpsrut" ]
-[ "$(./xortool/xortool-xor -n -h '30 31 32 33 34  35  ' -r 'A' | ./xortool/xortool-xor -r 'A' -f-)" = "012345" ]
-[ "$(./xortool/xortool-xor -n -r qpsrut -r 'A')" = "012345" ]
+[ "$($xortool_xor -n -s '\x3012345' -r 'A' | $xortool_xor -r 'A' -f-)" = "012345" ]
+[ "$($xortool_xor -n -s '\x3012345' -r 'A')" = "qpsrut" ]
+[ "$($xortool_xor -n -h '30 31 32 33 34  35  ' -r 'A' | $xortool_xor -r 'A' -f-)" = "012345" ]
+[ "$($xortool_xor -n -r qpsrut -r 'A')" = "012345" ]
 
-xortool -c 00 --key-length=10 test/data/binary_xored
+$xortool -c 00 --key-length=10 test/data/binary_xored
 f_cmp="$(grep 'secret_key' xortool_out/filename-key.csv|cut -d\; -f1)"
-xortool-xor -n -r secret_key -f "$f_cmp" | \
+$xortool_xor -n -r secret_key -f "$f_cmp" | \
     cmp test/data/binary_xored
-xortool-xor -n -r secret_key -f test/data/binary_xored | \
+$xortool_xor -n -r secret_key -f test/data/binary_xored | \
     cmp "$f_cmp"
 
 echo OK

pyproject.toml

@@ -1,2 +1,3 @@
-__all__ = "args", "colors", "libcolors", "routine"
-__version__ = "0.99"
+from importlib_metadata import version
+
+__version__ = version(__package__)

setup.py

@@ -1,6 +1,7 @@
 #!/usr/bin/env python3
-"""
-xortool
+from xortool import __version__
+__doc__ = f"""
+xortool {__version__}
   A tool to do some xor analysis:
   - guess the key length (based on count of equal chars)
   - guess the key (base on knowledge of most frequent char)
@@ -46,7 +47,6 @@
 import string
 import sys
 
-import xortool
 from xortool.args import (
     parse_parameters,
     ArgError,
@@ -82,7 +82,7 @@ class AnalysisError(Exception):
 
 def main():
     try:
-        PARAMETERS.update(parse_parameters(__doc__, xortool.__version__))
+        PARAMETERS.update(parse_parameters(__doc__, __version__))
         ciphertext = get_ciphertext()
         if not PARAMETERS["known_key_length"]:
             PARAMETERS["known_key_length"] = guess_key_length(ciphertext)

test/test.sh

@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
-#-*- coding:utf-8 -*-
-
-"""
+from xortool import __version__
+__doc__ = f"""
+xortool-xor {__version__}
 xor strings
 options:
     -s  -  string with \\xAF escapes
@@ -14,12 +14,9 @@
     --cycle - do not pad (default)
     --no-cycle / --nc  -  pad smaller strings with null bytes
 example: xor -s lol -h 414243 -f /etc/passwd
-
-author: hellman ( hellman1908@gmail.com )
 """
 
 import getopt
-import string
 import sys