Read the API key from INBUXA_MIGRATE_API_KEY #22

Merged
jcoffey-dev merged 1 commits from feat/api-key-env into main 2026-10-26 21:55:34 +00:00
4 changed files with 74 additions and 17 deletions

No files matched your search

+7
View File
@@ -3,6 +3,13 @@
All notable changes to this project are recorded here. Versions are dates:
release `v2026.9.30` is version `2026.9.30`.
## Unreleased
### Changed
- `--auth-bearer` reads `INBUXA_MIGRATE_API_KEY`, the name inbuxa-cli and the
console use. `INBUXA_MIGRATE_TOKEN` still works; when both are set, the API
key wins.
## [2026.9.30] -- 2026-09-30
The first release of inbuxa-migrate.
+2 -1
View File
@@ -57,7 +57,8 @@ advertises the types being written. The full command reference is in
Secrets are read from the environment, or asked for at a prompt:
INBUXA_MIGRATE_PASSWORD a password for --auth-basic
INBUXA_MIGRATE_TOKEN a bearer token for --auth-bearer
INBUXA_MIGRATE_API_KEY an API key or bearer token for --auth-bearer
(INBUXA_MIGRATE_TOKEN still works)
INBUXA_MIGRATE_EWS_CLIENT_SECRET the OAuth client secret for app-only EWS
INBUXA_MIGRATE_GRAPH_TOKEN a Microsoft Graph access token
+45 -11
View File
@@ -150,7 +150,7 @@ struct JmapImportArgs {
long,
value_name = "TOKEN",
num_args = 0..=1,
help = "Bearer token (value optional: falls back to $INBUXA_MIGRATE_TOKEN or prompt)"
help = "API key or bearer token (value optional: falls back to $INBUXA_MIGRATE_API_KEY or prompt)"
)]
auth_bearer: Option<Option<String>>,
@@ -211,7 +211,7 @@ struct ImapImportArgs {
long,
value_name = "TOKEN",
num_args = 0..=1,
help = "Bearer token for XOAUTH2 (value optional: falls back to $INBUXA_MIGRATE_TOKEN or prompt)"
help = "Bearer token for XOAUTH2 (value optional: falls back to $INBUXA_MIGRATE_API_KEY or prompt)"
)]
auth_bearer: Option<Option<String>>,
@@ -329,7 +329,7 @@ struct ExportArgs {
long,
value_name = "TOKEN",
num_args = 0..=1,
help = "Bearer token (value optional: falls back to $INBUXA_MIGRATE_TOKEN or prompt)"
help = "API key or bearer token (value optional: falls back to $INBUXA_MIGRATE_API_KEY or prompt)"
)]
auth_bearer: Option<Option<String>>,
@@ -427,7 +427,7 @@ pub struct ManageSieveImportArgs {
long,
value_name = "TOKEN",
num_args = 0..=1,
help = "Bearer token for OAUTHBEARER (value optional: $INBUXA_MIGRATE_TOKEN or prompt)"
help = "Bearer token for OAUTHBEARER (value optional: $INBUXA_MIGRATE_API_KEY or prompt)"
)]
auth_bearer: Option<Option<String>>,
@@ -477,7 +477,7 @@ pub struct DavImportArgs {
long,
value_name = "TOKEN",
num_args = 0..=1,
help = "Bearer token (value optional: $INBUXA_MIGRATE_TOKEN or prompt)"
help = "API key or bearer token (value optional: $INBUXA_MIGRATE_API_KEY or prompt)"
)]
auth_bearer: Option<Option<String>>,
@@ -589,7 +589,11 @@ fn resolve_managesieve_auth(
let user = auth_user
.ok_or_else(|| Error::Usage("--auth-user is required with --auth-bearer".to_owned()))?
.to_owned();
let token = secret::resolve(bearer.as_deref(), "INBUXA_MIGRATE_TOKEN", "bearer token")?;
let token = secret::resolve_any(
bearer.as_deref(),
secret::API_KEY_VARS,
"API key or bearer token",
)?;
Ok(ManageSieveAuth::Bearer { user, token })
}
@@ -752,7 +756,11 @@ fn resolve_dav_auth(
let bearer = auth_bearer.ok_or_else(|| {
Error::Usage("exactly one of --auth-basic / --auth-bearer is required".to_owned())
})?;
let token = secret::resolve(bearer.as_deref(), "INBUXA_MIGRATE_TOKEN", "bearer token")?;
let token = secret::resolve_any(
bearer.as_deref(),
secret::API_KEY_VARS,
"API key or bearer token",
)?;
Ok(DavAuth::Bearer { token })
}
@@ -858,7 +866,11 @@ fn resolve_imap_auth(
let user = auth_user
.ok_or_else(|| Error::Usage("--auth-user is required with --auth-bearer".to_owned()))?
.to_owned();
let token = secret::resolve(bearer.as_deref(), "INBUXA_MIGRATE_TOKEN", "bearer token")?;
let token = secret::resolve_any(
bearer.as_deref(),
secret::API_KEY_VARS,
"API key or bearer token",
)?;
Ok(ImapAuth::Bearer { user, token })
}
@@ -942,7 +954,7 @@ pub struct ExchangeEwsImportArgs {
long,
value_name = "TOKEN",
num_args = 0..=1,
help = "Bearer token (value optional: $INBUXA_MIGRATE_TOKEN or device-code flow)"
help = "API key or bearer token (value optional: $INBUXA_MIGRATE_API_KEY or device-code flow)"
)]
auth_bearer: Option<Option<String>>,
@@ -1109,7 +1121,7 @@ fn resolve_exchange_ews_auth(args: &ExchangeEwsImportArgs) -> Result<EwsAuth, Er
client_secret: env_secret,
}));
}
let token = secret::resolve(None, "INBUXA_MIGRATE_TOKEN", "bearer token")?;
let token = secret::resolve_any(None, secret::API_KEY_VARS, "API key or bearer token")?;
Ok(EwsAuth::Bearer { token })
}
@@ -1348,7 +1360,11 @@ fn resolve_auth(
let bearer = auth_bearer.ok_or_else(|| {
Error::Usage("exactly one of --auth-basic / --auth-bearer is required".to_owned())
})?;
let token = secret::resolve(bearer.as_deref(), "INBUXA_MIGRATE_TOKEN", "bearer token")?;
let token = secret::resolve_any(
bearer.as_deref(),
secret::API_KEY_VARS,
"API key or bearer token",
)?;
Ok(Auth::Bearer { token })
}
@@ -1379,6 +1395,7 @@ mod tests {
fn auth_password_without_basic_is_usage_error() {
let _g = lock();
unsafe {
env::remove_var("INBUXA_MIGRATE_API_KEY");
env::remove_var("INBUXA_MIGRATE_TOKEN");
env::remove_var("INBUXA_MIGRATE_PASSWORD");
}
@@ -1396,6 +1413,7 @@ mod tests {
fn auth_basic_with_password_resolves() {
let _g = lock();
unsafe {
env::remove_var("INBUXA_MIGRATE_API_KEY");
env::remove_var("INBUXA_MIGRATE_TOKEN");
env::remove_var("INBUXA_MIGRATE_PASSWORD");
}
@@ -1413,6 +1431,7 @@ mod tests {
fn auth_bearer_inline_token_resolves() {
let _g = lock();
unsafe {
env::remove_var("INBUXA_MIGRATE_API_KEY");
env::remove_var("INBUXA_MIGRATE_TOKEN");
env::remove_var("INBUXA_MIGRATE_PASSWORD");
}
@@ -1421,6 +1440,21 @@ mod tests {
assert!(matches!(auth, Auth::Bearer { token } if token == "t"));
}
#[test]
fn auth_bearer_reads_api_key_before_token() {
let _g = lock();
unsafe {
env::set_var("INBUXA_MIGRATE_API_KEY", "key");
env::set_var("INBUXA_MIGRATE_TOKEN", "old");
}
let auth = resolve_auth(None, None, Some(&None)).unwrap();
assert!(matches!(auth, Auth::Bearer { token } if token == "key"));
unsafe { env::remove_var("INBUXA_MIGRATE_API_KEY") };
let auth = resolve_auth(None, None, Some(&None)).unwrap();
assert!(matches!(auth, Auth::Bearer { token } if token == "old"));
unsafe { env::remove_var("INBUXA_MIGRATE_TOKEN") };
}
fn graph_config(objects: &[&str]) -> Result<GraphImportConfig, Error> {
let mut argv = vec![
"inbuxa-migrate",
+20 -5
View File
@@ -9,24 +9,39 @@ use std::process::Command;
use crate::error::Error;
/// The variables an API key or bearer token is read from, first match wins.
/// `INBUXA_MIGRATE_TOKEN` is the older name, still read.
pub const API_KEY_VARS: &[&str] = &["INBUXA_MIGRATE_API_KEY", "INBUXA_MIGRATE_TOKEN"];
pub fn resolve(
flag_value: Option<&str>,
env_var: &str,
prompt_label: &str,
) -> Result<String, Error> {
resolve_any(flag_value, &[env_var], prompt_label)
}
pub fn resolve_any(
flag_value: Option<&str>,
env_vars: &[&str],
prompt_label: &str,
) -> Result<String, Error> {
if let Some(value) = flag_value {
return Ok(value.to_owned());
}
if let Ok(value) = std::env::var(env_var)
&& !value.is_empty()
{
return Ok(value);
for env_var in env_vars {
if let Ok(value) = std::env::var(env_var)
&& !value.is_empty()
{
return Ok(value);
}
}
if std::io::stdin().is_terminal() {
return prompt_no_echo(prompt_label);
}
Err(Error::Usage(format!(
"no {prompt_label} provided: pass the flag, set ${env_var}, or run on a TTY for an interactive prompt"
"no {prompt_label} provided: pass the flag, set ${}, or run on a TTY for an interactive prompt",
env_vars[0]
)))
}