Function run_github_osint

openosint/tools/search_github.py:128–171

Search GitHub for a username, email, or keyword. GITHUB_TOKEN increases rate limits.

(query: str, timeout_seconds: int = _DEFAULT_TIMEOUT)

async def run_github_osint(query: str, timeout_seconds: int = _DEFAULT_TIMEOUT) -> str:
    """Search GitHub for a username, email, or keyword. GITHUB_TOKEN increases rate limits."""
    query = query.strip()
    if not query:
        return "Error: query cannot be empty."

    token = os.environ.get("GITHUB_TOKEN") or None
    timeout_cfg = aiohttp.ClientTimeout(total=timeout_seconds)

    try:
        async with aiohttp.ClientSession(
            headers=_build_headers(token),
            timeout=timeout_cfg,
        ) as session:
            user = await _fetch_user(session, query)
            if user:
                repos = await _fetch_repos(session, query)
                emails = await _discover_emails(session, query, repos)
                return _format_profile(user, repos, emails)

            users = await _search_users(session, query)
            if not users:
                return f"[GitHub] No users found for query: '{query}'."

            lines = [f"[GitHub] Search results for '{query}' ({len(users)} match(es)):"]
            for u in users:
                lines.append(
                    f"  • {u.get('login')} — {u.get('html_url')} (type: {u.get('type', '?')})"
                )
            return "\n".join(lines)

    except asyncio.TimeoutError:
        return f"Scan error: GitHub request timed out after {timeout_seconds}s."
    except aiohttp.ClientResponseError as exc:
        if exc.status == 403:
            return "Scan error: GitHub rate limit exceeded. Set GITHUB_TOKEN for higher limits."
        if exc.status == 401:
            return "Scan error: Invalid GITHUB_TOKEN."
        return f"Scan error: GitHub API error HTTP {exc.status}."
    except aiohttp.ClientError as exc:
        return f"Scan error: Network error querying GitHub: {exc}"
    except Exception as exc:
        logger.exception("Unexpected error during GitHub lookup.")
        return f"Internal error: {exc}"