6f37120dc4
A paper needs its experiment figures, and a figure is not text: the bytes go to
MinIO and the sentence keeps a Markdown address. That is what keeps a sentence
one editable string — a picture moves between paragraphs by being cut and
pasted, and survives a template switch with the sentence it belongs to.
Three decisions carry the safety, and each is a way to serve something other
than what was uploaded:
* the key is the digest of the bytes, so uploading the same screenshot twice is
one object and the address can never come to mean a different picture — which
is what makes the year-long `immutable` cache header safe;
* the format is sniffed from the magic bytes, not read from the client's
`Content-Type` or filename, and SVG is refused because an uploaded SVG served
from this origin is stored XSS;
* serving is restricted to the key space this application writes, so
`GET /api/images/{key}` cannot become a browser for the rest of the bucket.
Images are served through the API rather than from a public bucket URL so a
sentence never embeds a host name — the LAN in development and the public
address later would otherwise disagree — and the bucket can stay private. The
object is streamed rather than read into memory, and the connection is released
when the reader stops.
Storage unconfigured is a 503 that names the missing variables, not a crash:
the writing path does not depend on the bucket.
`scripts/smoke_images.py` walks the whole thing: each accepted format, the
refusals (text, SVG, a mislabelled file, an empty file, a key we did not
write), and a sentence that carries a figure through the paper endpoints.
21 lines
986 B
Python
21 lines
986 B
Python
"""The shape an upload answers with."""
|
|
|
|
from pydantic import BaseModel, Field
|
|
|
|
|
|
class ImageRead(BaseModel):
|
|
"""One stored image, as the client needs to know about it.
|
|
|
|
The caller gets the URL *and* the Markdown that embeds it, because those are
|
|
the two things it needs and only one of them is pleasant to assemble by
|
|
hand. They are produced together here so a client cannot invent a slightly
|
|
different syntax than the one the reader parses.
|
|
"""
|
|
|
|
key: str = Field(description="对象在桶里的键,也是这个 URL 的唯一来源")
|
|
url: str = Field(description="句子里的图片地址(同源相对路径,如 /api/images/…)")
|
|
markdown: str = Field(description="可直接粘进句子的 Markdown:")
|
|
content_type: str = Field(description="识别出来的图片类型,如 image/png")
|
|
size: int = Field(description="字节数")
|
|
sha256: str = Field(description="内容的 SHA-256,键就是它的一部分")
|