1461b486abbb14c5fe4ad10e86ac2a921d486203

Build # 1461b486abbb14c5fe4ad10e86ac2a921d486203

Build Type

push

github-actions

Committed by GitHub

Commit Message

Fix documentation of tube.recvall (#2163)

Run Details

3873 of 6370 branches covered (60.8%)

12198 of 16609 relevant lines covered (73.44%)

0.73 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

81.92

/pwnlib/commandline/shellcraft.py

#!/usr/bin/env python2
from __future__ import absolute_import
from __future__ import division

import argparse
import os
import six
import sys
import types

import pwnlib.args
pwnlib.args.free_form = False

from pwn import *
from pwnlib.commandline import common


#  ____  _          _ _                 __ _
# / ___|| |__   ___| | | ___ _ __ __ _ / _| |_
# \___ \| '_ \ / _ \ | |/ __| '__/ _` | |_| __|
#  ___) | | | |  __/ | | (__| | | (_| |  _| |_
# |____/|_| |_|\___|_|_|\___|_|  \__,_|_|  \__|

def _string(s):
    out = []
    for co in bytearray(s):
        c = chr(co)
        if co >= 0x20 and co <= 0x7e and c not in '/$\'"`':
            out.append(c)
        else:
            out.append('\\x%02x' % co)
    return '"' + ''.join(out) + '"\n'


p = common.parser_commands.add_parser(
    'shellcraft',
    help = 'Microwave shellcode -- Easy, fast and delicious',
    description = 'Microwave shellcode -- Easy, fast and delicious',
)


p.add_argument(
    '-?', '--show',
    action = 'store_true',
    help = 'Show shellcode documentation',
)

p.add_argument(
    '-o', '--out',
    metavar = 'file',
    type = argparse.FileType('wb'),
    default = getattr(sys.stdout, 'buffer', sys.stdout),
    help = 'Output file (default: stdout)',
)

p.add_argument(
    '-f', '--format',
    metavar = 'format',
    choices = ['r', 'raw',
               's', 'str', 'string',
               'c',
               'h', 'hex',
               'a', 'asm', 'assembly',
               'p',
               'i', 'hexii',
               'e', 'elf',
               'd', 'escaped',
               'default'],
    default = 'default',
    help = 'Output format (default: hex), choose from {e}lf, {r}aw, {s}tring, {c}-style array, {h}ex string, hex{i}i, {a}ssembly code, {p}reprocssed code, escape{d} hex string',
)

p.add_argument(
    'shellcode',
    nargs = '?',
    help = 'The shellcode you want',
    type = str
)

p.add_argument(
    'args',
    nargs = '*',
    metavar = 'arg',
    default = (),
    help = 'Argument to the chosen shellcode',
)

p.add_argument(
    '-d',
    '--debug',
    help='Debug the shellcode with GDB',
    action='store_true'
)

p.add_argument(
    '-b',
    '--before',
    help='Insert a debug trap before the code',
    action='store_true'
)

p.add_argument(
    '-a',
    '--after',
    help='Insert a debug trap after the code',
    action='store_true'
)

p.add_argument(
    '-v', '--avoid',
    action='append',
    help = 'Encode the shellcode to avoid the listed bytes'
)

p.add_argument(
    '-n', '--newline',
    dest='avoid',
    action='append_const',
    const='\n',
    help = 'Encode the shellcode to avoid newlines'
)

p.add_argument(
    '-z', '--zero',
    dest='avoid',
    action='append_const',
    const='\x00',
    help = 'Encode the shellcode to avoid NULL bytes'
)

p.add_argument(
    '-r',
    '--run',
    help="Run output",
    action='store_true'
)

p.add_argument(
    '--color',
    help="Color output",
    action='store_true',
    default=sys.stdout.isatty()
)

p.add_argument(
    '--no-color',
    help="Disable color output",
    action='store_false',
    dest='color'
)

p.add_argument(
    '--syscalls',
    help="List syscalls",
    action='store_true'
)

p.add_argument(
    '--address',
    help="Load address",
    default=None
)

p.add_argument(
    '-l', '--list',
    action='store_true',
    help='List available shellcodes, optionally provide a filter'
)

p.add_argument(
    '-s', '--shared',
    action='store_true',
    help='Generated ELF is a shared library'
)

def get_template(name):
    func = shellcraft
    for attr in name.split('.'):
        func = getattr(func, attr)
    return func

def is_not_a_syscall_template(name):
    template_src = shellcraft._get_source(name)
    return '/syscalls' not in template_src

def main(args):
    if args.list:
        templates = shellcraft.templates

        if args.shellcode:
            templates = filter(lambda a: args.shellcode in a, templates)
        elif not args.syscalls:
            templates = filter(is_not_a_syscall_template, templates)

        print('\n'.join(templates))
        exit()

    if not args.shellcode:
        common.parser.print_usage()
        exit()

    try:
        func = get_template(args.shellcode)
    except AttributeError:
        log.error("Unknown shellcraft template %r. Use --list to see available shellcodes." % args.shellcode)

    if args.show:
        # remove doctests
        doc = []
        in_doctest = False
        block_indent = None
        caption = None
        lines = func.__doc__.splitlines()
        i = 0
        while i < len(lines):
            line = lines[i]
            if line.lstrip().startswith('>>>'):
                # this line starts a doctest
                in_doctest = True
                block_indent = None
                if caption:
                    # delete back up to the caption
                    doc = doc[:caption - i]
                    caption = None
            elif line == '':
                # skip blank lines
                pass
            elif in_doctest:
                # indentation marks the end of a doctest
                indent = len(line) - len(line.lstrip())
                if block_indent is None:
                    if not line.lstrip().startswith('...'):
                        block_indent = indent
                elif indent < block_indent:
                    in_doctest = False
                    block_indent = None
                    # re-evalutate this line
                    continue
            elif line.endswith(':'):
                # save index of caption
                caption = i
            else:
                # this is not blank space and we're not in a doctest, so the
                # previous caption (if any) was not for a doctest
                caption = None

            if not in_doctest:
                doc.append(line)
            i += 1
        print('\n'.join(doc).rstrip())
        exit()

    defargs = len(six.get_function_defaults(func) or ())
    reqargs = six.get_function_code(func).co_argcount - defargs
    if len(args.args) < reqargs:
        if defargs > 0:
            log.critical('%s takes at least %d arguments' % (args.shellcode, reqargs))
            sys.exit(1)
        else:
            log.critical('%s takes exactly %d arguments' % (args.shellcode, reqargs))
            sys.exit(1)

    # Captain uglyness saves the day!
    for i, val in enumerate(args.args):
        try:
            args.args[i] = util.safeeval.expr(val)
        except ValueError:
            pass

    # And he strikes again!
    list(map(common.context_arg, args.shellcode.split('.')))
    code = func(*args.args)


    if args.before:
        code = shellcraft.trap() + code
    if args.after:
        code = code + shellcraft.trap()


    if args.format in ['a', 'asm', 'assembly']:
        if args.color:
            from pygments import highlight
            from pygments.formatters import TerminalFormatter
            from pwnlib.lexer import PwntoolsLexer

            code = highlight(code, PwntoolsLexer(), TerminalFormatter())

        print(code)
        exit()
    if args.format == 'p':
        print(cpp(code))
        exit()

    assembly = code

    vma = args.address
    if vma:
        vma = pwnlib.util.safeeval.expr(vma)

    if args.format in ['e','elf']:
        args.format = 'default'
        try: os.fchmod(args.out.fileno(), 0o700)
        except OSError: pass


        if not args.avoid:
            code = read(make_elf_from_assembly(assembly, vma=vma, shared=args.shared))
        else:
            code = asm(assembly)
            code = encode(code, args.avoid)
            code = make_elf(code, vma=vma, shared=args.shared)
            # code = read(make_elf(encode(asm(code), args.avoid)))
    else:
        code = encode(asm(assembly), args.avoid)

    if args.format == 'default':
        if args.out.isatty():
            args.format = 'hex'
        else:
            args.format = 'raw'

    arch = args.shellcode.split('.')[0]

    if args.debug:
        if not args.avoid:
            proc = gdb.debug_assembly(assembly, arch=arch, vma=vma)
        else:
            proc = gdb.debug_shellcode(code, arch=arch, vma=vma)
        proc.interactive()
        sys.exit(0)

    if args.run:
        proc = run_shellcode(code, arch=arch)
        proc.interactive()
        sys.exit(0)

    if args.format in ['s', 'str', 'string']:
        code = _string(code)
    elif args.format == 'c':
        code = '{' + ', '.join(map(hex, bytearray(code))) + '}' + '\n'
    elif args.format in ['h', 'hex']:
        code = pwnlib.util.fiddling.enhex(code) + '\n'
    elif args.format in ['i', 'hexii']:
        code = hexii(code) + '\n'
    elif args.format in ['d', 'escaped']:
        code = ''.join('\\x%02x' % c for c in bytearray(code)) + '\n'
    if not sys.stdin.isatty():
        args.out.write(getattr(sys.stdin, 'buffer', sys.stdin).read())

    if not hasattr(code, 'decode'):
        code = code.encode()
    args.out.write(code)

if __name__ == '__main__':
    pwnlib.commandline.common.main(__file__)

1	#!/usr/bin/env python2
2	from __future__ import absolute_import	1✔
3	from __future__ import division	1✔
4
5	import argparse	1✔
6	import os	1✔
7	import six	1✔
8	import sys	1✔
9	import types	1✔
10
11	import pwnlib.args	1✔
12	pwnlib.args.free_form = False	1✔
13
14	from pwn import *	1✔
15	from pwnlib.commandline import common	1✔
16
17
18	# ____ _ _ _ __ _
19	# / ___\|\| \|__ ___\| \| \| ___ _ __ __ _ / _\| \|_
20	# \___ \\| '_ \ / _ \ \| \|/ __\| '__/ _` \| \|_\| __\|
21	# ___) \| \| \| \| __/ \| \| (__\| \| \| (_\| \| _\| \|_
22	# \|____/\|_\| \|_\|\___\|_\|_\|\___\|_\| \__,_\|_\| \__\|
23
24	def _string(s):	1✔
25	out = []	1✔
26	for co in bytearray(s):	1✔
27	c = chr(co)	1✔
28	if co >= 0x20 and co <= 0x7e and c not in '/$\'"`':	1✔
29	out.append(c)	1✔
30	else:
31	out.append('\\x%02x' % co)	1✔
32	return '"' + ''.join(out) + '"\n'	1✔
33
34
35	p = common.parser_commands.add_parser(	1✔
36	'shellcraft',
37	help = 'Microwave shellcode -- Easy, fast and delicious',
38	description = 'Microwave shellcode -- Easy, fast and delicious',
39	)
40
41
42	p.add_argument(	1✔
43	'-?', '--show',
44	action = 'store_true',
45	help = 'Show shellcode documentation',
46	)
47
48	p.add_argument(	1✔
49	'-o', '--out',
50	metavar = 'file',
51	type = argparse.FileType('wb'),
52	default = getattr(sys.stdout, 'buffer', sys.stdout),
53	help = 'Output file (default: stdout)',
54	)
55
56	p.add_argument(	1✔
57	'-f', '--format',
58	metavar = 'format',
59	choices = ['r', 'raw',
60	's', 'str', 'string',
61	'c',
62	'h', 'hex',
63	'a', 'asm', 'assembly',
64	'p',
65	'i', 'hexii',
66	'e', 'elf',
67	'd', 'escaped',
68	'default'],
69	default = 'default',
70	help = 'Output format (default: hex), choose from {e}lf, {r}aw, {s}tring, {c}-style array, {h}ex string, hex{i}i, {a}ssembly code, {p}reprocssed code, escape{d} hex string',
71	)
72
73	p.add_argument(	1✔
74	'shellcode',
75	nargs = '?',
76	help = 'The shellcode you want',
77	type = str
78	)
79
80	p.add_argument(	1✔
81	'args',
82	nargs = '*',
83	metavar = 'arg',
84	default = (),
85	help = 'Argument to the chosen shellcode',
86	)
87
88	p.add_argument(	1✔
89	'-d',
90	'--debug',
91	help='Debug the shellcode with GDB',
92	action='store_true'
93	)
94
95	p.add_argument(	1✔
96	'-b',
97	'--before',
98	help='Insert a debug trap before the code',
99	action='store_true'
100	)
101
102	p.add_argument(	1✔
103	'-a',
104	'--after',
105	help='Insert a debug trap after the code',
106	action='store_true'
107	)
108
109	p.add_argument(	1✔
110	'-v', '--avoid',
111	action='append',
112	help = 'Encode the shellcode to avoid the listed bytes'
113	)
114
115	p.add_argument(	1✔
116	'-n', '--newline',
117	dest='avoid',
118	action='append_const',
119	const='\n',
120	help = 'Encode the shellcode to avoid newlines'
121	)
122
123	p.add_argument(	1✔
124	'-z', '--zero',
125	dest='avoid',
126	action='append_const',
127	const='\x00',
128	help = 'Encode the shellcode to avoid NULL bytes'
129	)
130
131	p.add_argument(	1✔
132	'-r',
133	'--run',
134	help="Run output",
135	action='store_true'
136	)
137
138	p.add_argument(	1✔
139	'--color',
140	help="Color output",
141	action='store_true',
142	default=sys.stdout.isatty()
143	)
144
145	p.add_argument(	1✔
146	'--no-color',
147	help="Disable color output",
148	action='store_false',
149	dest='color'
150	)
151
152	p.add_argument(	1✔
153	'--syscalls',
154	help="List syscalls",
155	action='store_true'
156	)
157
158	p.add_argument(	1✔
159	'--address',
160	help="Load address",
161	default=None
162	)
163
164	p.add_argument(	1✔
165	'-l', '--list',
166	action='store_true',
167	help='List available shellcodes, optionally provide a filter'
168	)
169
170	p.add_argument(	1✔
171	'-s', '--shared',
172	action='store_true',
173	help='Generated ELF is a shared library'
174	)
175
176	def get_template(name):	1✔
177	func = shellcraft	1✔
178	for attr in name.split('.'):	1✔
179	func = getattr(func, attr)	1✔
180	return func	1✔
181
182	def is_not_a_syscall_template(name):	1✔
183	template_src = shellcraft._get_source(name)	1✔
184	return '/syscalls' not in template_src	1✔
185
186	def main(args):	1✔
187	if args.list:	1✔
188	templates = shellcraft.templates	1✔
189
190	if args.shellcode:	1✔
191	templates = filter(lambda a: args.shellcode in a, templates)	1✔
192	elif not args.syscalls:	1✔
193	templates = filter(is_not_a_syscall_template, templates)	1✔
194
195	print('\n'.join(templates))	1✔
196	exit()	1✔
197
198	if not args.shellcode:	1!
199	common.parser.print_usage()	×
200	exit()	×
201
202	try:	1✔
203	func = get_template(args.shellcode)	1✔
204	except AttributeError:	×
205	log.error("Unknown shellcraft template %r. Use --list to see available shellcodes." % args.shellcode)	×
206
207	if args.show:	1✔
208	# remove doctests
209	doc = []	1✔
210	in_doctest = False	1✔
211	block_indent = None	1✔
212	caption = None	1✔
213	lines = func.__doc__.splitlines()	1✔
214	i = 0	1✔
215	while i < len(lines):	1✔
216	line = lines[i]	1✔
217	if line.lstrip().startswith('>>>'):	1✔
218	# this line starts a doctest
219	in_doctest = True	1✔
220	block_indent = None	1✔
221	if caption:	1✔
222	# delete back up to the caption
223	doc = doc[:caption - i]	1✔
224	caption = None	1✔
225	elif line == '':	1✔
226	# skip blank lines
227	pass	1✔
228	elif in_doctest:	1✔
229	# indentation marks the end of a doctest
230	indent = len(line) - len(line.lstrip())	1✔
231	if block_indent is None:	1!
232	if not line.lstrip().startswith('...'):	1!
233	block_indent = indent	1✔
234	elif indent < block_indent:	×
235	in_doctest = False	×
236	block_indent = None	×
237	# re-evalutate this line
238	continue	×
239	elif line.endswith(':'):	1✔
240	# save index of caption
241	caption = i	1✔
242	else:
243	# this is not blank space and we're not in a doctest, so the
244	# previous caption (if any) was not for a doctest
245	caption = None	1✔
246
247	if not in_doctest:	1✔
248	doc.append(line)	1✔
249	i += 1	1✔
250	print('\n'.join(doc).rstrip())	1✔
251	exit()	1✔
252
253	defargs = len(six.get_function_defaults(func) or ())	1✔
254	reqargs = six.get_function_code(func).co_argcount - defargs	1✔
255	if len(args.args) < reqargs:	1!
256	if defargs > 0:	×
257	log.critical('%s takes at least %d arguments' % (args.shellcode, reqargs))	×
258	sys.exit(1)	×
259	else:
260	log.critical('%s takes exactly %d arguments' % (args.shellcode, reqargs))	×
261	sys.exit(1)	×
262
263	# Captain uglyness saves the day!
264	for i, val in enumerate(args.args):	1✔
265	try:	1✔
266	args.args[i] = util.safeeval.expr(val)	1✔
267	except ValueError:	1✔
268	pass	1✔
269
270	# And he strikes again!
271	list(map(common.context_arg, args.shellcode.split('.')))	1✔
272	code = func(*args.args)	1✔
273
274
275	if args.before:	1✔
276	code = shellcraft.trap() + code	1✔
277	if args.after:	1✔
278	code = code + shellcraft.trap()	1✔
279
280
281	if args.format in ['a', 'asm', 'assembly']:	1✔
282	if args.color:	1!
283	from pygments import highlight	1✔
284	from pygments.formatters import TerminalFormatter	1✔
285	from pwnlib.lexer import PwntoolsLexer	1✔
286
287	code = highlight(code, PwntoolsLexer(), TerminalFormatter())	1✔
288
289	print(code)	1✔
290	exit()	1✔
291	if args.format == 'p':	1✔
292	print(cpp(code))	1✔
293	exit()	1✔
294
295	assembly = code	1✔
296
297	vma = args.address	1✔
298	if vma:	1!
299	vma = pwnlib.util.safeeval.expr(vma)	×
300
301	if args.format in ['e','elf']:	1✔
302	args.format = 'default'	1✔
303	try: os.fchmod(args.out.fileno(), 0o700)	1✔
304	except OSError: pass	1✔
305
306
307	if not args.avoid:	1!
308	code = read(make_elf_from_assembly(assembly, vma=vma, shared=args.shared))	1✔
309	else:
310	code = asm(assembly)	×
311	code = encode(code, args.avoid)	×
312	code = make_elf(code, vma=vma, shared=args.shared)	×
313	# code = read(make_elf(encode(asm(code), args.avoid)))
314	else:
315	code = encode(asm(assembly), args.avoid)	1✔
316
317	if args.format == 'default':	1✔
318	if args.out.isatty():	1!
319	args.format = 'hex'	×
320	else:
321	args.format = 'raw'	1✔
322
323	arch = args.shellcode.split('.')[0]	1✔
324
325	if args.debug:	1!
326	if not args.avoid:	×
327	proc = gdb.debug_assembly(assembly, arch=arch, vma=vma)	×
328	else:
329	proc = gdb.debug_shellcode(code, arch=arch, vma=vma)	×
330	proc.interactive()	×
331	sys.exit(0)	×
332
333	if args.run:	1✔
334	proc = run_shellcode(code, arch=arch)	1✔
335	proc.interactive()	1✔
336	sys.exit(0)	1✔
337
338	if args.format in ['s', 'str', 'string']:	1✔
339	code = _string(code)	1✔
340	elif args.format == 'c':	1✔
341	code = '{' + ', '.join(map(hex, bytearray(code))) + '}' + '\n'	1✔
342	elif args.format in ['h', 'hex']:	1!
343	code = pwnlib.util.fiddling.enhex(code) + '\n'	×
344	elif args.format in ['i', 'hexii']:	1✔
345	code = hexii(code) + '\n'	1✔
346	elif args.format in ['d', 'escaped']:	1!
347	code = ''.join('\\x%02x' % c for c in bytearray(code)) + '\n'	×
348	if not sys.stdin.isatty():	1!
349	args.out.write(getattr(sys.stdin, 'buffer', sys.stdin).read())	1✔
350
351	if not hasattr(code, 'decode'):	1!
352	code = code.encode()	×
353	args.out.write(code)	1✔
354
355	if __name__ == '__main__':	1✔
356	pwnlib.commandline.common.main(__file__)	1✔

Gallopsled / pwntools / 1461b486abbb14c5fe4ad10e86ac2a921d486203

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous