Skip to content

Commit 4bbd69b

Browse files
committed
fix(providers): protect refresh-owned credentials
Signed-off-by: Mrunal Patel <[email protected]>
1 parent a505e8d commit 4bbd69b

4 files changed

Lines changed: 240 additions & 18 deletions

File tree

‎.agents/skills/openshell-cli/SKILL.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -188,6 +188,12 @@ placeholders. A later `provider refresh configure` call is an explicit
188188
reauthorization boundary: it revokes the previous handle, and processes holding
189189
that handle fail closed until restarted.
190190

191+
While gateway-managed refresh is configured, `provider update --credential`
192+
cannot replace or delete the refresh-owned primary credential or any co-minted
193+
output. Use `provider refresh rotate`, reconfigure refresh, or delete refresh
194+
before returning those keys to manual management. Unrelated provider fields
195+
remain updateable.
196+
191197
---
192198

193199
## Workflow 3: Sandbox Lifecycle

‎architecture/sandbox.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,8 +94,10 @@ rotates the short-lived value, so an already-running process keeps one
9494
placeholder and each request resolves against the current token. Explicit
9595
refresh reconfiguration, provider replacement or detachment, and endpoint
9696
boundary changes produce a new handle and revoke the old one. Supervisors do
97-
not retain old values for these handles. Unmanaged static credentials retain
98-
the bounded revision-generation behavior.
97+
not retain old values for these handles. Public provider updates cannot replace
98+
or delete the refresh-owned primary credential or co-minted outputs; internal
99+
CAS rotation and explicit refresh lifecycle operations own those values.
100+
Unmanaged static credentials retain the bounded revision-generation behavior.
99101

100102
Route selection and policy evaluation use a syntax-only redacted request target;
101103
they do not materialize real credentials. Cross-endpoint placeholder use returns

‎crates/openshell-server/src/grpc/provider.rs‎

Lines changed: 222 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -305,6 +305,46 @@ pub(super) async fn update_provider_record_with_catalog(
305305
update_provider_record_validating(store, workspace, catalog, provider, None).await
306306
}
307307

308+
async fn reject_refresh_owned_credential_updates(
309+
store: &Store,
310+
provider_id: &str,
311+
credential_updates: &HashMap<String, String>,
312+
) -> Result<(), Status> {
313+
if credential_updates.is_empty() {
314+
return Ok(());
315+
}
316+
317+
let mut refresh_owned_keys = HashSet::new();
318+
for refresh_state in
319+
crate::provider_refresh::list_refresh_states_for_provider(store, provider_id).await?
320+
{
321+
let strategy =
322+
ProviderCredentialRefreshStrategy::try_from(refresh_state.strategy).unwrap_or_default();
323+
if !crate::provider_refresh::is_gateway_mintable_strategy(strategy) {
324+
continue;
325+
}
326+
327+
for key in std::iter::once(refresh_state.credential_key)
328+
.chain(refresh_state.additional_output_keys.into_values())
329+
{
330+
if credential_updates.contains_key(&key) {
331+
refresh_owned_keys.insert(key);
332+
}
333+
}
334+
}
335+
336+
if refresh_owned_keys.is_empty() {
337+
return Ok(());
338+
}
339+
340+
let mut refresh_owned_keys: Vec<_> = refresh_owned_keys.into_iter().collect();
341+
refresh_owned_keys.sort();
342+
Err(Status::failed_precondition(format!(
343+
"credentials managed by provider refresh cannot be updated or deleted with provider update: {}; use provider refresh rotate, configure, or delete",
344+
refresh_owned_keys.join(", ")
345+
)))
346+
}
347+
308348
async fn update_provider_record_validating(
309349
store: &Store,
310350
workspace: &str,
@@ -352,6 +392,9 @@ async fn update_provider_record_validating(
352392
));
353393
}
354394

395+
reject_refresh_owned_credential_updates(store, existing.object_id(), &provider.credentials)
396+
.await?;
397+
355398
let current_version = existing.metadata.as_ref().map_or(0, |m| m.resource_version);
356399

357400
let cas_version = if expected_resource_version == 0 {
@@ -8073,8 +8116,8 @@ mod tests {
80738116
}
80748117

80758118
#[tokio::test]
8076-
async fn refresh_managed_handle_survives_rotation_and_reconstruction_then_reconfigure_revokes()
8077-
{
8119+
async fn refresh_managed_handle_rejects_manual_replacement_survives_rotation_and_reconstruction_then_reconfigure_revokes()
8120+
{
80788121
let state = test_server_state().await;
80798122
let mut profile = custom_profile("stable-refresh-provider");
80808123
profile.credentials = vec![refreshable_credential("access_token", "ACCESS_TOKEN")];
@@ -8174,21 +8217,84 @@ mod tests {
81748217
.unwrap();
81758218
let original_placeholder = credential_state.snapshot().child_env["ACCESS_TOKEN"].clone();
81768219

8177-
update_provider_record_with_catalog(
8178-
state.store.as_ref(),
8179-
&catalog,
8180-
"default",
8181-
Provider {
8182-
metadata: Some(openshell_core::proto::datamodel::v1::ObjectMeta {
8183-
name: "stable-refresh".to_string(),
8184-
..Default::default()
8220+
for value in ["token-2", ""] {
8221+
let err = handle_update_provider(
8222+
&state,
8223+
authed_request(UpdateProviderRequest {
8224+
provider: Some(Provider {
8225+
metadata: Some(openshell_core::proto::datamodel::v1::ObjectMeta {
8226+
name: "stable-refresh".to_string(),
8227+
..Default::default()
8228+
}),
8229+
credentials: HashMap::from([(
8230+
"ACCESS_TOKEN".to_string(),
8231+
value.to_string(),
8232+
)]),
8233+
..Default::default()
8234+
}),
8235+
credential_expires_at_ms: HashMap::new(),
8236+
workspace: "default".to_string(),
81858237
}),
8186-
credentials: HashMap::from([("ACCESS_TOKEN".to_string(), "token-2".to_string())]),
8187-
..Default::default()
8188-
},
8189-
)
8190-
.await
8191-
.unwrap();
8238+
)
8239+
.await
8240+
.unwrap_err();
8241+
assert_eq!(err.code(), Code::FailedPrecondition);
8242+
assert!(err.message().contains("provider refresh"));
8243+
assert!(err.message().contains("ACCESS_TOKEN"));
8244+
}
8245+
8246+
let unchanged = state
8247+
.store
8248+
.get_message_by_name::<Provider>("default", "stable-refresh")
8249+
.await
8250+
.unwrap()
8251+
.unwrap();
8252+
assert_eq!(unchanged.credentials["ACCESS_TOKEN"], "token-1");
8253+
let unchanged_records =
8254+
load_provider_environment_records(state.store.as_ref(), "default", &names)
8255+
.await
8256+
.unwrap();
8257+
let unchanged_environment =
8258+
resolve_provider_environment_from_records_with_policy_bindings_and_credentials(
8259+
state.store.as_ref(),
8260+
&catalog,
8261+
&unchanged_records,
8262+
&HashMap::new(),
8263+
&state.credentials,
8264+
Some("sandbox-id"),
8265+
)
8266+
.await
8267+
.unwrap();
8268+
credential_state
8269+
.install_bound_environment(
8270+
revision_1,
8271+
unchanged_environment.environment,
8272+
unchanged_environment.credential_expires_at_ms,
8273+
unchanged_environment.dynamic_credentials,
8274+
unchanged_environment.static_credential_bindings,
8275+
Vec::new(),
8276+
)
8277+
.unwrap();
8278+
assert_eq!(
8279+
credential_state
8280+
.resolver_for_endpoint("api.example.com", 443, "/v1/messages")
8281+
.unwrap()
8282+
.resolve_placeholder(&original_placeholder),
8283+
Some("token-1")
8284+
);
8285+
8286+
// The gateway refresh path owns credential rotation and writes the
8287+
// minted value with an internal CAS, preserving the authorization
8288+
// epoch and therefore the workload handle.
8289+
state
8290+
.store
8291+
.update_message_cas::<Provider, _>(provider.object_id(), 0, |current| {
8292+
current
8293+
.credentials
8294+
.insert("ACCESS_TOKEN".to_string(), "token-2".to_string());
8295+
})
8296+
.await
8297+
.unwrap();
81928298
let records = load_provider_environment_records(state.store.as_ref(), "default", &names)
81938299
.await
81948300
.unwrap();
@@ -10541,6 +10647,106 @@ mod tests {
1054110647
);
1054210648
}
1054310649

10650+
#[tokio::test]
10651+
async fn update_provider_rejects_gateway_refresh_primary_and_additional_output_keys() {
10652+
use crate::grpc::policy::set_global_bool_setting_for_test;
10653+
10654+
let state = test_server_state().await;
10655+
set_global_bool_setting_for_test(
10656+
state.store.as_ref(),
10657+
openshell_core::settings::PROVIDERS_V2_ENABLED_KEY,
10658+
true,
10659+
)
10660+
.await
10661+
.unwrap();
10662+
10663+
let original_credentials = HashMap::from([
10664+
(
10665+
"AWS_ACCESS_KEY_ID".to_string(),
10666+
"original-access-key".to_string(),
10667+
),
10668+
(
10669+
"AWS_SECRET_ACCESS_KEY".to_string(),
10670+
"original-secret-key".to_string(),
10671+
),
10672+
(
10673+
"AWS_SESSION_TOKEN".to_string(),
10674+
"original-session-token".to_string(),
10675+
),
10676+
]);
10677+
let provider = create_provider_record(
10678+
state.store.as_ref(),
10679+
"default",
10680+
Provider {
10681+
metadata: Some(openshell_core::proto::datamodel::v1::ObjectMeta {
10682+
name: "aws-update-guard".to_string(),
10683+
workspace: "default".to_string(),
10684+
..Default::default()
10685+
}),
10686+
r#type: "aws".to_string(),
10687+
credentials: original_credentials.clone(),
10688+
..Default::default()
10689+
},
10690+
)
10691+
.await
10692+
.unwrap();
10693+
10694+
handle_configure_provider_refresh(
10695+
&state,
10696+
authed_request(ConfigureProviderRefreshRequest {
10697+
provider: "aws-update-guard".to_string(),
10698+
credential_key: "AWS_ACCESS_KEY_ID".to_string(),
10699+
strategy: ProviderCredentialRefreshStrategy::AwsStsAssumeRole as i32,
10700+
material: HashMap::from([(
10701+
"role_arn".to_string(),
10702+
"arn:aws:iam::123456789012:role/Test".to_string(),
10703+
)]),
10704+
secret_material_keys: Vec::new(),
10705+
expires_at_ms: None,
10706+
workspace: "default".to_string(),
10707+
}),
10708+
)
10709+
.await
10710+
.unwrap();
10711+
10712+
for key in [
10713+
"AWS_ACCESS_KEY_ID",
10714+
"AWS_SECRET_ACCESS_KEY",
10715+
"AWS_SESSION_TOKEN",
10716+
] {
10717+
for value in ["replacement", ""] {
10718+
let err = handle_update_provider(
10719+
&state,
10720+
authed_request(UpdateProviderRequest {
10721+
provider: Some(Provider {
10722+
metadata: Some(openshell_core::proto::datamodel::v1::ObjectMeta {
10723+
name: "aws-update-guard".to_string(),
10724+
..Default::default()
10725+
}),
10726+
credentials: HashMap::from([(key.to_string(), value.to_string())]),
10727+
..Default::default()
10728+
}),
10729+
credential_expires_at_ms: HashMap::new(),
10730+
workspace: "default".to_string(),
10731+
}),
10732+
)
10733+
.await
10734+
.unwrap_err();
10735+
assert_eq!(err.code(), Code::FailedPrecondition);
10736+
assert!(err.message().contains("provider refresh"));
10737+
assert!(err.message().contains(key));
10738+
}
10739+
}
10740+
10741+
let unchanged = state
10742+
.store
10743+
.get_message::<Provider>(provider.object_id())
10744+
.await
10745+
.unwrap()
10746+
.unwrap();
10747+
assert_eq!(unchanged.credentials, original_credentials);
10748+
}
10749+
1054410750
#[tokio::test]
1054510751
async fn configure_aws_sts_requires_profile_declaring_the_refresh() {
1054610752
use crate::grpc::StoredSettingValue;

‎docs/sandboxes/providers-v2.mdx‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -625,6 +625,14 @@ so running workloads keep the same opaque credential handle while the short-live
625625
token changes. Configuring refresh again is a revocation boundary and causes
626626
running workloads that still hold the previous handle to fail closed.
627627

628+
While gateway-managed refresh is configured, `provider update --credential`
629+
cannot replace or delete its primary credential or any co-minted output. Use
630+
`provider refresh rotate` to mint a new short-lived value. Re-run
631+
`provider refresh configure` to start a new authorization, or use
632+
`provider refresh delete` before returning those credential keys to manual
633+
management. You can still update unrelated credentials, configuration, and
634+
credential expiry metadata.
635+
628636
For a complete Microsoft Graph OAuth2 refresh-token walkthrough, see [Refresh Microsoft Graph Credentials with Providers v2](/get-started/tutorials/microsoft-graph-provider-refresh).
629637

630638
The profile YAML strategy values use underscores, while the CLI `--strategy` values use kebab-case:

0 commit comments

Comments
 (0)