pwncat/CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

The Changelog starts with v0.4.1, because we did not keep one before that, and simply didn't have the time to go back and retroactively create one.

[Unreleased]

Minor bug fixes. Mainly typos from changing the package name.

Changed

• Fixed --version switch.
• Fixed readme typos.

Added

• Read the Docs Configuration File

[v0.5.0] - 2021-11-28

This is a major release mainly due to the name change, and PyPI package addition. The package has been renamed to pwncat-cs and the default entrypoint has also been renamed to pwncat-cs. These changes were made in an effort to deconflict with Cytopia pwncat. Beyond that, some new features were added as seen in the release notes below.

I've tried to update all references to the old pwncat entrypoint, but may have missed some throughout the documentation or code. Please open an issue if you notice any old references to the previous name.

It's worth noting that the internal module name is still pwncat, as Cytopia does not implement an importable package (only a command line entrypoint). I may change this name in the future, but for now it doesn't cause any issues and would require a major refactor so I'm going to leave it.

Changed

• Moved dependency management and building to Poetry.
• Changed package name to pwncat-cs in order to not conflict w/ cytopia/pwncat.

Added

• Added ssl-bind and ssl-connect channel protocols for encrypted shells
• Added ncat-style ssl arguments to entrypoint and connect command
• Added query-string arguments to connection strings for both the entrypoint and the connect command.
• Added Enumeration States to allow session-bound enumerations
• Added PyPi publishing to GitHub publish workflow.
• Added licensing for pwncat (MIT)
• Added background listener API and commands (#43)
• Added Windows privilege escalation via BadPotato plugin (#106)

Removed

• Removed setup.py and requirements.txt

[0.4.4] - 2021-11-28

Fixed

• Possible exception due to pre-registering of session with manager
• Covered edge case in sudo rule parsing for wildcards (#183)
• Added fallthrough cases for PTY methods in case of misbehaving binaries (looking at you: screen)
• Fixed handling of socket.getpeername when Socket channel uses IPv6 (#159).
• Fixed verbose logging handler to be unique for every channel
• Fixed docstrings in Command modules
• Changed docker base image to python3.9-alpine to fix python version issues.
• Added logic for calling correct paramiko method when reloading an encrypted SSH privat ekey (#185).
• Forced Stream.RAW for all GTFOBins interaction (#195).
• Added custom which implementation for linux when which is not available (#193).
• Correctly handle --listen argument (#201)
• Added handler for OSError when attempting to detect the running shell (#179)
• Added additional check for stat time of file birth field (#208)
• Removed shell compare with ["nologin", "false", "sync", "git-shell"] (#210)
• Added shell compare with not in ["bash", "zsh", "ksh", "fish"] (#210)

Added

• Added alternatives to bash to be used during shell upgrade for a better shell
• Added a warning message when a KeyboardInterrupt is caught
• Added --verbose/-V for argument parser
• Added OSError for bind protocol to show appropriate error messages
• Contributing guidelines for GitHub maintainers
• Installation instructions for BlackArch
• Added lpwd and lcd commands to interact with the local working directory (#218)

Changed

• Removed handling of shell argument to Popen to prevent euid problems (#179)
• Changed some 'red' warning message color to 'yellow'
• Leak private keys for all users w/ file-read ability as UID=0 (#181)
• Raise PermissionError when underlying processes terminate unsuccessfully for LinuxReader and LinuxWriter
• Removed busybox and bruteforce commands from documentation.

[0.4.3] - 2021-06-18

Patch fix release. Major fixes are the correction of file IO for LinuxWriters and improved stability with better exception handling.

Fixed

• Pinned container base image to alpine 3.13.5 and installed to virtualenv (#134)
• Fixed syntax for f-strings in escalation command
• Re-added readline import for windows platform after being accidentally removed
• Corrected processing of password in connection string

Changed

• Changed session tracking so session IDs aren't reused
• Changed zsh prompt to match CWD of other shell prompts
• Improved exception handling throughout framework (#133)
• Added explicit permission checks when opening files
• Changed LinuxWriter close routine again to account for needed EOF signals (#140)

Added

• Added better file io test cases

[0.4.2] - 2021-06-15

Quick patch release due to corrected bug in ChannelFile which caused command output to be empty in some situations.

Fixed

• Fixed linux.enumerate.system.network to work with old and new style ip.
• Fixed ChannelFile.recvinto which will no longer raise BlockingIOError (#126, #131)
• Fixed sessions command with invalid session ID (#130)
• Fixed zsh shell prompt color syntax (#130)

Added

• Added Pull Request template
• Added CONTRIBUTING.md
• Added --version option to entrypoint to retrieve pwncat version
• Added latest tag to documented install command to prevent dev installs

[0.4.1] - 2021-06-14

Added

• Differentiate prompt syntax for standard bash, zsh and sh (#126)
• Added -c=never to ip command in linux.enumerate.system.network (#126)
• Updated Dockerfile to properly build post-v0.4.0 releases (#125)
• Added check for nologin shell to stop pwncat from accidentally closing the session (#116)
• Resolved all flake8 errors (#123)
• Improved EOF handling for Linux file-writes (#117)