EnvelopedSignatureReader Members

  • Article

[Starting with the .NET Framework 4.5, Windows Identity Foundation (WIF) has been fully integrated into the .NET Framework. The version of WIF addressed by this topic, WIF 3.5, is deprecated and should only be used when developing against the .NET Framework 3.5 SP1 or the .NET Framework 4. For more information about WIF in the .NET Framework 4.5, also known as WIF 4.5, see the Windows Identity Foundation documentation in the .NET Framework 4.5 Development Guide.]

Wraps a reader pointing to a enveloped signed XML and provides a reader that can be used to read the content without having to process the signature. The Signature is automatically validated when the last element of the envelope is read.

The following tables list the members exposed by the EnvelopedSignatureReader type.

Public Constructors

  Name Description
  EnvelopedSignatureReader Overloaded.  

Top

Public Properties

(see also Protected Properties)

  Name Description
public property AttributeCount  Overridden. Gets the number of Attributes at the current reader position. (Inherited from XmlReader)
public property BaseURI  Overridden. Gets the base Uri of the current node. (Inherited from XmlReader)
public property CanCanonicalize  (Inherited from XmlDictionaryReader)
public property CanReadBinaryContent  (Inherited from XmlReader)
public property CanReadValueChunk  (Inherited from XmlReader)
public property CanResolveEntity  (Inherited from XmlReader)
public property Depth  Overridden. Gets the Depth of the current node. (Inherited from XmlReader)
public property EOF  Overridden. Gets a value indicating if reader is positioned at the end of the stream. (Inherited from XmlReader)
public property HasAttributes  (Inherited from XmlReader)
public property HasValue  Overridden. Gets a value indicating if the current node can have a Value. (Inherited from XmlReader)
public property IsDefault  Overridden. Gets a value indicating if the current node is an attribute that was generated from the default value defined in the DTD or Schema. (Inherited from XmlReader)
public property IsEmptyElement  Overridden. Gets a value indicating if the current node is an empty element. (Inherited from XmlReader)
public property Item  Overridden. Gets the value of the attribute with the specified index. (Inherited from XmlReader)
public property Item  Overridden. Gets the value of the attribute with the specified System.Xml.XmlReader.Name. (Inherited from XmlReader)
public property Item  Overridden. Gets the value of the attribute with the specified System.Xml.XmlReader.LocalName and System.Xml.XmlReader.NamespaceURI from the wrapped reader. (Inherited from XmlReader)
public property LocalName  Overridden. Gets the local name of the current node. (Inherited from XmlReader)
public property Name  Overridden. Gets the qualified name of the current node. (Inherited from XmlReader)
public property NamespaceURI  Overridden. Gets the namespace URI of the current node. (Inherited from XmlReader)
public property NameTable  Overridden. Gets the XmlNameTable associated with this instance. (Inherited from XmlReader)
public property NodeType  Overridden. Gets the type of the current node. (Inherited from XmlReader)
public property Prefix  Overridden. Gets the prefix of the current node. (Inherited from XmlReader)
public property Quotas  (Inherited from XmlDictionaryReader)
public property QuoteChar  Overridden. Gets the quotation mark character used to enclose the attribute node. (" or '). (Inherited from XmlReader)
public property ReadState  Overridden. Gets the ReadState of the reader. (Inherited from XmlReader)
public property SchemaInfo  (Inherited from XmlReader)
public property Settings  (Inherited from XmlReader)
public property SigningCredentials Returns the SigningCredentials used in the signature after the envelope is consumed and when the signature is validated.
public property Value  Overridden. Gets the text value of the current node. (Inherited from XmlReader)
public property ValueType  Overridden. Gets the Common Language Runtime (CLR) type of the current node. (Inherited from XmlReader)
public property XmlLang  Overridden. Gets the xml:lang scope. (Inherited from XmlReader)
public property XmlSpace  Overridden. Gets the current xml:space scope. If no xml:space scope exists, this property defaults to XmlSpace.None. (Inherited from XmlReader)

Top

Protected Properties

  Name Description
protected property InnerReader  Gets the wrapped inner reader. (Inherited from DelegatingXmlDictionaryReader)

Top

Public Methods

(see also Protected Methods)

  Name Description
public method Close  Overridden. Closes the reader and changes the ReadState to Closed. (Inherited from XmlReader)
public method EndCanonicalization  (Inherited from XmlDictionaryReader)
public method Equals  (Inherited from Object)
public method GetAttribute  Overridden. Gets the value of the attribute at the given index. (Inherited from XmlReader)
public method GetAttribute  (Inherited from XmlDictionaryReader)
public method GetHashCode  (Inherited from Object)
public method GetType  (Inherited from Object)
public method IndexOfLocalName  (Inherited from XmlDictionaryReader)
public method IndexOfLocalName  (Inherited from XmlDictionaryReader)
public method IsLocalName  (Inherited from XmlDictionaryReader)
public method IsLocalName  (Inherited from XmlDictionaryReader)
public method IsNamespaceUri  (Inherited from XmlDictionaryReader)
public method IsNamespaceUri  (Inherited from XmlDictionaryReader)
public method IsStartArray  (Inherited from XmlDictionaryReader)
public method IsStartElement  (Inherited from XmlDictionaryReader)
public method IsStartElement  (Inherited from XmlReader)
public method IsStartElement  (Inherited from XmlReader)
public method IsStartElement  (Inherited from XmlReader)
public method LookupNamespace  Overridden. Resolves a namespace prefix in the current element scope. (Inherited from XmlReader)
public method MoveToAttribute  Overridden. Moves to the attribute with the specified index. (Inherited from XmlReader)
public method MoveToContent  (Inherited from XmlReader)
public method MoveToElement  Overridden. Moves to a node of type Element. (Inherited from XmlReader)
public method MoveToFirstAttribute  Overridden. Moves to the first attribute. (Inherited from XmlReader)
public method MoveToNextAttribute  Overridden. Moves the reader to the next attribute. (Inherited from XmlReader)
public method MoveToStartElement  (Inherited from XmlDictionaryReader)
public method MoveToStartElement  (Inherited from XmlDictionaryReader)
public method MoveToStartElement  (Inherited from XmlDictionaryReader)
public method MoveToStartElement  (Inherited from XmlDictionaryReader)
public method Read Overridden. Overrides the base Read method. Checks if the end of the envelope is reached and validates the signature if requireSignature is enabled. If the reader gets positioned on a Signature element the whole signature is read in if automaticallyReadSignature is enabled.
public method ReadArray  (Inherited from XmlDictionaryReader)
public method ReadArray  (Inherited from XmlDictionaryReader)
public method ReadArray  (Inherited from XmlDictionaryReader)
public method ReadArray  (Inherited from XmlDictionaryReader)
public method ReadArray  (Inherited from XmlDictionaryReader)
public method ReadArray  (Inherited from XmlDictionaryReader)
public method ReadArray  (Inherited from XmlDictionaryReader)
public method ReadArray  (Inherited from XmlDictionaryReader)
public method ReadArray  (Inherited from XmlDictionaryReader)
public method ReadArray  (Inherited from XmlDictionaryReader)
public method ReadArray  (Inherited from XmlDictionaryReader)
public method ReadArray  (Inherited from XmlDictionaryReader)
public method ReadArray  (Inherited from XmlDictionaryReader)
public method ReadArray  (Inherited from XmlDictionaryReader)
public method ReadArray  (Inherited from XmlDictionaryReader)
public method ReadArray  (Inherited from XmlDictionaryReader)
public method ReadArray  (Inherited from XmlDictionaryReader)
public method ReadArray  (Inherited from XmlDictionaryReader)
public method ReadArray  (Inherited from XmlDictionaryReader)
public method ReadArray  (Inherited from XmlDictionaryReader)
public method ReadAttributeValue  Overridden. Parses the attribute value into one or more Text, EntityReference, or EndEntity nodes. (Inherited from XmlReader)
public method ReadBooleanArray  (Inherited from XmlDictionaryReader)
public method ReadBooleanArray  (Inherited from XmlDictionaryReader)
public method ReadContentAs  Overridden. (Inherited from XmlReader)
public method ReadContentAsBase64  Overridden. Reads the content and returns the Base64 decoded binary bytes. (Inherited from XmlReader)
public method ReadContentAsBase64  (Inherited from XmlDictionaryReader)
public method ReadContentAsBinHex  Overridden. Reads the content and returns the BinHex decoded binary bytes. (Inherited from XmlReader)
public method ReadContentAsBinHex  (Inherited from XmlDictionaryReader)
public method ReadContentAsBoolean  (Inherited from XmlReader)
public method ReadContentAsChars  (Inherited from XmlDictionaryReader)
public method ReadContentAsDateTime  (Inherited from XmlReader)
public method ReadContentAsDecimal  Overridden. (Inherited from XmlReader)
public method ReadContentAsDouble  (Inherited from XmlReader)
public method ReadContentAsFloat  Overridden. (Inherited from XmlReader)
public method ReadContentAsGuid  (Inherited from XmlDictionaryReader)
public method ReadContentAsInt  (Inherited from XmlReader)
public method ReadContentAsLong  (Inherited from XmlReader)
public method ReadContentAsObject  (Inherited from XmlReader)
public method ReadContentAsQualifiedName  (Inherited from XmlDictionaryReader)
public method ReadContentAsString  Overridden. (Inherited from XmlReader)
public method ReadContentAsString  (Inherited from XmlDictionaryReader)
public method ReadContentAsString  (Inherited from XmlDictionaryReader)
public method ReadContentAsTimeSpan  (Inherited from XmlDictionaryReader)
public method ReadContentAsUniqueId  Overridden. Reads the content and returns the contained string. (Inherited from XmlDictionaryReader)
public method ReadDateTimeArray  (Inherited from XmlDictionaryReader)
public method ReadDateTimeArray  (Inherited from XmlDictionaryReader)
public method ReadDecimalArray  (Inherited from XmlDictionaryReader)
public method ReadDecimalArray  (Inherited from XmlDictionaryReader)
public method ReadDoubleArray  (Inherited from XmlDictionaryReader)
public method ReadDoubleArray  (Inherited from XmlDictionaryReader)
public method ReadElementContentAs  (Inherited from XmlReader)
public method ReadElementContentAs  (Inherited from XmlReader)
public method ReadElementContentAsBase64  (Inherited from XmlDictionaryReader)
public method ReadElementContentAsBase64  (Inherited from XmlReader)
public method ReadElementContentAsBinHex  (Inherited from XmlDictionaryReader)
public method ReadElementContentAsBinHex  (Inherited from XmlReader)
public method ReadElementContentAsBoolean  Overridden. (Inherited from XmlReader)
public method ReadElementContentAsBoolean  (Inherited from XmlReader)
public method ReadElementContentAsDateTime  Overridden. (Inherited from XmlReader)
public method ReadElementContentAsDateTime  (Inherited from XmlReader)
public method ReadElementContentAsDecimal  Overridden. (Inherited from XmlReader)
public method ReadElementContentAsDecimal  (Inherited from XmlReader)
public method ReadElementContentAsDouble  Overridden. (Inherited from XmlReader)
public method ReadElementContentAsDouble  (Inherited from XmlReader)
public method ReadElementContentAsFloat  Overridden. (Inherited from XmlReader)
public method ReadElementContentAsFloat  (Inherited from XmlReader)
public method ReadElementContentAsGuid  (Inherited from XmlDictionaryReader)
public method ReadElementContentAsInt  Overridden. (Inherited from XmlReader)
public method ReadElementContentAsInt  (Inherited from XmlReader)
public method ReadElementContentAsLong  Overridden. (Inherited from XmlReader)
public method ReadElementContentAsLong  (Inherited from XmlReader)
public method ReadElementContentAsObject  (Inherited from XmlReader)
public method ReadElementContentAsObject  (Inherited from XmlReader)
public method ReadElementContentAsString  Overridden. (Inherited from XmlReader)
public method ReadElementContentAsString  (Inherited from XmlReader)
public method ReadElementContentAsTimeSpan  (Inherited from XmlDictionaryReader)
public method ReadElementContentAsUniqueId  (Inherited from XmlDictionaryReader)
public method ReadElementString  (Inherited from XmlReader)
public method ReadElementString  (Inherited from XmlReader)
public method ReadElementString  (Inherited from XmlReader)
public method ReadEndElement  (Inherited from XmlReader)
public method ReadFullStartElement  (Inherited from XmlDictionaryReader)
public method ReadFullStartElement  (Inherited from XmlDictionaryReader)
public method ReadFullStartElement  (Inherited from XmlDictionaryReader)
public method ReadFullStartElement  (Inherited from XmlDictionaryReader)
public method ReadGuidArray  (Inherited from XmlDictionaryReader)
public method ReadGuidArray  (Inherited from XmlDictionaryReader)
public method ReadInnerXml  (Inherited from XmlReader)
public method ReadInt16Array  (Inherited from XmlDictionaryReader)
public method ReadInt16Array  (Inherited from XmlDictionaryReader)
public method ReadInt32Array  (Inherited from XmlDictionaryReader)
public method ReadInt32Array  (Inherited from XmlDictionaryReader)
public method ReadInt64Array  (Inherited from XmlDictionaryReader)
public method ReadInt64Array  (Inherited from XmlDictionaryReader)
public method ReadOuterXml  (Inherited from XmlReader)
public method ReadSingleArray  (Inherited from XmlDictionaryReader)
public method ReadSingleArray  (Inherited from XmlDictionaryReader)
public method ReadStartElement  (Inherited from XmlDictionaryReader)
public method ReadStartElement  (Inherited from XmlReader)
public method ReadStartElement  (Inherited from XmlReader)
public method ReadStartElement  (Inherited from XmlReader)
public method ReadString  Overridden. (Inherited from XmlReader)
public method ReadSubtree  (Inherited from XmlReader)
public method ReadTimeSpanArray  (Inherited from XmlDictionaryReader)
public method ReadTimeSpanArray  (Inherited from XmlDictionaryReader)
public method ReadToDescendant  (Inherited from XmlReader)
public method ReadToDescendant  (Inherited from XmlReader)
public method ReadToFollowing  (Inherited from XmlReader)
public method ReadToFollowing  (Inherited from XmlReader)
public method ReadToNextSibling  (Inherited from XmlReader)
public method ReadToNextSibling  (Inherited from XmlReader)
public method ReadValueAsBase64  (Inherited from XmlDictionaryReader)
public method ReadValueChunk  Overridden. Reads large streams of text embedded in an XML document. (Inherited from XmlReader)
public method ResolveEntity  Overridden. Resolves the entity reference for EntityReference nodes. (Inherited from XmlReader)
public method Skip  (Inherited from XmlReader)
public method StartCanonicalization  (Inherited from XmlDictionaryReader)
public method ToString  (Inherited from Object)
public method TryGetArrayLength  (Inherited from XmlDictionaryReader)
public method TryGetBase64ContentLength  (Inherited from XmlDictionaryReader)
public method TryGetLocalNameAsDictionaryString  (Inherited from XmlDictionaryReader)
public method TryGetNamespaceUriAsDictionaryString  (Inherited from XmlDictionaryReader)
public method TryGetValueAsDictionaryString  (Inherited from XmlDictionaryReader)
public method TryReadSignature Reads the signature if the reader is currently positioned at a Signature element.

Top

Protected Methods

  Name Description
protected method Dispose  (Inherited from XmlReader)
protected method Finalize  (Inherited from Object)
protected method InitializeInnerReader  Initializes the Inner reader that this instance wraps. (Inherited from DelegatingXmlDictionaryReader)
protected method IsTextNode  (Inherited from XmlDictionaryReader)
protected method MemberwiseClone  (Inherited from Object)
protected method ReadContentAsBinHex  (Inherited from XmlDictionaryReader)
protected method ReadContentAsString  (Inherited from XmlDictionaryReader)
protected method ReadString  (Inherited from XmlDictionaryReader)

Top

See Also

Reference

EnvelopedSignatureReader Class
Microsoft.IdentityModel.Protocols.XmlSignature Namespace

Copyright © 2008 by Microsoft Corporation. All rights reserved.