uv-agent-auth-code 0.1.0__tar.gz

uv_agent_auth_code-0.1.0/.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

uv_agent_auth_code-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,42 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    name: Tests (${{ matrix.os }})
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - ubuntu-latest
+          - macos-latest
+          - windows-latest
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v6
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.13"
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v8.1.0
+        with:
+          enable-cache: true
+
+      - name: Install dependencies
+        run: uv sync --locked --dev
+
+      - name: Run tests
+        run: uv run pytest

uv_agent_auth_code-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,227 @@
+name: Release
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: "Version to release, for example 0.1.0. Leave empty to use pyproject.toml."
+        required: false
+        type: string
+      tag:
+        description: "Release tag. Leave empty to use v<version>."
+        required: false
+        type: string
+      prerelease:
+        description: "Mark the GitHub release as a prerelease."
+        required: true
+        default: false
+        type: boolean
+      publish_pypi:
+        description: "Publish the built distributions to PyPI after creating the GitHub release."
+        required: true
+        default: false
+        type: boolean
+
+jobs:
+  build:
+    name: Build and verify distributions
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    outputs:
+      tag: ${{ steps.meta.outputs.tag }}
+      version: ${{ steps.meta.outputs.version }}
+      commit_sha: ${{ steps.release-ref.outputs.commit_sha }}
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+          ref: ${{ github.ref_name }}
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.13"
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v8.1.0
+        with:
+          enable-cache: true
+
+      - name: Resolve release metadata
+        id: meta
+        shell: bash
+        env:
+          INPUT_VERSION: ${{ inputs.version }}
+          INPUT_TAG: ${{ inputs.tag }}
+        run: |
+          python3 - <<'PY' >> "$GITHUB_OUTPUT"
+          import os
+          import re
+          import tomllib
+
+          input_version = os.environ.get("INPUT_VERSION", "").strip()
+          with open("pyproject.toml", "rb") as file:
+              current_version = tomllib.load(file)["project"]["version"]
+
+          version = input_version or current_version
+          if not re.fullmatch(r"\d+\.\d+\.\d+(?:(?:a|b|rc)\d+)?(?:\.post\d+)?(?:\.dev\d+)?", version):
+              raise SystemExit(f"Invalid release version: {version!r}")
+
+          tag = os.environ.get("INPUT_TAG", "").strip() or f"v{version}"
+          if not re.fullmatch(r"v?[A-Za-z0-9][A-Za-z0-9._+-]*", tag):
+              raise SystemExit(f"Invalid release tag: {tag!r}")
+
+          tag_version = tag[1:] if tag.startswith("v") else tag
+          if tag_version != version:
+              raise SystemExit(
+                  f"Release tag {tag!r} does not match release version {version!r}. "
+                  "Use the matching tag or leave tag empty."
+              )
+
+          print(f"version={version}")
+          print(f"tag={tag}")
+          PY
+
+      - name: Update version files
+        shell: bash
+        env:
+          RELEASE_VERSION: ${{ steps.meta.outputs.version }}
+        run: |
+          python3 - <<'PY'
+          import os
+          import re
+          from pathlib import Path
+
+          version = os.environ["RELEASE_VERSION"]
+          path = Path("pyproject.toml")
+          text = path.read_text(encoding="utf-8")
+          pattern = r'(?m)^version = "[^"]+"$'
+          updated, count = re.subn(pattern, f'version = "{version}"', text, count=1)
+          if count != 1:
+              raise SystemExit("Could not find project version in pyproject.toml")
+          path.write_text(updated, encoding="utf-8")
+          PY
+          uv lock
+
+      - name: Verify version files
+        shell: bash
+        env:
+          RELEASE_VERSION: ${{ steps.meta.outputs.version }}
+        run: |
+          python3 - <<'PY'
+          import os
+          import tomllib
+
+          with open("pyproject.toml", "rb") as file:
+              version = tomllib.load(file)["project"]["version"]
+          expected = os.environ["RELEASE_VERSION"]
+          if version != expected:
+              raise SystemExit(f"pyproject.toml version {version!r} does not match {expected!r}")
+          PY
+          uv lock --check
+
+      - name: Commit version bump
+        id: version-commit
+        shell: bash
+        env:
+          RELEASE_TAG: ${{ steps.meta.outputs.tag }}
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          git add pyproject.toml uv.lock
+          if git diff --cached --quiet; then
+            echo "No version changes to commit."
+            echo "committed=false" >> "$GITHUB_OUTPUT"
+          else
+            git commit -m "Release uv-agent-auth-code ${RELEASE_TAG}"
+            echo "committed=true" >> "$GITHUB_OUTPUT"
+          fi
+
+      - name: Install dependencies
+        run: uv sync --locked --dev
+
+      - name: Run tests
+        run: uv run pytest
+
+      - name: Build distributions
+        run: uv build
+
+      - name: Check distributions
+        run: uvx twine check --strict dist/*
+
+      - name: Push version bump
+        if: ${{ steps.version-commit.outputs.committed == 'true' }}
+        shell: bash
+        run: |
+          if [ "${GITHUB_REF_TYPE}" != "branch" ]; then
+            echo "Version bump commits require running the workflow from a branch." >&2
+            exit 1
+          fi
+          git push origin "HEAD:${GITHUB_REF_NAME}"
+
+      - name: Resolve release revision
+        id: release-ref
+        shell: bash
+        run: echo "commit_sha=$(git rev-parse HEAD)" >> "$GITHUB_OUTPUT"
+
+      - name: Upload distribution artifacts
+        uses: actions/upload-artifact@v7
+        with:
+          name: python-distributions
+          path: dist/*
+          if-no-files-found: error
+
+  github-release:
+    name: Create GitHub release
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+
+    steps:
+      - name: Download distribution artifacts
+        uses: actions/download-artifact@v8
+        with:
+          name: python-distributions
+          path: dist
+
+      - name: Create GitHub release
+        uses: softprops/action-gh-release@v3
+        with:
+          tag_name: ${{ needs.build.outputs.tag }}
+          target_commitish: ${{ needs.build.outputs.commit_sha }}
+          name: uv-agent-auth-code ${{ needs.build.outputs.tag }}
+          generate_release_notes: true
+          prerelease: ${{ inputs.prerelease }}
+          fail_on_unmatched_files: true
+          files: dist/*
+
+  pypi:
+    name: Publish to PyPI
+    needs:
+      - build
+      - github-release
+    if: ${{ inputs.publish_pypi }}
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/uv-agent-auth-code
+    permissions:
+      contents: read
+      id-token: write
+
+    steps:
+      - name: Download distribution artifacts
+        uses: actions/download-artifact@v8
+        with:
+          name: python-distributions
+          path: dist
+
+      - name: Publish distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/
+          print-hash: true

uv_agent_auth_code-0.1.0/.gitignore

@@ -0,0 +1,5 @@
+.venv/
+.pytest_cache/
+dist/
+__pycache__/
+*.py[cod]

uv_agent_auth_code-0.1.0/PKG-INFO

@@ -0,0 +1,59 @@
+Metadata-Version: 2.4
+Name: uv-agent-auth-code
+Version: 0.1.0
+Summary: Local auth-code challenge plugin for uv-agent.
+Requires-Python: >=3.12
+Requires-Dist: uv-agent>=0.21.0
+Description-Content-Type: text/markdown
+
+# uv-agent auth code plugin
+
+This plugin starts a small token-protected HTTP page that shows a single
+six-character challenge code. Other uv-agent plugins can call the
+`auth_code.verify` action with a user-provided code.
+
+The code is uppercase alphanumeric, case-insensitive when verified, short lived,
+and consumed after one successful verification.
+
+## Configuration
+
+```json
+{
+  "plugins": {
+    "auth-code": {
+      "enabled": true,
+      "config": {
+        "token": "replace-with-a-long-random-token",
+        "host": "0.0.0.0",
+        "port": 8765,
+        "ttl_s": 120
+      }
+    }
+  }
+}
+```
+
+`token` is required. The page can be opened as:
+
+```text
+http://127.0.0.1:8765/?token=replace-with-a-long-random-token
+```
+
+After token login, the plugin stores an in-memory HttpOnly session cookie.
+
+## Action
+
+```python
+result = await context.actions.call("auth_code.verify", {"code": "A7K2Q9"})
+```
+
+The plugin id is `auth-code`. The action id remains `auth_code.verify` because
+uv-agent action ids use dotted Python-style names.
+
+Successful verification returns:
+
+```json
+{"ok": true, "verified": true}
+```
+
+Failed verification returns `ok: false`, `verified: false`, and a `reason`.

uv_agent_auth_code-0.1.0/README.md

@@ -0,0 +1,51 @@
+# uv-agent auth code plugin
+
+This plugin starts a small token-protected HTTP page that shows a single
+six-character challenge code. Other uv-agent plugins can call the
+`auth_code.verify` action with a user-provided code.
+
+The code is uppercase alphanumeric, case-insensitive when verified, short lived,
+and consumed after one successful verification.
+
+## Configuration
+
+```json
+{
+  "plugins": {
+    "auth-code": {
+      "enabled": true,
+      "config": {
+        "token": "replace-with-a-long-random-token",
+        "host": "0.0.0.0",
+        "port": 8765,
+        "ttl_s": 120
+      }
+    }
+  }
+}
+```
+
+`token` is required. The page can be opened as:
+
+```text
+http://127.0.0.1:8765/?token=replace-with-a-long-random-token
+```
+
+After token login, the plugin stores an in-memory HttpOnly session cookie.
+
+## Action
+
+```python
+result = await context.actions.call("auth_code.verify", {"code": "A7K2Q9"})
+```
+
+The plugin id is `auth-code`. The action id remains `auth_code.verify` because
+uv-agent action ids use dotted Python-style names.
+
+Successful verification returns:
+
+```json
+{"ok": true, "verified": true}
+```
+
+Failed verification returns `ok: false`, `verified: false`, and a `reason`.

uv_agent_auth_code-0.1.0/pyproject.toml

@@ -0,0 +1,24 @@
+[project]
+name = "uv-agent-auth-code"
+version = "0.1.0"
+description = "Local auth-code challenge plugin for uv-agent."
+readme = "README.md"
+requires-python = ">=3.12"
+dependencies = [
+    "uv-agent>=0.21.0",
+]
+
+[project.entry-points."uv_agent.plugins"]
+auth-code = "uv_agent_auth_code:plugin"
+
+[dependency-groups]
+dev = [
+    "pytest>=9.0.0",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/uv_agent_auth_code"]

uv_agent_auth_code-0.1.0/src/uv_agent_auth_code/__init__.py

@@ -0,0 +1,73 @@
+from __future__ import annotations
+
+from typing import Any
+
+from uv_agent.plugins import PluginManifest, SetupPlugin
+
+from .service import AuthCodeConfig, AuthCodeService
+
+MANIFEST = PluginManifest(
+    id="auth-code",
+    version="0.1.0",
+    display_name={"en": "Auth Code", "zh": "验证码鉴权"},
+    description={
+        "en": "Starts a token-protected web page with a short-lived challenge code and exposes auth_code.verify.",
+        "zh": "启动受 token 保护的验证码页面，并提供 auth_code.verify action。",
+    },
+    capabilities=("action", "http_server"),
+    config_schema={
+        "type": "object",
+        "properties": {
+            "token": {"type": "string", "minLength": 1},
+            "host": {"type": "string", "default": "0.0.0.0"},
+            "port": {"type": "integer", "minimum": 0, "maximum": 65535, "default": 8765},
+            "ttl_s": {"type": "integer", "minimum": 1, "default": 120},
+            "session_ttl_s": {"type": "integer", "minimum": 60, "default": 43200},
+        },
+        "required": ["token"],
+    },
+)
+
+_SERVICES: dict[int, AuthCodeService] = {}
+
+
+def plugin() -> SetupPlugin:
+    return SetupPlugin(manifest=MANIFEST, setup=setup, stop=stop)
+
+
+def setup(context) -> None:
+    config = AuthCodeConfig.from_mapping(context.config)
+    service = AuthCodeService(config, logger=context.logger)
+    service.start()
+    _SERVICES[id(context)] = service
+    try:
+        context.actions.register(
+            "auth_code.verify",
+            _verify_action,
+            doc="Verify the current auth-code challenge. Payload: {'code': 'A7K2Q9'}.",
+            schema={
+                "type": "object",
+                "properties": {"code": {"type": "string"}},
+                "required": ["code"],
+            },
+        )
+    except Exception:
+        _SERVICES.pop(id(context), None)
+        service.stop()
+        raise
+    context.logger.info("Auth code server started url=%s", service.url)
+
+
+def stop(context) -> None:
+    service = _SERVICES.pop(id(context), None)
+    if service is not None:
+        service.stop()
+
+
+def _verify_action(payload: dict[str, Any], context=None) -> dict[str, Any]:
+    if context is None:
+        return {"ok": False, "verified": False, "reason": "missing_context"}
+    service = _SERVICES.get(id(context))
+    if service is None:
+        return {"ok": False, "verified": False, "reason": "service_unavailable"}
+    return service.verify(str(payload.get("code") or ""))