Win32.cs source code in C# .NET

Source code for the .NET framework in C#

                        
Code:

                         / DotNET / DotNET / 8.0 / untmp / whidbey / REDBITS / ndp / clr / src / BCL / System / Security / Principal / Win32.cs / 1 / Win32.cs
                        

                        
                            // ==++== 
//
//   Copyright (c) Microsoft Corporation.  All rights reserved.
//
// ==--== 

using Microsoft.Win32; 
using Microsoft.Win32.SafeHandles; 
using System;
using System.Runtime.CompilerServices; 
using System.Runtime.InteropServices;
using System.Security.Permissions;
using System.Text;
 
namespace System.Security.Principal
{ 
    using BOOL = System.Int32; 
    using DWORD = System.UInt32;
    using System.Globalization; 

    [Flags]
    internal enum PolicyRights
    { 
        POLICY_VIEW_LOCAL_INFORMATION            = 0x00000001,
        POLICY_VIEW_AUDIT_INFORMATION            = 0x00000002, 
        POLICY_GET_PRIVATE_INFORMATION           = 0x00000004, 
        POLICY_TRUST_ADMIN                       = 0x00000008,
        POLICY_CREATE_ACCOUNT                    = 0x00000010, 
        POLICY_CREATE_SECRET                     = 0x00000020,
        POLICY_CREATE_PRIVILEGE                  = 0x00000040,
        POLICY_SET_DEFAULT_QUOTA_LIMITS          = 0x00000080,
        POLICY_SET_AUDIT_REQUIREMENTS            = 0x00000100, 
        POLICY_AUDIT_LOG_ADMIN                   = 0x00000200,
        POLICY_SERVER_ADMIN                      = 0x00000400, 
        POLICY_LOOKUP_NAMES                      = 0x00000800, 
        POLICY_NOTIFICATION                      = 0x00001000,
    } 

    internal sealed class Win32
    {
        internal const BOOL FALSE = 0; 
        internal const BOOL TRUE = 1;
 
        private static bool _LsaApisSupported; 
        private static bool _LsaLookupNames2Supported;
        private static bool _ConvertStringSidToSidSupported; 
        private static bool _WellKnownSidApisSupported;

        static Win32()
        { 

            Win32Native.OSVERSIONINFO osvi = new Win32Native.OSVERSIONINFO(); 
 
            bool r = Win32Native.GetVersionEx(osvi);
            if ( !r ) 
            {
                BCLDebug.Assert( r, "OSVersion native call failed." );
                throw new SystemException( Environment.GetResourceString( "InvalidOperation_GetVersion" ));
            } 

            if ( osvi.PlatformId == Win32Native.VER_PLATFORM_WIN32_NT && 
                osvi.MajorVersion >= 5 )   // Windows 2000/XP/W2K3 and above 
            {
 
                //
                // ConvertStringSidToSid and lsa apis supported only on Windows 2000 and greater
                //
                _ConvertStringSidToSidSupported = true; 
                _LsaApisSupported = true;
 
                if (osvi.MajorVersion > 5 || osvi.MinorVersion > 0 ) // Windows XP/2003 and above 
                {
 
                    //
                    // LsaLookupNames2 supported only on XP and Windows 2003 and above
                    //
                    _LsaLookupNames2Supported = true; 
                    _WellKnownSidApisSupported = true;
                } 
                else 
                {
                    // Win2000 
                    _LsaLookupNames2Supported = false;


                    // 
                    // WellKnownSid apis are only supported on Windows 2000 SP3 and above
                    // (so we need sp info) 
                    // 
                    Win32Native.OSVERSIONINFOEX osviex = new Win32Native.OSVERSIONINFOEX();
 
                    r = Win32Native.GetVersionEx(osviex);
                    if ( !r )
                    {
                        BCLDebug.Assert( r, "OSVersion native call failed"); 
                        throw new SystemException( Environment.GetResourceString( "InvalidOperation_GetVersion" ));
                    } 
 
                    if (osviex.ServicePackMajor < 3)
                    { 
                        _WellKnownSidApisSupported = false;
                    }
                    else
                    { 
                        _WellKnownSidApisSupported = true;
                    } 
                } 
            }
            else 
            {
                //
                // Win9x
                // 
                _LsaApisSupported = false;
                _LsaLookupNames2Supported = false; 
                _ConvertStringSidToSidSupported = false; 
                _WellKnownSidApisSupported = false;
            } 

        }

        private Win32() {} // to avoid generation of default constructor 

        internal static bool SddlConversionSupported 
        { 
            get {
                return _ConvertStringSidToSidSupported; 
            }
        }

        internal static bool LsaApisSupported 
        {
            get { 
                return _LsaApisSupported; 
            }
        } 

        internal static bool LsaLookupNames2Supported
        {
            get { 
                return _LsaLookupNames2Supported;
            } 
        } 

        internal static bool WellKnownSidApisSupported 
        {
            get {
                return _WellKnownSidApisSupported;
            } 
        }
 
        // 
        // Wrapper around advapi32.LsaOpenPolicy
        // 

        internal static SafeLsaPolicyHandle LsaOpenPolicy(
            string systemName,
            PolicyRights rights ) 
        {
            // 
            // Check if the api is supported 
            //
            if (!LsaApisSupported) { 
                throw new PlatformNotSupportedException( Environment.GetResourceString( "PlatformNotSupported_Win9x" ));
            }

            uint ReturnCode; 
            SafeLsaPolicyHandle Result;
            Win32Native.LSA_OBJECT_ATTRIBUTES Loa; 
 
            Loa.Length = Marshal.SizeOf( typeof( Win32Native.LSA_OBJECT_ATTRIBUTES ));
            Loa.RootDirectory = IntPtr.Zero; 
            Loa.ObjectName = IntPtr.Zero;
            Loa.Attributes = 0;
            Loa.SecurityDescriptor = IntPtr.Zero;
            Loa.SecurityQualityOfService = IntPtr.Zero; 

            if ( 0 == ( ReturnCode = Win32Native.LsaOpenPolicy( systemName, ref Loa, ( int )rights, out Result ))) 
            { 
                return Result;
            } 
            else if ( ReturnCode == Win32Native.STATUS_ACCESS_DENIED )
            {
                throw new UnauthorizedAccessException();
            } 
            else if ( ReturnCode == Win32Native.STATUS_INSUFFICIENT_RESOURCES ||
            	      ReturnCode == Win32Native.STATUS_NO_MEMORY ) 
            { 
                throw new OutOfMemoryException();
            } 
            else
            {
                int win32ErrorCode = Win32Native.LsaNtStatusToWinError(unchecked((int) ReturnCode));
 
                BCLDebug.Assert( false, string.Format( CultureInfo.InvariantCulture, "Win32Native.LsaOpenPolicy returned unexpected error {0}",  win32ErrorCode));
                throw new SystemException(Win32Native.GetMessage(win32ErrorCode)); 
            } 
        }
 
        internal static byte[] ConvertIntPtrSidToByteArraySid( IntPtr binaryForm )
        {
            byte[] ResultSid;
 
            //
            // Verify the revision (just sanity, should never fail to be 1) 
            // 

            byte Revision = Marshal.ReadByte( binaryForm, 0 ); 

            if ( Revision != SecurityIdentifier.Revision )
            {
                throw new ArgumentException(Environment.GetResourceString( "IdentityReference_InvalidSidRevision" ), "binaryForm"); 
            }
 
            // 
            // Need the subauthority count in order to figure out how many bytes to read
            // 

            byte SubAuthorityCount = Marshal.ReadByte( binaryForm, 1 );

            if ( SubAuthorityCount < 0 || 
                SubAuthorityCount > SecurityIdentifier.MaxSubAuthorities )
            { 
                throw new ArgumentException(Environment.GetResourceString( "IdentityReference_InvalidNumberOfSubauthorities", SecurityIdentifier.MaxSubAuthorities), "binaryForm"); 
            }
 
            //
            // Compute the size of the binary form of this SID and allocate the memory
            //
 
            int BinaryLength = 1 + 1 + 6 + SubAuthorityCount * 4;
            ResultSid = new byte[ BinaryLength ]; 
 
            //
            // Extract the data from the returned pointer 
            //

            Marshal.Copy( binaryForm, ResultSid, 0, BinaryLength );
 
            return ResultSid;
        } 
 
        //
        // Wrapper around advapi32.ConvertStringSidToSidW 
        //

        internal static int CreateSidFromString(
            string stringSid, 
            out byte[] resultSid
            ) 
        { 
            int ErrorCode;
            IntPtr ByteArray = IntPtr.Zero; 

            if (!SddlConversionSupported)
            {
                throw new PlatformNotSupportedException( Environment.GetResourceString( "PlatformNotSupported_Win9x" )); 
            }
 
            try 
            {
                if ( TRUE != Win32Native.ConvertStringSidToSid( stringSid, out ByteArray )) 
                {
                    ErrorCode = Marshal.GetLastWin32Error();
                    goto Error;
                } 

                resultSid = ConvertIntPtrSidToByteArraySid( ByteArray ); 
            } 
            finally
            { 
                //
                // Now is a good time to get rid of the returned pointer
                //
 
                Win32Native.LocalFree( ByteArray );
            } 
 
            //
            // Now invoke the SecurityIdentifier factory method to create the result 
            //

            return Win32Native.ERROR_SUCCESS;
 
        Error:
 
            resultSid = null; 
            return ErrorCode;
        } 

        //
        // Wrapper around advapi32.CreateWellKnownSid
        // 

        internal static int CreateWellKnownSid( 
            WellKnownSidType sidType, 
            SecurityIdentifier domainSid,
            out byte[] resultSid 
            )
        {

            // 
            // Check if the api is supported
            // 
            if (!WellKnownSidApisSupported) { 
                throw new PlatformNotSupportedException( Environment.GetResourceString( "PlatformNotSupported_RequiresW2kSP3" ));
            } 

            //
            // Passing an array as big as it can ever be is a small price to pay for
            // not having to P/Invoke twice (once to get the buffer, once to get the data) 
            //
 
            uint length = ( uint )SecurityIdentifier.MaxBinaryLength; 
            resultSid = new byte[ length ];
 
            if ( FALSE != Win32Native.CreateWellKnownSid(( int )sidType, domainSid == null ? null : domainSid.BinaryForm, resultSid, ref length ))
            {
                return Win32Native.ERROR_SUCCESS;
            } 
            else
            { 
                resultSid = null; 

                return Marshal.GetLastWin32Error(); 
            }
        }

        // 
        // Wrapper around advapi32.EqualDomainSid
        // 
 
        internal static bool IsEqualDomainSid( SecurityIdentifier sid1, SecurityIdentifier sid2 )
        { 
            //
            // Check if the api is supported
            //
            if (!WellKnownSidApisSupported) { 
                throw new PlatformNotSupportedException( Environment.GetResourceString( "PlatformNotSupported_RequiresW2kSP3" ));
            } 
 
            if ( sid1 == null || sid2 == null )
            { 
                return false;
            }
            else
            { 
                bool result;
 
                byte[] BinaryForm1 = new Byte[sid1.BinaryLength]; 
                sid1.GetBinaryForm( BinaryForm1, 0 );
 
                byte[] BinaryForm2 = new Byte[sid2.BinaryLength];
                sid2.GetBinaryForm( BinaryForm2, 0 );

                return ( Win32Native.IsEqualDomainSid( BinaryForm1, BinaryForm2, out result ) == FALSE ? false : result ); 
            }
        } 
 
        //
        // Wrapper around avdapi32.GetWindowsAccountDomainSid 
        //

        internal static int GetWindowsAccountDomainSid(
            SecurityIdentifier sid, 
            out SecurityIdentifier resultSid
            ) 
        { 

            // 
            // Check if the api is supported
            //
            if (!WellKnownSidApisSupported) {
                throw new PlatformNotSupportedException( Environment.GetResourceString( "PlatformNotSupported_RequiresW2kSP3" )); 
            }
 
            // 
            // Passing an array as big as it can ever be is a small price to pay for
            // not having to P/Invoke twice (once to get the buffer, once to get the data) 
            //

            byte[] BinaryForm = new Byte[sid.BinaryLength];
            sid.GetBinaryForm( BinaryForm, 0 ); 
            uint sidLength = ( uint )SecurityIdentifier.MaxBinaryLength;
            byte[] resultSidBinary = new byte[ sidLength ]; 
 
            if ( FALSE != Win32Native.GetWindowsAccountDomainSid( BinaryForm, resultSidBinary, ref sidLength ))
            { 
                resultSid = new SecurityIdentifier( resultSidBinary, 0 );

                return Win32Native.ERROR_SUCCESS;
            } 
            else
            { 
                resultSid = null; 

                return Marshal.GetLastWin32Error(); 
            }
        }

        // 
        // Wrapper around advapi32.IsWellKnownSid
        // 
 
        internal static bool IsWellKnownSid(
            SecurityIdentifier sid, 
            WellKnownSidType type
            )
        {
            // 
            // Check if the api is supported
            // 
            if (!WellKnownSidApisSupported) { 
                throw new PlatformNotSupportedException( Environment.GetResourceString( "PlatformNotSupported_RequiresW2kSP3" ));
            } 

            byte[] BinaryForm = new byte[sid.BinaryLength];
            sid.GetBinaryForm( BinaryForm, 0 );
 
            if ( FALSE == Win32Native.IsWellKnownSid( BinaryForm, ( int )type ))
            { 
                return false; 
            }
            else 
            {
                return true;
            }
        } 

 
        // When the CLR is hosted, the host gets to implement these calls, 
        // otherwise, we call down into the Win32 APIs.
 
        [MethodImplAttribute(MethodImplOptions.InternalCall)]
        internal static extern int ImpersonateLoggedOnUser (SafeTokenHandle hToken);
        [MethodImplAttribute(MethodImplOptions.InternalCall)]
        internal static extern int OpenThreadToken (TokenAccessLevels dwDesiredAccess, WinSecurityContext OpenAs, out SafeTokenHandle phThreadToken); 
        [MethodImplAttribute(MethodImplOptions.InternalCall)]
        internal static extern int RevertToSelf (); 
        [MethodImplAttribute(MethodImplOptions.InternalCall)] 
        internal static extern int SetThreadToken(SafeTokenHandle hToken);
    } 
}

Link Menu

Network programming in C#, Network Programming in VB.NET, Network Programming in .NET
This book is available now!
Buy at Amazon US or
Buy at Amazon UK