forked from dotnet/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathSecurityUtilities.xml
223 lines (214 loc) · 13.7 KB
/
SecurityUtilities.xml
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
<Type Name="SecurityUtilities" FullName="Microsoft.Build.Tasks.Deployment.ManifestUtilities.SecurityUtilities">
<TypeSignature Language="C#" Value="public static class SecurityUtilities" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit SecurityUtilities extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Build.Tasks.Deployment.ManifestUtilities.SecurityUtilities" />
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Tasks.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.ComVisible(false)</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Provides a set of utility functions for manipulating security permision sets and signing.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="ComputeZonePermissionSet">
<MemberSignature Language="C#" Value="public static System.Security.PermissionSet ComputeZonePermissionSet (string targetZone, System.Security.PermissionSet includedPermissionSet, string[] excludedPermissions);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Security.PermissionSet ComputeZonePermissionSet(string targetZone, class System.Security.PermissionSet includedPermissionSet, string[] excludedPermissions) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.Tasks.Deployment.ManifestUtilities.SecurityUtilities.ComputeZonePermissionSet(System.String,System.Security.PermissionSet,System.String[])" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Tasks.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Security.PermissionSet</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="targetZone" Type="System.String" />
<Parameter Name="includedPermissionSet" Type="System.Security.PermissionSet" />
<Parameter Name="excludedPermissions" Type="System.String[]" />
</Parameters>
<Docs>
<param name="targetZone">Specifies a zone default permission set, which is obtained from machine policy. Valid values are <see langword="Internet" />, <see langword="LocalIntranet" />, or <see langword="Custom" />. If <see langword="Custom" /> is specified, the generated permission set is based only on the <c>includedPermissionSet</c> parameter.</param>
<param name="includedPermissionSet">A <see cref="P:Microsoft.Build.Tasks.Deployment.ManifestUtilities.TrustInfo.PermissionSet" /> object containing the set of permissions to be explicitly included in the generated permission set. Permissions specified in this parameter will be included verbatim in the generated permission set, regardless of <c>targetZone</c> or <c>excludedPermissions</c> parameters.</param>
<param name="excludedPermissions">An array of permission identity strings to be excluded from the zone default permission set. Permission identity strings can be computed using the <see cref="M:Microsoft.Build.Tasks.Deployment.ManifestUtilities.SecurityUtilities.PermissionSetToIdentityList(System.Security.PermissionSet)" /> method. This parameter is ignored if <c>targetZone</c> is not <see langword="Internet" /> or <see langword="LocalIntranet" />.</param>
<summary>Generates a permission set by computing the zone default permission set, removing any excluded permissions, and adding any included permissions.</summary>
<returns>Returns the generated permission set.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IdentityListToPermissionSet">
<MemberSignature Language="C#" Value="public static System.Security.PermissionSet IdentityListToPermissionSet (string[] ids);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Security.PermissionSet IdentityListToPermissionSet(string[] ids) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.Tasks.Deployment.ManifestUtilities.SecurityUtilities.IdentityListToPermissionSet(System.String[])" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Tasks.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Security.PermissionSet</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="ids" Type="System.String[]" />
</Parameters>
<Docs>
<param name="ids">An array of permission identity strings.</param>
<summary>Converts an array of permission identity strings to a permission set object.</summary>
<returns>Returns the converted permission set.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PermissionSetToIdentityList">
<MemberSignature Language="C#" Value="public static string[] PermissionSetToIdentityList (System.Security.PermissionSet permissionSet);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig string[] PermissionSetToIdentityList(class System.Security.PermissionSet permissionSet) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.Tasks.Deployment.ManifestUtilities.SecurityUtilities.PermissionSetToIdentityList(System.Security.PermissionSet)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Tasks.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String[]</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="permissionSet" Type="System.Security.PermissionSet" />
</Parameters>
<Docs>
<param name="permissionSet">The input permission set to be converted.</param>
<summary>Converts a permission set object to an array of permission identity strings.</summary>
<returns>Returns an array of permission identity strings.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SignFile">
<MemberSignature Language="C#" Value="public static void SignFile (System.Security.Cryptography.X509Certificates.X509Certificate2 cert, Uri timestampUrl, string path);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void SignFile(class System.Security.Cryptography.X509Certificates.X509Certificate2 cert, class System.Uri timestampUrl, string path) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.Tasks.Deployment.ManifestUtilities.SecurityUtilities.SignFile(System.Security.Cryptography.X509Certificates.X509Certificate2,System.Uri,System.String)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Tasks.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cert" Type="System.Security.Cryptography.X509Certificates.X509Certificate2" />
<Parameter Name="timestampUrl" Type="System.Uri" />
<Parameter Name="path" Type="System.String" />
</Parameters>
<Docs>
<param name="cert">The certificate to be used to sign the file.</param>
<param name="timestampUrl">Indicates that the file is to be timestamped by the timestamp server at the specified HTTP address. This parameter can be NULL if you do not want a timestamp.</param>
<param name="path">The name of the file to sign.</param>
<summary>Signs a ClickOnce manifest or PE file.</summary>
<remarks>
<format type="text/markdown"><] to be installed.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="SignFile">
<MemberSignature Language="C#" Value="public static void SignFile (string certThumbprint, Uri timestampUrl, string path);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void SignFile(string certThumbprint, class System.Uri timestampUrl, string path) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.Tasks.Deployment.ManifestUtilities.SecurityUtilities.SignFile(System.String,System.Uri,System.String)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Tasks.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="certThumbprint" Type="System.String" />
<Parameter Name="timestampUrl" Type="System.Uri" />
<Parameter Name="path" Type="System.String" />
</Parameters>
<Docs>
<param name="certThumbprint">Specifies the thumbprint, which is the SHA1 hash of the signing certificate, which is kept in your personal certificate store.</param>
<param name="timestampUrl">Indicates that the file is to be timestamped by the timestamp server at the specified HTTP address. This parameter can be NULL if you do not want a timestamp.</param>
<param name="path">The name of the file to sign.</param>
<summary>Signs a ClickOnce manifest or PE file.</summary>
<remarks>
<format type="text/markdown"><] to be installed.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="SignFile">
<MemberSignature Language="C#" Value="public static void SignFile (string certPath, System.Security.SecureString certPassword, Uri timestampUrl, string path);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void SignFile(string certPath, class System.Security.SecureString certPassword, class System.Uri timestampUrl, string path) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.Tasks.Deployment.ManifestUtilities.SecurityUtilities.SignFile(System.String,System.Security.SecureString,System.Uri,System.String)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Tasks.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="certPath" Type="System.String" />
<Parameter Name="certPassword" Type="System.Security.SecureString" />
<Parameter Name="timestampUrl" Type="System.Uri" />
<Parameter Name="path" Type="System.String" />
</Parameters>
<Docs>
<param name="certPath">The certificate to be used to sign the file. The certificate must contain a private key. The <see langword="KeyUsage" /> extension is optional, but if it is present, <see langword="DigitalSignature" /> must be set to <see langword="True" />. The <see langword="EnhancedKeyUsage" /> extension is also optional, but if it is present, the certificate must contain object identifier (OID) support.</param>
<param name="certPassword">The certificate password.</param>
<param name="timestampUrl">Indicates that the file is to be timestamped by the timestamp server at the specified HTTP address. This parameter can be NULL if you do not want a timestamp.</param>
<param name="path">The name of the file to sign.</param>
<summary>Signs a ClickOnce manifest.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This function is only for signing a manifest, not a PE file.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="XmlToPermissionSet">
<MemberSignature Language="C#" Value="public static System.Security.PermissionSet XmlToPermissionSet (System.Xml.XmlElement element);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Security.PermissionSet XmlToPermissionSet(class System.Xml.XmlElement element) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.Tasks.Deployment.ManifestUtilities.SecurityUtilities.XmlToPermissionSet(System.Xml.XmlElement)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Tasks.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Security.PermissionSet</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="element" Type="System.Xml.XmlElement" />
</Parameters>
<Docs>
<param name="element">An XML representation of the permission set.</param>
<summary>Converts an XML element to a permission set object.</summary>
<returns>The converted permission set object.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Converts an <xref:System.Xml.XmlElement> object to a <xref:System.Security.PermissionSet> object.
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>