Move kctf-pow wrappers into a dedicated pow module

Author: justinsteven

pwn/toplevel.py

@@ -37,6 +37,7 @@
 from pwnlib.fmtstr import FmtStr, fmtstr_payload, fmtstr_split
 from pwnlib.log import getLogger
 from pwnlib.memleak import MemLeak, RelativeMemLeak
+from pwnlib.pow import *
 from pwnlib.regsort import *
 from pwnlib.replacements import *
 from pwnlib.rop import ROP

pwnlib/pow.py

@@ -0,0 +1,74 @@
+"""
+CTF challenges are sometimes guarded by Proof of Work (PoW) challenges. These
+challenges require a connecting host to perform computational effort. Guarding
+a service with a Proof of Work challenge slows down the rate at which a user
+can connect to a service, reducing the effectiveness of brute-force techniques.
+
+Different Proof of Work algorithms require the connecting host to perform
+different operations. The algorithms are not interoperable. You must choose the
+correct algorithm to satisfy the server's requirements. As a connecting user,
+you are normally told which Proof of Work algorithm is in use by the server.
+
+Pwntools provides an implementation of Google's kCTF Proof of Work algorithm.
+"""
+
+from pwnlib.data.kctf.pow import solve_challenge as _kctf_pow_solve_challenge, \
+    verify_challenge as _kctf_pow_verify_challenge, get_challenge as _kctf_get_challenge
+
+
+def kctf_pow_solve(challenge):
+    """
+    Solve a kCTF Proof of Work challenge
+
+    Arguments:
+      `challenge` (str): The challenge to solve
+
+    Returns:
+      A string representing an acceptable solution
+
+    >>> challenge = 's.AAAB.AAAvm89LbEt4meEnXGwbHp3z'
+    >>> kctf_pow_solve(challenge)[:20] + '...'
+    's.AAAo8s+2Q06cSBM4nf...'
+    >>> hashes.sha256sumhex(six.ensure_binary(kctf_pow_solve(challenge)))
+    'fd13e60761fb4119848f2d7704100f8737c0ed754ef90f573cff74faac8ca800'
+
+    >>> kctf_pow_verify(challenge, kctf_pow_solve(challenge))
+    True
+    """
+    return _kctf_pow_solve_challenge(challenge)
+
+
+def kctf_pow_verify(challenge, solution):
+    """
+    Verify a kCFT Proof of Work solution
+
+    Arguments:
+      `challenge` (str): The challenge that was solved
+      `solution` (str): The solution to verify
+
+    Returns:
+      True if the solution is acceptable, else False
+
+    >>> challenge1 = kctf_pow_generate_challenge(1)
+    >>> challenge2 = kctf_pow_generate_challenge(1)
+    >>> kctf_pow_verify(challenge1, kctf_pow_solve(challenge1))
+    True
+
+    >>> kctf_pow_verify(challenge1, kctf_pow_solve(challenge2))
+    False
+    """
+    return _kctf_pow_verify_challenge(challenge, solution, False)
+
+
+def kctf_pow_generate_challenge(difficulty):
+    """
+    Generate a kCTF Proof of Work challenge
+
+    Arguments:
+      `difficulty` (int): The challenge difficulty. A difficulty of 31337 can be solved in ~30 seconds
+        at 1.66GHz with gmpy2 installed
+
+    Returns:
+      A string representing the challenge
+    """
+    return _kctf_get_challenge(difficulty)

pwnlib/util/misc.py

@@ -17,11 +17,8 @@
 from pwnlib.context import context
 from pwnlib.log import getLogger
 from pwnlib.util import fiddling
-from pwnlib.util import hashes
 from pwnlib.util import lists
 from pwnlib.util import packing
-from pwnlib.data.kctf.pow import solve_challenge as _kctf_pow_solve_challenge, \
-    verify_challenge as _kctf_pow_verify_challenge, get_challenge as _kctf_get_challenge
 
 log = getLogger(__name__)
 
@@ -137,61 +134,6 @@ def write(path, data = b'', create_dir = False, mode = 'w'):
     with open(path, mode) as f:
         f.write(data)
 
-def kctf_pow_solve(challenge):
-    """
-    Solve a kCTF Proof of Work challenge
-
-    Arguments:
-      `challenge` (str): The challenge to solve
-
-    Returns:
-      A string representing an acceptable solution
-
-    >>> challenge = 's.AAAB.AAAvm89LbEt4meEnXGwbHp3z'
-    >>> kctf_pow_solve(challenge)[:20] + '...'
-    's.AAAo8s+2Q06cSBM4nf...'
-    >>> hashes.sha256sumhex(six.ensure_binary(kctf_pow_solve(challenge)))
-    'fd13e60761fb4119848f2d7704100f8737c0ed754ef90f573cff74faac8ca800'
-
-    >>> kctf_pow_verify(challenge, kctf_pow_solve(challenge))
-    True
-    """
-    return _kctf_pow_solve_challenge(challenge)
-
-def kctf_pow_verify(challenge, solution):
-    """
-    Verify a kCFT Proof of Work solution
-
-    Arguments:
-      `challenge` (str): The challenge that was solved
-      `solution` (str): The solution to verify
-
-    Returns:
-      True if the solution is acceptable, else False
-
-    >>> challenge1 = kctf_pow_generate_challenge(1)
-    >>> challenge2 = kctf_pow_generate_challenge(1)
-    >>> kctf_pow_verify(challenge1, kctf_pow_solve(challenge1))
-    True
-
-    >>> kctf_pow_verify(challenge1, kctf_pow_solve(challenge2))
-    False
-    """
-    return _kctf_pow_verify_challenge(challenge, solution, False)
-
-def kctf_pow_generate_challenge(difficulty):
-    """
-    Generate a kCTF Proof of Work challenge
-
-    Arguments:
-      `difficulty` (int): The challenge difficulty. A difficulty of 31337 can be solved in ~30 seconds
-        at 1.66GHz with gmpy2 installed
-
-    Returns:
-      A string representing the challenge
-    """
-    return _kctf_get_challenge(difficulty)
-
 def which(name, all = False, path=None):
     """which(name, flags = os.X_OK, all = False) -> str or str set