DictionaryFile.psm1

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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
function Get-PasswordNumber {
<#
.SYNOPSIS
 
Calculates the number of possible passwords
 
.DESCRIPTION
 
Calculates the number of possible passwords based
on the input so you will know the actual number before
you proceed to create your dictionary file.
 
.PARAMETER Characters
 
Specifies the letters that need to be included.
Parameter is mandatory.
 
.PARAMETER Numbers
 
Specifies the numbers that need to be included.
Parameter is mandatory.
 
.PARAMETER Symbols
 
Specifies the Symbols that need to be included.
Parameter is mandatory.
 
.PARAMETER MinCharacters
 
Specifies the minimum characters of the generated passwords.
Parameter is mandatory.
 
.PARAMETER MaxCharacters
 
Specifies the maximum characters of the generated passwords.
Parameter is mandatory.
 
.PARAMETER IncludeCapital
 
Specifies whether or not to include upper case letters along with
the lower case letters.
 
.PARAMETER CapitalOnly
 
Specifies whether or not all lower case letters to be converted to
upper case letters.
 
.INPUTS
 
None. You cannot pipe objects to Get-PasswordNumber.
 
.OUTPUTS
 
System.String. Get-PasswordNumber returns the number of password that
can be created.
 
.EXAMPLE
 
C:\PS> Get-PasswordNumber -Characters "a,b,c" -Numbers "1,2,3" -Symbols "$,*,&" -MinCharacters 2 -MaxCharacters 5
There are 66420 possible passwords
 
.EXAMPLE
 
C:\PS> Get-PasswordNumber -Characters "a,b,c" -Numbers "1,2,3" -Symbols "$,*,&" -MinCharacters 2 -MaxCharacters 5 -IncludeCapital
There are 271440 possible passwords
 
.EXAMPLE
 
C:\PS> Get-PasswordNumber -Characters "a,b,c" -Numbers "1,2,3" -Symbols "$,*,&" -MinCharacters 2 -MaxCharacters 5 -CapitalOnly
There are 66420 possible passwords
 
.EXAMPLE
 
C:\PS> Get-PasswordNumber -Characters alphabet -Numbers "1,2,3" -Symbols "$,*,&" -MinCharacters 2 -MaxCharacters 5
There are 34636800 possible passwords
 
.LINK
 
https://www.sconstantinou.com/powershell-module-dictionaryfile
#>


    [cmdletbinding()]

    param(
        [parameter(Mandatory = $true)][String[]]$Characters,
        [parameter(Mandatory = $true)][String[]]$Numbers,
        [parameter(Mandatory = $true)][String[]]$Symbols,
        [parameter(Mandatory = $true)][Uint32]$MinCharacters,
        [parameter(Mandatory = $true)][Uint32]$MaxCharacters,
        [switch]$IncludeCapital,
        [switch]$CapitalOnly)

    if ($MinCharacters -eq "0"){
        throw "MinCharacters value cannot zero."
    }

    if ($Characters -eq "alphabet"){
        $Characters = "a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u,v,w,x,y,z"
    }

    if ($CapitalOnly -eq $True){
        $Characters = $Characters.ToUpper()
    }

    if ($IncludeCapital -eq $True){
        $CharactersCapital = $Characters.ToUpper()
        $Characters = $Characters + $CharactersCapital
    }

    $AllCharacters = $Characters + $Numbers + $Symbols
    $pool = $AllCharacters -split ','
    $pool = $pool | Select-Object -Unique
    [Uint32]$n = $pool.count

    switch ($MinCharacters){
        {$_ -eq $MaxCharacters}{
            [Uint32]$n = $pool.count
            [Uint32]$r = $_
            [Double]$TotalPossibilities = [math]::Pow($n,$r)
            Write-Output "There are $TotalPossibilities possible passwords"
        }
        {$_ -gt $MaxCharacters}{
            throw "MinCharacters value cannot be greater than MaxCharacters value"
        }
        {$_ -lt $MaxCharacters}{
            [int]$TotalPossibilities = 0

            for ($i = $MinCharacters;$i -le $MaxCharacters; $i++){
                [Uint32]$n = $pool.count
                [Uint32]$r = $i
                [Double]$TempPossibilities = [math]::Pow($n,$r)
                [Double]$TotalPossibilities = $TotalPossibilities + $TempPossibilities
            }

            Write-Output "There are $TotalPossibilities possible passwords"
        }
    }
}
New-Alias -Name gpn -Value Get-PasswordNumber

Function Get-Password {

    Param(
        [Object[]]$FullSet,
        [String]$Comma,
        [Uint32]$CurrentIndex = 0,
        [String]$TemporaryText = "",
        [String]$OutFile)

    $MaximumIndex = $FullSet.Count - 1
    $FullSet[$CurrentIndex] |
        ForEach-Object {
            [Array]$Password = "$($TemporaryText)$($Comma)$($_)".Trim($Comma)

            If ($CurrentIndex -lt $MaximumIndex) {
                $Password = Get-Password $FullSet -CurrentIndex ($CurrentIndex + 1) -TemporaryText $Password -OutFile $OutFile
            }

            Add-Content -Path $OutFile -Value $Password
        }
}

function Get-DictionaryFile {
<#
.SYNOPSIS
 
Calculates, creates and saves the possbile passwords
 
.DESCRIPTION
 
Calculates the number of possible passwords based
on the input. After the calculations has been completed
it will need your confirmation to proceed with the creation
of the possible passwords. If you access it will create the
passwords and save them in a dictionary file.
 
.PARAMETER Characters
 
Specifies the letters that need to be included.
Parameter is mandatory.
 
.PARAMETER Numbers
 
Specifies the numbers that need to be included.
Parameter is mandatory.
 
.PARAMETER Symbols
 
Specifies the Symbols that need to be included.
Parameter is mandatory.
 
.PARAMETER MinCharacters
 
Specifies the minimum characters of the generated passwords.
Parameter is mandatory.
 
.PARAMETER MaxCharacters
 
Specifies the maximum characters of the generated passwords.
Parameter is mandatory.
 
.PARAMETER IncludeCapital
 
Specifies whether or not to include upper case letters along with
the lower case letters.
 
.PARAMETER CapitalOnly
 
Specifies whether or not all lower case letters to be converted to
upper case letters.
 
.PARAMETER Path
 
Specifies the path and file that generated passwords will be saved.
(Default: $HOME\DictionaryFiles\DictionaryFile.txt)
 
.INPUTS
 
None. You cannot pipe objects to Get-PasswordNumber.
 
.OUTPUTS
 
System.String. Get-PasswordNumber returns the generated password to
the specified file.
 
.EXAMPLE
 
C:\PS> Get-DictionaryFile -Characters "a,b,c" -Numbers "1" -Symbols "$" -MinCharacters 2 -MaxCharacters 5
There are 3900 possible passwords
Are you sure you want to create the dictionary file (y or n): y
WARNING: Folder 'C:\Users\stephanos.constantin\DictionaryFiles' does not exist.
Creating Folder 'C:\Users\stephanos.constantin\DictionaryFiles'...
Folder 'C:\Users\stephanos.constantin\DictionaryFiles' created.
File 'DictionaryFile.txt' does not exist in folder 'C:\Users\stephanos.constantin\DictionaryFiles'.
Creating File 'DictionaryFile.txt' in folder 'C:\Users\stephanos.constantin\DictionaryFiles'...
File 'DictionaryFile.txt' created in folder 'C:\Users\stephanos.constantin\DictionaryFiles'.
Generating passwords...
Dictionary File creation COMPLETED!!!
 
.EXAMPLE
 
C:\PS> Get-DictionaryFile -Characters "a,b,c" -Numbers "1" -Symbols "$" -MinCharacters 2 -MaxCharacters 5
There are 3900 possible passwords
Are you sure you want to create the dictionary file (y or n): n
 
.EXAMPLE
 
C:\PS> Get-DictionaryFile -Characters "a,b,c" -Numbers "1" -Symbols "$" -MinCharacters 2 -MaxCharacters 5 -Path C:\Scripts_Output\MyFile.txt
There are 3900 possible passwords
Are you sure you want to create the dictionary file (y or n): y
File 'MyFile.txt' does not exist in folder 'C:\Scripts_Output'.
Creating File 'MyFile.txt' in folder 'C:\Scripts_Output'...
File 'MyFile.txt' created in folder 'C:\Scripts_Output'.
Generating passwords...
Dictionary File creation COMPLETED!!!
 
.EXAMPLE
 
C:\PS> Get-DictionaryFile -Characters "a,b,c" -Numbers "1" -Symbols "$" -MinCharacters 2 -MaxCharacters 5 -IncludeCapital
There are 37440 possible passwords
Are you sure you want to create the dictionary file (y or n): y
WARNING: File 'DictionaryFile.txt' already exists in folder 'C:\Users\stephanos.constantin\DictionaryFiles'.
WARNING: Removing File 'DictionaryFile.txt' from folder 'C:\Users\stephanos.constantin\DictionaryFiles'...
File 'DictionaryFile.txt' removed from folder 'C:\Users\stephanos.constantin\DictionaryFiles'.
Creating new DictionaryFile.txt file in folder 'C:\Users\stephanos.constantin\DictionaryFiles'...
New 'DictionaryFile.txt' file created in folder 'C:\Users\stephanos.constantin\DictionaryFiles'.
Generating passwords...
Dictionary File creation COMPLETED!!!
 
.EXAMPLE
 
C:\PS> Get-DictionaryFile -Characters "a,b,c" -Numbers "1" -Symbols "$" -MinCharacters 2 -MaxCharacters 5 -CapitalOnly
There are 3900 possible passwords
Are you sure you want to create the dictionary file (y or n): y
WARNING: File 'DictionaryFile.txt' already exists in folder 'C:\Users\stephanos.constantin\DictionaryFiles'.
WARNING: Removing File 'DictionaryFile.txt' from folder 'C:\Users\stephanos.constantin\DictionaryFiles'...
File 'DictionaryFile.txt' removed from folder 'C:\Users\stephanos.constantin\DictionaryFiles'.
Creating new DictionaryFile.txt file in folder 'C:\Users\stephanos.constantin\DictionaryFiles'...
New 'DictionaryFile.txt' file created in folder 'C:\Users\stephanos.constantin\DictionaryFiles'.
Generating passwords...
Dictionary File creation COMPLETED!!!
 
.EXAMPLE
 
C:\PS> Get-DictionaryFile -Characters "a,b,c" -Numbers "1" -Symbols "$" -MinCharacters 2 -MaxCharacters 5
There are 34636800 possible passwords
Are you sure you want to create the dictionary file (y or n): y
WARNING: Folder 'C:\Users\stephanos.constantin\DictionaryFiles' does not exist.
Creating Folder 'C:\Users\stephanos.constantin\DictionaryFiles'...
Folder 'C:\Users\stephanos.constantin\DictionaryFiles' created.
File 'DictionaryFile.txt' does not exist in folder 'C:\Users\stephanos.constantin\DictionaryFiles'.
Creating File 'DictionaryFile.txt' in folder 'C:\Users\stephanos.constantin\DictionaryFiles'...
File 'DictionaryFile.txt' created in folder 'C:\Users\stephanos.constantin\DictionaryFiles'.
Generating passwords...
Dictionary File creation COMPLETED!!!
 
.LINK
 
https://www.sconstantinou.com/powershell-module-dictionaryfile
#>


    [cmdletbinding()]

    param(
        [parameter(Mandatory = $true)][String[]]$Characters,
        [parameter(Mandatory = $true)][String[]]$Numbers,
        [parameter(Mandatory = $true)][String[]]$Symbols,
        [parameter(Mandatory = $true)][Uint32]$MinCharacters,
        [parameter(Mandatory = $true)][Uint32]$MaxCharacters,
        [Switch]$IncludeCapital,
        [Switch]$CapitalOnly,
        [String]$Path = "$HOME\DictionaryFiles\DictionaryFile.txt")

    $PasswordSpecs = @{
        Characters = $Characters
        Numbers = $Numbers
        Symbols = $Symbols
        MinCharacters = $MinCharacters
        MaxCharacters = $MaxCharacters
        IncludeCapital = $IncludeCapital
        CapitalOnly = $CapitalOnly}

    Get-PasswordNumber @PasswordSpecs

    do{$UserConfirmation = Read-Host -Prompt 'Are you sure you want to create the dictionary file (y or n)'
        If (($UserConfirmation -ieq "n") -or ($UserConfirmation -ieq "y")){
            $UserInput = "Correct"
        }
        else{
            $UserInput = "Wrong"
            $Warning = "You have entered a wrong answer.Please enter y [YES] or n [NO]"
            Write-Warning $Warning
        }
    }
    while ($UserInput -eq "Wrong")

    if ($UserConfirmation -ieq "n"){Break}

    $Directory = Split-Path $Path
    $File = [System.IO.Path]::GetFileName($Path)

    if ($Characters -eq "alphabet"){
        $Characters = "a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u,v,w,x,y,z"
    }

    if ($CapitalOnly -eq $True){
        $Characters = $Characters.ToUpper()
    }

    if ($IncludeCapital -eq $True){
        $CharactersCapital = $Characters.ToUpper()
        $Characters = $Characters + $CharactersCapital
    }

    if (-not (Test-Path -Path $Directory -PathType Container)){
        Write-Warning "Folder '$Directory' does not exist."
        Write-Output "Creating Folder '$Directory'..."
        New-Item -Path $Directory -ItemType Directory -Force |
            Out-Null
        Write-Output "Folder '$Directory' created."
    }

    if (-not (Test-Path -Path $Path -PathType Leaf)){
        Write-Output "File '$File' does not exist in folder '$Directory'."
        Write-Output "Creating File '$File' in folder '$Directory'..."
        New-Item -Path $Directory -Name $File -ItemType File -Force |
            Out-Null
        Write-Output "File '$File' created in folder '$Directory'."
    }
    else{
        Write-Warning "File '$File' already exists in folder '$Directory'."
        Write-Warning "Removing File '$File' from folder '$Directory'..."
        Remove-Item -Path "$Path" -Force | Out-Null
        Write-Output "File '$File' removed from folder '$Directory'."
        Write-Output "Creating new $File file in folder '$Directory'..."
        New-Item -Path $Directory -Name $File -ItemType File -Force |
            Out-Null
        Write-Output "New '$File' file created in folder '$Directory'."
    }

    $AllCharacters = $Characters + $Numbers + $Symbols
    $pool = $AllCharacters -split ','
    [Array]$pool = $pool |
        Select-Object -Unique

    Write-Output "Generating passwords..."

    for ($i = $MinCharacters; $i -le $MaxCharacters; $i++){
        $Passwords = @()

        for ($p = 1;$p -le $i;$p++){
            [Object[]]$Passwords += ,$pool
        }

        Get-Password $Passwords -OutFile "$Path"
    }

    Write-Output "Dictionary File creation COMPLETED!!!"
}
New-Alias -Name gdf -Value Get-DictionaryFile