Skip to content

Commit 3cdab0d

Browse files
TravisEz13TravisEz13
authored
Add Unblock-File for macOS (PowerShell#11137)
1 parent 7f564a2 commit 3cdab0d

6 files changed

Lines changed: 298 additions & 53 deletions

File tree

‎src/Microsoft.PowerShell.Commands.Utility/commands/utility/UnblockFile.cs‎

Lines changed: 65 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
11
// Copyright (c) Microsoft Corporation. All rights reserved.
22
// Licensed under the MIT License.
33

4-
#if !UNIX
5-
64
#region Using directives
75

86
using System;
97
using System.Collections.Generic;
108
using System.Collections.ObjectModel;
119
using System.ComponentModel;
10+
using System.Diagnostics;
1211
using System.Diagnostics.CodeAnalysis;
12+
using System.Globalization;
1313
using System.IO;
1414
using System.Management.Automation;
1515
using System.Management.Automation.Internal;
16+
using System.Runtime.InteropServices;
1617

1718
#endregion
1819

@@ -23,6 +24,11 @@ namespace Microsoft.PowerShell.Commands
2324
HelpUri = "https://go.microsoft.com/fwlink/?LinkID=2097033")]
2425
public sealed class UnblockFileCommand : PSCmdlet
2526
{
27+
#if UNIX
28+
private const string MacBlockAttribute = "com.apple.quarantine";
29+
private const int RemovexattrFollowSymLink = 0;
30+
#endif
31+
2632
/// <summary>
2733
/// The path of the file to unblock.
2834
/// </summary>
@@ -112,6 +118,7 @@ protected override void ProcessRecord()
112118
}
113119
}
114120
}
121+
#if !UNIX
115122

116123
// Unblock files
117124
foreach (string path in pathsToProcess)
@@ -124,10 +131,34 @@ protected override void ProcessRecord()
124131
}
125132
catch (Exception e)
126133
{
127-
WriteError(new ErrorRecord(e, "RemoveItemUnableToAccessFile", ErrorCategory.ResourceUnavailable, path));
134+
WriteError(new ErrorRecord(exception: e, errorId: "RemoveItemUnableToAccessFile", ErrorCategory.ResourceUnavailable, targetObject: path));
128135
}
129136
}
130137
}
138+
#else
139+
if (RuntimeInformation.IsOSPlatform(OSPlatform.Linux))
140+
{
141+
string errorMessage = UnblockFileStrings.LinuxNotSupported;
142+
Exception e = new PlatformNotSupportedException(errorMessage);
143+
ThrowTerminatingError(new ErrorRecord(exception: e, errorId: "LinuxNotSupported", ErrorCategory.NotImplemented, targetObject: null));
144+
return;
145+
}
146+
147+
foreach (string path in pathsToProcess)
148+
{
149+
if(IsBlocked(path))
150+
{
151+
UInt32 result = RemoveXattr(path, MacBlockAttribute, RemovexattrFollowSymLink);
152+
if(result != 0)
153+
{
154+
string errorMessage = string.Format(CultureInfo.CurrentUICulture, UnblockFileStrings.UnblockError, path);
155+
Exception e = new InvalidOperationException(errorMessage);
156+
WriteError(new ErrorRecord(exception: e, errorId: "UnblockError", ErrorCategory.InvalidResult, targetObject: path));
157+
}
158+
}
159+
}
160+
161+
#endif
131162
}
132163

133164
/// <summary>
@@ -163,6 +194,36 @@ private bool IsValidFileForUnblocking(string resolvedpath)
163194

164195
return isValidUnblockableFile;
165196
}
197+
198+
#if UNIX
199+
private bool IsBlocked(string path)
200+
{
201+
uint valueSize = 1024;
202+
IntPtr value = Marshal.AllocHGlobal((int)valueSize);
203+
try
204+
{
205+
var resultSize = GetXattr(path, MacBlockAttribute, value, valueSize, 0, RemovexattrFollowSymLink);
206+
return resultSize != -1;
207+
}
208+
finally
209+
{
210+
Marshal.FreeHGlobal(value);
211+
}
212+
}
213+
214+
// Ansi means UTF8 on Unix
215+
// https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man2/RemoveXattr.2.html
216+
[DllImport("libc", SetLastError = true, EntryPoint = "removexattr", CharSet = CharSet.Ansi)]
217+
private static extern UInt32 RemoveXattr(string path, string name, int options);
218+
219+
[DllImport("libc", EntryPoint = "getxattr", CharSet = CharSet.Ansi)]
220+
private static extern long GetXattr(
221+
[MarshalAs(UnmanagedType.LPStr)] string path,
222+
[MarshalAs(UnmanagedType.LPStr)] string name,
223+
IntPtr value,
224+
ulong size,
225+
uint position,
226+
int options);
227+
#endif
166228
}
167229
}
168-
#endif

‎src/Microsoft.PowerShell.Commands.Utility/resources/UnblockFileStrings.resx‎

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<root>
3+
<!--
4+
Microsoft ResX Schema
5+
6+
Version 2.0
7+
8+
The primary goals of this format is to allow a simple XML format
9+
that is mostly human readable. The generation and parsing of the
10+
various data types are done through the TypeConverter classes
11+
associated with the data types.
12+
13+
Example:
14+
15+
... ado.net/XML headers & schema ...
16+
<resheader name="resmimetype">text/microsoft-resx</resheader>
17+
<resheader name="version">2.0</resheader>
18+
<resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
19+
<resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
20+
<data name="Name1"><value>this is my long string</value><comment>this is a comment</comment></data>
21+
<data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>
22+
<data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">
23+
<value>[base64 mime encoded serialized .NET Framework object]</value>
24+
</data>
25+
<data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">
26+
<value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
27+
<comment>This is a comment</comment>
28+
</data>
29+
30+
There are any number of "resheader" rows that contain simple
31+
name/value pairs.
32+
33+
Each data row contains a name, and value. The row also contains a
34+
type or mimetype. Type corresponds to a .NET class that support
35+
text/value conversion through the TypeConverter architecture.
36+
Classes that don't support this are serialized and stored with the
37+
mimetype set.
38+
39+
The mimetype is used for serialized objects, and tells the
40+
ResXResourceReader how to depersist the object. This is currently not
41+
extensible. For a given mimetype the value must be set accordingly:
42+
43+
Note - application/x-microsoft.net.object.binary.base64 is the format
44+
that the ResXResourceWriter will generate, however the reader can
45+
read any of the formats listed below.
46+
47+
mimetype: application/x-microsoft.net.object.binary.base64
48+
value : The object must be serialized with
49+
: System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
50+
: and then encoded with base64 encoding.
51+
52+
mimetype: application/x-microsoft.net.object.soap.base64
53+
value : The object must be serialized with
54+
: System.Runtime.Serialization.Formatters.Soap.SoapFormatter
55+
: and then encoded with base64 encoding.
56+
57+
mimetype: application/x-microsoft.net.object.bytearray.base64
58+
value : The object must be serialized into a byte array
59+
: using a System.ComponentModel.TypeConverter
60+
: and then encoded with base64 encoding.
61+
-->
62+
<xsd:schema id="root" xmlns="" xmlns:xsd="https://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
63+
<xsd:import namespace="https://www.w3.org/XML/1998/namespace" />
64+
<xsd:element name="root" msdata:IsDataSet="true">
65+
<xsd:complexType>
66+
<xsd:choice maxOccurs="unbounded">
67+
<xsd:element name="metadata">
68+
<xsd:complexType>
69+
<xsd:sequence>
70+
<xsd:element name="value" type="xsd:string" minOccurs="0" />
71+
</xsd:sequence>
72+
<xsd:attribute name="name" use="required" type="xsd:string" />
73+
<xsd:attribute name="type" type="xsd:string" />
74+
<xsd:attribute name="mimetype" type="xsd:string" />
75+
<xsd:attribute ref="xml:space" />
76+
</xsd:complexType>
77+
</xsd:element>
78+
<xsd:element name="assembly">
79+
<xsd:complexType>
80+
<xsd:attribute name="alias" type="xsd:string" />
81+
<xsd:attribute name="name" type="xsd:string" />
82+
</xsd:complexType>
83+
</xsd:element>
84+
<xsd:element name="data">
85+
<xsd:complexType>
86+
<xsd:sequence>
87+
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
88+
<xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2" />
89+
</xsd:sequence>
90+
<xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1" />
91+
<xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3" />
92+
<xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4" />
93+
<xsd:attribute ref="xml:space" />
94+
</xsd:complexType>
95+
</xsd:element>
96+
<xsd:element name="resheader">
97+
<xsd:complexType>
98+
<xsd:sequence>
99+
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
100+
</xsd:sequence>
101+
<xsd:attribute name="name" type="xsd:string" use="required" />
102+
</xsd:complexType>
103+
</xsd:element>
104+
</xsd:choice>
105+
</xsd:complexType>
106+
</xsd:element>
107+
</xsd:schema>
108+
<resheader name="resmimetype">
109+
<value>text/microsoft-resx</value>
110+
</resheader>
111+
<resheader name="version">
112+
<value>2.0</value>
113+
</resheader>
114+
<resheader name="reader">
115+
<value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
116+
</resheader>
117+
<resheader name="writer">
118+
<value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
119+
</resheader>
120+
<data name="LinuxNotSupported" xml:space="preserve">
121+
<value>The cmdlet does not support Linux.</value>
122+
</data>
123+
<data name="UnblockError" xml:space="preserve">
124+
<value>There was an error unblocking {0}.</value>
125+
</data>
126+
</root>

‎src/Modules/Unix/Microsoft.PowerShell.Utility/Microsoft.PowerShell.Utility.psd1‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ CmdletsToExport = @(
2525
'Get-TraceSource', 'Set-TraceSource', 'Add-Type', 'Get-TypeData', 'Remove-TypeData', 'Update-TypeData',
2626
'Get-UICulture', 'Get-Unique', 'Get-Uptime', 'Clear-Variable', 'Get-Variable', 'New-Variable',
2727
'Remove-Variable', 'Set-Variable', 'Get-Verb', 'Write-Verbose', 'Write-Warning', 'Invoke-WebRequest',
28-
'Format-Wide', 'ConvertTo-Xml', 'Select-Xml', 'Get-Error', 'Update-List'
28+
'Format-Wide', 'ConvertTo-Xml', 'Select-Xml', 'Get-Error', 'Update-List', 'Unblock-File'
2929
)
3030
FunctionsToExport = @()
3131
AliasesToExport = @('fhx')

0 commit comments

Comments
 (0)