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

possible blog post: Caching TUF metadata

未关闭
#2,605 3 条评论 5 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 10 天内回复

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
25/100
Issue 类型
文档
描述清晰度
需要澄清
活跃度
停滞

调研方向

未指定文件、测试或代码入口点。首先查看粘贴的草稿以及 repository 针对博客或文档贡献的流程,然后明确这是否应当成为一篇已发布的文章,以及需要什么格式或审查。完成的标准是形成一篇已达成共识、经过审查并可供发布的文章,或记录一项不再继续推进的决定。

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

描述

I've spent far too long in the past week looking at CDN logs... I collected some notes from this, and wrote a first draft of a blog post or something. copy-pasting here so I don't lose it

TUF implementation details: Caching and content delivery networks

TUF metadata can be cached at various places during its lifetime, this post aims to describe the useful
methods of caching. The write-up assumes that the "consistent snapshot" feature of TUF is used:
this should be true for all reasonable implementations.

Client metadata cache

A TUF client stores downloaded metadata in an application cache as part of the
TUF Client Workflow. Note that caching metadata is subtly different from caching
artifacts: An artifact cache is a "pure" cache and can be purged at any time without
side-effects (other than possibly having to re-download). Purging the metadata cache
is also possible without service loss but does have minor security implications as
some rollback attack protection is lost.

Client HTTP cache

In addition to the actual metadata, a client could cache the ETag information
included in a timestamp.json response and use the If-None-Match header in
subsequent requests. This is not useful for other metadata or artifacts as they
should never change.

There is a minor information leak if this is done (as the server could now respond
maliciously to only some clients based on the content of the If-None-Match
header). Current client implementations are not known to cache ETag.

Content Delivery Network caching

One could imagine that caching something as simple as TUF metadata in a Content
Delivery Network (CDN) is a trivial feat but it turns out there are several pitfalls.

These are some of the lessons that have been learned while maintaining TUF repositories:

  • Uploading a new repository version to backend storage should be atomic (the metadata
    versions on the storage backend should always be consistent). If this is not technically possible,
    snapshot and all targets metadata should be uploaded before root and timestamp: this
    minimizes the window of potentially inconsistent metadata.
  • "Old" metadata (or artifact) versions should not be removed from backend storage immediately: this can break clients that are in the middle of an update process
  • CDN frontends should avoid serving any stale responses: 404 responses to root requests are part of the normal usage of the API and cannot be allowed to be stale, otherwise the repository state may be inconsistent.
  • CDN frontends may cache versioned positive metadata responses (root, snapshot, targets) with
    long lifetimes.
  • There are two valid alternatives to caching other responses:
    1. CDN frontend may use "negative cache" (caching failure codes) and may cache
      timestamp metadata responses, if it is able to invalidate the cache immediately on
      upload of new repository versions to storage backend.
    2. CDN frontend should not cache timestamp metadata responses or use "negative caching"
      if it is unable to invalidate the cache on upload of new data

At first glance it may seem like the above advice is overly cautious, and that failures
would be rare. In practice especially testing and alerting systems have managed to
consistently find failing combinations of mistakenly cached content.

主要语言
Python
星标
1.7k
派生
304
平均合并
9 小时 25 分钟
30 天内合并 PR
14

环境准备

从这里开始

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

theupdateframework/python-tuf 的其他 Issue

查看 theupdateframework/python-tuf 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

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