Skip to content

fix(server): redact provider credentials in gRPC CRUD responses#344

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
drew wants to merge 1 commit into from
Closed

fix(server): redact provider credentials in gRPC CRUD responses #344

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 26 additions & 4 deletions crates/openshell-server/src/grpc.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -111,6 +111,11 @@ pub fn clamp_limit(raw: u32, default: u32, max: u32) -> u32 {
if raw == 0 { default } else { raw.min(max) }
}

fn redact_provider_credentials(mut provider: Provider) -> Provider {
provider.credentials.clear();
provider
}

/// OpenShell gRPC service implementation.
#[derive(Debug, Clone)]
pub struct OpenShellService {
Expand DownExpand Up@@ -647,7 +652,7 @@ impl OpenShell for OpenShellService {
let provider = create_provider_record(self.state.store.as_ref(), provider).await?;

Ok(Response::new(ProviderResponse {
provider: Some(provider),
provider: Some(redact_provider_credentials(provider)),
}))
}

Expand All@@ -659,7 +664,7 @@ impl OpenShell for OpenShellService {
let provider = get_provider_record(self.state.store.as_ref(), &name).await?;

Ok(Response::new(ProviderResponse {
provider: Some(provider),
provider: Some(redact_provider_credentials(provider)),
}))
}

Expand All@@ -672,7 +677,12 @@ impl OpenShell for OpenShellService {
let providers =
list_provider_records(self.state.store.as_ref(), limit, request.offset).await?;

Ok(Response::new(ListProvidersResponse { providers }))
Ok(Response::new(ListProvidersResponse {
providers: providers
.into_iter()
.map(redact_provider_credentials)
.collect(),
}))
}

async fn update_provider(
Expand All@@ -686,7 +696,7 @@ impl OpenShell for OpenShellService {
let provider = update_provider_record(self.state.store.as_ref(), provider).await?;

Ok(Response::new(ProviderResponse {
provider: Some(provider),
provider: Some(redact_provider_credentials(provider)),
}))
}

Expand DownExpand Up@@ -3365,6 +3375,18 @@ mod tests {
assert_eq!(clamp_limit(u32::MAX, 100, MAX_PAGE_SIZE), MAX_PAGE_SIZE);
}

#[test]
fn redact_provider_credentials_clears_only_credentials() {
let provider = provider_with_values("gitlab-local", "gitlab");
let redacted = redact_provider_credentials(provider.clone());

assert!(redacted.credentials.is_empty());
assert_eq!(redacted.id, provider.id);
assert_eq!(redacted.name, provider.name);
assert_eq!(redacted.r#type, provider.r#type);
assert_eq!(redacted.config, provider.config);
}

fn provider_with_values(name: &str, provider_type: &str) -> Provider {
Provider {
id: String::new(),
Expand Down
Loading