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
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
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 CharacterSet

Specifies the characters (letters, numbers, 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

System.String. Get-PasswordNumber can accept a string value to
determine the CharacterSet parameter.

.OUTPUTS

System.Double. Get-PasswordNumber returns the number of passwords that
can be created.

.EXAMPLE

PS C:\> Get-PasswordNumber -CharacterSet "a,b,c,1,2,3,$,*,&" -MinCharacters 2 -MaxCharacters 5
66420

.EXAMPLE

PS C:\> Get-PasswordNumber -Characters "a,b,c,1,2,3,$,*,&" -MinCharacters 2 -MaxCharacters 5 -IncludeCapital
271440

.EXAMPLE

PS C:\> Get-PasswordNumber -Characters "a,b,c,1,2,3,$,*,&" -MinCharacters 2 -MaxCharacters 5 -CapitalOnly
66420

.EXAMPLE

PS C:\> Get-PasswordNumber -Characters alphabet -MinCharacters 2 -MaxCharacters 5
12356604

.EXAMPLE

PS C:\> Get-PasswordNumber "av,b,c" -MinCharacters 2 -MaxCharacters 2
9

.EXAMPLE

PS C:\> "a,b,c" | Get-PasswordNumber -MinCharacters 2 -MaxCharacters 2
9

.EXAMPLE

PS C:\> Get-PasswordNumber -CharacterSet "ad,b,c" -MinCharacters 2 -MaxCharacters 2 | ForEach-Object {$_ * 2}
18

.LINK

https://www.sconstantinou.com/get-passwordnumber

.LINK

Get-PasswordCombination

.LINK

New-DictionaryFile

.LINK

Get-DictionaryFile
#>


    [cmdletbinding()]

    param(
        [parameter(Mandatory = $true,ValueFromPipeline = $true)][alias("c")][String]$CharacterSet,
        [parameter(Mandatory = $true)][alias("min")][Uint32]$MinCharacters,
        [parameter(Mandatory = $true)][alias("max")][Uint32]$MaxCharacters,
        [alias("ic")][switch]$IncludeCapital,
        [alias("co")][switch]$CapitalOnly)

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

    if ($CharacterSet -eq "alphabet"){
        $CharacterSet = "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){
        $CharacterSet = $CharacterSet.ToUpper()
    }

    if ($IncludeCapital -eq $True){
        $CharactersCapital = $CharacterSet.ToUpper()
        $CharacterSetLow = $CharacterSet
        $CharacterSet = ""
        $CharacterSet = $CharacterSetLow, $CharactersCapital -join ","
    }

    $pool = $CharacterSet -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 $TotalPossibilities
        }
        {$_ -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 $TotalPossibilities
        }
    }
}
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

    foreach ($_ in $FullSet[$CurrentIndex]){
        [Array]$Password = "$($TemporaryText)$($Comma)$($_)".Trim($Comma)

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

        if ($OutFile -eq ""){Write-Output $Password}
        else{Add-Content -Path $OutFile -Value $Password}
    }
}

function Get-PasswordCombination {
<#
.SYNOPSIS

Creates all possbile passwords

.DESCRIPTION

Creates all possible passowrds based on your input
and provides the results in output.

.PARAMETER CharacterSet

Specifies the characters (letters, numbers, 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

System.String. Get-PasswordCombination can accept a string value to
determine the CharacterSet parameter.

.OUTPUTS

System.String. Get-PasswordCombination returns the generated password.

.EXAMPLE

PS C:\> Get-PasswordCombination -CharacterSet "a,b,c" -MinCharacters 1 -MaxCharacters 2
a
b
c
aa
ab
ac
ba
bb
bc
ca
cb
cc

.EXAMPLE

PS C:\> Get-PasswordCombination -CharacterSet "a,b,c" -MinCharacters 1 -MaxCharacters 2 -IncludeCapital
a
b
c
A
B
C
aa
ab
ac
aA
aB
aC
ba
bb
bc
bA
bB
bC
ca
cb
cc
cA
cB
cC
Aa
Ab
Ac
AA
AB
AC
Ba
Bb
Bc
BA
BB
BC
Ca
Cb
Cc
CA
CB
CC

.EXAMPLE

PS C:\> Get-PasswordCombination -CharacterSet "a,b,c" -MinCharacters 1 -MaxCharacters 2 -CapitalOnly
A
B
C
AA
AB
AC
BA
BB
BC
CA
CB
CC

.EXAMPLE

PS C:\> Get-PasswordCombination -CharacterSet "alphabet" -MinCharacters 1 -MaxCharacters 3
a
b
c
d
e
f
g
h
i
j
k
l
m
n
...
xu
xv
xw
xx
xy
xz
ya
yb
yc
yd
ye
yf
yg
...
zzz

.EXAMPLE

PS C:\> Get-PasswordCombination "av,b,c" -MinCharacters 2 -MaxCharacters 2
avav
avb
avc
bav
bb
bc
cav
cb
cc

.EXAMPLE

PS C:\> "a,b,c" | Get-PasswordCombination -MinCharacters 2 -MaxCharacters 2
aa
ab
ac
ba
bb
bc
ca
cb
cc

.EXAMPLE

PS C:\> Get-PasswordCombination -CharacterSet "ad,b,c" -MinCharacters 3 -MaxCharacters 3 | Where-Object {$_ -like "*db*"}
adadb
adbad
adbb
adbc
badb
cadb


.LINK

https://www.sconstantinou.com/get-passwordcombination

.LINK

New-DictionaryFile

.LINK

Get-PasswordNumber

.LINK

Get-DictionaryFile
#>


    [cmdletbinding()]

    param(
        [parameter(Mandatory = $true,ValueFromPipeline = $true)][alias("c")][String]$CharacterSet,
        [parameter(Mandatory = $true)][alias("min")][Uint32]$MinCharacters,
        [parameter(Mandatory = $true)][alias("max")][Uint32]$MaxCharacters,
        [alias("ic")][Switch]$IncludeCapital,
        [alias("co")][Switch]$CapitalOnly)

    if ($CharacterSet -eq "alphabet"){
        $CharacterSet = "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){
        $CharacterSet = $CharacterSet.ToUpper()
    }

    if ($IncludeCapital -eq $True){
        $CharactersCapital = $CharacterSet.ToUpper()
        $CharacterSetLow = $CharacterSet
        $CharacterSet = ""
        $CharacterSet = $CharacterSetLow, $CharactersCapital -join ","
    }

    $pool = $CharacterSet -split ','
    [Array]$pool = $pool | Select-Object -Unique

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

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

        Get-Password $Passwords
    }
}
New-Alias -Name gpc -Value Get-PasswordCombination

function New-DictionaryFile {
<#
.SYNOPSIS

Creates a dictionary file.

.DESCRIPTION

Creates a dictionary file containing all possible
passwords that can be created based on your input.

.PARAMETER CharacterSet

Specifies the characters (letters, numbers, 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.
Parameter is mandatory.

.INPUTS

System.String. New-DictionaryFile can accept a string value to
determine the CharacterSet parameter.

.OUTPUTS

None. New-DictionaryFile will save all the generated passwords to
the specified path.

.EXAMPLE

PS C:\> New-DictionaryFile -CharacterSet "a,b,c,1,$" -MinCharacters 2 -MaxCharacters 5 -Path C:\Scripts_Output\MyFile.txt

.EXAMPLE

PS C:\> New-DictionaryFile -CharacterSet "a,b,c,1,$" -MinCharacters 2 -MaxCharacters 5 -IncludeCapital -Path C:\Scripts_Output\MyFile.txt

.EXAMPLE

PS C:\> New-DictionaryFile -CharacterSet "a,b,c,1,$" -MinCharacters 2 -MaxCharacters 5 -CapitalOnly -Path C:\Scripts_Output\MyFile.txt

.EXAMPLE

PS C:\> New-DictionaryFile -CharacterSet "alphabet" -MinCharacters 1 -MaxCharacters 3 -Path C:\Scripts_Output\MyFile.txt

.EXAMPLE

PS C:\> New-DictionaryFile "av,b,c" -MinCharacters 2 -MaxCharacters 2 -Path C:\Scripts_Output\MyFile.txt

.EXAMPLE

PS C:\> "a,b,c" | New-DictionaryFile -MinCharacters 2 -MaxCharacters 2 -Path C:\Scripts_Output\MyFile.txt

.LINK

https://www.sconstantinou.com/new-dictionaryfile

.LINK

Get-PasswordCombination

.LINK

Get-PasswordNumber

.LINK

Get-DictionaryFile
#>


    [cmdletbinding(SupportsShouldProcess, ConfirmImpact='Medium')]

    param(
        [parameter(Mandatory = $true,ValueFromPipeline = $true)][alias("c")][String]$CharacterSet,
        [parameter(Mandatory = $true)][alias("min")][Uint32]$MinCharacters,
        [parameter(Mandatory = $true)][alias("max")][Uint32]$MaxCharacters,
        [alias("ic")][Switch]$IncludeCapital,
        [alias("co")][Switch]$CapitalOnly,
        [parameter(Mandatory = $true)][alias("p")][String]$Path = "")

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

    if ($CharacterSet -eq "alphabet"){
        $CharacterSet = "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){
        $CharacterSet = $CharacterSet.ToUpper()
    }

    if ($IncludeCapital -eq $True){
        $CharactersCapital = $CharacterSet.ToUpper()
        $CharacterSetLow = $CharacterSet
        $CharacterSet = ""
        $CharacterSet = $CharacterSetLow, $CharactersCapital -join ","
    }

    if (-not (Test-Path -Path $Directory -PathType Container)){
        New-Item -Path $Directory -ItemType Directory -Force |
            Out-Null
    }

    if (-not (Test-Path -Path $Path -PathType Leaf)){
        New-Item -Path $Directory -Name $File -ItemType File -Force |
            Out-Null
    }
    else{
        Remove-Item -Path "$Path" -Force | Out-Null
        New-Item -Path $Directory -Name $File -ItemType File -Force |
            Out-Null
    }

    $pool = $CharacterSet -split ','
    [Array]$pool = $pool | Select-Object -Unique

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

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

        Get-Password $Passwords -OutFile "$Path"
    }
}
New-Alias -Name ndf -Value New-DictionaryFile

function Get-DictionaryFile {
<#
.SYNOPSIS

Imports a dictionary file

.DESCRIPTION

Imports a previously created dictionary file into
memory.

.PARAMETER CharacterSet

Specifies the characters (letters, numbers, symbols) that
need to be included. Parameter is mandatory.

.INPUTS

System.String. Get-DictionaryFile can accept a string value to
determine the path of the dictionary file.

.OUTPUTS

System.Array. Get-DictionaryFile will provide the passwords that
where included in the dictionary file in an array.

.EXAMPLE

PS C:\> Get-DictionaryFile -Path C:\Scripts\DictionaryFile.txt
aa
ab
ac
ba
bb
bc
ca
cb
cc

.EXAMPLE

PS C:\> "C:\Scripts\DictionaryFile.txt" | Get-DictionaryFile
aa
ab
ac
ba
bb
bc
ca
cb
cc

.EXAMPLE

PS C:\> Get-DictionaryFile -Path "C:\Scripts\DictionaryFile.txt" | ForEach-Object {$_ + "a"}
aaa
aba
aca
baa
bba
bca
caa
cba
cca

.EXAMPLE

PS C:\> "C:\Scripts\DictionaryFile.txt" | Get-DictionaryFile | Where-Object {$_ -like "*b*"}
ab
ba
bb
bc
cb

.LINK

https://www.sconstantinou.com/get-dictionaryfile

.LINK

Get-PasswordCombination

.LINK

Get-PasswordNumber

.LINK

New-DictionaryFile
#>


    [cmdletbinding()]

    param([parameter(Mandatory = $true,ValueFromPipeline = $true)][alias("p")][String]$Path)

    [Array]$DictionaryFile = Get-Content -Path $Path

    Write-Output $DictionaryFile
}
New-Alias -Name gdf -Value Get-DictionaryFile