File size: 4,628 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 | // Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
#nullable enable
using System.Security.AccessControl;
namespace System.Management.Automation.Provider
{
#region ISecurityDescriptorCmdletProvider
/// <summary>
/// Provides an interface that allows simplified interaction
/// with namespaces that support security descriptors. The methods
/// on this interface allow a common set of commands to manage the security
/// on any namespace that supports this interface.
/// This interface should only be implemented on derived classes of
/// <see cref="CmdletProvider"/>, <see cref="ItemCmdletProvider"/>,
/// <see cref="ContainerCmdletProvider"/>, or <see cref="NavigationCmdletProvider"/>.
/// </summary>
/// <remarks>
/// A namespace provider should implement this interface if items in the
/// namespace are protected by Security Descriptors.
/// </remarks>
public interface ISecurityDescriptorCmdletProvider
{
/// <summary>
/// Gets the security descriptor for the item at the specified path.
/// </summary>
/// <param name="path">
/// The path of the item to from which to retrieve the security descriptor.
/// </param>
/// <param name="includeSections">
/// The sections of the security descriptor to retrieve, if your provider
/// supports them.
/// </param>
/// <returns>
/// Nothing. Write the security descriptor to the context's pipeline for
/// the item specified by the path using the WriteSecurityDescriptorObject
/// method.
/// </returns>
void GetSecurityDescriptor(
string path,
AccessControlSections includeSections);
/// <summary>
/// Sets the security descriptor for the item at the specified path.
/// </summary>
/// <param name="path">
/// The path of the item to for which to set the security descriptor.
/// </param>
/// <param name="securityDescriptor">
/// The new security descriptor for the item. This should replace the
/// previously existing security descriptor.
/// </param>
/// <returns>
/// Nothing. After setting the security descriptor to the value passed in,
/// write the new security descriptor to the context's pipeline for the
/// item specified by the path using the WriteSecurityDescriptorObject method.
/// </returns>
void SetSecurityDescriptor(
string path,
ObjectSecurity securityDescriptor);
/// <summary>
/// Creates a new empty security descriptor of the same type as
/// the item specified by the path. For example, if "path" points
/// to a file system directory, the descriptor returned will be
/// of type DirectorySecurity.
/// </summary>
/// <param name="path">
/// Path of the item to use to determine the type of resulting
/// SecurityDescriptor.
/// </param>
/// <param name="includeSections">
/// The sections of the security descriptor to create.
/// </param>
/// <returns>
/// A new ObjectSecurity object of the same type as
/// the item specified by the path.
/// </returns>
ObjectSecurity NewSecurityDescriptorFromPath(
string path,
AccessControlSections includeSections);
/// <summary>
/// Creates a new empty security descriptor of the specified type.
/// This method is used as a convenience function for consumers of
/// your provider.
/// </summary>
/// <param name="type">
/// The type of Security Descriptor to create. Your provider should
/// understand a string representation for each of the types of
/// SecurityDescriptors that it supports. For example, the File System
/// provider performs a case-insensitive comparison against "file" for a
/// FileSecurity descriptor, and "directory" or "container" for a
/// DirectorySecurity descriptor.
/// </param>
/// <param name="includeSections">
/// The sections of the security descriptor to create.
/// </param>
/// <returns>
/// A new ObjectSecurity object of the specified type.
/// </returns>
ObjectSecurity NewSecurityDescriptorOfType(
string type,
AccessControlSections includeSections);
}
#endregion ISecurityDescriptorCmdletProvider
}
|