websocket-sharp/websocket-sharp/Net/HttpDigestIdentity.cs

#region License
/*
 * HttpDigestIdentity.cs
 *
 * The MIT License
 *
 * Copyright (c) 2014-2017 sta.blockhead
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
#endregion

using System;
using System.Collections.Specialized;
using System.Security.Principal;

namespace WebSocketSharp.Net
{
  /// <summary>
  /// Holds the username and other parameters from
  /// an HTTP Digest authentication attempt.
  /// </summary>
  public class HttpDigestIdentity : GenericIdentity
  {
    #region Private Fields

    private NameValueCollection _parameters;

    #endregion

    #region Internal Constructors

    internal HttpDigestIdentity (NameValueCollection parameters)
      : base (parameters["username"], "Digest")
    {
      _parameters = parameters;
    }

    #endregion

    #region Public Properties

    /// <summary>
    /// Gets the algorithm parameter from a digest authentication attempt.
    /// </summary>
    /// <value>
    /// A <see cref="string"/> that represents the algorithm parameter.
    /// </value>
    public string Algorithm {
      get {
        return _parameters["algorithm"];
      }
    }

    /// <summary>
    /// Gets the cnonce parameter from a digest authentication attempt.
    /// </summary>
    /// <value>
    /// A <see cref="string"/> that represents the cnonce parameter.
    /// </value>
    public string Cnonce {
      get {
        return _parameters["cnonce"];
      }
    }

    /// <summary>
    /// Gets the nc parameter from a digest authentication attempt.
    /// </summary>
    /// <value>
    /// A <see cref="string"/> that represents the nc parameter.
    /// </value>
    public string Nc {
      get {
        return _parameters["nc"];
      }
    }

    /// <summary>
    /// Gets the nonce parameter from a digest authentication attempt.
    /// </summary>
    /// <value>
    /// A <see cref="string"/> that represents the nonce parameter.
    /// </value>
    public string Nonce {
      get {
        return _parameters["nonce"];
      }
    }

    /// <summary>
    /// Gets the opaque parameter from a digest authentication attempt.
    /// </summary>
    /// <value>
    /// A <see cref="string"/> that represents the opaque parameter.
    /// </value>
    public string Opaque {
      get {
        return _parameters["opaque"];
      }
    }

    /// <summary>
    /// Gets the qop parameter from a digest authentication attempt.
    /// </summary>
    /// <value>
    /// A <see cref="string"/> that represents the qop parameter.
    /// </value>
    public string Qop {
      get {
        return _parameters["qop"];
      }
    }

    /// <summary>
    /// Gets the realm parameter from a digest authentication attempt.
    /// </summary>
    /// <value>
    /// A <see cref="string"/> that represents the realm parameter.
    /// </value>
    public string Realm {
      get {
        return _parameters["realm"];
      }
    }

    /// <summary>
    /// Gets the response parameter from a digest authentication attempt.
    /// </summary>
    /// <value>
    /// A <see cref="string"/> that represents the response parameter.
    /// </value>
    public string Response {
      get {
        return _parameters["response"];
      }
    }

    /// <summary>
    /// Gets the uri parameter from a digest authentication attempt.
    /// </summary>
    /// <value>
    /// A <see cref="string"/> that represents the uri parameter.
    /// </value>
    public string Uri {
      get {
        return _parameters["uri"];
      }
    }

    #endregion

    #region Internal Methods

    internal bool IsValid (
      string password, string realm, string method, string entity
    )
    {
      var copied = new NameValueCollection (_parameters);
      copied["password"] = password;
      copied["realm"] = realm;
      copied["method"] = method;
      copied["entity"] = entity;

      var expected = AuthenticationResponse.CreateRequestDigest (copied);
      return _parameters["response"] == expected;
    }

    #endregion
  }
}