Skip to content

Commit ab46a86

Browse files
authored
Remove warning about code, and add one about spec. (#299)
Remove the warning about the code being in developer preview; we consider it stable enough to deploy in production now. Both code and specification are still evolving, but this is handled by the requirement to keep the packager updated per the `AMP-Cache-Transform` version. Add a warning about SXG security considerations. This is an attempt to distill advice from the risks outlined in the spec.
1 parent e870bd6 commit ab46a86

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

README.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
# AMP Packager
22

3-
> **WARNING**: This code is still evolving, and is a developer preview. The
4-
> specification is still changing, and this is an implementation of a snapshot
5-
> of it. Feel free to use it, but treat with care how you configure and deploy it.
6-
73
AMP Packager is a tool to [improve AMP
84
URLs](https://www.ampproject.org/latest/blog/developer-preview-of-better-amp-urls-in-google-search).
95
By running it in a proper configuration, web publishers may (eventually) have
@@ -150,6 +146,21 @@ packager URL directly, first add a Chrome extension to send an
150146
`AMP-Cache-Transform: any` request header. Otherwise, follow the above
151147
"Demonstrate privacy-preserving prefetch" instructions.
152148
149+
##### Security Considerations
150+
151+
Signed exchanges come with some [security
152+
considerations](https://wicg.github.io/webpackage/draft-yasskin-http-origin-signed-responses.html#security-considerations)
153+
that publishers should consider. A starting list of recommendations based on
154+
that:
155+
156+
* Use different keys for the signed exchange cert and the TLS cert.
157+
* Only sign public content that's OK to be shared with crawlers.
158+
* Don't sign personalized content. (It's OK to sign content that includes
159+
static JS that adds personalization at runtime.)
160+
* Be careful when signing inline JS; if it includes a vulnerability, it may be
161+
possible for attackers to exploit it without intercepting the network path,
162+
for up to 7 days.
163+
153164
#### Testing productionization without a valid certificate
154165
155166
It is possible to test an otherwise fully production configuration without

0 commit comments

Comments
 (0)