Public/Get-ALHSavedCredential.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
<#PSScriptInfo
 
.VERSION 1.2.0
 
.GUID 899d0d26-7c9e-4356-a846-bb1f6ee7b579
 
.AUTHOR Dieter Koch
 
.COMPANYNAME
 
.COPYRIGHT (c) 2021-2023 Dieter Koch
 
.TAGS
 
.LICENSEURI https://github.com/admins-little-helper/ALH/blob/main/LICENSE
 
.PROJECTURI https://github.com/admins-little-helper/ALH
 
.ICONURI
 
.EXTERNALMODULEDEPENDENCIES
 
.REQUIREDSCRIPTS
 
.EXTERNALSCRIPTDEPENDENCIES
 
.RELEASENOTES
1.0.0
Initial release
 
1.1.0
Cleaned up code
 
1.2.0
Fixed issue with variable names.
Added validatescript for parameter 'Path'.
Added parameter -AsJSon.
Added parameter -FilePath.
Redesign and code cleanup.
 
#>



<#
 
.DESCRIPTION
 Contains a function to retrieve credentials from a text file which were saved there as securestring.
 
#>



function Get-ALHSavedCredential {
    <#
    .SYNOPSIS
    Retrieve saved credentials (username and secure string password) from a text file.
 
    .DESCRIPTION
    Retrieve saved credentials (username and secure string password) from files.
 
    .PARAMETER Path
    Path to search in for credential files.
 
    .PARAMETER FileNamePrefix
    Filename prefix to use for credential files.
 
    .PARAMETER AsJson
    If specified, the output will be saved in a json file, instead of a text file.
 
    .EXAMPLE
    Get-ALHSavedCredential -Path C:\Admin\Credentials -FileNamePrefix "CredForApp1"
    Get credentials for App1 from text files (one for username, another for the password).
 
    .EXAMPLE
    Get-ALHSavedCredential -FilePath C:\Admin\Credentials\MyCredentials.json
    Get credentials from a JSON file.
 
    .INPUTS
    Nothing
 
    .OUTPUTS
    PSCredential
 
    .NOTES
    Author: Dieter Koch
    Email: diko@admins-little-helper.de
 
    .LINK
    https://github.com/admins-little-helper/ALH/blob/main/Help/Get-ALHSavedCredential.txt
    #>


    [OutputType([PSCredential])]
    [CmdletBinding(DefaultParameterSetName = "default")]
    param
    (
        [Parameter(Mandatory, ParameterSetName = "Path")]
        [ValidateScript({
                # Check if the given path is valid.
                if (-not (Test-Path -Path $_) ) {
                    throw "Folder does not exist."
                }
                # Check if the given path is a directory.
                if (-not (Test-Path -Path $_ -PathType Container) ) {
                    throw "The Path argument must be a folder. File paths are not allowed."
                }
                return $true
            })]
        [System.IO.FileInfo]
        $Path,

        [Parameter(Mandatory, ParameterSetName = "FilePath")]
        [ValidateScript({
                # Check if the given path is valid.
                if (-not (Test-Path -Path $_) ) {
                    throw "File or folder does not exist."
                }
                # Check if the given path is a file.
                if (Test-Path -Path $_ -PathType Container) {
                    throw "The Path argument must be a file. The given path is a folder."
                }
                # Check if the given file is not a json file.
                if ( -not ([IO.Path]::GetExtension($_) -eq ".json")) {
                    throw "The Path argument must be a file. The given path is a folder."
                }
                return $true
            })]
        [System.IO.FileInfo]
        $FilePath,

        [Parameter(ParameterSetName = "Path")]
        [ValidateNotNull()]
        [String]
        $FileNamePrefix,

        [Parameter(ParameterSetName = "Path")]
        [Switch]
        $AsJson
    )

    if ($PSCmdlet.ParameterSetName -eq "FilePath") {
        $FullPathFilCredential = $FilePath
        [switch]$AsJson = $true
    }

    if ($AsJson.IsPresent) {
        if ($PSCmdlet.ParameterSetName -eq "Path") {
            $FullPathFilCredential = Join-Path -Path $Path -ChildPath "$($FileNamePrefix)_Credential.json"
        }
        $FileList = @($FullPathFilCredential)
    }
    else {
        $FullPathFileIdentity = Join-Path -Path $Path -ChildPath "$($FileNamePrefix)_Identity.txt"
        $FullPathFileSecret = Join-Path -Path $Path -ChildPath "$($FileNamePrefix)_Secret.txt"
        $FileList = @($FullPathFileIdentity, $FullPathFileSecret)
    }

    $IsFileMissing = $false
    foreach ($File in $FileList) {
        if (-not (Test-Path -Path $File)) {
            Write-Error -Message "File not found or accessible. FullPath: $File"
            $IsFileMissing = $true
        }
    }

    if (-not ($IsFileMissing)) {
        if ($AsJson.IsPresent) {
            $MyCredentialObject = Get-Content -Path $FullPathFilCredential -Encoding UTF8 | ConvertFrom-Json
            $Credentials = New-Object System.Management.Automation.PSCredential ($MyCredentialObject.Username, $($MyCredentialObject.Password | ConvertTo-SecureString))
        }
        else {
            Write-Verbose -Message "Reading file content of $FullPathFileIdentity"
            $Identity = Get-Content "$FullPathFileIdentity"

            Write-Verbose -Message "Reading file content of $FullPathFileSecret"
            $Secret = Get-Content "$FullPathFileSecret" | ConvertTo-SecureString
            $Credentials = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList ($Identity, $Secret)
        }

        return $Credentials
    }
    else {
        return $null
    }
}

#region EndOfScript
<#
################################################################################
################################################################################
#
# ______ _ __ _____ _ _
# | ____| | | / _| / ____| (_) | |
# | |__ _ __ __| | ___ | |_ | (___ ___ _ __ _ _ __ | |_
# | __| | '_ \ / _` | / _ \| _| \___ \ / __| '__| | '_ \| __|
# | |____| | | | (_| | | (_) | | ____) | (__| | | | |_) | |_
# |______|_| |_|\__,_| \___/|_| |_____/ \___|_| |_| .__/ \__|
# | |
# |_|
################################################################################
################################################################################
# created with help of http://patorjk.com/software/taag/
#>

#endregion