From 3f36b0714634a97818e3fad9b5d77fdd4f009153 Mon Sep 17 00:00:00 2001 From: John Coffey Date: Mon, 26 Oct 2026 14:51:09 -0700 Subject: [PATCH] Read the API key from INBUXA_MIGRATE_API_KEY inbuxa-cli, the console and the docs call the credential an API key. --auth-bearer now reads $INBUXA_MIGRATE_API_KEY first and still falls back to $INBUXA_MIGRATE_TOKEN, so existing scripts keep working. Fixes #21 --- CHANGELOG.md | 7 +++++++ README.md | 3 ++- src/cli.rs | 56 +++++++++++++++++++++++++++++++++++++++++---------- src/secret.rs | 25 ++++++++++++++++++----- 4 files changed, 74 insertions(+), 17 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4399444..765d209 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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. diff --git a/README.md b/README.md index be1ffdc..6178b97 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/src/cli.rs b/src/cli.rs index 44576b3..c24aa3a 100644 --- a/src/cli.rs +++ b/src/cli.rs @@ -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>, @@ -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>, @@ -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>, @@ -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>, @@ -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>, @@ -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>, @@ -1109,7 +1121,7 @@ fn resolve_exchange_ews_auth(args: &ExchangeEwsImportArgs) -> Result Result { let mut argv = vec![ "inbuxa-migrate", diff --git a/src/secret.rs b/src/secret.rs index 153427e..cabce00 100644 --- a/src/secret.rs +++ b/src/secret.rs @@ -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 { + resolve_any(flag_value, &[env_var], prompt_label) +} + +pub fn resolve_any( + flag_value: Option<&str>, + env_vars: &[&str], + prompt_label: &str, ) -> Result { 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] ))) } -- 2.54.0