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.

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

secure-secrets-in-params: Flag insecure references to secure params #16251

Merged
merged 1 commit into from
Jan 31, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ namespace Bicep.Core.UnitTests.Diagnostics.LinterRuleTests
[TestClass]
public class SecretsInParamsMustBeSecureTests : LinterRuleTestsBase
{
private void AssertCodeFix(string inputFile, string resultFile)
=> AssertCodeFix(SecretsInParamsMustBeSecureRule.Code, "Mark parameter as secure", inputFile, resultFile);

[TestMethod]
public void ParameterNameInFormattedMessage()
{
Expand Down Expand Up @@ -156,5 +159,21 @@ param stgAccountName string
";
CompileAndTest(bicep, 0);
}

[TestMethod]
// https://github.com/Azure/bicep/issues/15835
public void Default_value_reference_to_insecure_param_is_flagged()
=> AssertCodeFix("""
@secure()
param secureParam string

param insecurePa|ram string = secureParam
""", """
@secure()
param secureParam string

@secure()
param insecureParam string = secureParam
""");
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ override public IEnumerable<IDiagnostic> AnalyzeInternal(SemanticModel model, Di
}
}

private Diagnostic? AnalyzeUnsecuredParameter(SemanticModel model, DiagnosticLevel diagnosticLevel, ParameterSymbol parameterSymbol)
private IDiagnostic? AnalyzeUnsecuredParameter(SemanticModel model, DiagnosticLevel diagnosticLevel, ParameterSymbol parameterSymbol)
{
string name = parameterSymbol.Name;
TypeSymbol type = parameterSymbol.Type;
Expand All @@ -69,23 +69,36 @@ override public IEnumerable<IDiagnostic> AnalyzeInternal(SemanticModel model, Di
{
if (!AllowedRegex.IsMatch(name))
{
// Create fix
var decorator = SyntaxFactory.CreateDecorator("secure");
var newline = model.Configuration.Formatting.Data.NewlineKind.ToEscapeSequence();
var decoratorText = $"{decorator}{newline}";
var fixSpan = new TextSpan(parameterSymbol.DeclaringSyntax.Span.Position, 0);
var codeReplacement = new CodeReplacement(fixSpan, decoratorText);

return CreateFixableDiagnosticForSpan(
diagnosticLevel,
parameterSymbol.NameSource.Span,
new CodeFix("Mark parameter as secure", isPreferred: true, CodeFixKind.QuickFix, codeReplacement),
name);
return CreateDiagnostic(model, parameterSymbol, diagnosticLevel);
}
}
}

foreach (var referencedSymbol in model.Binder.GetSymbolsReferencedInDeclarationOf(parameterSymbol))
{
if (referencedSymbol is ParameterSymbol referencedParameter && referencedParameter.IsSecure())
{
// The default vlaue has a reference to a parameter marked as secure
return CreateDiagnostic(model, parameterSymbol, diagnosticLevel);
}
}

return null;
}

private IDiagnostic CreateDiagnostic(SemanticModel model, ParameterSymbol parameterSymbol, DiagnosticLevel diagnosticLevel)
{
var decorator = SyntaxFactory.CreateDecorator("secure");
var newline = model.Configuration.Formatting.Data.NewlineKind.ToEscapeSequence();
var decoratorText = $"{decorator}{newline}";
var fixSpan = new TextSpan(parameterSymbol.DeclaringSyntax.Span.Position, 0);
var codeReplacement = new CodeReplacement(fixSpan, decoratorText);

return CreateFixableDiagnosticForSpan(
diagnosticLevel,
parameterSymbol.NameSource.Span,
new CodeFix("Mark parameter as secure", isPreferred: true, CodeFixKind.QuickFix, codeReplacement),
parameterSymbol.Name);
}
}
}
Loading