File: Base\System\Security\RightsManagement\PublishLicense.cs
Project: wpf\src\WindowsBase.csproj (WindowsBase)
//-----------------------------------------------------------------------------
//
// <copyright file="PublishLicense.cs" company="Microsoft">
//    Copyright (C) Microsoft Corporation.  All rights reserved.
// </copyright>
//
// Description:
//  This class implements the UnsignedPublishLicense class 
//   this class is the first step in the RightsManagement publishing process
//
// History:
//  06/01/2005: IgorBel :   Initial Implementation 
//
//-----------------------------------------------------------------------------
 
using System;
using System.Collections;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Diagnostics;
using System.Globalization;
using System.Windows;
using MS.Internal.Security.RightsManagement;
using SecurityHelper=MS.Internal.WindowsBase.SecurityHelper; 
 
// Disable message about unknown message numbers so as to allow the suppression
// of PreSharp warnings (whose numbers are unknown to the compiler).
#pragma warning disable 1634, 1691
 
namespace System.Security.RightsManagement 
{
 
    /// <summary>
    /// A Publish License is a list of rights, users, metadata, and other information that specifies how a specific user on 
    /// a specific computer is able to use the specified content. This Publish License must be signed by using the 
    /// UnisignedPublishLicense.Sign function. The resulting signed Publish License is given to a potential end user 
    /// who must then request a Use License by calling the PublishLicense.AcquireUseLicense function. It is only the 
    /// Use License that allows an application to exercise the rights that have been granted.
    /// </summary>
    /// <SecurityNote>
    ///     Critical:    This class expose access to methods that eventually do one or more of the the following
    ///             1. call into unmanaged code 
    ///             2. affects state/data that will eventually cross over unmanaged code boundary
    ///             3. Return some RM related information which is considered private 
    ///
    ///     TreatAsSafe: This attrbiute automatically applied to all public entry points. All the public entry points have
    ///     Demands for RightsManagementPermission at entry to counter the possible attacks that do 
    ///     not lead to the unamanged code directly(which is protected by another Demand there) but rather leave 
    ///     some status/data behind which eventually might cross the unamanaged boundary. 
    /// </SecurityNote>
    [SecurityCritical(SecurityCriticalScope.Everything)]    
    public class PublishLicense
    {
        /// <summary>
        /// This constructor accepts a string representation of a Publish License, which is supposed to be proided by the 
        /// publisher of a document to tyhe consumer of a document. 
        /// </summary>
        public PublishLicense(string signedPublishLicense)
        {
            SecurityHelper.DemandRightsManagementPermission();
 
            if (signedPublishLicense == null)
            {
                throw new ArgumentNullException("signedPublishLicense");
            }
            
            _serializedPublishLicense = signedPublishLicense;
 
            /////////////////
            // parse out the Use License acquisition Url 
            /////////////////
            _useLicenseAcquisitionUriFromPublishLicense =
                    ClientSession.GetUseLicenseAcquisitionUriFromPublishLicense(_serializedPublishLicense);
 
            if (_useLicenseAcquisitionUriFromPublishLicense == null)
            {
                throw new RightsManagementException(RightsManagementFailureCode.InvalidLicense);
            }
 
 
            /////////////////
            // parse out the Content Id GUID 
            /////////////////
            String contentIdStr = ClientSession.GetContentIdFromPublishLicense(_serializedPublishLicense);
 
            if (contentIdStr == null)
            {
                throw new RightsManagementException(RightsManagementFailureCode.InvalidLicense);                
            }
            else
            {
                _contentId = new Guid(contentIdStr);
            }
 
            /////////////////
            // parse out the Referral Info 
            /////////////////
            ClientSession.GetReferralInfoFromPublishLicense(
                            _serializedPublishLicense,
                            out _referralInfoName, 
                            out _referralInfoUri);
        }
 
        /// <summary>
        /// This function allows the Owner (or a person granted ViewRightsData right)
        /// to extract the original publishing information that was encrypted during publishing process.
        /// </summary>
        public UnsignedPublishLicense DecryptUnsignedPublishLicense(CryptoProvider cryptoProvider )
        {
            SecurityHelper.DemandRightsManagementPermission();
            
            if (cryptoProvider == null)
            {
                throw new ArgumentNullException("cryptoProvider");
            }
 
            return cryptoProvider.DecryptPublishLicense(_serializedPublishLicense);
        }
 
 
        /// <summary>
        /// The referral Information provided by the author of the protected content to the consumer.
        /// This property usually exposes a contact information to ask for additional rights for the 
        /// the protected content.
        /// </summary>
        public string ReferralInfoName
        {
 
            get 
            { 
                SecurityHelper.DemandRightsManagementPermission();
            
                return _referralInfoName; 
            }
        }
 
        /// <summary>
        /// The referral Information provided by the author of the protected content to the consumer.
        /// This property usually exposes a contact information to ask for additional rights for the 
        /// the protected content. Commonly mailto: URIs are used to expose a way to contact the author
        /// of the content. 
        /// </summary>
        public Uri ReferralInfoUri
        {
 
            get 
            { 
                SecurityHelper.DemandRightsManagementPermission();
            
                return _referralInfoUri; 
            }
        }
 
        /// <summary>
        /// The ContentId is created by the publisher and can be used to match content to UseLicense and PublishLicenses.
        /// </summary>
        public Guid ContentId
        {
            get 
            { 
                SecurityHelper.DemandRightsManagementPermission();
            
                return _contentId;
            }
        }
 
        /// <summary>
        /// The Uri that will be used by the AcquireUseLicense call to get the UseLicense. 
        /// </summary>
        public Uri UseLicenseAcquisitionUrl 
        {
            get 
            {
                SecurityHelper.DemandRightsManagementPermission();
            
                return _useLicenseAcquisitionUriFromPublishLicense;
            }
        }
        
        /// <summary>
        /// Returns the original XrML string that was used to deserialize the Pubish License 
        /// </summary>
        public override string ToString()
        {
            SecurityHelper.DemandRightsManagementPermission();
            
            return _serializedPublishLicense;
        }        
 
        /// <summary>
        ///  This function attempts to acquire a Use License.
        /// </summary>
        public UseLicense AcquireUseLicense(SecureEnvironment secureEnvironment)
        {
            SecurityHelper.DemandRightsManagementPermission();
            
            if (secureEnvironment == null)
            {
                throw new ArgumentNullException("secureEnvironment");
            }
 
            // The SecureEnvironment constructor makes sure ClientSession cannot be null.
            // Accordingly suppressing preSharp warning about having to validate ClientSession.
#pragma warning suppress 6506
            return secureEnvironment.ClientSession.AcquireUseLicense(_serializedPublishLicense, false);
        }
 
        /// <summary>
        ///  This function attempts to acquire a Use License. 
        ///  This function suppresses the Windows network authentication dialog box. If the license request is denied
        ///  because the user does not have permission. This function will prevent the network authentication dialog 
        ///  box from being displayed. This is useful when attempting to handle license acquisition on a background 
        ///  or other non-user interface thread because you can avoid potentially confusing dialog boxes. If authentication 
        ///  does fail, the function will throw an appropriate RightsManagementException
        /// </summary>
        public UseLicense AcquireUseLicenseNoUI(SecureEnvironment secureEnvironment)
        {
            SecurityHelper.DemandRightsManagementPermission();
                    
            if (secureEnvironment == null)
            {
                throw new ArgumentNullException("secureEnvironment");
            }
 
            // The SecureEnvironment constructor makes sure ClientSession cannot be null.
            // Accordingly suppressing preSharp warning about having to validate ClientSession.
#pragma warning suppress 6506
            return secureEnvironment.ClientSession.AcquireUseLicense(_serializedPublishLicense, true);
        }        
 
        private string _serializedPublishLicense;
        private string _referralInfoName;
        private Uri _referralInfoUri;
        private Guid _contentId;
        private Uri _useLicenseAcquisitionUriFromPublishLicense = null;
    }
}