Export (0) Print
Expand All

SecurityElement Class

Represents the XML object model for encoding security objects. This class cannot be inherited.

System.Object
  System.Security.SecurityElement

Namespace:  System.Security
Assembly:  mscorlib (in mscorlib.dll)

'Declaration
<SerializableAttribute> _
<ComVisibleAttribute(True)> _
Public NotInheritable Class SecurityElement

The SecurityElement type exposes the following members.

  NameDescription
Public methodSecurityElement(String)Initializes a new instance of the SecurityElement class with the specified tag.
Public methodSecurityElement(String, String)Initializes a new instance of the SecurityElement class with the specified tag and text.
Top

  NameDescription
Public propertyAttributesGets or sets the attributes of an XML element as name/value pairs.
Public propertyChildrenGets or sets the array of child elements of the XML element.
Public propertyTagGets or sets the tag name of an XML element.
Public propertyTextGets or sets the text within an XML element.
Top

  NameDescription
Public methodAddAttributeAdds a name/value attribute to an XML element.
Public methodAddChildAdds a child element to the XML element.
Public methodAttributeFinds an attribute by name in an XML element.
Public methodCopyCreates and returns an identical copy of the current SecurityElement object.
Public methodEqualCompares two XML element objects for equality.
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodStatic memberEscapeReplaces invalid XML characters in a string with their valid XML equivalent.
Public methodStatic memberFromStringCreates a security element from an XML-encoded string.
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodStatic memberIsValidAttributeNameDetermines whether a string is a valid attribute name.
Public methodStatic memberIsValidAttributeValueDetermines whether a string is a valid attribute value.
Public methodStatic memberIsValidTagDetermines whether a string is a valid tag.
Public methodStatic memberIsValidTextDetermines whether a string is valid as text within an XML element.
Public methodSearchForChildByTagFinds a child by its tag name.
Public methodSearchForTextOfTagFinds a child by its tag name and returns the contained text.
Public methodToStringProduces a string representation of an XML element and its constituent attributes, child elements, and text. (Overrides Object.ToString.)
Top

This class is intended to be a lightweight implementation of a simple XML object model for use within the security system, and not for use as a general XML object model. This documentation assumes a basic knowledge of XML.

The simple XML object model for an element consists of the following parts:

  • The tag is the element name.

  • The attributes are zero or more name/value attribute pairs on the element.

  • The children are zero or more elements nested within <tag> and </tag>.

It is strongly suggested that attribute based XML representation is used to express security elements and their values. This means properties of an element are expressed as attributes and property values are expressed as attribute values. Avoid nesting text within tags. For any <tag>text</tag> representation a representation of type <tag value="text"/> is usually available. Using this attribute-based XML representation increases readability and allows easy WMI portability of the resulting XML serialization.

An attribute name must be one character or longer, and cannot be Nothing. If element-based value representation is used, elements with a text string that is Nothing are represented in the <tag/> form; otherwise, text is delimited by the <tag> and </tag> tokens. Both forms can be combined with attributes, which are shown if present.

The tags, attributes, and text of elements, if present, are always case-sensitive. The XML form contains quotations and escapes where necessary. String values that include characters invalid for use in XML result in an ArgumentException. These rules apply to all properties and methods.

NoteNote

For performance reasons, character validity is only checked when the element is encoded into XML text form, and not on every set of a property or method. Static methods allow explicit checking where needed.

The following example shows the use of members of the SecurityElement class.

Imports System
Imports System.Security
Imports System.Collections



Class SecurityElementMembers

    <STAThread()> _
    Shared Sub Main(ByVal args() As String)
        Dim xmlRootElement As New SecurityElement("RootTag", "XML security tree")
        AddAttribute(xmlRootElement, "creationdate", DateTime.Now.ToString())
        AddChildElement(xmlRootElement, "destroytime", DateTime.Now.AddSeconds(1.0).ToString())

        Dim windowsRoleElement As New SecurityElement("WindowsMembership.WindowsRole")
        windowsRoleElement.AddAttribute("version", "1.00")
        ' Add a child element and a creationdate attribute.
        AddChildElement(windowsRoleElement, "BabyElement", "This is a child element")
        AddAttribute(windowsRoleElement, "creationdate", DateTime.Now.ToString())

        xmlRootElement.AddChild(windowsRoleElement)
        CompareAttributes(xmlRootElement, "creationdate")
        ConvertToHashTable(xmlRootElement)

        DisplaySummary(xmlRootElement)

        ' Determine if the security element is too old to keep.
        xmlRootElement = DestroyTree(xmlRootElement)
        If Not (xmlRootElement Is Nothing) Then 
            Dim elementInXml As String = xmlRootElement.ToString()
            Console.WriteLine(elementInXml)
        End If

        Console.WriteLine("This sample completed successfully; " + "press Enter to exit.")
        Console.ReadLine()

    End Sub 'Main


    ' Add an attribute to the specified security element. 
    Private Shared Function AddAttribute(ByVal xmlElement As SecurityElement, ByVal attributeName As String, ByVal attributeValue As String) As SecurityElement
        If Not (xmlElement Is Nothing) Then 
            ' Verify that the attribute name and value are valid XML formats. 
            If SecurityElement.IsValidAttributeName(attributeName) AndAlso SecurityElement.IsValidAttributeValue(attributeValue) Then 
                ' Add the attribute to the security element.
                xmlElement.AddAttribute(attributeName, attributeValue)
            End If 
        End If 
        Return xmlElement

    End Function 'AddAttribute


    ' Add a child element to the specified security element. 
    Private Shared Function AddChildElement(ByVal parentElement As SecurityElement, ByVal tagName As String, ByVal tagText As String) As SecurityElement
        If Not (parentElement Is Nothing) Then 
            ' Ensure that the tag text is in valid XML format. 
            If Not SecurityElement.IsValidText(tagText) Then 
                ' Replace invalid text with valid XML text  
                ' to enforce proper XML formatting.
                tagText = SecurityElement.Escape(tagText)
            End If 

            ' Determine whether the tag is in valid XML format. 
            If SecurityElement.IsValidTag(tagName) Then 
                Dim childElement As SecurityElement
                childElement = parentElement.SearchForChildByTag(tagName)
                If Not (childElement Is Nothing) Then 
                    Dim elementText As String
                    elementText = parentElement.SearchForTextOfTag(tagName)
                    If Not elementText.Equals(tagText) Then 
                        ' Add child element to the parent security element.
                        parentElement.AddChild(New SecurityElement(tagName, tagText))
                    End If 
                Else 
                    ' Add child element to the parent security element.
                    parentElement.AddChild(New SecurityElement(tagName, tagText))
                End If 
            End If 
        End If 
        Return parentElement

    End Function 'AddChildElement


    ' Create and display a summary sentence  
    ' about the specified security element. 
    Private Shared Sub DisplaySummary(ByVal xmlElement As SecurityElement)
        ' Retrieve tag name for the security element. 
        Dim xmlTreeName As String = xmlElement.Tag.ToString()
        ' Retrieve tag text for the security element. 
        Dim xmlTreeDescription As String = xmlElement.Text
        ' Retrieve value of the creationdate attribute. 
        Dim xmlCreationDate As String = xmlElement.Attribute("creationdate")
        ' Retrieve the number of children under the security element. 
        Dim childrenCount As String = xmlElement.Children.Count.ToString()
        Dim outputMessage As String = "The security XML tree named " + xmlTreeName
        outputMessage += "(" + xmlTreeDescription + ")"
        outputMessage += " was created on " + xmlCreationDate + " and "
        outputMessage += "contains " + childrenCount + " child elements."

        Console.WriteLine(outputMessage)

    End Sub 'DisplaySummary


    ' Compare the first two occurrences of an attribute  
    ' in the specified security element. 
    Private Shared Sub CompareAttributes(ByVal xmlElement As SecurityElement, ByVal attributeName As String)
        ' Create a hash table containing the security element's attributes. 
        Dim attributeKeys As Hashtable = xmlElement.Attributes
        Dim attributeValue As String = attributeKeys(attributeName).ToString()
        Dim xmlChild As SecurityElement
        For Each xmlChild In xmlElement.Children
            If attributeValue.Equals(xmlChild.Attribute(attributeName)) Then 
            End If 
        Next xmlChild
        ' The security elements were created at the exact same time. 
    End Sub 'CompareAttributes


    ' Convert the contents of the specified security element  
    ' to hash codes stored in a hash table. 
    Private Shared Sub ConvertToHashTable(ByVal xmlElement As SecurityElement)
        ' Create a hash table to hold hash codes of the security elements. 
        Dim xmlAsHash As New Hashtable()
        Dim rootIndex As Integer = xmlElement.GetHashCode()
        xmlAsHash.Add(rootIndex, "root")
        Dim parentNum As Integer = 0

        Dim xmlParent As SecurityElement
        For Each xmlParent In xmlElement.Children
            parentNum += 1
            xmlAsHash.Add(xmlParent.GetHashCode(), "parent" + parentNum.ToString())
            If Not (xmlParent.Children Is Nothing) AndAlso xmlParent.Children.Count > 0 Then 
                Dim childNum As Integer = 0
                Dim xmlChild As SecurityElement
                For Each xmlChild In xmlParent.Children
                    childNum += 1
                    xmlAsHash.Add(xmlChild.GetHashCode(), "child" + childNum.ToString())
                Next xmlChild
            End If 
        Next xmlParent

    End Sub 'ConvertToHashTable


    ' Delete the specified security element if the current time is past 
    ' the time stored in the destroytime tag. 
    Private Shared Function DestroyTree(ByVal xmlElement As SecurityElement) As SecurityElement
        Dim localXmlElement As SecurityElement = xmlElement
        Dim destroyElement As SecurityElement = localXmlElement.SearchForChildByTag("destroytime")

        ' Verify that a destroytime tag exists. 
        If Not (localXmlElement.SearchForChildByTag("destroytime") Is Nothing) Then 
            ' Retrieve the destroytime text to get the time  
            ' the tree can be destroyed. 
            Dim storedDestroyTime As String = localXmlElement.SearchForTextOfTag("destroytime")
            Dim destroyTime As DateTime = DateTime.Parse(storedDestroyTime)
            If DateTime.Now > destroyTime Then
                localXmlElement = Nothing
                Console.WriteLine("The XML security tree has been deleted.")
            End If 
        End If 

        ' Verify that xmlElement is of type SecurityElement. 
        If xmlElement.GetType().Equals(GetType(System.Security.SecurityElement)) Then 
            ' Determine whether the localXmlElement object  
            ' differs from xmlElement. 
            If xmlElement.Equals(localXmlElement) Then 
                ' Verify that the tags, attributes and children of the 
                ' two security elements are identical. 
                If xmlElement.Equal(localXmlElement) Then 
                    ' Return the original security element. 
                    Return xmlElement
                End If 
            End If 
        End If 

        ' Return the modified security element. 
        Return localXmlElement

    End Function 'DestroyTree
End Class 'SecurityElementMembers

' This sample produces the following output: 
'  
' The security XML tree named RootTag(XML security tree)  
' was created on 2/23/2004 1:23:00 PM and contains 2 child elements. 
'<RootTag creationdate="2/23/2004 1:23:00 PM">XML security tree 
'   <destroytime>2/23/2004 1:23:01 PM</destroytime> 
'   <WindowsMembership.WindowsRole version="1.00" 
'                                  creationdate="2/23/2004 1:23:00 PM"> 
'      <BabyElement>This is a child element.</BabyElement> 
'   </WindowsMembership.WindowsRole> 
'</RootTag> 

'This sample completed successfully; press Exit to continue.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft