forked from ESAPI/esapi-java-legacy
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathValidator.java
More file actions
1066 lines (985 loc) · 51 KB
/
Copy pathValidator.java
File metadata and controls
1066 lines (985 loc) · 51 KB
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
/**
* OWASP Enterprise Security API (ESAPI)
*
* This file is part of the Open Web Application Security Project (OWASP)
* Enterprise Security API (ESAPI) project. For details, please see
* <a href="http://www.owasp.org/index.php/ESAPI">http://www.owasp.org/index.php/ESAPI</a>.
*
* Copyright (c) 2007 - The OWASP Foundation
*
* The ESAPI is published by OWASP under the BSD license. You should read and accept the
* LICENSE before you use, modify, and/or redistribute this software.
*
* @author Jeff Williams <a href="http://www.aspectsecurity.com">Aspect Security</a>
* @created 2007
*/
package org.owasp.esapi;
import java.io.File;
import java.io.InputStream;
import java.net.URI;
import java.text.DateFormat;
import java.util.Date;
import java.util.List;
import java.util.Set;
import javax.servlet.http.HttpServletRequest;
import org.owasp.esapi.errors.IntrusionException;
import org.owasp.esapi.errors.ValidationException;
/**
* The Validator interface defines a set of methods for canonicalizing and
* validating untrusted input. Implementors should feel free to extend this
* interface to accommodate their own data formats. Rather than throw exceptions,
* this interface returns boolean results because not all validation problems
* are security issues. Boolean returns allow developers to handle both valid
* and invalid results more cleanly than exceptions.
* <P>
* Implementations must adopt a "whitelist" approach to validation where a
* specific pattern or character set is matched. "Blacklist" approaches that
* attempt to identify the invalid or disallowed characters are much more likely
* to allow a bypass with encoding or other tricks.
*
* @author Jeff Williams (jeff.williams .at. aspectsecurity.com) <a
* href="http://www.aspectsecurity.com">Aspect Security</a>
* @since June 1, 2007
*/
public interface Validator {
/**
* Add a validation rule to the registry using the "type name" of the rule as the key.
*/
void addRule( ValidationRule rule );
/**
* Get a validation rule from the registry with the "type name" of the rule as the key.
*/
ValidationRule getRule( String name );
/**
* Returns true if canonicalized input is valid.
* <p>
* Calls {@link #getValidInput(String, String, String, int, boolean, boolean)} with {@code canonicalize=true}
* and returns true if no exceptions are thrown.
*
* @throws IntrusionException Input likely indicates an attack.
*/
boolean isValidInput(String context, String input, String type, int maxLength, boolean allowNull) throws IntrusionException;
/**
* Returns true if canonicalized input is valid,
* any validation exceptions are added to the supplied {@code errorList}.
* <p>
* Calls {@link #getValidInput(String, String, String, int, boolean, boolean)} with {@code canonicalize=true}
* and returns true if no exceptions are thrown.
*
* @throws IntrusionException Input likely indicates an attack.
*/
boolean isValidInput(String context, String input, String type, int maxLength, boolean allowNull, ValidationErrorList errorList) throws IntrusionException;
/**
* Returns true if {@code input} is valid.
* <p>
* Calls {@link #getValidInput(String, String, String, int, boolean, boolean)}
* and returns true if no exceptions are thrown.
*
* @throws IntrusionException Input likely indicates an attack.
*/
boolean isValidInput(String context, String input, String type, int maxLength, boolean allowNull, boolean canonicalize) throws IntrusionException;
/**
* Returns true if {@code input} is valid,
* any validation exceptions are added to the supplied {@code errorList}.
* <p>
* Calls {@link #getValidInput(String, String, String, int, boolean, boolean)}
* and returns true if no exceptions are thrown.
*
* @throws IntrusionException Input likely indicates an attack.
*/
boolean isValidInput(String context, String input, String type, int maxLength, boolean allowNull, boolean canonicalize, ValidationErrorList errorList) throws IntrusionException;
/**
* Returns validated canonicalized {@code input} as a String.
* <p>
* Calls {@link #getValidInput(String, String, String, int, boolean, boolean)}
* with {@code canonicalize=true}.
*
* @throws ValidationException Input is invalid.
* @throws IntrusionException Input likely indicates an attack.
*/
String getValidInput(String context, String input, String type, int maxLength, boolean allowNull) throws ValidationException, IntrusionException;
/**
* Returns validated {@code input} as a String with optional canonicalization.
* <p>
* Invalid input will generate a descriptive ValidationException,
* and input that is clearly an attack will generate a descriptive IntrusionException.
*
* @param context
* A descriptive name of the parameter that you are validating (e.g., LoginPage_UsernameField).
* This value is used by any logging or error handling that is done with respect to the value passed in.
* @param input
* The actual user input data to validate.
* @param type
* The regular expression name which maps to the actual regular expression from "ESAPI.properties".
* @param maxLength
* The maximum post-canonicalized String length allowed.
* @param allowNull
* If {@code allowNull} is true then an input that is NULL or an empty string will be legal.
* If {@code allowNull} is false then NULL or an empty String will throw a ValidationException.
* @param canonicalize
* If canonicalize is true then input will be canonicalized before validation.
*
* @return The canonicalized user input.
*
* @throws ValidationException Input is invalid.
* @throws IntrusionException Input likely indicates an attack.
*/
String getValidInput(String context, String input, String type, int maxLength, boolean allowNull, boolean canonicalize) throws ValidationException, IntrusionException;
/**
* Returns canonicalized validated {@code input} as a String,
* and adds validation exceptions to the supplied {@code errorList}.
* <p>
* Calls {@link #getValidInput(String, String, String, int, boolean, boolean)}.
*
* @throws IntrusionException Input likely indicates an attack.
*/
String getValidInput(String context, String input, String type, int maxLength, boolean allowNull, ValidationErrorList errorList) throws IntrusionException;
/**
* Returns validated {@code input} as a String with optional canonicalization,
* and adds validation exceptions to the supplied {@code errorList}.
* <p>
* Returns the result of calling {@link #getValidInput(String, String, String, int, boolean, boolean)}
* with {@code canonicalize=true}.
*
* @throws IntrusionException Input likely indicates an attack.
*/
String getValidInput(String context, String input, String type, int maxLength, boolean allowNull, boolean canonicalize, ValidationErrorList errorList) throws IntrusionException;
/**
* Returns true if {@code input} is valid.
* <p>
* Calls {@link #getValidDate(String, String, DateFormat, boolean)},
* and returns true if no exceptions are thrown.
*
* @throws IntrusionException Input likely indicates an attack.
*/
boolean isValidDate(String context, String input, DateFormat format, boolean allowNull) throws IntrusionException;
/**
* Returns true if {@code input} is valid,
* any validation exceptions are added to the supplied {@code errorList}.
* <p>
* Calls {@link #getValidDate(String, String, DateFormat, boolean)}
* and returns true if no exceptions are thrown.
*
* @throws IntrusionException Input likely indicates an attack.
*/
boolean isValidDate(String context, String input, DateFormat format, boolean allowNull, ValidationErrorList errorList) throws IntrusionException;
/**
* Returns a valid date as a {@link java.util.Date}.
* <p>
* Invalid input will generate a descriptive ValidationException,
* and input that is clearly an attack will generate a descriptive IntrusionException.
*
* @param context
* A descriptive name of the parameter that you are validating (e.g., LoginPage_UsernameField).
* This value is used by any logging or error handling that is done with respect to the value passed in.
* @param input
* The actual user input data to validate.
* @param format
* Required formatting of date inputted.
* @param allowNull
* If {@code allowNull} is true then an input that is NULL or an empty string will be legal.
* If {@code allowNull} is false then NULL or an empty String will throw a ValidationException.
*
* @return A valid date as a {@link java.util.Date}
*
* @throws ValidationException Input is invalid.
* @throws IntrusionException Input likely indicates an attack.
*/
Date getValidDate(String context, String input, DateFormat format, boolean allowNull) throws ValidationException, IntrusionException;
/**
* Returns a valid date as a {@link java.util.Date},
* any validation exceptions are added to the supplied {@code errorList}.
* <p>
* Calls {@link #getValidDate(String, String, DateFormat, boolean)}.
*
* @throws IntrusionException Input likely indicates an attack.
*/
Date getValidDate(String context, String input, DateFormat format, boolean allowNull, ValidationErrorList errorList) throws IntrusionException;
/**
* Returns true if {@code input} is valid.
* <p>
* Calls {@link #getValidSafeHTML(String, String, int, boolean)},
* and returns true if no exceptions are thrown.
*
* @throws IntrusionException Input likely indicates an attack.
*/
boolean isValidSafeHTML(String context, String input, int maxLength, boolean allowNull) throws IntrusionException;
/**
* Returns true if {@code input} is valid,
* any validation exceptions are added to the supplied {@code errorList}.
* <p>
* Calls {@link #getValidSafeHTML(String, String, int, boolean)}
* and returns true if no exceptions are thrown.
*
* @throws IntrusionException Input likely indicates an attack.
*/
boolean isValidSafeHTML(String context, String input, int maxLength, boolean allowNull, ValidationErrorList errorList) throws IntrusionException;
/**
* Returns canonicalized and validated "safe" HTML that does not contain unwanted scripts in the body, attributes, CSS, URLs, or anywhere else.
* <p>
* The default behavior of this check depends on the {@code antisamy-esapi.xml} configuration.
* Implementors should reference the <a href="https://owasp.org/www-project-antisamy/">OWASP AntiSamy project</a> for ideas
* on how to do HTML validation in a whitelist way, as this is an extremely difficult problem.
*
* @param context
* A descriptive name of the parameter that you are validating (e.g., LoginPage_UsernameField).
* This value is used by any logging or error handling that is done with respect to the value passed in.
* @param input
* The actual user input data to validate.
* @param maxLength
* The maximum String length allowed.
* @param allowNull
* If {@code allowNull} is true then an input that is NULL or an empty string will be legal.
* If {@code allowNull} is false then NULL or an empty String will throw a ValidationException.
*
* @return Valid safe HTML
*
* @throws ValidationException Input is invalid.
* @throws IntrusionException Input likely indicates an attack.
*/
String getValidSafeHTML(String context, String input, int maxLength, boolean allowNull) throws ValidationException, IntrusionException;
/**
* Returns canonicalized and validated "safe" HTML that does not contain unwanted scripts in the body, attributes, CSS, URLs, or anywhere else,
* any validation exceptions are added to the supplied {@code errorList}.
* <p>
* The default behavior of this check depends on the {@code antisamy-esapi.xml} configuration.
* Implementors should reference the <a href="https://owasp.org/www-project-antisamy/">OWASP AntiSamy project</a> for ideas
* on how to do HTML validation in a whitelist way, as this is an extremely difficult problem.
* <p>
* Calls {@link #getValidSafeHTML(String, String, int, boolean)}.
*
* @throws IntrusionException Input likely indicates an attack.
*/
String getValidSafeHTML(String context, String input, int maxLength, boolean allowNull, ValidationErrorList errorList) throws IntrusionException;
/**
* Returns true if {@code input} matches the pattern for a valid credit card number.
* <p>
* Calls {@link #getValidCreditCard(String, String, boolean)},
* and returns true if no exceptions are thrown.
*
* @throws IntrusionException Input likely indicates an attack.
*/
boolean isValidCreditCard(String context, String input, boolean allowNull) throws IntrusionException;
/**
* Returns true if {@code input} matches the pattern for a valid credit card number,
* any validation exceptions are added to the supplied {@code errorList}.
* <p>
* Calls {@link #getValidCreditCard(String, String, boolean)}
* and returns true if no exceptions are thrown.
*
* @throws IntrusionException Input likely indicates an attack.
*/
boolean isValidCreditCard(String context, String input, boolean allowNull, ValidationErrorList errorList) throws IntrusionException;
/**
* Returns a canonicalized and validated credit card number as a String.
* <p>
* Invalid input will generate a descriptive ValidationException,
* and input that is clearly an attack will generate a descriptive IntrusionException.
*
* @param context
* A descriptive name of the parameter that you are validating (e.g., LoginPage_UsernameField).
* This value is used by any logging or error handling that is done with respect to the value passed in.
* @param input
* The actual user input data to validate.
* @param allowNull
* If {@code allowNull} is true then an input that is NULL or an empty string will be legal.
* If {@code allowNull} is false then NULL or an empty String will throw a ValidationException.
*
* @return A valid credit card number
*
* @throws ValidationException Input is invalid.
* @throws IntrusionException Input likely indicates an attack.
*/
String getValidCreditCard(String context, String input, boolean allowNull) throws ValidationException, IntrusionException;
/**
* Returns a canonicalized and validated credit card number as a String,
* any validation exceptions are added to the supplied {@code errorList}.
* <p>
* Calls {@link #getValidCreditCard(String, String, boolean)}.
*
* @throws IntrusionException Input likely indicates an attack.
*/
String getValidCreditCard(String context, String input, boolean allowNull, ValidationErrorList errorList) throws IntrusionException;
/**
* Returns true if {@code input} is valid.
* <p>
* Calls {@link #getValidDirectoryPath(String, String, File, boolean)},
* and returns true if no exceptions are thrown.
*
* @throws IntrusionException Input likely indicates an attack.
*/
boolean isValidDirectoryPath(String context, String input, File parent, boolean allowNull) throws IntrusionException;
/**
* Returns true if {@code input} is valid,
* any validation exceptions are added to the supplied {@code errorList}.
* <p>
* Calls {@link #getValidDirectoryPath(String, String, File, boolean)}
* and returns true if no exceptions are thrown.
*
* @throws IntrusionException Input likely indicates an attack.
*/
boolean isValidDirectoryPath(String context, String input, File parent, boolean allowNull, ValidationErrorList errorList) throws IntrusionException;
/**
* Returns a canonicalized and validated directory path as a String, provided that the input
* maps to an existing directory that is an existing subdirectory (at any level) of the specified parent.
* <p>
* Invalid input will generate a descriptive ValidationException,
* and input that is clearly an attack will generate a descriptive IntrusionException.
*
* @param context
* A descriptive name of the parameter that you are validating (e.g., LoginPage_UsernameField).
* This value is used by any logging or error handling that is done with respect to the value passed in.
* @param input
* The actual input data to validate.
* @param allowNull
* If {@code allowNull} is true then an input that is NULL or an empty string will be legal.
* If {@code allowNull} is false then NULL or an empty String will throw a ValidationException.
*
* @return A valid directory path
*
* @throws ValidationException Input is invalid.
* @throws IntrusionException Input likely indicates an attack.
*/
String getValidDirectoryPath(String context, String input, File parent, boolean allowNull) throws ValidationException, IntrusionException;
/**
* Returns a canonicalized and validated directory path as a String, provided that the input
* maps to an existing directory that is an existing subdirectory (at any level) of the specified parent;
* any validation exceptions are added to the supplied {@code errorList}.
* <p>
* Calls {@link #getValidDirectoryPath(String, String, File, boolean)}.
*
* @throws IntrusionException Input likely indicates an attack.
*/
String getValidDirectoryPath(String context, String input, File parent, boolean allowNull, ValidationErrorList errorList) throws IntrusionException;
/**
* Returns true if {@code input} is valid.
* <p>
* Calls {@link #getValidFileName(String, String, List, boolean)}
* with allowedExtensions set to the configured {@code ESAPI.securityConfiguration().getAllowedFileExtensions()}
* and returns true if no exceptions are thrown.
*
* @throws IntrusionException Input likely indicates an attack.
*
* @see ESAPI#securityConfiguration()
* @see SecurityConfiguration#getAllowedFileExtensions()
*/
boolean isValidFileName(String context, String input, boolean allowNull) throws IntrusionException;
/**
* Returns true if {@code input} is valid,
* any validation exceptions are added to the supplied {@code errorList}.
* <p>
* Calls {@link #getValidFileName(String, String, List, boolean)}
* with allowedExtensions set to the configured {@code ESAPI.securityConfiguration().getAllowedFileExtensions()}
* and returns true if no exceptions are thrown.
*
* @throws IntrusionException Input likely indicates an attack.
*
* @see ESAPI#securityConfiguration()
* @see SecurityConfiguration#getAllowedFileExtensions()
*/
boolean isValidFileName(String context, String input, boolean allowNull, ValidationErrorList errorList) throws IntrusionException;
/**
* Returns true if {@code input} is valid.
* <p>
* Calls {@link #getValidFileName(String, String, List, boolean)},
* and returns true if no exceptions are thrown.
*
* @throws IntrusionException Input likely indicates an attack.
*
* @see ESAPI#securityConfiguration()
* @see SecurityConfiguration#getAllowedFileExtensions()
*/
boolean isValidFileName(String context, String input, List<String> allowedExtensions, boolean allowNull) throws IntrusionException;
/**
* Returns true if {@code input} is valid,
* any validation exceptions are added to the supplied {@code errorList}.
* <p>
* Calls {@link #getValidFileName(String, String, List, boolean)}
* and returns true if no exceptions are thrown.
*
* @throws IntrusionException Input likely indicates an attack.
*
* @see ESAPI#securityConfiguration()
* @see SecurityConfiguration#getAllowedFileExtensions()
*/
boolean isValidFileName(String context, String input, List<String> allowedExtensions, boolean allowNull, ValidationErrorList errorList) throws IntrusionException;
/**
* Returns a canonicalized and validated file name as a String.
* Implementors should check for allowed file extensions here,
* as well as allowed file name characters, as declared in "ESAPI.properties".
* Invalid input will generate a descriptive ValidationException,
* and input that is clearly an attack will generate a descriptive IntrusionException.
*
* @param context
* A descriptive name of the parameter that you are validating (e.g., LoginPage_UsernameField).
* This value is used by any logging or error handling that is done with respect to the value passed in.
* @param input
* The actual input data to validate.
* @param allowedExtensions
* List of file extensions which will be accepted.
* @param allowNull
* If {@code allowNull} is true then an input that is NULL or an empty string will be legal.
* If {@code allowNull} is false then NULL or an empty String will throw a ValidationException.
*
* @return A valid file name
*
* @throws ValidationException Input is invalid.
* @throws IntrusionException Input likely indicates an attack.
*/
String getValidFileName(String context, String input, List<String> allowedExtensions, boolean allowNull) throws ValidationException, IntrusionException;
/**
* Returns a canonicalized and validated file name as a String,
* any validation exceptions are added to the supplied {@code errorList}.
* <p>
* Calls {@link #getValidFileName(String, String, List, boolean)},
* the supplied {@code errorList} is used to capture ValidationExceptions.
*
* @throws IntrusionException Input likely indicates an attack.
*/
String getValidFileName(String context, String input, List<String> allowedExtensions, boolean allowNull, ValidationErrorList errorList) throws IntrusionException;
/**
* Returns true if {@code input} is valid.
* <p>
* Calls {@link #getValidNumber(String, String, long, long, boolean)},
* and returns true if no exceptions are thrown.
*
* @throws IntrusionException Input likely indicates an attack.
*/
boolean isValidNumber(String context, String input, long minValue, long maxValue, boolean allowNull) throws IntrusionException;
/**
* Returns true if {@code input} is valid,
* any validation exceptions are added to the supplied {@code errorList}.
* <p>
* Calls {@link #getValidNumber(String, String, long, long, boolean)}
* and returns true if no exceptions are thrown.
*
* @throws IntrusionException Input likely indicates an attack.
*/
boolean isValidNumber(String context, String input, long minValue, long maxValue, boolean allowNull, ValidationErrorList errorList) throws IntrusionException;
/**
* Returns a validated number as a double within the range of minValue to maxValue.
* Invalid input will generate a descriptive ValidationException,
* and input that is clearly an attack will generate a descriptive IntrusionException.
*
* @param context
* A descriptive name of the parameter that you are validating (e.g., LoginPage_UsernameField).
* This value is used by any logging or error handling that is done with respect to the value passed in.
* @param input
* The actual input data to validate.
* @param allowNull
* If {@code allowNull} is true then an input that is NULL or an empty string will be legal.
* If {@code allowNull} is false then NULL or an empty String will throw a ValidationException.
* @param minValue
* Lowest legal value for input.
* @param maxValue
* Highest legal value for input.
*
* @return A validated number as a double.
*
* @throws ValidationException Input is invalid.
* @throws IntrusionException Input likely indicates an attack.
*/
Double getValidNumber(String context, String input, long minValue, long maxValue, boolean allowNull) throws ValidationException, IntrusionException;
/**
* Returns a validated number as a double within the range of minValue to maxValue,
* any validation exceptions are added to the supplied {@code errorList}.
* <p>
* Calls {@link #getValidNumber(String, String, long, long, boolean)}.
*
* @throws IntrusionException Input likely indicates an attack.
*/
Double getValidNumber(String context, String input, long minValue, long maxValue, boolean allowNull, ValidationErrorList errorList) throws IntrusionException;
/**
* Returns true if {@code input} is a valid integer between {@code minValue} and {@code maxValue} inclusive.
* <p>
* Calls {@link #getValidInteger(String, String, int, int, boolean)},
* and returns true if no exceptions are thrown.
*
* @throws IntrusionException Input likely indicates an attack.
*/
boolean isValidInteger(String context, String input, int minValue, int maxValue, boolean allowNull) throws IntrusionException;
/**
* Returns true if {@code input} is a valid integer between {@code minValue} and {@code maxValue} inclusive,
* any validation exceptions are added to the supplied {@code errorList}.
* <p>
* Calls {@link #getValidInteger(String, String, int, int, boolean)}
* and returns true if no exceptions are thrown.
*
* @throws IntrusionException Input likely indicates an attack.
*/
boolean isValidInteger(String context, String input, int minValue, int maxValue, boolean allowNull, ValidationErrorList errorList) throws IntrusionException;
/**
* Returns a validated integer,
* {@code input} is a valid integer if it is between {@code minValue} and {@code maxValue} inclusive.
* Invalid input will generate a descriptive ValidationException,
* and input that is clearly an attack will generate a descriptive IntrusionException.
*
* @param context
* A descriptive name of the parameter that you are validating (e.g., LoginPage_UsernameField).
* This value is used by any logging or error handling that is done with respect to the value passed in.
* @param input
* The actual input data to validate.
* @param allowNull
* If {@code allowNull} is true then an input that is NULL or an empty string will be legal.
* If {@code allowNull} is false then NULL or an empty String will throw a ValidationException.
* @param minValue
* Lowest legal value for input.
* @param maxValue
* Highest legal value for input.
*
* @return A validated number as an integer.
*
* @throws ValidationException Input is invalid.
* @throws IntrusionException Input likely indicates an attack.
*/
Integer getValidInteger(String context, String input, int minValue, int maxValue, boolean allowNull) throws ValidationException, IntrusionException;
/**
* Returns a validated integer,
* any validation exceptions are added to the supplied {@code errorList}.
* <p>
* Calls {@link #getValidInteger(String, String, int, int, boolean)}.
*
* @throws IntrusionException Input likely indicates an attack.
*/
Integer getValidInteger(String context, String input, int minValue, int maxValue, boolean allowNull, ValidationErrorList errorList) throws IntrusionException;
/**
* Returns true if {@code input} is valid.
* <p>
* Calls {@link #getValidDouble(String, String, double, double, boolean)},
* and returns true if no exceptions are thrown.
*
* @throws IntrusionException Input likely indicates an attack.
*/
boolean isValidDouble(String context, String input, double minValue, double maxValue, boolean allowNull) throws IntrusionException;
/**
* Returns true if {@code input} is valid,
* any validation exceptions are added to the supplied {@code errorList}.
* <p>
* Calls {@link #getValidDouble(String, String, double, double, boolean)}
* and returns true if no exceptions are thrown.
*
* @throws IntrusionException Input likely indicates an attack.
*/
boolean isValidDouble(String context, String input, double minValue, double maxValue, boolean allowNull, ValidationErrorList errorList) throws IntrusionException;
/**
* Returns a validated real number as a double.
* Invalid input will generate a descriptive ValidationException,
* and input that is clearly an attack will generate a descriptive IntrusionException.
*
* @param context
* A descriptive name of the parameter that you are validating (e.g., LoginPage_UsernameField).
* This value is used by any logging or error handling that is done with respect to the value passed in.
* @param input
* The actual input data to validate.
* @param allowNull
* If {@code allowNull} is true then an input that is NULL or an empty string will be legal.
* If {@code allowNull} is false then NULL or an empty String will throw a ValidationException.
* @param minValue
* Lowest legal value for input.
* @param maxValue
* Highest legal value for input.
*
* @return A validated real number as a double.
*
* @throws ValidationException Input is invalid.
* @throws IntrusionException Input likely indicates an attack.
*/
Double getValidDouble(String context, String input, double minValue, double maxValue, boolean allowNull) throws ValidationException, IntrusionException;
/**
* Returns a validated real number as a double,
* any validation exceptions are added to the supplied {@code errorList}.
* <p>
* Calls {@link #getValidDouble(String, String, double, double, boolean)},
* the supplied {@code errorList} is used to capture ValidationExceptions.
*
* @throws IntrusionException Input likely indicates an attack.
*/
Double getValidDouble(String context, String input, double minValue, double maxValue, boolean allowNull, ValidationErrorList errorList) throws IntrusionException;
/**
* Returns true if {@code input} is valid.
* <p>
* Calls {@link #getValidFileContent(String, byte[], int, boolean)},
* and returns true if no exceptions are thrown.
*
* @throws IntrusionException Input likely indicates an attack.
*/
boolean isValidFileContent(String context, byte[] input, int maxBytes, boolean allowNull) throws IntrusionException;
/**
* Returns true if {@code input} is valid,
* any validation exceptions are added to the supplied {@code errorList}.
* <p>
* Calls {@link #getValidFileContent(String, byte[], int, boolean)}
* and returns true if no exceptions are thrown.
*
* @throws IntrusionException Input likely indicates an attack.
*/
boolean isValidFileContent(String context, byte[] input, int maxBytes, boolean allowNull, ValidationErrorList errorList) throws IntrusionException;
/**
* Returns validated file content as a byte array.
* This is a good place to check for max file size, allowed character sets, and do virus scans.
* Invalid input will generate a descriptive ValidationException,
* and input that is clearly an attack will generate a descriptive IntrusionException.
*
* @param context
* A descriptive name of the parameter that you are validating (e.g., LoginPage_UsernameField).
* This value is used by any logging or error handling that is done with respect to the value passed in.
* @param input
* The actual input data to validate.
* @param maxBytes
* The maximum number of bytes allowed in a legal file.
* @param allowNull
* If {@code allowNull} is true then an input that is NULL or an empty string will be legal.
* If {@code allowNull} is false then NULL or an empty String will throw a ValidationException.
*
* @return A byte array containing valid file content.
*
* @throws ValidationException Input is invalid.
* @throws IntrusionException Input likely indicates an attack.
*/
byte[] getValidFileContent(String context, byte[] input, int maxBytes, boolean allowNull) throws ValidationException, IntrusionException;
/**
* Returns validated file content as a byte array,
* any validation exceptions are added to the supplied {@code errorList}.
* <p>
* Calls {@link #getValidFileContent(String, byte[], int, boolean)},
* the supplied {@code errorList} is used to capture ValidationExceptions.
*
* @throws IntrusionException Input likely indicates an attack.
*/
byte[] getValidFileContent(String context, byte[] input, int maxBytes, boolean allowNull, ValidationErrorList errorList) throws IntrusionException;
/**
* Returns true if {@code filepath}, {@code filename}, and {@code content} of a file are valid.
* <p>
* Calls {@link #isValidFileName(String, String, boolean)},
* {@link #isValidDirectoryPath(String, String, File, boolean)},
* and {@link #isValidFileContent(String, byte[], int, boolean)},
* and returns true if all three checks pass.
*
* @throws IntrusionException Input likely indicates an attack.
*/
boolean isValidFileUpload(String context, String filepath, String filename, File parent, byte[] content, int maxBytes, boolean allowNull) throws IntrusionException;
/**
* Returns true if {@code filepath}, {@code filename}, and {@code content} of a file are valid,
* any validation exceptions are added to the supplied {@code errorList}.
* <p>
* Calls {@link #isValidFileName(String, String, boolean, ValidationErrorList)}
* {@link #isValidDirectoryPath(String, String, File, boolean, ValidationErrorList)}
* and {@link #isValidFileContent(String, byte[], int, boolean, ValidationErrorList)},
* and returns true if all three checks pass.
*
* @throws IntrusionException Input likely indicates an attack.
*/
boolean isValidFileUpload(String context, String filepath, String filename, File parent, byte[] content, int maxBytes, boolean allowNull, ValidationErrorList errorList) throws IntrusionException;
/**
* Validates the {@code filepath}, {@code filename}, and {@code content} of a file.
* Invalid input will generate a descriptive ValidationException,
* and input that is clearly an attack will generate a descriptive IntrusionException.
*
* @param context
* A descriptive name of the parameter that you are validating (e.g., LoginPage_UsernameField).
* This value is used by any logging or error handling that is done with respect to the value passed in.
* @param filepath
* The file path of the uploaded file.
* @param filename
* The filename of the uploaded file
* @param content
* A byte array containing the content of the uploaded file.
* @param maxBytes
* The max number of bytes allowed for a legal file upload.
* @param allowNull
* If {@code allowNull} is true then an input that is NULL or an empty string will be legal.
* If {@code allowNull} is false then NULL or an empty String will throw a ValidationException.
*
* @throws ValidationException Input is invalid.
* @throws IntrusionException Input likely indicates an attack.
*/
void assertValidFileUpload(String context, String filepath, String filename, File parent, byte[] content, int maxBytes, List<String> allowedExtensions, boolean allowNull) throws ValidationException, IntrusionException;
/**
* Validates the {@code filepath}, {@code filename}, and {@code content} of a file,
* any validation exceptions are added to the supplied {@code errorList}.
* <p>
* Calls {@link #assertValidFileUpload(String, String, String, File, byte[], int, List, boolean)},
* the supplied {@code errorList} is used to capture ValidationExceptions.
*
* @throws IntrusionException Input likely indicates an attack.
*/
void assertValidFileUpload(String context, String filepath, String filename, File parent, byte[] content, int maxBytes, List<String> allowedExtensions, boolean allowNull, ValidationErrorList errorList) throws IntrusionException;
/**
* Returns true if {@code input} is valid.
* <p>
* Calls {@link #getValidListItem(String, String, List)}
* and returns true if no exceptions are thrown.
*
* @throws IntrusionException Input likely indicates an attack.
*/
boolean isValidListItem(String context, String input, List<String> list) throws IntrusionException;
/**
* Returns true if {@code input} is valid,
* any validation exceptions are added to the supplied {@code errorList}.
* <p>
* Calls {@link #getValidListItem(String, String, List)}
* and returns true if no exceptions are thrown.
*
* @throws IntrusionException Input likely indicates an attack.
*/
boolean isValidListItem(String context, String input, List<String> list, ValidationErrorList errorList) throws IntrusionException;
/**
* Returns the list item that exactly matches the canonicalized input.
* Invalid or non-matching input will generate a descriptive ValidationException,
* and input that is clearly an attack will generate a descriptive IntrusionException.
*
* @param context
* A descriptive name of the parameter that you are validating (e.g., LoginPage_UsernameField). This value is used by any logging or error handling that is done with respect to the value passed in.
* @param input
* The value to search 'list' for.
* @param list
* The list to search for 'input'.
*
* @return The list item that exactly matches the canonicalized input.
*
* @throws ValidationException Input is invalid.
* @throws IntrusionException Input likely indicates an attack.
*/
String getValidListItem(String context, String input, List<String> list) throws ValidationException, IntrusionException;
/**
* Returns the list item that exactly matches the canonicalized input,
* any validation exceptions are added to the supplied {@code errorList}.
* <p>
* Calls {@link #getValidListItem(String, String, List)}
*
* @throws IntrusionException Input likely indicates an attack.
*/
String getValidListItem(String context, String input, List<String> list, ValidationErrorList errorList) throws IntrusionException;
/**
* Returns true if only required and optional parameters are in the request.
* <p>
* Calls {@link #assertValidHTTPRequestParameterSet(String, HttpServletRequest, Set, Set)}
* and returns true if no exceptions are thrown.
*
* @throws IntrusionException Input likely indicates an attack.
*/
boolean isValidHTTPRequestParameterSet(String context, HttpServletRequest request, Set<String> required, Set<String> optional) throws IntrusionException;
/**
* Returns true if only required and optional parameters are in the request,
* any validation exceptions are added to the supplied {@code errorList}.
* <p>
* Calls {@link #assertValidHTTPRequestParameterSet(String, HttpServletRequest, Set, Set)}
* and returns true if no exceptions are thrown.
*
* @throws IntrusionException Input likely indicates an attack.
*/
boolean isValidHTTPRequestParameterSet(String context, HttpServletRequest request, Set<String> required, Set<String> optional, ValidationErrorList errorList) throws IntrusionException;
/**
* Validates that the parameters in the current request contain all required parameters
* and only optional ones in addition.
* Invalid input will generate a descriptive ValidationException,
* and input that is clearly an attack will generate a descriptive IntrusionException.
*
* @param context
* A descriptive name of the parameter that you are validating (e.g., LoginPage_UsernameField). This value is used by any logging or error handling that is done with respect to the value passed in.
* @param required
* parameters that are required to be in HTTP request
* @param optional
* additional parameters that may be in HTTP request
*
* @throws ValidationException Input is invalid.
* @throws IntrusionException Input likely indicates an attack.
*/
void assertValidHTTPRequestParameterSet(String context, HttpServletRequest request, Set<String> required, Set<String> optional) throws ValidationException, IntrusionException;
/**
* Validates that the parameters in the current request contain all required parameters
* and only optional ones in addition,
* any validation exceptions are added to the supplied {@code errorList}.
* <p>
* Calls {@link #assertValidHTTPRequestParameterSet(String, HttpServletRequest, Set, Set)}.
*
* @throws IntrusionException Input likely indicates an attack.
*/
void assertValidHTTPRequestParameterSet(String context, HttpServletRequest request, Set<String> required, Set<String> optional, ValidationErrorList errorList) throws IntrusionException;
/**
* Returns true if {@code input} is valid.
* <p>
* Calls {@link #getValidPrintable(String, char[], int, boolean)}
* and returns true if no exceptions are thrown.
*
* @throws IntrusionException Input likely indicates an attack.
*/
boolean isValidPrintable(String context, char[] input, int maxLength, boolean allowNull) throws IntrusionException;
/**
* Returns true if {@code input} is valid,
* any validation exceptions are added to the supplied {@code errorList}.
* <p>
* Calls {@link #getValidPrintable(String, char[], int, boolean)}
* and returns true if no exceptions are thrown.
*
* @throws IntrusionException Input likely indicates an attack.
*/
boolean isValidPrintable(String context, char[] input, int maxLength, boolean allowNull, ValidationErrorList errorList) throws IntrusionException;
/**
* Returns canonicalized and validated printable characters as a byte array.
* Invalid input will generate a descriptive ValidationException,
* and input that is clearly an attack will generate a descriptive IntrusionException.
*
* @param context
* A descriptive name of the parameter that you are validating (e.g., LoginPage_UsernameField).
* This value is used by any logging or error handling that is done with respect to the value passed in.
* @param input
* data to be returned as valid and printable
* @param maxLength
* Maximum number of bytes stored in 'input'
* @param allowNull
* If {@code allowNull} is true then an input that is NULL or an empty string will be legal.
* If {@code allowNull} is false then NULL or an empty String will throw a ValidationException.
*
* @return a byte array containing only printable characters, made up of data from 'input'
*
* @throws ValidationException Input is invalid.
*/
char[] getValidPrintable(String context, char[] input, int maxLength, boolean allowNull) throws ValidationException;
/**
* Returns canonicalized and validated printable characters as a byte array,
* any validation exceptions are added to the supplied {@code errorList}.
* <p>
* Calls {@link #getValidPrintable(String, char[], int, boolean)}.
*
* @throws IntrusionException Input likely indicates an attack.
*/
char[] getValidPrintable(String context, char[] input, int maxLength, boolean allowNull, ValidationErrorList errorList) throws IntrusionException;
/**
* Returns true if {@code input} is valid.
* <p>
* Calls {@link #getValidPrintable(String, String, int, boolean)}
* and returns true if no exceptions are thrown.
*
* @throws IntrusionException Input likely indicates an attack.
*/
boolean isValidPrintable(String context, String input, int maxLength, boolean allowNull) throws IntrusionException;
/**
* Returns true if {@code input} is valid,
* any validation exceptions are added to the supplied {@code errorList}.
* <p>
* Calls {@link #getValidPrintable(String, String, int, boolean)}
* and returns true if no exceptions are thrown.
*
* @throws IntrusionException Input likely indicates an attack.
*/
boolean isValidPrintable(String context, String input, int maxLength, boolean allowNull, ValidationErrorList errorList) throws IntrusionException;
/**
* Returns canonicalized and validated printable characters as a String.
* Invalid input will generate a descriptive ValidationException,
* and input that is clearly an attack will generate a descriptive IntrusionException.
*
* @param context
* A descriptive name of the parameter that you are validating (e.g., LoginPage_UsernameField).
* This value is used by any logging or error handling that is done with respect to the value passed in.
* @param input
* data to be returned as valid and printable
* @param maxLength
* Maximum number of bytes stored in 'input' after canonicalization
* @param allowNull
* If {@code allowNull} is true then an input that is NULL or an empty string will be legal.
* If {@code allowNull} is false then NULL or an empty String will throw a ValidationException.
*
* @return a String containing only printable characters, made up of data from 'input'
*
* @throws ValidationException Input is invalid.
*/
String getValidPrintable(String context, String input, int maxLength, boolean allowNull) throws ValidationException;
/**
* Returns canonicalized and validated printable characters as a String,
* any validation exceptions are added to the supplied {@code errorList}.
* <p>
* Calls {@link #getValidPrintable(String, String, int, boolean)}.
*
* @throws IntrusionException Input likely indicates an attack.
*/
String getValidPrintable(String context, String input, int maxLength, boolean allowNull, ValidationErrorList errorList) throws IntrusionException;
/**
* Returns true if {@code input} is valid.
* <p>
* Calls {@link #getValidRedirectLocation(String, String, boolean)}
* and returns true if no exceptions are thrown.
*/
boolean isValidRedirectLocation(String context, String input, boolean allowNull);
/**
* Returns true if {@code input} is valid,
* any validation exceptions are added to the supplied {@code errorList}.
* <p>
* Calls {@link #getValidRedirectLocation(String, String, boolean)}
* and returns true if no exceptions are thrown.
*/
boolean isValidRedirectLocation(String context, String input, boolean allowNull, ValidationErrorList errorList);
/**
* Returns a canonicalized and validated redirect location as a String.
* Invalid input will generate a descriptive ValidationException,
* and input that is clearly an attack will generate a descriptive IntrusionException.
*
* @param context
* A descriptive name of the parameter that you are validating (e.g., LoginPage_UsernameField).
* This value is used by any logging or error handling that is done with respect to the value passed in.
* @param input
* redirect location to be returned as valid, according to encoding rules set in "ESAPI.properties"
* @param allowNull
* If {@code allowNull} is true then an input that is NULL or an empty string will be legal.
* If {@code allowNull} is false then NULL or an empty String will throw a ValidationException.