Skip to content

Commit 9a30321

Browse files
authored
docs(cargo-yank): clarify yank behavior with leaked credentials (#16274)
Clarifies that yanking only affects Cargo's dependency resolution, not crate availability. Yanked crates remain fully downloadable, so yanking cannot prevent the spread of leaked credentials. Closes #16266
2 parents 6ce5357 + 4dc0493 commit 9a30321

File tree

4 files changed

+16
-12
lines changed

4 files changed

+16
-12
lines changed

src/doc/man/cargo-yank.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,10 @@ them at <[email protected]>.
6868

6969
If credentials have been leaked, the recommended course of action is to revoke
7070
them immediately. Once a crate has been published, it is impossible to determine
71-
if the leaked credentials have been copied. Yanking the crate only prevents new
72-
users from downloading it, but cannot stop those who have already downloaded it
73-
from keeping or even spreading the leaked credentials.
71+
if the leaked credentials have been copied. Yanking only prevents Cargo from
72+
selecting this version when resolving dependencies by default. Existing lock
73+
files or direct downloads are not affected, so yanking cannot stop further
74+
spreading of the leaked credentials.
7475

7576
[RustSec]: https://rustsec.org/
7677
[policies]: https://crates.io/policies

src/doc/man/generated_txt/cargo-yank.txt

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -75,9 +75,10 @@ DESCRIPTION
7575
If credentials have been leaked, the recommended course of action is to
7676
revoke them immediately. Once a crate has been published, it is
7777
impossible to determine if the leaked credentials have been copied.
78-
Yanking the crate only prevents new users from downloading it, but
79-
cannot stop those who have already downloaded it from keeping or even
80-
spreading the leaked credentials.
78+
Yanking only prevents Cargo from selecting this version when resolving
79+
dependencies by default. Existing lock files or direct downloads are not
80+
affected, so yanking cannot stop further spreading of the leaked
81+
credentials.
8182

8283
OPTIONS
8384
Yank Options

src/doc/src/commands/cargo-yank.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,10 @@ them at <[email protected]>.
6868

6969
If credentials have been leaked, the recommended course of action is to revoke
7070
them immediately. Once a crate has been published, it is impossible to determine
71-
if the leaked credentials have been copied. Yanking the crate only prevents new
72-
users from downloading it, but cannot stop those who have already downloaded it
73-
from keeping or even spreading the leaked credentials.
71+
if the leaked credentials have been copied. Yanking only prevents Cargo from
72+
selecting this version when resolving dependencies by default. Existing lock
73+
files or direct downloads are not affected, so yanking cannot stop further
74+
spreading of the leaked credentials.
7475

7576
[RustSec]: https://rustsec.org/
7677
[policies]: https://crates.io/policies

src/etc/man/cargo-yank.1

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -99,9 +99,10 @@ them at <[email protected]>\&.
9999
.sp
100100
If credentials have been leaked, the recommended course of action is to revoke
101101
them immediately. Once a crate has been published, it is impossible to determine
102-
if the leaked credentials have been copied. Yanking the crate only prevents new
103-
users from downloading it, but cannot stop those who have already downloaded it
104-
from keeping or even spreading the leaked credentials.
102+
if the leaked credentials have been copied. Yanking only prevents Cargo from
103+
selecting this version when resolving dependencies by default. Existing lock
104+
files or direct downloads are not affected, so yanking cannot stop further
105+
spreading of the leaked credentials.
105106
.SH "OPTIONS"
106107
.SS "Yank Options"
107108
.sp

0 commit comments

Comments
 (0)