CHANGELOG: clarify the security issue in `ipfs name resolve --stream`
We never return *invalid* records, just outdated ones. License: MIT Signed-off-by: Steven Allen <steven@stebalien.com>
Steven Allen committed
Oct 28, 2018 at 06:34 UTC
3a3bd09539c7a34ae8e42055320ab159cbfe1322
1 file changed
+14
-13
CHANGELOG.md
+14
-13
@@ -86,19 +86,20 @@ documentation in
86
It's still experimental but we don't expect too many breaking changes at this
87
point (it will very likely be stabilized in the next release).
88
89
-TODO: Put this (vv) somewhere else.
90
-There is now a new flag for `ipfs name resolve` - `--stream`. When the command is
91
-invoked with the flag set, it will start returning results as soon as they are discovered
92
-in the DHT and other routing mechanisms. This enables certain applications to start
93
-prefetching/displaying data while the discovery is still running. Note that for security
94
-reasons, unless you implement custom validation method, you should wait for the
95
-command to return before considering returned records up to date.
96
-
97
-
98
-In the previous release, we added support for extracting blocks inlined into
99
-CIDs. In this release, we've added support for creating these CIDs. You can now
100
-run `ipfs add` with the `--inline` flag to inline blocks less than or equal to
101
-32 bytes in length into a CID, instead of writing an actual block.
89
+There is now a new flag for `ipfs name resolve` - `--stream`. When the command
90
+is invoked with the flag set, it will start returning results as soon as they
91
+are discovered in the DHT and other routing mechanisms. This enables certain
92
+applications to start prefetching/displaying data while the discovery is still
93
+running. Note that this command will likely return many outdated records
94
+before it finding and returning the latest. However, it will always return
95
+*valid* records (even if a bit stale).
96
+
97
+Finally, in the previous release, we added support for extracting blocks inlined
98
+into CIDs. In this release, we've added support for creating these CIDs. You can
99
+now run `ipfs add` with the `--inline` flag to inline blocks less than or equal
100
+to 32 bytes in length into a CID, instead of writing an actual block. This
101
+should significantly reduce the size of filesystem trees with many empty
102
+directories and tiny files.
103
104
#### CoreAPI
105