Module/Common/Convert/Function.RangeConversion.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
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
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
#region Header
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License.
#endregion
#region Main Functions
<#
    .SYNOPSIS
        This function is a selection function that looks at text containing conditional language and
        tries to identify the correct specialized function to set it to for conversion. The conversion
        functions called by this function do the English to PowerShell conversion.
 
    .PARAMETER String
        The STIG text contains conditional text to try and convert to a PowerShell expression.
 
    .NOTES
        General Notes
#>

function Get-OrganizationValueTestString
{
    [CmdletBinding()]
    [OutputType([string])]
    param
    (
        [Parameter(Mandatory = $true)]
        [string]
        $String
    )

    switch ($string)
    {
        {Test-StringIsNegativeOr -String $PSItem}
        {
            ConvertTo-OrTestString -String $PSItem -Operator NotMatch
            continue
        }
        {Test-StringIsPositiveOr -String $PSItem}
        {
            ConvertTo-OrTestString -String $PSItem -Operator Match
            continue
        }
        {
            (Test-StringIsLessThan -String $PSItem)                 -or
            (Test-StringIsLessThanOrEqual -String $PSItem)          -or
            (Test-StringIsLessThanButNot -String $PSItem)           -or
            (Test-StringIsLessThanOrEqualButNot -String $PSItem)    -or
            (Test-StringIsLessThanOrEqualExcluding -String $PSItem) -or
            (Test-StringIsGreaterThan -String $PSItem)              -or
            (Test-StringIsGreaterThanOrEqual -String $PSItem)       -or
            (Test-StringIsGreaterThanButNot -String $PSItem)        -or
            (Test-StringIsGreaterThanOrEqualButNot -String $PSItem) -or
            (Test-StringIsBetweenTwoValues -String $PSItem)         -or
            (Test-StringHasOneValueOrDoesntExist -String $PSItem)
        }
        {
            ConvertTo-TestString -String $PSItem
            continue
        }
        {Test-StringIsMultipleValue -String $PSItem}
        {
            ConvertTo-MultipleValue -String $PSItem
            continue
        }
    }
}

function Get-TestStringTokenNumbers
{
    [CmdletBinding()]
    [OutputType([string[]])]
    param
    (
        [Parameter(Mandatory = $true)]
        [string]
        $String
    )

    <#
        Some strings contain double quotes around numbers. This causes the
        PSParser to return them as a string vs a number, so the double quotes
        are stripped out before being parsed.
    #>

    $string = $String -replace '"',''

    $tokens = [System.Management.Automation.PSParser]::Tokenize($string, [ref]$null)
    $number = $tokens.Where({$PSItem.type -eq 'Number'}).Content
    <#
        There is an edge case where the hex and decimal values are provided inline, so pick
        the hex code out and convert it to an int.
    #>

    $match = $number | Select-String -Pattern "\b(0x[A-Fa-f0-9]{8}){1}\b"

    if ($match)
    {
        if ($number.count -gt 2)
        {
            $number[1, 2]
        }
        else
        {
            [convert]::ToInt32($match,16)
        }
    }
    else
    {
        $number
    }
}

<#
    .SYNOPSIS
        Uses the PowerShell parser to tokenize the English sentences into individual words that are
        regrouped and complied into PS representations that can be applied and measured automatically.
#>

function Get-TestStringTokenList
{
    [CmdletBinding(DefaultParameterSetName = 'CommandTokens')]
    [OutputType([string])]
    param
    (
        [Parameter(Mandatory = $true)]
        [string]
        $String,

        [Parameter(ParameterSetName = 'CommandTokens')]
        [switch]
        $CommandTokens,

        [Parameter(ParameterSetName = 'StringTokens')]
        [switch]
        $StringTokens
    )

    $tokens = [System.Management.Automation.PSParser]::Tokenize($string, [ref]$null)

    if ($PSCmdlet.ParameterSetName -eq 'StringTokens')
    {
        return $tokens.Where({ $PSItem.type -eq 'String' }).Content
    }

    $commands = $tokens.Where({
            $PSItem.type -eq 'CommandArgument' -or
            $PSItem.type -eq 'Command' }).Content
    return ( $commands -join " " )
}

function ConvertTo-TestString
{
    [CmdletBinding()]
    [OutputType([string])]
    param
    (
        [Parameter(Mandatory = $true)]
        [string]
        $String
    )
    $number    = Get-TestStringTokenNumbers -String $string
    $operators = Get-TestStringTokenList -String $string -CommandTokens

    switch ($operators)
    {
        'greater than'
        {
            return "'{0}' -gt '$number'"
        }
        'or greater'
        {
            return "'{0}' -ge '$number'"
        }
        'greater than but not'
        {
            return "'{0}' -gt '$($number[0])' -and '{0}' -lt '$($number[1])'"
        }
        'or greater but not'
        {
            return "'{0}' -ge '$($number[0])' -and '{0}' -lt '$($number[1])'"
        }
        'less than'
        {
            return "'{0}' -lt '$number'"
        }
        'or less'
        {
            return "'{0}' -le '$number'"
        }
        'less than but not'
        {
            return "'{0}' -lt '$($number[0])' -and '{0}' -gt '$($number[1])'"
        }
        'or less but not'
        {
            return "'{0}' -le '$($number[0])' -and '{0}' -gt '$($number[1])'"
        }
        {$PSItem -match 'or less excluding'}
        {
            return "'{0}' -le '$($number[0])' -and '{0}' -gt '$($number[1])'"
        }
        'and'
        {
            return "'{0}' -ge '$($number[0])' -and '{0}' -le '$($number[1])'"
        }
        {$PSItem -match 'or if the Value Name does not exist'}
        {
            return "'{0}' -match '$($number[0])|ShouldBeAbsent'"
        }
        'through'
        {
            return "{0} -ge '$($number[0])' -and {0} -le '$($number[1])'"
        }
    }
}

<#
    .SYNOPSIS
        Converts a Rule to a hashtable so it can be splatted to other functions
 
    .PARAMETER InputObject
        The object being converted
 
    .NOTES
        There are multiple rules in the DNS STIG that enforce the same setting. If a duplicate rule is found
        it is converted to a documentRule
#>

function ConvertTo-HashTable
{
    [CmdletBinding()]
    [OutputType([hashtable])]
    param
    (
        [object] $InputObject
    )

    $hashTable = @{
        Id       = $InputObject.id
        Severity = $InputObject.Severity
        Title    = $InputObject.title
    }

    return $hashTable
}
#endregion
#region Or
<#
    .SYNOPSIS
        Checks if a string is asking for a negative or evaluation. Applies a regular expression against
        the string to look for a known pattern asking for a value to not be equal to one of 2 values.
 
    .PARAMETER String
        The string data to evaluate.
 
    .EXAMPLE
        This example returns $true
 
        Test-StringIsNegativeOr -String "1 or 2 = a Finding"
 
    .EXAMPLE
        This example returns $false
 
        Test-StringIsNegativeOr -String "1 or 2 = is not a Finding"
 
    .NOTES
        Tests if a string such as '1 or 2 = a Finding' is a negative or test.
#>

function Test-StringIsNegativeOr
{
    [CmdletBinding()]
    [OutputType([bool])]
    param
    (
        [Parameter(Mandatory = $true)]
        [string]
        $String
    )

    #
    if ($string -match "^(\s*)(\d{1,})(\s*)or(\s*)(\d{1,})(\s*)=(\s*)a(\s*)Finding(\s*)$")
    {
        $true
    }
    else
    {
        $false
    }
}

<#
    .SYNOPSIS
        Checks if a string is asking for a positive or evaluation. Applies a regular expression against
        the string to look for a known pattern asking for a value to be equal to one of 2 values.
 
    .PARAMETER string
        The string data to evaluate.
 
    .EXAMPLE
        An example
 
    .NOTES
        # This regex looks for patterns such as "1 (Lock Workstation) or 2 (Force Logoff)"
#>

function Test-StringIsPositiveOr
{
    [CmdletBinding()]
    [OutputType([bool])]
    param
    (
        [Parameter(Mandatory = $true)]
        [string]
        $String
    )

    <#
        Optional characters were seperated from the rest of the RegEx because it is a repeating
        pattern. If new characters are discovered in the future, they can be added here and in
        the tests.
    #>

    $optionalCharacter = "(\(|'|"")?"

    $regex = "^(\s*)(\d{1,})(\s*)$optionalCharacter.*$optionalCharacter" +
             "(\s*)or(\s*)(\d{1,})(\s*)$optionalCharacter.*$optionalCharacter(\s*)$"

    if ($string -match $regex)
    {
        $true
    }
    else
    {
        $false
    }
}

<#
    .SYNOPSIS
        Converts English textual representation of a comparison to a PowerShell code representation.
 
    .DESCRIPTION
        Using the Abstract Syntax Tree capability of PowerShell, the provided string is broken into
        individual AST Tokens. Those tokens are then combined to form the PowerShell version of the
        English text.
 
        The output of this function is intended to be added to any STIG rule that is ambiguous due to
        a range of possibilities be valid. The test string is used to determine if a local
        organizational setting is within a valid range according to the STIG.
 
    .PARAMETER String
        The string to convert
 
    .EXAMPLE
        This example returns the following comparison test
 
            -ne '1|2'
 
        ConvertTo-OrTestString -String '1 or 2 = a Finding' -Operator NotEqual
 
    .EXAMPLE
        This example returns the following comparison test
 
            -eq '1|2'
 
        ConvertTo-OrTestString -String '1 (Lock Workstation) or 2 (Force Logoff)' -Operator Equal
 
    .NOTES
        General notes
#>

function ConvertTo-OrTestString
{
    [CmdletBinding()]
    [OutputType([string])]
    param
    (
        [Parameter(Mandatory = $true)]
        [string]
        $String,

        [Parameter(Mandatory = $true)]
        [ValidateSet('Match', 'NotMatch')]
        [String]
        $Operator
    )

    $operatorString = @{
        'Match'    = '-match'
        'NotMatch' = '-notmatch'
    }

    try
    {
        $tokens = [System.Management.Automation.PSParser]::Tokenize($string, [ref]$null)
        $orgSettings = $tokens.Where( {$PSItem.type -eq 'Number' -and $PSItem.Content -notmatch '\dx\d{8}' }).Content
        if ($string -match 'or if the Value Name does not exist')
        {
            $orgSettings += 'ShouldBeAbsent'
        }
        "'{0}' $($operatorString[$Operator]) '$($orgSettings -join "|")'"
    }
    catch
    {
        Throw "Unable to convert $string into test string."
    }
}
#endregion
#region Greater Than

<#
    .SYNOPSIS
        Converts English textual representation of numeric ranges into PowerShell equivalent
        comparison statements.
 
    .PARAMETER string
        The String to test.
 
    .EXAMPLE
        This example returns $true
 
        Test-StringIsGreaterThan -String '14 (or greater)'
 
    .NOTES
        Sample STIG data would convert
#>

function Test-StringIsGreaterThan
{
    [CmdletBinding()]
    [OutputType([bool])]
    param
    (
        [Parameter(Mandatory = $true)]
        [string]
        $String
    )

    if ($string -match "^(\s*)Greater(\s*)than(\s*)(\d{1,})(\s*)$")
    {
        $true
    }
    else
    {
        $false
    }
}

<#
    .SYNOPSIS
        Converts English textual representation of numeric ranges into PowerShell equivalent
        comparison statements.
 
    .PARAMETER string
        The String to test.
 
    .EXAMPLE
        This example returns $true
 
        Test-StringIsGreaterThanOrEqual -String '0x00000032 (50) (or greater)'
 
    .NOTES
        Sample STIG data would convert 0x00000032 (50) (or greater) into '-ge 50'"
#>

function Test-StringIsGreaterThanOrEqual
{
    [CmdletBinding()]
    [OutputType([bool])]
    param
    (
        [Parameter(Mandatory = $true)]
        [string]
        $String
    )

    if ($string -match "^(\s*)((0x[A-Fa-f0-9]{8}){1})|(\d{1,})(\s*)(\()?or(\s*)greater(\s*)(\))?(\s*)$")
    {
        $true
    }
    else
    {
        $false
    }
}

<#
    .SYNOPSIS
        Converts English textual representation of numeric ranges into PowerShell equivalent
        comparison statements.
 
    .PARAMETER string
        The String to test.
 
    .EXAMPLE
        This example returns $true
 
        Test-StringIsGreaterThanButNot -String 'Greater than 30'
 
    .NOTES
        Sample STIG data would convert 30 (or greater, but not 100)
#>

function Test-StringIsGreaterThanButNot
{
    [CmdletBinding()]
    [OutputType([bool])]
    param
    (
        [Parameter(Mandatory = $true)]
        [string]
        $String
    )

    if ($string -match "^(\s*)greater(\s*)than(\s*)(\d{1,})(\s*)(\()?(\s*)but(\s*)not(\s*)(\d{1,})(\))?(\s*)$")
    {
        $true
    }
    else
    {
        $false
    }
}
#endregion
#region Between Two Values
<#
    .SYNOPSIS
        Converts English textual representation of numeric ranges into PowerShell equivalent
        comparison statements.
 
    .PARAMETER string
        The String to test.
 
    .EXAMPLE
        This example returns $true
 
        Test-StringIsBetweenTwoValues -String '1' and '132'
 
    .NOTES
        Sample STIG data
#>

function Test-StringIsBetweenTwoValues
{
    [CmdletBinding()]
    [OutputType([bool])]
    param
    (
        [Parameter(Mandatory = $true)]
        [string]
        $String
    )

    if ($string -match "([3-8][0-9]|9[0-9]|1[0-2][0-9]|13[0-2]|[0-7])")
    {
        $true
    }
    else
    {
        $false
    }
}
<#
    .SYNOPSIS
        Converts English textual representation of numeric ranges into PowerShell equivalent
        comparison statements.
 
    .PARAMETER string
        The String to test.
 
    .EXAMPLE
        This example returns $true
 
        Test-StringHasOneValueOrDoesntExist -String '30' or 'or if the Value Name does not exist'
 
    .NOTES
        Sample STIG data
#>

function Test-StringHasOneValueOrDoesntExist
{
    [CmdletBinding()]
    [OutputType([bool])]
    param
    (
        [Parameter(Mandatory = $true)]
        [string]
        $String
    )

    if ($string -match "^[0-9] \(or if the Value Name does not exist\)")
    {
        $true
    }
    else
    {
        $false
    }
}
#endregion
#region GreaterThanorEqual
<#
    .SYNOPSIS
        Converts English textual representation of numeric ranges into PowerShell equivalent
        comparison statements.
 
    .PARAMETER string
        The String to test.
 
    .EXAMPLE
        This example returns $true
 
        Test-StringIsGreaterThanOrEqualToButNot -String '0x00000032 (50) (or greater)'
 
    .NOTES
        Sample STIG data
#>

function Test-StringIsGreaterThanOrEqualButNot
{
    [CmdletBinding()]
    [OutputType([bool])]
    param
    (
        [Parameter(Mandatory = $true)]
        [string]
        $String
    )

    if ($string -match "^(\s*)(\d{1,})(\s*)(\()?(\s*)or(\s*)greater(\s*),(\s*)but(\s*)not(\s*)(\d{1,})(\))?(\s*)$")
    {
        $true
    }
    else
    {
        $false
    }
}
#endregion
#region Less Than
<#
    .SYNOPSIS
        Converts English textual representation of numeric ranges into PowerShell equivalent
        comparison statements.
 
    .PARAMETER string
        The String to test.
 
    .EXAMPLE
        This example returns $true
 
        Test-StringIsLessThan -String 'is less than "14"'
#>

function Test-StringIsLessThan
{
    [CmdletBinding()]
    [OutputType([bool])]
    param
    (
        [Parameter(Mandatory = $true)]
        [string]
        $String
    )

    if ($string -match "^(\s*)less(\s*)than(\s*)(\d{1,})(\))?(\s*)$")
    {
        $true
    }
    else
    {
        $false
    }
}

<#
    .SYNOPSIS
        Converts English textual representation of numeric ranges into PowerShell equivalent
        comparison statements.
 
    .PARAMETER string
        The String to test.
 
    .EXAMPLE
        This example returns $true
 
        Test-StringIsLessThanOrEqual -String '"4" logons or less'
#>

function Test-StringIsLessThanOrEqual
{
    [CmdletBinding()]
    [OutputType([bool])]
    param
    (
        [Parameter(Mandatory = $true)]
        [string]
        $String
    )
    # Turn 0x00000384 (900) (or less) into '-le 900'
    if ($string -match "^((\s*)((0x[A-Fa-f0-9]{8}){1}))?(\s*)(\()?(\d{1,})(\))?(\s*)(\()?or(\s*)less(\))?(\s*)$")
    {
        $true
    }
    else
    {
        $false
    }
}

<#
    .SYNOPSIS
        Converts English textual representation of numeric ranges into PowerShell equivalent
        comparison statements.
 
    .PARAMETER string
        The String to test.
 
    .EXAMPLE
        This example returns $true
 
        Test-StringIsLessThanButNot -String 'Less than 30 (but not 0)'
 
    .NOTES
        Sample STIG data would convert "Less than 30 (but not 0)" into '$i -lt "30" -and $i -gt 0'
#>

function Test-StringIsLessThanButNot
{
    [CmdletBinding()]
    [OutputType([bool])]
    param
    (
        [Parameter(Mandatory = $true)]
        [string]
        $String
    )

    #"$i -lt $value -and -ne $x"

    if ($string -match "^(\s*)less(\s*)than(\s*)(\d{1,})(\s*)(\()?but(\s*)not(\s*)(\d{1,})(\))?(\s*)$")
    {
        $true
    }
    else
    {
        $false
    }
}

<#
    .SYNOPSIS
        Converts English textual representation of numeric ranges into PowerShell equivalent
        comparison statements.
 
    .PARAMETER string
        The String to test.
 
    .EXAMPLE
        This example returns $true
 
        Test-StringIsLessThanOrEqualToButNot -String '30 (or less, but not 0)'
 
    .EXAMPLE
        This example returns $true
 
        Test-StringIsLessThanOrEqualToButNot -String '0x0000001e (30) (or less, but not 0)'
 
    .NOTES
        Sample STIG data would convert 30 (or less, but not 0) into '$i -le "30" -and $i -gt 0'
        Sample STIG data would convert 0x0000001e (30) (or less, but not 0) into '$i -le "30" -and $i -gt 0'
#>

function Test-StringIsLessThanOrEqualButNot
{
    [CmdletBinding()]
    [OutputType([bool])]
    param
    (
        [Parameter(Mandatory = $true)]
        [string]
        $String
    )

    if ($string -match "^(\s*)(\d{1,})(\s*)(\()?or(\s*)less(\s*),(\s*)but(\s*)not(\s*)(\d{1,})(\))?(\s*)$" -or
        $string -match "(\s*)(\()(\d{1,})(\))(\s*)(\()?or(\s*)less(\s*),(\s*)but(\s*)not(\s*)(\d{1,})(\))?(\s*)$")
    {
        $true
    }
    else
    {
        $false
    }
}
<#
    .SYNOPSIS
        Converts English textual representation of numeric ranges into PowerShell equivalent
        comparison statements.
 
    .PARAMETER string
        The String to test.
 
    .EXAMPLE
        This example returns $true
 
        Test-StringIsLessThanOrEqualExcluding -String '0x0000001e (30) (or less, excluding 0)'
 
    .NOTES
        Sample STIG data would convert 0x0000001e (30) (or less, excluding 0) into '$i -le "30" -and $i -gt 0'
#>

function Test-StringIsLessThanOrEqualExcluding
{
    [CmdletBinding()]
    [OutputType([bool])]
    param
    (
        [Parameter(Mandatory = $true)]
        [string]
        $String
    )

    if ($string -match "(\s*)(\()?(\d{1,})(\))?(\s*)(\()?or(\s*)less(\s*),(\s*)excluding(\s*)(\d{1,})(\))?(\s*)$")
    {
        $true
    }
    else
    {
        $false
    }
}
#endregion
#region Multiple Values
<#
    .SYNOPSIS
        Test if the string may contain multiple setting values
 
    .PARAMETER String
        The string to test
 
    .EXAMPLE
        This example returns $true
 
        Test-StringIsMultipleValue -String 'Possible values are orange, lemon, cherry'
#>

function Test-StringIsMultipleValue
{
    [CmdletBinding()]
    [OutputType([bool])]
    param
    (
        [Parameter(Mandatory = $true)]
        [string]
        $String
    )

    if ($string -match "(?<=Possible values are ).*")
    {
        $true
    }
    else
    {
        $false
    }
}

<#
    .SYNOPSIS
        Returns the possible setting values
 
    .PARAMETER String
        The string to test
 
    .EXAMPLE
        This example returns "{0} -match 'orange|lemon|cherry'""
 
    ConvertTo-MultipleValue -String 'Possible values are orange, lemon, cherry'
#>

function ConvertTo-MultipleValue
{
    [CmdletBinding()]
    [OutputType([string])]
    param
    (
        [Parameter(Mandatory)]
        [string[]]
        $String
    )

    $values = [regex]::match( $string, "(?<=Possible values are ).*" ).groups.Value
    $options = $values.replace(', ', '|')

    Write-Verbose "[$($MyInvocation.MyCommand.Name)] Possible Values : $options "

    return $( "'{0}' -match '^($options)$'" )
}
#endregion
#region Security Policy
<#
    .SYNOPSIS
        Selects the string that contains the policy setting and value(s)
#>

function Get-SecurityPolicyString
{
    [CmdletBinding()]
    [OutputType([string])]
    param
    (
        [Parameter(Mandatory = $true)]
        [AllowEmptyString()]
        [string[]]
        $CheckContent
    )

    Write-Verbose "[$($MyInvocation.MyCommand.Name)]"
    $stringMatch = '(If the (value for (the)?)?|(value\s))|(If.*".*" is )'
    $result = ( $checkContent | Select-String -Pattern $stringMatch ) -replace $stringMatch, ''
    # 'V-63427' (Win10) returns multiple matches. This is ensure the only the correct one is returned.
    $result = $result | Where-Object -FilterScript {$PSItem -notmatch 'site is using a password filter'}
    # V-73317 (WinSvr 2016) returns multiple matches, but we want both joined to calculate the range.
    $result = ($result -join " or ").Trim()
    return $result
}

<#
    .SYNOPSIS
        Checks the string for text that indicates a range of acceptable
        acceptable values are allowed by the STIG.
#>

function Test-SecurityPolicyContainsRange
{
    [CmdletBinding()]
    [OutputType([bool])]
    param
    (
        [Parameter(Mandatory = $true)]
        [AllowEmptyString()]
        [string[]]
        $CheckContent
    )

    Write-Verbose "[$($MyInvocation.MyCommand.Name)]"

    $string = Get-SecurityPolicyString -CheckContent $checkContent
    $string = Get-TestStringTokenList -String $string

    # This array is joined into an or '|' before being evaluated
    $matchList = @(
        '(?:is not set to )(?!(?:(a )other than)).*(?:this is a finding\.)',
        '(the value is .*this is a finding)',
        '((enabled|not(?: enabled)?) this is a finding)',
        '((column .*)|(for this option .*)this is a finding)'
    )

    if ( $string -match ($matchList -join '|') )
    {
        return $false
    }

    return $true
}

<#
    .SYNOPSIS
        Converts the Check-Content string into a PowerShell comparison string that can validate
        user input to organizational values.
#>

function Get-SecurityPolicyOrganizationValueTestString
{
    [CmdletBinding()]
    param
    (
        [Parameter(Mandatory = $true)]
        [AllowEmptyString()]
        [string[]]
        $CheckContent
    )

    Write-Verbose "[$($MyInvocation.MyCommand.Name)]"

    $stringBase = Get-SecurityPolicyString -CheckContent $CheckContent
    $string = Get-TestStringTokenList -String $stringBase -CommandTokens
    $settings = Get-TestStringTokenList -String $stringBase -StringTokens

    $reverse = @{
        'lt' = 'ge';
        'le' = 'gt';
        'gt' = 'le';
        'ge' = 'lt';
        'eq' = 'ne';
        'ne' = 'eq'
    }

    # The index string to add to the comparison for use in composite formatting.
    $indexString = "'{0}'"
    # The variable needs to be strongly typed for the indexing to work properly, when a single operator is found.
    # If not strongly typed, a single operator will return indexed characters.
    [string[]] $operators = @()
    # Some of the sentence structure is inverted, so this flag will realign the sentence structure so that that range operator
    # Is always before the eq|ne operators.
    $invertAdjective = $false
    # Some of the ranges have exclusions, so the comparison operator should not be inverted and this flag controls that.
    $excludeSecondAdjective = $false

    switch ($string)
    {
        {$string -match '^is set to'}
        {
            $operators = 'eq'
        }
        {$string -match '^is less than(?!.*excluding)'}
        {
            $operators = 'lt'; continue
        }
        {$string -match '^is less than(?=.*excluding)'}
        {
            $operators = 'lt', 'or', 'eq'; $excludeSecondAdjective = $true; continue
        }
        {$string -match '^is greater than(?!.*(excluding|is set))'}
        {
            $operators = 'gt'; continue
        }
        {$string -match '^is greater than.*(?=is set)'}
        {
            $operators = 'gt', 'and', 'eq'; continue
        }
        # The InvertAdjective changes the string to read 'is more than or' to move the equal to the second position like everything else.
        {$string -match '^is or (more|greater) than'}
        {
            $operators = 'gt', 'and', 'eq'; $invertAdjective = $true; continue
        }
        {$string -match '^is not set to a other than'}
        {
            $operators = 'eq'
        }
    }

    # Since the sentence was inverted, the value positions need to be inverted as well.
    if ($invertAdjective)
    {
        $firstValue = $settings[2]
        $secondValue = $settings[1]
    }
    else
    {
        $firstValue = $settings[1]
        $secondValue = $settings[2]
    }

    # Some settings are negated with the string 'this is a finding, so invert the comparison operators if the check is negated.
    if ($string -match 'this is a finding')
    {
        # If a string contains and/or build that into the test string operators
        if ($operators.count -gt '1')
        {
            # Some settings have values that need to be excluded from a range, so do not invert that operator
            if ($excludeSecondAdjective)
            {
                "$indexString -$($reverse[$operators[0]]) '$firstValue' -$($operators[1]) $indexString -$($operators[2]) '$secondValue'"
            }
            else
            {
                "$indexString -$($reverse[$operators[0]]) '$firstValue' -$($operators[1]) $indexString -$($reverse[$operators[2]]) '$secondValue'"
            }
        }
        else
        {
            "$indexString -$($reverse[$operators[0]]) '$firstValue'"
        }
    }
    else
    {
        "$indexString -$operators '$firstValue'"
    }
}
#endregion