Skip to content

Commit 7149418

Browse files
borsbors
committed
Auto merge of #12649 - arlosi:cred-stable, r=weihanglo
feat: stabilize credential-process and registry-auth Stabilization PR for `registry-auth` and `credential-process`. Tracking approval of this stabilization is done in the via the FCP in [#8933](#8933 (comment)). This PR is here to help reviewers of the FCP. * Stabilizes `registry-auth` and `credential-process` * Makes authenticated registries require a credential provider * Adds stable documentation for credential providers and authenticated registries Closes #8933 Closes #10474
2 parents 41cef47 + d345ca2 commit 7149418

File tree

38 files changed

+712
-497
lines changed

38 files changed

+712
-497
lines changed

‎Cargo.lock

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎credential/cargo-credential-1password/README.md

+14-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,18 @@
11
# cargo-credential-1password
22

3-
This is the implementation for the Cargo credential helper for [1password].
4-
See the [credential-process] documentation for how to use this.
3+
A Cargo [credential provider] for [1password].
4+
5+
`cargo-credential-1password` uses the 1password `op` CLI to store the token. You must
6+
install the `op` CLI from the [1password
7+
website](https://1password.com/downloads/command-line/). You must run `op signin`
8+
at least once with the appropriate arguments (such as `op signin my.1password.com [email protected]`),
9+
unless you provide the sign-in-address and email arguments. The master password will be required on each request
10+
unless the appropriate `OP_SESSION` environment variable is set. It supports
11+
the following command-line arguments:
12+
* `--account`: The account shorthand name to use.
13+
* `--vault`: The vault name to use.
14+
* `--sign-in-address`: The sign-in-address, which is a web address such as `my.1password.com`.
15+
* `--email`: The email address to sign in with.
516

617
[1password]: https://1password.com/
7-
[credential-process]: https://doc.rust-lang.org/nightly/cargo/reference/unstable.html#credential-process
18+
[credential provider]: https://doc.rust-lang.org/nightly/cargo/reference/registry-authentication.html

‎credential/cargo-credential-libsecret/README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# cargo-credential-libsecret
22

33
This is the implementation for the Cargo credential helper for [GNOME libsecret].
4-
See the [credential-process] documentation for how to use this.
4+
See the [credential-provider] documentation for how to use this.
5+
6+
This credential provider is built-in to cargo as `cargo:libsecret`.
57

68
[GNOME libsecret]: https://wiki.gnome.org/Projects/Libsecret
7-
[credential-process]: https://doc.rust-lang.org/nightly/cargo/reference/unstable.html#credential-process
9+
[credential-provider]: https://doc.rust-lang.org/nightly/cargo/reference/registry-authentication.html

‎credential/cargo-credential-macos-keychain/Cargo.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "cargo-credential-macos-keychain"
3-
version = "0.3.0"
3+
version = "0.3.1"
44
edition.workspace = true
55
license.workspace = true
66
repository = "https://github.com/rust-lang/cargo"

‎credential/cargo-credential-macos-keychain/README.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
# cargo-credential-macos-keychain
22

33
This is the implementation for the Cargo credential helper for [macOS Keychain].
4-
See the [credential-process] documentation for how to use this.
4+
See the [credential-provider] documentation for how to use this.
5+
6+
This credential provider is built-in to cargo as `cargo:macos-keychain`.
57

68
[macOS Keychain]: https://support.apple.com/guide/keychain-access/welcome/mac
7-
[credential-process]: https://doc.rust-lang.org/nightly/cargo/reference/unstable.html#credential-process
9+
[credential-provider]: https://doc.rust-lang.org/nightly/cargo/reference/registry-authentication.html
10+

‎credential/cargo-credential-wincred/README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# cargo-credential-wincred
22

33
This is the implementation for the Cargo credential helper for [Windows Credential Manager].
4-
See the [credential-process] documentation for how to use this.
4+
See the [credential-provider] documentation for how to use this.
5+
6+
This credential provider is built-in to cargo as `cargo:wincred`.
57

68
[Windows Credential Manager]: https://support.microsoft.com/en-us/windows/accessing-credential-manager-1b5c916a-6a16-889f-8581-fc16e8165ac0
7-
[credential-process]: https://doc.rust-lang.org/nightly/cargo/reference/unstable.html#credential-process
9+
[credential-provider]: https://doc.rust-lang.org/nightly/cargo/reference/registry-authentication.html

‎credential/cargo-credential/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ provides an interface to store tokens for authorizing access to a registry
55
such as https://crates.io/.
66

77
Documentation about credential processes may be found at
8-
https://doc.rust-lang.org/nightly/cargo/reference/unstable.html#credential-process
8+
https://doc.rust-lang.org/nightly/cargo/reference/credential-provider-protocol.html
99

1010
Example implementations may be found at
1111
https://github.com/rust-lang/cargo/tree/master/credential

‎publish.py

+5
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,11 @@
1717

1818

1919
TO_PUBLISH = [
20+
'credential/cargo-credential',
21+
'credential/cargo-credential-libsecret',
22+
'credential/cargo-credential-wincred',
23+
'credential/cargo-credential-1password',
24+
'credential/cargo-credential-macos-keychain',
2025
'crates/cargo-platform',
2126
'crates/cargo-util',
2227
'crates/crates-io',

‎src/bin/cargo/commands/login.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ pub fn cli() -> Command {
1010
.arg_registry("Registry to use")
1111
.arg(
1212
Arg::new("args")
13-
.help("Arguments for the credential provider (unstable)")
13+
.help("Additional arguments for the credential provider")
1414
.num_args(0..)
1515
.last(true),
1616
)

‎src/cargo/core/features.rs

+8-4
Original file line numberDiff line numberDiff line change
@@ -728,7 +728,6 @@ unstable_cli_options!(
728728
check_cfg: Option<(/*features:*/ bool, /*well_known_names:*/ bool, /*well_known_values:*/ bool, /*output:*/ bool)> = ("Specify scope of compile-time checking of `cfg` names/values"),
729729
codegen_backend: bool = ("Enable the `codegen-backend` option in profiles in .cargo/config.toml file"),
730730
config_include: bool = ("Enable the `include` key in config files"),
731-
credential_process: bool = ("Add a config setting to fetch registry authentication tokens by calling an external process"),
732731
direct_minimal_versions: bool = ("Resolve minimal dependency versions instead of maximum (direct dependencies only)"),
733732
doctest_xcompile: bool = ("Compile and run doctests for non-host target using runner config"),
734733
dual_proc_macros: bool = ("Build proc-macros for both the host and the target"),
@@ -744,7 +743,6 @@ unstable_cli_options!(
744743
panic_abort_tests: bool = ("Enable support to run tests with -Cpanic=abort"),
745744
profile_rustflags: bool = ("Enable the `rustflags` option in profiles in .cargo/config.toml file"),
746745
publish_timeout: bool = ("Enable the `publish.timeout` key in .cargo/config.toml file"),
747-
registry_auth: bool = ("Authentication for alternative registries"),
748746
rustdoc_map: bool = ("Allow passing external documentation mappings to rustdoc"),
749747
rustdoc_scrape_examples: bool = ("Allows Rustdoc to scrape code examples from reverse-dependencies"),
750748
script: bool = ("Enable support for single-file, `.rs` packages"),
@@ -818,6 +816,12 @@ const STABILIZED_TERMINAL_WIDTH: &str =
818816

819817
const STABILISED_SPARSE_REGISTRY: &str = "The sparse protocol is now the default for crates.io";
820818

819+
const STABILIZED_CREDENTIAL_PROCESS: &str =
820+
"Authentication with a credential provider is always available.";
821+
822+
const STABILIZED_REGISTRY_AUTH: &str =
823+
"Authenticated registries are available if a credential provider is configured.";
824+
821825
fn deserialize_build_std<'de, D>(deserializer: D) -> Result<Option<Vec<String>>, D::Error>
822826
where
823827
D: serde::Deserializer<'de>,
@@ -1081,6 +1085,8 @@ impl CliUnstable {
10811085
"sparse-registry" => stabilized_warn(k, "1.68", STABILISED_SPARSE_REGISTRY),
10821086
"terminal-width" => stabilized_warn(k, "1.68", STABILIZED_TERMINAL_WIDTH),
10831087
"doctest-in-workspace" => stabilized_warn(k, "1.72", STABILIZED_DOCTEST_IN_WORKSPACE),
1088+
"credential-process" => stabilized_warn(k, "1.74", STABILIZED_CREDENTIAL_PROCESS),
1089+
"registry-auth" => stabilized_warn(k, "1.74", STABILIZED_REGISTRY_AUTH),
10841090

10851091
// Unstable features
10861092
// Sorted alphabetically:
@@ -1098,7 +1104,6 @@ impl CliUnstable {
10981104
}
10991105
"codegen-backend" => self.codegen_backend = parse_empty(k, v)?,
11001106
"config-include" => self.config_include = parse_empty(k, v)?,
1101-
"credential-process" => self.credential_process = parse_empty(k, v)?,
11021107
"direct-minimal-versions" => self.direct_minimal_versions = parse_empty(k, v)?,
11031108
"doctest-xcompile" => self.doctest_xcompile = parse_empty(k, v)?,
11041109
"dual-proc-macros" => self.dual_proc_macros = parse_empty(k, v)?,
@@ -1119,7 +1124,6 @@ impl CliUnstable {
11191124
"panic-abort-tests" => self.panic_abort_tests = parse_empty(k, v)?,
11201125
"profile-rustflags" => self.profile_rustflags = parse_empty(k, v)?,
11211126
"publish-timeout" => self.publish_timeout = parse_empty(k, v)?,
1122-
"registry-auth" => self.registry_auth = parse_empty(k, v)?,
11231127
"rustdoc-map" => self.rustdoc_map = parse_empty(k, v)?,
11241128
"rustdoc-scrape-examples" => self.rustdoc_scrape_examples = parse_empty(k, v)?,
11251129
"separate-nightlies" => self.separate_nightlies = parse_empty(k, v)?,

‎src/cargo/lib.rs

+1-3
Original file line numberDiff line numberDiff line change
@@ -78,9 +78,7 @@
7878
//! This is the `#[cargo_test]` proc-macro used by the test suite to define tests.
7979
//! - [`credential`](https://github.com/rust-lang/cargo/tree/master/credential)
8080
//! This subdirectory contains several packages for implementing the
81-
//! experimental
82-
//! [credential-process](https://doc.rust-lang.org/nightly/cargo/reference/unstable.html#credential-process)
83-
//! feature.
81+
//! [credential providers](https://doc.rust-lang.org/nightly/cargo/reference/registry-authentication.html).
8482
//! - [`mdman`](https://github.com/rust-lang/cargo/tree/master/crates/mdman)
8583
//! ([nightly docs](https://doc.rust-lang.org/nightly/nightly-rustc/mdman/index.html)):
8684
//! This is a utility for generating cargo's man pages. See [Building the man

‎src/cargo/ops/registry/mod.rs

+1
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,7 @@ fn registry(
158158
None,
159159
operation,
160160
vec![],
161+
false,
161162
)?)
162163
} else {
163164
None

‎src/cargo/ops/registry/publish.rs

+1
Original file line numberDiff line numberDiff line change
@@ -169,6 +169,7 @@ pub fn publish(ws: &Workspace<'_>, opts: &PublishOpts<'_>) -> CargoResult<()> {
169169
None,
170170
operation,
171171
vec![],
172+
false,
172173
)?));
173174
}
174175

‎src/cargo/sources/registry/download.rs

+1
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,7 @@ pub(super) fn download(
8585
None,
8686
Operation::Read,
8787
vec![],
88+
true,
8889
)?)
8990
} else {
9091
None

‎src/cargo/sources/registry/http_remote.rs

+3-11
Original file line numberDiff line numberDiff line change
@@ -547,9 +547,7 @@ impl<'cfg> RegistryData for HttpRegistry<'cfg> {
547547
return Poll::Ready(Ok(LoadResponse::NotFound));
548548
}
549549
StatusCode::Unauthorized
550-
if !self.auth_required
551-
&& path == Path::new(RegistryConfig::NAME)
552-
&& self.config.cli_unstable().registry_auth =>
550+
if !self.auth_required && path == Path::new(RegistryConfig::NAME) =>
553551
{
554552
debug!(target: "network", "re-attempting request for config.json with authorization included.");
555553
self.fresh.remove(path);
@@ -612,10 +610,6 @@ impl<'cfg> RegistryData for HttpRegistry<'cfg> {
612610
}
613611
}
614612

615-
if !self.config.cli_unstable().registry_auth {
616-
self.auth_required = false;
617-
}
618-
619613
// Looks like we're going to have to do a network request.
620614
self.start_fetch()?;
621615

@@ -654,6 +648,7 @@ impl<'cfg> RegistryData for HttpRegistry<'cfg> {
654648
self.login_url.as_ref(),
655649
Operation::Read,
656650
self.auth_error_headers.clone(),
651+
true,
657652
)?;
658653
headers.append(&format!("Authorization: {}", authorization))?;
659654
trace!(target: "network", "including authorization for {}", full_url);
@@ -724,10 +719,7 @@ impl<'cfg> RegistryData for HttpRegistry<'cfg> {
724719
}
725720

726721
fn config(&mut self) -> Poll<CargoResult<Option<RegistryConfig>>> {
727-
let mut cfg = ready!(self.config()?).clone();
728-
if !self.config.cli_unstable().registry_auth {
729-
cfg.auth_required = false;
730-
}
722+
let cfg = ready!(self.config()?).clone();
731723
Poll::Ready(Ok(Some(cfg)))
732724
}
733725

‎src/cargo/sources/registry/remote.rs

+1-4
Original file line numberDiff line numberDiff line change
@@ -306,10 +306,7 @@ impl<'cfg> RegistryData for RemoteRegistry<'cfg> {
306306
match ready!(self.load(Path::new(""), Path::new(RegistryConfig::NAME), None)?) {
307307
LoadResponse::Data { raw_data, .. } => {
308308
trace!("config loaded");
309-
let mut cfg: RegistryConfig = serde_json::from_slice(&raw_data)?;
310-
if !self.config.cli_unstable().registry_auth {
311-
cfg.auth_required = false;
312-
}
309+
let cfg: RegistryConfig = serde_json::from_slice(&raw_data)?;
313310
Poll::Ready(Ok(Some(cfg)))
314311
}
315312
_ => Poll::Ready(Ok(None)),

0 commit comments

Comments
 (0)