Skip to content
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

Jump to bottom

Fix maps/lists with sensitive members not redacted #3765

Merged
merged 5 commits into from
Jul 17, 2024
Merged

Fix maps/lists with sensitive members not redacted #3765

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9d7d7e4
Fix maps/lists w sensitive members not redacted
landonxjames Jul 16, 2024
5a65100
Merge branch 'main' into landonxjames/sensitive-lists
landonxjames Jul 16, 2024
4b398c7
Fix bug with @sensitive structs
landonxjames Jul 16, 2024
3c37ca1
Update CHANGELOG
landonxjames Jul 17, 2024
76029f3
Merge branch 'main' into landonxjames/sensitive-lists
landonxjames Jul 17, 2024
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
15 changes: 8 additions & 7 deletions codegen-core/src/main/kotlin/software/amazon/smithy/rust/codegen/core/util/Smithy.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ import software.amazon.smithy.aws.traits.ServiceTrait
import software.amazon.smithy.codegen.core.CodegenException
import software.amazon.smithy.model.Model
import software.amazon.smithy.model.shapes.BooleanShape
import software.amazon.smithy.model.shapes.ListShape
import software.amazon.smithy.model.shapes.MapShape
import software.amazon.smithy.model.shapes.MemberShape
import software.amazon.smithy.model.shapes.NumberShape
import software.amazon.smithy.model.shapes.OperationShape
Expand Down Expand Up @@ -99,13 +101,12 @@ fun ServiceShape.hasEventStreamOperations(model: Model): Boolean =
}

fun Shape.shouldRedact(model: Model): Boolean =
when (this) {
is MemberShape ->
model.expectShape(target).shouldRedact(model) ||
model.expectShape(container)
.shouldRedact(model)

else -> this.hasTrait<SensitiveTrait>()
when {
this is MemberShape -> model.expectShape(target).shouldRedact(model)
hasTrait<SensitiveTrait>() -> true
this is ListShape -> member.shouldRedact(model)
this is MapShape -> key.shouldRedact(model) || value.shouldRedact(model)
else -> false
}

const val REDACTION = "\"*** Sensitive Data Redacted ***\""
Expand Down
43 changes: 35 additions & 8 deletions ...tlin/software/amazon/smithy/rust/codegen/core/smithy/generators/StructureGeneratorTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,10 @@ class StructureGeneratorTest {
structure Credentials {
username: String,
password: Password,

secretKey: SecretKey
secretKey: SecretKey,
secretValueMap: MapThatContainsSecretValues,
secretKeyMap: MapThatContainsSecretKeys,
secretList: ListThatContainsSecrets
}

structure StructWithDoc {
Expand All @@ -79,6 +81,20 @@ class StructureGeneratorTest {
public: String,
private: SecretStructure,
}

map MapThatContainsSecretKeys {
key: SecretKey
value: String
}

map MapThatContainsSecretValues {
key: String
value: SecretKey
}

list ListThatContainsSecrets {
member: Password
}
""".asSmithyModel()
val struct = model.lookup<StructureShape>("com.test#MyStruct")
val structWithDoc = model.lookup<StructureShape>("com.test#StructWithDoc")
Expand Down Expand Up @@ -159,15 +175,27 @@ class StructureGeneratorTest {
TestWorkspace.testProject().unitTest {
structureGenerator(model, provider, this, credentials).render()

this.unitTest(
"sensitive_fields_redacted",
rust(
"""
use std::collections::HashMap;

let mut secret_map = HashMap::new();
secret_map.insert("FirstSecret".to_string(), "don't leak me".to_string());
secret_map.insert("SecondSecret".to_string(), "don't leak me".to_string());

let secret_list = vec!["don't leak me".to_string()];

let creds = Credentials {
username: Some("not_redacted".to_owned()),
password: Some("don't leak me".to_owned()),
secret_key: Some("don't leak me".to_owned())
secret_key: Some("don't leak me".to_owned()),
secret_key_map: Some(secret_map.clone()),
secret_value_map: Some(secret_map),
secret_list: Some(secret_list),
};
assert_eq!(format!("{:?}", creds), "Credentials { username: Some(\"not_redacted\"), password: \"*** Sensitive Data Redacted ***\", secret_key: \"*** Sensitive Data Redacted ***\" }");

assert_eq!(format!("{:?}", creds),
"Credentials { username: Some(\"not_redacted\"), password: \"*** Sensitive Data Redacted ***\", secret_key: \"*** Sensitive Data Redacted ***\", secret_value_map: \"*** Sensitive Data Redacted ***\", secret_key_map: \"*** Sensitive Data Redacted ***\", secret_list: \"*** Sensitive Data Redacted ***\" }");
""",
)
}.compileAndTest()
Expand All @@ -179,8 +207,7 @@ class StructureGeneratorTest {
TestWorkspace.testProject().unitTest {
structureGenerator(model, provider, this, secretStructure).render()

this.unitTest(
"sensitive_structure_redacted",
rust(
"""
let secret_structure = SecretStructure {
secret_field: Some("secret".to_owned()),
Expand Down
Loading