forked from PowerShell/PSScriptAnalyzer
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathAvoidUsingInternalURLs.cs
More file actions
226 lines (209 loc) · 10.6 KB
/
Copy pathAvoidUsingInternalURLs.cs
File metadata and controls
226 lines (209 loc) · 10.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
//
// Copyright (c) Microsoft Corporation.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
//
using System;
using System.Collections;
using System.Collections.Generic;
using System.Linq;
using System.Linq.Expressions;
using System.Management.Automation.Language;
using Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic;
using System.ComponentModel.Composition;
using System.Globalization;
using System.IO;
namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.BuiltinRules
{
/// <summary>
/// AvoidUsingInternalURLs: Check if a URL is potentially an internal URL,
/// eg://msw, //scratch2/scratch
/// </summary>
[Export(typeof (IScriptRule))]
public class AvoidUsingInternalURLs : IScriptRule
{
/// <summary>
/// AnalyzeScript: Analyzes the ast to check if any internal URL is used.
/// </summary>
/// <param name="ast">The script's ast</param>
/// <param name="fileName">The script's file name</param>
/// <returns>A List of diagnostic results of this rule</returns>
public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName)
{
if (ast == null) throw new ArgumentNullException(Strings.NullAstErrorMessage);
IEnumerable<Ast> expressionAsts = ast.FindAll(testAst => testAst is StringConstantExpressionAst, true);
if (expressionAsts != null)
{
foreach (StringConstantExpressionAst expressionAst in expressionAsts)
{
Ast parentAst = expressionAst.Parent;
//Check if -replace is used, if it is string replace, we don't throw warnings.
Ast grandParentAst = parentAst.Parent;
if (grandParentAst is BinaryExpressionAst)
{
if ((grandParentAst as BinaryExpressionAst).Operator.Equals(TokenKind.Ireplace))
{
continue;
}
}
//Check if XPath is used. If XPath is used, then we don't throw warnings.
if (parentAst is InvokeMemberExpressionAst)
{
InvokeMemberExpressionAst invocation = parentAst as InvokeMemberExpressionAst;
if (invocation != null)
{
if (String.Equals(invocation.Member.ToString(), "SelectSingleNode",StringComparison.OrdinalIgnoreCase) ||
String.Equals(invocation.Member.ToString(), "SelectNodes",StringComparison.OrdinalIgnoreCase) ||
String.Equals(invocation.Member.ToString(), "Select", StringComparison.OrdinalIgnoreCase) ||
String.Equals(invocation.Member.ToString(), "Evaluate",StringComparison.OrdinalIgnoreCase) ||
String.Equals(invocation.Member.ToString(), "Matches",StringComparison.OrdinalIgnoreCase) ||
String.Equals(invocation.Expression.ToString(), "[System.String]",StringComparison.OrdinalIgnoreCase) ||
String.Equals(invocation.Expression.ToString(), "[String]", StringComparison.OrdinalIgnoreCase))
{
continue;
}
}
}
bool isPathValid = false;
bool isInternalURL = false;
//make sure there is no path
char[] invalidPathChars = Path.GetInvalidPathChars();
if (expressionAst.Value.IndexOfAny(invalidPathChars) < 0)
{
isPathValid = true;
}
//Check if path is UNC or begins with "http:" or "www"
if (isPathValid && ((!String.IsNullOrWhiteSpace(expressionAst.Value))) &&
(Path.IsPathRooted(expressionAst.Value) ||
expressionAst.Value.StartsWith("http:", StringComparison.CurrentCultureIgnoreCase)) ||
(expressionAst.Value.StartsWith("www", StringComparison.CurrentCultureIgnoreCase)))
{
//Exclude the case where there are only slashes in the expressions
char[] varToTrim = {'/','\\'};
string noSlash = expressionAst.Value.Trim(varToTrim);
if (!String.IsNullOrEmpty(noSlash) && noSlash.Trim().Length > 1)
{
//Check if the string contains two back or forward slashes, such as: \\scratch2\scratch or http:\\www.google.com
bool backSlash = expressionAst.Value.Contains(@"\\");
bool forwardSlash = expressionAst.Value.Contains(@"//");
string firstPartURL = "";
if (backSlash)
{
//Get the first part of the URL before the first back slash, eg: \\scratch2\scratch we check only scratch2 as the first part
string trimmedAddress =
expressionAst.Value.Substring(expressionAst.Value.IndexOf(@"\\") + 2);
if (trimmedAddress.Contains(@"\"))
{
firstPartURL = trimmedAddress.Substring(0, trimmedAddress.IndexOf(@"\"));
}
else
{
firstPartURL = trimmedAddress;
}
}
else if (forwardSlash)
{
//Get the first part of the URL before the first forward slash
string trimmedAddress =
expressionAst.Value.Substring(expressionAst.Value.IndexOf(@"//") + 2);
if (trimmedAddress.Contains(@"/"))
{
firstPartURL = trimmedAddress.Substring(0, trimmedAddress.IndexOf(@"/"));
}
else
{
firstPartURL = trimmedAddress;
}
}
else
{
if (expressionAst.Value.Contains(@"\"))
{
firstPartURL = expressionAst.Value.Substring(0, expressionAst.Value.IndexOf(@"\"));
}
else if (expressionAst.Value.Contains(@"/"))
{
firstPartURL = expressionAst.Value.Substring(0, expressionAst.Value.IndexOf(@"/"));
}
else
{
firstPartURL = expressionAst.Value;
}
}
if (!firstPartURL.Contains("."))
{
isInternalURL = true;
//Add a check to exclude potential SDDL format. Check if a string have four components separated by ":"
var count = firstPartURL.Count(x => x == ':');
if (count == 3 || count == 4 )
{
isInternalURL = false;
}
}
}
if (isInternalURL)
{
yield return
new DiagnosticRecord(
String.Format(CultureInfo.CurrentCulture, Strings.AvoidUsingInternalURLsError,
expressionAst.Value), expressionAst.Extent,
GetName(), DiagnosticSeverity.Information, fileName);
}
}
}
}
}
/// <summary>
/// GetName: Retrieves the name of this rule.
/// </summary>
/// <returns>The name of this rule</returns>
public string GetName()
{
return string.Format(CultureInfo.CurrentCulture, Strings.NameSpaceFormat, GetSourceName(), Strings.AvoidUsingInternalURLsName);
}
/// <summary>
/// GetCommonName: Retrieves the common name of this rule.
/// </summary>
/// <returns>The common name of this rule</returns>
public string GetCommonName()
{
return String.Format(CultureInfo.CurrentCulture, Strings.AvoidUsingInternalURLsCommonName);
}
/// <summary>
/// GetDescription: Retrieves the description of this rule.
/// </summary>
/// <returns>The description of this rule</returns>
public string GetDescription()
{
return string.Format(CultureInfo.CurrentCulture, Strings.AvoidUsingInternalURLsDescription);
}
/// <summary>
/// Method: Retrieves the type of the rule: builtin, managed or module.
/// </summary>
public SourceType GetSourceType()
{
return SourceType.Builtin;
}
/// <summary>
/// GetSeverity: Retrieves the severity of the rule: error, warning of information.
/// </summary>
/// <returns></returns>
public RuleSeverity GetSeverity()
{
return RuleSeverity.Information;
}
/// <summary>
/// Method: Retrieves the module/assembly name the rule is from.
/// </summary>
public string GetSourceName()
{
return string.Format(CultureInfo.CurrentCulture, Strings.SourceName);
}
}
}