For a project, a customer want to move all remote workers from domain joined to AzureAD joined. We created several packaged and a new an installation and setup routine. One challenge was the BitLocker recovery information. The customer had the recovery information saved in his Active Directory before. For Hybrid joined systems, this might also an option, but for AzureAD only systems it isn’t.
So I came up with the following script:
#requires -Version 2.0 -Modules BitLocker
#requires -RunAsAdministrator
<#
.SYNOPSIS
Backup the BitLocker Recovery Information to the Azure Active Directory
.DESCRIPTION
Backup the BitLocker Recovery Information to the Azure Active Directory
If the Boot Drive is not encrypted, the Script will try to enable the quick protection
.EXAMPLE
PS C:\> .\Invoke-BackupBitlockerRecoveryKey.ps1
.EXAMPLE
PS C:\> $AADInfo = (Get-DsRegStatusInfo | Select-Object -Property AzureAdJoined,WorkplaceJoined)
PS C:\> if ( ($AADInfo.AzureAdJoined -ne 'YES') -and ($AADInfo.WorkplaceJoined -ne 'YES') ) {throw 'Not AzureAD bound'} else {.\Invoke-BackupBitlockerRecoveryKey.ps1}
You may want to check if the device is AzureAD joined with Get-DsRegStatusInfo first
.NOTES
Quick and relativ dirty solution for a challange I had in the last couple of days
.LINK
Get-DsRegStatusInfo
.LINK
http://hochwald.net
#>
[CmdletBinding(ConfirmImpact = 'Low')]
param ()
begin
{
# Defaults
$LogName = 'Application'
$STP = 'Stop'
$SCT = 'SilentlyContinue'
$LogSource = 'enAutomate'
# Register the event log source
$null = (New-EventLog -LogName $LogName -Source $LogSource -ErrorAction $SCT)
}
process
{
try
{
# Get BitLocker Volume info
$BitLockerVolumeInfo = (Get-BitLockerVolume -ErrorAction $STP | Where-Object -FilterScript {
$_.VolumeType -eq 'OperatingSystem'
})
# Get the Mount Point
$BootDrive = $BitLockerVolumeInfo.MountPoint
# Check if the drive is encrypted
if ($BitLockerVolumeInfo.ProtectionStatus -ne 'On')
{
$InfoMessage = ('Enable BitLocker for ' + $BootDrive)
Write-Verbose -Message $InfoMessage
$null = (Write-EventLog -LogName $LogName -Source $LogSource -EntryType Information -EventId 1000 -Message $InfoMessage -ErrorAction $SCT)
# Now we try to activate BitLocker (-UsedSpaceOnly is not perfect, but much faster in this case
$null = (Enable-BitLocker -MountPoint $BootDrive -EncryptionMethod XtsAes128 -UsedSpaceOnly -SkipHardwareTest -RecoveryPasswordProtector -Confirm:$false -ErrorAction $STP)
}
# Get the correct ID (The one from the RecoveryPassword)
$BitLockerKeyProtectorId = ($BitLockerVolumeInfo.KeyProtector | Where-Object -FilterScript {
$_.KeyProtectorType -eq 'RecoveryPassword'
} | Select-Object -ExpandProperty KeyProtectorId)
# Check if we have a recovery password/id
if ($BitLockerKeyProtectorId)
{
# Do the backup towards AzureAD
$null = (BackupToAAD-BitLockerKeyProtector -MountPoint $BootDrive -KeyProtectorId $BitLockerKeyProtectorId -Confirm:$false -ErrorAction $STP)
$InfoMessage = ('The Recovery Infor for ' + $BootDrive + ' was saved to the Azure Active Directory')
Write-Verbose -Message $InfoMessage
$null = (Write-EventLog -LogName $LogName -Source $LogSource -EntryType Information -EventId 1000 -Message $InfoMessage -ErrorAction $SCT)
}
else
{
$WarningMessage = ('No Recorvery Information for ' + $BootDrive + ' found...')
Write-Warning -Message $WarningMessage
$null = (Write-EventLog -LogName $LogName -Source $LogSource -EntryType Warning -EventId 1001 -Message $WarningMessage -ErrorAction $SCT)
}
}
catch
{
#region ErrorHandler
# Get error record
[Management.Automation.ErrorRecord]$e = $_
# retrieve information about runtime error
$info = @{
Exception = $e.Exception.Message
Reason = $e.CategoryInfo.Reason
Target = $e.CategoryInfo.TargetName
Script = $e.InvocationInfo.ScriptName
Line = $e.InvocationInfo.ScriptLineNumber
Column = $e.InvocationInfo.OffsetInLine
}
# Error Stack
$info | Out-String | Write-Verbose
# Save to the Event Log
$null = (Write-EventLog -LogName $LogName -Source $LogSource -EntryType Error -EventId 1001 -Message ($info.Exception) -ErrorAction $SCT)
# Just display the info on continue with the rest of the list
$paramWriteError = @{
Message = ($info.Exception)
Exception = $info.Exception
TargetObject = $info.Target
ErrorAction = 'Stop'
WarningAction = 'Continue'
}
Write-Error @paramWriteError
}
}
#region LICENSE
<#
BSD 3-Clause License
Copyright (c) 2020, enabling Technology
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#>
#endregion LICENSE
#region DISCLAIMER
<#
DISCLAIMER:
- Use at your own risk, etc.
- This is open-source software, if you find an issue try to fix it yourself. There is no support and/or warranty in any kind
- This is a third-party Software
- The developer of this Software is NOT sponsored by or affiliated with Microsoft Corp (MSFT) or any of its subsidiaries in any way
- The Software is not supported by Microsoft Corp (MSFT)
- By using the Software, you agree to the License, Terms, and any Conditions declared and described above
- If you disagree with any of the Terms, and any Conditions declared: Just delete it and build your own solution
#>
#endregion DISCLAIMER
We used it in a combination with a function that I created a while ago to check if the system is AzureAD joined (fully, or workplace only). Here is the function:
#requires -Version 1.0
function Get-DsRegStatusInfo
{
<#
.SYNOPSIS
Wrapper function for the dsregcmd command
.DESCRIPTION
Wrapper function for the dsregcmd command
Nothing fancy, but it should convert the plain text ouput of dsregcmd to a PSObject
.EXAMPLE
PS C:\> Get-DsRegStatusInfo
Returns a PSObject with the values of dsregcmd
.EXAMPLE
PS C:\> $AADInfo = (Get-DsRegStatusInfo | Select-Object -Property AzureAdJoined,WorkplaceJoined)
PS C:\> if ( ($AADInfo.AzureAdJoined -ne 'YES') -and ($AADInfo.WorkplaceJoined -ne 'YES') ) {throw 'Not AzureAD bound'}
Check if the system is joined to the AzureAD (fully or just WorkplaceJoined)
.EXAMPLE
PS C:\> $AADInfo = (Get-DsRegStatusInfo | Select-Object -Property AzureAdJoined, WorkplaceJoined)
PS C:\> if ($AADInfo.AzureAdJoined -eq 'YES') {'AzureAd Joined'} elseif ($AADInfo.WorkplaceJoined -eq 'YES') {'Workplace Joined'} else {'Unknown'}
Check if the system is joined to the AzureAD (fully or just WorkplaceJoined)
.NOTES
Replaced my old ConvertFrom-String based wrapper implementation, this is more flexible
.LINK
http://hochwald.net
#>
[CmdletBinding(ConfirmImpact = 'None')]
[OutputType([psobject])]
param ()
begin
{
$DsRegCmdPlain = (& "$env:windir\system32\dsregcmd.exe" /status)
$DsRegStatusInfo = (New-Object -TypeName PSObject)
}
process
{
$DsRegCmdPlain | Select-String -Pattern ' *[A-z]+ : [A-z]+ *' | ForEach-Object -Process {
$null = (Add-Member -InputObject $DsRegStatusInfo -MemberType NoteProperty -Name (([String]$_).Trim() -split ' : ')[0] -Value (([String]$_).Trim() -split ' : ')[1] -ErrorAction SilentlyContinue)
}
}
end
{
$DsRegStatusInfo
}
}
#region LICENSE
<#
BSD 3-Clause License
Copyright (c) 2020, enabling Technology
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#>
#endregion LICENSE
#region DISCLAIMER
<#
DISCLAIMER:
- Use at your own risk, etc.
- This is open-source software, if you find an issue try to fix it yourself. There is no support and/or warranty in any kind
- This is a third-party Software
- The developer of this Software is NOT sponsored by or affiliated with Microsoft Corp (MSFT) or any of its subsidiaries in any way
- The Software is not supported by Microsoft Corp (MSFT)
- By using the Software, you agree to the License, Terms, and any Conditions declared and described above
- If you disagree with any of the Terms, and any Conditions declared: Just delete it and build your own solution
#>
#endregion DISCLAIMER
We also created a slightly different version, one that doesn’t require admin permission, and let this one run during each login.
Here is how to create a scheduled job for this:
$paramGetScheduledTask = @{
TaskName = 'Backup Bitlocker Recovery Key to AzureAD'
ErrorAction = 'SilentlyContinue'
}
if (-not (Get-ScheduledTask @paramGetScheduledTask))
{
$null = (& "$env:windir\system32\schtasks.exe" /create /tn 'Backup Bitlocker Recovery Key to AzureAD' /sc ONLOGON /ru Users /rl HIGHEST /DELAY 0001:00 /tr "C:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe -ExecutionPolicy ByPass -WindowStyle Hidden -File C:\scripts\PowerShell\Invoke-BackupBitlockerRecoveryKey.ps1")
}
You have to transfer the script on each system before.
The code is also published to my default PowerShell Repository on GitHub.