Merge branch 'stable' into beta

The function didn't work due to `sizeof` not being defined.  This PR imports
`ctypes` and uses `ctypes.sizeof`.

CHANGELOG.md

@@ -11,7 +11,8 @@ The table below shows which release corresponds to each branch, and what date th
 | ---------------- | -------- | ---------------------- |
 | [3.3.0](#330)    | `dev`    | Dec 24, 2016 (planned)
 | [3.2.0](#320)    | `beta`   | Nov 12, 2016 (planned)
-| [3.1.0](#310)    | `stable` | Oct 2, 2016
+| [3.1.1](#311)    | `stable` | Oct 23, 2016
+| [3.1.0](#310)    |          | Oct 2, 2016
 | [3.0.4](#304)    |          | Sept 19, 2016
 | [3.0.3](#303)    |          | Sept 18, 2016
 | [3.0.2](#302)    |          | Sept 6, 2016
@@ -65,6 +66,10 @@ The table below shows which release corresponds to each branch, and what date th
 [4893819]: https://github.com/Gallopsled/pwntools/commit/4893819b4c23182da570e2f4ea4c14d73af2c0df
 [2af55c9]: https://github.com/Gallopsled/pwntools/commit/2af55c9bc382eca23f89bc0abc7a07c075521f94
 
+## 3.1.1
+
+Fixed a bug in `MemLeak.struct` (PR: #768).
+
 ## 3.1.0
 
 A number of smaller bugfixes and documentation tweaks.

docs/requirements.txt

@@ -1,5 +1,5 @@
 sphinxcontrib-napoleon
-sphinxcontrib-autoprogram
+sphinxcontrib-autoprogram==0.1.2
 isort
 paramiko>=1.15.2
 mako>=1.0.0

extra/bash_completion.d/shellcraft

@@ -1,5 +1,6 @@
+#!/usr/bin/env bash
 # cache list of shellcodes
-_shellcraft_shellcodes=$(shellcraft)
+_shellcraft_shellcodes=$(pwn shellcraft -l)
 
 _shellcraft()
 {
@@ -44,3 +45,4 @@ _shellcraft()
 }
 
 complete -F _shellcraft pwn shellcraft
+complete -F _shellcraft shellcraft

pwnlib/commandline/unhex.py

@@ -20,7 +20,7 @@ def main(args):
             s = sys.stdin.read().translate(None, whitespace)
             sys.stdout.write(s.decode('hex'))
         else:
-            sys.stdout.write(''.join(sys.argv[1:]).decode('hex'))
+            sys.stdout.write(''.join(args.hex).decode('hex'))
     except TypeError, e:
         sys.stderr.write(str(e) + '\n')
 

pwnlib/memleak.py

@@ -1,3 +1,4 @@
+import ctypes
 import functools
 import string
 
@@ -96,8 +97,18 @@ class MemLeak(object):
             struct(class): A ctypes structure to be instantiated with leaked data
         Return Value:
             An instance of the provided struct class, with the leaked data decoded
+
+        Examples:
+
+            >>> @pwnlib.memleak.MemLeak
+            ... def leaker(addr):
+            ...     return "A"
+            >>> e = leaker.struct(0, pwnlib.elf.Elf32_Phdr)
+            >>> hex(e.p_paddr)
+            '0x41414141'
+
         """
-        size = sizeof(struct)
+        size = ctypes.sizeof(struct)
         data = self.n(address, size)
         obj = struct.from_buffer_copy(data)
         return obj

pwnlib/update.py

@@ -34,34 +34,6 @@ package_name    = 'pwntools'
 package_repo    = 'Gallopsled/pwntools'
 update_freq     = datetime.timedelta(days=7).total_seconds()
 
-def available_on_github(prerelease=current_version.is_prerelease):
-    """Return True if an update is available on Github.
-
-    >>> available_on_github() # doctest: +ELLIPSIS
-    <Version('...')>
-    >>> available_on_github(prerelease=False).is_prerelease
-    False
-    """
-    url = 'https://api.github.com/repos/%s/tags' % package_repo
-
-    with context.quiet:
-        tags = json.loads(wget(url, timeout = 60))
-
-    # 'pwntools-ancient' is a tag, but not a valid version.
-    # Handle this here, and for all potential tags which cause
-    # issues.
-    versions = []
-    for tag in [t['name'] for t in tags]:
-        try:
-            versions.append(packaging.version.Version(tag))
-        except Exception:
-            pass
-
-    if not prerelease:
-        versions = filter(lambda v: not v.is_prerelease, versions)
-
-    return max(versions)
-
 def available_on_pypi(prerelease=current_version.is_prerelease):
     """Return True if an update is available on PyPI.
 
@@ -120,21 +92,12 @@ def perform_check(prerelease=current_version.is_prerelease):
     ['pip', 'install', '-U', ...]
 
     >>> def bail(*a): raise Exception()
-    >>> github = pwnlib.update.available_on_github
     >>> pypi   = pwnlib.update.available_on_pypi
 
-    >>> pwnlib.update.available_on_github = bail
     >>> perform_check(prerelease=False)
     ['pip', 'install', '-U', 'pwntools']
     >>> perform_check(prerelease=True)  # doctest: +ELLIPSIS
     ['pip', 'install', '-U', 'pwntools...']
-    >>> pwnlib.update.available_on_github = github
-
-    >>> pwnlib.update.available_on_pypi = bail
-    >>> perform_check(prerelease=False)
-    ['pip', 'install', '-U', 'git+https://github.com/Gallopsled/pwntools.git@...']
-    >>> perform_check(prerelease=True)  # doctest: +ELLIPSIS
-    ['pip', 'install', '-U', 'git+https://github.com/Gallopsled/pwntools.git@...']
     """
     pypi = current_version
     try:
@@ -142,13 +105,7 @@ def perform_check(prerelease=current_version.is_prerelease):
     except Exception:
         log.warning("An issue occurred while checking PyPI")
 
-    github = current_version
-    try:
-        github = available_on_github(prerelease)
-    except Exception:
-        log.warning("An issue occurred while checking Github")
-
-    best = max(pypi, github, current_version)
+    best = max(pypi, current_version)
     where = None
     command = None
 
@@ -170,9 +127,6 @@ def perform_check(prerelease=current_version.is_prerelease):
         if best.is_prerelease:
             pypi_package += '==%s' % (best)
         command += [pypi_package]
-    else:
-        where = 'GitHub'
-        command += ['git+https://github.com/%s.git@%s' % (package_repo, github)]
 
     command_str = ' '.join(command)
 

pwnlib/version.py

@@ -1 +1 @@
-__version__ = '3.2.0beta2'
+__version__ = '3.2.0beta5'

setup.py

@@ -83,7 +83,7 @@ except ImportError:
 setup(
     name                 = 'pwntools',
     packages             = find_packages(),
-    version              = '3.2.0beta2',
+    version              = '3.2.0beta5',
     data_files           = [('',
                              glob.glob('*.md') + glob.glob('*.txt')),
                             ],