-
Notifications
You must be signed in to change notification settings - Fork 29
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #404 from StefanMaron/development
New rule0034 Use SecretText type
- Loading branch information
Showing
5 changed files
with
93 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| using System.Collections.Immutable; | ||
| using Microsoft.Dynamics.Nav.CodeAnalysis; | ||
| using Microsoft.Dynamics.Nav.CodeAnalysis.Diagnostics; | ||
| using Microsoft.Dynamics.Nav.CodeAnalysis.Symbols; | ||
|
|
||
| namespace BusinessCentral.LinterCop.Design | ||
| { | ||
| [DiagnosticAnalyzer] | ||
| public class Rule0043SecretText : DiagnosticAnalyzer | ||
| { | ||
| public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics { get; } = ImmutableArray.Create<DiagnosticDescriptor>(DiagnosticDescriptors.Rule0043SecretText); | ||
|
|
||
| private static readonly string authorization = "Authorization"; | ||
| private static readonly List<string> buildInMethodNames = new List<string> | ||
| { | ||
| "add", | ||
| "getvalues", | ||
| "tryaddwithoutvalidation" | ||
| }; | ||
|
|
||
| public override void Initialize(AnalysisContext context) => context.RegisterOperationAction(new Action<OperationAnalysisContext>(this.AnalyzeHttpObjects), OperationKind.InvocationExpression); | ||
|
|
||
| private void AnalyzeHttpObjects(OperationAnalysisContext ctx) | ||
| { | ||
| if (!VersionChecker.IsSupported(ctx.ContainingSymbol, VersionCompatibility.Fall2023OrGreater)) return; | ||
|
|
||
| if (ctx.ContainingSymbol.GetContainingObjectTypeSymbol().IsObsoletePending || ctx.ContainingSymbol.GetContainingObjectTypeSymbol().IsObsoleteRemoved) return; | ||
| if (ctx.ContainingSymbol.IsObsoletePending || ctx.ContainingSymbol.IsObsoleteRemoved) return; | ||
|
|
||
| IInvocationExpression operation = (IInvocationExpression)ctx.Operation; | ||
|
|
||
| // We need at least two arguments | ||
| if (operation.Arguments.Count() < 2) return; | ||
|
|
||
| switch (operation.TargetMethod.MethodKind) | ||
| { | ||
| case MethodKind.BuiltInMethod: | ||
| if (!buildInMethodNames.Contains(operation.TargetMethod.Name.ToLowerInvariant())) return; | ||
|
|
||
| // We need to verify that the method is called from a HttpHeaders or HttpClient object | ||
| if (!ctx.Operation.DescendantsAndSelf().Where(x => x.GetSymbol() != null) | ||
| .Where(x => x.Type.GetNavTypeKindSafe() == NavTypeKind.HttpHeaders || x.Type.GetNavTypeKindSafe() == NavTypeKind.HttpClient) | ||
| .Any()) return; | ||
| break; | ||
| case MethodKind.Method: | ||
| if (operation.TargetMethod.ContainingType.GetNavTypeKindSafe() != NavTypeKind.Codeunit) return; | ||
| ICodeunitTypeSymbol codeunitTypeSymbol = (ICodeunitTypeSymbol)operation.TargetMethod.GetContainingObjectTypeSymbol(); | ||
| if (!SemanticFacts.IsSameName(((INamespaceSymbol)codeunitTypeSymbol.ContainingSymbol).QualifiedName, "System.RestClient")) return; | ||
| if (!SemanticFacts.IsSameName(codeunitTypeSymbol.Name, "Rest Client")) return; | ||
| if (!SemanticFacts.IsSameName(operation.TargetMethod.Name, "SetDefaultRequestHeader")) return; | ||
| break; | ||
| default: | ||
| return; | ||
| } | ||
|
|
||
| if (!IsAuthorizationArgument(operation.Arguments[0])) return; | ||
|
|
||
| if (operation.Arguments[1].Parameter.OriginalDefinition.GetTypeSymbol().GetNavTypeKindSafe() != NavTypeKind.SecretText) | ||
| ctx.ReportDiagnostic(Diagnostic.Create(DiagnosticDescriptors.Rule0043SecretText, ctx.Operation.Syntax.GetLocation())); | ||
| } | ||
|
|
||
| private static bool IsAuthorizationArgument(IArgument argument) | ||
| { | ||
| switch (argument.Syntax.Kind) | ||
| { | ||
| case SyntaxKind.LiteralExpression: | ||
| return SemanticFacts.IsSameName(argument.Value.ConstantValue.Value.ToString(), authorization); | ||
| case SyntaxKind.IdentifierName: | ||
| IOperation operand = ((IConversionExpression)argument.Value).Operand; | ||
| ILabelTypeSymbol label = (ILabelTypeSymbol)operand.GetSymbol().OriginalDefinition.GetTypeSymbol(); | ||
| return SemanticFacts.IsSameName(label.GetLabelText(), authorization); | ||
| default: | ||
| return false; | ||
| } | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters