--- /dev/null
+#!/usr/bin/env python
+
+from os import name #, path, system, symlink, pathsep
+#from distutils.sysconfig import get_config_var
+from setuptools import setup, find_packages
+#from subprocess import PIPE, Popen
+#from sys import argv
+
+
+scripts = [
+ 'src/scripts/canari',
+ 'src/scripts/pysudo',
+ 'src/scripts/dispatcher',
+]
+
+extras = [
+ 'readline'
+]
+
+if name == 'nt':
+ scripts += ['%s.bat' % s for s in scripts]
+
+
+#if 'fixpath' not in argv:
+setup(
+ name='canari',
+ author='Nadeem Douba',
+ version='1.0',
+ author_email='ndouba@gmail.com',
+ description='Rapid transform development and transform execution framework for Maltego.',
+ license='GPL',
+ packages=find_packages('src'),
+ package_dir={ '' : 'src' },
+ scripts=scripts,
+ zip_safe=False,
+ package_data={
+ '' : [ '*.conf', '*.plate' ]
+ },
+ install_requires=[
+ 'pexpect',
+ 'argparse'
+ ],
+ dependency_links=[]
+)
+
+
+# Fixing Canari script path to work with JVM
+#elif 'fixpath' in argv:
+# print '\nChecking PATH of JVM and Canari...'
+#
+# if not path.exists('java/JVMPathChecker.class') and system('javac java/JVMPathChecker.java'):
+# print 'Error compiling the path checker using javac.'
+# exit(-1)
+#
+# proc = Popen(['java', '-cp', 'java', 'JVMPathChecker'], stdout=PIPE)
+# jvm_path = proc.communicate()[0][:-1].split(pathsep)
+#
+# bindir = get_config_var('BINDIR')
+#
+# if bindir not in jvm_path:
+# print "Warning %s not in your JVM's PATH" % bindir
+#
+# while True:
+# i = 0
+# for i, path_dir in enumerate(jvm_path):
+# print '[%d]: %s' % (i, path_dir)
+#
+# try:
+# selection = int(
+# raw_input("Please select the path where you'd like to place symlinks to Canari's scripts [0]: ")
+# )
+# if selection <= i:
+# for script in scripts:
+# srcf = path.join(bindir, script)
+# dstf = path.join(jvm_path[selection], script)
+# if not path.exists(srcf):
+# print 'Could not find %s in %s' % (repr(script), repr(bindir))
+# exit(-1)
+# elif path.exists(dstf):
+# print 'skipping %s since it already exists in %s...' % (
+# repr(script),
+# repr(jvm_path[selection])
+# )
+# continue
+# print 'symlinking %s to %s...' % (srcf, dstf)
+# symlink(srcf, dstf)
+# exit(0)
+# raise ValueError
+# except ValueError:
+# print 'Invalid selection... try again.'
+# else:
+# print 'All looks good... no further action required here.'
+#
+#
+#
+#print '\nChecking if other dependencies installed...'
+#
+#for e in extras:
+# try:
+# __import__(e)
+# except ImportError:
+# print 'WARNING: Package %s not installed. Please download and manually install this package' % repr(e)
--- /dev/null
+#!/usr/bin/env python
+
+__author__ = 'Nadeem Douba'
+__copyright__ = 'Copyright 2012, Canari Project'
+__credits__ = []
+
+__license__ = 'GPL'
+__version__ = '0.1'
+__maintainer__ = 'Nadeem Douba'
+__email__ = 'ndouba@gmail.com'
+__status__ = 'Development'
+
+__all__ = [
+ 'install_package',
+ 'uninstall_package',
+ 'mtgx2csv',
+ 'csv2sheets',
+ 'common',
+ 'help',
+ 'create_package',
+ 'create_transform',
+ 'debug_transform',
+ 'shell',
+ 'run_transform',
+ 'delete_transform',
+ 'rename_transform',
+ 'list_commands',
+ 'run_server'
+]
\ No newline at end of file
--- /dev/null
+#!/usr/bin/env python
+
+from os import path, listdir, sep, environ, mkdir, pathsep
+from pkg_resources import resource_filename
+from sys import path as pypath, platform
+from string import Template
+
+__author__ = 'Nadeem Douba'
+__copyright__ = 'Copyright 2012, Canari Project'
+__credits__ = []
+
+__license__ = 'GPL'
+__version__ = '0.1'
+__maintainer__ = 'Nadeem Douba'
+__email__ = 'ndouba@gmail.com'
+__status__ = 'Development'
+
+
+def get_commands(module='canari.commands'):
+ sc = __import__(module, globals(), locals(), fromlist=['__all__'])
+ commands = {}
+ for c in sc.__all__:
+ m = __import__('%s.%s' % (module, c), globals(), locals(), fromlist=['run', 'help'])
+ if 'run' in dir(m):
+ commands[cmd_name(m.__name__)] = m
+ return commands
+
+
+def _detect_settings_dir(d):
+ vs = [ i for i in listdir(d) if path.isdir(sep.join([d, i])) ]
+ if len(vs) == 1:
+ return sep.join([d, vs[0]])
+ else:
+ while True:
+ print('Multiple versions of Maltego detected: ')
+ for i, v in enumerate(vs):
+ print('[%d] Maltego %s' % (i, v))
+ r = raw_input('Please select which version you wish to install the transforms in [0]: ')
+ try:
+ if not r:
+ return sep.join([d, vs[0]])
+ elif int(r) < len(vs):
+ return sep.join([d, vs[int(r)]])
+ except ValueError:
+ pass
+ print('Invalid selection... %s' % repr(r))
+ print('Could not automatically find Maltego\'s settings directory. Use the -w parameter to specify its location, instead.')
+
+
+def detect_settings_dir():
+ d = None
+ if platform.startswith('linux'):
+ d = _detect_settings_dir(sep.join([path.expanduser('~'), '.maltego']))
+ elif platform == 'darwin':
+ d = _detect_settings_dir(sep.join([path.expanduser('~'), 'Library', 'Application Support', 'maltego']))
+ elif platform == 'win32':
+ d = _detect_settings_dir(sep.join([environ['APPDATA'], '.maltego']))
+ else:
+ raise NotImplementedError('Unknown or unsupported OS: %s' % repr(platform))
+ return d
+
+
+def read_template(name, values):
+ t = Template(file(resource_filename('canari.resources.template', '%s.plate' % name)).read())
+ return t.substitute(**values)
+
+
+def write_template(fname, data):
+ print('creating file %s...' % fname)
+ with file(fname, mode='wb') as w:
+ w.write(data)
+
+
+def generate_all(*args):
+ return "\n__all__ = [\n '%s'\n]" % "',\n '".join(args)
+
+
+def build_skeleton(*args):
+ for d in args:
+ if isinstance(d, list):
+ d = sep.join(d)
+ print('creating directory %s' % d)
+ mkdir(d)
+
+
+def highlight(string, color, bold):
+ attr = []
+ if color == 'green':
+ # green
+ attr.append('32')
+ elif color == 'red':
+ # red
+ attr.append('31')
+ else:
+ attr.append('30')
+ if bold:
+ attr.append('1')
+ return '\x1b[%sm%s\x1b[0m' % (';'.join(attr), string)
+
+
+def croak(exc):
+ print(highlight(exc, 'red', None))
+
+
+def fix_pypath():
+ if '' not in pypath:
+ pypath.insert(0, '')
+
+
+def fix_binpath(paths):
+ if paths is not None:
+ if isinstance(paths, basestring):
+ environ['PATH'] = paths
+ elif isinstance(paths, list):
+ environ['PATH'] = pathsep.join(paths)
+
+
+def import_transform(script):
+ fix_pypath()
+ return __import__(script, globals(), locals(), ['dotransform'])
+
+
+def cmd_name(name):
+ return name.replace('canari.commands.', '').replace('_', '-')
+
+
+def console_message(msg, tab=-1):
+ tab += 1
+ print('%s`- %s: %s %s' % (
+ ' ' * tab,
+ highlight(msg.tag, None, True),
+ highlight(msg.text, 'red', False) if msg.text is not None else '',
+ highlight(msg.attrib, 'green', True) if msg.attrib.keys() else ''
+ ))
+ for c in msg.getchildren():
+ print(' %s`- %s: %s %s' % (
+ ' ' * tab,
+ highlight(c.tag, None, True),
+ highlight(c.text, 'red', False) if c.text is not None else '',
+ highlight(c.attrib, 'green', True) if c.attrib.keys() else ''
+ ))
+ for sc in c.getchildren():
+ tab += 1
+ console_message(sc, tab)
+ tab -= 1
+ tab -= 1
\ No newline at end of file
--- /dev/null
+#!/usr/bin/env python
+
+from common import read_template, write_template, generate_all, build_skeleton, cmd_name
+
+from argparse import ArgumentParser
+from getpass import getuser
+from os import path, sep
+
+
+__author__ = 'Nadeem Douba'
+__copyright__ = 'Copyright 2012, Canari Project'
+__credits__ = []
+
+__license__ = 'GPL'
+__version__ = '0.1'
+__maintainer__ = 'Nadeem Douba'
+__email__ = 'ndouba@gmail.com'
+__status__ = 'Development'
+
+
+parser = ArgumentParser(
+ description='Creates a Canari transform package skeleton.',
+ usage='canari %s <package name>' % cmd_name(__name__)
+)
+
+parser.add_argument(
+ 'package',
+ metavar='<package name>',
+ help='The name of the canari package you wish to create.'
+)
+
+
+def write_setup(package_name, values):
+ write_template(sep.join([package_name, 'setup.py']), read_template('setup', values))
+ write_template(sep.join([package_name, 'README.md']), read_template('README', values))
+
+
+def write_root(base, init):
+ write_template(
+ sep.join([base, '__init__.py']),
+ init + generate_all('resources', 'transforms')
+ )
+
+
+def write_resources(package_name, resources, init, values):
+ write_template(
+ sep.join([resources, '__init__.py']),
+ init + generate_all('etc', 'images')
+ )
+
+ write_template(
+ sep.join([resources, 'etc', '__init__.py']),
+ init
+ )
+
+ write_template(
+ sep.join([resources, 'images', '__init__.py']),
+ init
+ )
+
+ write_template(
+ sep.join([resources, 'etc', '%s.conf' % package_name]),
+ read_template('conf', values)
+ )
+
+
+def write_common(transforms, init, values):
+ write_template(
+ sep.join([transforms, '__init__.py']),
+ init + generate_all('common', 'helloworld')
+ )
+
+ write_template(
+ sep.join([transforms, 'helloworld.py']),
+ read_template('transform', values)
+ )
+
+ write_template(
+ sep.join([transforms, 'common', '__init__.py']),
+ init + generate_all('entities')
+ )
+
+ write_template(
+ sep.join([transforms, 'common', 'entities.py']),
+ read_template('entities', values)
+ )
+
+
+def help():
+ parser.print_help()
+
+
+def description():
+ return parser.description
+
+
+def run(args):
+
+ opts = parser.parse_args(args)
+
+ package_name = opts.package
+ capitalized_package_name = package_name.capitalize()
+
+ values = {
+ 'package' : package_name,
+ 'entity' : 'My%sEntity' % capitalized_package_name,
+ 'base_entity' : '%sEntity' % capitalized_package_name,
+ 'author' : getuser(),
+ 'year' : 2012,
+ 'project' : capitalized_package_name,
+ 'namespace' : package_name
+ }
+
+ base = sep.join([package_name, 'src', package_name])
+ transforms = sep.join([base, 'transforms'])
+ resources = sep.join([base, 'resources'])
+
+ if not path.exists(package_name):
+ print('creating skeleton in %s' % package_name)
+ build_skeleton(
+ package_name,
+ [package_name, 'src'],
+ [package_name, 'maltego'],
+ base,
+ transforms,
+ [transforms, 'common'],
+ resources,
+ [resources, 'etc'],
+ [resources, 'images']
+ )
+ else:
+ print('A directory with the name %s already exists... exiting' % package_name)
+ exit(-1)
+
+
+ init = read_template('__init__', values)
+
+ write_setup(package_name, values)
+
+ write_root(base, init)
+
+ write_resources(package_name, resources, init, values)
+
+ write_common(transforms, init, values)
+
+ print('done!')
\ No newline at end of file
--- /dev/null
+#!/usr/bin/env python
+
+from common import write_template, read_template, cmd_name
+
+from argparse import ArgumentParser
+from os import path, sep, getcwd
+from getpass import getuser
+from re import sub
+
+
+__author__ = 'Nadeem Douba'
+__copyright__ = 'Copyright 2012, Canari Project'
+__credits__ = []
+
+__license__ = 'GPL'
+__version__ = '0.1'
+__maintainer__ = 'Nadeem Douba'
+__email__ = 'ndouba@gmail.com'
+__status__ = 'Development'
+
+
+parser = ArgumentParser(
+ description='Creates a new transform in the specified directory and auto-updates __init__.py.',
+ usage='canari %s <transform name> [options]' % cmd_name(__name__)
+)
+
+parser.add_argument(
+ 'transform',
+ metavar='<transform name>',
+ help='The name of the transform you wish to create.'
+)
+
+parser.add_argument(
+ '-d',
+ '--transform-dir',
+ metavar='<dir>',
+ help='The directory in which you wish to create the transform.',
+ default=getcwd()
+)
+
+
+def help():
+ parser.print_help()
+
+
+def description():
+ return parser.description
+
+
+def parse_args(args):
+ args = parser.parse_args(args)
+ return args
+
+
+def run(args):
+
+ opts = parse_args(args)
+
+ initf = sep.join([opts.transform_dir, '__init__.py'])
+ transform = opts.transform
+ directory = opts.transform_dir
+ transformf = sep.join([directory, transform if transform.endswith('.py') else '%s.py' % transform ])
+
+ if not path.exists(initf):
+ print ('Directory %s does not appear to be a python package directory... quitting!' % repr(opts.transform_dir))
+ exit(-1)
+ if path.exists(transformf):
+ print ('Transform %s already exists... quitting' % repr(transformf))
+ exit(-1)
+
+ values = {
+ 'author' : getuser(),
+ 'year' : 2012
+ }
+
+ write_template(
+ transformf,
+ read_template('newtransform', values)
+ )
+
+ print ('updating %s' % initf)
+ init = file(initf).read()
+
+ with file(initf, mode='wb') as w:
+ w.write(
+ sub(
+ r'__all__\s*\=\s*\[',
+ '__all__ = [\n %s,' % repr(transform),
+ init
+ )
+ )
+
+ print ('done!')
--- /dev/null
+#!/usr/bin/env python
+
+from common import cmd_name
+
+from argparse import ArgumentParser
+from re import sub, match
+
+
+__author__ = 'Nadeem Douba'
+__copyright__ = 'Copyright 2012, Canari Project'
+__credits__ = []
+
+__license__ = 'GPL'
+__version__ = '0.1'
+__maintainer__ = 'Nadeem Douba'
+__email__ = 'ndouba@gmail.com'
+__status__ = 'Development'
+
+
+parser = ArgumentParser(
+ description='Convert mixed entity type CSVs to separated CSV sheets.',
+ usage='canari %s <graph csv> <sheet prefix>' % cmd_name(__name__)
+)
+
+parser.add_argument(
+ 'graph',
+ metavar='<graph csv>',
+ help='The CSV file containing the output from the mtgx2csv command.'
+)
+
+parser.add_argument(
+ 'prefix',
+ metavar='<sheet prefix>',
+ help='The prefix to prepend to the generated CSV files.'
+)
+
+
+def help():
+ parser.print_help()
+
+
+def description():
+ return parser.description
+
+
+def parse_args(args):
+ return parser.parse_args(args)
+
+
+def run(args):
+
+ opts = parse_args(args)
+
+ matchers = {}
+
+ for line in file(opts.graph):
+ line.replace('""', '"')
+ matcher = sub('=([^"]+)"', '=([^"]+)"', line)
+
+ if matcher not in matchers:
+ matchers[matcher] = []
+
+ matchers[matcher].append(line)
+
+
+ i = 0
+ for matcher in matchers:
+ f = open('%s_%d.csv' % (opts.prefix, i), 'w')
+ i += 1
+
+ f.write(matcher.replace('=([^"]+)', ''))
+
+ for r in matchers[matcher]:
+ line = '","'.join(match(matcher, r).groups())
+ line = '"%s"\n' % line
+ line.replace('"', '""')
+ f.write(line)
+
+ f.close()
--- /dev/null
+#!/usr/bin/env python
+
+from ..maltego.message import MaltegoException, MaltegoTransformResponseMessage
+from common import croak, import_transform, cmd_name, console_message, fix_binpath
+from ..maltego.utils import onterminate, parseargs
+from ..config import config
+
+from distutils.sysconfig import get_config_var
+from os import execvp, geteuid, name, path
+from argparse import ArgumentParser
+from traceback import format_exc
+from sys import argv
+
+
+__author__ = 'Nadeem Douba'
+__copyright__ = 'Copyright 2012, Canari Project'
+__credits__ = []
+
+__license__ = 'GPL'
+__version__ = '0.1'
+__maintainer__ = 'Nadeem Douba'
+__email__ = 'ndouba@gmail.com'
+__status__ = 'Development'
+
+
+parser = ArgumentParser(
+ description='Runs Canari local transforms in a terminal-friendly fashion.',
+ usage='canari %s <transform> [param1 ... paramN] <value> [field1=value1...#fieldN=valueN]' % cmd_name(__name__)
+)
+
+parser.add_argument(
+ 'transform',
+ metavar='<transform>',
+ help='The name of the transform you wish to run (e.g. canari.transforms.nmapfastscan).'
+)
+
+parser.add_argument(
+ 'value',
+ metavar='<value>',
+ help='The value of the input entity being passed into the local transform.'
+)
+
+parser.add_argument(
+ 'params',
+ metavar='[param1 ... paramN]',
+ help='Any extra parameters that can be sent to the local transform.'
+)
+
+parser.add_argument(
+ 'fields',
+ metavar='[field1=value1...#fieldN=valueN]',
+ help='The fields of the input entity being passed into the local transform.'
+)
+
+
+def help():
+ parser.print_help()
+
+
+def description():
+ return parser.description
+
+
+def run(args):
+
+ [transform, params, value, fields] = parseargs(['canari %s' % cmd_name(__name__)] + args)
+
+ m = None
+ pysudo = path.join(get_config_var('BINDIR'), 'pysudo')
+ fix_binpath(config['default/path'])
+ try:
+ m = import_transform(transform)
+
+ if name == 'posix' and hasattr(m.dotransform, 'privileged') and geteuid():
+ execvp(pysudo, [pysudo] + list(argv))
+ exit(-1)
+
+ if hasattr(m, 'onterminate'):
+ onterminate(m.onterminate)
+ else:
+ m.__setattr__('onterminate', lambda *args: exit(-1))
+
+ msg = m.dotransform(
+ type(
+ 'MaltegoTransformRequestMessage',
+ (object,),
+ {
+ 'value' : value,
+ 'fields' : fields,
+ 'params' : params
+ }
+ )(),
+ MaltegoTransformResponseMessage()
+ )
+
+ if isinstance(msg, MaltegoTransformResponseMessage):
+ console_message(msg)
+ elif isinstance(msg, basestring):
+ raise MaltegoException(msg)
+ else:
+ raise MaltegoException('Could not resolve message type returned by transform.')
+ except MaltegoException, me:
+ croak(str(me))
+ except ImportError:
+ e = format_exc()
+ croak(e)
+ except Exception:
+ e = format_exc()
+ croak(e)
+ except KeyboardInterrupt, ki:
+ if m is not None:
+ m.onterminate()
\ No newline at end of file
--- /dev/null
+#!/usr/bin/env python
+
+from common import cmd_name
+
+from os import path, sep, getcwd, unlink
+from argparse import ArgumentParser
+from re import sub
+
+
+__author__ = 'Nadeem Douba'
+__copyright__ = 'Copyright 2012, Canari Project'
+__credits__ = []
+
+__license__ = 'GPL'
+__version__ = '0.1'
+__maintainer__ = 'Nadeem Douba'
+__email__ = 'ndouba@gmail.com'
+__status__ = 'Development'
+
+
+parser = ArgumentParser(
+ description='Deletes a transform in the specified directory and auto-updates __init__.py.',
+ usage='canari %s <transform name> [options]' % cmd_name(__name__)
+)
+
+parser.add_argument(
+ 'transform',
+ metavar='<transform name>',
+ help='The name of the transform you wish to delete.'
+)
+
+parser.add_argument(
+ '-d',
+ '--transform-dir',
+ metavar='<dir>',
+ help='The directory from which you wish to delete the transform.',
+ default=getcwd()
+)
+
+
+def help():
+ parser.print_help()
+
+
+def description():
+ return parser.description
+
+
+def parse_args(args):
+ args = parser.parse_args(args)
+ return args
+
+
+def run(args):
+
+ opts = parse_args(args)
+
+ initf = sep.join([opts.transform_dir, '__init__.py'])
+ transform = opts.transform
+ transformf = sep.join([opts.transform_dir, transform if transform.endswith('.py') else '%s.py' % transform ])
+
+ if not path.exists(initf):
+ print ('Directory %s does not appear to be a python package directory... quitting!' % repr(opts.transform_dir))
+ exit(-1)
+ if not path.exists(transformf):
+ print ("Transform %s doesn't exists... quitting" % repr(transformf))
+ exit(-1)
+
+ print ("deleting transform %s..." % repr(transformf))
+ unlink(transformf)
+
+ print ('updating %s' % initf)
+ init = file(initf).read()
+
+ with file(initf, mode='wb') as w:
+ w.write(
+ sub(
+ r'\s*%s,?' % repr(transform),
+ '',
+ init
+ )
+ )
+
+ print ('done!')
--- /dev/null
+#!/usr/bin/env python
+
+from common import get_commands, cmd_name
+
+from argparse import ArgumentParser
+from sys import modules
+
+
+__author__ = 'Nadeem Douba'
+__copyright__ = 'Copyright 2012, Canari Project'
+__credits__ = []
+
+__license__ = 'GPL'
+__version__ = '0.1'
+__maintainer__ = 'Nadeem Douba'
+__email__ = 'ndouba@gmail.com'
+__status__ = 'Development'
+
+cmds = get_commands()
+cmds.update({'help': modules[__name__]})
+
+parser = ArgumentParser(
+ description='Shows help related to various canari commands',
+ usage='canari %s <command>' % cmd_name(__name__)
+)
+parser.add_argument(
+ 'command',
+ metavar='<command>',
+ choices=cmds,
+ help='The canari command you want help for (%s)' % ', '.join(cmds)
+)
+
+
+def help():
+ parser.print_help()
+
+
+def description():
+ return parser.description
+
+
+def run(args):
+ cmds[parser.parse_args(args).command].help()
\ No newline at end of file
--- /dev/null
+#!/usr/bin/env python
+
+from ..maltego.configuration import (MaltegoTransform, CmdCwdTransformProperty, CmdDbgTransformProperty,
+ CmdLineTransformProperty, CmdParmTransformProperty, InputConstraint, TransformSet,
+ TransformSettings, CmdCwdTransformPropertySetting, CmdDbgTransformPropertySetting,
+ CmdLineTransformPropertySetting, CmdParmTransformPropertySetting)
+from common import detect_settings_dir, cmd_name, fix_pypath
+from ..maltego.message import ElementTree
+
+from os import sep, path, mkdir, chdir, getcwd, name
+from distutils.sysconfig import get_config_var
+from pkg_resources import resource_filename
+from argparse import ArgumentParser
+from string import Template
+from sys import stderr
+from re import sub
+
+
+
+__author__ = 'Nadeem Douba'
+__copyright__ = 'Copyright 2012, Canari Project'
+__credits__ = []
+
+__license__ = 'GPL'
+__version__ = '0.1'
+__maintainer__ = 'Nadeem Douba'
+__email__ = 'ndouba@gmail.com'
+__status__ = 'Development'
+
+
+# Dictionary of detected transforms
+transforms = {}
+
+# Argument parser
+parser = ArgumentParser(
+ description="Installs and configures canari transform packages in Maltego's UI",
+ usage='canari %s <package> [options]' % cmd_name(__name__)
+)
+
+parser.add_argument(
+ 'package',
+ metavar='<package>',
+ help='the name of the canari transforms package to install.'
+)
+parser.add_argument(
+ '-w',
+ '--working-dir',
+ metavar='[working dir]',
+ default=getcwd(),
+ help='the path that will be used as the working directory for the transforms being installed (default: current working directory)'
+)
+parser.add_argument(
+ '-s',
+ '--settings-dir',
+ metavar='[settings dir]',
+ default=detect_settings_dir,
+ help='the path to the Maltego settings directory (automatically detected if excluded)'
+)
+
+
+# Help for this command
+def help():
+ parser.print_help()
+
+
+def description():
+ return parser.description
+
+
+# Extra sauce to parse args
+def parse_args(args):
+ args = parser.parse_args(args)
+
+ if args.settings_dir is detect_settings_dir:
+ args.settings_dir = detect_settings_dir()
+
+ return args
+
+
+# Logic to install transforms
+def install_transform(module, name, author, spec, prefix, working_dir):
+
+ installdir = sep.join([prefix, 'config', 'Maltego', 'TransformRepositories', 'Local'])
+
+ if not path.exists(installdir):
+ mkdir(installdir)
+
+ setsdir = sep.join([prefix, 'config', 'Maltego', 'TransformSets'])
+
+ for i,n in enumerate(spec.uuids):
+
+ if n in transforms:
+ stderr.write('WARNING: Previous declaration of %s in transform %s. Overwriting...' % (n, module))
+ else:
+ print ('Installing transform %s from %s...' % (n, module))
+ transforms[n] = module
+
+ intype = spec.inputs[i][1]('').type
+
+ sets = None
+ if spec.inputs[i][0] is not None:
+ setdir = sep.join([setsdir, spec.inputs[i][0]])
+ if not path.exists(setdir):
+ mkdir(setdir)
+ open(sep.join([setdir, n]), 'w').close()
+ sets=TransformSet(spec.inputs[i][0])
+
+ transform = MaltegoTransform(
+ n,
+ spec.label,
+ author=author,
+ description=spec.description,
+ properties=[
+ CmdLineTransformProperty(),
+ CmdCwdTransformProperty(),
+ CmdDbgTransformProperty(),
+ CmdParmTransformProperty()
+ ],
+ input=InputConstraint(intype),
+ sets=sets
+ )
+ transform.sets
+
+
+ ElementTree(transform).write(sep.join([installdir, '%s.transform' % n]))
+
+ transformsettings = TransformSettings(properties=[
+ CmdLineTransformPropertySetting(path.join(get_config_var('BINDIR'), 'dispatcher')),
+ CmdParmTransformPropertySetting(name),
+ CmdCwdTransformPropertySetting(working_dir),
+ CmdDbgTransformPropertySetting(spec.debug)
+ ])
+ ElementTree(transformsettings).write(sep.join([installdir, '%s.transformsettings' % n]))
+
+
+def writeconf(sf, df, **kwargs):
+ if not path.exists(df):
+ print ('Writing %s to %s' % (sf, df))
+ with file(df, mode='wb') as w:
+ if 'sub' in kwargs and kwargs['sub']:
+ del kwargs['sub']
+ w.write(
+ Template(
+ file(
+ sf
+ ).read()
+ ).substitute(**kwargs)
+ )
+ else:
+ w.write(
+ file(
+ sf
+ ).read()
+ )
+
+
+def updateconf(c, f):
+ ld = getcwd()
+ chdir(path.dirname(f))
+
+ import canari.config as config
+ reload(config)
+
+ if c not in config.config['default/configs']:
+ print ('Updating %s...' % f)
+ s = ''
+ with file(f) as r:
+ s = r.read()
+ with file(f, mode='wb') as w:
+ w.write(sub(r'configs\s*\=', 'configs = %s,' % c, s))
+ chdir(ld)
+
+
+# Main
+def run(args):
+
+ opts = parse_args(args)
+
+ fix_pypath()
+
+
+ if opts.package.endswith('.transforms'):
+ opts.package = opts.package.replace('.transforms', '')
+
+ print ('Looking for transforms in %s.transforms' % opts.package)
+ m = __import__('%s.transforms' % opts.package, globals(), locals(), ['*'])
+
+ for t in m.__all__:
+ transform = '%s.transforms.%s' % (opts.package, t)
+
+ m2 = __import__(transform, globals(), locals(), ['dotransform'])
+ if hasattr(m2, 'dotransform') and hasattr(m2.dotransform, 'label'):
+ install_transform(
+ m2.__name__,
+ transform,
+ getattr(m2, '__author__', ''),
+ m2.dotransform,
+ opts.settings_dir,
+ opts.working_dir
+ )
+
+ if not transforms:
+ print ('Error: no transforms found...')
+ exit(-1)
+ else:
+ src = resource_filename('canari.resources.template', 'canari.plate')
+ writeconf(
+ src,
+ sep.join([opts.working_dir, 'canari.conf']),
+ sub=True,
+ command=' '.join(['canari install'] + args),
+ config=('%s.conf' % opts.package) if opts.package != 'canari' else '',
+ path='${PATH},/usr/local/bin,/opt/local/bin' if name == 'posix' else ''
+ )
+
+ if opts.package != 'canari':
+ src = resource_filename('%s.resources.etc' % opts.package, '%s.conf' % opts.package)
+ writeconf(src, sep.join([opts.working_dir, '%s.conf' % opts.package]), sub=False)
+ updateconf('%s.conf' % opts.package, sep.join([opts.working_dir, 'canari.conf']))
--- /dev/null
+#!/usr/bin/env python
+
+from common import get_commands, cmd_name, highlight
+
+from argparse import ArgumentParser
+from sys import modules
+
+__author__ = 'Nadeem Douba'
+__copyright__ = 'Copyright 2012, Canari Project'
+__credits__ = []
+
+__license__ = 'GPL'
+__version__ = '0.1'
+__maintainer__ = 'Nadeem Douba'
+__email__ = 'ndouba@gmail.com'
+__status__ = 'Development'
+
+cmds = get_commands()
+cmds.update({'list-commands': modules[__name__]})
+
+parser = ArgumentParser(
+ description='Lists all the available canari commands',
+ usage='canari %s' % cmd_name(__name__)
+)
+
+
+def help():
+ parser.print_help()
+
+
+def description():
+ return parser.description
+
+
+def run(args):
+ k = cmds.keys()
+ k.sort()
+ for i in k:
+ print ('%s - %s' % (highlight(i, 'green', True), cmds[i].description()))
\ No newline at end of file
--- /dev/null
+#!/usr/bin/env python
+
+from common import cmd_name
+
+from xml.etree.cElementTree import XML
+from argparse import ArgumentParser
+from zipfile import ZipFile
+
+
+__author__ = 'Nadeem Douba'
+__copyright__ = 'Copyright 2012, Canari Project'
+__credits__ = []
+
+__license__ = 'GPL'
+__version__ = '0.1'
+__maintainer__ = 'Nadeem Douba'
+__email__ = 'ndouba@gmail.com'
+__status__ = 'Development'
+
+
+parser = ArgumentParser(
+ description='Convert Maltego graph files (*.mtgx) to comma-separated values (CSV) file.',
+ usage='canari %s <graph>' % cmd_name(__name__)
+)
+
+parser.add_argument(
+ 'graph',
+ metavar='<graph>',
+ help='The name of the graph file you wish to convert to CSV.',
+)
+
+
+def parse_args(args):
+ return parser.parse_args(args)
+
+
+def help():
+ parser.print_help()
+
+
+def description():
+ return parser.description
+
+
+def run(args):
+
+ opts = parse_args(args)
+
+ zip = ZipFile(opts.graph)
+ graphs = filter(lambda x: x.endswith('.graphml'), zip.namelist())
+
+ for f in graphs:
+ csv = open(f.split('/')[1].split('.')[0] + '.csv', 'w')
+ xml = XML(zip.open(f).read())
+ for e in xml.findall('{http://graphml.graphdrawing.org/xmlns}graph/{http://graphml.graphdrawing.org/xmlns}node/{http://graphml.graphdrawing.org/xmlns}data/{http://maltego.paterva.com/xml/mtgx}MaltegoEntity'):
+ csv.write(('"Entity Type=%s",' % e.get('type')).strip())
+ for prop in e.findall('{http://maltego.paterva.com/xml/mtgx}Properties/{http://maltego.paterva.com/xml/mtgx}Property'):
+ value = prop.find('{http://maltego.paterva.com/xml/mtgx}Value').text or ''
+ if '"' in value:
+ value.replace('"', '""')
+ csv.write(('"%s=%s",' % (prop.get('displayName'), value)).strip())
+ csv.write('\n')
\ No newline at end of file
--- /dev/null
+#!/usr/bin/env python
+
+from common import cmd_name
+
+from os import path, sep, getcwd, rename
+from argparse import ArgumentParser
+from re import sub
+
+
+__author__ = 'Nadeem Douba'
+__copyright__ = 'Copyright 2012, Canari Project'
+__credits__ = []
+
+__license__ = 'GPL'
+__version__ = '0.1'
+__maintainer__ = 'Nadeem Douba'
+__email__ = 'ndouba@gmail.com'
+__status__ = 'Development'
+
+
+parser = ArgumentParser(
+ description='Renames a transform in the specified directory and auto-updates __init__.py.',
+ usage='canari %s <transform name> [options]' % cmd_name(__name__)
+)
+
+parser.add_argument(
+ 'transform',
+ metavar='<old transform name>',
+ help='The name of the transform you wish to rename.'
+)
+
+parser.add_argument(
+ 'new_transform',
+ metavar='<new transform name>',
+ help='The desired name of the transform.'
+)
+
+parser.add_argument(
+ '-d',
+ '--transform-dir',
+ metavar='<dir>',
+ help='The directory from which you wish to rename the transform.',
+ default=getcwd()
+)
+
+
+def help():
+ parser.print_help()
+
+
+def description():
+ return parser.description
+
+
+def parse_args(args):
+ args = parser.parse_args(args)
+ return args
+
+
+def run(args):
+
+ opts = parse_args(args)
+
+ initf = sep.join([opts.transform_dir, '__init__.py'])
+ transform = opts.transform
+ transformf = sep.join([opts.transform_dir, transform if transform.endswith('.py') else '%s.py' % transform ])
+ dtransform = opts.new_transform
+ dtransformf = sep.join([opts.transform_dir, dtransform if dtransform.endswith('.py') else '%s.py' % dtransform ])
+
+ if not path.exists(initf):
+ print ('Directory %s does not appear to be a python package directory... quitting!' % repr(opts.transform_dir))
+ exit(-1)
+ if not path.exists(transformf):
+ print ("Transform %s doesn't exists... quitting" % repr(transformf))
+ exit(-1)
+ if path.exists(dtransformf):
+ print ("Cannot overwrite existing transform %s... quitting" % repr(dtransformf))
+ exit(-1)
+ if dtransform == transform:
+ print ("Nothing to do here... the new name is the same as the old one?")
+ exit(-1)
+
+ print ('renaming transform %s to %s...' % (repr(transformf), repr(dtransformf)))
+ rename(transformf, dtransformf)
+
+ print ('updating %s' % initf)
+ init = file(initf).read()
+
+ with file(initf, mode='wb') as w:
+ w.write(
+ sub(
+ repr(transform),
+ repr(dtransform),
+ init
+ )
+ )
+
+ print ('done!')
--- /dev/null
+#!/usr/bin/env python
+
+from ..maltego.message import (MaltegoTransformResponseMessage, MaltegoException,
+ MaltegoTransformExceptionMessage, MaltegoMessage, Message)
+from common import cmd_name, import_transform, fix_binpath, fix_pypath
+from ..config import config
+
+from BaseHTTPServer import HTTPServer, BaseHTTPRequestHandler
+from xml.etree.cElementTree import fromstring
+from os import execvp, geteuid, name, path
+from SocketServer import ThreadingMixIn
+from ssl import wrap_socket, CERT_NONE
+from argparse import ArgumentParser
+from cStringIO import StringIO
+from urlparse import urlsplit
+from sys import argv
+from re import sub
+
+
+__author__ = 'Nadeem Douba'
+__copyright__ = 'Copyright 2012, Sploitego Project'
+__credits__ = []
+
+__license__ = 'GPL'
+__version__ = '0.1'
+__maintainer__ = 'Nadeem Douba'
+__email__ = 'ndouba@gmail.com'
+__status__ = 'Development'
+
+
+parser = ArgumentParser(
+ description='Runs a transform server for the given packages.',
+ usage='canari %s <transform package> [...]' % cmd_name(__name__)
+)
+
+parser.add_argument(
+ 'packages',
+ metavar='<package>',
+ help='The name of the transform packages you wish to host (e.g. mypkg.transforms).',
+ nargs='+'
+)
+
+parser.add_argument(
+ '--port',
+ metavar='<port>',
+ default=-1,
+ type=int,
+ help='The port the server will run on.'
+)
+
+parser.add_argument(
+ '--disable-ssl',
+ action='store_true',
+ default=False,
+ help='Any extra parameters that can be sent to the local transform.'
+)
+
+parser.add_argument(
+ '--enable-privileged',
+ action='store_true',
+ default=False,
+ help='DANGEROUS: permit TDS to run packages that require elevated privileges.'
+)
+
+parser.add_argument(
+ '--listen-on',
+ metavar='[address]',
+ default='',
+ help='The address of the interface to listen on.'
+)
+
+parser.add_argument(
+ '--cert',
+ metavar='[certificate]',
+ default='cert.pem',
+ help='The name of the certificate file used for the server in PEM format.'
+)
+
+
+def help():
+ parser.print_help()
+
+
+def description():
+ return parser.description
+
+
+def message(m, r):
+ """Write a MaltegoMessage to stdout and exit successfully"""
+
+ r.send_response(200)
+ r.send_header('Content-Type', 'text/xml')
+ r.send_header('Connection', 'close')
+ r.end_headers()
+
+ sio = StringIO()
+ m.entities
+ Message(MaltegoMessage(m)).write(sio)
+ v = sio.getvalue()
+ # Get rid of those nasty unicode 32 characters
+ r.wfile.write(sub(r'(&#\d{5};){2}', r'', v))
+
+
+def croak(error_msg, r):
+ """Throw an exception in the Maltego GUI containing error_msg."""
+
+ r.send_response(200)
+ r.send_header('Content-Type', 'text/xml')
+ r.send_header('Connection', 'close')
+ r.end_headers()
+
+ Message(
+ MaltegoMessage(
+ MaltegoTransformExceptionMessage(exceptions=MaltegoException(error_msg)
+ )
+ )
+ ).write(file=r.wfile)
+
+
+class MaltegoTransformRequestHandler(BaseHTTPRequestHandler):
+
+ protocol_version = 'HTTP/1.1'
+ server_version = 'Sploitego/1.0'
+ count = 0
+
+
+ def dotransform(self, t):
+
+ try:
+ if 'Content-Length' not in self.headers:
+ self.send_error(500, 'What?')
+ return
+
+ xml = fromstring(self.rfile.read(int(self.headers['Content-Length']))).find('MaltegoTransformRequestMessage')
+
+ e = xml.find('Entities/Entity')
+ etype = e.get('Type', '')
+
+ if t[1] and etype not in t[1]:
+ self.send_error(400, 'Unsupported input entity!')
+ return
+
+ value = e.find('Value').text or ''
+ fields = dict([(f.get('Name', ''), f.text) for f in xml.findall('Entities/Entity/AdditionalFields/Field')])
+ params = dict([(f.get('Name', ''), f.text) for f in xml.findall('TransformFields/Field')])
+ limits = xml.find('Limits').attrib
+
+ msg = t[0](
+ type(
+ 'MaltegoTransformRequestMessage',
+ (object,),
+ {
+ 'value' : value,
+ 'fields' : fields,
+ 'params' : params,
+ 'limits' : limits
+ }
+ )(),
+ MaltegoTransformResponseMessage()
+ )
+
+
+ if isinstance(msg, MaltegoTransformResponseMessage):
+ message(msg, self)
+ return
+ elif isinstance(msg, basestring):
+ raise MaltegoException(msg)
+ else:
+ raise MaltegoException('Could not resolve message type returned by transform.')
+
+ except MaltegoException, me:
+ croak(str(me), self)
+ except Exception, e:
+ croak(str(e), self)
+
+ def do_POST(self):
+ path = urlsplit(self.path or '/').path
+
+ if path not in self.server.transforms:
+ self.send_error(404, "Duh?")
+ else:
+ self.dotransform(self.server.transforms[path])
+
+ def do_GET(self):
+ self.count += 1
+ print self.count
+ path = urlsplit(self.path or '/').path
+ if path in self.server.transforms:
+ self.send_error(200, 'Yes')
+ return
+ self.send_error(404, 'No')
+
+
+class SecureMaltegoHTTPServer(HTTPServer):
+
+ def __init__(self, server_address=('', 8080), RequestHandlerClass=MaltegoTransformRequestHandler,
+ bind_and_activate=True, transforms={}, cert='cert.pem'):
+ HTTPServer.__init__(self, server_address, RequestHandlerClass, bind_and_activate=bind_and_activate)
+ self.socket = wrap_socket(self.socket, server_side=True, certfile=cert, cert_reqs=CERT_NONE)
+ self.transforms = transforms
+ self.server_name = 'Sploitego'
+
+
+class MaltegoHTTPServer(HTTPServer):
+
+ def __init__(self, server_address=('', 8080), RequestHandlerClass=MaltegoTransformRequestHandler,
+ bind_and_activate=True, transforms={}):
+ HTTPServer.__init__(self, server_address, RequestHandlerClass, bind_and_activate)
+ self.transforms = transforms
+
+
+class AsyncSecureMaltegoHTTPServer(ThreadingMixIn, SecureMaltegoHTTPServer):
+ pass
+
+
+class AsyncMaltegoHTTPServer(ThreadingMixIn, MaltegoHTTPServer):
+ pass
+
+
+
+def run(args):
+
+ opts = parser.parse_args(args)
+
+ fix_pypath()
+
+ if opts.port == -1:
+ opts.port = 443 if not opts.disable_ssl else 80
+
+ if name == 'posix' and geteuid() and (opts.port <= 1024 or opts.enable_privileged):
+ print ('You must run this server as root to continue...')
+ execvp('sudo', ['sudo'] + list(argv))
+
+ fix_binpath(config['default/path'])
+
+
+ transforms = {}
+
+ print ('Loading transform packages...')
+
+ try:
+ for p in opts.packages:
+
+ if not p.endswith('.transforms'):
+ p = ('%s.transforms' % p)
+
+ print ('Loading transform package %s' % p)
+
+ m = __import__(p, globals(), locals(), ['*'])
+
+ for t in m.__all__:
+
+ t = ('%s.%s' % (p, t))
+ m2 = import_transform(t)
+
+ if not hasattr(m2, 'dotransform'):
+ continue
+
+ if name == 'posix' and hasattr(m2.dotransform, 'privileged') and (geteuid() or not opts.enable_privileged):
+ continue
+
+ if hasattr(m2.dotransform, 'remote') and m2.dotransform.remote:
+ print ('Loading %s at /%s...' % (t, t))
+ if hasattr(m2.dotransform, 'inputs'):
+ inputs = [e[1]('').type for e in m2.dotransform.inputs]
+ inputs = inputs + [i.split('.')[-1] for i in inputs]
+ transforms['/%s' % t] = (m2.dotransform, inputs)
+ else:
+ transforms['/%s' % t] = (m2.dotransform, [])
+
+ except Exception, e:
+ print (str(e))
+ print ('Failed to load transforms... exiting')
+ exit(-1)
+
+ if not transforms:
+ print ("Couldn't find any remote transforms... you sure you got this right?")
+ exit(-1)
+
+ httpd = None
+
+ print ('Starting web server on %s:%s...' % (opts.listen_on, opts.port))
+ server_address = (opts.listen_on, opts.port)
+
+ if not opts.disable_ssl:
+ if not path.exists(opts.cert):
+ print ('The certificate file %s does not exist. Please create a PEM file...' % repr(opts.cert))
+ exit(-1)
+ print ('Making it secure (1337)...')
+ httpd = AsyncSecureMaltegoHTTPServer(server_address=server_address, transforms=transforms, cert=opts.cert)
+ else:
+ print ('Really? Over regular HTTP? What a shame...')
+ httpd = AsyncMaltegoHTTPServer(server_address=server_address, transforms=transforms)
+
+ try:
+ httpd.serve_forever()
+ except KeyboardInterrupt:
+ httpd.server_close()
\ No newline at end of file
--- /dev/null
+#!/usr/bin/env python
+
+from ..maltego.message import MaltegoException, MaltegoTransformResponseMessage
+from ..maltego.utils import onterminate, parseargs, croak, message
+from common import cmd_name, import_transform, fix_binpath
+
+from distutils.sysconfig import get_config_var
+from os import execvp, geteuid, name, path
+from argparse import ArgumentParser
+from traceback import format_exc
+from ..config import config
+from sys import argv
+
+
+__author__ = 'Nadeem Douba'
+__copyright__ = 'Copyright 2012, Canari Project'
+__credits__ = []
+
+__license__ = 'GPL'
+__version__ = '0.1'
+__maintainer__ = 'Nadeem Douba'
+__email__ = 'ndouba@gmail.com'
+__status__ = 'Development'
+
+
+parser = ArgumentParser(
+ description='Runs Canari local transforms in a terminal-friendly fashion.',
+ usage='canari %s <transform> [param1 ... paramN] <value> [field1=value1...#fieldN=valueN]' % cmd_name(__name__)
+)
+
+parser.add_argument(
+ 'transform',
+ metavar='<transform>',
+ help='The name of the transform you wish to run (e.g. canari.transforms.nmapfastscan).'
+)
+
+parser.add_argument(
+ 'value',
+ metavar='<value>',
+ help='The value of the input entity being passed into the local transform.'
+)
+
+parser.add_argument(
+ 'params',
+ metavar='[param1 ... paramN]',
+ help='Any extra parameters that can be sent to the local transform.'
+)
+
+parser.add_argument(
+ 'fields',
+ metavar='[field1=value1...#fieldN=valueN]',
+ help='The fields of the input entity being passed into the local transform.'
+)
+
+
+def help():
+ parser.print_help()
+
+
+def description():
+ return parser.description
+
+
+def run(args):
+
+ [transform, params, value, fields] = parseargs(['canari %s' % cmd_name(__name__)] + args)
+
+ m = None
+ pysudo = path.join(get_config_var('BINDIR'), 'pysudo')
+
+ fix_binpath(config['default/path'])
+ try:
+ m = import_transform(transform)
+
+ if name == 'posix' and hasattr(m.dotransform, 'privileged') and geteuid():
+# Keep it for another day
+# if platform == 'darwin':
+# execvp(
+# 'osascript',
+# ['osascript', '-e', 'do shell script "%s" with administrator privileges' % ' '.join(sys.argv)]
+# )
+# if sys.platform.startswith('linux') and path.exists("/usr/bin/gksudo"):
+# execvp('/usr/bin/gksudo', ['/usr/bin/gksudo'] + list(sys.argv))
+# else:
+ execvp(pysudo, [pysudo] + list(argv))
+ exit(-1)
+
+ if hasattr(m, 'onterminate'):
+ onterminate(m.onterminate)
+ else:
+ m.__setattr__('onterminate', lambda *args: exit(-1))
+
+ msg = m.dotransform(
+ type(
+ 'MaltegoTransformRequestMessage',
+ (object,),
+ {
+ 'value' : value,
+ 'fields' : fields,
+ 'params' : params
+ }
+ )(),
+ MaltegoTransformResponseMessage()
+ )
+
+ if isinstance(msg, MaltegoTransformResponseMessage):
+ message(msg)
+ elif isinstance(msg, basestring):
+ raise MaltegoException(msg)
+ else:
+ raise MaltegoException('Could not resolve message type returned by transform.')
+ except MaltegoException, me:
+ croak(str(me))
+ except ImportError:
+ e = format_exc()
+ croak(e)
+ except Exception:
+ e = format_exc()
+ croak(e)
+ except KeyboardInterrupt, be:
+ if m is not None:
+ m.onterminate()
\ No newline at end of file
--- /dev/null
+#!/usr/bin/env python
+
+from common import console_message, cmd_name, highlight, fix_pypath, fix_binpath
+from ..maltego.message import MaltegoTransformResponseMessage
+from ..config import config
+
+from code import InteractiveConsole
+from argparse import ArgumentParser
+from os import path, environ
+from atexit import register
+from re import sub, match
+import readline
+
+
+__author__ = 'Nadeem Douba'
+__copyright__ = 'Copyright 2012, Canari Project'
+__credits__ = []
+
+__license__ = 'GPL'
+__version__ = '0.1'
+__maintainer__ = 'Nadeem Douba'
+__email__ = 'ndouba@gmail.com'
+__status__ = 'Development'
+
+
+parser = ArgumentParser(
+ description='Creates a Canari debug shell for the specified transform package.',
+ usage='canari %s <package name>' % cmd_name(__name__)
+)
+
+parser.add_argument(
+ 'package',
+ metavar='<package name>',
+ help='The name of the canari package you wish to load local transform from for the Canari shell session.'
+)
+
+
+def help():
+ parser.print_help()
+
+
+def description():
+ return parser.description
+
+
+class MtgConsole(InteractiveConsole):
+
+ def __init__(self, package):
+ m = __import__(package, globals(), locals(), ['*'])
+ m.__dict__[MaltegoTransformResponseMessage.__name__] = MaltegoTransformResponseMessage
+ m.__dict__['message'] = console_message
+ InteractiveConsole.__init__(self, locals=m.__dict__)
+ self.init_history(path.expanduser('~/.mtgsh_history'))
+
+ def raw_input(self, prompt):
+ line = InteractiveConsole.raw_input(self, prompt=highlight('mtg> ', None, True))
+ r = match(r'([^(]+)\((.*?)\)', line)
+ if r is not None:
+ g = r.groups()
+ if g[0] in self.locals:
+ line = eval(sub(r'([^\(]+)\((.*)\)', r'self.docall("\1", \2)', line))
+ return line
+
+ def docall(self, *args, **kwargs):
+ return """message(%s.dotransform(
+ type(
+ 'MaltegoTransformRequestMessage',
+ (object,),
+ {
+ 'value' : %s,
+ 'fields' : %s,
+ 'params' : %s
+ }
+ )(),
+ MaltegoTransformResponseMessage()
+ ))""" % (args[0], repr(args[1]) if len(args) != 1 else repr(''), repr(kwargs), repr(args[2:]))
+
+ def init_history(self, histfile):
+ readline.parse_and_bind('tab: complete')
+ if hasattr(readline, "read_history_file"):
+ try:
+ readline.read_history_file(histfile)
+ except IOError:
+ pass
+ register(self.save_history, histfile)
+
+ def save_history(self, histfile):
+ readline.write_history_file(histfile)
+ print ('bye!')
+
+
+def run(args):
+
+ opts = parser.parse_args(args)
+
+ fix_binpath(config['default/path'])
+ fix_pypath()
+
+ if not opts.package.endswith('transforms'):
+ opts.package = '%s.transforms' % opts.package
+
+ mtgsh = MtgConsole(opts.package)
+ mtgsh.interact(highlight('Welcome to Canari.', 'green', True))
--- /dev/null
+#!/usr/bin/env python
+
+from common import detect_settings_dir, cmd_name, fix_pypath
+
+from os import sep, path, mkdir, listdir, unlink, rmdir
+from argparse import ArgumentParser
+
+
+__author__ = 'Nadeem Douba'
+__copyright__ = 'Copyright 2012, Canari Project'
+__credits__ = []
+
+__license__ = 'GPL'
+__version__ = '0.1'
+__maintainer__ = 'Nadeem Douba'
+__email__ = 'ndouba@gmail.com'
+__status__ = 'Development'
+
+
+# Argument parser
+parser = ArgumentParser(
+ description="Uninstalls and unconfigures canari transform packages in Maltego's UI",
+ usage='canari %s <package> [options]' % cmd_name(__name__)
+)
+
+parser.add_argument(
+ 'package',
+ metavar='<package>',
+ help='the name of the canari transforms package to uninstall.'
+)
+parser.add_argument(
+ '-s',
+ '--settings-dir',
+ metavar='[settings dir]',
+ default=detect_settings_dir,
+ help='the path to the Maltego settings directory (automatically detected if excluded)'
+)
+
+
+def help():
+ parser.print_help()
+
+
+def description():
+ return parser.description
+
+
+def uninstall_transform(module, spec, prefix):
+
+ installdir = sep.join([prefix, 'config', 'Maltego', 'TransformRepositories', 'Local'])
+
+ if not path.exists(installdir):
+ mkdir(installdir)
+
+ setsdir = sep.join([prefix, 'config', 'Maltego', 'TransformSets'])
+
+ for i,n in enumerate(spec.uuids):
+
+ print ('Uninstalling transform %s from %s...' % (n, module))
+
+ if spec.inputs[i][0] is not None:
+ setdir = sep.join([setsdir, spec.inputs[i][0]])
+ f = sep.join([setdir, n])
+ if path.exists(f):
+ unlink(f)
+ if path.exists(setdir) and not listdir(setdir):
+ rmdir(setdir)
+
+ tf = sep.join([installdir, '%s.transform' % n])
+ tsf = sep.join([installdir, '%s.transformsettings' % n])
+
+ if path.exists(tf):
+ unlink(tf)
+ if path.exists(tsf):
+ unlink(tsf)
+
+
+def parse_args(args):
+ args = parser.parse_args(args)
+ if args.settings_dir is detect_settings_dir:
+ args.settings_dir = detect_settings_dir()
+ return args
+
+
+def run(args):
+
+ opts = parse_args(args)
+
+ if not opts.package.endswith('.transforms'):
+ opts.package = '%s.transforms' % opts.package
+
+ fix_pypath()
+
+ m = __import__(opts.package, globals(), locals(), ['__all__'])
+
+ for t in m.__all__:
+ transform = '%s.%s' % (opts.package, t)
+ m2 = __import__(transform, globals(), locals(), ['dotransform'])
+ if hasattr(m2, 'dotransform') and hasattr(m2.dotransform, 'label'):
+ uninstall_transform(
+ m2.__name__,
+ m2.dotransform,
+ opts.settings_dir
+ )
--- /dev/null
+#!/usr/bin/env python
+
+from resource import conf
+
+from re import findall, search, match, split
+from ConfigParser import SafeConfigParser
+from os import environ, getcwd, sep
+from urlparse import urlsplit
+
+__author__ = 'Nadeem Douba'
+__copyright__ = 'Copyright 2012, Canari Project'
+__credits__ = []
+
+__license__ = 'GPL'
+__version__ = '0.1'
+__maintainer__ = 'Nadeem Douba'
+__email__ = 'ndouba@gmail.com'
+__status__ = 'Development'
+
+__all__ = [
+ 'CanariConfigParser',
+ 'config'
+]
+
+
+class CanariConfigParser(SafeConfigParser):
+
+ def _interpolate_environment_variables(self, value):
+ if isinstance(value, str):
+ evs = self._get_env_vars(value)
+ if evs:
+ for ev in evs:
+ s = '${%s}' % ev
+ value = value.replace(s, environ[ev])
+ return value
+
+ def _interpolate(self, section, option, value, d):
+ if isinstance(value, str):
+ value = self._interpolate_environment_variables(value)
+ elif isinstance(value, dict):
+ for i in value:
+ value[i] = self._interpolate_environment_variables(value[i])
+ else:
+ for i in range(0, len(value)):
+ value[i] = self._interpolate_environment_variables(value[i])
+ value = SafeConfigParser._interpolate(self, section, option, value, d)
+ return value
+
+ def _get_env_vars(self, value):
+ return findall(r'\${(.+?)}', value)
+
+ def __iadd__(self, other):
+ self.add_section(other)
+ return self
+
+ def __isub__(self, other):
+ self.remove_section(other)
+ return self
+
+ def __getitem__(self, item):
+ section,option = item.split('/')
+ value = self.get(section, option)
+ if isinstance(value, basestring):
+ if value.startswith('module:'):
+ r = urlsplit(value.replace('module', 'http'))
+ try:
+ v = r.path.lstrip('/')
+ m = __import__(r.netloc, globals(), locals(), [v])
+ value = m.__dict__[v]
+ except ImportError:
+ pass
+ elif match(r'^\d+$', value) is not None:
+ value = int(value)
+ elif match(r'^\d+\.\d+$', value) is not None:
+ value = float(value)
+ elif search(r'\s*(?<=[^\\]),+\s*', value) is not None:
+ l = split(r'\s*(?<=[^\\]),+\s*', value)
+ value = []
+ for v in l:
+ if match(r'^\d+$', v) is not None:
+ v = int(v)
+ elif match(r'^\d+\.\d+$', v) is not None:
+ v = float(v)
+ else:
+ v = v.replace(r'\,', ',')
+ value.append(v)
+ else:
+ value = value.replace(r'\,', ',')
+ return value
+
+ def __setitem__(self, key, value):
+ section,option = key.split('/')
+ if not self.has_section(section):
+ self.add_section(section)
+ self.set(section, option, value)
+
+
+config = CanariConfigParser()
+
+dconf = sep.join([ conf ])
+lconf = sep.join([ getcwd(), 'canari.conf' ])
+
+config.read([ dconf , lconf ])
+config.read(config['default/configs'])
\ No newline at end of file
--- /dev/null
+"""
+@version: 0.96(2010-08-29)
+
+@note:
+ABOUT EASYGUI
+
+EasyGui provides an easy-to-use interface for simple GUI interaction
+with a user. It does not require the programmer to know anything about
+tkinter, frames, widgets, callbacks or lambda. All GUI interactions are
+invoked by simple function calls that return results.
+
+@note:
+WARNING about using EasyGui with IDLE
+
+You may encounter problems using IDLE to run programs that use EasyGui. Try it
+and find out. EasyGui is a collection of Tkinter routines that run their own
+event loops. IDLE is also a Tkinter application, with its own event loop. The
+two may conflict, with unpredictable results. If you find that you have
+problems, try running your EasyGui program outside of IDLE.
+
+Note that EasyGui requires Tk release 8.0 or greater.
+
+@note:
+LICENSE INFORMATION
+
+EasyGui version 0.96
+
+Copyright (c) 2010, Stephen Raymond Ferg
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+ 1. Redistributions of source code must retain the above copyright notice,
+ this list of conditions and the following disclaimer.
+
+ 2. Redistributions in binary form must reproduce the above copyright notice,
+ this list of conditions and the following disclaimer in the documentation and/or
+ other materials provided with the distribution.
+
+ 3. The name of the author may not be used to endorse or promote products derived
+ from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
+IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+@note:
+ABOUT THE EASYGUI LICENSE
+
+This license is what is generally known as the "modified BSD license",
+aka "revised BSD", "new BSD", "3-clause BSD".
+See http://www.opensource.org/licenses/bsd-license.php
+
+This license is GPL-compatible.
+See http://en.wikipedia.org/wiki/License_compatibility
+See http://www.gnu.org/licenses/license-list.html#GPLCompatibleLicenses
+
+The BSD License is less restrictive than GPL.
+It allows software released under the license to be incorporated into proprietary products.
+Works based on the software may be released under a proprietary license or as closed source software.
+http://en.wikipedia.org/wiki/BSD_licenses#3-clause_license_.28.22New_BSD_License.22.29
+
+"""
+egversion = __doc__.split()[1]
+
+__all__ = ['ynbox'
+ , 'ccbox'
+ , 'boolbox'
+ , 'indexbox'
+ , 'msgbox'
+ , 'buttonbox'
+ , 'integerbox'
+ , 'multenterbox'
+ , 'enterbox'
+ , 'exceptionbox'
+ , 'choicebox'
+ , 'codebox'
+ , 'textbox'
+ , 'diropenbox'
+ , 'fileopenbox'
+ , 'filesavebox'
+ , 'passwordbox'
+ , 'multpasswordbox'
+ , 'multchoicebox'
+ , 'abouteasygui'
+ , 'egversion'
+ , 'egdemo'
+ , 'EgStore'
+ ]
+
+import sys, os
+import string
+import pickle
+import traceback
+
+
+#--------------------------------------------------
+# check python version and take appropriate action
+#--------------------------------------------------
+"""
+From the python documentation:
+
+sys.hexversion contains the version number encoded as a single integer. This is
+guaranteed to increase with each version, including proper support for non-
+production releases. For example, to test that the Python interpreter is at
+least version 1.5.2, use:
+
+if sys.hexversion >= 0x010502F0:
+ # use some advanced feature
+ ...
+else:
+ # use an alternative implementation or warn the user
+ ...
+"""
+
+
+if sys.hexversion >= 0x020600F0:
+ runningPython26 = True
+else:
+ runningPython26 = False
+
+if sys.hexversion >= 0x030000F0:
+ runningPython3 = True
+else:
+ runningPython3 = False
+
+try:
+ from PIL import Image as PILImage
+ from PIL import ImageTk as PILImageTk
+ PILisLoaded = True
+except:
+ PILisLoaded = False
+
+
+if runningPython3:
+ from tkinter import *
+ import tkinter.filedialog as tk_FileDialog
+ from io import StringIO
+else:
+ from Tkinter import *
+ import tkFileDialog as tk_FileDialog
+ from StringIO import StringIO
+
+def write(*args):
+ args = [str(arg) for arg in args]
+ args = " ".join(args)
+ sys.stdout.write(args)
+
+def writeln(*args):
+ write(*args)
+ sys.stdout.write("\n")
+
+say = writeln
+
+
+if TkVersion < 8.0 :
+ stars = "*"*75
+ writeln("""\n\n\n""" + stars + """
+You are running Tk version: """ + str(TkVersion) + """
+You must be using Tk version 8.0 or greater to use EasyGui.
+Terminating.
+""" + stars + """\n\n\n""")
+ sys.exit(0)
+
+def dq(s):
+ return '"%s"' % s
+
+rootWindowPosition = "+300+200"
+
+PROPORTIONAL_FONT_FAMILY = ("MS", "Sans", "Serif")
+MONOSPACE_FONT_FAMILY = ("Courier")
+
+PROPORTIONAL_FONT_SIZE = 10
+MONOSPACE_FONT_SIZE = 9 #a little smaller, because it it more legible at a smaller size
+TEXT_ENTRY_FONT_SIZE = 12 # a little larger makes it easier to see
+
+#STANDARD_SELECTION_EVENTS = ["Return", "Button-1"]
+STANDARD_SELECTION_EVENTS = ["Return", "Button-1", "space"]
+
+# Initialize some global variables that will be reset later
+__choiceboxMultipleSelect = None
+__widgetTexts = None
+__replyButtonText = None
+__choiceboxResults = None
+__firstWidget = None
+__enterboxText = None
+__enterboxDefaultText=""
+__multenterboxText = ""
+choiceboxChoices = None
+choiceboxWidget = None
+entryWidget = None
+boxRoot = None
+ImageErrorMsg = (
+ "\n\n---------------------------------------------\n"
+ "Error: %s\n%s")
+#-------------------------------------------------------------------
+# various boxes built on top of the basic buttonbox
+#-----------------------------------------------------------------------
+
+#-----------------------------------------------------------------------
+# ynbox
+#-----------------------------------------------------------------------
+def ynbox(msg="Shall I continue?"
+ , title=" "
+ , choices=("Yes", "No")
+ , image=None
+ ):
+ """
+ Display a msgbox with choices of Yes and No.
+
+ The default is "Yes".
+
+ The returned value is calculated this way::
+ if the first choice ("Yes") is chosen, or if the dialog is cancelled:
+ return 1
+ else:
+ return 0
+
+ If invoked without a msg argument, displays a generic request for a confirmation
+ that the user wishes to continue. So it can be used this way::
+ if ynbox(): pass # continue
+ else: sys.exit(0) # exit the program
+
+ @arg msg: the msg to be displayed.
+ @arg title: the window title
+ @arg choices: a list or tuple of the choices to be displayed
+ """
+ return boolbox(msg, title, choices, image=image)
+
+
+#-----------------------------------------------------------------------
+# ccbox
+#-----------------------------------------------------------------------
+def ccbox(msg="Shall I continue?"
+ , title=" "
+ , choices=("Continue", "Cancel")
+ , image=None
+ ):
+ """
+ Display a msgbox with choices of Continue and Cancel.
+
+ The default is "Continue".
+
+ The returned value is calculated this way::
+ if the first choice ("Continue") is chosen, or if the dialog is cancelled:
+ return 1
+ else:
+ return 0
+
+ If invoked without a msg argument, displays a generic request for a confirmation
+ that the user wishes to continue. So it can be used this way::
+
+ if ccbox():
+ pass # continue
+ else:
+ sys.exit(0) # exit the program
+
+ @arg msg: the msg to be displayed.
+ @arg title: the window title
+ @arg choices: a list or tuple of the choices to be displayed
+ """
+ return boolbox(msg, title, choices, image=image)
+
+
+#-----------------------------------------------------------------------
+# boolbox
+#-----------------------------------------------------------------------
+def boolbox(msg="Shall I continue?"
+ , title=" "
+ , choices=("Yes","No")
+ , image=None
+ ):
+ """
+ Display a boolean msgbox.
+
+ The default is the first choice.
+
+ The returned value is calculated this way::
+ if the first choice is chosen, or if the dialog is cancelled:
+ returns 1
+ else:
+ returns 0
+ """
+ reply = buttonbox(msg=msg, choices=choices, title=title, image=image)
+ if reply == choices[0]: return 1
+ else: return 0
+
+
+#-----------------------------------------------------------------------
+# indexbox
+#-----------------------------------------------------------------------
+def indexbox(msg="Shall I continue?"
+ , title=" "
+ , choices=("Yes","No")
+ , image=None
+ ):
+ """
+ Display a buttonbox with the specified choices.
+ Return the index of the choice selected.
+ """
+ reply = buttonbox(msg=msg, choices=choices, title=title, image=image)
+ index = -1
+ for choice in choices:
+ index = index + 1
+ if reply == choice: return index
+ raise AssertionError(
+ "There is a program logic error in the EasyGui code for indexbox.")
+
+
+#-----------------------------------------------------------------------
+# msgbox
+#-----------------------------------------------------------------------
+def msgbox(msg="(Your message goes here)", title=" ", ok_button="OK",image=None,root=None):
+ """
+ Display a messagebox
+ """
+ if type(ok_button) != type("OK"):
+ raise AssertionError("The 'ok_button' argument to msgbox must be a string.")
+
+ return buttonbox(msg=msg, title=title, choices=[ok_button], image=image,root=root)
+
+
+#-------------------------------------------------------------------
+# buttonbox
+#-------------------------------------------------------------------
+def buttonbox(msg="",title=" "
+ ,choices=("Button1", "Button2", "Button3")
+ , image=None
+ , root=None
+ ):
+ """
+ Display a msg, a title, and a set of buttons.
+ The buttons are defined by the members of the choices list.
+ Return the text of the button that the user selected.
+
+ @arg msg: the msg to be displayed.
+ @arg title: the window title
+ @arg choices: a list or tuple of the choices to be displayed
+ """
+ if sys.platform == 'darwin':
+ from subprocess import Popen
+ Tk().destroy()
+ Popen(['osascript', '-e', 'tell application "Python" to activate'])
+
+ global boxRoot, __replyButtonText, __widgetTexts, buttonsFrame
+
+
+ # Initialize __replyButtonText to the first choice.
+ # This is what will be used if the window is closed by the close button.
+ __replyButtonText = choices[0]
+
+ if root:
+ root.withdraw()
+ boxRoot = Toplevel(master=root)
+ boxRoot.withdraw()
+ else:
+ boxRoot = Tk()
+ boxRoot.withdraw()
+
+ boxRoot.protocol('WM_DELETE_WINDOW', denyWindowManagerClose )
+ boxRoot.title(title)
+ boxRoot.iconname('Dialog')
+ boxRoot.geometry(rootWindowPosition)
+ boxRoot.minsize(400, 100)
+
+ # ------------- define the messageFrame ---------------------------------
+ messageFrame = Frame(master=boxRoot)
+ messageFrame.pack(side=TOP, fill=BOTH)
+
+ # ------------- define the imageFrame ---------------------------------
+ tk_Image = None
+ if image:
+ imageFilename = os.path.normpath(image)
+ junk,ext = os.path.splitext(imageFilename)
+
+ if os.path.exists(imageFilename):
+ if ext.lower() in [".gif", ".pgm", ".ppm"]:
+ tk_Image = PhotoImage(master=boxRoot, file=imageFilename)
+ else:
+ if PILisLoaded:
+ try:
+ pil_Image = PILImage.open(imageFilename)
+ tk_Image = PILImageTk.PhotoImage(pil_Image, master=boxRoot)
+ except:
+ msg += ImageErrorMsg % (imageFilename,
+ "\nThe Python Imaging Library (PIL) could not convert this file to a displayable image."
+ "\n\nPIL reports:\n" + exception_format())
+
+ else: # PIL is not loaded
+ msg += ImageErrorMsg % (imageFilename,
+ "\nI could not import the Python Imaging Library (PIL) to display the image.\n\n"
+ "You may need to install PIL\n"
+ "(http://www.pythonware.com/products/pil/)\n"
+ "to display " + ext + " image files.")
+
+ else:
+ msg += ImageErrorMsg % (imageFilename, "\nImage file not found.")
+
+ if tk_Image:
+ imageFrame = Frame(master=boxRoot)
+ imageFrame.pack(side=TOP, fill=BOTH)
+ label = Label(imageFrame,image=tk_Image)
+ label.image = tk_Image # keep a reference!
+ label.pack(side=TOP, expand=YES, fill=X, padx='1m', pady='1m')
+
+ # ------------- define the buttonsFrame ---------------------------------
+ buttonsFrame = Frame(master=boxRoot)
+ buttonsFrame.pack(side=TOP, fill=BOTH)
+
+ # -------------------- place the widgets in the frames -----------------------
+ messageWidget = Message(messageFrame, text=msg, width=400)
+ messageWidget.configure(font=(PROPORTIONAL_FONT_FAMILY,PROPORTIONAL_FONT_SIZE))
+ messageWidget.pack(side=TOP, expand=YES, fill=X, padx='3m', pady='3m')
+
+ __put_buttons_in_buttonframe(choices)
+
+ # -------------- the action begins -----------
+ # put the focus on the first button
+ __firstWidget.focus_force()
+
+ boxRoot.deiconify()
+ boxRoot.mainloop()
+ boxRoot.destroy()
+ if root: root.deiconify()
+ return __replyButtonText
+
+
+#-------------------------------------------------------------------
+# integerbox
+#-------------------------------------------------------------------
+def integerbox(msg=""
+ , title=" "
+ , default=""
+ , lowerbound=0
+ , upperbound=99
+ , image = None
+ , root = None
+ , **invalidKeywordArguments
+ ):
+ """
+ Show a box in which a user can enter an integer.
+
+ In addition to arguments for msg and title, this function accepts
+ integer arguments for "default", "lowerbound", and "upperbound".
+
+ The default argument may be None.
+
+ When the user enters some text, the text is checked to verify that it
+ can be converted to an integer between the lowerbound and upperbound.
+
+ If it can be, the integer (not the text) is returned.
+
+ If it cannot, then an error msg is displayed, and the integerbox is
+ redisplayed.
+
+ If the user cancels the operation, None is returned.
+
+ NOTE that the "argLowerBound" and "argUpperBound" arguments are no longer
+ supported. They have been replaced by "upperbound" and "lowerbound".
+ """
+ if sys.platform == 'darwin':
+ from subprocess import Popen
+ Tk().destroy()
+ Popen(['osascript', '-e', 'tell application "Python" to activate'])
+ if "argLowerBound" in invalidKeywordArguments:
+ raise AssertionError(
+ "\nintegerbox no longer supports the 'argLowerBound' argument.\n"
+ + "Use 'lowerbound' instead.\n\n")
+ if "argUpperBound" in invalidKeywordArguments:
+ raise AssertionError(
+ "\nintegerbox no longer supports the 'argUpperBound' argument.\n"
+ + "Use 'upperbound' instead.\n\n")
+
+ if default != "":
+ if type(default) != type(1):
+ raise AssertionError(
+ "integerbox received a non-integer value for "
+ + "default of " + dq(str(default)) , "Error")
+
+ if type(lowerbound) != type(1):
+ raise AssertionError(
+ "integerbox received a non-integer value for "
+ + "lowerbound of " + dq(str(lowerbound)) , "Error")
+
+ if type(upperbound) != type(1):
+ raise AssertionError(
+ "integerbox received a non-integer value for "
+ + "upperbound of " + dq(str(upperbound)) , "Error")
+
+ if msg == "":
+ msg = ("Enter an integer between " + str(lowerbound)
+ + " and "
+ + str(upperbound)
+ )
+
+ while 1:
+ reply = enterbox(msg, title, str(default), image=image, root=root)
+ if reply == None: return None
+
+ try:
+ reply = int(reply)
+ except:
+ msgbox ("The value that you entered:\n\t%s\nis not an integer." % dq(str(reply))
+ , "Error")
+ continue
+
+ if reply < lowerbound:
+ msgbox ("The value that you entered is less than the lower bound of "
+ + str(lowerbound) + ".", "Error")
+ continue
+
+ if reply > upperbound:
+ msgbox ("The value that you entered is greater than the upper bound of "
+ + str(upperbound) + ".", "Error")
+ continue
+
+ # reply has passed all validation checks.
+ # It is an integer between the specified bounds.
+ return reply
+
+#-------------------------------------------------------------------
+# multenterbox
+#-------------------------------------------------------------------
+def multenterbox(msg="Fill in values for the fields."
+ , title=" "
+ , fields=()
+ , values=()
+ ):
+ r"""
+ Show screen with multiple data entry fields.
+
+ If there are fewer values than names, the list of values is padded with
+ empty strings until the number of values is the same as the number of names.
+
+ If there are more values than names, the list of values
+ is truncated so that there are as many values as names.
+
+ Returns a list of the values of the fields,
+ or None if the user cancels the operation.
+
+ Here is some example code, that shows how values returned from
+ multenterbox can be checked for validity before they are accepted::
+ ----------------------------------------------------------------------
+ msg = "Enter your personal information"
+ title = "Credit Card Application"
+ fieldNames = ["Name","Street Address","City","State","ZipCode"]
+ fieldValues = [] # we start with blanks for the values
+ fieldValues = multenterbox(msg,title, fieldNames)
+
+ # make sure that none of the fields was left blank
+ while 1:
+ if fieldValues == None: break
+ errmsg = ""
+ for i in range(len(fieldNames)):
+ if fieldValues[i].strip() == "":
+ errmsg += ('"%s" is a required field.\n\n' % fieldNames[i])
+ if errmsg == "":
+ break # no problems found
+ fieldValues = multenterbox(errmsg, title, fieldNames, fieldValues)
+
+ writeln("Reply was: %s" % str(fieldValues))
+ ----------------------------------------------------------------------
+
+ @arg msg: the msg to be displayed.
+ @arg title: the window title
+ @arg fields: a list of fieldnames.
+ @arg values: a list of field values
+ """
+ return __multfillablebox(msg,title,fields,values,None)
+
+
+#-----------------------------------------------------------------------
+# multpasswordbox
+#-----------------------------------------------------------------------
+def multpasswordbox(msg="Fill in values for the fields."
+ , title=" "
+ , fields=tuple()
+ ,values=tuple()
+ ):
+ r"""
+ Same interface as multenterbox. But in multpassword box,
+ the last of the fields is assumed to be a password, and
+ is masked with asterisks.
+
+ Example
+ =======
+
+ Here is some example code, that shows how values returned from
+ multpasswordbox can be checked for validity before they are accepted::
+ msg = "Enter logon information"
+ title = "Demo of multpasswordbox"
+ fieldNames = ["Server ID", "User ID", "Password"]
+ fieldValues = [] # we start with blanks for the values
+ fieldValues = multpasswordbox(msg,title, fieldNames)
+
+ # make sure that none of the fields was left blank
+ while 1:
+ if fieldValues == None: break
+ errmsg = ""
+ for i in range(len(fieldNames)):
+ if fieldValues[i].strip() == "":
+ errmsg = errmsg + ('"%s" is a required field.\n\n' % fieldNames[i])
+ if errmsg == "": break # no problems found
+ fieldValues = multpasswordbox(errmsg, title, fieldNames, fieldValues)
+
+ writeln("Reply was: %s" % str(fieldValues))
+ """
+ return __multfillablebox(msg,title,fields,values,"*")
+
+def bindArrows(widget):
+ widget.bind("<Down>", tabRight)
+ widget.bind("<Up>" , tabLeft)
+
+ widget.bind("<Right>",tabRight)
+ widget.bind("<Left>" , tabLeft)
+
+def tabRight(event):
+ boxRoot.event_generate("<Tab>")
+
+def tabLeft(event):
+ boxRoot.event_generate("<Shift-Tab>")
+
+#-----------------------------------------------------------------------
+# __multfillablebox
+#-----------------------------------------------------------------------
+def __multfillablebox(msg="Fill in values for the fields."
+ , title=" "
+ , fields=()
+ , values=()
+ , mask = None
+ ):
+ if sys.platform == 'darwin':
+ from subprocess import Popen
+ Tk().destroy()
+ Popen(['osascript', '-e', 'tell application "Python" to activate'])
+
+ global boxRoot, __multenterboxText, __multenterboxDefaultText, cancelButton, entryWidget, okButton
+
+ choices = ["OK", "Cancel"]
+ if len(fields) == 0: return None
+
+ fields = list(fields[:]) # convert possible tuples to a list
+ values = list(values[:]) # convert possible tuples to a list
+
+ if len(values) == len(fields): pass
+ elif len(values) > len(fields):
+ fields = fields[0:len(values)]
+ else:
+ while len(values) < len(fields):
+ values.append("")
+
+ boxRoot = Tk()
+
+ boxRoot.protocol('WM_DELETE_WINDOW', denyWindowManagerClose )
+ boxRoot.title(title)
+ boxRoot.iconname('Dialog')
+ boxRoot.geometry(rootWindowPosition)
+ boxRoot.bind("<Escape>", __multenterboxCancel)
+
+ # -------------------- put subframes in the boxRoot --------------------
+ messageFrame = Frame(master=boxRoot)
+ messageFrame.pack(side=TOP, fill=BOTH)
+
+ #-------------------- the msg widget ----------------------------
+ messageWidget = Message(messageFrame, width="4.5i", text=msg)
+ messageWidget.configure(font=(PROPORTIONAL_FONT_FAMILY,PROPORTIONAL_FONT_SIZE))
+ messageWidget.pack(side=RIGHT, expand=1, fill=BOTH, padx='3m', pady='3m')
+
+ global entryWidgets
+ entryWidgets = []
+
+ lastWidgetIndex = len(fields) - 1
+
+ for widgetIndex in range(len(fields)):
+ argFieldName = fields[widgetIndex]
+ argFieldValue = values[widgetIndex]
+ entryFrame = Frame(master=boxRoot)
+ entryFrame.pack(side=TOP, fill=BOTH)
+
+ # --------- entryWidget ----------------------------------------------
+ labelWidget = Label(entryFrame, text=argFieldName)
+ labelWidget.pack(side=LEFT)
+
+ entryWidget = Entry(entryFrame, width=40,highlightthickness=2)
+ entryWidgets.append(entryWidget)
+ entryWidget.configure(font=(PROPORTIONAL_FONT_FAMILY,TEXT_ENTRY_FONT_SIZE))
+ entryWidget.pack(side=RIGHT, padx="3m")
+
+ bindArrows(entryWidget)
+
+ entryWidget.bind("<Return>", __multenterboxGetText)
+ entryWidget.bind("<Escape>", __multenterboxCancel)
+
+ # for the last entryWidget, if this is a multpasswordbox,
+ # show the contents as just asterisks
+ if widgetIndex == lastWidgetIndex:
+ if mask:
+ entryWidgets[widgetIndex].configure(show=mask)
+
+ # put text into the entryWidget
+ entryWidgets[widgetIndex].insert(0,argFieldValue)
+ widgetIndex += 1
+
+ # ------------------ ok button -------------------------------
+ buttonsFrame = Frame(master=boxRoot)
+ buttonsFrame.pack(side=BOTTOM, fill=BOTH)
+
+ okButton = Button(buttonsFrame, takefocus=1, text="OK")
+ bindArrows(okButton)
+ okButton.pack(expand=1, side=LEFT, padx='3m', pady='3m', ipadx='2m', ipady='1m')
+
+ # for the commandButton, bind activation events to the activation event handler
+ commandButton = okButton
+ handler = __multenterboxGetText
+ for selectionEvent in STANDARD_SELECTION_EVENTS:
+ commandButton.bind("<%s>" % selectionEvent, handler)
+
+
+ # ------------------ cancel button -------------------------------
+ cancelButton = Button(buttonsFrame, takefocus=1, text="Cancel")
+ bindArrows(cancelButton)
+ cancelButton.pack(expand=1, side=RIGHT, padx='3m', pady='3m', ipadx='2m', ipady='1m')
+
+ # for the commandButton, bind activation events to the activation event handler
+ commandButton = cancelButton
+ handler = __multenterboxCancel
+ for selectionEvent in STANDARD_SELECTION_EVENTS:
+ commandButton.bind("<%s>" % selectionEvent, handler)
+
+
+ # ------------------- time for action! -----------------
+ entryWidgets[0].focus_force() # put the focus on the entryWidget
+ boxRoot.mainloop() # run it!
+
+ # -------- after the run has completed ----------------------------------
+ boxRoot.destroy() # button_click didn't destroy boxRoot, so we do it now
+ return __multenterboxText
+
+
+#-----------------------------------------------------------------------
+# __multenterboxGetText
+#-----------------------------------------------------------------------
+def __multenterboxGetText(event):
+ global __multenterboxText
+
+ __multenterboxText = []
+ for entryWidget in entryWidgets:
+ __multenterboxText.append(entryWidget.get())
+ boxRoot.quit()
+
+
+def __multenterboxCancel(event):
+ global __multenterboxText
+ __multenterboxText = None
+ boxRoot.quit()
+
+
+#-------------------------------------------------------------------
+# enterbox
+#-------------------------------------------------------------------
+def enterbox(msg="Enter something."
+ , title=" "
+ , default=""
+ , strip=True
+ , image=None
+ , root=None
+ ):
+ """
+ Show a box in which a user can enter some text.
+
+ You may optionally specify some default text, which will appear in the
+ enterbox when it is displayed.
+
+ Returns the text that the user entered, or None if he cancels the operation.
+
+ By default, enterbox strips its result (i.e. removes leading and trailing
+ whitespace). (If you want it not to strip, use keyword argument: strip=False.)
+ This makes it easier to test the results of the call::
+
+ reply = enterbox(....)
+ if reply:
+ ...
+ else:
+ ...
+ """
+ result = __fillablebox(msg, title, default=default, mask=None,image=image,root=root)
+ if result and strip:
+ result = result.strip()
+ return result
+
+
+def passwordbox(msg="Enter your password."
+ , title=" "
+ , default=""
+ , image=None
+ , root=None
+ ):
+ """
+ Show a box in which a user can enter a password.
+ The text is masked with asterisks, so the password is not displayed.
+ Returns the text that the user entered, or None if he cancels the operation.
+ """
+ return __fillablebox(msg, title, default, mask="*",image=image,root=root)
+
+
+def __fillablebox(msg
+ , title=""
+ , default=""
+ , mask=None
+ , image=None
+ , root=None
+ ):
+ """
+ Show a box in which a user can enter some text.
+ You may optionally specify some default text, which will appear in the
+ enterbox when it is displayed.
+ Returns the text that the user entered, or None if he cancels the operation.
+ """
+ if sys.platform == 'darwin':
+ from subprocess import Popen
+ Tk().destroy()
+ Popen(['osascript', '-e', 'tell application "Python" to activate'])
+
+ global boxRoot, __enterboxText, __enterboxDefaultText
+ global cancelButton, entryWidget, okButton
+
+ if title == None: title == ""
+ if default == None: default = ""
+ __enterboxDefaultText = default
+ __enterboxText = __enterboxDefaultText
+
+ if root:
+ root.withdraw()
+ boxRoot = Toplevel(master=root)
+ boxRoot.withdraw()
+ else:
+ boxRoot = Tk()
+ boxRoot.withdraw()
+
+ boxRoot.protocol('WM_DELETE_WINDOW', denyWindowManagerClose )
+ boxRoot.title(title)
+ boxRoot.iconname('Dialog')
+ boxRoot.geometry(rootWindowPosition)
+ boxRoot.bind("<Escape>", __enterboxCancel)
+
+ # ------------- define the messageFrame ---------------------------------
+ messageFrame = Frame(master=boxRoot)
+ messageFrame.pack(side=TOP, fill=BOTH)
+
+ # ------------- define the imageFrame ---------------------------------
+ tk_Image = None
+ if image:
+ imageFilename = os.path.normpath(image)
+ junk,ext = os.path.splitext(imageFilename)
+
+ if os.path.exists(imageFilename):
+ if ext.lower() in [".gif", ".pgm", ".ppm"]:
+ tk_Image = PhotoImage(master=boxRoot, file=imageFilename)
+ else:
+ if PILisLoaded:
+ try:
+ pil_Image = PILImage.open(imageFilename)
+ tk_Image = PILImageTk.PhotoImage(pil_Image, master=boxRoot)
+ except:
+ msg += ImageErrorMsg % (imageFilename,
+ "\nThe Python Imaging Library (PIL) could not convert this file to a displayable image."
+ "\n\nPIL reports:\n" + exception_format())
+
+ else: # PIL is not loaded
+ msg += ImageErrorMsg % (imageFilename,
+ "\nI could not import the Python Imaging Library (PIL) to display the image.\n\n"
+ "You may need to install PIL\n"
+ "(http://www.pythonware.com/products/pil/)\n"
+ "to display " + ext + " image files.")
+
+ else:
+ msg += ImageErrorMsg % (imageFilename, "\nImage file not found.")
+
+ if tk_Image:
+ imageFrame = Frame(master=boxRoot)
+ imageFrame.pack(side=TOP, fill=BOTH)
+ label = Label(imageFrame,image=tk_Image)
+ label.image = tk_Image # keep a reference!
+ label.pack(side=TOP, expand=YES, fill=X, padx='1m', pady='1m')
+
+ # ------------- define the buttonsFrame ---------------------------------
+ buttonsFrame = Frame(master=boxRoot)
+ buttonsFrame.pack(side=TOP, fill=BOTH)
+
+
+ # ------------- define the entryFrame ---------------------------------
+ entryFrame = Frame(master=boxRoot)
+ entryFrame.pack(side=TOP, fill=BOTH)
+
+ # ------------- define the buttonsFrame ---------------------------------
+ buttonsFrame = Frame(master=boxRoot)
+ buttonsFrame.pack(side=TOP, fill=BOTH)
+
+ #-------------------- the msg widget ----------------------------
+ messageWidget = Message(messageFrame, width="4.5i", text=msg)
+ messageWidget.configure(font=(PROPORTIONAL_FONT_FAMILY,PROPORTIONAL_FONT_SIZE))
+ messageWidget.pack(side=RIGHT, expand=1, fill=BOTH, padx='3m', pady='3m')
+
+ # --------- entryWidget ----------------------------------------------
+ entryWidget = Entry(entryFrame, width=40)
+ bindArrows(entryWidget)
+ entryWidget.configure(font=(PROPORTIONAL_FONT_FAMILY,TEXT_ENTRY_FONT_SIZE))
+ if mask:
+ entryWidget.configure(show=mask)
+ entryWidget.pack(side=LEFT, padx="3m")
+ entryWidget.bind("<Return>", __enterboxGetText)
+ entryWidget.bind("<Escape>", __enterboxCancel)
+ # put text into the entryWidget
+ entryWidget.insert(0,__enterboxDefaultText)
+
+ # ------------------ ok button -------------------------------
+ okButton = Button(buttonsFrame, takefocus=1, text="OK")
+ bindArrows(okButton)
+ okButton.pack(expand=1, side=LEFT, padx='3m', pady='3m', ipadx='2m', ipady='1m')
+
+ # for the commandButton, bind activation events to the activation event handler
+ commandButton = okButton
+ handler = __enterboxGetText
+ for selectionEvent in STANDARD_SELECTION_EVENTS:
+ commandButton.bind("<%s>" % selectionEvent, handler)
+
+
+ # ------------------ cancel button -------------------------------
+ cancelButton = Button(buttonsFrame, takefocus=1, text="Cancel")
+ bindArrows(cancelButton)
+ cancelButton.pack(expand=1, side=RIGHT, padx='3m', pady='3m', ipadx='2m', ipady='1m')
+
+ # for the commandButton, bind activation events to the activation event handler
+ commandButton = cancelButton
+ handler = __enterboxCancel
+ for selectionEvent in STANDARD_SELECTION_EVENTS:
+ commandButton.bind("<%s>" % selectionEvent, handler)
+
+ # ------------------- time for action! -----------------
+ entryWidget.focus_force() # put the focus on the entryWidget
+ boxRoot.deiconify()
+ boxRoot.mainloop() # run it!
+
+ # -------- after the run has completed ----------------------------------
+ if root: root.deiconify()
+ boxRoot.destroy() # button_click didn't destroy boxRoot, so we do it now
+ return __enterboxText
+
+
+def __enterboxGetText(event):
+ global __enterboxText
+
+ __enterboxText = entryWidget.get()
+ boxRoot.quit()
+
+
+def __enterboxRestore(event):
+ global entryWidget
+
+ entryWidget.delete(0,len(entryWidget.get()))
+ entryWidget.insert(0, __enterboxDefaultText)
+
+
+def __enterboxCancel(event):
+ global __enterboxText
+
+ __enterboxText = None
+ boxRoot.quit()
+
+def denyWindowManagerClose():
+ """ don't allow WindowManager close
+ """
+ x = Tk()
+ x.withdraw()
+ x.bell()
+ x.destroy()
+
+
+
+#-------------------------------------------------------------------
+# multchoicebox
+#-------------------------------------------------------------------
+def multchoicebox(msg="Pick as many items as you like."
+ , title=" "
+ , choices=()
+ , **kwargs
+ ):
+ """
+ Present the user with a list of choices.
+ allow him to select multiple items and return them in a list.
+ if the user doesn't choose anything from the list, return the empty list.
+ return None if he cancelled selection.
+
+ @arg msg: the msg to be displayed.
+ @arg title: the window title
+ @arg choices: a list or tuple of the choices to be displayed
+ """
+ if len(choices) == 0: choices = ["Program logic error - no choices were specified."]
+
+ global __choiceboxMultipleSelect
+ __choiceboxMultipleSelect = 1
+ return __choicebox(msg, title, choices)
+
+
+#-----------------------------------------------------------------------
+# choicebox
+#-----------------------------------------------------------------------
+def choicebox(msg="Pick something."
+ , title=" "
+ , choices=()
+ ):
+ """
+ Present the user with a list of choices.
+ return the choice that he selects.
+ return None if he cancels the selection selection.
+
+ @arg msg: the msg to be displayed.
+ @arg title: the window title
+ @arg choices: a list or tuple of the choices to be displayed
+ """
+ if len(choices) == 0: choices = ["Program logic error - no choices were specified."]
+
+ global __choiceboxMultipleSelect
+ __choiceboxMultipleSelect = 0
+ return __choicebox(msg,title,choices)
+
+
+#-----------------------------------------------------------------------
+# __choicebox
+#-----------------------------------------------------------------------
+def __choicebox(msg
+ , title
+ , choices
+ ):
+ """
+ internal routine to support choicebox() and multchoicebox()
+ """
+ if sys.platform == 'darwin':
+ from subprocess import Popen
+ Tk().destroy()
+ Popen(['osascript', '-e', 'tell application "Python" to activate'])
+ global boxRoot, __choiceboxResults, choiceboxWidget, defaultText
+ global choiceboxWidget, choiceboxChoices
+ #-------------------------------------------------------------------
+ # If choices is a tuple, we make it a list so we can sort it.
+ # If choices is already a list, we make a new list, so that when
+ # we sort the choices, we don't affect the list object that we
+ # were given.
+ #-------------------------------------------------------------------
+ choices = list(choices[:])
+ if len(choices) == 0:
+ choices = ["Program logic error - no choices were specified."]
+ defaultButtons = ["OK", "Cancel"]
+
+ # make sure all choices are strings
+ for index in range(len(choices)):
+ choices[index] = str(choices[index])
+
+ lines_to_show = min(len(choices), 20)
+ lines_to_show = 20
+
+ if title == None: title = ""
+
+ # Initialize __choiceboxResults
+ # This is the value that will be returned if the user clicks the close icon
+ __choiceboxResults = None
+
+ boxRoot = Tk()
+ boxRoot.protocol('WM_DELETE_WINDOW', denyWindowManagerClose )
+ screen_width = boxRoot.winfo_screenwidth()
+ screen_height = boxRoot.winfo_screenheight()
+ root_width = int((screen_width * 0.8))
+ root_height = int((screen_height * 0.5))
+ root_xpos = int((screen_width * 0.1))
+ root_ypos = int((screen_height * 0.05))
+
+ boxRoot.title(title)
+ boxRoot.iconname('Dialog')
+ rootWindowPosition = "+0+0"
+ boxRoot.geometry(rootWindowPosition)
+ boxRoot.expand=NO
+ boxRoot.minsize(root_width, root_height)
+ rootWindowPosition = "+" + str(root_xpos) + "+" + str(root_ypos)
+ boxRoot.geometry(rootWindowPosition)
+
+ # ---------------- put the frames in the window -----------------------------------------
+ message_and_buttonsFrame = Frame(master=boxRoot)
+ message_and_buttonsFrame.pack(side=TOP, fill=X, expand=NO)
+
+ messageFrame = Frame(message_and_buttonsFrame)
+ messageFrame.pack(side=LEFT, fill=X, expand=YES)
+ #messageFrame.pack(side=TOP, fill=X, expand=YES)
+
+ buttonsFrame = Frame(message_and_buttonsFrame)
+ buttonsFrame.pack(side=RIGHT, expand=NO, pady=0)
+ #buttonsFrame.pack(side=TOP, expand=YES, pady=0)
+
+ choiceboxFrame = Frame(master=boxRoot)
+ choiceboxFrame.pack(side=BOTTOM, fill=BOTH, expand=YES)
+
+ # -------------------------- put the widgets in the frames ------------------------------
+
+ # ---------- put a msg widget in the msg frame-------------------
+ messageWidget = Message(messageFrame, anchor=NW, text=msg, width=int(root_width * 0.9))
+ messageWidget.configure(font=(PROPORTIONAL_FONT_FAMILY,PROPORTIONAL_FONT_SIZE))
+ messageWidget.pack(side=LEFT, expand=YES, fill=BOTH, padx='1m', pady='1m')
+
+ # -------- put the choiceboxWidget in the choiceboxFrame ---------------------------
+ choiceboxWidget = Listbox(choiceboxFrame
+ , height=lines_to_show
+ , borderwidth="1m"
+ , relief="flat"
+ , bg="white"
+ )
+
+ if __choiceboxMultipleSelect:
+ choiceboxWidget.configure(selectmode=MULTIPLE)
+
+ choiceboxWidget.configure(font=(PROPORTIONAL_FONT_FAMILY,PROPORTIONAL_FONT_SIZE))
+
+ # add a vertical scrollbar to the frame
+ rightScrollbar = Scrollbar(choiceboxFrame, orient=VERTICAL, command=choiceboxWidget.yview)
+ choiceboxWidget.configure(yscrollcommand = rightScrollbar.set)
+
+ # add a horizontal scrollbar to the frame
+ bottomScrollbar = Scrollbar(choiceboxFrame, orient=HORIZONTAL, command=choiceboxWidget.xview)
+ choiceboxWidget.configure(xscrollcommand = bottomScrollbar.set)
+
+ # pack the Listbox and the scrollbars. Note that although we must define
+ # the textArea first, we must pack it last, so that the bottomScrollbar will
+ # be located properly.
+
+ bottomScrollbar.pack(side=BOTTOM, fill = X)
+ rightScrollbar.pack(side=RIGHT, fill = Y)
+
+ choiceboxWidget.pack(side=LEFT, padx="1m", pady="1m", expand=YES, fill=BOTH)
+
+ #---------------------------------------------------
+ # sort the choices
+ # eliminate duplicates
+ # put the choices into the choiceboxWidget
+ #---------------------------------------------------
+ for index in range(len(choices)):
+ choices[index] = str(choices[index])
+
+ if runningPython3:
+ choices.sort(key=str.lower)
+ else:
+ choices.sort( lambda x,y: cmp(x.lower(), y.lower())) # case-insensitive sort
+
+ lastInserted = None
+ choiceboxChoices = []
+ for choice in choices:
+ if choice == lastInserted: pass
+ else:
+ choiceboxWidget.insert(END, choice)
+ choiceboxChoices.append(choice)
+ lastInserted = choice
+
+ boxRoot.bind('<Any-Key>', KeyboardListener)
+
+ # put the buttons in the buttonsFrame
+ if len(choices) > 0:
+ okButton = Button(buttonsFrame, takefocus=YES, text="OK", height=1, width=6)
+ bindArrows(okButton)
+ okButton.pack(expand=NO, side=TOP, padx='2m', pady='1m', ipady="1m", ipadx="2m")
+
+ # for the commandButton, bind activation events to the activation event handler
+ commandButton = okButton
+ handler = __choiceboxGetChoice
+ for selectionEvent in STANDARD_SELECTION_EVENTS:
+ commandButton.bind("<%s>" % selectionEvent, handler)
+
+ # now bind the keyboard events
+ choiceboxWidget.bind("<Return>", __choiceboxGetChoice)
+ choiceboxWidget.bind("<Double-Button-1>", __choiceboxGetChoice)
+ else:
+ # now bind the keyboard events
+ choiceboxWidget.bind("<Return>", __choiceboxCancel)
+ choiceboxWidget.bind("<Double-Button-1>", __choiceboxCancel)
+
+ cancelButton = Button(buttonsFrame, takefocus=YES, text="Cancel", height=1, width=6)
+ bindArrows(cancelButton)
+ cancelButton.pack(expand=NO, side=BOTTOM, padx='2m', pady='1m', ipady="1m", ipadx="2m")
+
+ # for the commandButton, bind activation events to the activation event handler
+ commandButton = cancelButton
+ handler = __choiceboxCancel
+ for selectionEvent in STANDARD_SELECTION_EVENTS:
+ commandButton.bind("<%s>" % selectionEvent, handler)
+
+
+ # add special buttons for multiple select features
+ if len(choices) > 0 and __choiceboxMultipleSelect:
+ selectionButtonsFrame = Frame(messageFrame)
+ selectionButtonsFrame.pack(side=RIGHT, fill=Y, expand=NO)
+
+ selectAllButton = Button(selectionButtonsFrame, text="Select All", height=1, width=6)
+ bindArrows(selectAllButton)
+
+ selectAllButton.bind("<Button-1>",__choiceboxSelectAll)
+ selectAllButton.pack(expand=NO, side=TOP, padx='2m', pady='1m', ipady="1m", ipadx="2m")
+
+ clearAllButton = Button(selectionButtonsFrame, text="Clear All", height=1, width=6)
+ bindArrows(clearAllButton)
+ clearAllButton.bind("<Button-1>",__choiceboxClearAll)
+ clearAllButton.pack(expand=NO, side=TOP, padx='2m', pady='1m', ipady="1m", ipadx="2m")
+
+
+ # -------------------- bind some keyboard events ----------------------------
+ boxRoot.bind("<Escape>", __choiceboxCancel)
+
+ # --------------------- the action begins -----------------------------------
+ # put the focus on the choiceboxWidget, and the select highlight on the first item
+ choiceboxWidget.select_set(0)
+ choiceboxWidget.focus_force()
+
+ # --- run it! -----
+ boxRoot.mainloop()
+
+ boxRoot.destroy()
+ return __choiceboxResults
+
+
+def __choiceboxGetChoice(event):
+ global boxRoot, __choiceboxResults, choiceboxWidget
+
+ if __choiceboxMultipleSelect:
+ __choiceboxResults = [choiceboxWidget.get(index) for index in choiceboxWidget.curselection()]
+
+ else:
+ choice_index = choiceboxWidget.curselection()
+ __choiceboxResults = choiceboxWidget.get(choice_index)
+
+ # writeln("Debugging> mouse-event=", event, " event.type=", event.type)
+ # writeln("Debugging> choice=", choice_index, __choiceboxResults)
+ boxRoot.quit()
+
+
+def __choiceboxSelectAll(event):
+ global choiceboxWidget, choiceboxChoices
+
+ choiceboxWidget.selection_set(0, len(choiceboxChoices)-1)
+
+def __choiceboxClearAll(event):
+ global choiceboxWidget, choiceboxChoices
+
+ choiceboxWidget.selection_clear(0, len(choiceboxChoices)-1)
+
+
+
+def __choiceboxCancel(event):
+ global boxRoot, __choiceboxResults
+
+ __choiceboxResults = None
+ boxRoot.quit()
+
+
+def KeyboardListener(event):
+ global choiceboxChoices, choiceboxWidget
+ key = event.keysym
+ if len(key) <= 1:
+ if key in string.printable:
+ # Find the key in the list.
+ # before we clear the list, remember the selected member
+ try:
+ start_n = int(choiceboxWidget.curselection()[0])
+ except IndexError:
+ start_n = -1
+
+ ## clear the selection.
+ choiceboxWidget.selection_clear(0, 'end')
+
+ ## start from previous selection +1
+ for n in range(start_n+1, len(choiceboxChoices)):
+ item = choiceboxChoices[n]
+ if item[0].lower() == key.lower():
+ choiceboxWidget.selection_set(first=n)
+ choiceboxWidget.see(n)
+ return
+ else:
+ # has not found it so loop from top
+ for n in range(len(choiceboxChoices)):
+ item = choiceboxChoices[n]
+ if item[0].lower() == key.lower():
+ choiceboxWidget.selection_set(first = n)
+ choiceboxWidget.see(n)
+ return
+
+ # nothing matched -- we'll look for the next logical choice
+ for n in range(len(choiceboxChoices)):
+ item = choiceboxChoices[n]
+ if item[0].lower() > key.lower():
+ if n > 0:
+ choiceboxWidget.selection_set(first = (n-1))
+ else:
+ choiceboxWidget.selection_set(first = 0)
+ choiceboxWidget.see(n)
+ return
+
+ # still no match (nothing was greater than the key)
+ # we set the selection to the first item in the list
+ lastIndex = len(choiceboxChoices)-1
+ choiceboxWidget.selection_set(first = lastIndex)
+ choiceboxWidget.see(lastIndex)
+ return
+
+#-----------------------------------------------------------------------
+# exception_format
+#-----------------------------------------------------------------------
+def exception_format():
+ """
+ Convert exception info into a string suitable for display.
+ """
+ return "".join(traceback.format_exception(
+ sys.exc_info()[0]
+ , sys.exc_info()[1]
+ , sys.exc_info()[2]
+ ))
+
+#-----------------------------------------------------------------------
+# exceptionbox
+#-----------------------------------------------------------------------
+def exceptionbox(msg=None, title=None):
+ """
+ Display a box that gives information about
+ an exception that has just been raised.
+
+ The caller may optionally pass in a title for the window, or a
+ msg to accompany the error information.
+
+ Note that you do not need to (and cannot) pass an exception object
+ as an argument. The latest exception will automatically be used.
+ """
+ if title == None: title = "Error Report"
+ if msg == None:
+ msg = "An error (exception) has occurred in the program."
+
+ codebox(msg, title, exception_format())
+
+#-------------------------------------------------------------------
+# codebox
+#-------------------------------------------------------------------
+
+def codebox(msg=""
+ , title=" "
+ , text=""
+ ):
+ """
+ Display some text in a monospaced font, with no line wrapping.
+ This function is suitable for displaying code and text that is
+ formatted using spaces.
+
+ The text parameter should be a string, or a list or tuple of lines to be
+ displayed in the textbox.
+ """
+ return textbox(msg, title, text, codebox=1 )
+
+#-------------------------------------------------------------------
+# textbox
+#-------------------------------------------------------------------
+def textbox(msg=""
+ , title=" "
+ , text=""
+ , codebox=0
+ ):
+ """
+ Display some text in a proportional font with line wrapping at word breaks.
+ This function is suitable for displaying general written text.
+
+ The text parameter should be a string, or a list or tuple of lines to be
+ displayed in the textbox.
+ """
+ if sys.platform == 'darwin':
+ from subprocess import Popen
+ Tk().destroy()
+ Popen(['osascript', '-e', 'tell application "Python" to activate'])
+ if msg == None: msg = ""
+ if title == None: title = ""
+
+ global boxRoot, __replyButtonText, __widgetTexts, buttonsFrame
+ global rootWindowPosition
+ choices = ["OK"]
+ __replyButtonText = choices[0]
+
+
+ boxRoot = Tk()
+
+ boxRoot.protocol('WM_DELETE_WINDOW', denyWindowManagerClose )
+
+ screen_width = boxRoot.winfo_screenwidth()
+ screen_height = boxRoot.winfo_screenheight()
+ root_width = int((screen_width * 0.8))
+ root_height = int((screen_height * 0.5))
+ root_xpos = int((screen_width * 0.1))
+ root_ypos = int((screen_height * 0.05))
+
+ boxRoot.title(title)
+ boxRoot.iconname('Dialog')
+ rootWindowPosition = "+0+0"
+ boxRoot.geometry(rootWindowPosition)
+ boxRoot.expand=NO
+ boxRoot.minsize(root_width, root_height)
+ rootWindowPosition = "+" + str(root_xpos) + "+" + str(root_ypos)
+ boxRoot.geometry(rootWindowPosition)
+
+ mainframe = Frame(master=boxRoot)
+ mainframe.pack(side=TOP, fill=BOTH, expand=YES)
+
+ # ---- put frames in the window -----------------------------------
+ # we pack the textboxFrame first, so it will expand first
+ textboxFrame = Frame(mainframe, borderwidth=3)
+ textboxFrame.pack(side=BOTTOM , fill=BOTH, expand=YES)
+
+ message_and_buttonsFrame = Frame(mainframe)
+ message_and_buttonsFrame.pack(side=TOP, fill=X, expand=NO)
+
+ messageFrame = Frame(message_and_buttonsFrame)
+ messageFrame.pack(side=LEFT, fill=X, expand=YES)
+
+ buttonsFrame = Frame(message_and_buttonsFrame)
+ buttonsFrame.pack(side=RIGHT, expand=NO)
+
+ # -------------------- put widgets in the frames --------------------
+
+ # put a textArea in the top frame
+ if codebox:
+ character_width = int((root_width * 0.6) / MONOSPACE_FONT_SIZE)
+ textArea = Text(textboxFrame,height=25,width=character_width, padx="2m", pady="1m")
+ textArea.configure(wrap=NONE)
+ textArea.configure(font=(MONOSPACE_FONT_FAMILY, MONOSPACE_FONT_SIZE))
+
+ else:
+ character_width = int((root_width * 0.6) / MONOSPACE_FONT_SIZE)
+ textArea = Text(
+ textboxFrame
+ , height=25
+ , width=character_width
+ , padx="2m"
+ , pady="1m"
+ )
+ textArea.configure(wrap=WORD)
+ textArea.configure(font=(PROPORTIONAL_FONT_FAMILY,PROPORTIONAL_FONT_SIZE))
+
+
+ # some simple keybindings for scrolling
+ mainframe.bind("<Next>" , textArea.yview_scroll( 1,PAGES))
+ mainframe.bind("<Prior>", textArea.yview_scroll(-1,PAGES))
+
+ mainframe.bind("<Right>", textArea.xview_scroll( 1,PAGES))
+ mainframe.bind("<Left>" , textArea.xview_scroll(-1,PAGES))
+
+ mainframe.bind("<Down>", textArea.yview_scroll( 1,UNITS))
+ mainframe.bind("<Up>" , textArea.yview_scroll(-1,UNITS))
+
+
+ # add a vertical scrollbar to the frame
+ rightScrollbar = Scrollbar(textboxFrame, orient=VERTICAL, command=textArea.yview)
+ textArea.configure(yscrollcommand = rightScrollbar.set)
+
+ # add a horizontal scrollbar to the frame
+ bottomScrollbar = Scrollbar(textboxFrame, orient=HORIZONTAL, command=textArea.xview)
+ textArea.configure(xscrollcommand = bottomScrollbar.set)
+
+ # pack the textArea and the scrollbars. Note that although we must define
+ # the textArea first, we must pack it last, so that the bottomScrollbar will
+ # be located properly.
+
+ # Note that we need a bottom scrollbar only for code.
+ # Text will be displayed with wordwrap, so we don't need to have a horizontal
+ # scroll for it.
+ if codebox:
+ bottomScrollbar.pack(side=BOTTOM, fill=X)
+ rightScrollbar.pack(side=RIGHT, fill=Y)
+
+ textArea.pack(side=LEFT, fill=BOTH, expand=YES)
+
+
+ # ---------- put a msg widget in the msg frame-------------------
+ messageWidget = Message(messageFrame, anchor=NW, text=msg, width=int(root_width * 0.9))
+ messageWidget.configure(font=(PROPORTIONAL_FONT_FAMILY,PROPORTIONAL_FONT_SIZE))
+ messageWidget.pack(side=LEFT, expand=YES, fill=BOTH, padx='1m', pady='1m')
+
+ # put the buttons in the buttonsFrame
+ okButton = Button(buttonsFrame, takefocus=YES, text="OK", height=1, width=6)
+ okButton.pack(expand=NO, side=TOP, padx='2m', pady='1m', ipady="1m", ipadx="2m")
+
+ # for the commandButton, bind activation events to the activation event handler
+ commandButton = okButton
+ handler = __textboxOK
+ for selectionEvent in ["Return","Button-1","Escape"]:
+ commandButton.bind("<%s>" % selectionEvent, handler)
+
+
+ # ----------------- the action begins ----------------------------------------
+ try:
+ # load the text into the textArea
+ if type(text) == type("abc"): pass
+ else:
+ try:
+ text = "".join(text) # convert a list or a tuple to a string
+ except:
+ msgbox("Exception when trying to convert "+ str(type(text)) + " to text in textArea")
+ sys.exit(16)
+ textArea.insert(END,text, "normal")
+
+ except:
+ msgbox("Exception when trying to load the textArea.")
+ sys.exit(16)
+
+ try:
+ okButton.focus_force()
+ except:
+ msgbox("Exception when trying to put focus on okButton.")
+ sys.exit(16)
+
+ boxRoot.mainloop()
+
+ # this line MUST go before the line that destroys boxRoot
+ areaText = textArea.get(0.0,END)
+ boxRoot.destroy()
+ return areaText # return __replyButtonText
+
+#-------------------------------------------------------------------
+# __textboxOK
+#-------------------------------------------------------------------
+def __textboxOK(event):
+ global boxRoot
+ boxRoot.quit()
+
+
+
+#-------------------------------------------------------------------
+# diropenbox
+#-------------------------------------------------------------------
+def diropenbox(msg=None
+ , title=None
+ , default=None
+ ):
+ """
+ A dialog to get a directory name.
+ Note that the msg argument, if specified, is ignored.
+
+ Returns the name of a directory, or None if user chose to cancel.
+
+ If the "default" argument specifies a directory name, and that
+ directory exists, then the dialog box will start with that directory.
+ """
+ if sys.platform == 'darwin':
+ from subprocess import Popen
+ Tk().destroy()
+ Popen(['osascript', '-e', 'tell application "Python" to activate'])
+ title=getFileDialogTitle(msg,title)
+ localRoot = Tk()
+ localRoot.withdraw()
+ if not default: default = None
+ f = tk_FileDialog.askdirectory(
+ parent=localRoot
+ , title=title
+ , initialdir=default
+ , initialfile=None
+ )
+ localRoot.destroy()
+ if not f: return None
+ return os.path.normpath(f)
+
+
+
+#-------------------------------------------------------------------
+# getFileDialogTitle
+#-------------------------------------------------------------------
+def getFileDialogTitle(msg
+ , title
+ ):
+ if msg and title: return "%s - %s" % (title,msg)
+ if msg and not title: return str(msg)
+ if title and not msg: return str(title)
+ return None # no message and no title
+
+#-------------------------------------------------------------------
+# class FileTypeObject for use with fileopenbox
+#-------------------------------------------------------------------
+class FileTypeObject:
+ def __init__(self,filemask):
+ if len(filemask) == 0:
+ raise AssertionError('Filetype argument is empty.')
+
+ self.masks = []
+
+ if type(filemask) == type("abc"): # a string
+ self.initializeFromString(filemask)
+
+ elif type(filemask) == type([]): # a list
+ if len(filemask) < 2:
+ raise AssertionError('Invalid filemask.\n'
+ +'List contains less than 2 members: "%s"' % filemask)
+ else:
+ self.name = filemask[-1]
+ self.masks = list(filemask[:-1] )
+ else:
+ raise AssertionError('Invalid filemask: "%s"' % filemask)
+
+ def __eq__(self,other):
+ if self.name == other.name: return True
+ return False
+
+ def add(self,other):
+ for mask in other.masks:
+ if mask in self.masks: pass
+ else: self.masks.append(mask)
+
+ def toTuple(self):
+ return (self.name,tuple(self.masks))
+
+ def isAll(self):
+ if self.name == "All files": return True
+ return False
+
+ def initializeFromString(self, filemask):
+ # remove everything except the extension from the filemask
+ self.ext = os.path.splitext(filemask)[1]
+ if self.ext == "" : self.ext = ".*"
+ if self.ext == ".": self.ext = ".*"
+ self.name = self.getName()
+ self.masks = ["*" + self.ext]
+
+ def getName(self):
+ e = self.ext
+ if e == ".*" : return "All files"
+ if e == ".txt": return "Text files"
+ if e == ".py" : return "Python files"
+ if e == ".pyc" : return "Python files"
+ if e == ".xls": return "Excel files"
+ if e.startswith("."):
+ return e[1:].upper() + " files"
+ return e.upper() + " files"
+
+
+#-------------------------------------------------------------------
+# fileopenbox
+#-------------------------------------------------------------------
+def fileopenbox(msg=None
+ , title=None
+ , default="*"
+ , filetypes=None
+ ):
+ """
+ A dialog to get a file name.
+
+ About the "default" argument
+ ============================
+ The "default" argument specifies a filepath that (normally)
+ contains one or more wildcards.
+ fileopenbox will display only files that match the default filepath.
+ If omitted, defaults to "*" (all files in the current directory).
+
+ WINDOWS EXAMPLE::
+ ...default="c:/myjunk/*.py"
+ will open in directory c:\myjunk\ and show all Python files.
+
+ WINDOWS EXAMPLE::
+ ...default="c:/myjunk/test*.py"
+ will open in directory c:\myjunk\ and show all Python files
+ whose names begin with "test".
+
+
+ Note that on Windows, fileopenbox automatically changes the path
+ separator to the Windows path separator (backslash).
+
+ About the "filetypes" argument
+ ==============================
+ If specified, it should contain a list of items,
+ where each item is either::
+ - a string containing a filemask # e.g. "*.txt"
+ - a list of strings, where all of the strings except the last one
+ are filemasks (each beginning with "*.",
+ such as "*.txt" for text files, "*.py" for Python files, etc.).
+ and the last string contains a filetype description
+
+ EXAMPLE::
+ filetypes = ["*.css", ["*.htm", "*.html", "HTML files"] ]
+
+ NOTE THAT
+ =========
+
+ If the filetypes list does not contain ("All files","*"),
+ it will be added.
+
+ If the filetypes list does not contain a filemask that includes
+ the extension of the "default" argument, it will be added.
+ For example, if default="*abc.py"
+ and no filetypes argument was specified, then
+ "*.py" will automatically be added to the filetypes argument.
+
+ @rtype: string or None
+ @return: the name of a file, or None if user chose to cancel
+
+ @arg msg: the msg to be displayed.
+ @arg title: the window title
+ @arg default: filepath with wildcards
+ @arg filetypes: filemasks that a user can choose, e.g. "*.txt"
+ """
+ if sys.platform == 'darwin':
+ from subprocess import Popen
+ Tk().destroy()
+ Popen(['osascript', '-e', 'tell application "Python" to activate'])
+ localRoot = Tk()
+ localRoot.withdraw()
+
+ initialbase, initialfile, initialdir, filetypes = fileboxSetup(default,filetypes)
+
+ #------------------------------------------------------------
+ # if initialfile contains no wildcards; we don't want an
+ # initial file. It won't be used anyway.
+ # Also: if initialbase is simply "*", we don't want an
+ # initialfile; it is not doing any useful work.
+ #------------------------------------------------------------
+ if (initialfile.find("*") < 0) and (initialfile.find("?") < 0):
+ initialfile = None
+ elif initialbase == "*":
+ initialfile = None
+
+ f = tk_FileDialog.askopenfilename(parent=localRoot
+ , title=getFileDialogTitle(msg,title)
+ , initialdir=initialdir
+ , initialfile=initialfile
+ , filetypes=filetypes
+ )
+
+ localRoot.destroy()
+
+ if not f: return None
+ return os.path.normpath(f)
+
+
+#-------------------------------------------------------------------
+# filesavebox
+#-------------------------------------------------------------------
+def filesavebox(msg=None
+ , title=None
+ , default=""
+ , filetypes=None
+ ):
+ """
+ A file to get the name of a file to save.
+ Returns the name of a file, or None if user chose to cancel.
+
+ The "default" argument should contain a filename (i.e. the
+ current name of the file to be saved). It may also be empty,
+ or contain a filemask that includes wildcards.
+
+ The "filetypes" argument works like the "filetypes" argument to
+ fileopenbox.
+ """
+ if sys.platform == 'darwin':
+ from subprocess import Popen
+ Tk().destroy()
+ Popen(['osascript', '-e', 'tell application "Python" to activate'])
+ localRoot = Tk()
+ localRoot.withdraw()
+
+ initialbase, initialfile, initialdir, filetypes = fileboxSetup(default,filetypes)
+
+ f = tk_FileDialog.asksaveasfilename(parent=localRoot
+ , title=getFileDialogTitle(msg,title)
+ , initialfile=initialfile
+ , initialdir=initialdir
+ , filetypes=filetypes
+ )
+ localRoot.destroy()
+ if not f: return None
+ return os.path.normpath(f)
+
+
+#-------------------------------------------------------------------
+#
+# fileboxSetup
+#
+#-------------------------------------------------------------------
+def fileboxSetup(default,filetypes):
+ if not default: default = os.path.join(".","*")
+ initialdir, initialfile = os.path.split(default)
+ if not initialdir : initialdir = "."
+ if not initialfile: initialfile = "*"
+ initialbase, initialext = os.path.splitext(initialfile)
+ initialFileTypeObject = FileTypeObject(initialfile)
+
+ allFileTypeObject = FileTypeObject("*")
+ ALL_filetypes_was_specified = False
+
+ if not filetypes: filetypes= []
+ filetypeObjects = []
+
+ for filemask in filetypes:
+ fto = FileTypeObject(filemask)
+
+ if fto.isAll():
+ ALL_filetypes_was_specified = True # remember this
+
+ if fto == initialFileTypeObject:
+ initialFileTypeObject.add(fto) # add fto to initialFileTypeObject
+ else:
+ filetypeObjects.append(fto)
+
+ #------------------------------------------------------------------
+ # make sure that the list of filetypes includes the ALL FILES type.
+ #------------------------------------------------------------------
+ if ALL_filetypes_was_specified:
+ pass
+ elif allFileTypeObject == initialFileTypeObject:
+ pass
+ else:
+ filetypeObjects.insert(0,allFileTypeObject)
+ #------------------------------------------------------------------
+ # Make sure that the list includes the initialFileTypeObject
+ # in the position in the list that will make it the default.
+ # This changed between Python version 2.5 and 2.6
+ #------------------------------------------------------------------
+ if len(filetypeObjects) == 0:
+ filetypeObjects.append(initialFileTypeObject)
+
+ if initialFileTypeObject in (filetypeObjects[0], filetypeObjects[-1]):
+ pass
+ else:
+ if runningPython26:
+ filetypeObjects.append(initialFileTypeObject)
+ else:
+ filetypeObjects.insert(0,initialFileTypeObject)
+
+ filetypes = [fto.toTuple() for fto in filetypeObjects]
+
+ return initialbase, initialfile, initialdir, filetypes
+
+#-------------------------------------------------------------------
+# utility routines
+#-------------------------------------------------------------------
+# These routines are used by several other functions in the EasyGui module.
+
+def __buttonEvent(event):
+ """
+ Handle an event that is generated by a person clicking a button.
+ """
+ global boxRoot, __widgetTexts, __replyButtonText
+ __replyButtonText = __widgetTexts[event.widget]
+ boxRoot.quit() # quit the main loop
+
+
+def __put_buttons_in_buttonframe(choices):
+ """Put the buttons in the buttons frame
+ """
+ global __widgetTexts, __firstWidget, buttonsFrame
+
+ __firstWidget = None
+ __widgetTexts = {}
+
+ i = 0
+
+ for buttonText in choices:
+ tempButton = Button(buttonsFrame, takefocus=1, text=buttonText)
+ bindArrows(tempButton)
+ tempButton.pack(expand=YES, side=LEFT, padx='1m', pady='1m', ipadx='2m', ipady='1m')
+
+ # remember the text associated with this widget
+ __widgetTexts[tempButton] = buttonText
+
+ # remember the first widget, so we can put the focus there
+ if i == 0:
+ __firstWidget = tempButton
+ i = 1
+
+ # for the commandButton, bind activation events to the activation event handler
+ commandButton = tempButton
+ handler = __buttonEvent
+ for selectionEvent in STANDARD_SELECTION_EVENTS:
+ commandButton.bind("<%s>" % selectionEvent, handler)
+
+##-----------------------------------------------------------------------
+##
+## class EgStore
+##
+##-----------------------------------------------------------------------
+#class EgStore:
+# r"""
+#A class to support persistent storage.
+#
+#You can use EgStore to support the storage and retrieval
+#of user settings for an EasyGui application.
+#
+#
+## Example A
+##-----------------------------------------------------------------------
+## define a class named Settings as a subclass of EgStore
+##-----------------------------------------------------------------------
+#class Settings(EgStore):
+#::
+# def __init__(self, filename): # filename is required
+# #-------------------------------------------------
+# # Specify default/initial values for variables that
+# # this particular application wants to remember.
+# #-------------------------------------------------
+# self.userId = ""
+# self.targetServer = ""
+#
+# #-------------------------------------------------
+# # For subclasses of EgStore, these must be
+# # the last two statements in __init__
+# #-------------------------------------------------
+# self.filename = filename # this is required
+# self.restore() # restore values from the storage file if possible
+#
+#
+#
+## Example B
+##-----------------------------------------------------------------------
+## create settings, a persistent Settings object
+##-----------------------------------------------------------------------
+#settingsFile = "myApp_settings.txt"
+#settings = Settings(settingsFile)
+#
+#user = "obama_barak"
+#server = "whitehouse1"
+#settings.userId = user
+#settings.targetServer = server
+#settings.store() # persist the settings
+#
+## run code that gets a new value for userId, and persist the settings
+#user = "biden_joe"
+#settings.userId = user
+#settings.store()
+#
+#
+## Example C
+##-----------------------------------------------------------------------
+## recover the Settings instance, change an attribute, and store it again.
+##-----------------------------------------------------------------------
+#settings = Settings(settingsFile)
+#settings.userId = "vanrossum_g"
+#settings.store()
+#
+#"""
+# def __init__(self, filename): # obtaining filename is required
+# self.filename = None
+# raise NotImplementedError()
+#
+# def restore(self):
+# """
+# Set the values of whatever attributes are recoverable
+# from the pickle file.
+#
+# Populate the attributes (the __dict__) of the EgStore object
+# from the attributes (the __dict__) of the pickled object.
+#
+# If the pickled object has attributes that have been initialized
+# in the EgStore object, then those attributes of the EgStore object
+# will be replaced by the values of the corresponding attributes
+# in the pickled object.
+#
+# If the pickled object is missing some attributes that have
+# been initialized in the EgStore object, then those attributes
+# of the EgStore object will retain the values that they were
+# initialized with.
+#
+# If the pickled object has some attributes that were not
+# initialized in the EgStore object, then those attributes
+# will be ignored.
+#
+# IN SUMMARY:
+#
+# After the recover() operation, the EgStore object will have all,
+# and only, the attributes that it had when it was initialized.
+#
+# Where possible, those attributes will have values recovered
+# from the pickled object.
+# """
+# if not os.path.exists(self.filename): return self
+# if not os.path.isfile(self.filename): return self
+#
+# try:
+# f = open(self.filename,"rb")
+# unpickledObject = pickle.load(f)
+# f.close()
+#
+# for key in list(self.__dict__.keys()):
+# default = self.__dict__[key]
+# self.__dict__[key] = unpickledObject.__dict__.get(key,default)
+# except:
+# pass
+#
+# return self
+#
+# def store(self):
+# """
+# Save the attributes of the EgStore object to a pickle file.
+# Note that if the directory for the pickle file does not already exist,
+# the store operation will fail.
+# """
+# f = open(self.filename, "wb")
+# pickle.dump(self, f)
+# f.close()
+#
+#
+# def kill(self):
+# """
+# Delete my persistent file (i.e. pickle file), if it exists.
+# """
+# if os.path.isfile(self.filename):
+# os.remove(self.filename)
+# return
+#
+# def __str__(self):
+# """
+# return my contents as a string in an easy-to-read format.
+# """
+# # find the length of the longest attribute name
+# longest_key_length = 0
+# keys = []
+# for key in self.__dict__.keys():
+# keys.append(key)
+# longest_key_length = max(longest_key_length, len(key))
+#
+# keys.sort() # sort the attribute names
+# lines = []
+# for key in keys:
+# value = self.__dict__[key]
+# key = key.ljust(longest_key_length)
+# lines.append("%s : %s\n" % (key,repr(value)) )
+# return "".join(lines) # return a string showing the attributes
+
+
+
+
+##-----------------------------------------------------------------------
+##
+## test/demo easygui
+##
+##-----------------------------------------------------------------------
+#def egdemo():
+# """
+# Run the EasyGui demo.
+# """
+# # clear the console
+# writeln("\n" * 100)
+#
+# intro_message = ("Pick the kind of box that you wish to demo.\n"
+# + "\n * Python version " + sys.version
+# + "\n * EasyGui version " + egversion
+# + "\n * Tk version " + str(TkVersion)
+# )
+#
+# #========================================== END DEMONSTRATION DATA
+#
+#
+# while 1: # do forever
+# choices = [
+# "msgbox",
+# "buttonbox",
+# "buttonbox(image) -- a buttonbox that displays an image",
+# "choicebox",
+# "multchoicebox",
+# "textbox",
+# "ynbox",
+# "ccbox",
+# "enterbox",
+# "enterbox(image) -- an enterbox that displays an image",
+# "exceptionbox",
+# "codebox",
+# "integerbox",
+# "boolbox",
+# "indexbox",
+# "filesavebox",
+# "fileopenbox",
+# "passwordbox",
+# "multenterbox",
+# "multpasswordbox",
+# "diropenbox",
+# "About EasyGui",
+# " Help"
+# ]
+# choice = choicebox(msg=intro_message
+# , title="EasyGui " + egversion
+# , choices=choices)
+#
+# if not choice: return
+#
+# reply = choice.split()
+#
+# if reply[0] == "msgbox":
+# reply = msgbox("short msg", "This is a long title")
+# writeln("Reply was: %s" % repr(reply))
+#
+# elif reply[0] == "About":
+# reply = abouteasygui()
+#
+# elif reply[0] == "Help":
+# _demo_help()
+#
+# elif reply[0] == "buttonbox":
+# reply = buttonbox()
+# writeln("Reply was: %s" % repr(reply))
+#
+# title = "Demo of Buttonbox with many, many buttons!"
+# msg = "This buttonbox shows what happens when you specify too many buttons."
+# reply = buttonbox(msg=msg, title=title, choices=choices)
+# writeln("Reply was: %s" % repr(reply))
+#
+# elif reply[0] == "buttonbox(image)":
+# _demo_buttonbox_with_image()
+#
+# elif reply[0] == "boolbox":
+# reply = boolbox()
+# writeln("Reply was: %s" % repr(reply))
+#
+# elif reply[0] == "enterbox":
+# image = "python_and_check_logo.gif"
+# message = "Enter the name of your best friend."\
+# "\n(Result will be stripped.)"
+# reply = enterbox(message, "Love!", " Suzy Smith ")
+# writeln("Reply was: %s" % repr(reply))
+#
+# message = "Enter the name of your best friend."\
+# "\n(Result will NOT be stripped.)"
+# reply = enterbox(message, "Love!", " Suzy Smith ",strip=False)
+# writeln("Reply was: %s" % repr(reply))
+#
+# reply = enterbox("Enter the name of your worst enemy:", "Hate!")
+# writeln("Reply was: %s" % repr(reply))
+#
+# elif reply[0] == "enterbox(image)":
+# image = "python_and_check_logo.gif"
+# message = "What kind of snake is this?"
+# reply = enterbox(message, "Quiz",image=image)
+# writeln("Reply was: %s" % repr(reply))
+#
+# elif reply[0] == "exceptionbox":
+# try:
+# thisWillCauseADivideByZeroException = 1/0
+# except:
+# exceptionbox()
+#
+# elif reply[0] == "integerbox":
+# reply = integerbox(
+# "Enter a number between 3 and 333",
+# "Demo: integerbox WITH a default value",
+# 222, 3, 333)
+# writeln("Reply was: %s" % repr(reply))
+#
+# reply = integerbox(
+# "Enter a number between 0 and 99",
+# "Demo: integerbox WITHOUT a default value"
+# )
+# writeln("Reply was: %s" % repr(reply))
+#
+# elif reply[0] == "diropenbox" : _demo_diropenbox()
+# elif reply[0] == "fileopenbox": _demo_fileopenbox()
+# elif reply[0] == "filesavebox": _demo_filesavebox()
+#
+# elif reply[0] == "indexbox":
+# title = reply[0]
+# msg = "Demo of " + reply[0]
+# choices = ["Choice1", "Choice2", "Choice3", "Choice4"]
+# reply = indexbox(msg, title, choices)
+# writeln("Reply was: %s" % repr(reply))
+#
+# elif reply[0] == "passwordbox":
+# reply = passwordbox("Demo of password box WITHOUT default"
+# + "\n\nEnter your secret password", "Member Logon")
+# writeln("Reply was: %s" % str(reply))
+#
+# reply = passwordbox("Demo of password box WITH default"
+# + "\n\nEnter your secret password", "Member Logon", "alfie")
+# writeln("Reply was: %s" % str(reply))
+#
+# elif reply[0] == "multenterbox":
+# msg = "Enter your personal information"
+# title = "Credit Card Application"
+# fieldNames = ["Name","Street Address","City","State","ZipCode"]
+# fieldValues = [] # we start with blanks for the values
+# fieldValues = multenterbox(msg,title, fieldNames)
+#
+# # make sure that none of the fields was left blank
+# while 1:
+# if fieldValues == None: break
+# errmsg = ""
+# for i in range(len(fieldNames)):
+# if fieldValues[i].strip() == "":
+# errmsg = errmsg + ('"%s" is a required field.\n\n' % fieldNames[i])
+# if errmsg == "": break # no problems found
+# fieldValues = multenterbox(errmsg, title, fieldNames, fieldValues)
+#
+# writeln("Reply was: %s" % str(fieldValues))
+#
+# elif reply[0] == "multpasswordbox":
+# msg = "Enter logon information"
+# title = "Demo of multpasswordbox"
+# fieldNames = ["Server ID", "User ID", "Password"]
+# fieldValues = [] # we start with blanks for the values
+# fieldValues = multpasswordbox(msg,title, fieldNames)
+#
+# # make sure that none of the fields was left blank
+# while 1:
+# if fieldValues == None: break
+# errmsg = ""
+# for i in range(len(fieldNames)):
+# if fieldValues[i].strip() == "":
+# errmsg = errmsg + ('"%s" is a required field.\n\n' % fieldNames[i])
+# if errmsg == "": break # no problems found
+# fieldValues = multpasswordbox(errmsg, title, fieldNames, fieldValues)
+#
+# writeln("Reply was: %s" % str(fieldValues))
+#
+# elif reply[0] == "ynbox":
+# title = "Demo of ynbox"
+# msg = "Were you expecting the Spanish Inquisition?"
+# reply = ynbox(msg, title)
+# writeln("Reply was: %s" % repr(reply))
+# if reply:
+# msgbox("NOBODY expects the Spanish Inquisition!", "Wrong!")
+#
+# elif reply[0] == "ccbox":
+# title = "Demo of ccbox"
+# reply = ccbox(msg,title)
+# writeln("Reply was: %s" % repr(reply))
+#
+# elif reply[0] == "choicebox":
+# title = "Demo of choicebox"
+# longchoice = "This is an example of a very long option which you may or may not wish to choose."*2
+# listChoices = ["nnn", "ddd", "eee", "fff", "aaa", longchoice
+# , "aaa", "bbb", "ccc", "ggg", "hhh", "iii", "jjj", "kkk", "LLL", "mmm" , "nnn", "ooo", "ppp", "qqq", "rrr", "sss", "ttt", "uuu", "vvv"]
+#
+# msg = "Pick something. " + ("A wrapable sentence of text ?! "*30) + "\nA separate line of text."*6
+# reply = choicebox(msg=msg, choices=listChoices)
+# writeln("Reply was: %s" % repr(reply))
+#
+# msg = "Pick something. "
+# reply = choicebox(msg=msg, title=title, choices=listChoices)
+# writeln("Reply was: %s" % repr(reply))
+#
+# msg = "Pick something. "
+# reply = choicebox(msg="The list of choices is empty!", choices=[])
+# writeln("Reply was: %s" % repr(reply))
+#
+# elif reply[0] == "multchoicebox":
+# listChoices = ["aaa", "bbb", "ccc", "ggg", "hhh", "iii", "jjj", "kkk"
+# , "LLL", "mmm" , "nnn", "ooo", "ppp", "qqq"
+# , "rrr", "sss", "ttt", "uuu", "vvv"]
+#
+# msg = "Pick as many choices as you wish."
+# reply = multchoicebox(msg,"Demo of multchoicebox", listChoices)
+# writeln("Reply was: %s" % repr(reply))
+#
+# elif reply[0] == "textbox": _demo_textbox(reply[0])
+# elif reply[0] == "codebox": _demo_codebox(reply[0])
+#
+# else:
+# msgbox("Choice\n\n" + choice + "\n\nis not recognized", "Program Logic Error")
+# return
+#
+#
+#def _demo_textbox(reply):
+# text_snippet = ((\
+#"""It was the best of times, and it was the worst of times. The rich ate cake, and the poor had cake recommended to them, but wished only for enough cash to buy bread. The time was ripe for revolution! """ \
+#*5)+"\n\n")*10
+# title = "Demo of textbox"
+# msg = "Here is some sample text. " * 16
+# reply = textbox(msg, title, text_snippet)
+# writeln("Reply was: %s" % str(reply))
+#
+#def _demo_codebox(reply):
+# code_snippet = ("dafsdfa dasflkj pp[oadsij asdfp;ij asdfpjkop asdfpok asdfpok asdfpok"*3) +"\n"+\
+#"""# here is some dummy Python code
+#for someItem in myListOfStuff:
+# do something(someItem)
+# do something()
+# do something()
+# if somethingElse(someItem):
+# doSomethingEvenMoreInteresting()
+#
+#"""*16
+# msg = "Here is some sample code. " * 16
+# reply = codebox(msg, "Code Sample", code_snippet)
+# writeln("Reply was: %s" % repr(reply))
+#
+#
+#def _demo_buttonbox_with_image():
+#
+# msg = "Do you like this picture?\nIt is "
+# choices = ["Yes","No","No opinion"]
+#
+# for image in [
+# "python_and_check_logo.gif"
+# ,"python_and_check_logo.jpg"
+# ,"python_and_check_logo.png"
+# ,"zzzzz.gif"]:
+#
+# reply=buttonbox(msg + image,image=image,choices=choices)
+# writeln("Reply was: %s" % repr(reply))
+#
+#
+#def _demo_help():
+# savedStdout = sys.stdout # save the sys.stdout file object
+# sys.stdout = capturedOutput = StringIO()
+# help("easygui")
+# sys.stdout = savedStdout # restore the sys.stdout file object
+# codebox("EasyGui Help",text=capturedOutput.getvalue())
+#
+#def _demo_filesavebox():
+# filename = "myNewFile.txt"
+# title = "File SaveAs"
+# msg ="Save file as:"
+#
+# f = filesavebox(msg,title,default=filename)
+# writeln("You chose to save file: %s" % f)
+#
+#def _demo_diropenbox():
+# title = "Demo of diropenbox"
+# msg = "Pick the directory that you wish to open."
+# d = diropenbox(msg, title)
+# writeln("You chose directory...: %s" % d)
+#
+# d = diropenbox(msg, title,default="./")
+# writeln("You chose directory...: %s" % d)
+#
+# d = diropenbox(msg, title,default="c:/")
+# writeln("You chose directory...: %s" % d)
+#
+#
+#def _demo_fileopenbox():
+# msg = "Python files"
+# title = "Open files"
+# default="*.py"
+# f = fileopenbox(msg,title,default=default)
+# writeln("You chose to open file: %s" % f)
+#
+# default="./*.gif"
+# filetypes = ["*.jpg",["*.zip","*.tgs","*.gz", "Archive files"],["*.htm", "*.html","HTML files"]]
+# f = fileopenbox(msg,title,default=default,filetypes=filetypes)
+# writeln("You chose to open file: %s" % f)
+#
+# """#deadcode -- testing ----------------------------------------
+# f = fileopenbox(None,None,default=default)
+# writeln("You chose to open file: %s" % f)
+#
+# f = fileopenbox(None,title,default=default)
+# writeln("You chose to open file: %s" % f)
+#
+# f = fileopenbox(msg,None,default=default)
+# writeln("You chose to open file: %s" % f)
+#
+# f = fileopenbox(default=default)
+# writeln("You chose to open file: %s" % f)
+#
+# f = fileopenbox(default=None)
+# writeln("You chose to open file: %s" % f)
+# #----------------------------------------------------deadcode """
+#
+#
+#def _dummy():
+# pass
+#
+#EASYGUI_ABOUT_INFORMATION = '''
+#========================================================================
+#0.96(2010-08-29)
+#========================================================================
+#This version fixes some problems with version independence.
+#
+#BUG FIXES
+#------------------------------------------------------
+# * A statement with Python 2.x-style exception-handling syntax raised
+# a syntax error when running under Python 3.x.
+# Thanks to David Williams for reporting this problem.
+#
+# * Under some circumstances, PIL was unable to display non-gif images
+# that it should have been able to display.
+# The cause appears to be non-version-independent import syntax.
+# PIL modules are now imported with a version-independent syntax.
+# Thanks to Horst Jens for reporting this problem.
+#
+#LICENSE CHANGE
+#------------------------------------------------------
+#Starting with this version, EasyGui is licensed under what is generally known as
+#the "modified BSD license" (aka "revised BSD", "new BSD", "3-clause BSD").
+#This license is GPL-compatible but less restrictive than GPL.
+#Earlier versions were licensed under the Creative Commons Attribution License 2.0.
+#
+#
+#========================================================================
+#0.95(2010-06-12)
+#========================================================================
+#
+#ENHANCEMENTS
+#------------------------------------------------------
+# * Previous versions of EasyGui could display only .gif image files using the
+# msgbox "image" argument. This version can now display all image-file formats
+# supported by PIL the Python Imaging Library) if PIL is installed.
+# If msgbox is asked to open a non-gif image file, it attempts to import
+# PIL and to use PIL to convert the image file to a displayable format.
+# If PIL cannot be imported (probably because PIL is not installed)
+# EasyGui displays an error message saying that PIL must be installed in order
+# to display the image file.
+#
+# Note that
+# http://www.pythonware.com/products/pil/
+# says that PIL doesn't yet support Python 3.x.
+#
+#
+#========================================================================
+#0.94(2010-06-06)
+#========================================================================
+#
+#ENHANCEMENTS
+#------------------------------------------------------
+# * The codebox and textbox functions now return the contents of the box, rather
+# than simply the name of the button ("Yes"). This makes it possible to use
+# codebox and textbox as data-entry widgets. A big "thank you!" to Dominic
+# Comtois for requesting this feature, patiently explaining his requirement,
+# and helping to discover the tkinter techniques to implement it.
+#
+# NOTE THAT in theory this change breaks backward compatibility. But because
+# (in previous versions of EasyGui) the value returned by codebox and textbox
+# was meaningless, no application should have been checking it. So in actual
+# practice, this change should not break backward compatibility.
+#
+# * Added support for SPACEBAR to command buttons. Now, when keyboard
+# focus is on a command button, a press of the SPACEBAR will act like
+# a press of the ENTER key; it will activate the command button.
+#
+# * Added support for keyboard navigation with the arrow keys (up,down,left,right)
+# to the fields and buttons in enterbox, multenterbox and multpasswordbox,
+# and to the buttons in choicebox and all buttonboxes.
+#
+# * added highlightthickness=2 to entry fields in multenterbox and
+# multpasswordbox. Now it is easier to tell which entry field has
+# keyboard focus.
+#
+#
+#BUG FIXES
+#------------------------------------------------------
+# * In EgStore, the pickle file is now opened with "rb" and "wb" rather than
+# with "r" and "w". This change is necessary for compatibility with Python 3+.
+# Thanks to Marshall Mattingly for reporting this problem and providing the fix.
+#
+# * In integerbox, the actual argument names did not match the names described
+# in the docstring. Thanks to Daniel Zingaro of at University of Toronto for
+# reporting this problem.
+#
+# * In integerbox, the "argLowerBound" and "argUpperBound" arguments have been
+# renamed to "lowerbound" and "upperbound" and the docstring has been corrected.
+#
+# NOTE THAT THIS CHANGE TO THE ARGUMENT-NAMES BREAKS BACKWARD COMPATIBILITY.
+# If argLowerBound or argUpperBound are used, an AssertionError with an
+# explanatory error message is raised.
+#
+# * In choicebox, the signature to choicebox incorrectly showed choicebox as
+# accepting a "buttons" argument. The signature has been fixed.
+#
+#
+#========================================================================
+#0.93(2009-07-07)
+#========================================================================
+#
+#ENHANCEMENTS
+#------------------------------------------------------
+#
+# * Added exceptionbox to display stack trace of exceptions
+#
+# * modified names of some font-related constants to make it
+# easier to customize them
+#
+#
+#========================================================================
+#0.92(2009-06-22)
+#========================================================================
+#
+#ENHANCEMENTS
+#------------------------------------------------------
+#
+# * Added EgStore class to to provide basic easy-to-use persistence.
+#
+#BUG FIXES
+#------------------------------------------------------
+#
+# * Fixed a bug that was preventing Linux users from copying text out of
+# a textbox and a codebox. This was not a problem for Windows users.
+#
+#'''
+#
+#def abouteasygui():
+# """
+# shows the easygui revision history
+# """
+# codebox("About EasyGui\n"+egversion,"EasyGui",EASYGUI_ABOUT_INFORMATION)
+# return None
+#
+#
+#
+#if __name__ == '__main__':
+# if True:
+# egdemo()
+# else:
+# # test the new root feature
+# root = Tk()
+# msg = """This is a test of a main Tk() window in which we will place an easygui msgbox.
+# It will be an interesting experiment.\n\n"""
+# messageWidget = Message(root, text=msg, width=1000)
+# messageWidget.pack(side=TOP, expand=YES, fill=X, padx='3m', pady='3m')
+# messageWidget = Message(root, text=msg, width=1000)
+# messageWidget.pack(side=TOP, expand=YES, fill=X, padx='3m', pady='3m')
+#
+#
+# msgbox("this is a test of passing in boxRoot", root=root)
+# msgbox("this is a second test of passing in boxRoot", root=root)
+#
+# reply = enterbox("Enter something", root=root)
+# writeln("You wrote:", reply)
+#
+# reply = enterbox("Enter something else", root=root)
+# writeln("You wrote:", reply)
+# root.destroy()
--- /dev/null
+#!/usr/bin/env python
+
+__author__ = 'Nadeem Douba'
+__copyright__ = 'Copyright 2012, Sploitego Project'
+__credits__ = []
+
+__license__ = 'GPL'
+__version__ = '0.1'
+__maintainer__ = 'Nadeem Douba'
+__email__ = 'ndouba@gmail.com'
+__status__ = 'Development'
+
+__all__ = [
+ 'privileged',
+ 'specification'
+]
+
+
+def superuser(f):
+ f.privileged = True
+ return f
+
+
+class configure(object):
+
+ def __init__(self, **kwargs):
+ diff = set(['label', 'uuids', 'inputs']).difference(kwargs)
+ if diff:
+ raise TypeError('Missing transform specification properties: %s' % ', '.join(diff))
+ if not isinstance(kwargs['uuids'], list):
+ raise TypeError('Expected type list (got %s instead)' % type(kwargs['uuids']).__name__)
+ if not isinstance(kwargs['inputs'], list):
+ raise TypeError('Expected type list (got %s instead)' % type(kwargs['inputs']))
+ kwargs['description'] = kwargs.get('description', '')
+ kwargs['debug'] = kwargs.get('debug', False)
+ self.specification = kwargs
+
+ def __call__(self, f):
+ f.__dict__.update(self.specification)
+ return f
--- /dev/null
+#!/usr/bin/env python
+
+__author__ = 'Nadeem Douba'
+__copyright__ = 'Copyright 2012, Canari Project'
+__credits__ = []
+
+__license__ = 'GPL'
+__version__ = '0.1'
+__maintainer__ = 'Nadeem Douba'
+__email__ = 'ndouba@gmail.com'
+__status__ = 'Development'
+
+__all__ = [
+ 'message',
+ 'utils'
+]
\ No newline at end of file
--- /dev/null
+#!/usr/bin/env python
+
+from ..xmltools.oxml import XMLAttribute, XSAttributeType, XMLSubElement, XSSubElementType
+from message import MaltegoElement
+
+
+__author__ = 'Nadeem Douba'
+__copyright__ = 'Copyright 2012, Canari Project'
+__credits__ = []
+
+__license__ = 'GPL'
+__version__ = '0.1'
+__maintainer__ = 'Nadeem Douba'
+__email__ = 'ndouba@gmail.com'
+__status__ = 'Development'
+
+__all__ = [
+ 'BuiltInTransformSets',
+ 'TransformAdapter',
+ 'MaltegoTransform',
+ 'InputConstraint',
+ 'OutputEntity',
+ 'InputEntity',
+ 'PropertyType',
+ 'TransformProperty',
+ 'TransformPropertySetting',
+ 'CmdLineTransformProperty',
+ 'CmdLineTransformPropertySetting',
+ 'CmdParmTransformProperty',
+ 'CmdParmTransformPropertySetting',
+ 'CmdCwdTransformProperty',
+ 'CmdCwdTransformPropertySetting',
+ 'CmdDbgTransformProperty',
+ 'CmdDbgTransformPropertySetting',
+ 'TransformSettings',
+ 'TransformSet'
+]
+
+
+class TransformAdapter(object):
+ Local ='com.paterva.maltego.transform.protocol.v2.LocalTransformAdapterV2'
+ Remote ='com.paterva.maltego.transform.protocol.v2.RemoteTransformAdapterV2'
+
+
+@XMLAttribute(name='abstract', type=XSAttributeType.Bool, default=False)
+@XMLAttribute(name='author', default='')
+@XMLAttribute(name='description', default='')
+@XMLAttribute(name='displayName', propname='displayname')
+@XMLAttribute(name='name')
+@XMLAttribute(name='requireDisplayInfo', propname='requireinfo', type=XSAttributeType.Bool, default=False)
+@XMLAttribute(name='template', type=XSAttributeType.Bool, default=False)
+@XMLAttribute(name='visibility', default='public')
+@XMLAttribute(name='helpURL', propname='helpurl')
+@XMLAttribute(name='owner')
+@XMLAttribute(name='version', default='1.0')
+@XMLAttribute(name='locationRelevance', propname='locrel')
+@XMLSubElement(name='TransformAdapter', propname='adapter', type=XSSubElementType.Enum, choices=[TransformAdapter.Local, TransformAdapter.Remote], default=TransformAdapter.Local)
+@XMLSubElement(name='StealthLevel', propname='stealthlvl', type=XSSubElementType.Integer, default=0)
+@XMLSubElement(name='defaultSets', propname='sets', type=XSSubElementType.List)
+@XMLSubElement(name='Disclaimer', propname='disclaimer', type=XSSubElementType.CData)
+@XMLSubElement(name='Help', propname='help', type=XSSubElementType.CData)
+@XMLSubElement(name='OutputEntities', propname='output', type=XSSubElementType.List)
+@XMLSubElement(name='InputConstraints', propname='input', type=XSSubElementType.List)
+@XMLSubElement(name='Properties/Fields', propname='properties', type=XSSubElementType.List)
+class MaltegoTransform(MaltegoElement):
+ def __init__(self, name, displayname, **kwargs):
+ super(MaltegoTransform, self).__init__(self.__class__.__name__)
+ self.name = name
+ self.displayname = displayname
+ self.abstract = kwargs.get('abstract', self.abstract)
+ self.author = kwargs.get('author', self.author)
+ self.description = kwargs.get('description', self.description)
+ self.requireinfo = kwargs.get('requireinfo', self.requireinfo)
+ self.template = kwargs.get('template', self.template)
+ self.visibility = kwargs.get('visibility', self.visibility)
+ self.helpurl = kwargs.get('helpurl', self.helpurl)
+ self.owner = kwargs.get('owner', self.owner)
+ self.version = kwargs.get('version', self.version)
+ self.locrel = kwargs.get('locrel', self.locrel)
+ self.adapter = kwargs.get('adapter', self.adapter)
+ self.stealthlvl = kwargs.get('stealthlvl', self.stealthlvl)
+ self.disclaimer = kwargs.get('disclaimer')
+ self.help = kwargs.get('help')
+ self.appendelements(kwargs.get('sets'))
+ self.appendelements(kwargs.get('input'))
+ self.appendelements(kwargs.get('output'))
+ self.appendelements(kwargs.get('properties'))
+
+ def appendelement(self, other):
+ if isinstance(other, TransformSet):
+ self.sets += other
+ elif isinstance(other, TransformProperty):
+ self.properties += other
+ elif isinstance(other, InputConstraint) or isinstance(other, InputEntity):
+ self.input += other
+ elif isinstance(other, OutputEntity):
+ self.output += other
+
+ def removeelement(self, other):
+ if isinstance(other, TransformSet):
+ self.sets -= other
+ if isinstance(other, TransformProperty):
+ self.properties -= other
+ elif isinstance(other, InputConstraint) or isinstance(other, InputEntity):
+ self.input -= other
+ elif isinstance(other, OutputEntity):
+ self.output -= other
+
+
+class BuiltInTransformSets(object):
+ ConvertToDomain = "Convert to Domain"
+ DomainsUsingMXNS = "Domains using MX NS"
+ FindOnWebpage = "Find on webpage"
+ RelatedEmailAddresses = "Related Email addresses"
+ DNSFromDomain = "DNS from Domain"
+ EmailAddressesFromDomain = "Email addresses from Domain"
+ IPOwnerDetail = "IP owner detail"
+ ResolveToIP = "Resolve to IP"
+ DNSFromIP = "DNS from IP"
+ EmailAddressesFromPerson = "Email addresses from Person"
+ InfoFromNS = "Info from NS"
+ DomainFromDNS = "Domain From DNS"
+ FilesAndDocumentsFromDomain = "Files and Documents from Domain"
+ LinksInAndOutOfSite = "Links in and out of site"
+ DomainOwnerDetail = "Domain owner detail"
+ FilesAndDocumentsFromPhrase = "Files and Documents from Phrase"
+
+
+@XMLAttribute(name='name')
+class TransformSet(MaltegoElement):
+
+ def __init__(self, name):
+ super(MaltegoElement, self).__init__('Set')
+ self.name = name
+
+
+@XMLAttribute(name='max', type=XSAttributeType.Integer, default=1)
+@XMLAttribute(name='min', type=XSAttributeType.Integer, default=1)
+@XMLAttribute(name='type')
+class InputConstraint(MaltegoElement):
+ def __init__(self, type, **kwargs):
+ super(InputConstraint, self).__init__('Entity')
+ self.type = type
+ self.min = kwargs.get('min', self.min)
+ self.max = kwargs.get('max', self.max)
+
+
+class OutputEntity(InputConstraint):
+ pass
+
+
+class InputEntity(InputConstraint):
+ pass
+
+
+class PropertyType(object):
+ String = 'string'
+ Boolean = 'boolean'
+ Integer = 'int'
+
+
+@XMLSubElement(name='DefaultValue', propname='defaultvalue')
+@XMLSubElement(name='SampleValue', propname='samplevalue', default='')
+@XMLAttribute(name='abstract', type=XSAttributeType.Bool, default=False)
+@XMLAttribute(name='description', default='')
+@XMLAttribute(name='displayName', propname='displayname')
+@XMLAttribute(name='hidden', type=XSAttributeType.Bool, default=False)
+@XMLAttribute(name='name')
+@XMLAttribute(name='nullable', type=XSAttributeType.Bool, default=False)
+@XMLAttribute(name='readonly', type=XSAttributeType.Bool, default=False)
+@XMLAttribute(name='popup', type=XSAttributeType.Bool, default=False)
+@XMLAttribute(name='type', default=PropertyType.String)
+@XMLAttribute(name='visibility', default='public')
+class TransformProperty(MaltegoElement):
+
+ def __init__(self, name, default, displayname, description, **kwargs):
+ super(TransformProperty, self).__init__("Property")
+ self.name = name
+ self.displayname = displayname
+ self.defaultvalue = default
+ self.description = description
+ self.abstract = kwargs.get('abstract', self.abstract)
+ self.samplevalue = kwargs.get('sample', self.samplevalue)
+ self.hidden = kwargs.get('hidden', self.hidden)
+ self.nullable = kwargs.get('nullable', self.nullable)
+ self.popup = kwargs.get('popup', self.popup)
+ self.readonly = kwargs.get('readonly', self.readonly)
+ self.type = kwargs.get('type', self.type)
+ self.visibility = kwargs.get('visibility', self.visibility)
+
+
+@XMLAttribute(name='name')
+@XMLAttribute(name='popup', type=XSAttributeType.Bool, default=False)
+@XMLAttribute(name='type', default=PropertyType.String)
+class TransformPropertySetting(MaltegoElement):
+
+ def __init__(self, name, value, **kwargs):
+ super(TransformPropertySetting, self).__init__("Property")
+ self.name = name
+ self.text = value
+ self.popup = kwargs.get('popup', self.popup)
+ self.type = kwargs.get('type', self.type)
+
+
+def CmdLineTransformProperty(cmd=''):
+ return TransformProperty(
+ 'transform.local.command',
+ cmd,
+ 'Command line',
+ 'The command to execute for this transform'
+ )
+
+
+def CmdLineTransformPropertySetting(cmd=''):
+ return TransformPropertySetting(
+ 'transform.local.command',
+ cmd
+ )
+
+
+def CmdParmTransformProperty(params=''):
+ return TransformProperty(
+ 'transform.local.parameters',
+ params,
+ 'Command parameters',
+ 'The parameters to pass to the transform command'
+ )
+
+
+def CmdParmTransformPropertySetting(params=''):
+ return TransformPropertySetting(
+ 'transform.local.parameters',
+ params
+ )
+
+
+def CmdCwdTransformProperty(cwd=''):
+ return TransformProperty(
+ 'transform.local.working-directory',
+ cwd,
+ 'Working directory',
+ 'The working directory used when invoking the executable',
+ sample_val='/'
+ )
+
+
+def CmdCwdTransformPropertySetting(cwd=''):
+ return TransformPropertySetting(
+ 'transform.local.working-directory',
+ cwd
+ )
+
+
+def CmdDbgTransformProperty(dbg=False):
+ return TransformProperty(
+ 'transform.local.debug',
+ str(dbg).lower(),
+ 'Show debug info',
+ "When this is set, the transform's text output will be printed to the output window",
+ sample_val=False,
+ type=PropertyType.Boolean
+ )
+
+
+def CmdDbgTransformPropertySetting(dbg=False):
+ return TransformPropertySetting(
+ 'transform.local.debug',
+ str(dbg).lower(),
+ type=PropertyType.Boolean
+ )
+
+
+@XMLAttribute(name='enabled', type=XSAttributeType.Bool, default=True)
+@XMLAttribute(name='disclaimerAccepted', propname='accepted', type=XSAttributeType.Bool, default=False)
+@XMLAttribute(name='showHelp', propname='show', type=XSAttributeType.Bool, default=True)
+@XMLSubElement(name='Properties', propname='properties', type=XSSubElementType.List)
+class TransformSettings(MaltegoElement):
+
+ def __init__(self, **kwargs):
+ super(TransformSettings, self).__init__(self.__class__.__name__)
+ self.enabled = kwargs.get('enabled', self.enabled)
+ self.accepted = kwargs.get('accepted', self.accepted)
+ self.show = kwargs.get('show', self.show)
+ self.appendelements(kwargs.get('properties'))
+
+ def appendelement(self, other):
+ if isinstance(other, TransformPropertySetting):
+ self.properties += other
+
+ def removeelement(self, other):
+ if isinstance(other, TransformPropertySetting):
+ self.properties -= other
\ No newline at end of file
--- /dev/null
+#!/usr/bin/env python
+
+from message import Entity, EntityField, EntityFieldType
+
+__author__ = 'Nadeem Douba'
+__copyright__ = 'Copyright 2012, Canari Project'
+__credits__ = []
+
+__license__ = 'GPL'
+__version__ = '0.1'
+__maintainer__ = 'Nadeem Douba'
+__email__ = 'ndouba@gmail.com'
+__status__ = 'Development'
+
+__all__ = [
+ 'Device',
+ 'BuiltWithTechnology',
+ 'Domain',
+ 'DNSName',
+ 'MXRecord',
+ 'NSRecord',
+ 'IPv4Address',
+ 'Netblock',
+ 'AS',
+ 'Website',
+ 'URL',
+ 'Phrase',
+ 'Document',
+ 'Person',
+ 'EmailAddress',
+ 'Twit',
+ 'Affiliation',
+ 'AffiliationBebo',
+ 'AffiliationFacebook',
+ 'AffiliationFlickr',
+ 'AffiliationLinkedin',
+ 'AffiliationMySpace',
+ 'AffiliationOrkut',
+ 'AffiliationSpock',
+ 'AffiliationTwitter',
+ 'AffiliationZoominfo',
+ 'AffiliationWikiEdit',
+ 'Location',
+ 'PhoneNumber',
+ 'Banner',
+ 'Port',
+ 'Service',
+ 'Vuln',
+ 'Webdir',
+ 'WebTitle'
+]
+
+
+class Device(Entity):
+ pass
+
+
+class BuiltWithTechnology(Entity):
+ pass
+
+
+@EntityField(name='fqdn', displayname='Domain Name')
+@EntityField(name='whois-info', propname='whoisinfo', displayname='WHOIS Info')
+class Domain(Entity):
+ pass
+
+
+@EntityField(name='fqdn', displayname='DNS Name')
+class DNSName(Entity):
+ pass
+
+
+@EntityField(name='fqdn', displayname='MX Record')
+@EntityField(name='mxrecord.priority', propname='mxpriority', type=EntityFieldType.Integer)
+class MXRecord(Entity):
+ pass
+
+
+@EntityField(name='fqdn', displayname='NS Record')
+class NSRecord(Entity):
+ pass
+
+
+@EntityField(name='ipv4-address', propname='ipv4address', displayname='IP Address')
+@EntityField(name='ipaddress.internal', propname='internal', displayname='Internal', type=EntityFieldType.Bool)
+class IPv4Address(Entity):
+ pass
+
+
+@EntityField(name='ipv4-range', propname='ipv4range', displayname='IP Range')
+class Netblock(Entity):
+ pass
+
+
+@EntityField(name='as.number', propname='number', displayname='AS Number', type=EntityFieldType.Integer)
+class AS(Entity):
+ pass
+
+
+@EntityField(name='http', displayname='HTTP Ports')
+@EntityField(name='https', displayname='HTTPS Ports')
+@EntityField(name='servertype', displayname='Server Banner')
+@EntityField(name='URLS', propname='urls', displayname='URLs')
+class Website(Entity):
+ pass
+
+
+@EntityField(name='fqdn', displayname='Website')
+@EntityField(name='website.ssl-enabled', propname='ssl', displayname='SSL Enabled', type=EntityFieldType.Bool)
+@EntityField(name='ports', displayname='Ports')
+class URL(Entity):
+ pass
+
+
+@EntityField(name='text', displayname='Text')
+class Phrase(Entity):
+ pass
+
+
+@EntityField(name='title', displayname='Title')
+@EntityField(name='document.meta-data', propname='metadata', displayname='Meta-Data')
+@EntityField(name='url', displayname='URL')
+class Document(Entity):
+ pass
+
+
+@EntityField(name='person.fullname', propname='fullname', displayname='Full Name')
+@EntityField(name='person.firstnames', propname='firstnames', displayname='First Names')
+@EntityField(name='person.lastname', propname='lastname', displayname='Surname')
+class Person(Entity):
+ pass
+
+
+@EntityField(name='email', displayname='Email Address')
+class EmailAddress(Entity):
+ pass
+
+
+@EntityField(name='twit.name', propname='name', displayname='Twit')
+@EntityField(name='id', displayname='Twit ID')
+@EntityField(name='author', displayname='Author')
+@EntityField(name='author_uri', propname='authoruri', displayname='AUthor URI')
+@EntityField(name='content', displayname='Content')
+@EntityField(name='imglink', displayname='Image Link')
+@EntityField(name='pubdate', displayname='Date published')
+@EntityField(name='title', displayname='Title')
+class Twit(Entity):
+ pass
+
+
+@EntityField(name='person.name', propname='name', displayname='Name')
+@EntityField(name='affiliation.uid', propname='uid', displayname='UID')
+@EntityField(name='affiliation.network', propname='network', displayname='Network')
+@EntityField(name='affiliation.profile-url', propname='profileurl', displayname='Profile URL')
+class Affiliation(Entity):
+ pass
+
+
+class AffiliationBebo(Affiliation):
+ pass
+
+
+class AffiliationFacebook(Affiliation):
+ name = "affiliation.Facebook"
+
+
+class AffiliationFlickr(Affiliation):
+ name = "affiliation.Flickr"
+
+
+class AffiliationLinkedin(Affiliation):
+ pass
+
+
+class AffiliationMySpace(Affiliation):
+ pass
+
+
+class AffiliationOrkut(Affiliation):
+ pass
+
+
+class AffiliationSpock(Affiliation):
+ pass
+
+
+@EntityField(name='twitter.number', propname='number', displayname='Twitter Number')
+@EntityField(name='twitter.screen-name', propname='number', displayname='Screen Name')
+@EntityField(name='twitter.friendcount', propname='number', displayname='Friend Count')
+@EntityField(name='twitter.fullname', propname='fullname', displayname='Real Name')
+class AffiliationTwitter(Affiliation):
+ name = "affiliation.Twitter"
+
+
+class AffiliationZoominfo(Affiliation):
+ pass
+
+
+class AffiliationWikiEdit(Affiliation):
+ pass
+
+
+@EntityField(name='location.name', propname='name', displayname='Name')
+@EntityField(name='country', displayname='Country')
+@EntityField(name='city', displayname='City')
+@EntityField(name='location.area', propname='area', displayname='Area')
+@EntityField(name='countrycode', displayname='Country Code')
+@EntityField(name='longitude', displayname='Longitude')
+@EntityField(name='latitude', displayname='Latitude')
+class Location(Entity):
+ pass
+
+
+@EntityField(name='phonenumber', displayname='Phone Number')
+@EntityField(name='phonenumber.countrycode', propname='countrycode', displayname='Country Code')
+@EntityField(name='phonenumber.citycode', propname='citycode', displayname='City Code')
+@EntityField(name='phonenumber.areacode', propname='areacode', displayname='Area Code')
+@EntityField(name='phonenumber.lastnumbers', propname='lastnumbers', displayname='Last Digits')
+class PhoneNumber(Entity):
+ pass
+
+
+class Banner(Entity):
+ pass
+
+
+class Port(Entity):
+ pass
+
+
+class Service(Entity):
+ pass
+
+
+class Vuln(Entity):
+ pass
+
+
+class Webdir(Entity):
+ pass
+
+
+@EntityField(name='title', displayname='Title')
+class WebTitle(Entity):
+ pass
\ No newline at end of file
--- /dev/null
+#!/usr/bin/env python
+
+from ..xmltools.oxml import ElementTree, Element
+
+from cStringIO import StringIO
+from copy import deepcopy
+
+
+__author__ = 'Nadeem Douba'
+__copyright__ = 'Copyright 2012, Canari Project'
+__credits__ = []
+
+__license__ = 'GPL'
+__version__ = '0.1'
+__maintainer__ = 'Nadeem Douba'
+__email__ = 'ndouba@gmail.com'
+__status__ = 'Development'
+
+
+__all__ = [
+ 'HTML',
+ 'TABLE',
+ 'TR',
+ 'TD',
+ 'A',
+ 'IMG',
+ 'Table'
+]
+
+
+class HTML(Element, object):
+
+ def __init__(self, tag='html', attrib={}, **extra):
+ attrib = attrib.copy()
+ attrib.update(extra)
+ super(HTML, self).__init__(tag, attrib)
+
+ def __add__(self, other):
+ newobj = deepcopy(self)
+ newobj.append(other)
+ return newobj
+
+ def __iadd__(self, other):
+ self.append(other)
+ return self
+
+ def __sub__(self, other):
+ self.remove(other)
+ newobj = deepcopy(self)
+ self.append(other)
+ return newobj
+
+ def __isub__(self, other):
+ self.remove(other)
+ return self
+
+ def __str__(self):
+ sio = StringIO()
+ ElementTree(self).write(sio)
+ return sio.getvalue()
+
+
+class TABLE(HTML):
+
+ def __init__(self, title="GENERAL INFORMATION", colspan="2", **kwargs):
+ super(TABLE, self).__init__(
+ "table",
+ attrib={
+ 'width' : '100%',
+ 'border' : '1',
+ 'rules' : 'cols',
+ 'frame' : 'box',
+ 'cellpadding' : '2'
+ }
+ )
+
+ tr = TR()
+ self.append(tr)
+ tr.append(TD(title, colspan=colspan, css_class=TD.ONE))
+
+ for i in kwargs:
+ self.set(i, str(kwargs[i]) if not isinstance(kwargs[i], basestring) else kwargs[i])
+
+class TR(HTML):
+
+ def __init__(self):
+ super(TR, self).__init__('tr')
+
+
+class A(HTML):
+
+ def __init__(self, label, href, **kwargs):
+ attrib = { 'href' : href }
+ attrib.update(kwargs)
+ super(A, self).__init__(
+ 'a',
+ attrib=attrib
+ )
+ self.text = label
+
+
+class IMG(HTML):
+
+ def __init__(self, src, **kwargs):
+ attrib = { 'src' : src }
+ attrib.update(kwargs)
+
+ super(IMG, self).__init__(
+ 'img',
+ attrib=attrib
+ )
+
+class TD(HTML):
+
+ ONE = "one"
+ TWO = "two"
+ THREE = "three"
+ VALUE = "value"
+
+ def __init__(self, value, css_class=TWO, align="center", **kwargs):
+ super(TD, self).__init__(
+ 'td',
+ attrib={
+ 'class' : css_class,
+ 'align' : align,
+ }
+ )
+ self.text = str(value) if not isinstance(value, basestring) else value
+
+ for i in kwargs:
+ self.set(i, str(kwargs[i]) if not isinstance(kwargs[i], basestring) else kwargs[i])
+
+
+class Table(object):
+
+ def __init__(self, columns, title='GENERAL INFORMATION'):
+ self._rows = []
+ self._title = title
+ self._rows.append([ TD(c, TD.THREE) for c in columns ])
+
+ def addrow(self, columns):
+ self._rows.append([ TD(c) for c in columns ])
+
+ def __str__(self):
+ self.table = TABLE(self._title, colspan=len(self._rows[0]))
+ for r in self._rows:
+ tr = TR()
+ c = tr.getchildren()
+ c += r
+ self.table += tr
+ return str(self.table)
--- /dev/null
+#!/usr/bin/env python
+
+from ..xmltools.oxml import *
+
+from numbers import Number
+from re import sub
+
+
+__author__ = 'Nadeem Douba'
+__copyright__ = 'Copyright 2012, Canari Project'
+__credits__ = []
+
+__license__ = 'GPL'
+__version__ = '0.1'
+__maintainer__ = 'Nadeem Douba'
+__email__ = 'ndouba@gmail.com'
+__status__ = 'Development'
+
+__all__ = [
+ 'Message',
+ 'MaltegoElement',
+ 'MaltegoMessage',
+ 'MaltegoTransformExceptionMessage',
+ 'MaltegoException',
+ 'MaltegoTransformResponseMessage',
+ 'Label',
+ 'MatchingRule',
+ 'Field',
+ 'StringEntityField',
+ 'EnumEntityField',
+ 'IntegerEntityField',
+ 'BooleanEntityField',
+ 'FloatEntityField',
+ 'LongEntityField',
+ 'EntityFieldType',
+ 'EntityField',
+ 'UIMessageType',
+ 'UIMessage',
+ 'Entity',
+]
+
+
+class Message(ElementTree):
+ pass
+
+
+class MaltegoElement(Element):
+ pass
+
+
+class MaltegoMessage(MaltegoElement):
+
+ def __init__(self, message):
+ super(MaltegoMessage, self).__init__(self.__class__.__name__)
+ self.append(message)
+
+
+@XMLSubElement(name='Exceptions', propname='exceptions', type=XSSubElementType.List)
+class MaltegoTransformExceptionMessage(MaltegoElement):
+
+ def __init__(self, **kwargs):
+ super(MaltegoTransformExceptionMessage, self).__init__(self.__class__.__name__)
+ self.appendelements(kwargs.get('exceptions'))
+
+ def appendelement(self, exception):
+ if isinstance(exception, MaltegoException):
+ self.exceptions += exception
+ else:
+ self.exceptions += MaltegoException(str(exception))
+
+
+class MaltegoException(MaltegoElement, Exception):
+
+ def __init__(self, message):
+ super(MaltegoException, self).__init__('Exception')
+ Exception.__init__(self, message)
+ self.text = message if not isinstance(message, basestring) else message
+
+
+@XMLSubElement(name='UIMessages', propname='uimessages', type=XSSubElementType.List)
+@XMLSubElement(name='Entities', propname='entities', type=XSSubElementType.List)
+class MaltegoTransformResponseMessage(MaltegoElement):
+
+ def __init__(self, **kwargs):
+ super(MaltegoTransformResponseMessage, self).__init__(self.__class__.__name__)
+ self.appendelements(kwargs.get('entities'))
+ self.appendelements(kwargs.get('uimessages'))
+
+ def appendelement(self, other):
+ if isinstance(other, Entity):
+ self.entities += other
+ elif isinstance(other, UIMessage):
+ self.uimessages += other
+
+ def removeelement(self, other):
+ if isinstance(other, Entity):
+ self.entities -= other
+ elif isinstance(other, UIMessage):
+ self.uimessages -= other
+
+
+@XMLAttribute(name='Name', propname='name')
+@XMLAttribute(name='Type', propname='type', default='text/text')
+@XMLSubElement(name='CDATA', propname='cdata')
+class Label(MaltegoElement):
+
+ def __init__(self, name, value, **kwargs):
+ super(Label, self).__init__(self.__class__.__name__)
+ self.name = name
+ self.type = kwargs.get('type', self.type)
+
+ if self.type == 'text/html':
+ self.cdata = value
+ else:
+ self.text = str(value) if not isinstance(value, basestring) else value
+
+
+class MatchingRule(object):
+ Strict = "strict"
+ Loose = "loose"
+
+
+@XMLAttribute(name='Name', propname='name')
+@XMLAttribute(name='DisplayName', propname='displayname')
+@XMLAttribute(name='MatchingRule', propname='matchingrule', default=MatchingRule.Strict)
+class Field(MaltegoElement):
+
+ def __init__(self, name, value, **kwargs):
+ super(Field, self).__init__(self.__class__.__name__)
+ self.name = name
+ self.matchingrule = kwargs.get('matchingrule', self.matchingrule)
+ self.displayname = kwargs.get('displayname', name.title())
+ self.text = str(value) if not isinstance(value, basestring) else value
+
+
+class StringEntityField(object):
+
+ def __init__(self, name, displayname=None, decorator=None, matchingrule=MatchingRule.Strict):
+ self.name = name
+ self.displayname = name.title() if displayname is None else displayname
+ self.decorator = decorator
+ self.matchingrule = matchingrule
+
+ def _find(self, obj):
+ for f in obj.fields:
+ if f.name == self.name:
+ return f
+ return None
+
+ def __get__(self, obj, objtype):
+ o = self._find(obj)
+ return o.text if o is not None else None
+
+ def __set__(self, obj, val):
+ f = self._find(obj)
+ if not isinstance(val, basestring) and val is not None:
+ val = str(val)
+ if f is None and val is not None:
+ f = Field(self.name, val, displayname=self.displayname, matchingrule=self.matchingrule)
+ obj += f
+ elif f is not None and val is None:
+ obj -= f
+ else:
+ f.text = val
+ if self.decorator is not None:
+ self.decorator(obj, val)
+
+
+class EnumEntityField(StringEntityField):
+
+ def __init__(self, name, displayname=None, choices=[], decorator=None):
+ self.choices = [ str(c) if not isinstance(c, basestring) else c for c in choices ]
+ super(EnumEntityField, self).__init__(name, displayname, decorator)
+
+ def __set__(self, obj, val):
+ val = str(val) if not isinstance(val, basestring) else val
+ if val not in self.choices:
+ raise ValueError('Expected one of %s (got %s instead)' % (self.choices, val))
+ super(EnumEntityField, self).__set__(obj, val)
+
+
+class IntegerEntityField(StringEntityField):
+
+ def __get__(self, obj, objtype):
+ return int(super(IntegerEntityField, self).__get__(obj, objtype))
+
+ def __set__(self, obj, val):
+ if not isinstance(val, Number):
+ raise TypeError('Expected an instance of int (got %s instance instead)' % type(val).__name__)
+ super(IntegerEntityField, self).__set__(obj, val)
+
+
+class BooleanEntityField(StringEntityField):
+
+ def __get__(self, obj, objtype):
+ return super(BooleanEntityField, self).__get__(obj, objtype) == 'true'
+
+ def __set__(self, obj, val):
+ if not isinstance(val, bool):
+ raise TypeError('Expected an instance of bool (got %s instance instead)' % type(val).__name__)
+ super(BooleanEntityField, self).__set__(obj, str(val).lower())
+
+
+class FloatEntityField(StringEntityField):
+
+ def __get__(self, obj, objtype):
+ return float(super(FloatEntityField, self).__get__(obj, objtype))
+
+ def __set__(self, obj, val):
+ if not isinstance(val, Number):
+ raise TypeError('Expected an instance of float (got %s instance instead)' % type(val).__name__)
+ super(FloatEntityField, self).__set__(obj, val)
+
+
+class LongEntityField(StringEntityField):
+
+ def __get__(self, obj, objtype):
+ return long(super(LongEntityField, self).__get__(obj, objtype))
+
+ def __set__(self, obj, val):
+ if not isinstance(val, Number):
+ raise TypeError('Expected an instance of float (got %s instance instead)' % type(val).__name__)
+ super(LongEntityField, self).__set__(obj, val)
+
+
+class EntityFieldType(object):
+ String = StringEntityField
+ Integer = IntegerEntityField
+ Long = LongEntityField
+ Float = FloatEntityField
+ Bool = BooleanEntityField
+ Enum = EnumEntityField
+
+
+class EntityField(object):
+
+ def __init__(self, **kwargs):
+ self.name = kwargs.get('name')
+ if self.name is None:
+ raise ValueError("Keyword argument 'name' is required.")
+ self.property = kwargs.get('propname', sub('[^\w]+', '_', self.name))
+ self.displayname = kwargs.get('displayname', self.name.title())
+ self.type = kwargs.get('type', EntityFieldType.String)
+ self.required = kwargs.get('required', False)
+ self.choices = kwargs.get('choices')
+ self.matchingrule = kwargs.get('matchingrule', MatchingRule.Strict)
+ self.decorator = kwargs.get('decorator')
+
+ def __call__(self, cls):
+ if self.type is EntityFieldType.Enum:
+ setattr(cls, self.property, self.type(self.name, self.displayname, self.choices, self.decorator))
+ else:
+ setattr(cls, self.property, self.type(self.name, self.displayname, self.decorator))
+ return cls
+
+
+class UIMessageType(object):
+ Fatal = "FatalError"
+ Partial = "PartialError"
+ Inform = "Inform"
+ Debug = "Debug"
+
+
+@XMLAttribute(name='MessageType', propname='type', default=UIMessageType.Inform)
+class UIMessage(MaltegoElement):
+
+ def __init__(self, message, **kwargs):
+ super(UIMessage, self).__init__(self.__class__.__name__)
+ self.type = kwargs.get('type', self.type)
+ self.text = str(message) if not isinstance(message, basestring) else message
+
+
+@XMLSubElement(name='Value', propname='value')
+@XMLSubElement(name='Weight', propname='weight', type=XSSubElementType.Integer, default=1)
+@XMLSubElement(name='IconURL', propname='iconurl')
+@XMLSubElement(name='AdditionalFields', propname='fields', type=XSSubElementType.List)
+@XMLSubElement(name='DisplayInformation', propname='labels', type=XSSubElementType.List)
+@XMLSubElement(name='Value', propname='value')
+@XMLAttribute(name='Type', propname='type')
+class Entity(MaltegoElement):
+
+ namespace = 'maltego'
+ name = None
+
+ def __init__(self, value, **kwargs):
+ super(Entity, self).__init__("Entity")
+ type = kwargs.get('type', None)
+ if type is None:
+ self.type = '%s.%s' % (self.namespace, self.__class__.__name__ if self.name is None else self.name)
+ self.value = value
+ self.weight = kwargs.get('weight', self.weight)
+ self.iconurl = kwargs.get('iconurl', self.iconurl)
+ self.appendelements(kwargs.get('fields'))
+ self.appendelements(kwargs.get('labels'))
+
+ def appendelement(self, other):
+ if isinstance(other, Field):
+ display_name = other.get('DisplayName')
+ if display_name is None:
+ name = other.get('Name')
+ if name in self.fields.keys():
+ other.set('DisplayName', self.fields[name])
+ else:
+ other.set('DisplayName', name.title())
+ self.fields += other
+ elif isinstance(other, Label):
+ self.labels += other
+
+ def removeelement(self, other):
+ if isinstance(other, Field):
+ self.fields -= other
+ elif isinstance(other, Label):
+ self.labels -= other
+
+
+
+
+
--- /dev/null
+#!/usr/bin/env python
+
+from message import MaltegoMessage, Message, MaltegoTransformExceptionMessage, MaltegoException
+
+from signal import signal, SIGTERM, SIGINT
+from sys import exit, argv, stderr, stdout
+from cStringIO import StringIO
+from re import split, sub
+
+
+__author__ = 'Nadeem Douba'
+__copyright__ = 'Copyright 2012, Sploitego Project'
+__credits__ = []
+
+__license__ = 'GPL'
+__version__ = '0.1'
+__maintainer__ = 'Nadeem Douba'
+__email__ = 'ndouba@gmail.com'
+__status__ = 'Development'
+
+__all__ = [
+ 'onterminate',
+ 'message',
+ 'croak',
+ 'parseargs',
+ 'debug',
+ 'progress'
+]
+
+
+def onterminate(func):
+ """Register a signal handler to execute when Maltego forcibly terminates the transform."""
+ signal(SIGTERM, func)
+ signal(SIGINT, func)
+
+
+def message(m, fd=stdout):
+ """Write a MaltegoMessage to stdout and exit successfully"""
+ sio = StringIO()
+ m.entities
+ Message(MaltegoMessage(m)).write(sio)
+ v = sio.getvalue()
+ # Get rid of those nasty unicode 32 characters
+ fd.write(sub(r'(&#\d{5};){2}', r'', v))
+ exit(0)
+
+
+def croak(error_msg):
+ """Throw an exception in the Maltego GUI containing error_msg."""
+ Message(MaltegoMessage(MaltegoTransformExceptionMessage(exceptions=MaltegoException(error_msg)))).write()
+ exit(0)
+
+
+def parseargs(args=argv):
+ """Parse arguments for Maltego local transforms."""
+
+ if len(args) < 3:
+ stderr.write('usage: %s <transform> [param1 ... paramN] <value> [field1=value1...#fieldN=valueN]\n' % args[0])
+ exit(-1)
+
+ arg_script = args[1]
+ arg_field = args[-1] if '=' in args[-1] else None
+ arg_value = args[-1] if arg_field is None else args[-2]
+ arg_param = []
+
+ if arg_field is None and len(args) > 3:
+ arg_param = list(args[2:-1])
+ elif arg_field is not None and len(args) > 4:
+ arg_param = list(args[2:-2])
+
+ fields = {}
+ if arg_field is not None:
+ fs = split(r'(?<=[^\\])#', arg_field)
+ if fs is not None:
+ fields = dict(map(lambda x: x.split('=', 1), fs))
+
+ return arg_script, arg_param, arg_value, fields
+
+
+def debug(*args):
+ """Send debug messages to the Maltego console."""
+ for i in args:
+ stderr.write('D:%s\n' % str(i))
+
+
+def progress(i):
+ """Send a progress report to the Maltego console."""
+ stderr.write('%%%d\n' % min(max(i, 0), 100))
\ No newline at end of file
--- /dev/null
+#!/usr/bin/env python
+
+from pkg_resources import resource_filename
+
+
+__author__ = 'Nadeem Douba'
+__copyright__ = 'Copyright 2012, Sploitego Project'
+__credits__ = []
+
+__license__ = 'GPL'
+__version__ = '0.1'
+__maintainer__ = 'Nadeem Douba'
+__email__ = 'ndouba@gmail.com'
+__status__ = 'Development'
+
+
+etc = 'canari.resources.etc'
+
+
+def imageicon(pkg, name):
+ return 'file://%s' % resource_filename(pkg, name)
+
+
+def imagepath(pkg, name):
+ return '%s' % resource_filename(pkg, name)
+
+
+# etc
+conf = resource_filename(etc, 'canari.conf')
\ No newline at end of file
--- /dev/null
+#!/usr/bin/env python
+
+__author__ = 'Nadeem Douba'
+__copyright__ = 'Copyright 2012, Sploitego Project'
+__credits__ = []
+
+__license__ = 'GPL'
+__version__ = '0.1'
+__maintainer__ = 'Nadeem Douba'
+__email__ = 'ndouba@gmail.com'
+__status__ = 'Development'
+
+__all__ = [
+ 'images',
+ 'etc',
+ 'template'
+]
\ No newline at end of file
--- /dev/null
+#!/usr/bin/env python
+
+__author__ = 'Nadeem Douba'
+__copyright__ = 'Copyright 2012, Sploitego Project'
+__credits__ = []
+
+__license__ = 'GPL'
+__version__ = '0.1'
+__maintainer__ = 'Nadeem Douba'
+__email__ = 'ndouba@gmail.com'
+__status__ = 'Development'
\ No newline at end of file
--- /dev/null
+[default]
+# Additional config files that should be read to merge with the current config
+configs =
+
+# Additional exec paths (comma separated)
+path = ${PATH},/usr/local/bin,/opt/local/bin
\ No newline at end of file
--- /dev/null
+# README - ${project}
+
+Welcome to Sploitego. You might be wondering what all these files are about. Before you can use the power of
+```mtginstall``` you needed to create a transform package and that's exactly what you did here! I've given you a
+directory structure to use in the following manner:
+
+* ```src/${package}``` directory is where all your stuff goes in terms of auxiliary modules that you may need for your
+ modules
+* ```src/${package}/transforms``` directory is where all your transform modules should be placed. An example
+ ```helloworld``` transform is there for your viewing pleasure.
+* ```src/${package}/transforms/common``` directory is where you can put some common code for your transforms like result
+ parsing, entities, etc.
+* ```src/${package}/transforms/common/entities.py``` is where you define your custom entities. Take a look at the
+ examples provided if you want to play around with custom entities.
+* ```maltego/``` is where you can store your Maltego entity exports.
+
+If you're going to add a new transform in the transforms directory, remember to update the ```__all__``` variable in
+```src/${package}/transforms/__init__.py```. Otherwise, ```mtginstall``` won't attempt to install the transform.
+Alternatively, ```mtgtransgen <transform name>``` can be used within the ```src/${package}/transforms``` directory to
+generate a transform module and have it automatically added to the ```__init__.py``` file, like so:
+
+To test your transform, simply ```cd``` into the src directory and run ```mtgdebug```, like so:
+
+```bash
+$$ mtgdebug ${project}.transforms.helloworld Phil
+%50
+D:This was pointless!
+%100
+`- MaltegoTransformResponseMessage:
+ `- Entities:
+ `- Entity: {'Type': 'test.MyTestEntity'}
+ `- Value: Hello Phil!
+ `- Weight: 1
+ `- AdditionalFields:
+ `- Field: 2 {'DisplayName': 'Field 1', 'Name': 'test.field1', 'MatchingRule': 'strict'}
+ `- Field: test {'DisplayName': 'Field N', 'Name': 'test.fieldN', 'MatchingRule': 'strict'}
+```
+
+Cool right? If you have any further questions don't hesitate to drop us a line;)
+
+Have fun!
\ No newline at end of file
--- /dev/null
+#!/usr/bin/env python
+
+__author__ = '${author}'
+__copyright__ = 'Copyright ${year}, ${project} Project'
+__credits__ = []
+
+__license__ = 'GPL'
+__version__ = '0.1'
+__maintainer__ = '${author}'
+__email__ = 'whereim@onthe.net'
+__status__ = 'Development'
\ No newline at end of file
--- /dev/null
+#!/usr/bin/env python
+
+__author__ = 'Nadeem Douba'
+__copyright__ = 'Copyright 2012, Sploitego Project'
+__credits__ = []
+
+__license__ = 'GPL'
+__version__ = '0.1'
+__maintainer__ = 'Nadeem Douba'
+__email__ = 'ndouba@gmail.com'
+__status__ = 'Development'
\ No newline at end of file
--- /dev/null
+# This was generated by running: $command
+# If you'd like to override any of the default settings for this package just go ahead and change em below!
+
+[default]
+# Additional config files that should be read to merge with the current config
+configs = $config
+
+path = $path
\ No newline at end of file
--- /dev/null
+[section1]
+
+option1 = this, is, a, list
+
+option2 = this\, is\, a\, comma-separated string
+
+
+[section2]
+
+etc = etc
\ No newline at end of file
--- /dev/null
+#!/usr/bin/env python
+
+from canari.maltego.message import Entity, EntityField, EntityFieldType, MatchingRule
+
+__author__ = '${author}'
+__copyright__ = 'Copyright ${year}, ${project} Project'
+__credits__ = []
+
+__license__ = 'GPL'
+__version__ = '0.1'
+__maintainer__ = '${author}'
+__email__ = 'whereim@inthe.net'
+__status__ = 'Development'
+
+__all__ = [
+ '${base_entity}',
+ '${entity}'
+]
+
+"""
+DO NOT EDIT:
+The following entity is the base entity type from which all your entities will inherit from. This provides you with the
+default namespace that all your entities will use for their unique entity type in Maltego. For example, ${entity} will
+have an entity type name of ${namespace}.${entity}. When adding a new entity in Maltego, you will have to specify this
+name (${namespace}.${entity}) in the 'Unique entity type' field.
+"""
+class ${base_entity}(Entity):
+ namespace = '${namespace}'
+
+
+"""
+You can specify as many entity fields as you want by just adding an extra @EntityField() decorator to your entities. The
+@EntityField() decorator takes the following parameters:
+ - name: the name of the field without spaces or special characters except for dots ('.') (required)
+ - propname: the name of the object's property used to get and set the value of the field (required, if name contains dots)
+ - displayname: the name of the entity as it appears in Maltego (optional)
+ - type: the data type of the field (optional, default: EntityFieldType.String)
+ - required: whether or not the field's value must be set before sending back the message (optional, default: False)
+ - choices: a list of acceptable field values for this field (optional)
+ - matchingrule: whether or not the field should be loosely or strictly matched (optional, default: MatchingRule.Strict)
+ - decorator: a function that is invoked each and everytime the field's value is set or changed.
+TODO: define as many custom fields and entity types as you wish:)
+"""
+@EntityField(name='${package}.fieldN', propname='fieldN', displayname='Field N', matchingrule=MatchingRule.Loose)
+@EntityField(name='${package}.field1', propname='field1', displayname='Field 1', type=EntityFieldType.Integer)
+class ${entity}(${base_entity}):
+ """
+ Uncomment the line below and comment out the pass if you wish to define a ridiculous entity type name like
+ 'my.fancy.EntityType'
+ """
+ # name = my.fancy.EntityType
+ pass
\ No newline at end of file
--- /dev/null
+#!/usr/bin/env python
+
+from canari.maltego.utils import debug, progress
+from canari.framework import configure #, superuser
+
+__author__ = '${author}'
+__copyright__ = 'Copyright ${year}, <project> Project'
+__credits__ = []
+
+__license__ = 'GPL'
+__version__ = '0.1'
+__maintainer__ = '${author}'
+__email__ = 'whereim@onthe.net'
+__status__ = 'Development'
+
+__all__ = [
+ 'dotransform',
+ 'onterminate'
+]
+
+# Uncomment the line below if the transform needs to run as super-user
+#@superuser
+"""
+TODO: set the appropriate configuration parameters for your transform.
+"""
+@configure(
+ label='TODO: To Something [Hello World]',
+ description='TODO: Returns a Something entity with the phrase "Hello Word!"',
+ uuids=[ 'TODO something.v2.SomethingToPhrase_HelloWorld' ],
+ inputs=[ ( 'TODO: Some Set', SomethingEntity ) ],
+ debug=True
+)
+def dotransform(request, response):
+ """
+ TODO: write your data mining logic below.
+ """
+ return response
+
+
+def onterminate():
+ """
+ TODO: Write your cleanup logic below or delete the onterminate function and remove it from the __all__ variable
+ """
+ pass
\ No newline at end of file
--- /dev/null
+from setuptools import setup, find_packages
+
+setup(
+ name='${package}',
+ author='${author}',
+ version='1.0',
+ author_email='whereim@onthe.net',
+ description='Your description here',
+ license='GPL',
+ packages=find_packages('src'),
+ package_dir={ '' : 'src' },
+ zip_safe=False,
+ package_data={
+ '' : [ '*.gif', '*.png', '*.conf' ] # list of resources
+ },
+ install_requires=[
+ # Name of packages required for easy_install
+ ],
+ dependency_links=[
+ # custom links for the install_requires
+ ]
+)
\ No newline at end of file
--- /dev/null
+#!/usr/bin/env python
+
+from canari.maltego.entities import Person
+from canari.maltego.utils import debug, progress
+from canari.framework import configure #, superuser
+from common.entities import ${entity}
+
+__author__ = '${author}'
+__copyright__ = 'Copyright ${year}, ${project} Project'
+__credits__ = []
+
+__license__ = 'GPL'
+__version__ = '0.1'
+__maintainer__ = '${author}'
+__email__ = 'whereim@onthe.net'
+__status__ = 'Development'
+
+__all__ = [
+ 'dotransform',
+ 'onterminate'
+]
+
+# Uncomment the line below if the transform needs to run as super-user
+#@superuser
+"""
+The @configure decorator tells mtginstall how to install the transform in Maltego. It takes the following parameters:
+ - label: the name of the transform as it appears in the Maltego UI transform selection menu
+ - description: a short description of the transform
+ - uuids: a list of unique transform IDs, one per input type. The order of this list must match that of the
+ inputs parameter. Make sure you account for entity type inheritance in Maltego. For example, if you
+ choose a DNSName entity type as your input type you do not need to specify it again for MXRecord,
+ NSRecord, etc.
+ - inputs: a list of tuples where the first item is the name of the transform set the transform should be part
+ of, and the second item is the input entity type.
+ - debug: Whether or not the debugging window should appear in Maltego's UI when running the transform.
+TODO: set the appropriate configuration parameters for your transform.
+"""
+@configure(
+ label='To ${entity} [Hello World]',
+ description='Returns a ${entity} entity with the phrase "Hello Word!"',
+ uuids=[ '${namespace}.v2.${entity}ToPhrase_HelloWorld' ],
+ inputs=[ ( '${project}', Person ) ],
+ debug=True
+)
+def dotransform(request, response):
+ """
+ The dotransform function is our transform's entry point. The request object has the following properties:
+ - value: a string containing the value of the input entity.
+ - fields: a dictionary of entity field names and their respective values of the input entity.
+ - params: any additional command-line arguments to be passed to the transform.
+ TODO: write your data mining logic below.
+ """
+
+ # Report transform progress
+ progress(50)
+ # Send a debugging message to the Maltego UI console
+ debug('This was pointless!')
+
+ # Create ${entity} entity with value set to 'Hello <request.value>!'
+ e = ${entity}('Hello %s!' % request.value)
+ # Setting field values on the entity
+ e.field1 = 2
+ e.fieldN = 'test'
+ # Update progress
+ progress(100)
+
+ # Add entity to response object
+ response += e
+
+ # Return response for visualization
+ return response
+
+
+"""
+Called if transform interrupted. It's presence is optional; you can remove this function if you don't need to do any
+resource clean up.
+
+TODO: Write your cleanup logic below or delete the onterminate function and remove it from the __all__ variable
+"""
+def onterminate():
+ debug('Caught signal... exiting.')
+ exit(0)
\ No newline at end of file
--- /dev/null
+#!/usr/bin/env python
+
+__author__ = 'Nadeem Douba'
+__copyright__ = 'Copyright 2012, Sploitego Project'
+__credits__ = []
+
+__license__ = 'GPL'
+__version__ = '0.1'
+__maintainer__ = 'Nadeem Douba'
+__email__ = 'ndouba@gmail.com'
+__status__ = 'Development'
+
+
+__all__ = [
+ 'fs',
+ 'wordlist'
+]
\ No newline at end of file
--- /dev/null
+#!/usr/bin/env python
+
+from os import path, name, sep, stat
+from tempfile import gettempdir
+from sys import maxint
+from time import time
+
+if name == 'nt':
+ from win32con import LOCKFILE_EXCLUSIVE_LOCK as LOCK_EX, LOCKFILE_FAIL_IMMEDIATELY as LOCK_NB
+ from win32file import _get_osfhandle, LockFileEx, UnlockFileEx
+ from pywintypes import OVERLAPPED, error as WinIOError
+else:
+ from fcntl import LOCK_EX, LOCK_NB, LOCK_UN, flock
+
+
+__author__ = 'Nadeem Douba'
+__copyright__ = 'Copyright 2012, Sploitego Project'
+__credits__ = []
+
+__license__ = 'GPL'
+__version__ = '0.1'
+__maintainer__ = 'Nadeem Douba'
+__email__ = 'ndouba@gmail.com'
+__status__ = 'Development'
+
+__all__ = [
+ 'cookie',
+ 'flock',
+ 'fsemaphore',
+ 'fmutex',
+ 'ufile',
+ 'age'
+]
+
+
+if name == 'nt':
+ LOCK_SH = 0
+ LOCK_UN = 0
+ __overlapped = OVERLAPPED()
+
+ def flock(file, flags):
+ hfile = _get_osfhandle(file.fileno())
+ try:
+ if flags & LOCK_UN:
+ UnlockFileEx(hfile, 0, -0x10000, __overlapped)
+ else:
+ LockFileEx(hfile, flags, 0, -0x10000, __overlapped)
+ except WinIOError, exc:
+ raise IOError('[Errno %d] %s' % (exc[0], exc[2]))
+
+
+def cookie(name):
+ return sep.join([gettempdir(), name])
+
+
+class fsemaphore(file):
+
+ def __init__(self, name, mode='rb', buffering=-1):
+ super(fsemaphore, self).__init__(name, mode, buffering)
+
+ def lockex(self, nb=False):
+ flags = LOCK_EX
+ if nb:
+ flags |= LOCK_NB
+ flock(self, flags)
+
+ def locksh(self, nb=False):
+ flags = LOCK_SH
+ if nb:
+ flags |= LOCK_NB
+ flock(self, flags)
+
+ def unlock(self, nb=False):
+ flags = LOCK_UN
+ if nb:
+ flags |= LOCK_NB
+ flock(self, flags)
+
+
+class fmutex(fsemaphore):
+
+ def __init__(self, name):
+ super(fmutex, self).__init__(cookie(name), 'wb')
+ self.lockex()
+
+ def __del__(self):
+ self.unlock()
+
+
+class ufile(file):
+
+ def __init__(self, name):
+ if path.exists(name):
+ p, n = path.split(name)
+ n, e = path.splitext(n)
+
+ for i in xrange(2, maxint):
+ name = path.join(p, '%s(%d)%s') % (n, i, e)
+ if not path.exists(name):
+ break
+ super(ufile, self).__init__(name, mode='wb')
+
+
+def age(path):
+ return time() - stat(path).st_mtime
\ No newline at end of file
--- /dev/null
+#!/usr/bin/env python
+
+from zlib import decompress, MAX_WBITS
+from re import findall, search, sub
+from urllib import urlopen
+
+__author__ = 'Nadeem Douba'
+__copyright__ = 'Copyright 2012, Sploitego Project'
+__credits__ = []
+
+__license__ = 'GPL'
+__version__ = '0.1'
+__maintainer__ = 'Nadeem Douba'
+__email__ = 'ndouba@gmail.com'
+__status__ = 'Development'
+
+__all__ = [
+ 'wordlist'
+]
+
+
+def wordlist(uri, match='(.*?)\n+', ignore='^#.*', strip=None):
+ l = []
+ data = urlopen(uri).read()
+ if search('\.gz(ip)?$', uri) is not None:
+ data = decompress(data, 16 + MAX_WBITS)
+ if data:
+ l = findall(match, data)
+ if ignore is not None:
+ l = filter(lambda x: search(ignore, x) is None, l)
+ if strip is not None:
+ l = map(lambda x: sub(strip, '', x), l)
+ return l
+
+
--- /dev/null
+#!/usr/bin/env python
+
+__author__ = 'Nadeem Douba'
+__copyright__ = 'Copyright 2012, Sploitego Project'
+__credits__ = []
+
+__license__ = 'GPL'
+__version__ = '0.1'
+__maintainer__ = 'Nadeem Douba'
+__email__ = 'ndouba@gmail.com'
+__status__ = 'Development'
+
+__all__ = [
+ 'objectify',
+ 'oxml'
+]
\ No newline at end of file
--- /dev/null
+#!/usr/bin/env python
+
+import xml.etree.ElementTree as ET
+from numbers import Number
+from copy import deepcopy
+from pickle import dumps
+from sys import stdout
+from re import sub
+
+__author__ = 'Nadeem Douba'
+__copyright__ = 'Copyright 2012, Canari Project'
+__credits__ = []
+
+__license__ = 'GPL'
+__version__ = '0.1'
+__maintainer__ = 'Nadeem Douba'
+__email__ = 'ndouba@gmail.com'
+__status__ = 'Development'
+
+__all__ = [
+ 'XSStringAttribute',
+ 'XSEnumAttribute',
+ 'XSIntegerAttribute',
+ 'XSBooleanAttribute',
+ 'XSFloatAttribute',
+ 'XSLongAttribute',
+ 'XSAttributeType',
+ 'XMLAttribute',
+ 'XSStringSubElement',
+ 'XSCDataSubElement',
+ 'XSEnumSubElement',
+ 'XSIntegerSubElement',
+ 'XSBooleanSubElement',
+ 'XSFloatSubElement',
+ 'XSLongSubElement',
+ 'XSListSubElement',
+ 'XSSubElementType',
+ 'XMLSubElement',
+ 'ElementTree',
+ 'Element'
+]
+
+
+_e = ET.Element
+_se = ET.SubElement
+_eto = ET.ElementTree
+
+
+class XSStringAttribute(object):
+
+ def __init__(self, name, default=None, required=False):
+ self.name = name
+ self.required = required
+ if default is not None and not isinstance(default, basestring):
+ default = str(default)
+ self.default = default
+
+ def __get__(self, obj, objtype):
+ return obj.attrib.setdefault(self.name, self.default)
+
+ def __set__(self, obj, val):
+ if val is None:
+ if self.default is None:
+ if self.name in obj.attrib:
+ del obj.attrib[self.name]
+ else:
+ obj.attrib[self.name] = self.default
+ return
+ elif not isinstance(val, basestring):
+ val = str(val)
+ obj.attrib[self.name] = val
+
+
+class XSEnumAttribute(XSStringAttribute):
+
+ def __init__(self, name, choices, default=None, required=False):
+ self.choices = [ str(c) if not isinstance(c, basestring) else c for c in choices ]
+ super(XSEnumAttribute, self).__init__(name, default, required)
+
+ def __set__(self, obj, val):
+ if not isinstance(val, basestring):
+ val = str(val)
+ if val not in self.choices:
+ raise ValueError('Expected one of %s (got %s instead)' % (self.choices, val))
+ super(XSEnumAttribute, self).__set__(obj, val)
+
+
+class XSIntegerAttribute(XSStringAttribute):
+
+ def __get__(self, obj, objtype):
+ return int(super(XSIntegerAttribute, self).__get__(obj, objtype))
+
+ def __set__(self, obj, val):
+ if not isinstance(val, Number):
+ raise TypeError('Expected an instance of int (got %s instance instead)' % type(val).__name__)
+ super(XSIntegerAttribute, self).__set__(obj, val)
+
+
+class XSBooleanAttribute(XSStringAttribute):
+
+ def __init__(self, name, default=False, required=False):
+ super(XSBooleanAttribute, self).__init__(name, str(default).lower(), required)
+
+ def __get__(self, obj, objtype):
+ return super(XSBooleanAttribute, self).__get__(obj, objtype) == 'true'
+
+ def __set__(self, obj, val):
+ if not isinstance(val, bool):
+ raise TypeError('Expected an instance of bool (got %s instance instead)' % type(val).__name__)
+ super(XSBooleanAttribute, self).__set__(obj, str(val).lower())
+
+
+class XSFloatAttribute(XSStringAttribute):
+
+ def __get__(self, obj, objtype):
+ return float(super(XSFloatAttribute, self).__get__(obj, objtype))
+
+ def __set__(self, obj, val):
+ if not isinstance(val, Number):
+ raise TypeError('Expected an instance of float (got %s instance instead)' % type(val).__name__)
+ super(XSFloatAttribute, self).__set__(obj, val)
+
+
+class XSLongAttribute(XSStringAttribute):
+
+ def __get__(self, obj, objtype):
+ return long(super(XSLongAttribute, self).__get__(obj, objtype))
+
+ def __set__(self, obj, val):
+ if not isinstance(val, Number):
+ raise TypeError('Expected an instance of float (got %s instance instead)' % type(val).__name__)
+ super(XSLongAttribute, self).__set__(obj, val)
+
+
+class XSAttributeType(object):
+ String = XSStringAttribute
+ Float = XSFloatAttribute
+ Integer = XSIntegerAttribute
+ Enum = XSEnumAttribute
+ Bool = XSBooleanAttribute
+ Long = XSLongAttribute
+
+
+class XMLAttribute(object):
+
+ def __init__(self, **kwargs):
+ self.name = kwargs.get('name')
+ if self.name is None:
+ raise ValueError("Keyword argument 'name' is required.")
+ self.property = kwargs.get('propname', sub('[^\w]+', '_', self.name))
+ self.type = kwargs.get('type', XSAttributeType.String)
+ self.default = kwargs.get('default', None)
+ self.required = kwargs.get('required', False)
+ self.choices = kwargs.get('choices')
+
+ def __call__(self, cls):
+ if self.type is XSAttributeType.Enum:
+ setattr(cls, self.property, self.type(self.name, self.choices, self.default))
+ else:
+ setattr(cls, self.property, self.type(self.name, self.default))
+ return cls
+
+
+class XSStringSubElement(object):
+
+ def __init__(self, name, default=None):
+ self.name = name
+ if default is not None and not isinstance(default, basestring):
+ default = str(default)
+ self.default = default
+
+ def __get__(self, obj, objtype):
+ e = obj.find(self.name)
+ if e is None:
+ if self.default is None:
+ return None
+ e = obj.findelement(self.name)
+ e.text = self.default
+ return e.text
+ if e.text is None and self.default is not None:
+ e.text = self.default
+ return e.text
+
+ def __set__(self, obj, val):
+ if val is None:
+ e = obj.find(self.name)
+ if e is not None:
+ if self.default is None:
+ obj.remove(e)
+ else:
+ e.text = self.default
+ return
+ if not isinstance(val, basestring):
+ val = str(val)
+ obj.findelement(self.name).text = val
+
+
+class XSCDataSubElement(XSStringSubElement):
+
+ def __init__(self, name, default=None):
+ super(XSCDataSubElement, self).__init__('%s/CDATA' % name, default)
+
+
+class XSEnumSubElement(XSStringSubElement):
+
+ def __init__(self, name, choices, default=None):
+ self.choices = [ str(c) if not isinstance(c, basestring) else c for c in choices ]
+ super(XSEnumSubElement, self).__init__(name, default)
+
+ def __set__(self, obj, val):
+ if not isinstance(val, basestring):
+ val = str(val)
+ if val not in self.choices:
+ raise ValueError('Expected one of %s (got %s instead)' % (self.choices, val))
+ super(XSEnumSubElement, self).__set__(obj, val)
+
+
+class XSIntegerSubElement(XSStringSubElement):
+
+ def __get__(self, obj, objtype):
+ return int(super(XSIntegerSubElement, self).__get__(obj, objtype))
+
+ def __set__(self, obj, val):
+ if not isinstance(val, Number):
+ raise TypeError('Expected an instance of int (got %s instance instead)' % type(val))
+ super(XSIntegerSubElement, self).__set__(obj, val)
+
+
+class XSBooleanSubElement(XSStringSubElement):
+
+ def __init__(self, name, default=False):
+ super(XSBooleanSubElement, self).__init__(name, str(default).lower())
+
+ def __get__(self, obj, objtype):
+ return super(XSBooleanSubElement, self).__get__(obj, objtype) == 'true'
+
+ def __set__(self, obj, val):
+ if not isinstance(val, bool):
+ raise TypeError('Expected an instance of bool (got %s instance instead)' % type(val))
+ super(XSBooleanSubElement, self).__set__(obj, str(val).lower())
+
+
+class XSFloatSubElement(XSStringSubElement):
+
+ def __get__(self, obj, objtype):
+ return float(super(XSFloatSubElement, self).__get__(obj, objtype))
+
+ def __set__(self, obj, val):
+ if not isinstance(val, Number):
+ raise TypeError('Expected an instance of float (got %s instance instead)' % type(val))
+ super(XSFloatSubElement, self).__set__(obj, val)
+
+
+class XSLongSubElement(XSStringSubElement):
+
+ def __get__(self, obj, objtype):
+ return long(super(XSLongSubElement, self).__get__(obj, objtype))
+
+ def __set__(self, obj, val):
+ if not isinstance(val, Number):
+ raise TypeError('Expected an instance of float (got %s instance instead)' % type(val))
+ super(XSLongSubElement, self).__set__(obj, val)
+
+
+class XSListSubElement(object):
+
+ def __init__(self, name):
+ self.name = name
+
+ def __get__(self, obj, objtype):
+ return obj.findelement(self.name)
+
+
+class XSSubElementType(object):
+ String = XSStringSubElement
+ Float = XSFloatSubElement
+ Integer = XSIntegerSubElement
+ Enum = XSEnumSubElement
+ Bool = XSBooleanSubElement
+ Long = XSLongSubElement
+ List = XSListSubElement
+ CData = XSCDataSubElement
+
+
+class XMLSubElement(object):
+
+ def __init__(self, **kwargs):
+ self.name = kwargs.get('name')
+ if self.name is None:
+ raise ValueError("Keyword argument 'name' is required.")
+ self.property = kwargs.get('propname', sub('[^\w]+', '_', self.name))
+ self.type = kwargs.get('type', XSSubElementType.String)
+ self.default = kwargs.get('default', None)
+ self.required = kwargs.get('required', False)
+ self.choices = kwargs.get('choices')
+
+ def __call__(self, cls):
+ if self.type is XSSubElementType.Enum:
+ setattr(cls, self.property, self.type(self.name, self.choices, self.default))
+ elif self.type is XSSubElementType.List:
+ setattr(cls, self.property, self.type(self.name))
+ else:
+ setattr(cls, self.property, self.type(self.name, self.default))
+ return cls
+
+
+class ElementTree(ET.ElementTree):
+ """ElementTree with CDATA support."""
+ def _write(self, file, node, encoding, namespaces):
+ if node.tag == 'CDATA':
+ if node.text is not None:
+ text = node.text.encode(encoding)
+ file.write('<![CDATA[%s]]>' % text)
+ else:
+ _eto._write(self, file, node, encoding, namespaces)
+
+ def write(self, file=stdout, encoding='us-ascii'):
+ _eto.write(self, file, encoding)
+
+
+class Element(ET._ElementInterface, object):
+
+ def __init__(self, tag='Element', attrib={}, **kwargs):
+ attrib = attrib.copy()
+ attrib.update(kwargs)
+ super(Element, self).__init__(tag, attrib)
+
+ def __add__(self, other):
+ newobj = deepcopy(self)
+ newobj += other
+ return newobj
+
+ def __iadd__(self, other):
+ if isinstance(other, list):
+ for o in other:
+ self.appendelement(o)
+ else:
+ self.appendelement(other)
+ return self
+
+ appendelements = __iadd__
+
+ def __sub__(self, other):
+ newobj = deepcopy(self)
+ newobj -= other
+ return newobj
+
+ def __isub__(self, other):
+ if isinstance(other, list):
+ for o in other:
+ self.removeelement(o)
+ else:
+ self.removeelement(other)
+ return self
+
+ removeelements = __isub__
+
+ def appendelement(self, other):
+ self.append(other)
+
+ def removeelement(self, other):
+ self.remove(other)
+
+ def findelement(self, name):
+ e = self.find(name)
+ if e is None:
+ if '/' in name:
+ path = name.split('/')
+ e = self
+ for p in path:
+ ce = e.find(p)
+ if ce is None:
+ e = _se(e, p)
+ else:
+ e = _se(self, name)
+ return e
+
+ def makeelement(self, tag, attrib):
+ return Element(tag, attrib)
+
+ def __eq__(self, other):
+ return dumps(self) == dumps(other)
--- /dev/null
+#!/usr/bin/env python
+
+__author__ = 'Nadeem Douba'
+__copyright__ = 'Copyright 2012, Sploitego Project'
+__credits__ = ['Nadeem Douba']
+
+__license__ = 'GPL'
+__version__ = '0.1'
+__maintainer__ = 'Nadeem Douba'
+__email__ = 'ndouba@gmail.com'
+__status__ = 'Development'
\ No newline at end of file
--- /dev/null
+#!/usr/bin/env python
+
+from canari.commands.common import get_commands
+from argparse import ArgumentParser
+
+
+__author__ = 'Nadeem Douba'
+__copyright__ = 'Copyright 2012, Canari Project'
+__credits__ = []
+
+__license__ = 'GPL'
+__version__ = '0.1'
+__maintainer__ = 'Nadeem Douba'
+__email__ = 'ndouba@gmail.com'
+__status__ = 'Development'
+
+
+
+cmds = get_commands()
+
+def parse_args():
+ parser = ArgumentParser(
+ description='Centralized Canari Management System'
+ )
+ parser.add_argument(
+ 'command',
+ metavar='<command>',
+ choices=cmds,
+ default='help',
+ nargs='?',
+ help='The name of the command you wish to run (%s).' % ', '.join(cmds),
+ )
+ args = parser.parse_known_args()
+ return args
+
+
+def main():
+ args = parse_args()
+ cmds[args[0].command].run(args[1])
+
+
+if __name__ == '__main__':
+ try:
+ main()
+ except KeyboardInterrupt:
+ print('exiting...')
+ pass
\ No newline at end of file
--- /dev/null
+@python %~dp0\canari %*
\ No newline at end of file
--- /dev/null
+#!/usr/bin/env python
+
+from canari.commands.run_transform import run
+
+from sys import argv
+
+__author__ = 'Nadeem Douba'
+__copyright__ = 'Copyright 2012, Canari Project'
+__credits__ = []
+
+__license__ = 'GPL'
+__version__ = '0.1'
+__maintainer__ = 'Nadeem Douba'
+__email__ = 'ndouba@gmail.com'
+__status__ = 'Development'
+
+
+if __name__ == '__main__':
+ run(argv[1:])
\ No newline at end of file
--- /dev/null
+@python %~dp0\dispatcher %*
\ No newline at end of file
--- /dev/null
+#!/usr/bin/env python
+
+from canari.easygui import passwordbox
+from canari.utils.fs import fmutex
+
+from pexpect import spawn, EOF
+from sys import argv, stderr
+from os import execvp
+
+
+__author__ = 'Nadeem Douba'
+__copyright__ = 'Copyright 2012, Sploitego Project'
+__credits__ = []
+
+__license__ = 'GPL'
+__version__ = '0.1'
+__maintainer__ = 'Nadeem Douba'
+__email__ = 'ndouba@gmail.com'
+__status__ = 'Development'
+
+
+def main():
+
+ if len(argv) == 1:
+ print 'usage: %s <command>' % argv[0]
+ exit(-1)
+
+ child = None
+
+ try:
+ l = fmutex('pysudo.lock')
+ child = spawn('sudo -S echo start')
+ while not child.expect(['Password:', 'start']):
+ password = passwordbox('Please enter your password.', 'sudo', '')
+ child.sendline(password)
+ del l
+ execvp('sudo', ['sudo'] + argv[1:])
+
+ except EOF:
+ stderr.write(child.before)
+ except TypeError:
+ stderr.write('Terminated.')
+ except Exception, e:
+ stderr.write(str(e))
+
+
+if __name__ == '__main__':
+ main()
--- /dev/null
+@python %~dp0\pysudo %*
\ No newline at end of file