-
Notifications
You must be signed in to change notification settings - Fork 2k
/
ProxyControl.java
1664 lines (1489 loc) · 70.3 KB
/
ProxyControl.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
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to you under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.jmeter.protocol.http.proxy;
import java.awt.event.ActionEvent;
import java.io.BufferedInputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.Serializable;
import java.net.MalformedURLException;
import java.nio.charset.StandardCharsets;
import java.security.GeneralSecurityException;
import java.security.KeyStore;
import java.security.UnrecoverableKeyException;
import java.security.cert.CertificateExpiredException;
import java.security.cert.CertificateNotYetValidException;
import java.security.cert.X509Certificate;
import java.util.ArrayDeque;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Date;
import java.util.Enumeration;
import java.util.HashSet;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.prefs.Preferences;
import org.apache.commons.codec.binary.Base64;
import org.apache.commons.codec.digest.DigestUtils;
import org.apache.commons.lang3.StringUtils;
import org.apache.commons.lang3.time.DateUtils;
import org.apache.http.conn.ssl.AbstractVerifier;
import org.apache.jmeter.assertions.Assertion;
import org.apache.jmeter.assertions.ResponseAssertion;
import org.apache.jmeter.assertions.gui.AssertionGui;
import org.apache.jmeter.config.Arguments;
import org.apache.jmeter.config.ConfigElement;
import org.apache.jmeter.config.ConfigTestElement;
import org.apache.jmeter.control.GenericController;
import org.apache.jmeter.control.TransactionController;
import org.apache.jmeter.control.gui.LogicControllerGui;
import org.apache.jmeter.control.gui.TransactionControllerGui;
import org.apache.jmeter.engine.util.ValueReplacer;
import org.apache.jmeter.exceptions.IllegalUserActionException;
import org.apache.jmeter.functions.InvalidVariableException;
import org.apache.jmeter.gui.GuiPackage;
import org.apache.jmeter.gui.tree.JMeterTreeModel;
import org.apache.jmeter.gui.tree.JMeterTreeNode;
import org.apache.jmeter.processor.PostProcessor;
import org.apache.jmeter.processor.PreProcessor;
import org.apache.jmeter.protocol.http.control.AuthManager;
import org.apache.jmeter.protocol.http.control.AuthManager.Mechanism;
import org.apache.jmeter.protocol.http.control.Authorization;
import org.apache.jmeter.protocol.http.control.Header;
import org.apache.jmeter.protocol.http.control.HeaderManager;
import org.apache.jmeter.protocol.http.control.RecordingController;
import org.apache.jmeter.protocol.http.gui.AuthPanel;
import org.apache.jmeter.protocol.http.sampler.HTTPSampleResult;
import org.apache.jmeter.protocol.http.sampler.HTTPSamplerBase;
import org.apache.jmeter.protocol.http.sampler.HTTPSamplerFactory;
import org.apache.jmeter.protocol.http.util.HTTPConstants;
import org.apache.jmeter.samplers.SampleEvent;
import org.apache.jmeter.samplers.SampleListener;
import org.apache.jmeter.samplers.SampleResult;
import org.apache.jmeter.testbeans.TestBeanHelper;
import org.apache.jmeter.testelement.NonTestElement;
import org.apache.jmeter.testelement.TestElement;
import org.apache.jmeter.testelement.TestPlan;
import org.apache.jmeter.testelement.TestStateListener;
import org.apache.jmeter.testelement.property.BooleanProperty;
import org.apache.jmeter.testelement.property.CollectionProperty;
import org.apache.jmeter.testelement.property.IntegerProperty;
import org.apache.jmeter.testelement.property.JMeterProperty;
import org.apache.jmeter.testelement.property.PropertyIterator;
import org.apache.jmeter.testelement.property.StringProperty;
import org.apache.jmeter.testelement.property.TestElementProperty;
import org.apache.jmeter.threads.AbstractThreadGroup;
import org.apache.jmeter.timers.Timer;
import org.apache.jmeter.util.JMeterUtils;
import org.apache.jmeter.visualizers.Visualizer;
import org.apache.jorphan.exec.KeyToolUtils;
import org.apache.jorphan.util.JOrphanUtils;
import org.apache.oro.text.MalformedCachePatternException;
import org.apache.oro.text.regex.Pattern;
import org.apache.oro.text.regex.Perl5Compiler;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/** Class handles storing of generated samples etc. */
public class ProxyControl extends GenericController implements NonTestElement {
private static final Logger log = LoggerFactory.getLogger(ProxyControl.class);
private static final long serialVersionUID = 240L;
private static final String ASSERTION_GUI = AssertionGui.class.getName();
private static final String TRANSACTION_CONTROLLER_GUI = TransactionControllerGui.class.getName();
private static final String LOGIC_CONTROLLER_GUI = LogicControllerGui.class.getName();
private static final String AUTH_PANEL = AuthPanel.class.getName();
private static final String AUTH_MANAGER = AuthManager.class.getName();
public static final int DEFAULT_PORT = 8888;
// and as a string
public static final String DEFAULT_PORT_S = Integer.toString(DEFAULT_PORT);
//+ JMX file attributes
private static final String PORT = "ProxyControlGui.port"; // $NON-NLS-1$
private static final String DOMAINS = "ProxyControlGui.domains"; // $NON-NLS-1$
private static final String EXCLUDE_LIST = "ProxyControlGui.exclude_list"; // $NON-NLS-1$
private static final String INCLUDE_LIST = "ProxyControlGui.include_list"; // $NON-NLS-1$
private static final String CAPTURE_HTTP_HEADERS = "ProxyControlGui.capture_http_headers"; // $NON-NLS-1$
private static final String ADD_ASSERTIONS = "ProxyControlGui.add_assertion"; // $NON-NLS-1$
private static final String GROUPING_MODE = "ProxyControlGui.grouping_mode"; // $NON-NLS-1$
private static final String SAMPLER_TYPE_NAME = "ProxyControlGui.sampler_type_name"; // $NON-NLS-1$
private static final String SAMPLER_REDIRECT_AUTOMATICALLY = "ProxyControlGui.sampler_redirect_automatically"; // $NON-NLS-1$
private static final String SAMPLER_FOLLOW_REDIRECTS = "ProxyControlGui.sampler_follow_redirects"; // $NON-NLS-1$
private static final String USE_KEEPALIVE = "ProxyControlGui.use_keepalive"; // $NON-NLS-1$
private static final String SAMPLER_DOWNLOAD_IMAGES = "ProxyControlGui.sampler_download_images"; // $NON-NLS-1$
private static final String HTTP_SAMPLER_NAMING_MODE = "ProxyControlGui.proxy_http_sampler_naming_mode"; // $NON-NLS-1$
private static final String PREFIX_HTTP_SAMPLER_NAME = "ProxyControlGui.proxy_prefix_http_sampler_name"; // $NON-NLS-1$
private static final String PROXY_PAUSE_HTTP_SAMPLER = "ProxyControlGui.proxy_pause_http_sampler"; // $NON-NLS-1$
private static final String DEFAULT_ENCODING_PROPERTY = "ProxyControlGui.default_encoding"; // $NON-NLS-1$
private static final String REGEX_MATCH = "ProxyControlGui.regex_match"; // $NON-NLS-1$
private static final String CONTENT_TYPE_EXCLUDE = "ProxyControlGui.content_type_exclude"; // $NON-NLS-1$
private static final String CONTENT_TYPE_INCLUDE = "ProxyControlGui.content_type_include"; // $NON-NLS-1$
private static final String NOTIFY_CHILD_SAMPLER_LISTENERS_FILTERED = "ProxyControlGui.notify_child_sl_filtered"; // $NON-NLS-1$
private static final String BEARER_AUTH = "Bearer"; // $NON-NLS-1$
private static final String BASIC_AUTH = "Basic"; // $NON-NLS-1$
private static final String DIGEST_AUTH = "Digest"; // $NON-NLS-1$
//- JMX file attributes
// Must agree with the order of entries in the drop-down
// created in ProxyControlGui.createGroupingPanel()
private static final int GROUPING_ADD_SEPARATORS = 1;
private static final int GROUPING_IN_SIMPLE_CONTROLLERS = 2;
private static final int GROUPING_STORE_FIRST_ONLY = 3;
private static final int GROUPING_IN_TRANSACTION_CONTROLLERS = 4;
// Original numeric order (we now use strings)
private static final String SAMPLER_TYPE_HTTP_SAMPLER_JAVA = "0";
private static final String SAMPLER_TYPE_HTTP_SAMPLER_HC3_1 = "1";
private static final String SAMPLER_TYPE_HTTP_SAMPLER_HC4 = "2";
private long sampleGap;
// for ssl connection
private static final String KEYSTORE_TYPE =
JMeterUtils.getPropDefault("proxy.cert.type", "JKS"); // $NON-NLS-1$ $NON-NLS-2$
// Proxy configuration SSL
private static final String CERT_DIRECTORY =
JMeterUtils.getPropDefault("proxy.cert.directory", JMeterUtils.getJMeterBinDir()); // $NON-NLS-1$
private static final String CERT_FILE_DEFAULT = "proxyserver.jks";// $NON-NLS-1$
private static final String CERT_FILE =
JMeterUtils.getPropDefault("proxy.cert.file", CERT_FILE_DEFAULT); // $NON-NLS-1$
private static final File CERT_PATH = new File(CERT_DIRECTORY, CERT_FILE);
private static final String CERT_PATH_ABS = CERT_PATH.getAbsolutePath();
private static final String DEFAULT_PASSWORD = "password"; // $NON-NLS-1$ NOSONAR only default password, if user has not defined one
/** Keys for user preferences */
private static final String USER_PASSWORD_KEY = "proxy_cert_password"; // NOSONAR not a hardcoded password
// Note: Windows user preferences are stored relative to: HKEY_CURRENT_USER\Software\JavaSoft\Prefs
private static final Preferences PREFERENCES = Preferences.userNodeForPackage(ProxyControl.class);
private static final boolean USE_DYNAMIC_KEYS = JMeterUtils.getPropDefault("proxy.cert.dynamic_keys", true); // $NON-NLS-1$
// The alias to be used if dynamic host names are not possible
static final String JMETER_SERVER_ALIAS = ":jmeter:"; // $NON-NLS-1$
public static final int CERT_VALIDITY = JMeterUtils.getPropDefault("proxy.cert.validity", 7); // $NON-NLS-1$
// If this is defined, it is assumed to be the alias of a user-supplied certificate; overrides dynamic mode
static final String CERT_ALIAS = JMeterUtils.getProperty("proxy.cert.alias"); // $NON-NLS-1$
public enum KeystoreMode {
USER_KEYSTORE, // user-provided keystore
JMETER_KEYSTORE, // keystore generated by JMeter; single entry
DYNAMIC_KEYSTORE,// keystore generated by JMeter; dynamic entries
NONE // cannot use keystore
}
static final KeystoreMode KEYSTORE_MODE;
static {
if (CERT_ALIAS != null) {
KEYSTORE_MODE = KeystoreMode.USER_KEYSTORE;
log.info(
"HTTP(S) Test Script Recorder will use the keystore '{}' with the alias: '{}'",
CERT_PATH_ABS, CERT_ALIAS);
} else {
if (!KeyToolUtils.haveKeytool()) {
KEYSTORE_MODE = KeystoreMode.NONE;
} else if (USE_DYNAMIC_KEYS) {
KEYSTORE_MODE = KeystoreMode.DYNAMIC_KEYSTORE;
log.info(
"HTTP(S) Test Script Recorder SSL Proxy will use keys that support embedded 3rd party resources in file {}",
CERT_PATH_ABS);
} else {
KEYSTORE_MODE = KeystoreMode.JMETER_KEYSTORE;
log.warn(
"HTTP(S) Test Script Recorder SSL Proxy will use keys that may not work for embedded resources in file {}",
CERT_PATH_ABS);
}
}
}
/**
* Whether to use the redirect disabling feature (can be switched off if it does not work)
*/
private static final boolean USE_REDIRECT_DISABLING =
JMeterUtils.getPropDefault("proxy.redirect.disabling", true); // $NON-NLS-1$
// Although this field is mutable, it is only accessed within the synchronized method deliverSampler()
private static String LAST_REDIRECT = null;
private transient Daemon server;
private long lastTime = 0;// When was the last sample seen?
private transient KeyStore keyStore;
private volatile boolean addAssertions = false;
private volatile int groupingMode = 0;
private volatile boolean samplerRedirectAutomatically = false;
private volatile boolean samplerFollowRedirects = false;
private volatile boolean useKeepAlive = false;
private volatile boolean samplerDownloadImages = false;
private volatile boolean notifyChildSamplerListenersOfFilteredSamples = true;
private volatile boolean regexMatch = false;
private Set<Class<?>> addableInterfaces = new HashSet<>(
Arrays.asList(Visualizer.class, ConfigElement.class,
Assertion.class, Timer.class, PreProcessor.class,
PostProcessor.class, SampleListener.class));
/**
* Tree node where the samples should be stored.
* This property is not persistent.
*/
private JMeterTreeNode target;
private String storePassword;
private String keyPassword;
private JMeterTreeModel nonGuiTreeModel;
private ArrayDeque<SamplerInfo> sampleQueue = new ArrayDeque<>();
// accessed from Swing-Thread, only
private String oldPrefix = null;
public ProxyControl() {
setPort(DEFAULT_PORT);
setExcludeList(new HashSet<>());
setIncludeList(new HashSet<>());
setCaptureHttpHeaders(true); // maintain original behaviour
new javax.swing.Timer(200, this::putSamplesIntoModel).start();
}
/**
* Set a {@link JMeterTreeModel} to be used by the ProxyControl, when used
* in a non-GUI environment, where the {@link JMeterTreeModel} can't be
* acquired through {@link GuiPackage#getTreeModel()}
*
* @param treeModel the {@link JMeterTreeModel} to be used, or {@code null} when
* the GUI model should be used
*/
public void setNonGuiTreeModel(JMeterTreeModel treeModel) {
this.nonGuiTreeModel = treeModel;
}
public void setPort(int port) {
this.setProperty(new IntegerProperty(PORT, port));
}
public void setPort(String port) {
setProperty(PORT, port);
}
public void setSslDomains(String domains) {
setProperty(DOMAINS, domains, "");
}
public String getSslDomains() {
return getPropertyAsString(DOMAINS, "");
}
public void setCaptureHttpHeaders(boolean capture) {
setProperty(new BooleanProperty(CAPTURE_HTTP_HEADERS, capture));
}
public void setGroupingMode(int grouping) {
this.groupingMode = grouping;
setProperty(new IntegerProperty(GROUPING_MODE, grouping));
}
public void setAssertions(boolean b) {
addAssertions = b;
setProperty(new BooleanProperty(ADD_ASSERTIONS, b));
}
public void setSamplerTypeName(String samplerTypeName) {
setProperty(new StringProperty(SAMPLER_TYPE_NAME, samplerTypeName));
}
public void setSamplerRedirectAutomatically(boolean b) {
samplerRedirectAutomatically = b;
setProperty(new BooleanProperty(SAMPLER_REDIRECT_AUTOMATICALLY, b));
}
public void setSamplerFollowRedirects(boolean b) {
samplerFollowRedirects = b;
setProperty(new BooleanProperty(SAMPLER_FOLLOW_REDIRECTS, b));
}
public void setUseKeepAlive(boolean b) {
useKeepAlive = b;
setProperty(new BooleanProperty(USE_KEEPALIVE, b));
}
public void setSamplerDownloadImages(boolean b) {
samplerDownloadImages = b;
setProperty(new BooleanProperty(SAMPLER_DOWNLOAD_IMAGES, b));
}
public void setHTTPSampleNamingMode(int httpNamingMode) {
setProperty(new IntegerProperty(HTTP_SAMPLER_NAMING_MODE, httpNamingMode));
}
public String getDefaultEncoding() {
return getPropertyAsString(DEFAULT_ENCODING_PROPERTY, StandardCharsets.UTF_8.name());
}
public void setDefaultEncoding(String defaultEncoding) {
setProperty(DEFAULT_ENCODING_PROPERTY, defaultEncoding);
}
public void setPrefixHTTPSampleName(String prefixHTTPSampleName) {
setProperty(PREFIX_HTTP_SAMPLER_NAME, prefixHTTPSampleName);
}
public void setProxyPauseHTTPSample(String proxyPauseHTTPSample) {
setProperty(PROXY_PAUSE_HTTP_SAMPLER, proxyPauseHTTPSample);
}
public void setNotifyChildSamplerListenerOfFilteredSamplers(boolean b) {
notifyChildSamplerListenersOfFilteredSamples = b;
setProperty(new BooleanProperty(NOTIFY_CHILD_SAMPLER_LISTENERS_FILTERED, b));
}
public void setIncludeList(Collection<String> list) {
setProperty(new CollectionProperty(INCLUDE_LIST, new HashSet<>(list)));
}
public void setExcludeList(Collection<String> list) {
setProperty(new CollectionProperty(EXCLUDE_LIST, new HashSet<>(list)));
}
public void setRegexMatch(boolean b) {
regexMatch = b;
setProperty(new BooleanProperty(REGEX_MATCH, b));
}
public void setContentTypeExclude(String contentTypeExclude) {
setProperty(new StringProperty(CONTENT_TYPE_EXCLUDE, contentTypeExclude));
}
public void setContentTypeInclude(String contentTypeInclude) {
setProperty(new StringProperty(CONTENT_TYPE_INCLUDE, contentTypeInclude));
}
public boolean getAssertions() {
return getPropertyAsBoolean(ADD_ASSERTIONS);
}
public int getGroupingMode() {
return getPropertyAsInt(GROUPING_MODE);
}
public int getPort() {
return getPropertyAsInt(PORT);
}
public String getPortString() {
return getPropertyAsString(PORT);
}
public int getDefaultPort() {
return DEFAULT_PORT;
}
public boolean getCaptureHttpHeaders() {
return getPropertyAsBoolean(CAPTURE_HTTP_HEADERS);
}
public String getSamplerTypeName() {
// Convert the old numeric types - just in case someone wants to reload the workbench
String type = getPropertyAsString(SAMPLER_TYPE_NAME);
if (SAMPLER_TYPE_HTTP_SAMPLER_JAVA.equals(type)) {
type = HTTPSamplerFactory.IMPL_JAVA;
} else if (SAMPLER_TYPE_HTTP_SAMPLER_HC3_1.equals(type)) {
type = HTTPSamplerFactory.IMPL_HTTP_CLIENT4;
} else if (SAMPLER_TYPE_HTTP_SAMPLER_HC4.equals(type)) {
type = HTTPSamplerFactory.IMPL_HTTP_CLIENT4;
}
return type;
}
public boolean getSamplerRedirectAutomatically() {
return getPropertyAsBoolean(SAMPLER_REDIRECT_AUTOMATICALLY, false);
}
public boolean getSamplerFollowRedirects() {
return getPropertyAsBoolean(SAMPLER_FOLLOW_REDIRECTS, true);
}
public boolean getUseKeepalive() {
return getPropertyAsBoolean(USE_KEEPALIVE, true);
}
public boolean getSamplerDownloadImages() {
return getPropertyAsBoolean(SAMPLER_DOWNLOAD_IMAGES, false);
}
public int getHTTPSampleNamingMode() {
return getPropertyAsInt(HTTP_SAMPLER_NAMING_MODE);
}
public String getPrefixHTTPSampleName() {
return getPropertyAsString(PREFIX_HTTP_SAMPLER_NAME);
}
public String getProxyPauseHTTPSample() {
return getPropertyAsString(PROXY_PAUSE_HTTP_SAMPLER);
}
public boolean getNotifyChildSamplerListenerOfFilteredSamplers() {
return getPropertyAsBoolean(NOTIFY_CHILD_SAMPLER_LISTENERS_FILTERED, true);
}
public boolean getRegexMatch() {
return getPropertyAsBoolean(REGEX_MATCH, false);
}
public String getContentTypeExclude() {
return getPropertyAsString(CONTENT_TYPE_EXCLUDE);
}
public String getContentTypeInclude() {
return getPropertyAsString(CONTENT_TYPE_INCLUDE);
}
/**
* @return the {@link JMeterTreeModel} used when run in non-GUI mode, or {@code null} when run in GUI mode
*/
public JMeterTreeModel getNonGuiTreeModel() {
return nonGuiTreeModel;
}
public void addConfigElement(ConfigElement config) {
// NOOP
}
public void startProxy() throws IOException {
try {
initKeyStore();
} catch (GeneralSecurityException e) {
log.error("Could not initialise key store", e);
throw new IOException("Could not create keystore", e);
} catch (IOException e) { // make sure we log the error
log.error("Could not initialise key store", e);
throw e;
}
notifyTestListenersOfStart();
try {
server = new Daemon(getPort(), this);
if (getProxyPauseHTTPSample().isEmpty()) {
sampleGap = JMeterUtils.getPropDefault("proxy.pause", 5000);
} else {
sampleGap = Long.parseLong(getProxyPauseHTTPSample().trim());
}
server.start();
if (GuiPackage.getInstance() != null) {
GuiPackage.getInstance().register(server);
}
} catch (IOException e) {
log.error("Could not create HTTP(S) Test Script Recorder Proxy daemon", e);
throw e;
}
}
public void addExcludedPattern(String pattern) {
getExcludePatterns().addItem(pattern);
}
public CollectionProperty getExcludePatterns() {
return (CollectionProperty) getProperty(EXCLUDE_LIST);
}
public void addIncludedPattern(String pattern) {
getIncludePatterns().addItem(pattern);
}
public CollectionProperty getIncludePatterns() {
return (CollectionProperty) getProperty(INCLUDE_LIST);
}
public void clearExcludedPatterns() {
getExcludePatterns().clear();
}
public void clearIncludedPatterns() {
getIncludePatterns().clear();
}
/** @return the target controller node */
public JMeterTreeNode getTarget() {
return target;
}
/**
* Sets the target node where samples generated by the proxy are to be stored.
*
* @param target target node to store generated samples
*/
public void setTarget(JMeterTreeNode target) {
this.target = target;
}
/**
* Receives the recorded sampler from the proxy server for placing in the
* test tree; this is skipped if the sampler is null (e.g. for recording SSL errors)
* Always sends the result to any registered sample listeners.
*
* @param sampler the sampler, may be null
* @param testElements the test elements to be added (e.g. header manager) under the Sampler
* @param result the sample result, not null
* TODO param serverResponse to be added to allow saving of the
* server's response while recording.
*/
public synchronized void deliverSampler(final HTTPSamplerBase sampler, final TestElement[] testElements, final SampleResult result) {
boolean notifySampleListeners = true;
if (sampler != null) {
if (USE_REDIRECT_DISABLING
&& (samplerRedirectAutomatically || samplerFollowRedirects)
&& result instanceof HTTPSampleResult) {
final HTTPSampleResult httpSampleResult = (HTTPSampleResult) result;
final String urlAsString = httpSampleResult.getUrlAsString();
if (urlAsString.equals(LAST_REDIRECT)) { // the url matches the last redirect
sampler.setEnabled(false);
sampler.setComment("Detected a redirect from the previous sample");
} else { // this is not the result of a redirect
LAST_REDIRECT = null; // so break the chain
}
if (httpSampleResult.isRedirect()) { // Save Location so resulting sample can be disabled
if (LAST_REDIRECT == null) {
sampler.setComment("Detected the start of a redirect chain");
}
LAST_REDIRECT = httpSampleResult.getRedirectLocation();
} else {
LAST_REDIRECT = null;
}
}
if (filterContentType(result) && filterUrl(sampler)) {
JMeterTreeNode myTarget = findTargetControllerNode();
@SuppressWarnings("unchecked") // OK, because find only returns correct element types
Collection<ConfigTestElement> defaultConfigurations = (Collection<ConfigTestElement>) findApplicableElements(
myTarget, ConfigTestElement.class, false);
@SuppressWarnings("unchecked") // OK, because find only returns correct element types
Collection<Arguments> userDefinedVariables = (Collection<Arguments>) findApplicableElements(
myTarget, Arguments.class, true);
removeValuesFromSampler(sampler, defaultConfigurations);
replaceValues(sampler, testElements, userDefinedVariables);
sampler.setAutoRedirects(samplerRedirectAutomatically);
sampler.setFollowRedirects(samplerFollowRedirects);
sampler.setUseKeepAlive(useKeepAlive);
sampler.setImageParser(samplerDownloadImages);
Authorization authorization = createAuthorization(testElements, sampler);
if (authorization != null) {
setAuthorization(authorization, myTarget);
}
sampleQueue.add(new SamplerInfo(sampler, testElements, myTarget, getPrefixHTTPSampleName(), groupingMode));
} else {
if (log.isDebugEnabled()) {
log.debug(
"Sample excluded based on url or content-type: {} - {}",
result.getUrlAsString(), result.getContentType());
}
notifySampleListeners = notifyChildSamplerListenersOfFilteredSamples;
result.setSampleLabel("[" + result.getSampleLabel() + "]");
}
}
if (notifySampleListeners) {
// SampleEvent is not passed JMeterVariables, because they don't make sense for Proxy Recording
notifySampleListeners(new SampleEvent(result, "WorkBench"));
} else {
log.debug(
"Sample not delivered to Child Sampler Listener based on url or content-type: {} - {}",
result.getUrlAsString(), result.getContentType());
}
}
/**
* Detect Header manager in subConfigs,
* Find(if any) Authorization header
* Construct Authentication object
* Removes Authorization if present
*
* @param testElements {@link TestElement}[]
* @param sampler {@link HTTPSamplerBase}
* @return {@link Authorization}
*/
private Authorization createAuthorization(final TestElement[] testElements, HTTPSamplerBase sampler) {
Header authHeader;
Authorization authorization = null;
// Iterate over subconfig elements searching for HeaderManager
for (TestElement te : testElements) {
if (te instanceof HeaderManager) {
@SuppressWarnings("unchecked") // headers should only contain the correct classes
List<TestElementProperty> headers = (ArrayList<TestElementProperty>) ((HeaderManager) te).getHeaders().getObjectValue();
for (Iterator<?> iterator = headers.iterator(); iterator.hasNext();) {
TestElementProperty tep = (TestElementProperty) iterator
.next();
if (tep.getName().equals(HTTPConstants.HEADER_AUTHORIZATION)) {
//Construct Authorization object from HEADER_AUTHORIZATION
authHeader = (Header) tep.getObjectValue();
String headerValue = authHeader.getValue().trim();
String[] authHeaderContent = headerValue.split(" ");//$NON-NLS-1$
String authType;
String authCredentialsBase64;
if(authHeaderContent.length>=2) {
authType = authHeaderContent[0];
// if HEADER_AUTHORIZATION contains "Basic"
// then set Mechanism.BASIC_DIGEST, otherwise Mechanism.KERBEROS
Mechanism mechanism;
switch (authType) {
case BEARER_AUTH:
// This one will need to be correlated manually by user
return null;
case DIGEST_AUTH:
mechanism = Mechanism.DIGEST;
break;
case BASIC_AUTH:
mechanism = Mechanism.BASIC;
break;
default:
mechanism = Mechanism.KERBEROS;
break;
}
authCredentialsBase64 = authHeaderContent[1];
authorization=new Authorization();
try {
authorization.setURL(sampler.getUrl().toExternalForm());
} catch (MalformedURLException e) {
log.error("Error filling url on authorization, message: {}", e.getMessage(), e);
authorization.setURL("${AUTH_BASE_URL}");//$NON-NLS-1$
}
authorization.setMechanism(mechanism);
if(BASIC_AUTH.equals(authType)) {
String authCred= new String(Base64.decodeBase64(authCredentialsBase64));
String[] loginPassword = authCred.split(":"); //$NON-NLS-1$
if(loginPassword.length == 2) {
authorization.setUser(loginPassword[0]);
authorization.setPass(loginPassword[1]);
} else {
log.error("Error parsing BASIC Auth authorization header:'{}', decoded value:'{}'",
authCredentialsBase64, authCred);
// we keep initial header
return null;
}
} else {
// Digest or Kerberos
authorization.setUser("${AUTH_LOGIN}");//$NON-NLS-1$
authorization.setPass("${AUTH_PASSWORD}");//$NON-NLS-1$
}
}
// remove HEADER_AUTHORIZATION from HeaderManager
// because it's useless after creating Authorization object
iterator.remove();
break;
}
}
}
}
return authorization;
}
public void stopProxy() {
if (server != null) {
server.stopServer();
if (GuiPackage.getInstance() != null) {
GuiPackage.getInstance().unregister(server);
}
try {
server.join(1000); // wait for server to stop
} catch (InterruptedException e) {
//NOOP
Thread.currentThread().interrupt();
}
notifyTestListenersOfEnd();
server = null;
}
}
public String[] getCertificateDetails() {
if (isDynamicMode()) {
try {
X509Certificate caCert = (X509Certificate) keyStore.getCertificate(KeyToolUtils.getRootCAalias());
if (caCert == null) {
return new String[]{"Could not find certificate"};
}
return new String[]
{
caCert.getSubjectX500Principal().toString(),
"Fingerprint(SHA1): " + JOrphanUtils.baToHexString(DigestUtils.sha1(caCert.getEncoded()), ' '),
"Created: "+ caCert.getNotBefore().toString()
};
} catch (GeneralSecurityException e) {
log.error("Problem reading root CA from keystore", e);
return new String[] { "Problem with root certificate", e.getMessage() };
}
}
return new String[0]; // should not happen
}
// Package protected to allow test case access
boolean filterUrl(HTTPSamplerBase sampler) {
String domain = sampler.getDomain();
if (domain == null || domain.length() == 0) {
return false;
}
String url = generateMatchUrl(sampler);
CollectionProperty includePatterns = getIncludePatterns();
if (includePatterns.size() > 0 && !matchesPatterns(url, includePatterns)) {
return false;
}
CollectionProperty excludePatterns = getExcludePatterns();
if (excludePatterns.size() > 0 && matchesPatterns(url, excludePatterns)) {
return false;
}
return true;
}
// Package protected to allow test case access
/**
* Filter the response based on the content type.
* If no include nor exclude filter is specified, the result will be included
*
* @param result the sample result to check
* @return <code>true</code> means result will be kept
*/
boolean filterContentType(SampleResult result) {
String includeExp = getContentTypeInclude();
String excludeExp = getContentTypeExclude();
// If no expressions are specified, we let the sample pass
if((includeExp == null || includeExp.length() == 0) &&
(excludeExp == null || excludeExp.length() == 0)
)
{
return true;
}
// Check that we have a content type
String sampleContentType = result.getContentType();
if (sampleContentType == null || sampleContentType.length() == 0) {
if (log.isDebugEnabled()) {
log.debug("No Content-type found for : {}", result.getUrlAsString());
}
return true;
}
if (log.isDebugEnabled()) {
log.debug("Content-type to filter : {}", sampleContentType);
}
// Check if the include pattern is matched
boolean matched = testPattern(includeExp, sampleContentType, true);
if(!matched) {
return false;
}
// Check if the exclude pattern is matched
matched = testPattern(excludeExp, sampleContentType, false);
if(!matched) {
return false;
}
return true;
}
/**
* Returns true if matching pattern was different from expectedToMatch
*
* @param expression Expression to match
* @param sampleContentType content to check
* @return boolean true if Matching expression
*/
private boolean testPattern(String expression, String sampleContentType, boolean expectedToMatch) {
if(expression != null && expression.length() > 0) {
if(log.isDebugEnabled()) {
log.debug(
"Testing Expression : {} on sampleContentType: {}, expected to match: {}",
expression, sampleContentType, expectedToMatch);
}
Pattern pattern = null;
try {
pattern = JMeterUtils.getPatternCache().getPattern(expression, Perl5Compiler.READ_ONLY_MASK | Perl5Compiler.SINGLELINE_MASK);
if(JMeterUtils.getMatcher().contains(sampleContentType, pattern) != expectedToMatch) {
return false;
}
} catch (MalformedCachePatternException e) {
log.warn("Skipped invalid content pattern: {}", expression, e);
}
}
return true;
}
/**
* Find if there is any AuthManager in JMeterTreeModel
* If there is no one, create and add it to tree
* Add authorization object to AuthManager
*
* @param authorization {@link Authorization}
* @param target {@link JMeterTreeNode}
*/
private void setAuthorization(Authorization authorization, JMeterTreeNode target) {
JMeterTreeModel jmeterTreeModel = getJmeterTreeModel();
List<JMeterTreeNode> authManagerNodes = jmeterTreeModel.getNodesOfType(AuthManager.class);
if (authManagerNodes.isEmpty()) {
try {
log.debug("Creating HTTP Authentication manager for authorization: {}", authorization);
AuthManager authManager = newAuthorizationManager(authorization);
jmeterTreeModel.addComponent(authManager, target);
} catch (IllegalUserActionException e) {
log.error("Failed to add Authorization Manager to target node: {}", target.getName(), e);
}
} else {
AuthManager authManager = (AuthManager) authManagerNodes.get(0).getTestElement();
authManager.addAuth(authorization);
}
}
private JMeterTreeModel getJmeterTreeModel() {
if (this.nonGuiTreeModel == null) {
return GuiPackage.getInstance().getTreeModel();
}
return this.nonGuiTreeModel;
}
/**
* Helper method to add a Response Assertion
* Called from AWT Event thread
*/
private void addAssertion(JMeterTreeModel model, JMeterTreeNode node) throws IllegalUserActionException {
ResponseAssertion ra = new ResponseAssertion();
ra.setProperty(TestElement.GUI_CLASS, ASSERTION_GUI);
ra.setName(JMeterUtils.getResString("assertion_title")); // $NON-NLS-1$
ra.setTestFieldResponseData();
model.addComponent(ra, node);
}
/** Construct a new AuthManager with the provided authorization */
private AuthManager newAuthorizationManager(Authorization authorization) {
AuthManager authManager = new AuthManager();
authManager.setProperty(TestElement.GUI_CLASS, AUTH_PANEL);
authManager.setProperty(TestElement.TEST_CLASS, AUTH_MANAGER);
authManager.setName("HTTP Authorization Manager");
authManager.addAuth(authorization);
return authManager;
}
/**
* Helper method to add a Divider
* Called from Application Thread that needs to update GUI (JMeterTreeModel)
*/
private void addDivider(final JMeterTreeModel model, final JMeterTreeNode node) {
final GenericController sc = new GenericController();
sc.setProperty(TestElement.GUI_CLASS, LOGIC_CONTROLLER_GUI);
sc.setName("-------------------"); // $NON-NLS-1$
safelyAddComponent(model, node, sc);
}
private void safelyAddComponent(
final JMeterTreeModel model,
final JMeterTreeNode node,
final GenericController controller) {
JMeterUtils.runSafe(true, () -> {
try {
model.addComponent(controller, node);
} catch (IllegalUserActionException e) {
log.error("Program error", e);
throw new Error(e);
}
});
}
/**
* Helper method to add a Simple Controller to contain the samplers.
* Called from Application Thread that needs to update GUI (JMeterTreeModel)
*
* @param model Test component tree model
* @param node Node in the tree where we will add the Controller
* @param name A name for the Controller
*/
private void addSimpleController(final JMeterTreeModel model, final JMeterTreeNode node, String name) {
final GenericController sc = new GenericController();
sc.setProperty(TestElement.GUI_CLASS, LOGIC_CONTROLLER_GUI);
sc.setName(name);
safelyAddComponent(model, node, sc);
}
/**
* Helper method to add a Transaction Controller to contain the samplers.
* Called from Application Thread that needs to update GUI (JMeterTreeModel)
*
* @param model Test component tree model
* @param node Node in the tree where we will add the Controller
* @param name A name for the Controller
*/
private void addTransactionController(final JMeterTreeModel model, final JMeterTreeNode node, String name) {
final TransactionController sc = new TransactionController();
sc.setIncludeTimers(false);
sc.setProperty(TestElement.GUI_CLASS, TRANSACTION_CONTROLLER_GUI);
sc.setName(name);
safelyAddComponent(model, node, sc);
}
/**
* Helper method to replicate any timers found within the Proxy Controller
* into the provided sampler, while replacing any occurrences of string _T_
* in the timer's configuration with the provided deltaT.
* Called from AWT Event thread
*
* @param model Test component tree model
* @param node Sampler node in where we will add the timers
* @param deltaT Time interval from the previous request
*/
private void addTimers(JMeterTreeModel model, JMeterTreeNode node, long deltaT) {
TestPlan variables = new TestPlan();
variables.addParameter("T", Long.toString(deltaT)); // $NON-NLS-1$
ValueReplacer replacer = new ValueReplacer(variables);
JMeterTreeNode mySelf = model.getNodeOf(this);
if(mySelf != null) {
Enumeration<?> children = mySelf.children();
while (children.hasMoreElements()) {
JMeterTreeNode templateNode = (JMeterTreeNode)children.nextElement();
if (templateNode.isEnabled()) {
TestElement template = templateNode.getTestElement();
if (template instanceof Timer) {
TestElement timer = (TestElement) template.clone();
try {
timer.setComment("Recorded:"+Long.toString(deltaT)+"ms");
replacer.undoReverseReplace(timer);
model.addComponent(timer, node);
} catch (InvalidVariableException