3 releases (breaking)

0.4.0 Sep 18, 2023
0.3.0 Aug 15, 2023
0.1.0 Dec 16, 2020

#388 in Authentication

Download history 13/week @ 2023-06-08 28/week @ 2023-06-15 23/week @ 2023-06-22 33/week @ 2023-06-29 33/week @ 2023-07-06 35/week @ 2023-07-13 37/week @ 2023-07-20 35/week @ 2023-07-27 98/week @ 2023-08-03 162/week @ 2023-08-10 200/week @ 2023-08-17 328/week @ 2023-08-24 126/week @ 2023-08-31 167/week @ 2023-09-07 193/week @ 2023-09-14 89/week @ 2023-09-21

623 downloads per month
Used in 4 crates


651 lines


This package is a library to assist writing a Cargo credential helper, which provides an interface to store tokens for authorizing access to a registry such as https://crates.io/.

Documentation about credential processes may be found at https://doc.rust-lang.org/nightly/cargo/reference/credential-provider-protocol.html

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


Create a Cargo project with this as a dependency:

# Add this to your Cargo.toml:

cargo-credential = "0.4"

And then include a main.rs binary which implements the Credential trait, and calls the main function which will call the appropriate method of the trait:

// src/main.rs

use cargo_credential::{Credential, Error};

struct MyCredential;

impl Credential for MyCredential {
    /// implement trait methods here...

fn main() {


Helper library for writing Cargo credential providers.

A credential process should have a struct that implements the Credential trait. The main function should be called with an instance of that struct, such as:

fn main() {

While in the perform function, stdin and stdout will be re-attached to the active console. This allows credential providers to be interactive if necessary.

Error handling


A credential provider may only support some registry URLs. If this is the case and an unsupported index URL is passed to the provider, it should respond with Error::UrlNotSupported. Other credential providers may be attempted by Cargo.


When attempting an Action::Get or Action::Logout, if a credential can not be found, the provider should respond with Error::NotFound. Other credential providers may be attempted by Cargo.


A credential provider might not support all operations. For example if the provider only supports Action::Get, Error::OperationNotSupported should be returned for all other requests.


All other errors go here. The error will be shown to the user in Cargo, including the full error chain using std::error::Error::source.



~147K SLoC