mirror of
https://github.com/astral-sh/uv.git
synced 2025-08-27 14:04:16 +00:00

This PR is a first step toward support for storing credentials in the system keyring. The `keyring-rs` crate is the best option for system keyring integration, but the latest version (v4) requires either that Linux users have `libdbus` installed or that it is built with `libdbus` vendored in. This is because v4 depends on [dbus-secret-service](https://github.com/open-source-cooperative/dbus-secret-service), which was created as an alternative to [secret-service](https://github.com/open-source-cooperative/secret-service-rs) so that users are not required to use an async runtime. Since uv does use an async runtime, this is not a good tradeoff for uv. This PR: * Vendors `keyring-rs` crate into a new `uv-keyring` workspace crate * Moves to the async `secret-service` crate that does not require clients on Linux to have `libdbus` on their machines. This includes updating `CredentialsAPI` trait (and implementations) to use async methods. * Adds `uv-keyring` tests to `cargo test` jobs. For `cargo test | ubuntu`, this meant setting up secret service and priming gnome-keyring as an earlier step. * Removes iOS code paths * Patches in @oconnor663 's changes from his [`keyring-rs` PR](https://github.com/open-source-cooperative/keyring-rs/pull/261) * Applies many clippy-driven updates
175 lines
4.8 KiB
Rust
175 lines
4.8 KiB
Rust
#![cfg(feature = "keyring-tests")]
|
|
|
|
use common::{generate_random_bytes_of_len, generate_random_string, init_logger};
|
|
use uv_keyring::{Entry, Error};
|
|
|
|
mod common;
|
|
|
|
#[tokio::test]
|
|
async fn test_missing_entry() {
|
|
init_logger();
|
|
|
|
let name = generate_random_string();
|
|
let entry = Entry::new(&name, &name).expect("Can't create entry");
|
|
assert!(
|
|
matches!(entry.get_password().await, Err(Error::NoEntry)),
|
|
"Missing entry has password"
|
|
);
|
|
}
|
|
|
|
#[tokio::test]
|
|
#[cfg(target_os = "linux")]
|
|
async fn test_empty_password() {
|
|
init_logger();
|
|
|
|
let name = generate_random_string();
|
|
let entry = Entry::new(&name, &name).expect("Can't create entry");
|
|
let in_pass = "";
|
|
entry
|
|
.set_password(in_pass)
|
|
.await
|
|
.expect("Can't set empty password");
|
|
let out_pass = entry
|
|
.get_password()
|
|
.await
|
|
.expect("Can't get empty password");
|
|
assert_eq!(
|
|
in_pass, out_pass,
|
|
"Retrieved and set empty passwords don't match"
|
|
);
|
|
entry
|
|
.delete_credential()
|
|
.await
|
|
.expect("Can't delete password");
|
|
assert!(
|
|
matches!(entry.get_password().await, Err(Error::NoEntry)),
|
|
"Able to read a deleted password"
|
|
);
|
|
}
|
|
|
|
#[tokio::test]
|
|
async fn test_round_trip_ascii_password() {
|
|
init_logger();
|
|
|
|
let name = generate_random_string();
|
|
let entry = Entry::new(&name, &name).expect("Can't create entry");
|
|
let password = "test ascii password";
|
|
entry
|
|
.set_password(password)
|
|
.await
|
|
.expect("Can't set ascii password");
|
|
let stored_password = entry
|
|
.get_password()
|
|
.await
|
|
.expect("Can't get ascii password");
|
|
assert_eq!(
|
|
stored_password, password,
|
|
"Retrieved and set ascii passwords don't match"
|
|
);
|
|
entry
|
|
.delete_credential()
|
|
.await
|
|
.expect("Can't delete ascii password");
|
|
assert!(
|
|
matches!(entry.get_password().await, Err(Error::NoEntry)),
|
|
"Able to read a deleted ascii password"
|
|
);
|
|
}
|
|
|
|
#[tokio::test]
|
|
async fn test_round_trip_non_ascii_password() {
|
|
init_logger();
|
|
|
|
let name = generate_random_string();
|
|
let entry = Entry::new(&name, &name).expect("Can't create entry");
|
|
let password = "このきれいな花は桜です";
|
|
entry
|
|
.set_password(password)
|
|
.await
|
|
.expect("Can't set non-ascii password");
|
|
let stored_password = entry
|
|
.get_password()
|
|
.await
|
|
.expect("Can't get non-ascii password");
|
|
assert_eq!(
|
|
stored_password, password,
|
|
"Retrieved and set non-ascii passwords don't match"
|
|
);
|
|
entry
|
|
.delete_credential()
|
|
.await
|
|
.expect("Can't delete non-ascii password");
|
|
assert!(
|
|
matches!(entry.get_password().await, Err(Error::NoEntry)),
|
|
"Able to read a deleted non-ascii password"
|
|
);
|
|
}
|
|
|
|
#[tokio::test]
|
|
async fn test_round_trip_random_secret() {
|
|
init_logger();
|
|
|
|
let name = generate_random_string();
|
|
let entry = Entry::new(&name, &name).expect("Can't create entry");
|
|
let secret = generate_random_bytes_of_len(24);
|
|
entry
|
|
.set_secret(secret.as_slice())
|
|
.await
|
|
.expect("Can't set random secret");
|
|
let stored_secret = entry.get_secret().await.expect("Can't get random secret");
|
|
assert_eq!(
|
|
&stored_secret,
|
|
secret.as_slice(),
|
|
"Retrieved and set random secrets don't match"
|
|
);
|
|
entry
|
|
.delete_credential()
|
|
.await
|
|
.expect("Can't delete random secret");
|
|
assert!(
|
|
matches!(entry.get_password().await, Err(Error::NoEntry)),
|
|
"Able to read a deleted random secret"
|
|
);
|
|
}
|
|
|
|
#[tokio::test]
|
|
async fn test_update() {
|
|
init_logger();
|
|
|
|
let name = generate_random_string();
|
|
let entry = Entry::new(&name, &name).expect("Can't create entry");
|
|
let password = "test ascii password";
|
|
entry
|
|
.set_password(password)
|
|
.await
|
|
.expect("Can't set initial ascii password");
|
|
let stored_password = entry
|
|
.get_password()
|
|
.await
|
|
.expect("Can't get ascii password");
|
|
assert_eq!(
|
|
stored_password, password,
|
|
"Retrieved and set initial ascii passwords don't match"
|
|
);
|
|
let password = "このきれいな花は桜です";
|
|
entry
|
|
.set_password(password)
|
|
.await
|
|
.expect("Can't update ascii with non-ascii password");
|
|
let stored_password = entry
|
|
.get_password()
|
|
.await
|
|
.expect("Can't get non-ascii password");
|
|
assert_eq!(
|
|
stored_password, password,
|
|
"Retrieved and updated non-ascii passwords don't match"
|
|
);
|
|
entry
|
|
.delete_credential()
|
|
.await
|
|
.expect("Can't delete updated password");
|
|
assert!(
|
|
matches!(entry.get_password().await, Err(Error::NoEntry)),
|
|
"Able to read a deleted updated password"
|
|
);
|
|
}
|