dhondta / python-sploitkit / 172

pending completion

Build # 172

Build Type

push

travis-ci

Committed by

dhondta

Commit Message

<a href="https://github.com/dhondta/python-sploitkit/commit/<a class=hub.com/dhondta/python-sploitkit/commit/2a8b4e658029b09b5b217303ff6d6e2f6c245f23">2a8b4e658<a href="https://github.com/dhondta/python-sploitkit/commit/2a8b4e658029b09b5b217303ff6d6e2f6c245f23">&quot;&gt;Revert &amp;quot;Updated gh-pages (from master)&quot;

This reverts commit </a><a class="double-link" href="https://github.com/dhondta/python-sploitkit/commit/<a class="double-link" href="https://github.com/dhondta/python-sploitkit/commit/b37b7ab4b0f186a5cee750d1cd7c4b5740f81845">b37b7ab4b</a>">b37b7ab4b</a><a href="https://github.com/dhondta/python-sploitkit/commit/2a8b4e658029b09b5b217303ff6d6e2f6c245f23">.

Run Details

40 of 40 new or added lines in 7 files covered. (100.0%)

1659 of 2595 relevant lines covered (63.93%)

1.28 hits per line

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

36.62

/sploitkit/base/commands/utils.py

# -*- coding: UTF-8 -*-
import os
import stat
import yaml
from collections.abc import Iterable
from gc import collect, get_objects, get_referrers
from pprint import pprint
from subprocess import call
from sys import getrefcount
from tinyscript.helpers import human_readable_size, BorderlessTable, Path

from sploitkit import *


# ---------------------------- GENERAL-PURPOSE COMMANDS ------------------------
class Edit(Command):
    """ Edit a text file """
    requirements = {'system': ["vim"]}
    single_arg   = True
    
    def check_requirements(self):
        return self.config.option("TEXT_EDITOR").value is not None
    
    def complete_values(self):
        p = Path(self.config.option("WORKSPACE").value)
        f = p.iterfiles(relative=True)
        return list(map(lambda x: str(x), f))
    
    def run(self, filename):
        f = Path(self.config.option("WORKSPACE").value).joinpath(filename)
        self.console._files.edit(str(f))
    
    def validate(self, filename):
        return


class History(Command):
    """ Inspect commands history """
    requirements = {'system': ["less"]}
    
    def run(self):
        h = Path(self.config.option("WORKSPACE").value).joinpath("history")
        self.console._files.page(str(h))


class Shell(Command):
    """ Execute a shell command """
    single_arg = True
    
    def complete_values(self):
        l = []
        e = stat.S_IEXEC | stat.S_IXGRP | stat.S_IXOTH
        for p in os.environ['PATH'].split(":"):
            if not os.path.isdir(p):
                continue
            for f in os.listdir(p):
                fp = os.path.join(p, f)
                if os.path.isfile(fp):
                    st = os.stat(fp)
                    if st.st_mode & e and f not in l:
                        l.append(f)
        return l
        
    def run(self, cmd=None):
        if cmd is None:
            from pty import spawn
            spawn("/bin/bash")
        else:
            call(cmd, shell=True)
        print_formatted_text("")
    
    def validate(self, cmd):
        _ = cmd.split()
        if len(_) <= 1 and _[0] not in self.complete_values():
            raise ValueError("bad shell command")


class Stats(Command):
    """ Display console's statistics """
    level = "root"
    
    def run(self):
        d = [["Item", "Path", "Size"]]
        p = self.console.app_folder
        d.append(["APP_FOLDER", str(p), human_readable_size(p.size)])
        p = self.workspace
        d.append(["WORKSPACE", str(p), human_readable_size(p.size)])
        t = BorderlessTable(d, "Statistics")
        print_formatted_text(t.table)


# ------------------------------- DEBUGGING COMMANDS ---------------------------
class DebugCommand(Command):
    """ Proxy class for development commands """
    requirements = {'config': {'DEBUG': True}}


class Logs(DebugCommand):
    """ Inspect console logs """
    requirements = {'system': ["less"]}
    
    def run(self):
        self.console._files.page(self.logger.__logfile__)


class Pydbg(DebugCommand):
    """ Start a Python debugger session """
    requirements = {'python': ["pdb"]}

    def run(self):
        import pdb
        pdb.set_trace()


class State(DebugCommand):
    """ Display console's shared state """
    def run(self):
        for k, v in self.console.state.items():
            print_formatted_text("\n{}:".format(k))
            v = v or ""
            if len(v) == 0:
                continue
            if isinstance(v, Iterable):
                if isinstance(v, dict):
                    v = dict(**v)
                for l in yaml.dump(v).split("\n"):
                    if len(l.strip()) == 0:
                        continue
                    print_formatted_text("  " + l)
            else:
                print_formatted_text(v)
        print_formatted_text("")


# ------------------------------ DEVELOPMENT COMMANDS --------------------------
class DevCommand(DebugCommand):
    """ Proxy class for development commands """
    def condition(self):
        return getattr(Console, "_dev_mode", False)


class Collect(DevCommand):
    """ Garbage-collect """
    def run(self):
        collect()


class Dict(DevCommand):
    """ Show console's dictionary of attributes """
    def run(self):
        pprint(self.console.__dict__)


class Memory(DevCommand):
    """ Inspect memory consumption """
    keys         = ["graph", "growth", "info", "leaking", "objects", "refs"]
    requirements = {
        'python': ["objgraph", "psutil", "xdot"],
        'system': ["xdot"],
    }
    
    def complete_values(self, key=None):
        if key in ["graph", "refs"]:
            return [str(o) for o in get_objects() if isinstance(o, Console)]
    
    def run(self, key, value=None):
        if value is not None:
            obj = list(filter(lambda o: str(o) == value, get_objects()))[0]
        if key == "graph":
            from objgraph import show_refs
            if value is None:
                p = self.console.parent
                show_refs(self.console if p is None else p, refcounts=True, max_depth=3)
            else:
                show_refs(obj, refcounts=True, max_depth=3)
        elif key == "growth":
            from objgraph import get_leaking_objects, show_most_common_types
            show_most_common_types(objects=get_leaking_objects())
        elif key == "info":
            from psutil import Process
            p = Process(os.getpid())
            print_formatted_text(p.memory_info())
        elif key == "leaking":
            from objgraph import get_leaking_objects
            print_formatted_text(get_leaking_objects())
        elif key == "objects":
            data = [["Object", "#References"]]
            for o in get_objects():
                if isinstance(o, (Console, Module)):
                    data.append([str(o), str(getrefcount(o))])
            t = BorderlessTable(data, "Consoles/Modules")
            print_formatted_text(t.table)
        elif key == "refs":
            if value is not None:
                print_formatted_text(getrefcount(obj), ":")
                pprint(get_referrers(obj))
    
    def validate(self, key, value=None):
        if key in ["graph", "refs"]:
            if value and value not in self.complete_values("graph"):
                raise ValueError("bad object")
        elif value:
            raise ValueError("this key takes no value")


1	# -- coding: UTF-8 --
2	import os	2✔
3	import stat	2✔
4	import yaml	2✔
5	from collections.abc import Iterable	2✔
6	from gc import collect, get_objects, get_referrers	2✔
7	from pprint import pprint	2✔
8	from subprocess import call	2✔
9	from sys import getrefcount	2✔
10	from tinyscript.helpers import human_readable_size, BorderlessTable, Path	2✔
11
12	from sploitkit import *	2✔
13
14
15	# ---------------------------- GENERAL-PURPOSE COMMANDS ------------------------
16	class Edit(Command):	2✔
17	""" Edit a text file """
18	requirements = {'system': ["vim"]}	2✔
19	single_arg = True	2✔
20
21	def check_requirements(self):	2✔
22	return self.config.option("TEXT_EDITOR").value is not None	2✔
23
24	def complete_values(self):	2✔
25	p = Path(self.config.option("WORKSPACE").value)	×
26	f = p.iterfiles(relative=True)	×
27	return list(map(lambda x: str(x), f))	×
28
29	def run(self, filename):	2✔
30	f = Path(self.config.option("WORKSPACE").value).joinpath(filename)	×
31	self.console._files.edit(str(f))	×
32
33	def validate(self, filename):	2✔
34	return	×
35
36
37	class History(Command):	2✔
38	""" Inspect commands history """
39	requirements = {'system': ["less"]}	2✔
40
41	def run(self):	2✔
42	h = Path(self.config.option("WORKSPACE").value).joinpath("history")	×
43	self.console._files.page(str(h))	×
44
45
46	class Shell(Command):	2✔
47	""" Execute a shell command """
48	single_arg = True	2✔
49
50	def complete_values(self):	2✔
51	l = []	×
52	e = stat.S_IEXEC \| stat.S_IXGRP \| stat.S_IXOTH	×
53	for p in os.environ['PATH'].split(":"):	×
54	if not os.path.isdir(p):	×
55	continue	×
56	for f in os.listdir(p):	×
57	fp = os.path.join(p, f)	×
58	if os.path.isfile(fp):	×
59	st = os.stat(fp)	×
60	if st.st_mode & e and f not in l:	×
61	l.append(f)	×
62	return l	×
63
64	def run(self, cmd=None):	2✔
65	if cmd is None:	×
66	from pty import spawn	×
67	spawn("/bin/bash")	×
68	else:
69	call(cmd, shell=True)	×
70	print_formatted_text("")	×
71
72	def validate(self, cmd):	2✔
73	_ = cmd.split()	×
74	if len(_) <= 1 and _[0] not in self.complete_values():	×
75	raise ValueError("bad shell command")	×
76
77
78	class Stats(Command):	2✔
79	""" Display console's statistics """
80	level = "root"	2✔
81
82	def run(self):	2✔
83	d = [["Item", "Path", "Size"]]	×
84	p = self.console.app_folder	×
85	d.append(["APP_FOLDER", str(p), human_readable_size(p.size)])	×
86	p = self.workspace	×
87	d.append(["WORKSPACE", str(p), human_readable_size(p.size)])	×
88	t = BorderlessTable(d, "Statistics")	×
89	print_formatted_text(t.table)	×
90
91
92	# ------------------------------- DEBUGGING COMMANDS ---------------------------
93	class DebugCommand(Command):	2✔
94	""" Proxy class for development commands """
95	requirements = {'config': {'DEBUG': True}}	2✔
96
97
98	class Logs(DebugCommand):	2✔
99	""" Inspect console logs """
100	requirements = {'system': ["less"]}	2✔
101
102	def run(self):	2✔
103	self.console._files.page(self.logger.__logfile__)	×
104
105
106	class Pydbg(DebugCommand):	2✔
107	""" Start a Python debugger session """
108	requirements = {'python': ["pdb"]}	2✔
109
110	def run(self):	2✔
111	import pdb	×
112	pdb.set_trace()	×
113
114
115	class State(DebugCommand):	2✔
116	""" Display console's shared state """
117	def run(self):	2✔
118	for k, v in self.console.state.items():	×
119	print_formatted_text("\n{}:".format(k))	×
120	v = v or ""	×
121	if len(v) == 0:	×
122	continue	×
123	if isinstance(v, Iterable):	×
124	if isinstance(v, dict):	×
125	v = dict(**v)	×
126	for l in yaml.dump(v).split("\n"):	×
127	if len(l.strip()) == 0:	×
128	continue	×
129	print_formatted_text(" " + l)	×
130	else:
131	print_formatted_text(v)	×
132	print_formatted_text("")	×
133
134
135	# ------------------------------ DEVELOPMENT COMMANDS --------------------------
136	class DevCommand(DebugCommand):	2✔
137	""" Proxy class for development commands """
138	def condition(self):	2✔
139	return getattr(Console, "_dev_mode", False)	2✔
140
141
142	class Collect(DevCommand):	2✔
143	""" Garbage-collect """
144	def run(self):	2✔
145	collect()	×
146
147
148	class Dict(DevCommand):	2✔
149	""" Show console's dictionary of attributes """
150	def run(self):	2✔
151	pprint(self.console.__dict__)	×
152
153
154	class Memory(DevCommand):	2✔
155	""" Inspect memory consumption """
156	keys = ["graph", "growth", "info", "leaking", "objects", "refs"]	2✔
157	requirements = {	2✔
158	'python': ["objgraph", "psutil", "xdot"],
159	'system': ["xdot"],
160	}
161
162	def complete_values(self, key=None):	2✔
163	if key in ["graph", "refs"]:	×
164	return [str(o) for o in get_objects() if isinstance(o, Console)]	×
165
166	def run(self, key, value=None):	2✔
167	if value is not None:	×
168	obj = list(filter(lambda o: str(o) == value, get_objects()))[0]	×
169	if key == "graph":	×
170	from objgraph import show_refs	×
171	if value is None:	×
172	p = self.console.parent	×
173	show_refs(self.console if p is None else p, refcounts=True, max_depth=3)	×
174	else:
175	show_refs(obj, refcounts=True, max_depth=3)	×
176	elif key == "growth":	×
177	from objgraph import get_leaking_objects, show_most_common_types	×
178	show_most_common_types(objects=get_leaking_objects())	×
179	elif key == "info":	×
180	from psutil import Process	×
181	p = Process(os.getpid())	×
182	print_formatted_text(p.memory_info())	×
183	elif key == "leaking":	×
184	from objgraph import get_leaking_objects	×
185	print_formatted_text(get_leaking_objects())	×
186	elif key == "objects":	×
187	data = [["Object", "#References"]]	×
188	for o in get_objects():	×
189	if isinstance(o, (Console, Module)):	×
190	data.append([str(o), str(getrefcount(o))])	×
191	t = BorderlessTable(data, "Consoles/Modules")	×
192	print_formatted_text(t.table)	×
193	elif key == "refs":	×
194	if value is not None:	×
195	print_formatted_text(getrefcount(obj), ":")	×
196	pprint(get_referrers(obj))	×
197
198	def validate(self, key, value=None):	2✔
199	if key in ["graph", "refs"]:	×
200	if value and value not in self.complete_values("graph"):	×
201	raise ValueError("bad object")	×
202	elif value:	×
203	raise ValueError("this key takes no value")	×
204

dhondta / python-sploitkit / 172

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