tracebit-python 0.1.0__py3-none-any.whl

tracebit/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.1.0"

tracebit/api.py

@@ -0,0 +1,65 @@
+import requests
+
+from .config import get_base_url
+
+
+class TracebitError(Exception):
+    pass
+
+
+class TracebitClient:
+    def __init__(self, token, base_url=None):
+        self.base_url = (base_url or get_base_url()).rstrip("/")
+        self.session = requests.Session()
+        self.session.headers["Authorization"] = f"Bearer {token}"
+        self.session.headers["Content-Type"] = "application/json"
+
+    def _url(self, path):
+        return f"{self.base_url}/api/v1/credentials/{path}"
+
+    def _check(self, resp, context="API request"):
+        if resp.status_code == 401:
+            raise TracebitError(
+                "Authentication failed (401). Check your API token."
+            )
+        if resp.status_code == 400:
+            raise TracebitError(f"{context} failed: {resp.text}")
+        resp.raise_for_status()
+
+    def generate_metadata(self):
+        resp = self.session.get(self._url("generate-metadata"))
+        self._check(resp, "Generate metadata")
+        return resp.json()
+
+    def issue_credentials(self, name, types, source="tracebit-python",
+                          source_type="endpoint", labels=None):
+        body = {
+            "name": name,
+            "types": types,
+            "source": source,
+            "sourceType": source_type,
+        }
+        if labels:
+            body["labels"] = [{"name": k, "value": v} for k, v in labels.items()]
+        resp = self.session.post(self._url("issue-credentials"), json=body)
+        self._check(resp, "Issue credentials")
+        return resp.json()
+
+    def confirm_credentials(self, confirmation_id):
+        resp = self.session.post(
+            self._url("confirm-credentials"),
+            json={"id": confirmation_id},
+        )
+        if resp.status_code == 404:
+            raise TracebitError(
+                f"Confirmation ID {confirmation_id} not found."
+            )
+        self._check(resp, "Confirm credentials")
+
+    def remove_credentials(self, name, cred_type="aws"):
+        """Notify Tracebit to expire credentials server-side."""
+        resp = self.session.post(
+            f"{self.base_url}/api/_internal/v1/cli/remove",
+            json={"name": name, "type": cred_type},
+        )
+        self._check(resp, "Remove credentials")

tracebit/aws.py

@@ -0,0 +1,80 @@
+import configparser
+import os
+from pathlib import Path
+
+
+AWS_DIR = Path.home() / ".aws"
+CREDENTIALS_FILE = AWS_DIR / "credentials"
+CONFIG_FILE = AWS_DIR / "config"
+
+
+def _ensure_aws_dir():
+    AWS_DIR.mkdir(mode=0o700, exist_ok=True)
+
+
+def _read_ini(path):
+    parser = configparser.ConfigParser()
+    if path.exists():
+        parser.read(str(path))
+    return parser
+
+
+def _write_ini(parser, path):
+    with open(path, "w") as f:
+        parser.write(f)
+    os.chmod(path, 0o600)
+
+
+def deploy_aws_credentials(profile, region, access_key_id, secret_access_key,
+                            session_token):
+    """Write canary AWS credentials to ~/.aws/credentials and ~/.aws/config."""
+    _ensure_aws_dir()
+
+    # credentials file
+    creds = _read_ini(CREDENTIALS_FILE)
+    if not creds.has_section(profile):
+        creds.add_section(profile)
+    creds.set(profile, "aws_access_key_id", access_key_id)
+    creds.set(profile, "aws_secret_access_key", secret_access_key)
+    creds.set(profile, "aws_session_token", session_token)
+    _write_ini(creds, CREDENTIALS_FILE)
+
+    # config file
+    config = _read_ini(CONFIG_FILE)
+    config_section = f"profile {profile}" if profile != "default" else "default"
+    if not config.has_section(config_section):
+        config.add_section(config_section)
+    config.set(config_section, "region", region)
+    _write_ini(config, CONFIG_FILE)
+
+
+def remove_aws_credentials(profile):
+    """Remove a profile from both AWS credential files."""
+    for path, section in [
+        (CREDENTIALS_FILE, profile),
+        (CONFIG_FILE, f"profile {profile}" if profile != "default" else "default"),
+    ]:
+        if not path.exists():
+            continue
+        parser = _read_ini(path)
+        if parser.has_section(section):
+            parser.remove_section(section)
+            _write_ini(parser, path)
+
+
+def get_aws_credentials(profile):
+    """Read back credentials for a profile, or None if not found."""
+    creds = _read_ini(CREDENTIALS_FILE)
+    if not creds.has_section(profile):
+        return None
+    return {
+        "aws_access_key_id": creds.get(profile, "aws_access_key_id", fallback=None),
+        "aws_secret_access_key": creds.get(profile, "aws_secret_access_key", fallback=None),
+        "aws_session_token": creds.get(profile, "aws_session_token", fallback=None),
+    }
+
+
+def profile_exists(profile):
+    """Check if a profile already exists in the credentials file."""
+    creds = _read_ini(CREDENTIALS_FILE)
+    return creds.has_section(profile)

tracebit/cli.py

@@ -0,0 +1,435 @@
+import argparse
+import json
+import socket
+import subprocess
+import sys
+from datetime import datetime, timezone
+
+import requests
+
+from .api import TracebitClient, TracebitError
+from .aws import deploy_aws_credentials, remove_aws_credentials, profile_exists
+from .config import load_token, save_token
+from .state import (
+    save_credential,
+    load_credentials,
+    remove_credential,
+    get_expiring_credentials,
+)
+
+
+def _get_client(args):
+    token = getattr(args, "token", None) or load_token()
+    if not token:
+        print(
+            "Error: No API token found. Set TRACEBIT_API_TOKEN, "
+            "run 'tracebit configure', or pass --token.",
+            file=sys.stderr,
+        )
+        sys.exit(1)
+    base_url = getattr(args, "base_url", None)
+    return TracebitClient(token, base_url=base_url)
+
+
+def _parse_labels(label_args):
+    if not label_args:
+        return {}
+    labels = {}
+    for item in label_args:
+        if "=" not in item:
+            print(f"Error: Invalid label format '{item}', expected key=value",
+                  file=sys.stderr)
+            sys.exit(1)
+        k, v = item.split("=", 1)
+        labels[k] = v
+    return labels
+
+
+def cmd_configure(args):
+    """Save API token to config file."""
+    if args.token_value:
+        token = args.token_value
+    elif not sys.stdin.isatty():
+        token = sys.stdin.read().strip()
+    else:
+        import getpass
+        token = getpass.getpass("API token: ")
+
+    if not token:
+        print("Error: No token provided.", file=sys.stderr)
+        sys.exit(1)
+
+    save_token(token)
+    print("Token saved to ~/.config/tracebit/token")
+
+
+def cmd_deploy_aws(args):
+    """Issue, deploy, and confirm AWS canary credentials."""
+    client = _get_client(args)
+    name = args.name or socket.gethostname()
+    labels = _parse_labels(args.labels)
+
+    # get defaults from API if profile/region not specified
+    profile = args.profile
+    region = args.region
+    if not region:
+        try:
+            meta = client.generate_metadata()
+            region = meta.get("awsRegion") or "us-east-1"
+        except Exception:
+            region = "us-east-1"
+    if not profile:
+        profile = "staging"
+
+    # check for existing profile (don't clobber real credentials)
+    if profile_exists(profile) and not args.force:
+        # check if it's one of ours (from state) — suggest --force
+        # if it's unknown, warn more strongly
+        ours = any(
+            c.get("profile") == profile
+            for c in load_credentials()
+            if c["type"] == "aws"
+        )
+        if ours:
+            print(
+                f"Error: AWS profile '{profile}' already has a canary deployed. "
+                f"Use --force to replace it, or 'tracebit refresh' to renew.",
+                file=sys.stderr,
+            )
+        else:
+            print(
+                f"Error: AWS profile '{profile}' already exists and is NOT a "
+                f"known canary — refusing to overwrite. Use --profile to choose "
+                f"a different name, or --force if you're sure.",
+                file=sys.stderr,
+            )
+        sys.exit(1)
+
+    # if --force and there's an existing canary for this profile, expire it first
+    if args.force:
+        existing = [
+            c for c in load_credentials()
+            if c["type"] == "aws" and c.get("profile") == profile
+        ]
+        for old in existing:
+            try:
+                client.remove_credentials(old["name"], "aws")
+                print(f"Expired previous canary '{old['name']}' on Tracebit.")
+            except TracebitError:
+                pass
+            remove_credential(old["name"], "aws")
+
+    # issue credentials
+    print(f"Issuing AWS canary credentials (name={name}, profile={profile})...")
+    try:
+        result = client.issue_credentials(
+            name=name, types=["aws"], source="tracebit-python",
+            source_type="endpoint", labels=labels,
+        )
+    except TracebitError as e:
+        print(f"Error: {e}", file=sys.stderr)
+        sys.exit(1)
+
+    aws = result.get("aws")
+    if not aws:
+        print("Error: No AWS credentials in response.", file=sys.stderr)
+        sys.exit(1)
+
+    # deploy locally
+    deploy_aws_credentials(
+        profile=profile,
+        region=region,
+        access_key_id=aws["awsAccessKeyId"],
+        secret_access_key=aws["awsSecretAccessKey"],
+        session_token=aws["awsSessionToken"],
+    )
+    print(f"Credentials written to ~/.aws/credentials [{profile}]")
+
+    # confirm deployment
+    try:
+        client.confirm_credentials(aws["awsConfirmationId"])
+        print("Deployment confirmed with Tracebit.")
+    except TracebitError as e:
+        print(f"Warning: Could not confirm deployment: {e}", file=sys.stderr)
+
+    # save state
+    save_credential({
+        "name": name,
+        "type": "aws",
+        "profile": profile,
+        "region": region,
+        "expiration": aws["awsExpiration"],
+        "confirmation_id": aws["awsConfirmationId"],
+        "labels": labels,
+    })
+
+    if args.json_output:
+        print(json.dumps({
+            "profile": profile,
+            "region": region,
+            "access_key_id": aws["awsAccessKeyId"],
+            "expiration": aws["awsExpiration"],
+        }, indent=2))
+    else:
+        print(f"\nCanary deployed successfully!")
+        print(f"  Profile:    {profile}")
+        print(f"  Region:     {region}")
+        print(f"  Access Key: {aws['awsAccessKeyId']}")
+        print(f"  Expires:    {aws['awsExpiration']}")
+
+
+def cmd_refresh(args):
+    """Refresh credentials expiring within the given threshold."""
+    client = _get_client(args)
+    hours = args.hours
+    expiring = get_expiring_credentials(hours=hours)
+
+    if not expiring:
+        print("No credentials need refreshing.")
+        return
+
+    failures = 0
+    for cred in expiring:
+        if cred["type"] != "aws":
+            print(f"Skipping non-AWS credential: {cred['name']}")
+            continue
+
+        print(f"Refreshing AWS credential '{cred['name']}'...")
+        try:
+            result = client.issue_credentials(
+                name=cred["name"], types=["aws"], source="tracebit-python",
+                source_type="endpoint", labels=cred.get("labels", {}),
+            )
+        except (TracebitError, requests.RequestException) as e:
+            print(f"Error refreshing {cred['name']}: {e}", file=sys.stderr)
+            failures += 1
+            continue
+
+        aws = result.get("aws")
+        if not aws:
+            print(f"Error: No AWS credentials in refresh response for {cred['name']}.",
+                  file=sys.stderr)
+            failures += 1
+            continue
+
+        deploy_aws_credentials(
+            profile=cred["profile"],
+            region=cred["region"],
+            access_key_id=aws["awsAccessKeyId"],
+            secret_access_key=aws["awsSecretAccessKey"],
+            session_token=aws["awsSessionToken"],
+        )
+
+        try:
+            client.confirm_credentials(aws["awsConfirmationId"])
+        except (TracebitError, requests.RequestException) as e:
+            print(f"Warning: Could not confirm refresh for {cred['name']}: {e}",
+                  file=sys.stderr)
+
+        save_credential({
+            "name": cred["name"],
+            "type": "aws",
+            "profile": cred["profile"],
+            "region": cred["region"],
+            "expiration": aws["awsExpiration"],
+            "confirmation_id": aws["awsConfirmationId"],
+            "labels": cred.get("labels", {}),
+        })
+        print(f"  Refreshed. New expiration: {aws['awsExpiration']}")
+
+    if failures:
+        print(f"\n{failures} credential(s) failed to refresh.", file=sys.stderr)
+        sys.exit(1)
+
+
+def cmd_trigger_aws(args):
+    """Test-fire an AWS canary credential."""
+    creds = load_credentials()
+    aws_creds = [c for c in creds if c["type"] == "aws"]
+
+    if not aws_creds:
+        print("No AWS canary credentials deployed.", file=sys.stderr)
+        sys.exit(1)
+
+    if args.name:
+        match = [c for c in aws_creds if c["name"] == args.name]
+        if not match:
+            print(f"No AWS credential found with name '{args.name}'.",
+                  file=sys.stderr)
+            sys.exit(1)
+        cred = match[0]
+    else:
+        cred = aws_creds[0]
+
+    profile = cred["profile"]
+    print(f"Triggering canary credential (profile={profile})...")
+
+    try:
+        result = subprocess.run(
+            ["aws", "sts", "get-caller-identity", "--profile", profile],
+            capture_output=True, text=True, timeout=10,
+        )
+        if result.returncode == 0 and "arn:aws:sts::" in result.stdout:
+            print("Canary triggered successfully!")
+            print(result.stdout.strip())
+        else:
+            print("Trigger command ran but output was unexpected:")
+            if result.stdout:
+                print(result.stdout.strip())
+            if result.stderr:
+                print(result.stderr.strip(), file=sys.stderr)
+    except FileNotFoundError:
+        print(
+            "Error: 'aws' CLI not found. Install it to use the trigger command.",
+            file=sys.stderr,
+        )
+        sys.exit(1)
+    except subprocess.TimeoutExpired:
+        print("Error: Trigger command timed out.", file=sys.stderr)
+        sys.exit(1)
+
+
+def cmd_show(args):
+    """Display deployed canary credentials."""
+    creds = load_credentials()
+    if not creds:
+        print("No canary credentials deployed.")
+        return
+
+    if args.json_output:
+        print(json.dumps(creds, indent=2))
+        return
+
+    now = datetime.now(timezone.utc)
+    for c in creds:
+        exp_str = c.get("expiration", "unknown")
+        status = ""
+        if exp_str and exp_str != "unknown":
+            try:
+                exp_dt = datetime.fromisoformat(exp_str.replace("Z", "+00:00"))
+                if exp_dt < now:
+                    status = " [EXPIRED]"
+                elif (exp_dt - now).total_seconds() < 7200:
+                    status = " [EXPIRING SOON]"
+            except ValueError:
+                pass
+
+        print(f"  Name:       {c['name']}")
+        print(f"  Type:       {c['type']}")
+        if c["type"] == "aws":
+            print(f"  Profile:    {c.get('profile', 'n/a')}")
+            print(f"  Region:     {c.get('region', 'n/a')}")
+        print(f"  Expires:    {exp_str}{status}")
+        if c.get("labels"):
+            print(f"  Labels:     {c['labels']}")
+        print()
+
+
+def cmd_remove(args):
+    """Remove deployed canary credentials."""
+    client = _get_client(args)
+    creds = load_credentials()
+
+    if args.name:
+        matches = [c for c in creds if c["name"] == args.name]
+    else:
+        matches = creds
+
+    if not matches:
+        print("No matching credentials found.")
+        return
+
+    for c in matches:
+        # expire server-side
+        try:
+            client.remove_credentials(c["name"], c["type"])
+            print(f"Expired '{c['name']}' ({c['type']}) on Tracebit.")
+        except TracebitError as e:
+            print(f"Warning: Could not expire server-side: {e}", file=sys.stderr)
+
+        if c["type"] == "aws":
+            remove_aws_credentials(c.get("profile", ""))
+            print(f"Removed AWS profile '{c.get('profile')}' from ~/.aws/")
+        remove_credential(c["name"], c["type"])
+        print(f"Removed credential '{c['name']}' ({c['type']}) from state.")
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        prog="tracebit",
+        description="Manage Tracebit canary credentials",
+    )
+    parser.add_argument("--token", help="API token (overrides env/config)")
+    parser.add_argument("--base-url", help="Override Tracebit API base URL")
+    parser.add_argument("--json", dest="json_output", action="store_true",
+                        help="Output in JSON format where supported")
+
+    sub = parser.add_subparsers(dest="command")
+
+    # configure
+    p_conf = sub.add_parser("configure", help="Save API token")
+    p_conf.add_argument("token_value", nargs="?", help="Token to save")
+
+    # deploy
+    p_deploy = sub.add_parser("deploy", help="Deploy canary credentials")
+    deploy_sub = p_deploy.add_subparsers(dest="deploy_type")
+
+    p_aws = deploy_sub.add_parser("aws", help="Deploy AWS canary credentials")
+    p_aws.add_argument("--name", help="Credential name for Tracebit dashboard (default: hostname)")
+    p_aws.add_argument("--profile",
+                        help="AWS profile name — pick something realistic "
+                             "e.g. 'staging', 'backup', 'legacy-admin' (default: from API)")
+    p_aws.add_argument("--region", help="AWS region (default: from API)")
+    p_aws.add_argument("--labels", nargs="*", metavar="KEY=VALUE",
+                        help="Labels as key=value pairs")
+    p_aws.add_argument("--force", action="store_true",
+                        help="Overwrite existing profile")
+
+    # refresh
+    p_refresh = sub.add_parser("refresh", help="Refresh expiring credentials")
+    p_refresh.add_argument("--hours", type=float, default=13,
+                           help="Refresh credentials expiring within this many hours (default: 13)")
+
+    # trigger
+    p_trigger = sub.add_parser("trigger", help="Test-fire a canary credential")
+    trigger_sub = p_trigger.add_subparsers(dest="trigger_type")
+    p_trig_aws = trigger_sub.add_parser("aws", help="Trigger AWS canary")
+    p_trig_aws.add_argument("--name", help="Credential name to trigger")
+
+    # show
+    sub.add_parser("show", help="Show deployed credentials")
+
+    # remove
+    p_remove = sub.add_parser("remove", help="Remove deployed credentials")
+    p_remove.add_argument("--name", help="Name of credential to remove (all if omitted)")
+
+    args = parser.parse_args()
+
+    if not args.command:
+        parser.print_help()
+        sys.exit(1)
+
+    if args.command == "configure":
+        cmd_configure(args)
+    elif args.command == "deploy":
+        if not getattr(args, "deploy_type", None):
+            p_deploy.print_help()
+            sys.exit(1)
+        if args.deploy_type == "aws":
+            cmd_deploy_aws(args)
+    elif args.command == "refresh":
+        cmd_refresh(args)
+    elif args.command == "trigger":
+        if not getattr(args, "trigger_type", None):
+            p_trigger.print_help()
+            sys.exit(1)
+        if args.trigger_type == "aws":
+            cmd_trigger_aws(args)
+    elif args.command == "show":
+        cmd_show(args)
+    elif args.command == "remove":
+        cmd_remove(args)
+
+
+if __name__ == "__main__":
+    main()

tracebit/config.py

@@ -0,0 +1,28 @@
+import os
+from pathlib import Path
+
+
+DEFAULT_BASE_URL = "https://community.tracebit.com"
+CONFIG_DIR = Path.home() / ".config" / "tracebit"
+TOKEN_FILE = CONFIG_DIR / "token"
+
+
+def get_base_url():
+    return os.environ.get("TRACEBIT_URL", DEFAULT_BASE_URL).rstrip("/")
+
+
+def load_token():
+    """Load API token from env var or config file."""
+    token = os.environ.get("TRACEBIT_API_TOKEN")
+    if token:
+        return token.strip()
+    if TOKEN_FILE.exists():
+        return TOKEN_FILE.read_text().strip()
+    return None
+
+
+def save_token(token):
+    """Save API token to config file with restricted permissions."""
+    CONFIG_DIR.mkdir(parents=True, exist_ok=True)
+    TOKEN_FILE.write_text(token.strip() + "\n")
+    TOKEN_FILE.chmod(0o600)

tracebit/state.py

@@ -0,0 +1,81 @@
+import json
+import os
+from datetime import datetime, timezone
+from pathlib import Path
+
+
+STATE_DIR = Path.home() / ".config" / "tracebit"
+STATE_FILE = STATE_DIR / "state.json"
+
+
+def _load_state():
+    if not STATE_FILE.exists():
+        return {"credentials": []}
+    with open(STATE_FILE) as f:
+        return json.load(f)
+
+
+def _save_state(state):
+    STATE_DIR.mkdir(parents=True, exist_ok=True)
+    with open(STATE_FILE, "w") as f:
+        json.dump(state, f, indent=2)
+    os.chmod(STATE_FILE, 0o600)
+
+
+def save_credential(data):
+    """Save or update a deployed credential entry.
+
+    data should contain: name, type, profile, region, expiration,
+    confirmation_id, labels (dict).
+    """
+    state = _load_state()
+    # replace existing entry with same name+type
+    state["credentials"] = [
+        c for c in state["credentials"]
+        if not (c["name"] == data["name"] and c["type"] == data["type"])
+    ]
+    state["credentials"].append(data)
+    _save_state(state)
+
+
+def load_credentials():
+    """Return list of all deployed credentials."""
+    return _load_state().get("credentials", [])
+
+
+def remove_credential(name, cred_type=None):
+    """Remove a credential by name (and optionally type)."""
+    state = _load_state()
+    if cred_type:
+        state["credentials"] = [
+            c for c in state["credentials"]
+            if not (c["name"] == name and c["type"] == cred_type)
+        ]
+    else:
+        state["credentials"] = [
+            c for c in state["credentials"] if c["name"] != name
+        ]
+    _save_state(state)
+
+
+def get_credential(name, cred_type="aws"):
+    """Get a specific credential by name and type."""
+    for c in load_credentials():
+        if c["name"] == name and c["type"] == cred_type:
+            return c
+    return None
+
+
+def get_expiring_credentials(hours=2):
+    """Return credentials expiring within the given number of hours."""
+    now = datetime.now(timezone.utc)
+    expiring = []
+    for c in load_credentials():
+        exp = c.get("expiration")
+        if not exp:
+            continue
+        exp_dt = datetime.fromisoformat(exp.replace("Z", "+00:00"))
+        diff = (exp_dt - now).total_seconds() / 3600
+        if diff < hours:
+            expiring.append(c)
+    return expiring

tracebit_python-0.1.0.dist-info/METADATA

@@ -0,0 +1,200 @@
+Metadata-Version: 2.4
+Name: tracebit-python
+Version: 0.1.0
+Summary: CLI for managing Tracebit canary credentials on headless servers
+License: Apache-2.0
+Project-URL: Repository, https://github.com/SiteRelEnby/tracebit-python
+Project-URL: Issues, https://github.com/SiteRelEnby/tracebit-python/issues
+Keywords: tracebit,canary,honeypot,aws,credentials,security,detection,deception
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: System Administrators
+Classifier: Operating System :: POSIX
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Security
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.20
+Dynamic: license-file
+
+# tracebit-python
+
+[![PyPI](https://img.shields.io/pypi/v/tracebit-python)](https://pypi.org/project/tracebit-python/)
+[![Python](https://img.shields.io/pypi/pyversions/tracebit-python)](https://pypi.org/project/tracebit-python/)
+[![License](https://img.shields.io/pypi/l/tracebit-python)](LICENSE)
+![transrights](https://pride-badges.pony.workers.dev/static/v1?label=trans%20rights&stripeWidth=6&stripeColors=5BCEFA,F5A9B8,FFFFFF,F5A9B8,5BCEFA)
+![enbyware](https://pride-badges.pony.workers.dev/static/v1?label=enbyware&labelColor=%23555&stripeWidth=8&stripeColors=FCF434%2CFFFFFF%2C9C59D1%2C2C2C2C)
+![pluralmade](https://pride-badges.pony.workers.dev/static/v1?label=plural+made&labelColor=%23555&stripeWidth=8&stripeColors=2e0525%2C553578%2C7675c3%2C89c7b0%2Cf4ecbd)
+
+Python CLI for deploying [Tracebit](https://community.tracebit.com/) canary
+credentials on headless servers.
+
+Tracebit provides canary tokens — fake credentials that trigger alerts when
+used by an attacker. Their official CLI requires browser-based OAuth, which
+doesn't work on headless servers. This tool uses the Tracebit API directly
+with pre-generated API tokens.
+
+## Installation
+
+```bash
+pip install tracebit-python
+```
+
+Or from source:
+
+```bash
+git clone https://github.com/SiteRelEnby/tracebit-python
+cd tracebit-python
+pip install -e .
+```
+
+## Quick Start
+
+### 1. Get an API token
+
+Log in to [community.tracebit.com](https://community.tracebit.com/) and
+create an API token from the web UI.
+
+### 2. Configure
+
+```bash
+tracebit configure
+# paste your API token when prompted
+```
+
+Or use an environment variable:
+
+```bash
+export TRACEBIT_API_TOKEN=your-token-here
+```
+
+### 3. Deploy a canary
+
+```bash
+tracebit deploy aws --profile staging
+```
+
+This issues canary AWS credentials from Tracebit, writes them to
+`~/.aws/credentials` under the specified profile, and confirms the
+deployment. If anyone (or anything) uses these credentials, Tracebit
+fires an alert.
+
+### 4. Test it
+
+```bash
+tracebit trigger aws
+```
+
+Runs `aws sts get-caller-identity` against the canary profile. You should
+see an alert on the Tracebit dashboard within a few minutes.
+
+### 5. Keep credentials fresh
+
+Canary credentials expire after ~24 hours. Set up a cron job to refresh them:
+
+```bash
+# crontab -e
+0 */12 * * * /path/to/tracebit refresh
+```
+
+## Commands
+
+### `tracebit configure [TOKEN]`
+
+Save an API token to `~/.config/tracebit/token`. Reads from argument, stdin,
+or interactive prompt.
+
+### `tracebit deploy aws`
+
+Issue and deploy canary AWS credentials.
+
+| Option | Default | Description |
+|--------|---------|-------------|
+| `--name` | hostname | Credential name (shown on Tracebit dashboard) |
+| `--profile` | `staging` | AWS profile name in `~/.aws/credentials` |
+| `--region` | from API | AWS region |
+| `--labels` | | Metadata as `key=value` pairs |
+| `--force` | | Replace existing profile (expires old canary first) |
+
+Choose a realistic profile name — `staging`, `backup`, `legacy-admin`, etc.
+The whole point is for these to look like real credentials to an attacker.
+
+### `tracebit refresh`
+
+Re-issue any credentials expiring within the given threshold. Designed to run
+from cron.
+
+| Option | Default | Description |
+|--------|---------|-------------|
+| `--hours` | `13` | Refresh credentials expiring within this many hours |
+
+With 24h credentials and a 12h cron, the default of 13 hours ensures every
+cron run refreshes credentials.
+
+### `tracebit trigger aws`
+
+Test-fire a canary by calling `aws sts get-caller-identity` with the canary
+profile. Requires the AWS CLI to be installed.
+
+| Option | Default | Description |
+|--------|---------|-------------|
+| `--name` | first found | Credential name to trigger |
+
+### `tracebit show`
+
+Display deployed canary credentials, their profiles, and expiration status.
+
+### `tracebit remove`
+
+Remove canary credentials locally and expire them on Tracebit's server.
+
+| Option | Default | Description |
+|--------|---------|-------------|
+| `--name` | all | Name of credential to remove |
+
+## Global Options
+
+| Option | Description |
+|--------|-------------|
+| `--token TOKEN` | API token (overrides env var and config file) |
+| `--base-url URL` | Override Tracebit API URL |
+| `--json` | JSON output (where supported) |
+
+## Token Resolution
+
+The API token is resolved in this order:
+
+1. `--token` command-line flag
+2. `TRACEBIT_API_TOKEN` environment variable
+3. `~/.config/tracebit/token` file
+
+## How It Works
+
+1. **Issue** — requests canary AWS credentials from the Tracebit API
+2. **Deploy** — writes them to `~/.aws/credentials` and `~/.aws/config`
+   under the chosen profile name
+3. **Confirm** — tells Tracebit the credentials were deployed, so it starts
+   monitoring for usage
+4. **Alert** — any AWS API call using these credentials triggers a detection
+   on the Tracebit dashboard
+
+The credentials have an explicit deny policy — they can't actually do anything
+in AWS. But any attempt to use them (by an attacker who found them on disk,
+in a config file, etc.) is logged and alerted on.
+
+## File Permissions
+
+- `~/.aws/` directory: `0700`
+- `~/.aws/credentials`, `~/.aws/config`: `0600`
+- `~/.config/tracebit/token`: `0600`
+- `~/.config/tracebit/state.json`: `0600`
+
+## License
+
+[Apache License 2.0](LICENSE)

tracebit_python-0.1.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+tracebit/__init__.py,sha256=kUR5RAFc7HCeiqdlX36dZOHkUI5wI6V_43RpEcD8b-0,22
+tracebit/api.py,sha256=c4JeIqio63BCJYgpMJ4UbrPH3QLk9ntvxRr_kQxKYio,2244
+tracebit/aws.py,sha256=e1v3cFRjCa5dnmC3o9Z4fLTo8snoBxcnXtTfk1KqNXE,2503
+tracebit/cli.py,sha256=-opbLUpX0HsBvZfBWVLBNm7a0SuFZmX8uC8RHDHk-oM,14517
+tracebit/config.py,sha256=4Ij0n9r7vnjBOXtr5ocb67cqh3_XplETEe94TPC3D7w,743
+tracebit/state.py,sha256=8LI8VBOKcoFrOXmWnxuWMldyYy6avOSXzFglnZclxls,2251
+tracebit_python-0.1.0.dist-info/licenses/LICENSE,sha256=v3xdaciFoLUqc5hVeC4fmMEJChMUxbCW6D-bJIPgbW4,10773
+tracebit_python-0.1.0.dist-info/METADATA,sha256=ZCZph8PPtJWqdBCRBw9d6W-YVNXhk0AJkvZzEPYBFHU,6271
+tracebit_python-0.1.0.dist-info/WHEEL,sha256=YCfwYGOYMi5Jhw2fU4yNgwErybb2IX5PEwBKV4ZbdBo,91
+tracebit_python-0.1.0.dist-info/entry_points.txt,sha256=mssiXqZ3necMdOeKdjEG2vQvp4u1hlsmuBnhqsl-UyY,47
+tracebit_python-0.1.0.dist-info/top_level.txt,sha256=vxCf1kl0TOzPUugMSloikJ23W9aqNVhyE8dm7T0nQVs,9
+tracebit_python-0.1.0.dist-info/RECORD,,

tracebit_python-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

tracebit_python-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+tracebit = tracebit.cli:main

tracebit_python-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2025 keyquorum contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

tracebit_python-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+tracebit