hcs/Hcs.ClientNet/Microsoft/Xades/CertificateValues.cs

// CertificateValues.cs
//
// XAdES Starter Kit for Microsoft .NET 3.5 (and above)
// 2010 Microsoft France
// Published under the CECILL-B Free Software license agreement.
// (http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.txt)
// 
// THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, 
// WHETHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED 
// WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE. 
// THE ENTIRE RISK OF USE OR RESULTS IN CONNECTION WITH THE USE OF THIS CODE 
// AND INFORMATION REMAINS WITH THE USER.

using System;
using System.Collections;
using System.Xml;

namespace Microsoft.Xades
{
    /// <summary>
    /// The CertificateValues element contains the full set of certificates
    /// that have been used to validate	the electronic signature, including the
    /// signer's certificate. However, it is not necessary to include one of
    /// those certificates into this property, if the certificate is already
    /// present in the ds:KeyInfo element of the signature.
    /// In fact, both the signer certificate (referenced in the mandatory
    /// SigningCertificate property element) and all certificates referenced in
    /// the CompleteCertificateRefs property element must be present either in
    /// the ds:KeyInfo element of the signature or in the CertificateValues
    /// property element.
    /// </summary>
    public class CertificateValues
    {
        #region Private variables
        private string id;
        private EncapsulatedX509CertificateCollection encapsulatedX509CertificateCollection;
        private OtherCertificateCollection otherCertificateCollection;
        #endregion

        #region Public properties

        /// <summary>
        /// Optional Id of the certificate values element
        /// </summary>
        public string Id
        {
            get
            {
                return this.id;
            }
            set
            {
                this.id = value;
            }
        }

        /// <summary>
        /// A collection of encapsulated X509 certificates
        /// </summary>
        public EncapsulatedX509CertificateCollection EncapsulatedX509CertificateCollection
        {
            get
            {
                return this.encapsulatedX509CertificateCollection;
            }
            set
            {
                this.encapsulatedX509CertificateCollection = value;
            }
        }

        /// <summary>
        /// Collection of other certificates
        /// </summary>
        public OtherCertificateCollection OtherCertificateCollection
        {
            get
            {
                return this.otherCertificateCollection;
            }
            set
            {
                this.otherCertificateCollection = value;
            }
        }
        #endregion

        #region Constructors
        /// <summary>
        /// Default constructor
        /// </summary>
        public CertificateValues()
        {
            this.encapsulatedX509CertificateCollection = new EncapsulatedX509CertificateCollection();
            this.otherCertificateCollection = new OtherCertificateCollection();
        }
        #endregion

        #region Public methods
        /// <summary>
        /// Check to see if something has changed in this instance and needs to be serialized
        /// </summary>
        /// <returns>Flag indicating if a member needs serialization</returns>
        public bool HasChanged()
        {
            bool retVal = false;

            if (this.id != null && this.id != "")
            {
                retVal = true;
            }
            if (this.encapsulatedX509CertificateCollection.Count > 0)
            {
                retVal = true;
            }
            if (this.otherCertificateCollection.Count > 0)
            {
                retVal = true;
            }

            return retVal;
        }

        /// <summary>
        /// Load state from an XML element
        /// </summary>
        /// <param name="xmlElement">XML element containing new state</param>
        public void LoadXml(System.Xml.XmlElement xmlElement)
        {
            XmlNamespaceManager xmlNamespaceManager;
            XmlNodeList xmlNodeList;
            IEnumerator enumerator;
            XmlElement iterationXmlElement;
            EncapsulatedX509Certificate newEncapsulatedX509Certificate;
            OtherCertificate newOtherCertificate;

            if (xmlElement == null)
            {
                throw new ArgumentNullException("xmlElement");
            }
            if (xmlElement.HasAttribute("Id"))
            {
                this.id = xmlElement.GetAttribute("Id");
            }
            else
            {
                this.id = "";
            }

            xmlNamespaceManager = new XmlNamespaceManager(xmlElement.OwnerDocument.NameTable);
            xmlNamespaceManager.AddNamespace("xades", XadesSignedXml.XadesNamespaceUri);

            this.encapsulatedX509CertificateCollection.Clear();
            this.otherCertificateCollection.Clear();

            xmlNodeList = xmlElement.SelectNodes("xades:EncapsulatedX509Certificate", xmlNamespaceManager);
            enumerator = xmlNodeList.GetEnumerator();
            try
            {
                while (enumerator.MoveNext())
                {
                    iterationXmlElement = enumerator.Current as XmlElement;
                    if (iterationXmlElement != null)
                    {
                        newEncapsulatedX509Certificate = new EncapsulatedX509Certificate();
                        newEncapsulatedX509Certificate.LoadXml(iterationXmlElement);
                        this.encapsulatedX509CertificateCollection.Add(newEncapsulatedX509Certificate);
                    }
                }
            }
            finally
            {
                IDisposable disposable = enumerator as IDisposable;
                if (disposable != null)
                {
                    disposable.Dispose();
                }
            }

            xmlNodeList = xmlElement.SelectNodes("xades:OtherCertificate", xmlNamespaceManager);
            enumerator = xmlNodeList.GetEnumerator();
            try
            {
                while (enumerator.MoveNext())
                {
                    iterationXmlElement = enumerator.Current as XmlElement;
                    if (iterationXmlElement != null)
                    {
                        newOtherCertificate = new OtherCertificate();
                        newOtherCertificate.LoadXml(iterationXmlElement);
                        this.otherCertificateCollection.Add(newOtherCertificate);
                    }
                }
            }
            finally
            {
                IDisposable disposable = enumerator as IDisposable;
                if (disposable != null)
                {
                    disposable.Dispose();
                }
            }
        }

        /// <summary>
        /// Returns the XML representation of the this object
        /// </summary>
        /// <returns>XML element containing the state of this object</returns>
        public XmlElement GetXml()
        {
            XmlDocument creationXmlDocument;
            XmlElement retVal;

            creationXmlDocument = new XmlDocument();
            retVal = creationXmlDocument.CreateElement("xades", "CertificateValues", XadesSignedXml.XadesNamespaceUri);
            if (this.id != null && this.id != "")
            {
                retVal.SetAttribute("Id", this.id);
            }

            if (this.encapsulatedX509CertificateCollection.Count > 0)
            {
                foreach (EncapsulatedX509Certificate encapsulatedX509Certificate in this.encapsulatedX509CertificateCollection)
                {
                    if (encapsulatedX509Certificate.HasChanged())
                    {
                        retVal.AppendChild(creationXmlDocument.ImportNode(encapsulatedX509Certificate.GetXml(), true));
                    }
                }
            }
            if (this.otherCertificateCollection.Count > 0)
            {
                foreach (OtherCertificate otherCertificate in this.otherCertificateCollection)
                {
                    if (otherCertificate.HasChanged())
                    {
                        retVal.AppendChild(creationXmlDocument.ImportNode(otherCertificate.GetXml(), true));
                    }
                }
            }

            return retVal;
        }
        #endregion
    }
}