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 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356
|
//-----------------------------------------------------------------------
// <copyright file="WSTrust13RequestSerializer.cs" company="Microsoft">
// Copyright (c) Microsoft Corporation. All rights reserved.
// </copyright>
//-----------------------------------------------------------------------
namespace System.IdentityModel.Protocols.WSTrust
{
using System.Collections.Generic;
using System.IdentityModel.Tokens;
using System.Xml;
/// <summary>
/// Class for deserializing a WSTrust 1.3 RequestSecurityToken from an XmlReader
/// </summary>
public class WSTrust13RequestSerializer : WSTrustRequestSerializer
{
/// <summary>
/// Deserializes the RST from the XmlReader to a RequestSecurityToken object.
/// </summary>
/// <param name="reader">XML reader over the RST</param>
/// <param name="context">Current Serialization context.</param>
/// <returns>RequestSecurityToken object if the deserialization was successful</returns>
/// <exception cref="ArgumentNullException">The reader or context parameter is null</exception>
/// <exception cref="WSTrustSerializationException">There was an error parsing the RST</exception>
public override RequestSecurityToken ReadXml(XmlReader reader, WSTrustSerializationContext context)
{
if (reader == null)
{
throw DiagnosticUtility.ExceptionUtility.ThrowHelperArgumentNull("reader");
}
if (context == null)
{
throw DiagnosticUtility.ExceptionUtility.ThrowHelperArgumentNull("context");
}
return WSTrustSerializationHelper.CreateRequest(reader, context, this, WSTrustConstantsAdapter.Trust13);
}
/// <summary>
/// Override of the base class that reads a child element inside the RST
/// </summary>
/// <param name="reader">Reader pointing at an element to read inside the RST.</param>
/// <param name="rst">The RequestSecurityToken element that is being populated from the reader.</param>
/// <param name="context">Current Serialization context.</param>
/// <exception cref="ArgumentNullException">Either reader or rst or context parameter is null.</exception>
/// <exception cref="WSTrustSerializationException">Unable to deserialize the current parameter.</exception>
public override void ReadXmlElement(XmlReader reader, RequestSecurityToken rst, WSTrustSerializationContext context)
{
if (reader == null)
{
throw DiagnosticUtility.ExceptionUtility.ThrowHelperArgumentNull("reader");
}
if (rst == null)
{
throw DiagnosticUtility.ExceptionUtility.ThrowHelperArgumentNull("rst");
}
if (context == null)
{
throw DiagnosticUtility.ExceptionUtility.ThrowHelperArgumentNull("context");
}
// special case SecondaryParameters, they cannot be embeded as per WS-Trust 1.3
if (reader.IsStartElement(WSTrust13Constants.ElementNames.SecondaryParameters, WSTrust13Constants.NamespaceURI))
{
rst.SecondaryParameters = this.ReadSecondaryParameters(reader, context);
return;
}
if (reader.IsStartElement(WSTrust13Constants.ElementNames.KeyWrapAlgorithm, WSTrust13Constants.NamespaceURI))
{
rst.KeyWrapAlgorithm = reader.ReadElementContentAsString();
if (!UriUtil.CanCreateValidUri(rst.KeyWrapAlgorithm, UriKind.Absolute))
{
throw DiagnosticUtility.ExceptionUtility.ThrowHelperError(new WSTrustSerializationException(SR.GetString(SR.ID3135, WSTrust13Constants.ElementNames.KeyWrapAlgorithm, WSTrust13Constants.NamespaceURI, rst.KeyWrapAlgorithm)));
}
return;
}
if (reader.IsStartElement(WSTrust13Constants.ElementNames.ValidateTarget, WSTrust13Constants.NamespaceURI))
{
if (!reader.IsEmptyElement)
{
rst.ValidateTarget = new SecurityTokenElement(WSTrustSerializationHelper.ReadInnerXml(reader), context.SecurityTokenHandlers);
}
if (rst.ValidateTarget == null)
{
throw DiagnosticUtility.ExceptionUtility.ThrowHelperError(new WSTrustSerializationException(SR.GetString(SR.ID3221)));
}
return;
}
WSTrustSerializationHelper.ReadRSTXml(reader, rst, context, WSTrustConstantsAdapter.Trust13);
}
/// <summary>
/// Writes out the supported elements on the request object. Override this method if someone
/// has sub-class the RequestSecurityToken class and added more property to it.
/// </summary>
/// <param name="rst">The request instance</param>
/// <param name="writer">The writer to write to</param>
/// <param name="context">Current Serialization context.</param>
/// <exception cref="ArgumentNullException">Either rst or writer or context parameter is null.</exception>
public override void WriteKnownRequestElement(RequestSecurityToken rst, XmlWriter writer, WSTrustSerializationContext context)
{
if (rst == null)
{
throw DiagnosticUtility.ExceptionUtility.ThrowHelperArgumentNull("rst");
}
if (writer == null)
{
throw DiagnosticUtility.ExceptionUtility.ThrowHelperArgumentNull("writer");
}
if (context == null)
{
throw DiagnosticUtility.ExceptionUtility.ThrowHelperArgumentNull("context");
}
// Write out the exisiting ones
WSTrustSerializationHelper.WriteKnownRequestElement(rst, writer, context, this, WSTrustConstantsAdapter.Trust13);
// Specific to WS-Trust 13
if (!string.IsNullOrEmpty(rst.KeyWrapAlgorithm))
{
if (!UriUtil.CanCreateValidUri(rst.KeyWrapAlgorithm, UriKind.Absolute))
{
throw DiagnosticUtility.ExceptionUtility.ThrowHelperError(new WSTrustSerializationException(SR.GetString(SR.ID3135, WSTrust13Constants.ElementNames.KeyWrapAlgorithm, WSTrust13Constants.NamespaceURI, rst.KeyWrapAlgorithm)));
}
this.WriteXmlElement(writer, WSTrust13Constants.ElementNames.KeyWrapAlgorithm, rst.KeyWrapAlgorithm, rst, context);
}
if (rst.SecondaryParameters != null)
{
this.WriteXmlElement(writer, WSTrust13Constants.ElementNames.SecondaryParameters, rst.SecondaryParameters, rst, context);
}
if (rst.ValidateTarget != null)
{
this.WriteXmlElement(writer, WSTrust13Constants.ElementNames.ValidateTarget, rst.ValidateTarget, rst, context);
}
}
/// <summary>
/// Serializes the given RequestSecurityToken into the XmlWriter
/// </summary>
/// <param name="request">RequestSecurityToken object to be serialized</param>
/// <param name="writer">XML writer to serialize into</param>
/// <param name="context">Current Serialization context.</param>
/// <exception cref="ArgumentNullException">The request or writer or context parameter is null.</exception>
public override void WriteXml(RequestSecurityToken request, XmlWriter writer, WSTrustSerializationContext context)
{
if (request == null)
{
throw DiagnosticUtility.ExceptionUtility.ThrowHelperArgumentNull("request");
}
if (writer == null)
{
throw DiagnosticUtility.ExceptionUtility.ThrowHelperArgumentNull("writer");
}
if (context == null)
{
throw DiagnosticUtility.ExceptionUtility.ThrowHelperArgumentNull("context");
}
WSTrustSerializationHelper.WriteRequest(request, writer, context, this, WSTrustConstantsAdapter.Trust13);
}
/// <summary>
/// Override of the Base class method that writes a specific RST parameter to the outgoing stream.
/// </summary>
/// <param name="writer">Writer to which the </param>
/// <param name="elementName">The Local name of the element to be written.</param>
/// <param name="elementValue">The value of the element.</param>
/// <param name="rst">The entire RST object that is being serialized.</param>
/// <param name="context">Current Serialization context.</param>
/// <exception cref="ArgumentNullException">Either writer or rst or context is null.</exception>
/// <exception cref="ArgumentException">elementName is null or an empty string.</exception>
public override void WriteXmlElement(XmlWriter writer, string elementName, object elementValue, RequestSecurityToken rst, WSTrustSerializationContext context)
{
if (writer == null)
{
throw DiagnosticUtility.ExceptionUtility.ThrowHelperArgumentNull("writer");
}
if (string.IsNullOrEmpty(elementName))
{
throw DiagnosticUtility.ThrowHelperArgumentNullOrEmptyString("elementName");
}
if (rst == null)
{
throw DiagnosticUtility.ExceptionUtility.ThrowHelperArgumentNull("rst");
}
if (context == null)
{
throw DiagnosticUtility.ExceptionUtility.ThrowHelperArgumentNull("context");
}
// Write out the WSTrust13 specific elements
if (StringComparer.Ordinal.Equals(elementName, WSTrust13Constants.ElementNames.SecondaryParameters))
{
RequestSecurityToken secondaryParameters = elementValue as RequestSecurityToken;
if (secondaryParameters == null)
{
throw DiagnosticUtility.ExceptionUtility.ThrowHelperError(new InvalidOperationException(SR.GetString(SR.ID2064, WSTrust13Constants.ElementNames.SecondaryParameters)));
}
// WS-Trust 13 spec does not allow this
if (secondaryParameters.SecondaryParameters != null)
{
throw DiagnosticUtility.ExceptionUtility.ThrowHelperError(new InvalidOperationException(SR.GetString(SR.ID2055)));
}
writer.WriteStartElement(WSTrust13Constants.Prefix, WSTrust13Constants.ElementNames.SecondaryParameters, WSTrust13Constants.NamespaceURI);
// write out the known elements inside the rst.SecondaryParameters
this.WriteKnownRequestElement(secondaryParameters, writer, context);
// Write the custom elements here from the rst.SecondaryParameters.Elements bag
foreach (KeyValuePair<string, object> messageParam in secondaryParameters.Properties)
{
this.WriteXmlElement(writer, messageParam.Key, messageParam.Value, rst, context);
}
// close out the SecondaryParameters element
writer.WriteEndElement();
return;
}
if (StringComparer.Ordinal.Equals(elementName, WSTrust13Constants.ElementNames.KeyWrapAlgorithm))
{
writer.WriteElementString(WSTrust13Constants.Prefix, WSTrust13Constants.ElementNames.KeyWrapAlgorithm, WSTrust13Constants.NamespaceURI, (string)elementValue);
return;
}
if (StringComparer.Ordinal.Equals(elementName, WSTrust13Constants.ElementNames.ValidateTarget))
{
SecurityTokenElement tokenElement = elementValue as SecurityTokenElement;
if (tokenElement == null)
{
throw DiagnosticUtility.ExceptionUtility.ThrowHelperArgument("elementValue", SR.GetString(SR.ID3222, WSTrust13Constants.ElementNames.ValidateTarget, WSTrust13Constants.NamespaceURI, typeof(SecurityTokenElement), elementValue));
}
writer.WriteStartElement(WSTrust13Constants.Prefix, WSTrust13Constants.ElementNames.ValidateTarget, WSTrust13Constants.NamespaceURI);
if (tokenElement.SecurityTokenXml != null)
{
tokenElement.SecurityTokenXml.WriteTo(writer);
}
else
{
context.SecurityTokenHandlers.WriteToken(writer, tokenElement.GetSecurityToken());
}
writer.WriteEndElement();
return;
}
WSTrustSerializationHelper.WriteRSTXml(writer, elementName, elementValue, context, WSTrustConstantsAdapter.Trust13);
}
/// <summary>
/// Checks if the given reader is positioned at a RequestSecurityToken element with namespace
/// 'http://docs.oasis-open.org/ws-sx/ws-trust/200512'
/// </summary>
/// <param name="reader">The reader to read from</param>
/// <returns>
/// 'True' if the reader is positioned at a RequestSecurityToken element with namespace
/// 'http://docs.oasis-open.org/ws-sx/ws-trust/200512'.
/// </returns>
/// <exception cref="ArgumentNullException">The input argument is null.</exception>
public override bool CanRead(XmlReader reader)
{
if (reader == null)
{
throw DiagnosticUtility.ExceptionUtility.ThrowHelperArgumentNull("reader");
}
return reader.IsStartElement(WSTrust13Constants.ElementNames.RequestSecurityToken, WSTrust13Constants.NamespaceURI);
}
/// <summary>
/// Special case for reading SecondaryParameters inside a WS-Trust 1.3 RST. The specification states that a SecondaryParameters element
/// cannot be inside a SecondaryParameters element. Override this method to provide custom processing.
/// </summary>
/// <param name="reader">Reader pointing at the SecondaryParameters element inside the RST.</param>
/// <param name="context">Current Serialization context.</param>
/// <exception cref="ArgumentNullException">Either reader or context parameter is null.</exception>
/// <exception cref="WSTrustSerializationException">An inner 'SecondaryParameter' element was found while processing the outer 'SecondaryParameter'.</exception>
/// <returns>RequestSecurityToken that contains the SecondaryParameters found in the RST</returns>
protected virtual RequestSecurityToken ReadSecondaryParameters(
XmlReader reader,
WSTrustSerializationContext context)
{
RequestSecurityToken secondaryParameters = CreateRequestSecurityToken();
if (reader.IsEmptyElement)
{
reader.Read();
reader.MoveToContent();
return secondaryParameters;
}
reader.ReadStartElement();
while (reader.IsStartElement())
{
if (reader.IsStartElement(
WSTrust13Constants.ElementNames.KeyWrapAlgorithm, WSTrust13Constants.NamespaceURI))
{
secondaryParameters.KeyWrapAlgorithm = reader.ReadElementContentAsString();
if (!UriUtil.CanCreateValidUri(secondaryParameters.KeyWrapAlgorithm, UriKind.Absolute))
{
throw DiagnosticUtility.ExceptionUtility.ThrowHelperError(
new WSTrustSerializationException(
SR.GetString(
SR.ID3135,
WSTrust13Constants.ElementNames.KeyWrapAlgorithm,
WSTrust13Constants.NamespaceURI,
secondaryParameters.KeyWrapAlgorithm)));
}
}
else if (reader.IsStartElement(
WSTrust13Constants.ElementNames.SecondaryParameters, WSTrust13Constants.NamespaceURI))
{
throw DiagnosticUtility.ExceptionUtility.ThrowHelperError(
new WSTrustSerializationException(SR.GetString(SR.ID3130)));
}
else
{
WSTrustSerializationHelper.ReadRSTXml(
reader,
secondaryParameters,
context,
WSTrustConstantsAdapter.GetConstantsAdapter(reader.NamespaceURI) ?? WSTrustConstantsAdapter.TrustFeb2005);
}
}
reader.ReadEndElement();
return secondaryParameters;
}
}
}
|