VaultServer

1.0.0

Private/GetUserObjectsInLDAP.ps1

                                function GetUserObjectsInLDAP {

    [CmdletBinding()]

    Param(

        [Parameter(Mandatory=$False)]

        [int]$ObjectCount = 0,

        [Parameter(Mandatory=$False)]

        [string]$Domain,

        [Parameter(Mandatory=$False)]

        [pscredential]$LDAPCreds

    )

    #region >> Prep

    if ($PSVersionTable.Platform -eq "Unix" -and !$LDAPCreds) {

        Write-Error "On this Platform (i.e. $($PSVersionTable.Platform)), you must provide credentials with access to LDAP/Active Directory using the -LDAPCreds parameter! Halting!"

        $global:FunctionResult = "1"

        return

    }

    if ($LDAPCreds) {

        # Make sure the $LDAPCreds.UserName is in the correct format

        if ($LDAPCreds.UserName -notmatch "\\") {

            Write-Error "The -LDAPCreds UserName is NOT in the correct format! The format must be: <Domain>\<User>"

            $global:FunctionResult = "1"

            return

        }

    }

    if ($PSVersionTable.Platform -eq "Unix") {

        # Determine if we have the required Linux commands

        [System.Collections.ArrayList]$LinuxCommands = @(

            "echo"

            "host"

            "hostname"

            "ldapsearch"

            #"expect"

        )

        if (!$Domain) {

            $null = $LinuxCommands.Add("domainname")

        }

        [System.Collections.ArrayList]$CommandsNotPresent = @()

        foreach ($CommandName in $LinuxCommands) {

            $CommandCheckResult = command -v $CommandName

            if (!$CommandCheckResult) {

                $null = $CommandsNotPresent.Add($CommandName)

            }

        }

        if ($CommandsNotPresent.Count -gt 0) {

            [System.Collections.ArrayList]$FailedInstalls = @()

            if ($CommandsNotPresent -contains "echo" -or $CommandsNotPresent -contains "whoami") {

                try {

                    $null = InstallLinuxPackage -PossiblePackageNames "coreutils" -CommandName "echo"

                }

                catch {

                    $null = $FailedInstalls.Add("coreutils")

                }

            }

            if ($CommandsNotPresent -contains "host" -or $CommandsNotPresent -contains "hostname" -or $CommandsNotPresent -contains "domainname") {

                try {

                    $null = InstallLinuxPackage -PossiblePackageNames @("dnsutils","bindutils","bind-utils","bind-tools") -CommandName "nslookup"

                }

                catch {

                    $null = $FailedInstalls.Add("dnsutils_bindutils_bind-utils_bind-tools")

                }

            }

            if ($CommandsNotPresent -contains "ldapsearch") {

                try {

                    $null = InstallLinuxPackage -PossiblePackageNames "openldap-clients" -CommandName "ldapsearch"

                }

                catch {

                    $null = $FailedInstalls.Add("openldap-clients")

                }

            }

            <#

            if ($CommandsNotPresent -contains "expect") {

                try {

                    $null = Install-LinuxPackage -PossiblePackageNames "expect" -CommandName "expect"

                }

                catch {

                    $null = $FailedInstalls.Add("expect")

                }

            }

            #>

            if ($FailedInstalls.Count -gt 0) {

                Write-Error "The following Linux packages are required, but were not able to be installed:`n$($FailedInstalls -join "`n")`nHalting!"

                $global:FunctionResult = "1"

                return

            }

        }

        [System.Collections.ArrayList]$CommandsNotPresent = @()

        foreach ($CommandName in $LinuxCommands) {

            $CommandCheckResult = command -v $CommandName

            if (!$CommandCheckResult) {

                $null = $CommandsNotPresent.Add($CommandName)

            }

        }

        if ($CommandsNotPresent.Count -gt 0) {

            Write-Error "The following Linux commands are required, but not present on $env:ComputerName:`n$($CommandsNotPresent -join "`n")`nHalting!"

            $global:FunctionResult = "1"

            return

        }

    }

    # Below $LDAPInfo Output is PSCustomObject with properties: DirectoryEntryInfo, LDAPBaseUri,

    # GlobalCatalogConfigured3268, GlobalCatalogConfiguredForSSL3269, Configured389, ConfiguredForSSL636,

    # PortsThatWork

    try {

        if ($Domain) {

            $DomainControllerInfo = GetDomainController -Domain $Domain -ErrorAction Stop

        }

        else {

            $DomainControllerInfo = GetDomainController -ErrorAction Stop

        }

        if ($DomainControllerInfo.PrimaryDomainController -eq "unknown") {

            $PDC = $DomainControllerInfo.FoundDomainControllers[0]

        }

        else {

            $PDC = $DomainControllerInfo.PrimaryDomainController

        }

        $LDAPInfo = TestLDAP -ADServerHostNameOrIP $PDC -ErrorAction Stop

        if (!$DomainControllerInfo) {throw "Problem with GetDomainController function! Halting!"}

        if (!$LDAPInfo) {throw "Problem with TestLDAP function! Halting!"}

    }

    catch {

        Write-Error $_

        $global:FunctionResult = "1"

        return

    }

    if (!$LDAPInfo.PortsThatWork) {

        Write-Error "Unable to access LDAP on $PDC! Halting!"

        $global:FunctionResult = "1"

        return

    }

    if ($LDAPInfo.PortsThatWork -contains "389") {

        $Port = "389"

        $LDAPUri = $LDAPInfo.LDAPBaseUri + ":$Port"

    }

    elseif ($LDAPInfo.PortsThatWork -contains "3268") {

        $Port = "3268"

        $LDAPUri = $LDAPInfo.LDAPBaseUri + ":$Port"

    }

    elseif ($LDAPInfo.PortsThatWork -contains "636") {

        $Port = "636"

        $LDAPUri = $LDAPInfo.LDAPBaseUri + ":$Port"

    }

    elseif ($LDAPInfo.PortsThatWork -contains "3269") {

        $Port = "3269"

        $LDAPUri = $LDAPInfo.LDAPBaseUri + ":$Port"

    }

    if ($PSVersionTable.Platform -eq "Unix") {

        $SimpleDomainPrep = $PDC -split "\."

        $SimpleDomain = $SimpleDomainPrep[1..$($SimpleDomainPrep.Count-1)] -join "."

        [System.Collections.ArrayList]$DomainLDAPContainersPrep = @()

        foreach ($Section in $($SimpleDomain -split "\.")) {

            $null = $DomainLDAPContainersPrep.Add($Section)

        }

        $DomainLDAPContainers = $($DomainLDAPContainersPrep | foreach {"DC=$_"}) -join ","

        $BindUserName = $LDAPCreds.UserName

        $BindUserNameForExpect = $BindUserName -replace [regex]::Escape('\'),'\\\'

        $BindPassword = $LDAPCreds.GetNetworkCredential().Password

        $ldapSearchOutput = ldapsearch -x -h $PDC -D $BindUserName -w $BindPassword -b $DomainLDAPContainers -s sub "(&(objectClass=user)(!(objectClass=computer)))" cn

        <#

        $ldapSearchCmdForExpect = "ldapsearch -x -h $PDC -D $BindUserNameForExpect -W -b `"$DomainLDAPContainers`" -s sub `"(&(objectClass=user)(!(objectClass=computer)))`" cn"

        [System.Collections.ArrayList]$ExpectScriptPrep = @(

            'expect - << EOF'

            'set timeout 120'

            "set password $BindPassword"

            'set prompt \"(>|:|#|\\\\\\$)\\\\s+\\$\"'

            "spawn $ldapSearchCmdForExpect"

            'match_max 100000'

            'expect \"Enter LDAP Password:\"'

            'send -- \"\$password\r\"'

            'expect -re \"\$prompt\"'

            'send -- \"exit\r\"'

            'expect eof'

            'EOF'

        )

        $ExpectScript = $ExpectScriptPrep -join "`n"

        #Write-Host "`$ExpectScript is:`n$ExpectScript"

        #$ExpectScript | Export-CliXml "$HOME/ExpectScript2.xml"

        # The below $ExpectOutput is an array of strings

        $ExpectOutput = $ldapSearchOutput = bash -c "$ExpectScript"

        #>

        $Users = $ldapSearchOutput -match "cn:" | foreach {$_ -replace 'cn:[\s]+'}

        if ($ObjectCount -gt 0) {

            $Users = $Users[0..$($ObjectCount-1)]

        }

    }

    else {

        try {

            if ($LDAPCreds) {

                $LDAPUserName = $LDAPCreds.UserName

                $LDAPPassword = $LDAPCreds.GetNetworkCredential().Password

                $LDAPSearchRoot = [System.DirectoryServices.DirectoryEntry]::new($LDAPUri,$LDAPUserName,$LDAPPassword)

            }

            else {

                $LDAPSearchRoot = [System.DirectoryServices.DirectoryEntry]::new($LDAPUri)

            }

            $LDAPSearcher = [System.DirectoryServices.DirectorySearcher]::new($LDAPSearchRoot)

            $LDAPSearcher.Filter = "(&(objectCategory=User))"

            $LDAPSearcher.SizeLimit = 0

            $LDAPSearcher.PageSize = 250

            $Users = $LDAPSearcher.FindAll() | foreach {$_.GetDirectoryEntry()}

            if ($ObjectCount -gt 0) {

                $Users = $Users[0..$($ObjectCount-1)]

            }

        }

        catch {

            Write-Error $_

            $global:FunctionResult = "1"

            return

        }

    }

    $Users

}

# SIG # Begin signature block

# MIIMiAYJKoZIhvcNAQcCoIIMeTCCDHUCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB

# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR

# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUR9uD2u4BuF07TGfbGbwIuk47

# /4mgggn9MIIEJjCCAw6gAwIBAgITawAAAB/Nnq77QGja+wAAAAAAHzANBgkqhkiG

# 9w0BAQsFADAwMQwwCgYDVQQGEwNMQUIxDTALBgNVBAoTBFpFUk8xETAPBgNVBAMT

# CFplcm9EQzAxMB4XDTE3MDkyMDIxMDM1OFoXDTE5MDkyMDIxMTM1OFowPTETMBEG

# CgmSJomT8ixkARkWA0xBQjEUMBIGCgmSJomT8ixkARkWBFpFUk8xEDAOBgNVBAMT

# B1plcm9TQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDCwqv+ROc1

# bpJmKx+8rPUUfT3kPSUYeDxY8GXU2RrWcL5TSZ6AVJsvNpj+7d94OEmPZate7h4d

# gJnhCSyh2/3v0BHBdgPzLcveLpxPiSWpTnqSWlLUW2NMFRRojZRscdA+e+9QotOB

# aZmnLDrlePQe5W7S1CxbVu+W0H5/ukte5h6gsKa0ktNJ6X9nOPiGBMn1LcZV/Ksl

# lUyuTc7KKYydYjbSSv2rQ4qmZCQHqxyNWVub1IiEP7ClqCYqeCdsTtfw4Y3WKxDI

# JaPmWzlHNs0nkEjvnAJhsRdLFbvY5C2KJIenxR0gA79U8Xd6+cZanrBUNbUC8GCN

# wYkYp4A4Jx+9AgMBAAGjggEqMIIBJjASBgkrBgEEAYI3FQEEBQIDAQABMCMGCSsG

# AQQBgjcVAgQWBBQ/0jsn2LS8aZiDw0omqt9+KWpj3DAdBgNVHQ4EFgQUicLX4r2C

# Kn0Zf5NYut8n7bkyhf4wGQYJKwYBBAGCNxQCBAweCgBTAHUAYgBDAEEwDgYDVR0P

# AQH/BAQDAgGGMA8GA1UdEwEB/wQFMAMBAf8wHwYDVR0jBBgwFoAUdpW6phL2RQNF

# 7AZBgQV4tgr7OE0wMQYDVR0fBCowKDAmoCSgIoYgaHR0cDovL3BraS9jZXJ0ZGF0

# YS9aZXJvREMwMS5jcmwwPAYIKwYBBQUHAQEEMDAuMCwGCCsGAQUFBzAChiBodHRw

# Oi8vcGtpL2NlcnRkYXRhL1plcm9EQzAxLmNydDANBgkqhkiG9w0BAQsFAAOCAQEA

# tyX7aHk8vUM2WTQKINtrHKJJi29HaxhPaHrNZ0c32H70YZoFFaryM0GMowEaDbj0

# a3ShBuQWfW7bD7Z4DmNc5Q6cp7JeDKSZHwe5JWFGrl7DlSFSab/+a0GQgtG05dXW

# YVQsrwgfTDRXkmpLQxvSxAbxKiGrnuS+kaYmzRVDYWSZHwHFNgxeZ/La9/8FdCir

# MXdJEAGzG+9TwO9JvJSyoGTzu7n93IQp6QteRlaYVemd5/fYqBhtskk1zDiv9edk

# mHHpRWf9Xo94ZPEy7BqmDuixm4LdmmzIcFWqGGMo51hvzz0EaE8K5HuNvNaUB/hq

# MTOIB5145K8bFOoKHO4LkTCCBc8wggS3oAMCAQICE1gAAAH5oOvjAv3166MAAQAA

# AfkwDQYJKoZIhvcNAQELBQAwPTETMBEGCgmSJomT8ixkARkWA0xBQjEUMBIGCgmS

# JomT8ixkARkWBFpFUk8xEDAOBgNVBAMTB1plcm9TQ0EwHhcNMTcwOTIwMjE0MTIy

# WhcNMTkwOTIwMjExMzU4WjBpMQswCQYDVQQGEwJVUzELMAkGA1UECBMCUEExFTAT

# BgNVBAcTDFBoaWxhZGVscGhpYTEVMBMGA1UEChMMRGlNYWdnaW8gSW5jMQswCQYD

# VQQLEwJJVDESMBAGA1UEAxMJWmVyb0NvZGUyMIIBIjANBgkqhkiG9w0BAQEFAAOC

# AQ8AMIIBCgKCAQEAxX0+4yas6xfiaNVVVZJB2aRK+gS3iEMLx8wMF3kLJYLJyR+l

# rcGF/x3gMxcvkKJQouLuChjh2+i7Ra1aO37ch3X3KDMZIoWrSzbbvqdBlwax7Gsm

# BdLH9HZimSMCVgux0IfkClvnOlrc7Wpv1jqgvseRku5YKnNm1JD+91JDp/hBWRxR

# 3Qg2OR667FJd1Q/5FWwAdrzoQbFUuvAyeVl7TNW0n1XUHRgq9+ZYawb+fxl1ruTj

# 3MoktaLVzFKWqeHPKvgUTTnXvEbLh9RzX1eApZfTJmnUjBcl1tCQbSzLYkfJlJO6

# eRUHZwojUK+TkidfklU2SpgvyJm2DhCtssFWiQIDAQABo4ICmjCCApYwDgYDVR0P

# AQH/BAQDAgeAMBMGA1UdJQQMMAoGCCsGAQUFBwMDMB0GA1UdDgQWBBS5d2bhatXq

# eUDFo9KltQWHthbPKzAfBgNVHSMEGDAWgBSJwtfivYIqfRl/k1i63yftuTKF/jCB

# 6QYDVR0fBIHhMIHeMIHboIHYoIHVhoGubGRhcDovLy9DTj1aZXJvU0NBKDEpLENO

# PVplcm9TQ0EsQ049Q0RQLENOPVB1YmxpYyUyMEtleSUyMFNlcnZpY2VzLENOPVNl

# cnZpY2VzLENOPUNvbmZpZ3VyYXRpb24sREM9emVybyxEQz1sYWI/Y2VydGlmaWNh

# dGVSZXZvY2F0aW9uTGlzdD9iYXNlP29iamVjdENsYXNzPWNSTERpc3RyaWJ1dGlv

# blBvaW50hiJodHRwOi8vcGtpL2NlcnRkYXRhL1plcm9TQ0EoMSkuY3JsMIHmBggr

# BgEFBQcBAQSB2TCB1jCBowYIKwYBBQUHMAKGgZZsZGFwOi8vL0NOPVplcm9TQ0Es

# Q049QUlBLENOPVB1YmxpYyUyMEtleSUyMFNlcnZpY2VzLENOPVNlcnZpY2VzLENO

# PUNvbmZpZ3VyYXRpb24sREM9emVybyxEQz1sYWI/Y0FDZXJ0aWZpY2F0ZT9iYXNl

# P29iamVjdENsYXNzPWNlcnRpZmljYXRpb25BdXRob3JpdHkwLgYIKwYBBQUHMAKG

# Imh0dHA6Ly9wa2kvY2VydGRhdGEvWmVyb1NDQSgxKS5jcnQwPQYJKwYBBAGCNxUH

# BDAwLgYmKwYBBAGCNxUIg7j0P4Sb8nmD8Y84g7C3MobRzXiBJ6HzzB+P2VUCAWQC

# AQUwGwYJKwYBBAGCNxUKBA4wDDAKBggrBgEFBQcDAzANBgkqhkiG9w0BAQsFAAOC

# AQEAszRRF+YTPhd9UbkJZy/pZQIqTjpXLpbhxWzs1ECTwtIbJPiI4dhAVAjrzkGj

# DyXYWmpnNsyk19qE82AX75G9FLESfHbtesUXnrhbnsov4/D/qmXk/1KD9CE0lQHF

# Lu2DvOsdf2mp2pjdeBgKMRuy4cZ0VCc/myO7uy7dq0CvVdXRsQC6Fqtr7yob9NbE

# OdUYDBAGrt5ZAkw5YeL8H9E3JLGXtE7ir3ksT6Ki1mont2epJfHkO5JkmOI6XVtg

# anuOGbo62885BOiXLu5+H2Fg+8ueTP40zFhfLh3e3Kj6Lm/NdovqqTBAsk04tFW9

# Hp4gWfVc0gTDwok3rHOrfIY35TGCAfUwggHxAgEBMFQwPTETMBEGCgmSJomT8ixk

# ARkWA0xBQjEUMBIGCgmSJomT8ixkARkWBFpFUk8xEDAOBgNVBAMTB1plcm9TQ0EC

# E1gAAAH5oOvjAv3166MAAQAAAfkwCQYFKw4DAhoFAKB4MBgGCisGAQQBgjcCAQwx

# CjAIoAKAAKECgAAwGQYJKoZIhvcNAQkDMQwGCisGAQQBgjcCAQQwHAYKKwYBBAGC

# NwIBCzEOMAwGCisGAQQBgjcCARUwIwYJKoZIhvcNAQkEMRYEFOPljPMQmldxAo/v

# 0Pj8m5ZwfjqvMA0GCSqGSIb3DQEBAQUABIIBAG67aLflkiWj2d3Vb7Ib0eWMm49Y

# xreHH1vtPqvX/8O54s4d8K46OJTLtQCymL558Eq4KZe5UeaHg1lUXKXeUdKkMYkG

# dAflmUu41IVvpwaMegUE/2d5xp6CvLokjIdhcqeKjB14VbF+IO3jWn87opZdYmPl

# X2FKR5rBAHJmRfCZOA5/vFaj5mxvXZgHmJY/mhIqPF+ftSpOIB4ZDKhG8xDt0Emb

# eE04NhZvv12pfEarn/8in1to59OF7XWWL80+sBZVIyZIbBWdXZ516RIUpfsG/pUS

# dq6KW2hTW4Z5UOUBCTGbvQTWbE7/woZvVEmTkl+pR/NPbKncajM9miTCAi8=

# SIG # End signature block