Skip to content

Commit 4c3466c

Browse files
raghushantharaghushantha
committed
Merge pull request #405 from PowerShell/development
Merge Branches
2 parents 71f7791 + 51f9d93 commit 4c3466c

File tree

79 files changed

+3218
-710
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

79 files changed

+3218
-710
lines changed

‎CHANGELOG.MD‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,40 @@
1+
## Released v1.2.0 (Dec.17, 2015)
2+
###Features:
3+
- Support for consuming PowerShell content as streams (-ScriptDefinition)
4+
- ScriptAnalyzer accepts configuration (settings) in the form of a hashtable (-Settings), added sample Settings
5+
- Ability to run default ruleset along with custom ones in the same invocation (-IncludeDefaultRules)
6+
- Recurse Custom Rule Paths (-RecurseCustomRulePath)
7+
- Consistent Engine error handling when working with Settings, Default and Custom Rules
8+
9+
###Rules:
10+
- Rule to detect the presence of default value for Mandatory parameters (AvoidDefaultValueForMandatoryParameter)
11+
12+
###Fixes:
13+
####Engine:
14+
- Engine update to prevent script based injection attacks
15+
- CustomizedRulePath is now called CustomRulePath – Fixes to handle folder paths
16+
- Fixes for RecurseCustomRulePath functionality
17+
- Fix to binplace cmdlet help file as part of build process
18+
- ScriptAnalyzer Profile is now called Settings
19+
- Fix to emit filename in the diagnosticrecord when using Script based custom rules
20+
- Fix to prevent Engine from calling Update-Help for script based custom rules
21+
- Added additional pester tests to take care of test holes in Custom Rule feature
22+
- Post-build error handling improvements, fixed typos in the project
23+
24+
####Rules:
25+
- Fixed bug in Positional parameter rule to trigger only when used with > 3 positional parameters
26+
- Updated keywords that trigger PSAvoidUsingPlainTextForPassword rule
27+
- Updated ProvideDefaultParameterValue rule to AvoidDefaultValueForMandatoryParameter rule
28+
- Deprecate Internal Url rule based on community feedback, identified additional rules to handle hardcoded paths etc
29+
- Added localhost exceptions for HardCodedComputerName Rule
30+
- Update to Credential based rules to validate the presence of CredentialAttribute and PSCredential type
31+
32+
###Documentation:
33+
- Rule & Cmdlet documentation updates – Cmdlet help file addition
34+
35+
36+
##
37+
138
## Released v1.1.1 (Nov.3, 2015)
239
###Features:
340
- Support for PSDrives when using Invoke-ScriptAnalyzer

‎Rules/AvoidUsingInternalURLs.cs‎ renamed to ‎DeprecatedRules/AvoidUsingInternalURLs.cs‎

File renamed without changes.

‎Engine/Commands/GetScriptAnalyzerRuleCommand.cs‎

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,25 @@ public class GetScriptAnalyzerRuleCommand : PSCmdlet, IOutputWriter
3333
[Parameter(Mandatory = false)]
3434
[ValidateNotNullOrEmpty]
3535
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
36-
public string[] CustomizedRulePath
36+
[Alias("CustomizedRulePath")]
37+
public string[] CustomRulePath
3738
{
38-
get { return customizedRulePath; }
39-
set { customizedRulePath = value; }
39+
get { return customRulePath; }
40+
set { customRulePath = value; }
4041
}
41-
private string[] customizedRulePath;
42+
private string[] customRulePath;
43+
44+
/// <summary>
45+
/// RecurseCustomRulePath: Find rules within subfolders under the path
46+
/// </summary>
47+
[Parameter(Mandatory = false)]
48+
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
49+
public SwitchParameter RecurseCustomRulePath
50+
{
51+
get { return recurseCustomRulePath; }
52+
set { recurseCustomRulePath = value; }
53+
}
54+
private bool recurseCustomRulePath;
4255

4356
/// <summary>
4457
/// Name: The name of a specific rule to list.
@@ -76,7 +89,9 @@ public string[] Severity
7689
/// </summary>
7790
protected override void BeginProcessing()
7891
{
79-
ScriptAnalyzer.Instance.Initialize(this, customizedRulePath);
92+
string[] rulePaths = Helper.ProcessCustomRulePaths(customRulePath,
93+
this.SessionState, recurseCustomRulePath);
94+
ScriptAnalyzer.Instance.Initialize(this, rulePaths, null, null, null, null == rulePaths ? true : false);
8095
}
8196

8297
/// <summary>

‎Engine/Commands/InvokeScriptAnalyzerCommand.cs‎

Lines changed: 111 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -31,14 +31,19 @@ namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.Commands
3131
/// <summary>
3232
/// InvokeScriptAnalyzerCommand: Cmdlet to statically check PowerShell scripts.
3333
/// </summary>
34-
[Cmdlet(VerbsLifecycle.Invoke, "ScriptAnalyzer", HelpUri = "http://go.microsoft.com/fwlink/?LinkId=525914")]
34+
[Cmdlet(VerbsLifecycle.Invoke,
35+
"ScriptAnalyzer",
36+
DefaultParameterSetName="File",
37+
HelpUri = "http://go.microsoft.com/fwlink/?LinkId=525914")]
3538
public class InvokeScriptAnalyzerCommand : PSCmdlet, IOutputWriter
3639
{
3740
#region Parameters
3841
/// <summary>
3942
/// Path: The path to the file or folder to invoke PSScriptAnalyzer on.
4043
/// </summary>
41-
[Parameter(Position = 0, Mandatory = true)]
44+
[Parameter(Position = 0,
45+
ParameterSetName = "File",
46+
Mandatory = true)]
4247
[ValidateNotNull]
4348
[Alias("PSPath")]
4449
public string Path
@@ -48,18 +53,57 @@ public string Path
4853
}
4954
private string path;
5055

56+
/// <summary>
57+
/// ScriptDefinition: a script definition in the form of a string to run rules on.
58+
/// </summary>
59+
[Parameter(Position = 0,
60+
ParameterSetName = "ScriptDefinition",
61+
Mandatory = true)]
62+
[ValidateNotNull]
63+
public string ScriptDefinition
64+
{
65+
get { return scriptDefinition; }
66+
set { scriptDefinition = value; }
67+
}
68+
private string scriptDefinition;
69+
5170
/// <summary>
5271
/// CustomRulePath: The path to the file containing custom rules to run.
5372
/// </summary>
5473
[Parameter(Mandatory = false)]
5574
[ValidateNotNull]
5675
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
57-
public string[] CustomizedRulePath
76+
[Alias("CustomizedRulePath")]
77+
public string[] CustomRulePath
78+
{
79+
get { return customRulePath; }
80+
set { customRulePath = value; }
81+
}
82+
private string[] customRulePath;
83+
84+
/// <summary>
85+
/// RecurseCustomRulePath: Find rules within subfolders under the path
86+
/// </summary>
87+
[Parameter(Mandatory = false)]
88+
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
89+
public SwitchParameter RecurseCustomRulePath
5890
{
59-
get { return customizedRulePath; }
60-
set { customizedRulePath = value; }
91+
get { return recurseCustomRulePath; }
92+
set { recurseCustomRulePath = value; }
6193
}
62-
private string[] customizedRulePath;
94+
private bool recurseCustomRulePath;
95+
96+
/// <summary>
97+
/// IncludeDefaultRules: Invoke default rules along with Custom rules
98+
/// </summary>
99+
[Parameter(Mandatory = false)]
100+
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
101+
public SwitchParameter IncludeDefaultRules
102+
{
103+
get { return includeDefaultRules; }
104+
set { includeDefaultRules = value; }
105+
}
106+
private bool includeDefaultRules;
63107

64108
/// <summary>
65109
/// ExcludeRule: Array of names of rules to be disabled.
@@ -125,16 +169,20 @@ public SwitchParameter SuppressedOnly
125169
private bool suppressedOnly;
126170

127171
/// <summary>
128-
/// Returns path to the file that contains user profile for ScriptAnalyzer
172+
/// Returns path to the file that contains user profile or hash table for ScriptAnalyzer
129173
/// </summary>
174+
[Alias("Profile")]
130175
[Parameter(Mandatory = false)]
131176
[ValidateNotNull]
132-
public string Profile
177+
public object Settings
133178
{
134-
get { return profile; }
135-
set { profile = value; }
179+
get { return settings; }
180+
set { settings = value; }
136181
}
137-
private string profile;
182+
183+
private object settings;
184+
185+
private bool stopProcessing;
138186

139187
#endregion Parameters
140188

@@ -145,37 +193,79 @@ public string Profile
145193
/// </summary>
146194
protected override void BeginProcessing()
147195
{
196+
string[] rulePaths = Helper.ProcessCustomRulePaths(customRulePath,
197+
this.SessionState, recurseCustomRulePath);
198+
199+
if (!ScriptAnalyzer.Instance.ParseProfile(this.settings, this.SessionState.Path, this))
200+
{
201+
stopProcessing = true;
202+
return;
203+
}
204+
148205
ScriptAnalyzer.Instance.Initialize(
149206
this,
150-
customizedRulePath,
207+
rulePaths,
151208
this.includeRule,
152209
this.excludeRule,
153210
this.severity,
154-
this.suppressedOnly,
155-
this.profile);
211+
null == rulePaths ? true : this.includeDefaultRules,
212+
this.suppressedOnly);
156213
}
157214

158215
/// <summary>
159216
/// Analyzes the given script/directory.
160217
/// </summary>
161218
protected override void ProcessRecord()
162219
{
163-
// throws Item Not Found Exception
164-
Collection<PathInfo> paths = this.SessionState.Path.GetResolvedPSPathFromPSPath(path);
165-
foreach (PathInfo p in paths)
220+
if (stopProcessing)
221+
{
222+
stopProcessing = false;
223+
return;
224+
}
225+
226+
if (String.Equals(this.ParameterSetName, "File", StringComparison.OrdinalIgnoreCase))
227+
{
228+
// throws Item Not Found Exception
229+
Collection<PathInfo> paths = this.SessionState.Path.GetResolvedPSPathFromPSPath(path);
230+
foreach (PathInfo p in paths)
231+
{
232+
ProcessPathOrScriptDefinition(this.SessionState.Path.GetUnresolvedProviderPathFromPSPath(p.Path));
233+
}
234+
}
235+
else if (String.Equals(this.ParameterSetName, "ScriptDefinition", StringComparison.OrdinalIgnoreCase))
166236
{
167-
ProcessPath(this.SessionState.Path.GetUnresolvedProviderPathFromPSPath(p.Path));
237+
ProcessPathOrScriptDefinition(scriptDefinition);
168238
}
169239
}
170240

241+
protected override void EndProcessing()
242+
{
243+
ScriptAnalyzer.Instance.CleanUp();
244+
base.EndProcessing();
245+
}
246+
247+
protected override void StopProcessing()
248+
{
249+
ScriptAnalyzer.Instance.CleanUp();
250+
base.StopProcessing();
251+
}
252+
171253
#endregion
172254

173255
#region Methods
174256

175-
private void ProcessPath(string path)
257+
private void ProcessPathOrScriptDefinition(string pathOrScriptDefinition)
176258
{
177-
IEnumerable<DiagnosticRecord> diagnosticsList =
178-
ScriptAnalyzer.Instance.AnalyzePath(path, this.recurse);
259+
IEnumerable<DiagnosticRecord> diagnosticsList = Enumerable.Empty<DiagnosticRecord>();
260+
261+
if (String.Equals(this.ParameterSetName, "File", StringComparison.OrdinalIgnoreCase))
262+
{
263+
diagnosticsList = ScriptAnalyzer.Instance.AnalyzePath(pathOrScriptDefinition, this.recurse);
264+
}
265+
else if (String.Equals(this.ParameterSetName, "ScriptDefinition", StringComparison.OrdinalIgnoreCase))
266+
{
267+
diagnosticsList = ScriptAnalyzer.Instance.AnalyzeScriptDefinition(pathOrScriptDefinition);
268+
}
179269

180270
//Output through loggers
181271
foreach (ILogger logger in ScriptAnalyzer.Instance.Loggers)

‎Engine/Configurations/CmdletDesign.psd1‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
@{
2+
IncludeRules=@('PSUseApprovedVerbs',
3+
'PSReservedCmdletChar',
4+
'PSReservedParams',
5+
'PSShouldProcess',
6+
'PSUseShouldProcessForStateChangingFunctions',
7+
'PSUseSingularNouns',
8+
'PSMissingModuleManifestField',
9+
'PSAvoidDefaultValueSwitchParameter')
10+
}

‎Engine/Configurations/DSC.psd1‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
@{
2+
IncludeRules=@('PSDSC*')
3+
}

‎Engine/Configurations/ScriptFunctions.psd1‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
@{
2+
IncludeRules=@('PSAvoidUsingCmdletAliases',
3+
'PSAvoidUsingWMICmdlet',
4+
'PSAvoidUsingEmptyCatchBlock',
5+
'PSUseCmdletCorrectly',
6+
'PSUseShouldProcessForStateChangingFunctions',
7+
'PSAvoidUsingPositionalParameters',
8+
'PSAvoidGlobalVars',
9+
'PSUseDeclaredVarsMoreThanAssignments',
10+
'PSAvoidUsingInvokeExpression')
11+
}

‎Engine/Configurations/ScriptSecurity.psd1‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
@{
2+
IncludeRules=@('PSAvoidUsingPlainTextForPassword',
3+
'PSAvoidUsingComputerNameHardcoded',
4+
'PSAvoidUsingConvertToSecureStringWithPlainText',
5+
'PSUsePSCredentialType',
6+
'PSAvoidUsingUserNameAndPasswordParams',
7+
'PSAvoidUsingFilePath')
8+
}

‎Engine/Configurations/ScriptingStyle.psd1‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
@{
2+
IncludeRules=@('PSProvideCommentHelp',
3+
'PSAvoidUsingWriteHost')
4+
}

‎Engine/Generic/AvoidCmdletGeneric.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic
2424
public abstract class AvoidCmdletGeneric : IScriptRule
2525
{
2626
/// <summary>
27-
/// AnalyzeScript: Analyzes the given Ast and returns DiagnosticRecords based on the anaylsis.
27+
/// AnalyzeScript: Analyzes the given Ast and returns DiagnosticRecords based on the analysis.
2828
/// </summary>
2929
/// <param name="ast">The script's ast</param>
3030
/// <param name="fileName">The name of the script file being analyzed</param>
@@ -38,7 +38,7 @@ public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName)
3838

3939
List<String> cmdletNameAndAliases = Microsoft.Windows.PowerShell.ScriptAnalyzer.Helper.Instance.CmdletNameAndAliases(GetCmdletName());
4040

41-
// Iterrates all CommandAsts and check the command name.
41+
// Iterates all CommandAsts and check the command name.
4242
foreach (CommandAst cmdAst in commandAsts)
4343
{
4444
if (cmdAst.GetCommandName() == null) continue;

0 commit comments

Comments
 (0)