Add new Client constructors, deprecate old ones #242
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
erickt
force-pushed
the
init2
branch
2 times, most recently
from
a519604 to
d5a51f5
Compare
This patch changes how Clients are created. It adds the following functions: * `Client::from_local` - use the specified root version from the local repository as our initial trusted root. * `Client::from_pinned_root_keyids` - use the specified root version, threshold, and keyids to trust a root fetched from the local or remote repository. * `Client::from_pinned_root_keys` - use the specified root version, threshold, and public keys to trust a root fetched from the local or remote repository. * `Client::from_pinned_root` - use the specified root metadata as the initial trusted root. This deprecates the old constructors: * `Client::new` * `Client::with_root_pinned` Closes: theupdateframework#229
There was a problem hiding this comment.
FYI, from cargo rustdoc:
warning: `[Client::from_root_pinned_keyids]` cannot be resolved, ignoring it...
--> src/client.rs:154:54
|
154 | /// **DEPRECATED**: This has been replaced with [Client::from_root_pinned_keyids].
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ cannot be resolved, ignoring
|
= note: `#[warn(intra_doc_link_resolution_failure)]` on by default
= help: to escape `[` and `]` characters, just add '\' before them like `\[` or `\]`
Finished dev [unoptimized + debuginfo] target(s) in 0.11s
I can't seem to comment on the right line because the diff isn't loading, not sure what's up with that.
|
Thanks, I just pushed up a fix for the deprecation notice. It also looks like the diff view is working again. |
src/client.rs
Outdated
Comment on lines
439
to
443
| // Also store this root metadata as the latest version. | ||
| local | ||
| .store_metadata(&root_path, &MetadataVersion::None, &root) | ||
| .await?; | ||
| } |
There was a problem hiding this comment.
I think this should be conditional on whether you're increasing the version somehow. Can you add tests for this case to each of these constructors to show that these don't roll back root?
There was a problem hiding this comment.
I think it was a mistake to fold this change into this patch. I'll remove it.
* renamed `Client::from_*` to `with_*` and `Tuf::from_*` to `Tuf::with_*`. * renmaed `Client::from_local` to `Client::from_trusted_local` to be a little more explicit. * Don't write unversioned root metadata in the constructor * Don't write root metadata in `Client::with_pinned_root` * rename fn to `fetch_metadata_from_local_or_else_remote` * ran `cargo fmt * added a few more tests
ComputerDruid
approved these changes
Dec 6, 2019
Change-Id: Ia42ac5ba7a05ea3cde64047cd8cf54ac0950cac2
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This patch changes how Clients are created. It adds the following
functions:
Client::from_local- use the specified root version from the local repository as our initial trusted root.Client::from_pinned_root_keyids- use the specified root version, threshold, and keyids to trust a root fetched from the local or remote repository.Client::from_pinned_root_keys- use the specified root version, threshold, and public keys to trust a root fetched from the local or remote repository.Client::from_pinned_root- use the specified root metadata as the initial trusted root.This deprecates the old constructors:
Client::newClient::with_root_pinnedCloses: #229