File size: 9,599 Bytes
8c763fb | 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 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 | // Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System;
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.Management.Automation;
using System.Management.Automation.Security;
//
// Now define the set of commands for manipulating modules.
//
namespace Microsoft.PowerShell.Commands
{
#region New-Module
/// <summary>
/// Implements a cmdlet that creates a dynamic module from a scriptblock..
/// </summary>
[Cmdlet(VerbsCommon.New, "Module", DefaultParameterSetName = "ScriptBlock", HelpUri = "https://go.microsoft.com/fwlink/?LinkID=2096698")]
[OutputType(typeof(PSModuleInfo))]
public sealed class NewModuleCommand : ModuleCmdletBase
{
/// <summary>
/// This parameter specifies the name to assign to the dynamic module.
/// </summary>
[Parameter(ParameterSetName = "Name", Mandatory = true, ValueFromPipeline = true, Position = 0)]
public string Name
{
get { return _name; }
set { _name = value; }
}
private string _name;
/// <summary>
/// Specify a scriptblock to use for the module body...
/// </summary>
[Parameter(ParameterSetName = "Name", Mandatory = true, Position = 1)]
[Parameter(ParameterSetName = "ScriptBlock", Mandatory = true, Position = 0)]
[ValidateNotNull]
public ScriptBlock ScriptBlock
{
get
{
return _scriptBlock;
}
set
{
_scriptBlock = value;
}
}
private ScriptBlock _scriptBlock;
/// <summary>
/// This parameter specifies the patterns matching the functions to import from the module...
/// </summary>
[Parameter]
[ValidateNotNull]
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays", Justification = "Cmdlets use arrays for parameters.")]
public string[] Function
{
get
{
return _functionImportList;
}
set
{
if (value == null)
return;
_functionImportList = value;
// Create the list of patterns to match at parameter bind time
// so errors will be reported before loading the module...
BaseFunctionPatterns = new List<WildcardPattern>();
foreach (string pattern in _functionImportList)
{
BaseFunctionPatterns.Add(WildcardPattern.Get(pattern, WildcardOptions.IgnoreCase));
}
}
}
private string[] _functionImportList = Array.Empty<string>();
/// <summary>
/// This parameter specifies the patterns matching the cmdlets to import from the module...
/// </summary>
[Parameter]
[ValidateNotNull]
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays", Justification = "Cmdlets use arrays for parameters.")]
public string[] Cmdlet
{
get
{
return _cmdletImportList;
}
set
{
if (value == null)
return;
_cmdletImportList = value;
// Create the list of patterns to match at parameter bind time
// so errors will be reported before loading the module...
BaseCmdletPatterns = new List<WildcardPattern>();
foreach (string pattern in _cmdletImportList)
{
BaseCmdletPatterns.Add(WildcardPattern.Get(pattern, WildcardOptions.IgnoreCase));
}
}
}
private string[] _cmdletImportList = Array.Empty<string>();
/// <summary>
/// This parameter causes the session state instance to be written...
/// </summary>
[Parameter]
public SwitchParameter ReturnResult
{
get { return (SwitchParameter)_returnResult; }
set { _returnResult = value; }
}
private bool _returnResult;
/// <summary>
/// This parameter causes the session state instance to be written...
/// </summary>
[Parameter]
public SwitchParameter AsCustomObject
{
get { return (SwitchParameter)_asCustomObject; }
set { _asCustomObject = value; }
}
private bool _asCustomObject;
/// <summary>
/// The arguments to pass to the scriptblock used to create the module.
/// </summary>
[Parameter(ValueFromRemainingArguments = true)]
[Alias("Args")]
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays", Justification = "Cmdlets use arrays for parameters.")]
public object[] ArgumentList
{
get { return _arguments; }
set { _arguments = value; }
}
private object[] _arguments;
/// <summary>
/// Create the new module...
/// </summary>
protected override void EndProcessing()
{
// Create a module from a scriptblock...
if (_scriptBlock != null)
{
// Check ScriptBlock language mode. If it is different than the context language mode
// then throw error since private trusted script functions may be exposed.
if (Context.LanguageMode == PSLanguageMode.ConstrainedLanguage && _scriptBlock.LanguageMode == PSLanguageMode.FullLanguage)
{
if (SystemPolicy.GetSystemLockdownPolicy() != SystemEnforcementMode.Audit)
{
this.ThrowTerminatingError(
new ErrorRecord(
new PSSecurityException(Modules.CannotCreateModuleWithScriptBlock),
"Modules_CannotCreateModuleWithFullLanguageScriptBlock",
ErrorCategory.SecurityError,
targetObject: null));
}
SystemPolicy.LogWDACAuditMessage(
context: Context,
title: Modules.WDACNewModuleCommandLogTitle,
message: Modules.WDACNewModuleCommandLogMessage,
fqid: "NewModuleCmdletWitFullLanguageScriptblockNotAllowed",
dropIntoDebugger: true);
}
string gs = System.Guid.NewGuid().ToString();
if (string.IsNullOrEmpty(_name))
{
_name = PSModuleInfo.DynamicModulePrefixString + gs;
}
try
{
Context.Modules.IncrementModuleNestingDepth(this, _name);
List<object> results = null;
PSModuleInfo localModule = null;
try
{
// The path for a "dynamic" module will be a GUID so it's unique.
localModule = Context.Modules.CreateModule(_name, gs, _scriptBlock, null, out results, _arguments);
// Export all functions and variables if no exports were specified...
if (!localModule.SessionState.Internal.UseExportList)
{
List<WildcardPattern> cmdletPatterns = BaseCmdletPatterns ?? MatchAll;
List<WildcardPattern> functionPatterns = BaseFunctionPatterns ?? MatchAll;
ModuleIntrinsics.ExportModuleMembers(this,
localModule.SessionState.Internal,
functionPatterns, cmdletPatterns, BaseAliasPatterns, BaseVariablePatterns, null);
}
}
catch (RuntimeException e)
{
// Preserve the inner module invocation info...
e.ErrorRecord.PreserveInvocationInfoOnce = true;
WriteError(e.ErrorRecord);
}
// If the module was created successfully, then process the result...
if (localModule != null)
{
if (_returnResult)
{
// import the specified members...
ImportModuleMembers(localModule, string.Empty /* no -Prefix for New-Module cmdlet */);
WriteObject(results, true);
}
else if (_asCustomObject)
{
WriteObject(localModule.AsCustomObject());
}
else
{
// import the specified members...
ImportModuleMembers(localModule, string.Empty /* no -Prefix for New-Module cmdlet */);
WriteObject(localModule);
}
}
}
finally
{
Context.Modules.DecrementModuleNestingCount();
}
return;
}
}
}
#endregion
}
|