PowerShellKeePass

1.0.0.0

private/New-KPCompositeKey.ps1

Function New-KPCompositeKey {
<#
    .SYNOPSIS
        Creates a new database composite key
 
    .DESCRIPTION
        Creates a new database composite key used for locking and unlocking a secure database file. At least one authentication method must been used
 
    .PARAMETER MasterPassword
        If specified, will use a password to help unlock a database
 
    .PARAMETER KeyFile
        If specified, will use the key file to help unlock a database
 
    .PARAMETER UseWindowsUserAccount
        If specified, will use the currently logged on user account to help unlock a database
 
    .EXAMPLE
        New-KPCompositeKey -MasterPassword 'Passw0rd'
 
    .EXAMPLE
        New-KPCompositeKey -KeyFile 'C:\SecureLocation\KeyFile.txt'
 
    .EXAMPLE
        New-KPCompositeKey -MasterPassword 'Password' -UseWindowsUserAccount
 
    .NOTES
        For additional information please see my GitHub wiki page
 
    .LINK
        https://github.com/My-Random-Thoughts/PowerShellKeePass
#>

    [CmdletBinding(SupportsShouldProcess)]
    Param (
        [securestring]$MasterPassword = $null,

        [string]$KeyFile = $null,

        [switch]$UseWindowsUserAccount
    )

    Begin {
        # Check at least one authentication method has been used
        If ((-not $MasterPassword) -and (-not $KeyFile) -and (-not $UseWindowsUserAccount.IsPresent)) {
            Throw 'At least one authentication method must be used'
        }
    }

    Process {
        $compositeKey = (New-Object -TypeName 'KeePassLib.Keys.CompositeKey')

        If ($MasterPassword) {
            $compositeKey.AddUserKey(
                (New-Object -TypeName 'KeePassLib.Keys.KcpPassword'(
                    $(ConvertTo-KPPlainText -InputString $MasterPassword))
                )
            )
        }

        If ($KeyFile) {
            If (Test-Path -Path $KeyFile) {
                $compositeKey.AddUserKey(
                    (New-Object -TypeName 'KeePassLib.Keys.KcpKeyFile'($KeyFile))
                )
            }
        }

        If ($UseWindowsUserAccount.IsPresent) {
            $compositeKey.AddUserKey(
                (New-Object -TypeName 'KeePassLib.Keys.KcpUserAccount')
            )
        }

        If ($PSCmdlet.ShouldProcess('Composite Key', 'Create New')) {
            Return $compositeKey
        }

        Return $null
    }

    End {
    }
}