dockerauto.py

#!/usr/bin/env python3
#
# DockerAuto version 1.1 (27_10_2023)
# Written by Andy Tyler (@ticarpi)
# Please use responsibly...
# Software URL: https://github.com/ticarpi/dockerauto
# Web: https://www.ticarpi.com
# Twitter: @ticarpi

dockerautovers = "1.1"
import os
from urllib.request import urlretrieve
import json
import base64
import argparse
from datetime import datetime
import shutil
from zipfile import ZipFile 


basepath = os.path.expanduser('~/.dockerauto/')
configfile = basepath+'dockerlist.json'
tmpdir = basepath+'tmp_da/'

def run_update(dockerlist_json, updateitem):
    if dockerlist_json['dockeritems'][updateitem][3][0] != 'DockerHub':
        run_build(dockerlist_json, updateitem)
    else:
        try:
            print("\n[+] Running docker update command for "+updateitem)
            run_cmd('docker pull '+dockerlist_json['dockeritems'][updateitem][3][1])
            os.system(cmd)
        except:
            print('[-] The specified tool ('+updateitem+') could not be updated')

def run_build(dockerlist_json, dockeritem):
    try:
        print('[+] Prepping temp build directory')
        shutil.rmtree(tmpdir)
    except:
        print('[+] Creating temp build directory')
    if dockerlist_json['dockeritems'][dockeritem][3][0] == 'GitHub':
        split = dockerlist_json['dockeritems'][dockeritem][3][2].split("/")
        gitdir = split[-1]
        builddir = tmpdir+gitdir
        pwd = os.getcwd()
        os.mkdir(tmpdir)
        os.chdir(tmpdir)
        os.system('git clone '+dockerlist_json['dockeritems'][dockeritem][3][2])
        os.chdir(pwd)
    elif dockerlist_json['dockeritems'][dockeritem][3][0] == 'ZipUrl':
        try:
            builddir = tmpdir+dockerlist_json['dockeritems'][dockeritem][3][3]
        except:
            builddir = tmpdir
        os.mkdir(tmpdir)
        pwd = os.getcwd()
        print('[+] Downloading '+dockerlist_json['dockeritems'][dockeritem][3][2])
        downloadfile(dockerlist_json['dockeritems'][dockeritem][3][2], tmpdir+'temp.zip')
        with ZipFile(tmpdir+'temp.zip', 'r') as zObject:
            print('[+] Extracting '+tmpdir+'temp.zip to '+tmpdir)
            zObject.extractall(path=tmpdir)
    else:
        builddir = tmpdir
        os.mkdir(builddir)
        pwd = os.getcwd()
    for file in dockerlist_json['dockeritems'][dockeritem][4].keys():
        filename = builddir.rstrip("/")+'/'+file
        print('    [*] Building: '+filename)
        b642file(dockerlist_json['dockeritems'][dockeritem][4][file], filename)
    os.chdir(builddir)
    run_cmd('docker build -t '+dockeritem+' .')
    os.chdir(pwd)
    shutil.rmtree(builddir)
    print('[+] Cleaning up temp build directory')
    return True

def b642file(fileb64, filename):
    with open(filename, 'w') as newfile:
        newfile.write(base64.b64decode(fileb64.encode('ascii')).decode('ascii'))

def mode_update(dockeritem):
    with open(configfile, "r") as dockerlist:
        dockerlist_json = json.load(dockerlist)
    if dockeritem == 'ALL' or dockeritem == 'all':
        print("[+] Updating all of the following:")
        for key in dockerlist_json['dockeritems'].keys():
            print("    [*] "+key)
        update = input('\n[!] Are you sure you want to update all Docker images? (y/N)')
        if update=='y' or update=='Y':
            for key in dockerlist_json['dockeritems'].keys():
                run_update(dockerlist_json, key)
                dockerlist_json['dockeritems'][key][5] = timestamp = int(datetime.timestamp(datetime.now()))
            with open(configfile, "w") as dockerdump:
                dockerdump.write(json.dumps(dockerlist_json))
        else:
            print('Quitting...')
            exit(1)
    else:
        print('[+] Updating '+dockeritem)
        run_update(dockerlist_json, dockeritem)
        dockerlist_json['dockeritems'][dockeritem][5] = timestamp = int(datetime.timestamp(datetime.now()))
        with open(configfile, "w") as dockerdump:
            dockerdump.write(json.dumps(dockerlist_json))

def run_remove(dockerlist_json, removeitem):
    print("\n[+] Removing config entry for "+removeitem)
    del dockerlist_json['dockeritems'][removeitem]
    with open(configfile, "w") as dockerdump:
        dockerdump.write(json.dumps(dockerlist_json))
        print('\n[+] '+removeitem+' has been removed from the config')

def mode_remove(dockeritem):
    with open(configfile, "r") as dockerlist:
        dockerlist_json = json.load(dockerlist)
    if dockeritem in dockerlist_json['dockeritems'].keys():
        print('[+] Removing '+dockeritem+' from the config:')
        remove = input('\n[!] Are you sure you want to remove this item? (y/N)')
        if remove=='y' or remove=='Y':
            run_remove(dockerlist_json, dockeritem)
        else:
            print('Quitting...')
            exit(1)
    else:
        print("The specified tool ("+dockeritem+") is not in the config file. Try one of the following:")
        for key in dockerlist_json['dockeritems'].keys():
            print("    [*] "+key)

def mode_run(dockeritem, args):
    with open(configfile, "r") as dockerlist:
        dockerlist_json = json.load(dockerlist)
    try:
        imagelist = checkimage()
        if dockeritem in imagelist or dockerlist_json['dockeritems'][dockeritem][3][0] == 'DockerHub':
            print("[+] Running docker command for "+dockeritem)
            if ' --rm ' in dockerlist_json['dockeritems'][dockeritem][1]:
                run_cmd(dockerlist_json['dockeritems'][dockeritem][1]+' '+args)
            else:
                cmd = 'docker ps -a --format json'
                if powershellcmd:
                    cmd = powershellcmd+' -c \''+cmd+'\''
                loaded = os.popen(cmd).readlines()         
                loadlist = []
                for container in loaded:
                    img = json.loads(container)
                    loadlist.append(img['Names'])
                if dockeritem in loadlist:
                    print('[*] Detected an existing named DockerAuto container - restarting...')
                    run_cmd('docker start '+dockeritem+' -i')
        else:
            print('[-] The image has not yet been created. Run `dockerauto update '+dockeritem+'` to create the docker image')
    except:
        print("The specified tool ("+dockeritem+") could not be run. Try one of the following:")
        for key in dockerlist_json['dockeritems'].keys():
            print("    [*] "+key)

def unload_image(dockeritem, dockerlist_json):
    try:
        run_cmd('docker image rm '+dockerlist_json['dockeritems'][dockeritem][3][1])
    except:
        print("[!] ERROR processing the specified tool ("+dockeritem+").")

def run_cmd(cmd):
    if powershellcmd:
        cmd = powershellcmd+' -c \''+cmd+'\''
    #print('[*] Running: '+cmd+'\n')
    os.system(cmd)

def mode_shell(dockeritem):
    with open(configfile, "r") as dockerlist:
        dockerlist_json = json.load(dockerlist)
    if dockeritem in dockerlist_json['dockeritems']:
        print('[+] Creating a /bin/sh shell on the DockerAuto image ('+dockerlist_json['dockeritems'][dockeritem][3][1]+')\n    [*] Type exit to close the shell\n    [*] If the image has /bin/bash you can run that to upgrade your shell\n')
        run_cmd('docker run -it --rm --name shell_'+dockeritem+' --entrypoint=/bin/sh '+dockerlist_json['dockeritems'][dockeritem][3][1])

def mode_unload(dockeritem):
    with open(configfile, "r") as dockerlist:
        dockerlist_json = json.load(dockerlist)
    if dockeritem == 'ALL' or dockeritem == 'all':
        print("[+] Unloading all of the following Docker images:")
        for key in dockerlist_json['dockeritems'].keys():
            print("    [*] "+key+' ('+dockerlist_json['dockeritems'][key][3][1]+')')
        update = input('\n[!] Are you sure you want to unload all Docker images? (y/N)')
        if update=='y' or update=='Y':
            for key in dockerlist_json['dockeritems'].keys():
                unload_image(key, dockerlist_json)
        else:
            print('Quitting...')
            exit(1)
    if dockeritem in dockerlist_json['dockeritems']:
        unload_image(dockeritem, dockerlist_json)
    elif dockeritem != 'ALL' and dockeritem != 'all':
        print("The specified tool ("+dockeritem+") is not in the config file. Try one of the following:")
        for key in dockerlist_json['dockeritems'].keys():
            print("    [*] "+key)

def file2b64(inputfile, filename):
    b64obj = {}
    with open(inputfile, 'r') as thisfile:
        b64obj[filename] = base64.b64encode(thisfile.read().encode('ascii')).decode('ascii')
    return b64obj

def mode_add(dockeritem, dockerfile, file, configfile, dockercomposefile):
    dockeritem.replace(' ', '_')
    with open(configfile, "r") as dockerlist:
        dockerlist_json = json.load(dockerlist)
    if dockeritem in dockerlist_json['dockeritems']:
        print('[-] An entry already exists for '+dockeritem)
        exit(1)
    print('\n[+] Creating entry for new DockerAuto item: '+dockeritem)
    newitem = ["","","",[],"","",""]
    newitem[5] = ''
    newitem[0] = input('\n[*] Please enter a short description of the image\n')
    newitem[4] = {}
    if dockerfile or dockercomposefile:
        if file:
            for filename in file:
                split = filename.split("/")
                filename_split = split[-1]
                print('[+] Adding: '+filename+' contents to build info')
                newitem[4].update(file2b64(filename, filename_split))
        if dockerfile:
            newitem[4].update(file2b64(dockerfile, 'Dockerfile'))
            print('[+] Adding: '+dockerfile+' as the Dockerfile for building the '+dockeritem+' base image')
        else:
            newitem[4].update(file2b64(dockercomposefile, 'docker-compose.yaml'))
            print('[+] Adding: '+dockercomposefile+' as the docker-compose.yaml file for building the '+dockeritem+' multi container image')
        option = input('[*] Select which category best fits your new DockerAuto item:\n    [1] Tool (for running a single application)\n    [2] Service (For serving or receiving files, or hosting data etc.)\n    [3] Environment (For exploring filesystems and running a variety of tooling from a base image)\n')
        if option == '1':
            newitem[6] = "tool"
        elif option == '2':
            newitem[6] = "service"
        elif option == '3':
            newitem[6] = "environment"
        else:
            print('[-] Not a valid option. Quitting...')
            exit(1)
        option = input('[*] Select which method you want to use to generate your Docker content:\n    [1] Clone a GitHub repo\n    [2] Download a zip\n    [3] No codebase to import\n')
        if option == '1':
            repourl = 'https://www.github.com/'+input('\n[*] Please enter the "user/name" of the GitHub repo for cloning (e.g. ticarpi/jwt_tool)\n')
            newitem[3] = ['GitHub', dockeritem, repourl]
        elif option == '2':
            zipurl = input('\n    [*] Please enter the URL of the zipfile you wish to download\n')
            zipdir = input('\n    [*] Please enter a directory name that the files are within in the zip file (or leave blank if no zip subdirectory)\n')
            newitem[3] = ['ZipUrl', dockeritem, zipurl, zipdir]
        elif option == '3':
            if dockerfile:
                newitem[3] = ['Dockerfile', dockeritem]
            else:
                newitem[3] = ['Docker-Compose', dockeritem]
        else:
            print('[-] Not a valid option. Quitting...')
            exit(1)
    else:
        option = input('[*] Select which category best fits your new DockerAuto item:\n    [1] Tool (for running a single application)\n    [2] Service (For serving or receiving files, or hosting data etc.)\n    [3] Environment (For exploring filesystems and running a variety of tooling from a base image)\n')
        if option == '1':
            newitem[6] = "tool"
        elif option == '2':
            newitem[6] = "service"
        elif option == '3':
            newitem[6] = "environment"
        else:
            print('[-] Not a valid option. Quitting...')
            exit(1)
        option = input('[*] Select which method you want to use to generate your Docker content:\n    [1] Clone a GitHub repo\n    [2] Download a zip\n    [3] Pull from DockerHub\n')
        if option == '1':
            repourl = 'https://www.github.com/'+input('\n[*] Please enter the "user/name" of the GitHub repo for cloning (e.g. ticarpi/jwt_tool)\n')
            newitem[3] = ['GitHub', dockeritem, repourl]
        elif option == '2':
            zipurl = input('\n    [*] Please enter the URL of the zipfile you wish to download\n')
            zipdir = input('\n    [*] Please enter a directory name that the files are within in the zip file (or leave blank if no zip subdirectory)\n')
            newitem[3] = ['ZipUrl', dockeritem, zipurl, zipdir]
        elif option == '3':
            newitem[3] = ['DockerHub', input('\n[*] Please enter the DockerHub repo (e.g. ticarpi/jwt_tool)\n')]
        else:
            print('[-] Not a valid option. Quitting...')
            exit(1)
    newitem[1] = input('\n[*] Please enter the base command used to run this container.\ne.g. docker run -it --network \"host\" --rm -v \"${PWD}:/tmp\" -v \"${HOME}/.jwt_tool:/root/.jwt_tool\" ticarpi/jwt_tool\n    Include the following:\n    [*] volume mapping "-v"\n    [*] port mapping "-p"\n    [*] environment variables "-e"\n    [*] Remove instruction "--rm"\n    [*] only use "double quotes", not \'single quotes\'\n    [*] and make sure the image referenced is: '+newitem[3][1]+'\n')
    newitem[2] = input('\n[*] Please enter any useful notes for running the container, separating each note with a semicolon. e.g. "-h; PWD mapped to /tmp"\n')
    dockerlist_json['dockeritems'][dockeritem] = newitem
    with open(configfile, "w") as dockerdump:
        dockerdump.write(json.dumps(dockerlist_json))
        print('\n[+] new item ('+dockeritem+') has been added to the config')

def mode_info(dockeritem):
    with open(configfile, "r") as dockerlist:
        dockerlist_json = json.load(dockerlist)
    if dockeritem in dockerlist_json['dockeritems']:
        if dockerlist_json['dockeritems'][dockeritem][5] == '':
            updatetime = 'NEVER'
        else:
            updatetime = str(datetime.fromtimestamp(dockerlist_json['dockeritems'][dockeritem][5]))
        if dockerlist_json['dockeritems'][dockeritem][4] == {}:
            genfiles = ['None']
        else:
            genfiles =  dockerlist_json['dockeritems'][dockeritem][4].keys()
        print("[+] Info for: "+dockeritem+" (Last updated: "+updatetime+")")
        print("    [*] Description: "+dockerlist_json['dockeritems'][dockeritem][0])
        print("    [*] Usage Notes:\n        [*] "+dockerlist_json['dockeritems'][dockeritem][2].replace(';','\n        [*]'))
        print("    [*] Command: "+dockerlist_json['dockeritems'][dockeritem][1])
        print("    [*] Image Source: "+str(dockerlist_json['dockeritems'][dockeritem][3]))
        print("    [*] Dockerfile Generation Script Files:")
        for file in genfiles:
            print("        [*] "+file)
        print("    [*] Category: "+dockerlist_json['dockeritems'][dockeritem][6].capitalize())
    else:
        print("The specified tool ("+dockeritem+") is not in the config file. Try one of the following:")
        for key in dockerlist_json['dockeritems'].keys():
            print("    [*] "+key)

def mode_list():
    with open(configfile, "r") as dockerlist:
        dockerlist_json = json.load(dockerlist)
        imagelist = checkimage()
        print('[+] Images in config:')
        for cat in ['tool', 'service', 'environment']:
            print('    [*] '+cat.capitalize()+'s')
            for key in dockerlist_json['dockeritems'].keys():
                if dockerlist_json['dockeritems'][key][6] == cat:
                    installed = ' - run \'update\' to build image'
                    imgname = dockerlist_json['dockeritems'][key][3][1]
                    if imgname in imagelist:
                        installed = ' - IMAGE INSTALLED ('+imgname+')'
                    print("        [*] "+key+installed)

def saveconfig(sourcefile, destfile):
    print('\n[+] Saving config\nfrom: '+sourcefile+'\nto: '+destfile+'\n')
    try:
        shutil.copy2(sourcefile, destfile)
    except:
        print('Copy failed, check permissions on source and destination files:\nSource:'+sourcefile+'\nDestination: '+destfile)

def downloadfile(URL, filename):
    urlretrieve(URL, filename)

def checkimage():
    cmd = 'docker images --format "{{json .}}"'
    if powershellcmd:
        cmd = powershellcmd+' -c \''+cmd+'\''
    images = os.popen(cmd).readlines()
    imagelist = []
    for image in images:
        img = json.loads(image)
        imagelist.append(img['Repository'])
    return imagelist

def mode_export():
    saveconfig(configfile, os.getcwd()+'/EXPORT.dockerlist.json')

def mode_install(config):
    if os.path.exists(basepath):
        overwrite = input('[!] Installing a new DockerAuto config will remove previous configs and some cached docker data.\nDo you want to continue? (y/N)')
        
        if overwrite=='y' or overwrite=='Y':
            jsonfile=os.getcwd()+'/'+config
            saveconfig(jsonfile, configfile)
        else:
            print('Quitting...')
            exit(1)
    if shutil.which('dockerauto') is None:
        os.system('sudo ln -s '+os.getcwd()+'/dockerauto.py /usr/bin/dockerauto')
        os.chmod(os.getcwd()+'/dockerauto.py', 0o775)
        print('[+] DockerAuto now installed via simlink to /usr/bin/dockerauto, you can now run with:\n$ dockerauto [args]')
    try:
        print('[+] Prepping base directory at: '+basepath)
        shutil.rmtree(basepath)
    except:
        print('[+] Building base directory at: '+basepath)
    os.mkdir(basepath)
    if config.startswith('http://') or config.startswith('https://'):
        downloadfile(config, 'temp.json')
        config = 'temp.json'
    if not os.path.exists(config):
        print('[!] Cannot find '+config+' check the filepath')
        exit(1)
    #jsonfile=os.getcwd()+'/'+config
    saveconfig(config, configfile)
        
def checkwsl():
    powershellcmd = ''
    if os.environ.get('WSL_DISTRO_NAME'):
        print('[+] WSL detected, checking for PowerShell path...')
        for path in ['/mnt/c/Windows/System32/WindowsPowerShell/v1.0/powershell.exe', '/mnt/c/Windows/SysWOW64/WindowsPowerShell/v1.0/powershell.exe']:
                if os.path.exists(path):
                    powershellcmd = path
                    break
    
    if powershellcmd:
        print('    [*] PowerShell path: '+powershellcmd+'\n')
    else:
        print("[-] PowerShell couldn't be found, trying with WSL2 Docker instead.\n")
    return powershellcmd

def checkdeps():
    errors=0
    if shutil.which('docker') is None and not powershellcmd:
        print('[-] Docker NOT installed.\nThis is a requirement for a tool that runs Docker containers.\n\nOn Kali and other Linux distros that use the APT package manager you can install this and configure it by running the following command:\nsudo apt update && sudo apt install docker.io -y && sudo usermod -aG docker $USER\n')
        errors+=1
    if shutil.which('git') is None:
        print('[-] Git NOT installed.\nThis is a requirement in order to update and pull Git repos to build new Docker containers.\n\nOn Kali and other Linux distros that use the APT package manager you can install this by running the following command:\nsudo apt update && sudo apt install git -y\n')
        errors+=1
    if errors>0:
        exit(1)

logo="\n██████   ██████   ██████ ██   ██ ███████ ██████   █████  ██    ██ ████████  ██████  \n"
logo+="██   ██ ██    ██ ██      ██  ██  ██      ██   ██ ██   ██ ██    ██    ██    ██    ██ \n"
logo+="██   ██ ██    ██ ██      █████   █████   ██████  ███████ ██    ██    ██    ██    ██ \n"
logo+="██   ██ ██    ██ ██      ██  ██  ██      ██   ██ ██   ██ ██    ██    ██    ██    ██ \n"
logo+="██████   ██████   ██████ ██   ██ ███████ ██   ██ ██   ██  ██████     ██     ██████  \n"
logo+="\t@ticarpi\t\t\t\t\t\tversion "+dockerautovers+"\n"
    
if __name__ == '__main__':
    print(logo)
    powershellcmd = checkwsl()
    checkdeps()
    parser = argparse.ArgumentParser(epilog="OK, bye", formatter_class=argparse.RawTextHelpFormatter)
    subparsers = parser.add_subparsers(dest='mode',required=True)
    parser_install = subparsers.add_parser('install', help="Install a new config file (and set up symlink to run DockerAuto from any directory)")
    parser_run = subparsers.add_parser('run', help="Run Docker commands for DockerAuto items")
    parser_list = subparsers.add_parser('list', help="Show all DockerAuto items in the config (and install status)")
    parser_info = subparsers.add_parser('info', help="Look up info about each DockerAuto item in the config")
    parser_shell = subparsers.add_parser('shell', help="Drop into the specified DockerAuto image in a shell")
    parser_add = subparsers.add_parser('add', help="Add new DockerAuto items to the config manually")
    parser_remove = subparsers.add_parser('remove', help="Remove DockerAuto items from the config manually")
    parser_update = subparsers.add_parser('update', help="Pull any new Docker image updates for DockerAuto items in the config - or for everything (update ALL)")
    parser_unload = subparsers.add_parser('unload', help="Delete stored Docker images for DockerAuto items in the config - or for everything (unload ALL)")
    parser_export = subparsers.add_parser('export', help="Export the config file")
    parser_add.add_argument('dockeritem', type=str, action="store", help="A new DockerAuto item", default='dockerauto')
    parser_shell.add_argument('dockeritem', type=str, action="store", help="The DockerAuto image to connect to", default='dockerauto')
    parser_add.add_argument('-d', '--dockerfile', action="store", help="Dockerfile for the new DockerAuto item")
    parser_add.add_argument('-dc', '--dockercomposefile', action="store", help="docker-compose YAML file for running a collection of services")
    parser_add.add_argument('-f', '--file', action="append", help="Additional files, such as configs/certs, for the new DockerAuto item")
    parser_run.add_argument('dockeritem', type=str, action="store", help="Run the selected DockerAuto items", default='dockerauto')
    parser_update.add_argument('dockeritem', type=str, action="store", help="Update the selected DockerAuto items (or 'update ALL' to update all Docker images)", default='ALL')
    parser_unload.add_argument('dockeritem', type=str, action="store", help="Unload the selected DockerAuto item to the config", default='ALL')
    parser_remove.add_argument('dockeritem', type=str, action="store", help="Remove the selected DockerAuto item from the config", default='ALL')
    parser_run.add_argument('arglist', help="Arguments to use in the docker command (surround in 'single quotes' e.g. '-u https://example.com -X GET')", nargs='*')
    parser_info.add_argument('dockeritem', type=str, action="store", help="Info about selected DockerAuto items", default='dockerauto')
    parser_install.add_argument("-c", "--config", action="store", help="URL or local filepath to grab your custom DockerAuto config from", required=False, default='example.dockerlist.json')
    args = parser.parse_args()
    if not os.path.exists(configfile) and args.mode != 'install':
        print('Install config before you can use any other DockerAuto functionality:\n$ python3 dockerauto.py install -j [Path/URL to dockerlist.json]')
        exit(1)
    if args.mode == 'install':
        mode_install(args.config)
    elif args.mode == 'info':
        mode_info(args.dockeritem)
    elif args.mode == 'update':
        mode_update(args.dockeritem)
    elif args.mode == 'unload':
        mode_unload(args.dockeritem)
    elif args.mode == 'shell':
        mode_shell(args.dockeritem)
    elif args.mode == 'remove':
        mode_remove(args.dockeritem)
    elif args.mode == 'list':
        mode_list()
    elif args.mode == 'export':
        mode_export()
    elif args.mode == 'run':
        arglist = ''
        if args.arglist:
            arglist = args.arglist[0] 
        mode_run(args.dockeritem, arglist)
    elif args.mode == 'add':
        if args.dockerfile and args.dockercomposefile:
            print('[-] Cannot specify BOTH Dockerfile and docker-compose YAML.\n    [*] If your Docker-Compose instance uses Dockerfiles, add these as files (\'-f\')')
            exit(1)
        mode_add(args.dockeritem, args.dockerfile, args.file, configfile, args.dockercomposefile)