Drop newline in tube.recvline by default

Change the default value of the `drop` parameter to `True` to avoid the common `recvline().strip()` dance and be in line with other readline implementations.

Author: peace-maker

docs/source/intro.rst

@@ -43,7 +43,7 @@ For example, remote connections via :mod:`pwnlib.tubes.remote`.
     >>> conn.send(b'USER anonymous\r\n')
     >>> conn.recvuntil(b' ', drop=True)
     b'331'
-    >>> conn.recvline()
+    >>> conn.recvline(drop=False)
     b'Please specify the password.\r\n'
     >>> conn.close()
 
@@ -65,7 +65,7 @@ Interacting with processes is easy thanks to :mod:`pwnlib.tubes.process`.
     >>> sh.recvline(timeout=1)
     b''
     >>> sh.recvline(timeout=5)
-    b'hello world\n'
+    b'hello world'
     >>> sh.close()
 
 Not only can you interact with processes programmatically, but you can
@@ -91,7 +91,7 @@ a ``process`` tube.
     >>> sh.recvline(timeout=1)
     b''
     >>> sh.recvline(timeout=5)
-    b'hello world\n'
+    b'hello world'
     >>> shell.close()
 
 Packing Integers

pwnlib/adb/adb.py

@@ -322,7 +322,7 @@ def __do_deferred_initialization(self):
                     r.recvuntil('OK')
                     r.recvline() # Rest of the line
                     r.sendline('avd name')
-                    self.avd = r.recvline().strip()
+                    self.avd = r.recvline()
             except:
                 pass
 

pwnlib/asm.py

@@ -608,7 +608,7 @@ def make_elf(data,
         >>> p = process(filename)
         >>> p.sendline(b'echo Hello; exit')
         >>> p.recvline()
-        b'Hello\n'
+        b'Hello'
     """
     retval = None
 

pwnlib/elf/corefile.py

@@ -361,7 +361,7 @@ class Corefile(ELF):
         >>> io = process(elf.path, env=env)
         >>> io.sendline(b'echo hello')
         >>> io.recvline()
-        b'hello\n'
+        b'hello'
 
         The process is still running, but accessing its :attr:`.process.corefile` property
         automatically invokes GDB to attach and dump a corefile.

pwnlib/encoders/amd64/delta.py

@@ -18,7 +18,7 @@ class amd64DeltaEncoder(i386DeltaEncoder):
     >>> p = run_shellcode(encoded)
     >>> p.sendline(b'echo hello; exit')
     >>> p.recvline()
-    b'hello\n'
+    b'hello'
     """
     assembly = '''
 base:

pwnlib/encoders/arm/xor.py

@@ -21,7 +21,7 @@ class ArmXorEncoder(Encoder):
     >>> p = run_shellcode(encoded)
     >>> p.sendline(b'echo hello; exit')
     >>> p.recvline()
-    b'hello\n'
+    b'hello'
     """
 
     arch = 'arm'

pwnlib/encoders/i386/xor.py

@@ -33,7 +33,7 @@ class i386XorEncoder(Encoder):
     >>> p = run_shellcode(encoded)
     >>> p.sendline(b'echo hello; exit')
     >>> p.recvline()
-    b'hello\n'
+    b'hello'
     >>> encoders.i386.xor.encode(asm(shellcraft.execve('/bin/sh')), avoid=bytearray([0x31]))
     b'\xd9\xd0\xd9t$\xf4^\xfcj\x07Y\x83\xc6\x19\x89\xf7\xad\x93\xad1\xd8\xabIu\xf7\x00\x00\x00\x00h\x01\x01\x01\x00\x00\x00\x00\x01\x814$\x00\x00\x00\x00.ri\x01\x00\x00\x00\x00h/bi\x00\x00\x00\x01n\x89\xe30\x00\x01\x00\x00\xc90\xd2j\x00\x00\x00\x00\x0bX\xcd\x80'
     """

pwnlib/encoders/mips/xor.py

@@ -109,7 +109,7 @@ class MipsXorEncoder(Encoder):
     >>> p = run_shellcode(encoded)
     >>> p.sendline(b'echo hello; exit')
     >>> p.recvline()
-    b'hello\n'
+    b'hello'
     """
 
     arch = 'mips'

pwnlib/filesystem/ssh.py

@@ -500,7 +500,7 @@ def mkdir(self, mode=0o777, parents=False, exist_ok=True):
         >>> f = SSHPath('dirA/dirB/dirC', ssh=ssh_conn)
         >>> f.mkdir(parents=True)
         >>> ssh_conn.run(['ls', '-la', f.absolute().path], env={'LC_ALL': 'C.UTF-8'}).recvline()
-        b'total 8\n'
+        b'total 8'
         """
         if exist_ok and self.is_dir():
             return

pwnlib/gdb.py

@@ -194,7 +194,7 @@ def debug_assembly(asm, gdbscript=None, vma=None, api=False):
     >>> assembly = shellcraft.echo("Hello world!\n")
     >>> io = gdb.debug_assembly(assembly)
     >>> io.recvline()
-    b'Hello world!\n'
+    b'Hello world!'
     """
     tmp_elf = make_elf_from_assembly(asm, vma=vma, extract=False)
     os.chmod(tmp_elf, 0o777)
@@ -229,7 +229,7 @@ def debug_shellcode(data, gdbscript=None, vma=None, api=False):
     >>> shellcode = asm(assembly)
     >>> io = gdb.debug_shellcode(shellcode)
     >>> io.recvline()
-    b'Hello world!\n'
+    b'Hello world!'
     """
     if isinstance(data, str):
         log.error("Shellcode is cannot be unicode.  Did you mean debug_assembly?")
@@ -489,7 +489,7 @@ def debug(args, gdbscript=None, gdb_args=None, exe=None, ssh=None, env=None, por
 
         >>> io.sendline(b"echo hello")
         >>> io.recvline()
-        b'hello\n'
+        b'hello'
 
         Interact with the process
 
@@ -513,7 +513,7 @@ def debug(args, gdbscript=None, gdb_args=None, exe=None, ssh=None, env=None, por
 
         >>> io.sendline(b"echo hello")
         >>> io.recvline()
-        b'hello\n'
+        b'hello'
 
         Interact with the process
 
@@ -525,7 +525,7 @@ def debug(args, gdbscript=None, gdb_args=None, exe=None, ssh=None, env=None, por
         >>> io = gdb.debug(args=[b'\xde\xad\xbe\xef'], gdbscript='continue', exe="/bin/sh")
         >>> io.sendline(b"echo $0")
         >>> io.recvline()
-        b'\xde\xad\xbe\xef\n'
+        b'\xde\xad\xbe\xef'
         >>> io.close()
 
         Demonstrate that LD_PRELOAD is respected
@@ -571,15 +571,15 @@ def debug(args, gdbscript=None, gdb_args=None, exe=None, ssh=None, env=None, por
         >>> io = gdb.debug(args=[b'\xde\xad\xbe\xef'], gdbscript='continue', exe="/bin/sh", ssh=shell)
         >>> io.sendline(b"echo $0")
         >>> io.recvline()
-        b'$ \xde\xad\xbe\xef\n'
+        b'$ \xde\xad\xbe\xef'
         >>> io.close()
 
         Using an empty args[0] on a remote process
 
         >>> io = gdb.debug(args=[], gdbscript='continue', exe="/bin/sh", ssh=shell)
         >>> io.sendline(b"echo $0")
         >>> io.recvline()
-        b'$ \n'
+        b'$ '
         >>> io.close()
 
 
@@ -616,12 +616,12 @@ def debug(args, gdbscript=None, gdb_args=None, exe=None, ssh=None, env=None, por
 
         >>> io.gdb.continue_nowait()
         >>> io.recvline()
-        b'foo\n'
+        b'foo'
         >>> io.close()
 
         >>> ssh_io.gdb.continue_nowait()
         >>> ssh_io.recvline()
-        b'foo\n'
+        b'foo'
         >>> ssh_io.close()
         >>> shell.close()
     """
@@ -983,7 +983,7 @@ def attach(target, gdbscript = '', exe = None, gdb_args = None, ssh = None, sysr
         ... quit
         ... ''')
         >>> io.recvline()
-        b'Hello from process debugger!\n'
+        b'Hello from process debugger!'
         >>> io.sendline(b'echo Hello from bash && exit')
         >>> io.recvall()
         b'Hello from bash\n'
@@ -1007,7 +1007,7 @@ def attach(target, gdbscript = '', exe = None, gdb_args = None, ssh = None, sysr
             Observe the forced line
 
             >>> io.recvline()
-            b'Hello from process debugger!\n'
+            b'Hello from process debugger!'
 
             Interact with the program in a regular way
 
@@ -1031,7 +1031,7 @@ def attach(target, gdbscript = '', exe = None, gdb_args = None, ssh = None, sysr
         ... quit
         ... ''')
         >>> io.recvline()
-        b'Hello from remote debugger!\n'
+        b'Hello from remote debugger!'
         >>> io.sendline(b'echo Hello from bash && exit')
         >>> io.recvall()
         b'Hello from bash\n'
@@ -1052,12 +1052,12 @@ def attach(target, gdbscript = '', exe = None, gdb_args = None, ssh = None, sysr
         ... end
         ... ''')
         >>> gdbserver.recvline(timeout=10)  # doctest: +ELLIPSIS
-        b'Remote debugging from host 127.0.0.1, ...\n'
+        b'Remote debugging from host 127.0.0.1, ...'
         >>> gdbserver.recvline(timeout=10)
-        b'Hello from gdbserver debugger!\n'
+        b'Hello from gdbserver debugger!'
         >>> gdbserver.sendline(b'echo Hello from bash && exit')
         >>> gdbserver.recvline(timeout=10)
-        b'Hello from bash\n'
+        b'Hello from bash'
         >>> gdbserver.close()
 
         Attach to processes running on a remote machine via an SSH :class:`.ssh` process
@@ -1071,10 +1071,10 @@ def attach(target, gdbscript = '', exe = None, gdb_args = None, ssh = None, sysr
         ... quit
         ... ''')
         >>> io.recvline(timeout=5)  # doctest: +SKIP
-        b'Hello from ssh debugger!\n'
+        b'Hello from ssh debugger!'
         >>> io.sendline(b'This will be echoed back')
         >>> io.recvline()
-        b'This will be echoed back\n'
+        b'This will be echoed back'
         >>> io.close()
 
         To attach to remote gdbserver, assume you have a socat server delivering gdbserver
@@ -1095,7 +1095,7 @@ def attach(target, gdbscript = '', exe = None, gdb_args = None, ssh = None, sysr
         ...     io.recvline()
         ...     io.close()
         ...     server.close()
-        b'Hello\n'
+        b'Hello'
     """
     if context.noptrace:
         log.warn_once("Skipping debug attach since context.noptrace==True")