mcs/class/System.Security/System.Security.Cryptography.Xml/XmlDsigEnvelopedSignatureTransform.cs

   1 //
   2 // XmlDsigEnvelopedSignatureTransform.cs -
   3 //      Enveloped Signature Transform implementation for XML Signature
   4 //
   5 // Author:
   6 //      Sebastien Pouliot (spouliot@motus.com)
   7 //      Atsushi Enomoto (atsushi@ximian.com)
   8 //
   9 // (C) 2002, 2003 Motus Technologies Inc. (http://www.motus.com)
  10 // (C) 2004 Novell Inc.
  11 //
  12
  13 //
  14 // Permission is hereby granted, free of charge, to any person obtaining
  15 // a copy of this software and associated documentation files (the
  16 // "Software"), to deal in the Software without restriction, including
  17 // without limitation the rights to use, copy, modify, merge, publish,
  18 // distribute, sublicense, and/or sell copies of the Software, and to
  19 // permit persons to whom the Software is furnished to do so, subject to
  20 // the following conditions:
  21 //
  22 // The above copyright notice and this permission notice shall be
  23 // included in all copies or substantial portions of the Software.
  24 //
  25 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  26 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  27 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  28 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  29 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  30 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  31 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  32 //
  33
  34 using System.Collections;
  35 using System.IO;
  36 using System.Xml;
  37
  38 namespace System.Security.Cryptography.Xml {
  39
  40         public class XmlDsigEnvelopedSignatureTransform : Transform {
  41
  42                 private Type[] input;
  43                 private Type[] output;
  44                 private bool comments;
  45                 private object inputObj;
  46
  47                 public XmlDsigEnvelopedSignatureTransform ()
  48                 {
  49                         Algorithm = "http://www.w3.org/2000/09/xmldsig#enveloped-signature";
  50                         comments = false;
  51                 }
  52
  53                 public XmlDsigEnvelopedSignatureTransform (bool includeComments)
  54                 {
  55                         comments = includeComments;
  56                 }
  57
  58                 public override Type[] InputTypes {
  59                         get {
  60                                 if (input == null) {
  61                                         lock (this) {
  62                                                 // this way the result is cached if called multiple time
  63                                                 input = new Type [3];
  64                                                 input[0] = typeof (System.IO.Stream);
  65                                                 input[1] = typeof (System.Xml.XmlDocument);
  66                                                 input[2] = typeof (System.Xml.XmlNodeList);
  67                                         }
  68                                 }
  69                                 return input;
  70                         }
  71                 }
  72
  73                 public override Type[] OutputTypes {
  74                         get {
  75                                 if (output == null) {
  76                                         lock (this) {
  77                                                 // this way the result is cached if called multiple time
  78                                                 output = new Type [2];
  79                                                 output [0] = typeof (System.Xml.XmlDocument);
  80                                                 output [1] = typeof (System.Xml.XmlNodeList);
  81                                         }
  82                                 }
  83                                 return output;
  84                         }
  85                 }
  86
  87                 protected override XmlNodeList GetInnerXml ()
  88                 {
  89                         return null; // THIS IS DOCUMENTED AS SUCH
  90                 }
  91
  92                 // NOTE: This method never supports the requirements written
  93                 // in xmldsig spec that says its input is canonicalized before
  94                 // transforming. This method just removes Signature element.
  95                 // Canonicalization is done in SignedXml.
  96                 public override object GetOutput ()
  97                 {
  98                         XmlDocument doc = null;
  99
 100                         // possible input: Stream, XmlDocument, and XmlNodeList
 101                         if (inputObj is Stream) {
 102                                 doc = new XmlDocument ();
 103                                 doc.PreserveWhitespace = true;
 104 #if NET_1_1
 105                                 doc.XmlResolver = GetResolver ();
 106 #endif
 107                                 doc.Load (inputObj as Stream);
 108                                 return GetOutputFromNode (doc, GetNamespaceManager (doc), true);
 109                         }
 110                         else if (inputObj is XmlDocument) {
 111                                 doc = inputObj as XmlDocument;
 112                                 return GetOutputFromNode (doc, GetNamespaceManager (doc), true);
 113                         }
 114                         else if (inputObj is XmlNodeList) {
 115                                 ArrayList al = new ArrayList ();
 116                                 XmlNodeList nl = (XmlNodeList) inputObj;
 117                                 if (nl.Count > 0) {
 118                                         XmlNamespaceManager m = GetNamespaceManager (nl.Item (0));
 119                                         ArrayList tmp = new ArrayList ();
 120                                         foreach (XmlNode n in nl)
 121                                                 tmp.Add (n);
 122                                         foreach (XmlNode n in tmp)
 123                                                 if (n.SelectNodes ("ancestor-or-self::dsig:Signature", m).Count == 0)
 124                                                         al.Add (GetOutputFromNode (n, m, false));
 125                                 }
 126                                 return new XmlDsigNodeList (al);
 127                         }
 128                         // Note that it is unexpected behavior with related to InputTypes (MS.NET accepts XmlElement)
 129                         else if (inputObj is XmlElement) {
 130                                 XmlElement el = inputObj as XmlElement;
 131                                 XmlNamespaceManager m = GetNamespaceManager (el);
 132                                 if (el.SelectNodes ("ancestor-or-self::dsig:Signature", m).Count == 0)
 133                                         return GetOutputFromNode (el, m, true);
 134                         }
 135
 136                         throw new NullReferenceException ();
 137                 }
 138
 139                 private XmlNamespaceManager GetNamespaceManager (XmlNode n)
 140                 {
 141                         XmlDocument doc = n is XmlDocument ? n as XmlDocument : n.OwnerDocument;
 142                         XmlNamespaceManager nsmgr = new XmlNamespaceManager (doc.NameTable);
 143                         nsmgr.AddNamespace ("dsig", XmlSignature.NamespaceURI);
 144                         return nsmgr;
 145                 }
 146
 147                 private XmlNode GetOutputFromNode (XmlNode input, XmlNamespaceManager nsmgr, bool remove)
 148                 {
 149                         if (remove) {
 150                                 XmlNodeList nl = input.SelectNodes ("descendant-or-self::dsig:Signature", nsmgr);
 151                                 foreach (XmlNode n in nl)
 152                                         n.ParentNode.RemoveChild (n);
 153                         }
 154                         return input;
 155                 }
 156
 157                 public override object GetOutput (Type type)
 158                 {
 159                         if (type == Type.GetType ("Stream"))
 160                                 return GetOutput ();
 161                         throw new ArgumentException ("type");
 162                 }
 163
 164                 public override void LoadInnerXml (XmlNodeList nodeList)
 165                 {
 166                         // NO CHANGE
 167                 }
 168
 169                 public override void LoadInput (object obj)
 170                 {
 171                         inputObj = obj;
 172                 }
 173         }
 174 }