PSTrueCrypt

0.0.8.1

src/Utility/PSTrueCrypt.Utility.psm1

using namespace 'System.Management.Automation'
using module ..\Writer\PSTrueCrypt.Writer.psm1
using module ..\Storage\PSTrueCrypt.Storage.psm1

$StorageLocation = @{
    Production  = 'HKCU:\SOFTWARE\PSTrueCrypt'
    Testing     = 'HKCU:\SOFTWARE\PSTrueCrypt\Test'
}

enum OSVerification {
    TrueCryptFound = 1
    VeraCryptFound = 2
                
    TrueCryptValid = 4
    VeraCryptValid = 8
     
    TrueCryptVerified = 16
    VeraCryptVerified = 32

    TrueCryptSuccess = 21
    VeraCryptSuccess = 42
}

function Start-SystemCheck
{
    [CmdletBinding()]
    Param()
    
    Add-Type -AssemblyName System.Windows.Forms

    [int]$Results = 0;

    $Regex = "(\w+)\\?$"

    ($Env:Path).Split(';') | ForEach-Object {

        [void]($_ -match $Regex)
        $EnvPathName = $Matches[1]
        
        if(($EnvPathName -eq "TrueCrypt") -or ($EnvPathName -eq "VeraCrypt"))
        {
            $Results += [OSVerification]::($EnvPathName+"Found")

            try
            {
                 Out-Verbose 'EnvPathFoundAndWillBeTested' -Format $EnvPathName
                
                $IsValid = Test-Path $_ -IsValid
                
                if($IsValid -eq $True) {
                        $Results += [OSVerification]::($EnvPathName+"Valid")

                    $IsVerified = Test-Path $_
                    
                    if($IsVerified -eq $True) {
                        $Results += [OSVerification]::($EnvPathName+"Verified")
                    }
                }
            }
            # should be safe to swallow. any discrepanceis will result in the Get-OSVerificationResults call...
            catch{ }

            if(Get-OSVerificationResults $EnvPathName $Results)
            {
                 Out-Verbose 'EnvPathSuccessfullyTested' -Format $EnvPathName
            }
            else
            {
                 Out-Warning 'EnvironmentVarPathFailed' -Format {$_}
                 Out-Warning 'EnvironmentVarRecommendation' -Format {$EnvPathName,$EnvPathName}
                 Out-Warning 'EnvironmentVarRecommendationExample' -Format $EnvPathName
                 Out-Warning 'EnvironmentVarRecommendation2'
            }
        }
    }
}
Export-ModuleMember -Function Start-SystemCheck

#.ExternalHelp PSTrueCrypt-help.xml
function Set-CryptEnvironmentVariable
{
    [CmdletBinding()]
    Param
    (
        [Parameter(Mandatory = $True)]
        [ValidateNotNullOrEmpty()]
        [string]$PathVar
    )

    [int]$Results = 0

    $Regex = "(\w+)\\?$"

    try 
    {
        [void]($PathVar -match $Regex)
        $EnvPathName = $Matches[1]
        
        $Results += [OSVerification]::($EnvPathName+"Found")

        $IsValid = Test-Path $PathVar -IsValid
        
        if($IsValid -eq $True) {
            $Results += [OSVerification]::($EnvPathName+"Valid")
        }

        $IsVerified = Test-Path $PathVar
            
        if($IsVerified -eq $True) {
            $Results += [OSVerification]::($EnvPathName+"Verified")
        }

        if(Get-OSVerificationResults $EnvPathName $Results)
        {
             Out-Verbose 'ConfirmPathVarIsValid' -Format $PathVar

            $Decision = Get-Confirmation -Message "$PathVar will be added to the 'PATH' environment variable."

            if($Decision -eq $True)
            {
                try
                {
                     Out-Verbose 'PathVarSettingAttempt' -Format $PathVar

                    [System.Environment]::SetEnvironmentVariable("Path", $env:Path +";"+ $PathVar, [EnvironmentVariableTarget]::Machine)

                     Out-Information 'ConfirmCreationOfEnvironmentVar' -Format $PathVar
                }
                catch
                {
                     Out-Error 'UnableToChangeEnvironmentVar' -Recommendment 'SecurityRecommendment' -Action Stop
                }
            }
            else
            {
                 Out-Warning 'NewEnvironmentVarCancelled'
            }  
        }
        else 
        {
             Out-Warning 'InvalidEnvironmentVarAttempt' -Format $PathVar -Action Inquire
        }
    }
    catch
    {
         Out-Warning 'InvalidEnvironmentVarAttempt' -Format $PathVar -Action Inquire
    }
}
Export-ModuleMember -Function Set-CryptEnvironmentVariable

# internal function
function Get-OSVerificationResults
{
    [CmdletBinding()]
    Param
    (
        [Parameter(Mandatory = $True, Position = 1)]
        [string]$EnvPathName,

        [Parameter(Mandatory = $True, Position = 2)]
        [int]$Results,

        [ValidateSet("Found", "Valid", "Verified", "Success")]
        [string]$ResultStep = "Success"
    )

    try 
    {
        ([OSVerification]::($EnvPathName+$ResultStep) -band $Results)/[OSVerification]::($EnvPathName+$ResultStep) -eq $True
    }
    catch
    {
        $False
    }
}

function Edit-HistoryFile
{
    try
    {
        $PSHistoryFilePath = (Get-PSReadlineOption | Select-Object -ExpandProperty HistorySavePath)
        $PSHistoryTempFilePath = $PSHistoryFilePath+".tmp"

        Get-Content -Path $PSHistoryFilePath | ForEach-Object { $_ -replace "-KeyfilePath.*(?<!Mount\-TrueCrypt|mt)", "-KeyfilePath X:\XXXXX\XXXXX\XXXXX"} | Set-Content -Path $PSHistoryTempFilePath

        Copy-Item -Path $PSHistoryTempFilePath -Destination $PSHistoryFilePath -Force

        Remove-Item -Path $PSHistoryTempFilePath -Force
    }
    catch
    {
        Out-Error 'UnableToRedact'
        Out-Error 'Genaric' -Format $PSHistoryFilePath -Action Inquire
    }
}
Export-ModuleMember -Function Edit-HistoryFile

# ref: http://stackoverflow.com/a/24649481
function Get-Confirmation
{
    Param
    (
        [Parameter(Mandatory = $True, Position = 1)]
        [string]$Message
    )
    
    $Question = 'Do you want to proceed?'

    $Choices = New-Object Collections.ObjectModel.Collection[Management.Automation.Host.ChoiceDescription]
    $Choices.Add((New-Object Management.Automation.Host.ChoiceDescription -ArgumentList "&Yes"))
    $Choices.Add((New-Object Management.Automation.Host.ChoiceDescription -ArgumentList "&No"))

    [bool]$Decision = !($Host.UI.PromptForChoice($Message, $Question, $Choices, 1))
    
    $Decision
}
Export-ModuleMember -Function Get-Confirmation


# internal function
# ref: http://www.jonathanmedd.net/2014/01/testing-for-admin-privileges-in-powershell.html
function Test-IsAdmin 
{
    ([Security.Principal.WindowsPrincipal] [Security.Principal.WindowsIdentity]::GetCurrent()).IsInRole([Security.Principal.WindowsBuiltInRole] "Administrator")
}
Export-ModuleMember -Function Test-IsAdmin 

function Restart-LogicalDiskCheck
{
    # Enumerates thru all containers and selects ones that have 'IsMounted' set to true and
    # who's 'LastMountedUri' drive now no longer exists will set the container's
    # 'IsMounted' to false.
    # NOTE: Test-Path doesnt work in this FilterScript immediately aftering container is
    # mounted, hence the Get-PSDrive call
    Get-RegistrySubKeys -FilterScript  {
        ($_.getValue('IsMounted').GetHashCode() -eq $True) -and (-not(Get-PSDrive).Root.Contains($_.getValue('LastMountedUri')+':\'))
    } | Write-Container -IsMounted $False
}
Export-ModuleMember -Function Restart-LogicalDiskCheck

function Get-DynamicParameterValues
{
    [CmdletBinding()]
    Param
    (
        [switch]$IsSystemUnderTest
    )

    if(-not $IsSystemUnderTest) {
        Start-Transaction
        $Scope = $StorageLocation.Production
    } else {
        $Scope = $StorageLocation.Testing
    }

    $ContainerNames = Get-RegistrySubKeys -Path $Scope | Get-SubKeyNames -Path $Scope 
    
    if(-not $IsSystemUnderTest) {
        Complete-Transaction
    } else {

    }
    
    $ParamAttrib = New-Object ParameterAttribute
    $ParamAttrib.Mandatory = $True
    $ParamAttrib.Position = 0

    $AttribColl = New-Object System.Collections.ObjectModel.Collection[System.Attribute]
    $AttribColl.Add((New-Object ValidateSetAttribute($ContainerNames)))
    $AttribColl.Add($ParamAttrib)

    $RuntimeParam = New-Object RuntimeDefinedParameter('Name', [string], $AttribColl)
    $RuntimeParamDic = New-Object RuntimeDefinedParameterDictionary
    $RuntimeParamDic.Add('Name', $RuntimeParam)

    return $RuntimeParamDic
}
Export-ModuleMember -Function Get-DynamicParameterValues

function Invoke-BeginBlock
{
    [CmdletBinding()]
    Param
    (
        [switch]$IsSystemUnderTest,

        [switch]$UseIndependentTransaction
    )

    Start-Transaction -Independent:$UseIndependentTransaction.IsPresent
    
    Push-Location
    
    if($IsSystemUnderTest -eq $False) {
        Set-Location -Path $StorageLocation.Production
    } else {
        Set-Location -Path $StorageLocation.Testing -UseTransaction
    }
}
Export-ModuleMember -Function Invoke-BeginBlock

function Invoke-EndBlock
{
    [CmdletBinding()]
    Param
    (
        [switch]$IsSystemUnderTest
    )

    Pop-Location
    
    if($IsSystemUnderTest -eq $False) {
        Complete-Transaction
    } else {

    }
}
Export-ModuleMember -Function Invoke-EndBlock