Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

Add HTTP Downstream Metadata API

未关闭
#61 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
35/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
停滞
技术栈
python
领域
api

调研方向

从 stubs/wit_world/imports/http_downstream.py 开始,并将其接口与 issue #009 中计划的 Request wrapper 进行比较。检查 src/component/compute/http_downstream.rs 和 Viceroy 测试笔记,以区分受支持的元数据与作为 stub 的 TLS 和 fingerprint 函数。完成的标准是暴露约定的 downstream API,并覆盖受支持的行为、多请求处理以及已记录的 Viceroy 限制。

由索引模型根据 Issue 内容生成。

描述

Overview

Add support for accessing downstream (incoming) HTTP request metadata, including client/server IP addresses, TLS connection details, security fingerprints, and compliance information.

Relationship to Issue #009: Issue #009 covers the low-level Request/Response wrappers. This issue (#014) specifically focuses on implementing the downstream metadata functions from the http-downstream WIT interface. These functions take a Request and return metadata, and will likely be exposed via a request.downstream accessor as shown in #009's examples.

WIT Interface

interface http-downstream {
  use http-req.{request, client-cert-verify-result};
  use types.{ip-address, error};
  use http-body.body;
  use async-io.pollable;

  // Multi-request handling
  next-request: func(options: next-request-options) -> result<pending-request, error>;
  await-request: func(pending: pending-request) -> result<option<tuple<request, body>>, error>;

  // IP addresses
  downstream-client-ip-addr: func(ds-request: request) -> option<ip-address>;
  downstream-server-ip-addr: func(ds-request: request) -> option<ip-address>;

  // TLS metadata
  downstream-tls-cipher-openssl-name: func(ds-request: request, max-len: u64) -> result<option<list<u8>>, error>;
  downstream-tls-protocol: func(ds-request: request, max-len: u64) -> result<option<list<u8>>, error>;
  downstream-tls-client-hello: func(ds-request: request, max-len: u64) -> result<option<list<u8>>, error>;
  downstream-tls-raw-client-certificate: func(ds-request: request, max-len: u64) -> result<option<list<u8>>, error>;
  downstream-tls-client-cert-verify-result: func(ds-request: request) -> result<option<client-cert-verify-result>, error>;
  downstream-tls-client-servername: func(ds-request: request, max-len: u64) -> result<option<string>, error>;
  downstream-tls-ja3-md5: func(ds-request: request) -> result<option<list<u8>>, error>;
  downstream-tls-ja4: func(ds-request: request, max-len: u64) -> result<option<string>, error>;

  // Security and fingerprinting
  downstream-client-h2-fingerprint: func(ds-request: request, max-len: u64) -> result<string, error>;
  downstream-client-oh-fingerprint: func(ds-request: request, max-len: u64) -> result<string, error>;
  downstream-client-ddos-detected: func(ds-request: request) -> result<bool, error>;
  downstream-client-request-id: func(ds-request: request, max-len: u64) -> result<string, error>;

  // Compliance and headers
  downstream-compliance-region: func(ds-request: request, max-len: u64) -> result<option<string>, error>;
  downstream-original-header-names: func(ds-request: request, max-len: u64, cursor: u32) -> result<tuple<string, option<u32>>, error>;
  downstream-original-header-count: func(ds-request: request) -> result<u32, error>;

  // Purge authentication
  fastly-key-is-valid: func(ds-request: request) -> result<bool, error>;
}

WIT bindings: stubs/wit_world/imports/http_downstream.py

API Design

Functions that take a Request and return metadata (likely exposed via request.downstream accessor):

  • IP Access: get_client_ip(request) / get_server_ip(request) returning Optional[Union[IPv4Address, IPv6Address]]
  • TLS Info: get_tls_cipher(request), get_tls_protocol(request), get_tls_ja3_md5(request), get_tls_ja4(request)
  • Client Certificates: get_client_certificate(request), get_client_cert_verify_result(request)
  • Security: is_ddos_detected(request), get_request_id(request), get_h2_fingerprint(request)
  • Compliance: get_compliance_region(request) for GDPR/data residency
  • Headers: get_original_headers(request) preserving case and order
  • Multi-request: next_request(timeout_ms) / await_request(pending) for handling multiple requests per sandbox

Usage via Request wrapper (see issue #009):

client_ip = incoming_req.downstream.client_ip()
tls_ja3 = incoming_req.downstream.tls_ja3_md5()

Cross-SDK Comparison: Rust exposes these as methods on Request extensions, Go uses functions in fsthttp package, JS provides via event.client object. Python will likely expose via request.downstream namespace for clean API.

Viceroy Testing

Viceroy implementation status (src/component/compute/http_downstream.rs):

✅ Fully Supported:

  • downstream_client_ip_addr - Returns client IP from request context
  • downstream_server_ip_addr - Returns server IP from request context
  • downstream_original_header_names / downstream_original_header_count - Preserves original header casing/order
  • downstream_client_request_id - Returns generated request ID (format: 32-char hex)
  • downstream_compliance_region - Returns compliance region if configured
  • next_request / await_request - Multi-request handling works

⚠️ Stubbed (returns None/empty):

  • All downstream_tls_* functions - Return None (no TLS metadata in local testing)
  • downstream_client_h2_fingerprint - Returns empty string
  • downstream_client_oh_fingerprint - Returns empty string
  • downstream_client_ddos_detected - Always returns false
  • fastly_key_is_valid - Always returns false

Testing Approach:

  • Use @on_viceroy with inline TOML for IP address configuration
  • Mark TLS/fingerprint tests as xfail - they return None in Viceroy
  • Test multi-request handling with sequential request pattern
  • Test original header preservation with mixed-case headers

Example test config:

[local_server]
client_ip = "203.0.113.42"
compliance_region = "EU"

Reference

主要语言
Python
星标
5
派生
1
PR 合并指标
30 天内没有已合并 PR

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

fastly/compute-sdk-python 的其他 Issue

查看 fastly/compute-sdk-python 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。