diff --git a/source/assets/install/windows_dockerdesktop_wsl_config.png b/source/assets/install/windows_dockerdesktop_wsl_config.png new file mode 100644 index 0000000..4cdd79a Binary files /dev/null and b/source/assets/install/windows_dockerdesktop_wsl_config.png differ diff --git a/source/assets/installed_tools/lists/latest_nightly_amd64.csv b/source/assets/installed_tools/lists/latest_nightly_amd64.csv index 62d53a6..0fdbd19 100644 --- a/source/assets/installed_tools/lists/latest_nightly_amd64.csv +++ b/source/assets/installed_tools/lists/latest_nightly_amd64.csv @@ -12,7 +12,6 @@ apksigner,https://source.android.com/security/apksigning,arguably the most impor apktool,https://github.com/iBotPeaches/Apktool,It is a tool for reverse engineering 3rd party / closed / binary Android apps. arjun,https://github.com/s0md3v/Arjun,HTTP parameter discovery suite. arsenal,https://github.com/Orange-Cyberdefense/arsenal,Powerful weapons for penetration testing. -ascii,https://github.com/moul/ascii,ASCII command-line tool to replace images with color-coded ASCII art. assetfinder,https://github.com/tomnomnom/assetfinder,Tool to find subdomains and IP addresses associated with a domain. autoconf,https://www.gnu.org/software/autoconf/autoconf.html,Tool for producing shell scripts to configure source code packages autorecon,https://github.com/Tib3rius/AutoRecon,Multi-threaded network reconnaissance tool which performs automated enumeration of services. @@ -39,6 +38,7 @@ Censys,https://github.com/censys/censys-python,An easy-to-use and lightweight AP certipy,https://github.com/ly4k/Certipy,Python tool to create and sign certificates certsync,https://github.com/zblurx/certsync,certsync is a tool that helps you synchronize certificates between two directories. cewl,https://digi.ninja/projects/cewl.php,Generates custom wordlists by spidering a target's website and parsing the results +cewler,https://github.com/roys/cewler,CeWL alternative in Python chainsaw,https://github.com/WithSecureLabs/chainsaw,Rapidly Search and Hunt through Windows Forensic Artefacts checksec-py,https://github.com/Wenzel/checksec.py,Python wrapper script for checksec.sh from paX. chisel,https://github.com/jpillora/chisel,Go based TCP tunnel with authentication and encryption support @@ -52,10 +52,11 @@ coercer,https://github.com/p0dalirius/coercer,DFS-R target coercion tool constellation,https://github.com/constellation-app/Constellation,Find and exploit vulnerabilities in mobile applications. corscanner,https://github.com/chenjj/CORScanner,a Python script for finding CORS misconfigurations. cowpatty,https://github.com/joswr1ght/cowpatty,cowpatty is a tool for offline dictionary attacks against WPA-PSK (Pre-Shared Key) networks. -crackhound,https://github.com/trustedsec/crackhound.git,A fast WPA/WPA2/WPA3 WiFi Handshake capture / password recovery and analysis tool -crackmapexec,https://github.com/mpgn/CrackMapExec,Network scanner. +crackhound,https://github.com/trustedsec/crackhound,A fast WPA/WPA2/WPA3 WiFi Handshake capture / password recovery and analysis tool +crackmapexec,https://github.com/Porchetta-Industries/CrackMapExec,Network scanner. crunch,https://github.com/crunchsec/crunch,A wordlist generator where you can specify a standard character set or a character set you specify. cupp,https://github.com/Mebus/cupp,Cupp is a tool used to generate personalized password lists based on target information. +CyberChef,https://github.com/gchq/CyberChef/,The Cyber Swiss Army Knife cyperoth,https://github.com/seajaysec/cypheroth,Automated extensible toolset that runs cypher queries against Bloodhound's Neo4j backend and saves output to spreadsheets. darkarmour,https://github.com/bats3c/darkarmour,a tool to detect and evade common antivirus products dex2jar,https://github.com/pxb1988/dex2jar,A tool to convert Android's dex files to Java's jar files @@ -71,6 +72,7 @@ donpapi,https://github.com/login-securite/DonPAPI,Dumping revelant information o droopescan,https://github.com/droope/droopescan,Scan Drupal websites for vulnerabilities. drupwn,https://github.com/immunIT/drupwn,Drupal security scanner. eaphammer,https://github.com/s0lst1c3/eaphammer,EAPHammer is a toolkit for performing targeted evil twin attacks against WPA2-Enterprise networks. +empire,https://github.com/BC-SECURITY/Empire,post-exploitation and adversary emulation framework enum4linux-ng,https://github.com/cddmp/enum4linux-ng,Tool for enumerating information from Windows and Samba systems. enyx,https://github.com/trickster0/enyx,Framework for building offensive security tools. evilwinrm,https://github.com/Hackplayers/evil-winrm,Tool to connect to a remote Windows system with WinRM. @@ -90,6 +92,7 @@ findomain,https://github.com/findomain/findomain,The fastest and cross-platform finduncommonshares,https://github.com/p0dalirius/FindUncommonShares,Script that can help identify shares that are not commonly found on a Windows system. firefox,https://www.mozilla.org,A web browser foremost,https://doc.ubuntu-fr.org/foremost,Foremost is a forensic tool for recovering files based on their headers / footers / and internal data structures. +freeipscanner,https://github.com/scrt/freeipscanner,A simple bash script to enumerate stale ADIDNS entries freerdp2-x11,https://github.com/FreeRDP/FreeRDP,FreeRDP is a free implementation of the Remote Desktop Protocol (RDP) released under the Apache license. frida,https://github.com/frida/frida,Dynamic instrumentation toolkit fuxploider,https://github.com/almandin/fuxploider,a Python tool for finding and exploiting file upload forms/directories. @@ -105,7 +108,7 @@ githubemail,https://github.com/paulirish/github-email,a command-line tool to ret gittools,https://github.com/internetwache/GitTools,A collection of Git tools including a powerful Dumper for dumping Git repositories. gmsadumper,https://github.com/micahvandeusen/gMSADumper,A tool for extracting credentials and other information from a Microsoft Active Directory domain. gobuster,https://github.com/OJ/gobuster,Tool to discover hidden files and directories. -goldencopy,https://github.com/0x09AL/golden_copy.git,A tool to copy data from Golden Ticket and Silver Ticket +goldencopy,https://github.com/Dramelac/GoldenCopy,Copy the properties and groups of a user from neo4j (bloodhound) to create an identical golden ticket GoMapEnum,https://github.com/nodauf/GoMapEnum,Nothing new but existing techniques are brought together in one tool. gopherus,https://github.com/tarunkant/Gopherus,Gopherus is a simple command line tool for exploiting vulnerable Gopher servers. gosecretsdump,https://github.com/c-sto/gosecretsdump,Implements NTLMSSP network authentication protocol in Go @@ -126,7 +129,7 @@ hashonymize,https://github.com/ShutdownRepo/hashonymize,This small tool is aimed hcxdumptool,https://github.com/ZerBea/hcxdumptool,Small tool to capture packets from wlan devices. hcxtools,https://github.com/ZerBea/hcxtools,Tools for capturing and analyzing packets from WLAN devices. hexedit,https://github.com/pixel/hexedit,View and edit binary files -holehe,https://github.com/megadose/holehe,Exploit a vulnerable Samba service to gain root access. +holehe,https://github.com/megadose/holehe,mail osint tool finding out if it is used on websites. hping3,https://github.com/antirez/hping,A network tool able to send custom TCP/IP packets httpmethods,https://github.com/ShutdownRepo/httpmethods,Tool for exploiting HTTP methods (e.g. PUT / DELETE / etc.) httprobe,https://github.com/tomnomnom/httprobe,A simple utility for enumerating HTTP and HTTPS servers. @@ -149,7 +152,7 @@ kadimus,https://github.com/P0cL4bs/Kadimus,a tool for detecting and exploiting f KeePwn,https://github.com/Orange-Cyberdefense/KeePwn,KeePwn is a tool that extracts passwords from KeePass 1.x and 2.x databases. kerbrute,https://github.com/ropnop/kerbrute,A tool to perform Kerberos pre-auth bruteforcing kiterunner,https://github.com/assetnote/kiterunner,Tool for operating Active Directory environments. -Kraken,https://github.com/kraken-ng/Kraken.git,Kraken is a modular multi-language webshell focused on web post-exploitation and defense evasion. It supports three technologies (PHP / JSP and ASPX) and is core is developed in Python. +Kraken,https://github.com/kraken-ng/Kraken,Kraken is a modular multi-language webshell focused on web post-exploitation and defense evasion. It supports three technologies (PHP / JSP and ASPX) and is core is developed in Python. krbjack,https://github.com/almandin/krbjack,A Kerberos AP-REQ hijacking tool with DNS unsecure updates abuse. krbrelayx,https://github.com/dirkjanm/krbrelayx,a tool for performing Kerberos relay attacks kubectl,https://kubernetes.io/docs/reference/kubectl/overview/,Command-line interface for managing Kubernetes clusters. @@ -245,6 +248,7 @@ pykek,https://github.com/preempt/pykek,PyKEK (Python Kerberos Exploitation Kit) pylaps,https://github.com/p0dalirius/pylaps,Utility for enumerating and querying LDAP servers. pypykatz,https://github.com/skelsec/pypykatz,a Python library for mimikatz-like functionality pyrit,https://github.com/JPaulMora/Pyrit,Python-based WPA/WPA2-PSK attack tool. +pywerview,https://github.com/the-useless-one/pywerview,A (partial) Python rewriting of PowerSploit's PowerView. pywhisker,https://github.com/ShutdownRepo/pywhisker,PyWhisker is a Python equivalent of the original Whisker made by Elad Shamir and written in C#. This tool allows users to manipulate the msDS-KeyCredentialLink attribute of a target user/computer to obtain full control over that object. It's based on Impacket and on a Python equivalent of Michael Grafnetter's DSInternals called PyDSInternals made by podalirius. pywsus,https://github.com/GoSecure/pywsus,Python implementation of a WSUS client radare2,https://github.com/radareorg/radare2,A complete framework for reverse-engineering and analyzing binaries @@ -280,7 +284,7 @@ shuffledns,https://github.com/projectdiscovery/shuffledns,A fast and customizabl simplyemail,https://github.com/SimplySecurity/SimplyEmail,a scriptable command line tool for sending emails sipvicious,https://github.com/enablesecurity/sipvicious,Enumeration and MITM tool for SIP devices sleuthkit,https://github.com/sleuthkit/sleuthkit,Forensic toolkit to analyze volume and file system data -sliver,https://github.com/BishopFox/sliver.git,Open source / cross-platform and extensible C2 framework +sliver,https://github.com/BishopFox/sliver,Open source / cross-platform and extensible C2 framework smali,https://github.com/JesusFreke/smali,A tool to disassemble and assemble Android's dex files smartbrute,https://github.com/ShutdownRepo/SmartBrute,The smart password spraying and bruteforcing tool for Active Directory Domain Services. smbclient,https://github.com/samba-team/samba,SMBclient is a command-line utility that allows you to access Windows shared resources @@ -310,7 +314,7 @@ TeamsPhisher,https://github.com/Octoberfest7/TeamsPhisher,TeamsPhisher is a Pyth testdisk,https://github.com/cgsecurity/testdisk,Partition recovery and file undelete utility testssl,https://github.com/drwetter/testssl.sh,a tool for testing SSL/TLS encryption on servers theharvester,https://github.com/laramies/theHarvester,Tool for gathering e-mail accounts / subdomain names / virtual host / open ports / banners / and employee names from different public sources -tig,https://github.com/jonas/tig.git,Tig is an ncurses-based text-mode interface for git. +tig,https://github.com/jonas/tig,Tig is an ncurses-based text-mode interface for git. timing,https://github.com/ffleming/timing_attack,Tool to generate a timing profile for a given command. tls-map,https://github.com/sec-it/tls-map,tls-map is a library for mapping TLS cipher algorithm names. tls-scanner,https://github.com/tls-attacker/tls-scanner,a simple script to check the security of a remote TLS/SSL web server diff --git a/source/assets/installed_tools/lists/latest_nightly_arm64.csv b/source/assets/installed_tools/lists/latest_nightly_arm64.csv index 4470b98..0e30553 100644 --- a/source/assets/installed_tools/lists/latest_nightly_arm64.csv +++ b/source/assets/installed_tools/lists/latest_nightly_arm64.csv @@ -12,7 +12,6 @@ apksigner,https://source.android.com/security/apksigning,arguably the most impor apktool,https://github.com/iBotPeaches/Apktool,It is a tool for reverse engineering 3rd party / closed / binary Android apps. arjun,https://github.com/s0md3v/Arjun,HTTP parameter discovery suite. arsenal,https://github.com/Orange-Cyberdefense/arsenal,Powerful weapons for penetration testing. -ascii,https://github.com/moul/ascii,ASCII command-line tool to replace images with color-coded ASCII art. assetfinder,https://github.com/tomnomnom/assetfinder,Tool to find subdomains and IP addresses associated with a domain. autoconf,https://www.gnu.org/software/autoconf/autoconf.html,Tool for producing shell scripts to configure source code packages autorecon,https://github.com/Tib3rius/AutoRecon,Multi-threaded network reconnaissance tool which performs automated enumeration of services. @@ -39,6 +38,7 @@ Censys,https://github.com/censys/censys-python,An easy-to-use and lightweight AP certipy,https://github.com/ly4k/Certipy,Python tool to create and sign certificates certsync,https://github.com/zblurx/certsync,certsync is a tool that helps you synchronize certificates between two directories. cewl,https://digi.ninja/projects/cewl.php,Generates custom wordlists by spidering a target's website and parsing the results +cewler,https://github.com/roys/cewler,CeWL alternative in Python chainsaw,https://github.com/WithSecureLabs/chainsaw,Rapidly Search and Hunt through Windows Forensic Artefacts checksec-py,https://github.com/Wenzel/checksec.py,Python wrapper script for checksec.sh from paX. chisel,https://github.com/jpillora/chisel,Go based TCP tunnel with authentication and encryption support @@ -51,10 +51,11 @@ cmsmap,https://github.com/Dionach/CMSmap,Tool for security audit of web content coercer,https://github.com/p0dalirius/coercer,DFS-R target coercion tool corscanner,https://github.com/chenjj/CORScanner,a Python script for finding CORS misconfigurations. cowpatty,https://github.com/joswr1ght/cowpatty,cowpatty is a tool for offline dictionary attacks against WPA-PSK (Pre-Shared Key) networks. -crackhound,https://github.com/trustedsec/crackhound.git,A fast WPA/WPA2/WPA3 WiFi Handshake capture / password recovery and analysis tool -crackmapexec,https://github.com/mpgn/CrackMapExec,Network scanner. +crackhound,https://github.com/trustedsec/crackhound,A fast WPA/WPA2/WPA3 WiFi Handshake capture / password recovery and analysis tool +crackmapexec,https://github.com/Porchetta-Industries/CrackMapExec,Network scanner. crunch,https://github.com/crunchsec/crunch,A wordlist generator where you can specify a standard character set or a character set you specify. cupp,https://github.com/Mebus/cupp,Cupp is a tool used to generate personalized password lists based on target information. +CyberChef,https://github.com/gchq/CyberChef/,The Cyber Swiss Army Knife cyperoth,https://github.com/seajaysec/cypheroth,Automated extensible toolset that runs cypher queries against Bloodhound's Neo4j backend and saves output to spreadsheets. darkarmour,https://github.com/bats3c/darkarmour,a tool to detect and evade common antivirus products dex2jar,https://github.com/pxb1988/dex2jar,A tool to convert Android's dex files to Java's jar files @@ -89,6 +90,7 @@ findomain,https://github.com/findomain/findomain,The fastest and cross-platform finduncommonshares,https://github.com/p0dalirius/FindUncommonShares,Script that can help identify shares that are not commonly found on a Windows system. firefox,https://www.mozilla.org,A web browser foremost,https://doc.ubuntu-fr.org/foremost,Foremost is a forensic tool for recovering files based on their headers / footers / and internal data structures. +freeipscanner,https://github.com/scrt/freeipscanner,A simple bash script to enumerate stale ADIDNS entries freerdp2-x11,https://github.com/FreeRDP/FreeRDP,FreeRDP is a free implementation of the Remote Desktop Protocol (RDP) released under the Apache license. frida,https://github.com/frida/frida,Dynamic instrumentation toolkit fuxploider,https://github.com/almandin/fuxploider,a Python tool for finding and exploiting file upload forms/directories. @@ -104,7 +106,7 @@ githubemail,https://github.com/paulirish/github-email,a command-line tool to ret gittools,https://github.com/internetwache/GitTools,A collection of Git tools including a powerful Dumper for dumping Git repositories. gmsadumper,https://github.com/micahvandeusen/gMSADumper,A tool for extracting credentials and other information from a Microsoft Active Directory domain. gobuster,https://github.com/OJ/gobuster,Tool to discover hidden files and directories. -goldencopy,https://github.com/0x09AL/golden_copy.git,A tool to copy data from Golden Ticket and Silver Ticket +goldencopy,https://github.com/Dramelac/GoldenCopy,Copy the properties and groups of a user from neo4j (bloodhound) to create an identical golden ticket GoMapEnum,https://github.com/nodauf/GoMapEnum,Nothing new but existing techniques are brought together in one tool. gopherus,https://github.com/tarunkant/Gopherus,Gopherus is a simple command line tool for exploiting vulnerable Gopher servers. gosecretsdump,https://github.com/c-sto/gosecretsdump,Implements NTLMSSP network authentication protocol in Go @@ -125,7 +127,7 @@ hashonymize,https://github.com/ShutdownRepo/hashonymize,This small tool is aimed hcxdumptool,https://github.com/ZerBea/hcxdumptool,Small tool to capture packets from wlan devices. hcxtools,https://github.com/ZerBea/hcxtools,Tools for capturing and analyzing packets from WLAN devices. hexedit,https://github.com/pixel/hexedit,View and edit binary files -holehe,https://github.com/megadose/holehe,Exploit a vulnerable Samba service to gain root access. +holehe,https://github.com/megadose/holehe,mail osint tool finding out if it is used on websites. hping3,https://github.com/antirez/hping,A network tool able to send custom TCP/IP packets httpmethods,https://github.com/ShutdownRepo/httpmethods,Tool for exploiting HTTP methods (e.g. PUT / DELETE / etc.) httprobe,https://github.com/tomnomnom/httprobe,A simple utility for enumerating HTTP and HTTPS servers. @@ -147,7 +149,7 @@ kadimus,https://github.com/P0cL4bs/Kadimus,a tool for detecting and exploiting f KeePwn,https://github.com/Orange-Cyberdefense/KeePwn,KeePwn is a tool that extracts passwords from KeePass 1.x and 2.x databases. kerbrute,https://github.com/ropnop/kerbrute,A tool to perform Kerberos pre-auth bruteforcing kiterunner,https://github.com/assetnote/kiterunner,Tool for operating Active Directory environments. -Kraken,https://github.com/kraken-ng/Kraken.git,Kraken is a modular multi-language webshell focused on web post-exploitation and defense evasion. It supports three technologies (PHP / JSP and ASPX) and is core is developed in Python. +Kraken,https://github.com/kraken-ng/Kraken,Kraken is a modular multi-language webshell focused on web post-exploitation and defense evasion. It supports three technologies (PHP / JSP and ASPX) and is core is developed in Python. krbjack,https://github.com/almandin/krbjack,A Kerberos AP-REQ hijacking tool with DNS unsecure updates abuse. krbrelayx,https://github.com/dirkjanm/krbrelayx,a tool for performing Kerberos relay attacks kubectl,https://kubernetes.io/docs/reference/kubectl/overview/,Command-line interface for managing Kubernetes clusters. @@ -240,6 +242,7 @@ pykek,https://github.com/preempt/pykek,PyKEK (Python Kerberos Exploitation Kit) pylaps,https://github.com/p0dalirius/pylaps,Utility for enumerating and querying LDAP servers. pypykatz,https://github.com/skelsec/pypykatz,a Python library for mimikatz-like functionality pyrit,https://github.com/JPaulMora/Pyrit,Python-based WPA/WPA2-PSK attack tool. +pywerview,https://github.com/the-useless-one/pywerview,A (partial) Python rewriting of PowerSploit's PowerView. pywhisker,https://github.com/ShutdownRepo/pywhisker,PyWhisker is a Python equivalent of the original Whisker made by Elad Shamir and written in C#. This tool allows users to manipulate the msDS-KeyCredentialLink attribute of a target user/computer to obtain full control over that object. It's based on Impacket and on a Python equivalent of Michael Grafnetter's DSInternals called PyDSInternals made by podalirius. pywsus,https://github.com/GoSecure/pywsus,Python implementation of a WSUS client radare2,https://github.com/radareorg/radare2,A complete framework for reverse-engineering and analyzing binaries @@ -275,7 +278,7 @@ shuffledns,https://github.com/projectdiscovery/shuffledns,A fast and customizabl simplyemail,https://github.com/SimplySecurity/SimplyEmail,a scriptable command line tool for sending emails sipvicious,https://github.com/enablesecurity/sipvicious,Enumeration and MITM tool for SIP devices sleuthkit,https://github.com/sleuthkit/sleuthkit,Forensic toolkit to analyze volume and file system data -sliver,https://github.com/BishopFox/sliver.git,Open source / cross-platform and extensible C2 framework +sliver,https://github.com/BishopFox/sliver,Open source / cross-platform and extensible C2 framework smali,https://github.com/JesusFreke/smali,A tool to disassemble and assemble Android's dex files smartbrute,https://github.com/ShutdownRepo/SmartBrute,The smart password spraying and bruteforcing tool for Active Directory Domain Services. smbclient,https://github.com/samba-team/samba,SMBclient is a command-line utility that allows you to access Windows shared resources @@ -304,7 +307,7 @@ TeamsPhisher,https://github.com/Octoberfest7/TeamsPhisher,TeamsPhisher is a Pyth testdisk,https://github.com/cgsecurity/testdisk,Partition recovery and file undelete utility testssl,https://github.com/drwetter/testssl.sh,a tool for testing SSL/TLS encryption on servers theharvester,https://github.com/laramies/theHarvester,Tool for gathering e-mail accounts / subdomain names / virtual host / open ports / banners / and employee names from different public sources -tig,https://github.com/jonas/tig.git,Tig is an ncurses-based text-mode interface for git. +tig,https://github.com/jonas/tig,Tig is an ncurses-based text-mode interface for git. timing,https://github.com/ffleming/timing_attack,Tool to generate a timing profile for a given command. tls-map,https://github.com/sec-it/tls-map,tls-map is a library for mapping TLS cipher algorithm names. tls-scanner,https://github.com/tls-attacker/tls-scanner,a simple script to check the security of a remote TLS/SSL web server diff --git a/source/assets/installed_tools/nightly.csv b/source/assets/installed_tools/nightly.csv index 881da01..57ded89 100644 --- a/source/assets/installed_tools/nightly.csv +++ b/source/assets/installed_tools/nightly.csv @@ -1,3 +1,3 @@ Image tag,Version,Arch,Build date,Tools list -nightly,552360f0,arm64,2023-10-02T17:32:46Z,:download:`nightly_552360f0_arm64.csv ` -nightly,552360f0,amd64,2023-10-02T17:00:45Z,:download:`nightly_552360f0_amd64.csv ` +nightly,55999787,arm64,2023-11-01T19:21:27Z,:download:`nightly_55999787_arm64.csv ` +nightly,55999787,amd64,2023-11-01T19:02:08Z,:download:`nightly_55999787_amd64.csv ` diff --git a/source/community/contributors.rst b/source/community/contributors.rst index d427a9f..bd5bc19 100644 --- a/source/community/contributors.rst +++ b/source/community/contributors.rst @@ -7,6 +7,7 @@ This part of the documentation is meant for Exegol contributors, those who write First things first, once you know on what module you want to contribute (`wrapper `_, `images `_, `documentation `_, `resources `_, etc.) `fork it `_, `checkout `_ to the ``dev`` branch, then come back to this page to start coding. .. contents:: + :local: Documentation ============== @@ -316,8 +317,8 @@ Tools sometimes have their own issues along their development. A temporary fix c function install_TOOL() { [...] # git -C /opt/tools/ clone --depth 1 https://github.com/REPO/TOOL.git - local TEMP_FIX_LIMIT="YYYY-MM-DD" - if [ "$(date +%Y%m%d)" -gt "$(date -d $TEMP_FIX_LIMIT +%Y%m%d)" ]; then + local temp_fix_limit="YYYY-MM-DD" + if [ "$(date +%Y%m%d)" -gt "$(date -d $temp_fix_limit +%Y%m%d)" ]; then criticalecho "Temp fix expired. Exiting." else git -C /opt/tools/ clone https://github.com/REPO/TOOL.git @@ -339,8 +340,8 @@ Tools sometimes have their own issues along their development. A temporary fix c function install_TOOL() { [...] git -C /opt/tools/ clone --depth 1 https://github.com/REPO/TOOL.git - local TEMP_FIX_LIMIT="YYYY-MM-DD" - if [ "$(date +%Y%m%d)" -gt "$(date -d $TEMP_FIX_LIMIT +%Y%m%d)" ]; then + local temp_fix_limit="YYYY-MM-DD" + if [ "$(date +%Y%m%d)" -gt "$(date -d $temp_fix_limit +%Y%m%d)" ]; then criticalecho "Temp fix expired. Exiting." else git config --local user.email "local" @@ -363,4 +364,4 @@ Wrapper .. hint:: - This documentation is not written yet... Please contact us if you would like to contribute to this part and don't know how. \ No newline at end of file + This documentation is not written yet... Please contact us if you would like to contribute to this part and don't know how. diff --git a/source/community/maintainers.rst b/source/community/maintainers.rst index ddb3f9b..ded96e7 100644 --- a/source/community/maintainers.rst +++ b/source/community/maintainers.rst @@ -5,6 +5,7 @@ Maintainers This part of the documentation is meant for Exegol maintainers. It adds up to the :doc:`contributors ` documentation. .. contents:: + :local: Wrapper release =============== diff --git a/source/community/users.rst b/source/community/users.rst index cce0e8e..83cea7c 100644 --- a/source/community/users.rst +++ b/source/community/users.rst @@ -5,6 +5,7 @@ Users This part of the documentation is meant for Exegol users, those who want to understand the project a bit more, open issues, get in touch with the community, etc.. .. contents:: + :local: Opening issues ============== diff --git a/source/exegol-image/my-resources.rst b/source/exegol-image/my-resources.rst index 4d4e2a5..3717b2a 100644 --- a/source/exegol-image/my-resources.rst +++ b/source/exegol-image/my-resources.rst @@ -19,6 +19,7 @@ Below are the features offered by "My-resources", allowing users to extend Exego * :ref:`User setup `: In this functionality, a shell script can be populated with every command a user wishes its containers to run at their creation. .. contents:: + :local: .. _Custom-tools: diff --git a/source/exegol-wrapper/advanced-uses.rst b/source/exegol-wrapper/advanced-uses.rst index 9a21c31..7ffee71 100644 --- a/source/exegol-wrapper/advanced-uses.rst +++ b/source/exegol-wrapper/advanced-uses.rst @@ -3,6 +3,7 @@ Advanced uses =============== .. contents:: + :local: .. _exegol_configuration: diff --git a/source/getting-started/faq.rst b/source/getting-started/faq.rst index ae97fc2..2c1c85b 100644 --- a/source/getting-started/faq.rst +++ b/source/getting-started/faq.rst @@ -5,7 +5,7 @@ Frequently asked questions Below are the frequently asked questions regarding either features, the overall project or troubleshooting matters. .. contents:: - :local: + :local: .. Frequently asked questions should be questions that actually got asked. @@ -27,8 +27,9 @@ There are multiple checks to do to make sure Docker works properly. .. tab:: Docker service The Docker service must installed up and running. - For Windows users, Docker Desktop for Windows must be up and running. - For macOS users, Docker Desktop for Mac (or `OrbStack `_) must be up and running. + + - For Windows users: Docker Desktop for Windows must be up and running. + - For macOS users: Docker Desktop for Mac (or `OrbStack `_) must be up and running. .. tab:: Docker permissions @@ -86,7 +87,18 @@ Yes. And you have multiple choices. Can I customize Exegol? ~~~~~~~~~~~~~~~~~~~~~~~ -Yes, please refer to the :doc:`"my-resources" documentation `. +Yes, please refer to the :doc:`"my-resources" documentation ` that explains how to automatically setup your changes to your Exegol containers. +Also, see the :doc:`"wrapper's advanced-uses" documentation ` to see how to edit Exegol's conf among other things. +You could also want to :ref:`make your own Exegol image ` + +.. _custom_image: + +Can I make my own Exegol image? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Yes. You will need to create a dockerfile (e.g. ``CUSTOM.dockerfile``) at the root of the exegol-images module next to the other dockerfiles (i.e. ``/path/to/Exegol/exegol-docker-build/``) containing the instructions you want the build process to follow. + +Then, run something like ``exegol install "myimagename" "CUSTOM"`` to build the image locally. See the ``install`` documentation: :doc:`install action `. How to install Exegol on an external drive? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -128,4 +140,14 @@ For macOS users, XQuartz is needed. It's listed in the :ref:`install requirement Exegol's wrapper automatically starts XQuartz on macOS hosts when needed. But if for some reason it gets manually closed by the users while a container is running, X11 sharing will not work. Restarting the container with ``exegol restart `` will restart XQuartz automatically if needed. +Can I install docker directly on my WSL2 distro instead of Docker Desktop ? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Yes, it's possible to install docker directly on WSL2 rather than using Docker Desktop, but you'll be restricted to your WSL2 environment and its constraints. + +Although Docker Desktop is incomplete, it does offer a few advantages (exegol can be used from powershell / cmd, windows folder sharing with the exegol workstation, etc). +We therefore recommend **Docker Desktop as the official support** for Exegol. + +We do **not** guarantee wrapper stability with a directly installed WSL docker. + .. TODO: add a note, when the Desktop feature is in prod, that explains the ups and dows of X11 vs. Desktop mode. \ No newline at end of file diff --git a/source/getting-started/install.rst b/source/getting-started/install.rst index f296c8d..ff54b20 100644 --- a/source/getting-started/install.rst +++ b/source/getting-started/install.rst @@ -13,6 +13,7 @@ Once the wrapper is installed, the second step in setting up Exegol on a device :doc:`here `). Both actions will guide the user in installing an image if needed. .. contents:: + :local: .. _install_requirements: @@ -23,7 +24,7 @@ The following elements are required before Exegol can be installed, whatever the * git (`Linux `__ | `macOS `__ | `Windows `__) * python3 (`Linux `__ | `macOS `__ | `Windows `__) -* docker (`Linux `__ | `macOS `__ | `Windows `__) +* docker (`Linux `__) or Docker Desktop (`macOS `__ | `Windows `__) * at least 20GB of free storage Additional dependencies may be required depending on the host OS. @@ -87,43 +88,24 @@ Additional dependencies may be required depending on the host OS. To support graphical applications (:ref:`display sharing functionality `, e.g. Bloodhound, Wireshark, Burp, etc.), additional dependencies and configuration are required: - * Windows **10** (with `KB5020030 `_), or Windows **11**, is required - * Docker must run on **WSL2** engine (`how to `_) - * `WSLg `_ must be installed - * at least one WSL distribution must be **installed** as well (e.g. Debian), with **Docker integration** and **Systemd** enabled + * Windows **10** (up to date), or Windows **11**, is required + * **Docker Desktop** installed on the Windows host + * Docker Desktop must be configured to run on **WSL2** engine (`how to `_) + * `WSLg `_ must be installed to support graphical application + * at least one WSL distribution must be **installed** as well (e.g. Debian), with **Docker integration** enabled (see screenshot below) - .. tip:: - To check if ``systemd`` is enabled on the distribution under WSL, the command below can be used. - - .. code-block:: bash - - sudo systemctl status - - To enable ``systemd``, the steps below can be followed. - - .. code-block:: bash - - sudo -e /etc/wsl.conf - - Add the following content: - .. code-block:: bash - - [boot] - systemd=true - - Then restart the distribution under WSL, and make sure ``systemd`` is enabled. - - .. code-block:: bash + .. figure:: /assets/install/windows_dockerdesktop_wsl_config.png + :align: center + :alt: Windows Docker Desktop WSL integration configuration - sudo systemctl status + Windows Docker Desktop WSL integration configuration - .. important:: - To support graphical applications, the distribution under WSL must have ``x11-xserver-utils`` installed. + In a Windows environment, the Exegol wrapper can be installed **either** in a **WSL shell** or directly in your Windows environment with **Powershell**. - .. code-block:: bash + .. warning:: - sudo apt-get install x11-xserver-utils + Please note that it is **not** advisable to use Exegol from both environments at the same time, as this could lead to conflicts and Exegol does not officially support this configuration. .. _exegol_install: