tpotce/docker/_tests/tests/cowrie.sh
2026-05-29 14:27:28 +02:00

737 lines
23 KiB
Bash
Executable file

#!/usr/bin/env bash
set -Eeuo pipefail
SCRIPT_DIR="$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" && pwd)"
# shellcheck source=../lib/common.sh
source "${SCRIPT_DIR}/../lib/common.sh"
TEST_NAME="cowrie"
DEFAULT_IMAGE="dtagdevsec/cowrie:24.04.1"
IMAGE=""
SSH_PORT=""
TELNET_PORT=""
PERSONA=""
LOG_DIR=""
TTY_LOG_DIR=""
DL_DIR=""
KEYS_DIR=""
JSON_LOG_FILE=""
MAPPED_SSH_PORT=""
MAPPED_TELNET_PORT=""
usage() {
cat <<EOF
Usage: $0 [options]
Run an isolated post-build smoke test for the Cowrie image.
Options:
--image IMAGE Image to test. Defaults to docker/cowrie/docker-compose.yml.
--ssh-port PORT Host TCP port for SSH. Default: dynamic free port.
--telnet-port PORT Host TCP port for Telnet. Default: dynamic free port.
--persona ID Force a generated Cowrie persona. Default: random.
--timeout SEC Timeout for startup, protocol, and log checks. Default: 30.
--bind-ip IP Host IP to bind. Default: 127.0.0.1.
--keep-artifacts Keep temporary compose file and logs for debugging.
-h, --help Show this help message.
EOF
}
parse_args() {
while [[ $# -gt 0 ]]; do
case "$1" in
--image)
[[ $# -ge 2 ]] || test_die "--image requires an argument"
IMAGE="$2"
shift 2
;;
--image=*)
IMAGE="${1#*=}"
shift
;;
--ssh-port)
[[ $# -ge 2 ]] || test_die "--ssh-port requires an argument"
SSH_PORT="$2"
shift 2
;;
--ssh-port=*)
SSH_PORT="${1#*=}"
shift
;;
--telnet-port)
[[ $# -ge 2 ]] || test_die "--telnet-port requires an argument"
TELNET_PORT="$2"
shift 2
;;
--telnet-port=*)
TELNET_PORT="${1#*=}"
shift
;;
--persona)
[[ $# -ge 2 ]] || test_die "--persona requires an argument"
PERSONA="$2"
shift 2
;;
--persona=*)
PERSONA="${1#*=}"
shift
;;
--timeout)
[[ $# -ge 2 ]] || test_die "--timeout requires an argument"
TEST_TIMEOUT="$2"
shift 2
;;
--timeout=*)
TEST_TIMEOUT="${1#*=}"
shift
;;
--bind-ip)
[[ $# -ge 2 ]] || test_die "--bind-ip requires an argument"
TEST_BIND_IP="$2"
shift 2
;;
--bind-ip=*)
TEST_BIND_IP="${1#*=}"
shift
;;
--keep-artifacts)
TEST_KEEP_ARTIFACTS="true"
shift
;;
-h|--help)
usage
exit 0
;;
*)
test_die "Unknown option: $1"
;;
esac
done
}
validate_args() {
test_validate_timeout
if [[ -n "${SSH_PORT}" ]]; then
test_validate_port "${SSH_PORT}"
fi
if [[ -n "${TELNET_PORT}" ]]; then
test_validate_port "${TELNET_PORT}"
fi
if [[ -n "${PERSONA}" && ! "${PERSONA}" =~ ^[a-z0-9][a-z0-9-]*$ ]]; then
test_die "--persona must contain only lowercase letters, numbers, and dashes"
fi
}
prepare_cowrie_harness() {
test_prepare_harness "${TEST_NAME}"
LOG_DIR="${TEST_TMP_ROOT}/log"
TTY_LOG_DIR="${LOG_DIR}/tty"
DL_DIR="${TEST_TMP_ROOT}/downloads"
KEYS_DIR="${TEST_TMP_ROOT}/keys"
JSON_LOG_FILE="${LOG_DIR}/cowrie.json"
TEST_ARTIFACT_LOG_DIR="${LOG_DIR}"
mkdir -p "${LOG_DIR}" "${TTY_LOG_DIR}" "${DL_DIR}" "${KEYS_DIR}"
chmod 0777 "${LOG_DIR}" "${TTY_LOG_DIR}" "${DL_DIR}" "${KEYS_DIR}"
cat > "${TEST_HARNESS_COMPOSE}" <<EOF
services:
cowrie:
image: "${IMAGE}"
container_name: "${TEST_CONTAINER_NAME}"
restart: "no"
read_only: true
user: "2000:2000"
tmpfs:
- /tmp/cowrie:uid=2000,gid=2000
- /tmp/cowrie/data:uid=2000,gid=2000
ports:
- "${TEST_BIND_IP}:${SSH_PORT}:22"
- "${TEST_BIND_IP}:${TELNET_PORT}:23"
environment:
COWRIE_PERSONA: "${PERSONA}"
volumes:
- "${DL_DIR}:/home/cowrie/cowrie/dl"
- "${KEYS_DIR}:/home/cowrie/cowrie/etc"
- "${LOG_DIR}:/home/cowrie/cowrie/log"
- "${TTY_LOG_DIR}:/home/cowrie/cowrie/log/tty"
networks:
default:
name: "${TEST_PROJECT_NAME}_net"
EOF
}
wait_for_json_log() {
local deadline=$((SECONDS + TEST_TIMEOUT))
while (( SECONDS < deadline )); do
if [[ -f "${JSON_LOG_FILE}" ]]; then
return 0
fi
sleep 1
done
return 1
}
run_ssh_banner_probe() {
local token="$1"
python3 - "${TEST_BIND_IP}" "${MAPPED_SSH_PORT}" "${token}" "${TEST_TIMEOUT}" <<'PY'
import socket
import sys
import time
host = sys.argv[1]
port = int(sys.argv[2])
token = sys.argv[3]
timeout = int(sys.argv[4])
deadline = time.monotonic() + timeout
client_banner = f"SSH-2.0-tpot-cowrie-smoke-{token}\r\n".encode("ascii")
try:
with socket.create_connection((host, port), timeout=timeout) as sock:
sock.settimeout(1)
chunks = []
while time.monotonic() < deadline:
try:
chunk = sock.recv(256)
except socket.timeout:
continue
if not chunk:
raise RuntimeError("Connection closed before SSH banner")
chunks.append(chunk)
if b"\n" in b"".join(chunks):
break
banner = b"".join(chunks).splitlines()[0]
if not banner.startswith(b"SSH-"):
raise RuntimeError(f"Expected SSH banner, got {banner!r}")
sock.sendall(client_banner)
time.sleep(0.2)
print(f"SSH banner: {banner.decode('ascii', errors='replace')}")
except Exception as exc:
print(f"SSH probe failed: {exc}", file=sys.stderr)
sys.exit(1)
PY
}
run_ssh_banner_probe_with_retries() {
local token="$1"
local deadline=$((SECONDS + TEST_TIMEOUT))
local output=""
while (( SECONDS < deadline )); do
if output="$(run_ssh_banner_probe "${token}" 2>&1)"; then
printf '%s\n' "${output}"
return 0
fi
sleep 1
done
printf '%s\n' "${output}" >&2
return 1
}
run_telnet_login_probe() {
local token="$1"
python3 - "${TEST_BIND_IP}" "${MAPPED_TELNET_PORT}" "${token}" "${TEST_TIMEOUT}" <<'PY'
import socket
import sys
import time
IAC = 255
DONT = 254
DO = 253
WONT = 252
WILL = 251
SB = 250
SE = 240
host = sys.argv[1]
port = int(sys.argv[2])
token = sys.argv[3]
timeout = int(sys.argv[4])
username = f"cowrie-user-{token}"
password = f"cowrie-pass-{token}"
deadline = time.monotonic() + timeout
def readable(data):
return data.decode("utf-8", errors="ignore").lower()
def read_until(sock, needles):
data = bytearray()
in_subnegotiation = False
while time.monotonic() < deadline:
try:
chunk = sock.recv(256)
except socket.timeout:
continue
if not chunk:
break
index = 0
while index < len(chunk):
byte = chunk[index]
if byte == IAC and index + 1 < len(chunk):
command = chunk[index + 1]
if command in (DO, DONT, WILL, WONT) and index + 2 < len(chunk):
option = chunk[index + 2]
if command in (DO, DONT):
sock.sendall(bytes([IAC, WONT, option]))
else:
sock.sendall(bytes([IAC, DONT, option]))
index += 3
continue
if command == SB:
in_subnegotiation = True
index += 2
continue
if command == SE:
in_subnegotiation = False
index += 2
continue
index += 2
continue
if not in_subnegotiation:
data.append(byte)
index += 1
text = readable(data)
if any(needle in text for needle in needles):
return bytes(data)
raise RuntimeError(f"Timed out waiting for one of {needles}; received {bytes(data)!r}")
try:
with socket.create_connection((host, port), timeout=timeout) as sock:
sock.settimeout(1)
login_prompt = read_until(sock, ("login:", "username:"))
sock.sendall((username + "\r\n").encode("ascii"))
password_prompt = read_until(sock, ("password:",))
sock.sendall((password + "\r\n").encode("ascii"))
time.sleep(0.5)
print(
"Telnet prompts: "
f"{login_prompt[-80:].decode('utf-8', errors='replace')!r}; "
f"{password_prompt[-80:].decode('utf-8', errors='replace')!r}"
)
except Exception as exc:
print(f"Telnet probe failed: {exc}", file=sys.stderr)
sys.exit(1)
PY
}
run_telnet_login_probe_with_retries() {
local token="$1"
local deadline=$((SECONDS + TEST_TIMEOUT))
local output=""
while (( SECONDS < deadline )); do
if output="$(run_telnet_login_probe "${token}" 2>&1)"; then
printf '%s\n' "${output}"
return 0
fi
sleep 1
done
printf '%s\n' "${output}" >&2
return 1
}
wait_for_json_event_containing() {
local token="$1"
local mode="$2"
python3 - "${JSON_LOG_FILE}" "${token}" "${mode}" "${TEST_TIMEOUT}" <<'PY'
import json
import sys
import time
from pathlib import Path
path = Path(sys.argv[1])
token = sys.argv[2]
mode = sys.argv[3]
timeout = int(sys.argv[4])
deadline = time.monotonic() + timeout
last_error = None
def contains_token(value):
if isinstance(value, str):
return token in value
if isinstance(value, dict):
return any(contains_token(item) for item in value.values())
if isinstance(value, list):
return any(contains_token(item) for item in value)
return False
def matches_mode(event):
eventid = str(event.get("eventid", ""))
if mode == "ssh":
return contains_token(event) and (
eventid.startswith("cowrie.client.")
or eventid.startswith("cowrie.session.")
or eventid.startswith("cowrie.login.")
)
if mode == "telnet":
return contains_token(event) and (
eventid.startswith("cowrie.login.")
or eventid.startswith("cowrie.session.")
or eventid.startswith("cowrie.client.")
)
raise RuntimeError(f"Unknown mode: {mode}")
while time.monotonic() < deadline:
if not path.exists():
last_error = f"{path} does not exist yet"
time.sleep(1)
continue
try:
lines = path.read_text(encoding="utf-8", errors="replace").splitlines()
except OSError as exc:
last_error = f"Could not read {path}: {exc}"
time.sleep(1)
continue
for line_number, line in enumerate(lines, 1):
if not line.strip():
continue
try:
event = json.loads(line)
except json.JSONDecodeError as exc:
last_error = f"Invalid JSON in {path}:{line_number}: {exc}"
continue
if matches_mode(event):
print(f"JSON event found in {path}:{line_number}: {event.get('eventid', '<missing eventid>')}")
sys.exit(0)
last_error = f"No {mode} JSON event found in {path} for token {token}"
time.sleep(1)
if last_error:
print(last_error, file=sys.stderr)
sys.exit(1)
PY
}
assert_custom_filesystem() {
docker exec -i "${TEST_CONTAINER_NAME}" python3 - <<'PY'
import configparser
import json
import pickle
from pathlib import Path
import sys
root = Path("/home/cowrie/cowrie")
personas_root = root / "personas"
metadata_path = personas_root / "personas.json"
selected_path = Path("/tmp/cowrie/persona")
runtime_config_path = Path("/tmp/cowrie/runtime/cowrie.cfg")
protocol_path = root / "src" / "cowrie" / "shell" / "protocol.py"
offenders = []
expected_package_managers = {
"ubuntu-jammy": {"apt", "apt-get", "dpkg"},
"debian-bookworm-vuln": {"apt", "apt-get", "dpkg"},
"fedora-36-vuln": {"dnf", "rpm", "yum"},
"rhel-9-vuln": {"dnf", "rpm", "yum"},
"dlink-dir859": set(),
"tplink-wr841n": set(),
"zyxel-nas326": set(),
"openwrt-1806": {"opkg"},
"qnap-qts": {"qpkg_cli"},
"synology-dsm": {"synopkg"},
"ubiquiti-edgerouter-x": {"apt-get", "dpkg"},
}
ubuntu_only_markers = (
b"ubuntu 22.04",
b"id=ubuntu",
b"jammy jellyfish",
)
package_manager_paths = (
"bin/apt",
"bin/apt-get",
"bin/dnf",
"bin/opkg",
"bin/rpm",
"bin/yum",
"sbin/opkg",
"sbin/qpkg_cli",
"usr/bin/apt",
"usr/bin/apt-get",
"usr/bin/dnf",
"usr/bin/dpkg",
"usr/bin/opkg",
"usr/bin/rpm",
"usr/bin/yum",
"usr/sbin/opkg",
"usr/sbin/qpkg_cli",
"usr/syno/bin/synopkg",
)
def read_bytes(path):
try:
return path.read_bytes()
except OSError as exc:
print(f"Could not read {path}: {exc}", file=sys.stderr)
sys.exit(1)
def fail(message):
print(message, file=sys.stderr)
sys.exit(1)
def check_forbidden(path, persona_id):
if "phil" in path.name.lower():
offenders.append(str(path))
if path.is_file():
data = read_bytes(path).lower()
forbidden = [
b"phil",
b"2.6.26-2-686",
b"2.6.26-19lenny",
b"com/ubuntu/upstart",
b"dannf@debian.org",
]
if persona_id != "ubuntu-jammy":
forbidden.extend(ubuntu_only_markers)
if any(marker in data for marker in forbidden):
offenders.append(str(path))
def node_children(node):
return node[7] if len(node) > 7 and isinstance(node[7], list) else []
def find_node(root_node, relative_path):
current = root_node
for part in Path(relative_path).parts:
if part in ("", "/"):
continue
current = next((child for child in node_children(current) if child[0] == part), None)
if current is None:
return None
return current
if not metadata_path.is_file():
fail(f"Missing Cowrie persona metadata: {metadata_path}")
if not selected_path.is_file():
fail(f"Missing selected Cowrie persona file: {selected_path}")
if not runtime_config_path.is_file():
fail(f"Missing runtime Cowrie config: {runtime_config_path}")
if "skip_python_commands" not in protocol_path.read_text(encoding="utf-8"):
fail("Cowrie protocol.py does not contain persona command filtering patch")
personas = json.loads(metadata_path.read_text(encoding="utf-8"))
if len(personas) != 11:
fail(f"Expected 11 Cowrie personas, found {len(personas)}")
ids = {persona["id"]: persona for persona in personas}
selected = selected_path.read_text(encoding="utf-8").strip()
if selected not in ids:
fail(f"Selected persona is not in personas.json: {selected}")
config = configparser.ConfigParser()
config.read(runtime_config_path)
selected_dir = personas_root / selected
expected_filesystem = selected_dir / "fs.pickle"
expected_honeyfs = selected_dir / "honeyfs"
expected_processes = selected_dir / "cmdoutput.json"
expected_txtcmds = selected_dir / "txtcmds"
if config.get("shell", "filesystem", fallback="") != str(expected_filesystem):
fail("Runtime config does not point to the selected fs.pickle")
if config.get("honeypot", "contents_path", fallback="") != str(expected_honeyfs):
fail("Runtime config does not point to the selected honeyfs")
if config.get("shell", "processes", fallback="") != str(expected_processes):
fail("Runtime config does not point to the selected cmdoutput.json")
if config.get("honeypot", "txtcmds_path", fallback="") != str(expected_txtcmds):
fail("Runtime config does not point to the selected txtcmds")
if config.get("ssh", "version", fallback="") != ids[selected]["ssh_banner"]:
fail("Runtime config SSH banner does not match selected persona metadata")
if "apt" not in config.get("shell", "skip_python_commands", fallback=""):
fail("Runtime config does not disable generic package-manager Python commands")
for persona_id, persona in ids.items():
persona_dir = personas_root / persona_id
pickle_path = persona_dir / "fs.pickle"
honeyfs = persona_dir / "honeyfs"
config_path = persona_dir / "cowrie.cfg"
cmdoutput_path = persona_dir / "cmdoutput.json"
txtcmds_path = persona_dir / "txtcmds"
if not pickle_path.is_file():
fail(f"Missing Cowrie persona pickle: {pickle_path}")
if not honeyfs.is_dir():
fail(f"Missing Cowrie persona honeyfs: {honeyfs}")
if not config_path.is_file():
fail(f"Missing Cowrie persona config: {config_path}")
if not cmdoutput_path.is_file():
fail(f"Missing Cowrie persona cmdoutput.json: {cmdoutput_path}")
if not txtcmds_path.is_dir():
fail(f"Missing Cowrie persona txtcmds: {txtcmds_path}")
if pickle_path.stat().st_size < 1000000:
fail(f"{persona_id} fs.pickle is unexpectedly small: {pickle_path.stat().st_size} bytes")
pickle_bytes = read_bytes(pickle_path)
with pickle_path.open("rb") as handle:
pickle_tree = pickle.load(handle)
if persona["user"].encode("utf-8") not in pickle_bytes:
fail(f"{persona_id} fs.pickle does not contain persona user {persona['user']}")
if persona["hostname"].encode("utf-8") not in pickle_bytes:
fail(f"{persona_id} fs.pickle does not contain persona hostname {persona['hostname']}")
if persona_id == "ubuntu-jammy":
for marker in ubuntu_only_markers:
if marker not in pickle_bytes.lower():
fail(f"{persona_id} fs.pickle does not contain Ubuntu marker {marker!r}")
if persona["ssh_banner"] not in config_path.read_text(encoding="utf-8"):
fail(f"{persona_id} config does not contain persona SSH banner")
cmdoutput = json.loads(cmdoutput_path.read_text(encoding="utf-8"))
if not cmdoutput.get("command", {}).get("ps"):
fail(f"{persona_id} cmdoutput.json has no ps process list")
config_text = config_path.read_text(encoding="utf-8")
if "skip_python_commands =" not in config_text:
fail(f"{persona_id} config does not define skip_python_commands")
package_managers = set(persona.get("package_managers", []))
if package_managers != expected_package_managers[persona_id]:
fail(f"{persona_id} package managers do not match persona: {sorted(package_managers)}")
for command_path in (
"bin/df",
"bin/dmesg",
"bin/mount",
"bin/ulimit",
"usr/bin/lscpu",
"usr/bin/nproc",
"usr/bin/top",
):
if not (txtcmds_path / command_path).is_file():
fail(f"{persona_id} txtcmds is missing {command_path}")
for command_path in package_manager_paths:
manager_name = Path(command_path).name
should_exist = manager_name in package_managers
exists_in_pickle = find_node(pickle_tree, command_path) is not None
exists_in_txtcmds = (txtcmds_path / command_path).is_file()
if should_exist and exists_in_txtcmds and not exists_in_pickle:
fail(f"{persona_id} package manager is missing from fs.pickle: {command_path}")
if not should_exist and (exists_in_pickle or exists_in_txtcmds):
fail(f"{persona_id} has mismatched package manager command: {command_path}")
passwd = read_bytes(honeyfs / "etc" / "passwd")
hostname = read_bytes(honeyfs / "etc" / "hostname")
os_release = read_bytes(honeyfs / "etc" / "os-release")
if persona["user"].encode("utf-8") not in passwd:
fail(f"{persona_id} honeyfs /etc/passwd does not contain persona user")
if persona["hostname"].encode("utf-8") not in hostname:
fail(f"{persona_id} honeyfs /etc/hostname does not contain persona hostname")
if not os_release.strip():
fail(f"{persona_id} honeyfs /etc/os-release is empty")
check_forbidden(pickle_path, persona_id)
check_forbidden(config_path, persona_id)
check_forbidden(cmdoutput_path, persona_id)
for item in honeyfs.rglob("*"):
check_forbidden(item, persona_id)
for item in txtcmds_path.rglob("*"):
check_forbidden(item, persona_id)
if offenders:
fail("Cowrie persona filesystem contains forbidden markers: " + ", ".join(offenders))
print(f"Cowrie persona pool validated: {selected} selected, {len(personas)} personas, no phil")
PY
}
assert_no_runtime_errors() {
if grep -R -E "Traceback|NameError|Unhandled Error|Exception" "${LOG_DIR}" >/dev/null 2>&1; then
test_die "Cowrie runtime error found in log files"
fi
if test_compose logs --no-color 2>/dev/null | grep -E "Traceback|NameError|Unhandled Error|Exception" >/dev/null 2>&1; then
test_die "Cowrie runtime error found in Docker logs"
fi
}
main() {
parse_args "$@"
validate_args
test_check_dependencies
if [[ -z "${IMAGE}" ]]; then
IMAGE="$(test_read_compose_image "${TEST_NAME}" "${DEFAULT_IMAGE}")"
fi
test_info "Using image: ${IMAGE}"
test_require_image "${IMAGE}" "docker compose -f docker/${TEST_NAME}/docker-compose.yml build ${TEST_NAME}"
if [[ -n "${SSH_PORT}" ]]; then
test_ensure_port_free "${TEST_BIND_IP}" "${SSH_PORT}" || test_die "${TEST_BIND_IP}:${SSH_PORT} is already in use. Try --ssh-port <free-port>."
fi
if [[ -n "${TELNET_PORT}" ]]; then
test_ensure_port_free "${TEST_BIND_IP}" "${TELNET_PORT}" || test_die "${TEST_BIND_IP}:${TELNET_PORT} is already in use. Try --telnet-port <free-port>."
fi
prepare_cowrie_harness
test_enable_cleanup
test_info "Starting isolated Cowrie container"
test_compose up -d --no-build >/dev/null
test_wait_for_container || test_die "Cowrie container did not stay running"
test_ok "Container is running"
MAPPED_SSH_PORT="$(test_get_mapped_port "${TEST_NAME}" "22")" || test_die "Could not resolve mapped host port for 22/tcp"
test_ok "Port ${TEST_BIND_IP}:${MAPPED_SSH_PORT} maps to container port 22/tcp"
MAPPED_TELNET_PORT="$(test_get_mapped_port "${TEST_NAME}" "23")" || test_die "Could not resolve mapped host port for 23/tcp"
test_ok "Port ${TEST_BIND_IP}:${MAPPED_TELNET_PORT} maps to container port 23/tcp"
test_info "Validating custom Cowrie filesystem profile"
assert_custom_filesystem || test_die "Custom Cowrie filesystem validation failed"
test_ok "Custom Cowrie filesystem profile is present"
test_info "Waiting for cowrie.json"
wait_for_json_log || test_die "cowrie.json was not created"
test_ok "cowrie.json exists"
local ssh_token="ssh-test-$(date +%s)-$$"
test_info "Running SSH banner probe with token: ${ssh_token}"
run_ssh_banner_probe_with_retries "${ssh_token}" || test_die "SSH probe failed on ${TEST_BIND_IP}:${MAPPED_SSH_PORT}"
test_wait_for_container || test_die "Cowrie container stopped after SSH probe"
test_info "Waiting for SSH probe event in cowrie.json"
wait_for_json_event_containing "${ssh_token}" "ssh" || test_die "SSH probe token was not found in cowrie.json"
test_ok "SSH probe was written to cowrie.json"
local telnet_token="telnet-test-$(date +%s)-$$"
test_info "Running Telnet login probe with token: ${telnet_token}"
run_telnet_login_probe_with_retries "${telnet_token}" || test_die "Telnet probe failed on ${TEST_BIND_IP}:${MAPPED_TELNET_PORT}"
test_wait_for_container || test_die "Cowrie container stopped after Telnet probe"
test_info "Waiting for Telnet probe event in cowrie.json"
wait_for_json_event_containing "${telnet_token}" "telnet" || test_die "Telnet probe token was not found in cowrie.json"
test_ok "Telnet probe was written to cowrie.json"
assert_no_runtime_errors
test_ok "No Cowrie runtime errors found in logs"
test_ok "Cowrie post-build smoke test completed successfully"
}
main "$@"