/
TemplateEngine_HtmlOutputEscapingTest.java
1562 lines (1113 loc) · 66.8 KB
/
TemplateEngine_HtmlOutputEscapingTest.java
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
package gg.jte;
import gg.jte.html.HtmlTemplateOutput;
import gg.jte.html.OwaspHtmlPolicy;
import gg.jte.html.policy.PreventInlineEventHandlers;
import gg.jte.html.policy.PreventSingleQuotedAttributes;
import gg.jte.output.StringOutput;
import gg.jte.runtime.TemplateUtils;
import gg.jte.support.LocalizationSupport;
import org.junit.jupiter.api.Test;
import java.io.Writer;
import java.util.Collections;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.catchThrowable;
public class TemplateEngine_HtmlOutputEscapingTest {
DummyCodeResolver codeResolver = new DummyCodeResolver();
TemplateEngine templateEngine = TemplateEngine.create(codeResolver, ContentType.Html);
MyLocalizer localizer = new MyLocalizer();
StringOutput output = new StringOutput();
@Test
void outputEscaping() {
codeResolver.givenCode("template.jte",
"@param String url\n" +
"@param String title\n" +
"Look at <a href=\"${url}\">${title}</a>");
templateEngine.render("template.jte", TemplateUtils.toMap("url", "https://www.test.com?param1=1¶m2=2", "title", "<script>alert('hello');</script>"), output);
assertThat(output.toString()).isEqualTo("Look at <a href=\"https://www.test.com?param1=1&param2=2\"><script>alert('hello');</script></a>");
}
@Test
void unclosedTag() {
codeResolver.givenCode("unclosed.jte", "<span><a></span>");
Throwable throwable = catchThrowable(() -> templateEngine.render("unclosed.jte", null, output));
assertThat(throwable).isInstanceOf(TemplateException.class).hasMessage("Failed to compile unclosed.jte, error at line 1: Unclosed tag <a>, expected </a>, got </span>.");
}
@Test
void codeInTag() {
codeResolver.givenCode("template.jte", "@param String tag\n\n<span><${tag}/></span>");
Throwable throwable = catchThrowable(() -> templateEngine.render("template.jte", "br", output));
assertThat(throwable).isInstanceOf(TemplateException.class).hasMessage("Failed to compile template.jte, error at line 3: Illegal HTML tag name ${tag}! Expressions in HTML tag names are not allowed.");
}
@Test
void codeInTag_unsafe() {
codeResolver.givenCode("template.jte", "@param String tag\n\n<span><$unsafe{tag}/></span>");
templateEngine.render("template.jte", "br", output);
assertThat(output.toString()).isEqualTo("\n<span><br/></span>");
}
@Test
void codeInAttribute() {
codeResolver.givenCode("template.jte", "@param String attribute\n\n<span ${attribute}=\"value\"></span>");
Throwable throwable = catchThrowable(() -> templateEngine.render("template.jte", "class", output));
assertThat(throwable).isInstanceOf(TemplateException.class).hasMessage("Failed to compile template.jte, error at line 3: Illegal HTML attribute name ${attribute}! Expressions in HTML attribute names are not allowed.");
}
@Test
void codeInAttribute_unsafe() {
codeResolver.givenCode("template.jte", "@param String attribute\n\n<span $unsafe{attribute}=\"value\"></span>");
templateEngine.render("template.jte", "class", output);
assertThat(output.toString()).isEqualTo("\n<span class=\"value\"></span>");
}
@Test
void commentIsNotConfusedWithHtmlTag() {
codeResolver.givenCode("template.jte", "@param String name\n<%-- Comment --%>\n<p>Hello ${name}</p>");
templateEngine.render("template.jte", "John", output);
assertThat(output.toString()).isEqualTo("\n<p>Hello John</p>");
}
@Test
void attributes() {
codeResolver.givenCode("template.jte", "@param String userName\n<div data-title=\"Hello ${userName}\"></div>");
templateEngine.render("template.jte", "\"><script>alert('xss')</script>", output);
assertThat(output.toString()).isEqualTo("<div data-title=\"Hello "><script>alert('xss')</script>\"></div>");
}
@Test
void attributes_null() {
codeResolver.givenCode("template.jte", "@param String title\n<button data-title=\"${title}\">Click</button>");
templateEngine.render("template.jte", (String)null, output);
assertThat(output.toString()).isEqualTo("<button>Click</button>");
}
@Test
void attributes_string() {
codeResolver.givenCode("template.jte", "@param String title\n<button data-title=\"${title}\">Click</button>");
templateEngine.render("template.jte", "The title", output);
assertThat(output.toString()).isEqualTo("<button data-title=\"The title\">Click</button>");
}
@Test
void attributes_byte() {
codeResolver.givenCode("template.jte", "@param byte value\n<button data-value=\"${value}\">Click</button>");
templateEngine.render("template.jte", (byte)42, output);
assertThat(output.toString()).isEqualTo("<button data-value=\"42\">Click</button>");
}
@Test
void attributes_short() {
codeResolver.givenCode("template.jte", "@param short value\n<button data-value=\"${value}\">Click</button>");
templateEngine.render("template.jte", (short)42, output);
assertThat(output.toString()).isEqualTo("<button data-value=\"42\">Click</button>");
}
@Test
void attributes_int() {
codeResolver.givenCode("template.jte", "@param int value\n<button data-value=\"${value}\">Click</button>");
templateEngine.render("template.jte", 42, output);
assertThat(output.toString()).isEqualTo("<button data-value=\"42\">Click</button>");
}
@Test
void attributes_long() {
codeResolver.givenCode("template.jte", "@param long value\n<button data-value=\"${value}\">Click</button>");
templateEngine.render("template.jte", 42L, output);
assertThat(output.toString()).isEqualTo("<button data-value=\"42\">Click</button>");
}
@Test
void attributes_float() {
codeResolver.givenCode("template.jte", "@param float value\n<button data-value=\"${value}\">Click</button>");
templateEngine.render("template.jte", 42.5f, output);
assertThat(output.toString()).isEqualTo("<button data-value=\"42.5\">Click</button>");
}
@Test
void attributes_double() {
codeResolver.givenCode("template.jte", "@param double value\n<button data-value=\"${value}\">Click</button>");
templateEngine.render("template.jte", 42.5, output);
assertThat(output.toString()).isEqualTo("<button data-value=\"42.5\">Click</button>");
}
@Test
void attributes_Integer() {
codeResolver.givenCode("template.jte", "@param Integer value\n<button data-value=\"${value}\">Click</button>");
templateEngine.render("template.jte", 42, output);
assertThat(output.toString()).isEqualTo("<button data-value=\"42\">Click</button>");
}
@Test
void attributes_Integer_null() {
codeResolver.givenCode("template.jte", "@param Integer value\n<button data-value=\"${value}\">Click</button>");
templateEngine.render("template.jte", (Integer)null, output);
assertThat(output.toString()).isEqualTo("<button>Click</button>");
}
@Test
void attributes_Boolean() {
codeResolver.givenCode("template.jte", "@param Boolean value\n<button data-value=\"${value}\">Click</button>");
templateEngine.render("template.jte", Boolean.FALSE, output);
assertThat(output.toString()).isEqualTo("<button>Click</button>");
}
@Test
void attributes_Boolean2() {
codeResolver.givenCode("template.jte", "@param Boolean value\n<button data-value=\"${value}\">Click</button>");
templateEngine.render("template.jte", false, output);
assertThat(output.toString()).isEqualTo("<button>Click</button>");
}
@Test
void attributes_Boolean_null() {
codeResolver.givenCode("template.jte", "@param Boolean value\n<button data-value=\"${value}\">Click</button>");
templateEngine.render("template.jte", (Boolean)null, output);
assertThat(output.toString()).isEqualTo("<button>Click</button>");
}
@Test
void attributes_content() {
codeResolver.givenCode("template.jte", "@param gg.jte.Content content\n<button data-title = \"${content}\">Click</button>");
templateEngine.render("template.jte", (Content) output -> output.writeContent("Hello \"My friend\"!"), output);
assertThat(output.toString()).isEqualTo("<button data-title=\"Hello "My friend"!\">Click</button>");
}
@Test
void attributes_content_null() {
codeResolver.givenCode("template.jte", "@param gg.jte.Content content\n<button data-title = \"${content}\">Click</button>");
templateEngine.render("template.jte", (Content)null, output);
assertThat(output.toString()).isEqualTo("<button>Click</button>");
}
@Test
void attributes_multipleOutputs() {
codeResolver.givenCode("template.jte", "@param String title\n<button data-title-x2=\"${title} + ${title}\">Click</button>");
templateEngine.render("template.jte", "The title", output);
assertThat(output.toString()).isEqualTo("<button data-title-x2=\"The title + The title\">Click</button>");
}
@Test
void attributes_multipleOutputs_null() {
codeResolver.givenCode("template.jte", "@param String title\n<button data-title-x2=\"${title} + ${title}\">Click</button>");
templateEngine.render("template.jte", (String)null, output);
assertThat(output.toString()).isEqualTo("<button data-title-x2=\" + \">Click</button>");
}
@Test
void attributes_boolean_true() {
codeResolver.givenCode("template.jte", "@param boolean visible\n<button data-visible=\"${visible}\">Click</button>");
templateEngine.render("template.jte", true, output);
assertThat(output.toString()).isEqualTo("<button data-visible=\"true\">Click</button>");
}
@Test
void attributes_boolean_false() {
codeResolver.givenCode("template.jte", "@param boolean visible\n<button data-visible=\"${visible}\">Click</button>");
templateEngine.render("template.jte", false, output);
assertThat(output.toString()).isEqualTo("<button>Click</button>");
}
@Test
void attributes_boolean_false_attributeBefore() {
codeResolver.givenCode("template.jte", "@param boolean visible\n<button data-test data-visible=\"${visible}\">Click</button>");
templateEngine.render("template.jte", false, output);
assertThat(output.toString()).isEqualTo("<button data-test>Click</button>");
}
@Test
void attributes_boolean_true_attributeBefore() {
codeResolver.givenCode("template.jte", "@param boolean visible\n<button data-test data-visible=\"${visible}\">Click</button>");
templateEngine.render("template.jte", true, output);
assertThat(output.toString()).isEqualTo("<button data-test data-visible=\"true\">Click</button>");
}
@Test
void attributes_booleanExpression1() {
codeResolver.givenCode("template.jte", "@param boolean visible\n<button data-visible=\"${visible == true}\" data-invisible=\"${!visible}\">Click</button>");
templateEngine.render("template.jte", true, output);
assertThat(output.toString()).isEqualTo("<button data-visible=\"true\">Click</button>");
}
@Test
void attributes_booleanExpression2() {
codeResolver.givenCode("template.jte", "@param boolean visible\n<button data-visible=\"${visible == true}\" data-invisible=\"${!visible}\">Click</button>");
templateEngine.render("template.jte", false, output);
assertThat(output.toString()).isEqualTo("<button data-invisible=\"true\">Click</button>");
}
@Test
void booleanAttributes_true() {
codeResolver.givenCode("template.jte", "@param boolean disabled\n<button disabled=\"${disabled}\">Click</button>");
templateEngine.render("template.jte", true, output);
assertThat(output.toString()).isEqualTo("<button disabled>Click</button>");
}
@Test
void booleanAttributes_false() {
codeResolver.givenCode("template.jte", "@param boolean disabled\n<button disabled=\"${disabled}\">Click</button>");
templateEngine.render("template.jte", false, output);
assertThat(output.toString()).isEqualTo("<button>Click</button>");
}
@Test
void booleanAttribute_noJavaExpression() {
codeResolver.givenCode("template.jte", "@param boolean disabled\n<button disabled=\"disabled\">Click</button>");
templateEngine.render("template.jte", false, output);
assertThat(output.toString()).isEqualTo("<button disabled=\"disabled\">Click</button>");
}
@Test
void booleanAttributes_noParams() {
codeResolver.givenCode("template.jte", "@param String cssClass\n<button disabled class=\"${cssClass}\">Click</button>");
templateEngine.render("template.jte", "dummy", output);
assertThat(output.toString()).isEqualTo("<button disabled class=\"dummy\">Click</button>");
}
@Test
void booleanAttributes_noParams2() {
codeResolver.givenCode("template.jte", "@param String placeholder\n<input id=\"login-email\" type=\"text\" placeholder=\"${placeholder}\" required>\n<input id=\"login-password\" type=\"password\" placeholder=\"Savecode\" required>");
templateEngine.render("template.jte", "dummy", output);
assertThat(output.toString()).isEqualTo("<input id=\"login-email\" type=\"text\" placeholder=\"dummy\" required>\n" +
"<input id=\"login-password\" type=\"password\" placeholder=\"Savecode\" required>");
}
@Test
void booleanAttributes_withoutCondition() {
codeResolver.givenCode("template.jte", "@param boolean disabled\n<button class=\"submit cta\" disabled=\"${disabled}\" data-item=\"id\">Do it</button>");
templateEngine.render("template.jte", true, output);
assertThat(output.toString()).isEqualTo("<button class=\"submit cta\" disabled data-item=\"id\">Do it</button>");
}
@Test
void booleanAttributes_expression1() {
codeResolver.givenCode("template.jte", "@param String disabled\n<button disabled=\"${\"true\".equals(disabled)}\">Click</button>");
templateEngine.render("template.jte", "true", output);
assertThat(output.toString()).isEqualTo("<button disabled>Click</button>");
}
@Test
void booleanAttributes_expression2() {
codeResolver.givenCode("template.jte", "@param String disabled\n<button disabled=\"${\"true\".equals(disabled)}\">Click</button>");
templateEngine.render("template.jte", (Object)null, output);
assertThat(output.toString()).isEqualTo("<button>Click</button>");
}
@Test
void booleanAttributes_followedByOutput() {
codeResolver.givenCode("template.jte", "@param String label\n<input required><label>${label}</label>");
templateEngine.render("template.jte", "Label", output);
assertThat(output.toString()).isEqualTo("<input required><label>Label</label>");
}
@Test
void attributes_String() {
codeResolver.givenCode("template.jte", "@param String value\n<button data-value=\"${value}\">Click</button>");
templateEngine.render("template.jte", "Hello", output);
assertThat(output.toString()).isEqualTo("<button data-value=\"Hello\">Click</button>");
}
@Test
void attributes_String_null() {
codeResolver.givenCode("template.jte", "@param String value\n<button data-value=\"${value}\">Click</button>");
templateEngine.render("template.jte", (String)null, output);
assertThat(output.toString()).isEqualTo("<button>Click</button>");
}
@Test
void attributes_String_empty() {
codeResolver.givenCode("template.jte", "@param String value\n<button data-value=\"${value}\">Click</button>");
templateEngine.render("template.jte", "", output);
assertThat(output.toString()).isEqualTo("<button>Click</button>");
}
@Test
void cssClasses() {
codeResolver.givenCode("template.jte", "@import static gg.jte.html.support.HtmlSupport.*\n@param boolean visible\n<button class=\"mb-3 ${addClass(!visible, \"hide\").addClass(visible, \"show\")}\">Click</button>");
templateEngine.render("template.jte", false, output);
assertThat(output.toString()).isEqualTo("<button class=\"mb-3 hide\">Click</button>");
}
@Test
void cssClasses_empty() {
codeResolver.givenCode("template.jte", "@import static gg.jte.html.support.HtmlSupport.*\n@param boolean visible\n<button class=\"${addClass(!visible, \"hide\")}\">Click</button>");
templateEngine.render("template.jte", true, output);
assertThat(output.toString()).isEqualTo("<button>Click</button>");
}
@Test
void doctype() {
codeResolver.givenCode("template.jte", "@param String x\n<!DOCTYPE html>");
templateEngine.render("template.jte", (Object)null, output);
assertThat(output.toString()).isEqualTo("<!DOCTYPE html>");
}
@Test
void htmlComment() {
codeResolver.givenCode("template.jte", "@param String url\n<!-- html comment --><a href=\"${url}\">Click me!</a>");
templateEngine.render("template.jte", "https://jte.gg", output);
assertThat(output.toString()).isEqualTo("<a href=\"https://jte.gg\">Click me!</a>");
}
@Test
void htmlComment_withHtmlCommentsPreserved() {
codeResolver.givenCode("template.jte", "@param String url\n<!-- html comment --><a href=\"${url}\">Click me!</a>");
templateEngine.setHtmlCommentsPreserved(true);
templateEngine.render("template.jte", "https://jte.gg", output);
assertThat(output.toString()).isEqualTo("<!-- html comment --><a href=\"https://jte.gg\">Click me!</a>");
}
@Test
void htmlComment_withCode() {
codeResolver.givenCode("template.jte", "@param String name\n\n<!--Comment here with ${name}-->\n<span>Test</span>");
templateEngine.render("template.jte", "Hello", output);
assertThat(output.toString()).isEqualTo("\n\n<span>Test</span>");
}
@Test
void htmlComment_withCode_withHtmlCommentsPreserved() {
codeResolver.givenCode("template.jte", "@param String name\n\n<!--Comment here with ${name}-->\n<span>Test</span>");
templateEngine.setHtmlCommentsPreserved(true);
templateEngine.render("template.jte", "Hello", output);
assertThat(output.toString()).isEqualTo("\n<!--Comment here with Hello-->\n<span>Test</span>");
}
@Test
void htmlComment_andNothingElse() {
codeResolver.givenCode("template.jte", "<!--Comment here-->");
templateEngine.render("template.jte", null, output);
assertThat(output.toString()).isEqualTo("");
}
@Test
void htmlComment_beforeParams() {
codeResolver.givenCode("template.jte", "<!--Comment here-->\n@param String name\n<span>${name}</span>");
templateEngine.render("template.jte", "Hello", output);
assertThat(output.toString()).isEqualTo("<span>Hello</span>");
}
@Test
void htmlComment_ignoredIfInAttribute() {
codeResolver.givenCode("template.jte", "@param String name\n\n<span name=\"<!--this is not a comment ${name}-->\">Test</span>");
templateEngine.render("template.jte", "Hello", output);
assertThat(output.toString()).isEqualTo("\n<span name=\"<!--this is not a comment Hello-->\">Test</span>");
}
@Test
void htmlComment_ignoredIfInJavaScript() {
codeResolver.givenCode("template.jte", "@param String name\n<script>var name=\"<!--this is not a comment ${name}-->\"</script>");
templateEngine.render("template.jte", "Hello", output);
assertThat(output.toString()).isEqualTo("<script>var name=\"<!--this is not a comment Hello-->\"</script>");
}
@Test
void htmlComment_ignoredIfInCss() {
codeResolver.givenCode("template.jte", "@param String name\n<style type=\"text/css\"><!--this is not a comment ${name}--></style>");
templateEngine.render("template.jte", "Hello", output);
assertThat(output.toString()).isEqualTo("<style type=\"text/css\"><!--this is not a comment Hello--></style>");
}
@Test
void htmlComment_ignoredIfInJavaPart() {
codeResolver.givenCode("template.jte", "@param String name\n<span>${\"<!--this is not a comment \" + name + \"-->\"}</span>");
templateEngine.render("template.jte", "Hello", output);
assertThat(output.toString()).isEqualTo("<span><!--this is not a comment Hello--></span>");
}
@Test
void htmlComment_ignoredIfInJavaPart2() {
codeResolver.givenCode("template.jte", "@param String name\n<span>!{String x = \"<!--this is not a comment \" + name + \"-->\";}${x}</span>");
templateEngine.render("template.jte", "Hello", output);
assertThat(output.toString()).isEqualTo("<span><!--this is not a comment Hello--></span>");
}
@Test
void htmlComment_raw() {
codeResolver.givenCode("template.jte", "@param String url\n@raw<!-- html comment -->@endraw<a href=\"${url}\">Click me!</a>");
templateEngine.render("template.jte", "https://jte.gg", output);
assertThat(output.toString()).isEqualTo("<!-- html comment --><a href=\"https://jte.gg\">Click me!</a>");
}
@Test
void jsComment() {
codeResolver.givenCode("template.jte", "@param String hello\n<script>// hello\nvar x = 'hello';</script>${hello}");
templateEngine.render("template.jte", "Hello", output);
assertThat(output.toString()).isEqualTo("<script>\nvar x = 'hello';</script>Hello");
}
@Test
void jsComment_withHtmlCommentsPreserved() {
codeResolver.givenCode("template.jte", "@param String hello\n<script>// hello\nvar x = 'hello';</script>${hello}");
templateEngine.setHtmlCommentsPreserved(true);
templateEngine.render("template.jte", "Hello", output);
assertThat(output.toString()).isEqualTo("<script>// hello\nvar x = 'hello';</script>Hello");
}
@Test
void jsComment_onlyComment() {
codeResolver.givenCode("template.jte", "@param String hello\n<script>// hello</script>${hello}");
templateEngine.render("template.jte", "Hello", output);
assertThat(output.toString()).isEqualTo("<script></script>Hello");
}
@Test
void jsComment_string_singleQuote() {
codeResolver.givenCode("template.jte", "@param String hello\n<script>var x = '// hello, hello';</script>${hello}");
templateEngine.render("template.jte", "Hello", output);
assertThat(output.toString()).isEqualTo("<script>var x = '// hello, hello';</script>Hello");
}
@Test
void jsComment_string_doubleQuote() {
codeResolver.givenCode("template.jte", "@param String hello\n<script>var x = \"// hello, hello\";</script>${hello}");
templateEngine.render("template.jte", "Hello", output);
assertThat(output.toString()).isEqualTo("<script>var x = \"// hello, hello\";</script>Hello");
}
@Test
void jsComment_lineBreaks() {
codeResolver.givenCode("template.jte", "@param String hello\n<script>\n" +
" x.value = \"false\" // foo\n" +
" x.test() // bar\n" +
"</script>\n" +
"${hello}");
templateEngine.render("template.jte", "Hello", output);
assertThat(output.toString()).isEqualTo("<script>\n" +
" x.value = \"false\" \n" +
" x.test() \n" +
"</script>\nHello");
}
@Test
void jsBlockComment() {
codeResolver.givenCode("template.jte", "@param String hello\n<script>/* hello*/var x = 'hello';</script>${hello}");
templateEngine.render("template.jte", "Hello", output);
assertThat(output.toString()).isEqualTo("<script>var x = 'hello';</script>Hello");
}
@Test
void jsBlockComment_withHtmlCommentsPreserved() {
codeResolver.givenCode("template.jte", "@param String hello\n<script>/* hello*/var x = 'hello';</script>${hello}");
templateEngine.setHtmlCommentsPreserved(true);
templateEngine.render("template.jte", "Hello", output);
assertThat(output.toString()).isEqualTo("<script>/* hello*/var x = 'hello';</script>Hello");
}
@Test
void jsBlockComment_onlyComment() {
codeResolver.givenCode("template.jte", "@param String hello\n<script>/* hello*/</script>${hello}");
templateEngine.render("template.jte", "Hello", output);
assertThat(output.toString()).isEqualTo("<script></script>Hello");
}
@Test
void jsBlockComment_string_singleQuote() {
codeResolver.givenCode("template.jte", "@param String hello\n<script>var x = '/* hello, hello';</script>${hello}");
templateEngine.render("template.jte", "Hello", output);
assertThat(output.toString()).isEqualTo("<script>var x = '/* hello, hello';</script>Hello");
}
@Test
void jsBlockComment_string_doubleQuote() {
codeResolver.givenCode("template.jte", "@param String hello\n<script>var x = \"/* hello, hello\";</script>${hello}");
templateEngine.render("template.jte", "Hello", output);
assertThat(output.toString()).isEqualTo("<script>var x = \"/* hello, hello\";</script>Hello");
}
@Test
void cssComment() {
codeResolver.givenCode("template.jte", "<style type=\"text/css\">/*This is it!*/html { height: 100%;}</style>");
templateEngine.render("template.jte", "Hello", output);
assertThat(output.toString()).isEqualTo("<style type=\"text/css\">html { height: 100%;}</style>");
}
@Test
void cssComment_withHtmlCommentsPreserved() {
codeResolver.givenCode("template.jte", "<style type=\"text/css\">/*This is it!*/html { height: 100%;}</style>");
templateEngine.setHtmlCommentsPreserved(true);
templateEngine.render("template.jte", "Hello", output);
assertThat(output.toString()).isEqualTo("<style type=\"text/css\">/*This is it!*/html { height: 100%;}</style>");
}
@Test
void cssComment_string_singleQuote() {
codeResolver.givenCode("template.jte", "<style type=\"text/css\">/*This is it!*/.smog::after { content: '/*cough*/';/*funny*/}</style>");
templateEngine.render("template.jte", "Hello", output);
assertThat(output.toString()).isEqualTo("<style type=\"text/css\">.smog::after { content: '/*cough*/';}</style>");
}
@Test
void cssComment_string_singleQuote_escape() {
codeResolver.givenCode("template.jte", "<style type=\"text/css\">/*This is it!*/.smog::after { content: 'Let\\'s /*cough*/';/*funny*/}</style>");
templateEngine.render("template.jte", "Hello", output);
assertThat(output.toString()).isEqualTo("<style type=\"text/css\">.smog::after { content: 'Let\\'s /*cough*/';}</style>");
}
@Test
void cssComment_string_doubleQuote() {
codeResolver.givenCode("template.jte", "<style type=\"text/css\">/*This is it!*/.smog::after { content: \"/*cough*/\";/*funny*/}</style>");
templateEngine.render("template.jte", "Hello", output);
assertThat(output.toString()).isEqualTo("<style type=\"text/css\">.smog::after { content: \"/*cough*/\";}</style>");
}
@Test
void cssComment_string_doubleQuote_escape() {
codeResolver.givenCode("template.jte", "<style type=\"text/css\">/*This is it!*/.smog::after { content: \"Let\\'s /*cough*/\";/*funny*/}</style>");
templateEngine.render("template.jte", "Hello", output);
assertThat(output.toString()).isEqualTo("<style type=\"text/css\">.smog::after { content: \"Let\\'s /*cough*/\";}</style>");
}
@Test
void script1() {
codeResolver.givenCode("template.jte", "@param String userName\n<script>var x = 'Hello, ${userName}';</script>");
templateEngine.render("template.jte", "'; alert('Visit my site!'); var y ='", output);
assertThat(output.toString()).isEqualTo("<script>var x = 'Hello, \\'; alert(\\'Visit my site!\\'); var y =\\'';</script>");
}
@Test
void script2() {
codeResolver.givenCode("template.jte", "@param int amount\n<script>if (amount<${amount}) {alert('Amount is ' + ${amount})};</script>");
templateEngine.render("template.jte", 5, output);
assertThat(output.toString()).isEqualTo("<script>if (amount<5) {alert('Amount is ' + 5)};</script>");
}
@Test
void script3() {
codeResolver.givenCode("template.jte", "@param int amount\n<script>writeToDom('<p>test ${amount}</p>');</script>");
templateEngine.render("template.jte", 5, output);
assertThat(output.toString()).isEqualTo("<script>writeToDom('<p>test 5</p>');</script>");
}
@Test
void script4() {
codeResolver.givenCode("template.jte", "<div class=\"container\">\n" +
" <script>\n" +
" $(document).ready(function() {\n" +
" var orderId = getUrlParameter('orderId');\n" +
" $.get('shop/order?orderId=' + orderId, {}, function (data) {\n" +
" var address = data.deliveryAddress.firstName + ' ' + data.deliveryAddress.lastName + '<br/>';\n" +
" address += data.deliveryAddress.street + '<br/>';\n" +
" if (data.deliveryAddress.company !== null && data.deliveryAddress.company.length > 0) {\n" +
" address += data.deliveryAddress.company + '<br/>';\n" +
" }\n" +
" address += data.deliveryAddress.postCode + '<br/>';\n" +
" address += data.deliveryAddress.city + '<br/>';\n" +
" address += data.deliveryAddress.country + '<br/>';\n" +
" $('#shipping-address').html(address);\n" +
" $('.physical-item').html(data.physicalItemName);\n" +
" });\n" +
" });\n" +
" </script>\n" +
"</div>");
templateEngine.render("template.jte", null, output);
assertThat(output.toString()).isEqualTo("<div class=\"container\">\n" +
" <script>\n" +
" $(document).ready(function() {\n" +
" var orderId = getUrlParameter('orderId');\n" +
" $.get('shop/order?orderId=' + orderId, {}, function (data) {\n" +
" var address = data.deliveryAddress.firstName + ' ' + data.deliveryAddress.lastName + '<br/>';\n" +
" address += data.deliveryAddress.street + '<br/>';\n" +
" if (data.deliveryAddress.company !== null && data.deliveryAddress.company.length > 0) {\n" +
" address += data.deliveryAddress.company + '<br/>';\n" +
" }\n" +
" address += data.deliveryAddress.postCode + '<br/>';\n" +
" address += data.deliveryAddress.city + '<br/>';\n" +
" address += data.deliveryAddress.country + '<br/>';\n" +
" $('#shipping-address').html(address);\n" +
" $('.physical-item').html(data.physicalItemName);\n" +
" });\n" +
" });\n" +
" </script>\n" +
"</div>");
}
@Test
void onMethods() {
codeResolver.givenCode("template.jte", "@param String userName\n\n<span onclick=\"showName('${userName}')\">Click me</span>");
templateEngine.render("template.jte", "'); alert('xss", output);
assertThat(output.toString()).isEqualTo("\n<span onclick=\"showName('\\x27); alert(\\x27xss')\">Click me</span>");
}
@Test
void onMethods_policy() {
OwaspHtmlPolicy policy = new OwaspHtmlPolicy();
policy.addPolicy(new PreventInlineEventHandlers());
templateEngine.setHtmlPolicy(policy);
codeResolver.givenCode("template.jte", "@param String name\n\n<span data-title=\"${name}\" onclick=\"showName('${name}')\">Click me</span>");
Throwable throwable = catchThrowable(() -> templateEngine.render("template.jte", "'); alert('xss", output));
assertThat(throwable).hasMessage("Failed to compile template.jte, error at line 3: Inline event handlers are not allowed: onclick");
}
@Test
void css() {
codeResolver.givenCode("template.jte", "<style type=\"text/css\">\n" +
"/*<![CDATA[*/\n" +
"body {\n" +
"\tcolor: #333333;\n" +
"\tline-height: 150%;\n" +
"}\n" +
"\n" +
"thead {\n" +
"\tfont-weight: bold;\n" +
"\tbackground-color: #CCCCCC;\n" +
"}\n" +
"/*]]>*/\n" +
"</style>");
templateEngine.render("template.jte", null, output);
assertThat(output.toString()).isEqualTo("<style type=\"text/css\">\n" +
"\n" +
"body {\n" +
"\tcolor: #333333;\n" +
"\tline-height: 150%;\n" +
"}\n" +
"\n" +
"thead {\n" +
"\tfont-weight: bold;\n" +
"\tbackground-color: #CCCCCC;\n" +
"}\n" +
"\n" +
"</style>");
}
@Test
void inlineStyle() {
// TODO We will probably forbid this by HtmlPolicy, so not needed atm
}
@Test
void forbidUnquotedAttributeValues() {
codeResolver.givenCode("template.jte", "@param String id\n\n<span id=${id}></span>");
Throwable throwable = catchThrowable(() -> templateEngine.render("template.jte", "test", output));
assertThat(throwable).isInstanceOf(TemplateException.class).hasMessage("Failed to compile template.jte, error at line 3: Unquoted HTML attribute values are not allowed: id");
}
@Test
void forbidUnqotedAttributeValues_attributeContentIsIgnored() {
codeResolver.givenCode("template.jte", "<meta name=\"viewport\" content=\"width=device-width, initial-scale=1\">");
templateEngine.render("template.jte", null, output);
assertThat(output.toString()).isEqualTo("<meta name=\"viewport\" content=\"width=device-width, initial-scale=1\">");
}
@Test
void forbidUnqotedAttributeValues_emptyAttribute() {
codeResolver.givenCode("template.jte", "<div data-test-important-content>");
templateEngine.render("template.jte", null, output);
assertThat(output.toString()).isEqualTo("<div data-test-important-content>");
}
@Test
void singleQuotedAttributeValues() {
codeResolver.givenCode("template.jte", "@param String id\n\n<span id='${id}'></span>");
templateEngine.render("template.jte", "<script>console.log(\"Hello\")</script>", output);
assertThat(output.toString()).isEqualTo("\n<span id='<script>console.log("Hello")</script>'></span>");
}
@Test
void forbidSingleQuotedAttributeValues() {
OwaspHtmlPolicy htmlPolicy = new OwaspHtmlPolicy();
htmlPolicy.addPolicy(new PreventSingleQuotedAttributes());
templateEngine.setHtmlPolicy(htmlPolicy);
codeResolver.givenCode("template.jte", "@param String id\n\n<span id='${id}'></span>");
Throwable throwable = catchThrowable(() -> templateEngine.render("template.jte", "test", output));
assertThat(throwable).isInstanceOf(TemplateException.class).hasMessage("Failed to compile template.jte, error at line 3: HTML attribute values must be double quoted: id");
}
@Test
void forbidSingleQuotedAttributeValues_boolean() {
OwaspHtmlPolicy htmlPolicy = new OwaspHtmlPolicy();
htmlPolicy.addPolicy(new PreventSingleQuotedAttributes());
templateEngine.setHtmlPolicy(htmlPolicy);
codeResolver.givenCode("template.jte", "@param String id\n<input id=\"${id}\" required>");
templateEngine.render("template.jte", "test", output);
assertThat(output.toString()).isEqualTo("<input id=\"test\" required>");
}
@Test
void forbidSingleQuotedAttributeValues_empty() {
OwaspHtmlPolicy htmlPolicy = new OwaspHtmlPolicy();
htmlPolicy.addPolicy(new PreventSingleQuotedAttributes());
templateEngine.setHtmlPolicy(htmlPolicy);
codeResolver.givenCode("template.jte", "@param String id\n<input data-webtest>");
templateEngine.render("template.jte", "test", output);
assertThat(output.toString()).isEqualTo("<input data-webtest>");
}
@Test
void enumInTagBody() {
codeResolver.givenCode("template.jte", "@param gg.jte.TemplateEngineTest.ModelType type\n<div>${type}</div>");
templateEngine.render("template.jte", TemplateEngineTest.ModelType.Two, output);
assertThat(output.toString()).isEqualTo("<div>Two</div>");
}
@Test
void enumInTagAttribute() {
codeResolver.givenCode("template.jte", "@param gg.jte.TemplateEngineTest.ModelType type\n<div data-type=\"${type}\"></div>");
templateEngine.render("template.jte", TemplateEngineTest.ModelType.Two, output);
assertThat(output.toString()).isEqualTo("<div data-type=\"Two\"></div>");
}
@Test
void nullInTagBody() {
codeResolver.givenCode("template.jte", "@param String type\n<div>${type}</div>");
templateEngine.render("template.jte", Collections.singletonMap("type", null), output);
assertThat(output.toString()).isEqualTo("<div></div>");
}
@Test
void nullInTagAttribute() {
codeResolver.givenCode("template.jte", "@param String type\n<div data-type=\"${type}\"></div>");
templateEngine.render("template.jte", Collections.singletonMap("type", null), output);
assertThat(output.toString()).isEqualTo("<div></div>");
}
@Test
void uppercaseTag() {
codeResolver.givenCode("template.jte", "@param String url\n<A href=\"${url}\">Click me!</A>");
Throwable throwable = catchThrowable(() -> templateEngine.render("template.jte", "javascript:alert(1)", output));
assertThat(throwable.getMessage()).isEqualTo("Failed to compile template.jte, error at line 2: HTML tags are expected to be lowercase: A");
}
@Test
void uppercaseAttribute() {
codeResolver.givenCode("template.jte", "@param String url\n<a HREF=\"${url}\">Click me!</a>");
Throwable throwable = catchThrowable(() -> templateEngine.render("template.jte", "javascript:alert(1)", output));
assertThat(throwable.getMessage()).isEqualTo("Failed to compile template.jte, error at line 2: HTML attributes are expected to be lowercase: HREF");
}
@Test
void contentBlockInAttribute() {
codeResolver.givenCode("template.jte", "@param gg.jte.Content content = @`This is \"the way\"!`\n<span data-title=\"${content}\">Info</span>");
templateEngine.render("template.jte", new HashMap<>(), output);
assertThat(output.toString()).isEqualTo("<span data-title=\"This is "the way"!\">Info</span>");
}
@Test
void contentBlockInAttribute2() {
codeResolver.givenCode("template.jte", "@param gg.jte.Content content = @`This is <b>the way</b>!`\n<span data-title=\"${content}\" foo=\"bar\">${content}</span>");
templateEngine.render("template.jte", new HashMap<>(), output);
assertThat(output.toString()).isEqualTo("<span data-title=\"This is <b>the way</b>!\" foo=\"bar\">This is <b>the way</b>!</span>");
}
@Test
void contentBlockInAttribute3() {
codeResolver.givenCode("template.jte",
"@param String url\n" +
"!{gg.jte.Content content = @`<a href=\"${url}\" class=\"foo\">Hello</a>`;}\n" +
"${content}");