From fdfba99476d4959aa351269bcdb5dafbe1a8524c Mon Sep 17 00:00:00 2001 From: Horst Gutmann Date: Thu, 2 Jul 2020 21:32:23 +0200 Subject: [PATCH] Add implementation report for webmentiond --- implementation-reports/webmentiond.md | 182 ++++++++++++++++++++++++++ 1 file changed, 182 insertions(+) create mode 100644 implementation-reports/webmentiond.md diff --git a/implementation-reports/webmentiond.md b/implementation-reports/webmentiond.md new file mode 100644 index 0000000..a9c498f --- /dev/null +++ b/implementation-reports/webmentiond.md @@ -0,0 +1,182 @@ +# webmentiond + +Implementation Home Page URL: https://webmentiond.org + +Source Code repo URL(s) (optional): https://github.com/zerok/webmentiond +* [x] 100% open source implementation + +Programming Language(s): Go, JavaScript + +Developer(s): [Horst Gutmann](https://zerokspot.com) + +Implementation Classes (Sender and/or Receiver): Sender and Receiver + + +## Sending + +### Discovery Tests (3.1.1) + +MUST + +* [x] [Discovery Test #1](https://webmention.rocks/test/1) +* [x] [Discovery Test #2](https://webmention.rocks/test/2) +* [x] [Discovery Test #3](https://webmention.rocks/test/3) +* [x] [Discovery Test #4](https://webmention.rocks/test/4) +* [x] [Discovery Test #5](https://webmention.rocks/test/5) +* [x] [Discovery Test #6](https://webmention.rocks/test/6) +* [x] [Discovery Test #7](https://webmention.rocks/test/7) +* [x] [Discovery Test #8](https://webmention.rocks/test/8) +* [x] [Discovery Test #9](https://webmention.rocks/test/9) +* [x] [Discovery Test #10](https://webmention.rocks/test/10) +* [x] [Discovery Test #11](https://webmention.rocks/test/11) +* [x] [Discovery Test #12](https://webmention.rocks/test/12) +* [x] [Discovery Test #13](https://webmention.rocks/test/13) +* [x] [Discovery Test #14](https://webmention.rocks/test/14) +* [x] [Discovery Test #15](https://webmention.rocks/test/15) +* [x] [Discovery Test #16](https://webmention.rocks/test/16) +* [x] [Discovery Test #17](https://webmention.rocks/test/17) +* [x] [Discovery Test #18](https://webmention.rocks/test/18) +* [x] [Discovery Test #19](https://webmention.rocks/test/19) +* [x] [Discovery Test #20](https://webmention.rocks/test/20) +* [x] [Discovery Test #21](https://webmention.rocks/test/21) + + +### Sending Tests (3.1.2) + +MUST + +* [x] Accepts HTTP 200 response as a success +* [x] Accepts HTTP 201 response as a success +* [x] Accepts HTTP 202 response as a success + + +### Update Tests (3.1.3) + +SHOULD + +* [na] [Update Test #1](https://webmention.rocks/update/1) +* [na] [Update Test #2](https://webmention.rocks/update/2) + +#### Implementation Notes + +Webmentiond does not keep any state for sending mentions to external URLs. + + +### Delete Tests (3.1.4) + +SHOULD + +* [na] [Delete Test #1](https://webmention.rocks/delete/1) + +#### Implementation Notes + +Webmentiond does not keep any state for sending mentions to external URLs. + + +### Security Considerations (4) + +* [ ] The sender avoids sending a Webmention to a loopback address (SHOULD) + + +### Extensions + +This implementation has also implemented the following extensions. + +* [ ] [Salmention](http://indiewebcamp.com/Salmention) +* [ ] [Vouch](http://indiewebcamp.com/Vouch) +* [ ] [Private Webmention](http://indiewebcamp.com/Private-Webmention) +* [ ] Other: _______ + + +## Receiving + +Indicate which type of response the receiver provides: + +* [ ] HTTP 200 - Receiver synchronously processes the Webmention request (not recommended) +* [ ] HTTP 201 - Receiver creates a status URL the sender can use to check the status of the Webmention +* [x] HTTP 202 - Receiver processes the Webmention asynchronously + +Describe the response body (if any) which is returned in the request: + + +### Request Verification (3.2.1) + +* [x] Verifies source and target are valid URLs, rejecting with HTTP 400 (MUST) +* [x] Verifies that target is a valid resource for which the receiver accepts Webmentions, rejecting with HTTP 400 (SHOULD) +* [x] Ignores fragment when checking if target is supported (SHOULD) + +### Webmention Verification (3.2.2) + +* [x] Verification is processed asynchronously (SHOULD) +* [x] Follows at least one HTTP redirect on source URL (MUST) +* [x] Respects a self-imposed limit on number of HTTP redirects to follow (MUST) + +#### Source URL content-types supported + +Please list the content types that your implementation supports when checking if the source document links to the target URL. + +* [x] HTML +* [ ] Other: ______ + + +### HTML Verification (3.2.2) + +The tests below apply when the source document is HTML. + +* [x] Accepts a Webmention where the target URL is in an `` tag +* [x] Accepts a Webmention where the target URL is in an `` tag +* [x] Accepts a Webmention where the target URL is in an `` tag inside an HTML comment +* [x] Rejects a Webmention where the target URL is not in the document + + +### Webmention Display/Use + +* [x] The receiver displays data from the source URL on the target post (MAY) + +* [x] The receiver recognizes that the source URL is a "comment" or "reply" to the post + * [ ] using HTML markup: __________ +* [x] The receiver recognizes that the source URL is a "like" of the post + * [ ] using HTML markup: __________ +* [ ] The receiver recognizes that the source URL is a "repost" of the post + * [ ] using HTML markup: __________ +* [x] The receiver recognizes that the source URL is an "RSVP" to the post + * [ ] using HTML markup: __________ +* [ ] The receiver recognizes additional response types, using markup: + * [ ] Response: __________ using HTML markup: __________ + + +### Update Tests (3.2.4) + +* [x] Does not display an update Webmention as a new response (SHOULD) +* [x] Removes the response when an update Webmention is sent and the source URL returns 200 and no link is found (SHOULD) +* [x] Updates and stores the information from the primary object at the source URL (MUST) +* [ ] Updates and stores the information from children or descendant objects at the source URL (MAY) + + +### Delete Tests (3.2.4) + +* [x] Recognizes an HTTP 410 response as a delete, and removes the response (SHOULD) + + +### Security Considerations (4) + +* [x] Webmentions are moderated before being displayed (MAY) +* [ ] Webmentions are periodically re-verified (MAY) +* [x] The receiver ensures any displayed data it properly encoded/filtered to prevent XSS attacks (MUST) +* [ ] Respects a self-imposed limit on the time spent fetching the source URL (SHOULD) +* [ ] Respects a self-imposed limit on the number of bytes fetched from the source URL (SHOULD) +* [ ] The receiver accepts additional parameters or headers, and so has CSRF protection (SHOULD) + + +### Extensions + +This implementation has also implemented the following extensions. + +* [ ] [Salmention](http://indiewebcamp.com/Salmention) +* [ ] [Vouch](http://indiewebcamp.com/Vouch) +* [ ] [Private Webmention](http://indiewebcamp.com/Private-Webmention) +* [ ] Other: _______ +