-
Notifications
You must be signed in to change notification settings - Fork 282
/
SecurityAdmin.java
1513 lines (1224 loc) · 73 KB
/
SecurityAdmin.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
/*
* Copyright 2015-2018 _floragunn_ GmbH
* Licensed 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.
*/
/*
* SPDX-License-Identifier: Apache-2.0
*
* The OpenSearch Contributors require contributions made to
* this file be licensed under the Apache-2.0 license or a
* compatible open source license.
*
* Modifications Copyright OpenSearch Contributors. See
* GitHub history for details.
*/
package org.opensearch.security.tools;
import java.io.ByteArrayInputStream;
import java.io.Console;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileWriter;
import java.io.IOException;
import java.io.InputStream;
import java.io.Reader;
import java.io.Writer;
import java.net.InetSocketAddress;
import java.net.Socket;
import java.nio.charset.StandardCharsets;
import java.nio.file.Paths;
import java.security.KeyStore;
import java.security.PrivateKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.text.SimpleDateFormat;
import java.util.Arrays;
import java.util.Date;
import java.util.HashMap;
import java.util.Locale;
import java.util.Map;
import javax.net.ssl.HostnameVerifier;
import javax.net.ssl.SSLContext;
import com.fasterxml.jackson.databind.InjectableValues;
import com.fasterxml.jackson.databind.JsonNode;
import com.google.common.base.Charsets;
import com.google.common.base.Joiner;
import com.google.common.collect.Iterators;
import com.google.common.io.ByteSource;
import com.google.common.io.CharStreams;
import com.google.common.io.Files;
import org.apache.commons.cli.CommandLine;
import org.apache.commons.cli.CommandLineParser;
import org.apache.commons.cli.DefaultParser;
import org.apache.commons.cli.HelpFormatter;
import org.apache.commons.cli.Option;
import org.apache.commons.cli.Options;
import org.apache.commons.cli.ParseException;
import org.apache.http.HttpHost;
import org.apache.http.conn.ssl.DefaultHostnameVerifier;
import org.apache.http.conn.ssl.NoopHostnameVerifier;
import org.apache.http.nio.conn.ssl.SSLIOSessionStrategy;
import org.apache.http.ssl.SSLContextBuilder;
import org.apache.http.ssl.SSLContexts;
import org.opensearch.ExceptionsHelper;
import org.opensearch.OpenSearchException;
import org.opensearch.OpenSearchStatusException;
import org.opensearch.Version;
import org.opensearch.action.admin.cluster.health.ClusterHealthRequest;
import org.opensearch.action.admin.cluster.health.ClusterHealthResponse;
import org.opensearch.action.admin.cluster.settings.ClusterUpdateSettingsRequest;
import org.opensearch.action.admin.indices.delete.DeleteIndexRequest;
import org.opensearch.action.admin.indices.settings.put.UpdateSettingsRequest;
import org.opensearch.action.get.GetRequest;
import org.opensearch.action.get.GetResponse;
import org.opensearch.action.index.IndexRequest;
import org.opensearch.action.support.WriteRequest.RefreshPolicy;
import org.opensearch.action.support.master.AcknowledgedResponse;
import org.opensearch.client.Request;
import org.opensearch.client.RequestOptions;
import org.opensearch.client.Response;
import org.opensearch.client.RestClient;
import org.opensearch.client.RestClientBuilder;
import org.opensearch.client.RestHighLevelClient;
import org.opensearch.client.indices.CreateIndexRequest;
import org.opensearch.client.indices.GetIndexRequest;
import org.opensearch.client.indices.GetIndexRequest.Feature;
import org.opensearch.client.indices.GetIndexResponse;
import org.opensearch.client.transport.NoNodeAvailableException;
import org.opensearch.cluster.health.ClusterHealthStatus;
import org.opensearch.common.Strings;
import org.opensearch.common.bytes.BytesReference;
import org.opensearch.common.collect.Tuple;
import org.opensearch.common.settings.Settings;
import org.opensearch.common.unit.TimeValue;
import org.opensearch.common.xcontent.NamedXContentRegistry;
import org.opensearch.common.xcontent.XContentBuilder;
import org.opensearch.common.xcontent.XContentFactory;
import org.opensearch.common.xcontent.XContentParser;
import org.opensearch.common.xcontent.XContentType;
import org.opensearch.common.xcontent.json.JsonXContent;
import org.opensearch.index.IndexNotFoundException;
import org.opensearch.rest.RestStatus;
import org.opensearch.security.DefaultObjectMapper;
import org.opensearch.security.NonValidatingObjectMapper;
import org.opensearch.security.auditlog.config.AuditConfig;
import org.opensearch.security.securityconf.Migration;
import org.opensearch.security.securityconf.impl.AllowlistingSettings;
import org.opensearch.security.securityconf.impl.CType;
import org.opensearch.security.securityconf.impl.NodesDn;
import org.opensearch.security.securityconf.impl.SecurityDynamicConfiguration;
import org.opensearch.security.securityconf.impl.WhitelistingSettings;
import org.opensearch.security.securityconf.impl.v6.RoleMappingsV6;
import org.opensearch.security.securityconf.impl.v7.ActionGroupsV7;
import org.opensearch.security.securityconf.impl.v7.ConfigV7;
import org.opensearch.security.securityconf.impl.v7.InternalUserV7;
import org.opensearch.security.securityconf.impl.v7.RoleMappingsV7;
import org.opensearch.security.securityconf.impl.v7.RoleV7;
import org.opensearch.security.securityconf.impl.v7.TenantV7;
import org.opensearch.security.ssl.util.ExceptionUtils;
import org.opensearch.security.support.ConfigConstants;
import org.opensearch.security.support.ConfigHelper;
import org.opensearch.security.support.PemKeyReader;
import org.opensearch.security.support.SecurityJsonNode;
import static org.opensearch.common.xcontent.DeprecationHandler.THROW_UNSUPPORTED_OPERATION;
import static org.opensearch.security.support.SecurityUtils.replaceEnvVars;
@SuppressWarnings("deprecation")
public class SecurityAdmin {
private static final boolean CREATE_AS_LEGACY = Boolean.parseBoolean(System.getenv("OPENDISTRO_SECURITY_ADMIN_CREATE_AS_LEGACY"));
private static final boolean ALLOW_MIXED = Boolean.parseBoolean(System.getenv("OPENDISTRO_SECURITY_ADMIN_ALLOW_MIXED_CLUSTER"));
private static final String OPENDISTRO_SECURITY_TS_PASS = "OPENDISTRO_SECURITY_TS_PASS";
private static final String OPENDISTRO_SECURITY_KS_PASS = "OPENDISTRO_SECURITY_KS_PASS";
private static final String OPENDISTRO_SECURITY_KEYPASS = "OPENDISTRO_SECURITY_KEYPASS";
//not used in multithreaded fashion, so it's okay to define it as a constant here
private static final SimpleDateFormat DATE_FORMAT = new SimpleDateFormat("yyyy-MMM-dd_HH-mm-ss", Locale.ENGLISH); //NOSONAR
private static final Settings ENABLE_ALL_ALLOCATIONS_SETTINGS = Settings.builder()
.put("cluster.routing.allocation.enable", "all")
.build();
public static void main(final String[] args) {
try {
final int returnCode = execute(args);
System.exit(returnCode);
} catch (NoNodeAvailableException e) {
System.out.println("ERR: Cannot connect to OpenSearch. Please refer to opensearch logfile for more information");
System.out.println("Trace:");
System.out.println(ExceptionsHelper.stackTrace(e));
System.out.println();
System.exit(-1);
}
catch (IndexNotFoundException e) {
System.out.println("ERR: No OpenSearch Security configuration index found. Please execute securityadmin with different command line parameters");
System.out.println("When you run it for the first time do not specify -us, -era, -dra or -rl");
System.out.println();
System.exit(-1);
}
catch (Throwable e) {
if (e instanceof OpenSearchException
&& e.getMessage() != null
&& e.getMessage().contains("no permissions")) {
System.out.println("ERR: You try to connect with a TLS node certificate instead of an admin client certificate");
System.out.println();
System.exit(-1);
}
System.out.println("ERR: An unexpected "+e.getClass().getSimpleName()+" occured: "+e.getMessage());
System.out.println("Trace:");
System.out.println(ExceptionsHelper.stackTrace(e));
System.out.println();
System.exit(-1);
}
}
public static int execute(final String[] args) throws Exception {
System.out.println("Security Admin v7");
System.setProperty("security.nowarn.client","true");
System.setProperty("jdk.tls.rejectClientInitiatedRenegotiation","true");
final HelpFormatter formatter = new HelpFormatter();
Options options = new Options();
options.addOption( "nhnv", "disable-host-name-verification", false, "Disable hostname verification" );
options.addOption(Option.builder("ts").longOpt("truststore").hasArg().argName("file").desc("Path to truststore (JKS/PKCS12 format)").build());
options.addOption(Option.builder("ks").longOpt("keystore").hasArg().argName("file").desc("Path to keystore (JKS/PKCS12 format").build());
options.addOption(Option.builder("tst").longOpt("truststore-type").hasArg().argName("type").desc("JKS or PKCS12, if not given we use the file extension to dectect the type").build());
options.addOption(Option.builder("kst").longOpt("keystore-type").hasArg().argName("type").desc("JKS or PKCS12, if not given we use the file extension to dectect the type").build());
options.addOption(Option.builder("tspass").longOpt("truststore-password").hasArg().argName("password").desc("Truststore password").build());
options.addOption(Option.builder("kspass").longOpt("keystore-password").hasArg().argName("password").desc("Keystore password").build());
options.addOption(Option.builder("cd").longOpt("configdir").hasArg().argName("directory").desc("Directory for config files").build());
options.addOption(Option.builder("h").longOpt("hostname").hasArg().argName("host").desc("OpenSearch host (default: localhost)").build());
options.addOption(Option.builder("p").longOpt("port").hasArg().argName("port").desc("OpenSearch transport port (default: 9200)").build());
options.addOption(Option.builder("cn").longOpt("clustername").hasArg().argName("clustername").desc("Clustername (do not use together with -icl)").build());
options.addOption( "sniff", "enable-sniffing", false, "Enable client.transport.sniff" );
options.addOption( "icl", "ignore-clustername", false, "Ignore clustername (do not use together with -cn)" );
options.addOption(Option.builder("r").longOpt("retrieve").desc("retrieve current config").build());
options.addOption(Option.builder("f").longOpt("file").hasArg().argName("file").desc("file").build());
options.addOption(Option.builder("t").longOpt("type").hasArg().argName("file-type").desc("file-type").build());
options.addOption(Option.builder("ksalias").longOpt("keystore-alias").hasArg().argName("alias").desc("Keystore alias").build());
options.addOption(Option.builder("ec").longOpt("enabled-ciphers").hasArg().argName("cipers").desc("Comma separated list of enabled TLS ciphers").build());
options.addOption(Option.builder("ep").longOpt("enabled-protocols").hasArg().argName("protocols").desc("Comma separated list of enabled TLS protocols").build());
//TODO mark as deprecated and replace it with "era" if "era" is mature enough
options.addOption(Option.builder("us").longOpt("update_settings").hasArg().argName("number of replicas").desc("Update the number of Security index replicas, reload configuration on all nodes and exit").build());
options.addOption(Option.builder("i").longOpt("index").hasArg().argName("indexname").desc("The index OpenSearch Security uses to store the configuration").build());
options.addOption(Option.builder("era").longOpt("enable-replica-autoexpand").desc("Enable replica auto expand and exit").build());
options.addOption(Option.builder("dra").longOpt("disable-replica-autoexpand").desc("Disable replica auto expand and exit").build());
options.addOption(Option.builder("rl").longOpt("reload").desc("Reload the configuration on all nodes, flush all Security caches and exit").build());
options.addOption(Option.builder("ff").longOpt("fail-fast").desc("fail-fast if something goes wrong").build());
options.addOption(Option.builder("dg").longOpt("diagnose").desc("Log diagnostic trace into a file").build());
options.addOption(Option.builder("dci").longOpt("delete-config-index").desc("Delete '.opendistro_security' config index and exit.").build());
options.addOption(Option.builder("esa").longOpt("enable-shard-allocation").desc("Enable all shard allocation and exit.").build());
options.addOption(Option.builder("arc").longOpt("accept-red-cluster").desc("Also operate on a red cluster. If not specified the cluster state has to be at least yellow.").build());
options.addOption(Option.builder("cacert").hasArg().argName("file").desc("Path to trusted cacert (PEM format)").build());
options.addOption(Option.builder("cert").hasArg().argName("file").desc("Path to admin certificate in PEM format").build());
options.addOption(Option.builder("key").hasArg().argName("file").desc("Path to the key of admin certificate").build());
options.addOption(Option.builder("keypass").hasArg().argName("password").desc("Password of the key of admin certificate (optional)").build());
options.addOption(Option.builder("si").longOpt("show-info").desc("Show system and license info").build());
options.addOption(Option.builder("w").longOpt("whoami").desc("Show information about the used admin certificate").build());
options.addOption(Option.builder("prompt").longOpt("prompt-for-password").desc("Prompt for password if not supplied").build());
options.addOption(Option.builder("er").longOpt("explicit-replicas").hasArg().argName("number of replicas").desc("Set explicit number of replicas or autoexpand expression for .opendistro_security index").build());
options.addOption(Option.builder("backup").hasArg().argName("folder").desc("Backup configuration to folder").build());
options.addOption(Option.builder("migrate").hasArg().argName("folder").desc("Migrate and use folder to store migrated files").build());
options.addOption(Option.builder("rev").longOpt("resolve-env-vars").desc("Resolve/Substitute env vars in config with their value before uploading").build());
options.addOption(Option.builder("vc").numberOfArgs(1).optionalArg(true).argName("version").longOpt("validate-configs").desc("Validate config for version 6 or 7 (default 7)").build());
options.addOption(Option.builder("mo").longOpt("migrate-offline").hasArg().argName("folder").desc("Migrate and use folder to store migrated files").build());
//when adding new options also adjust validate(CommandLine line)
String hostname = "localhost";
int port = 9200;
String kspass = System.getenv(OPENDISTRO_SECURITY_KS_PASS);
String tspass = System.getenv(OPENDISTRO_SECURITY_TS_PASS);
String cd = ".";
String ks = null;
String ts = null;
String kst = null;
String tst = null;
boolean nhnv = false;
String clustername = "opensearch";
String file = null;
String type = null;
boolean retrieve = false;
String ksAlias = null;
String[] enabledProtocols = new String[0];
String[] enabledCiphers = new String[0];
Integer updateSettings = null;
String index = ConfigConstants.OPENDISTRO_SECURITY_DEFAULT_CONFIG_INDEX;
Boolean replicaAutoExpand = null;
boolean reload = false;
boolean failFast = false;
boolean diagnose = false;
boolean deleteConfigIndex = false;
boolean enableShardAllocation = false;
boolean acceptRedCluster = false;
String keypass = System.getenv(OPENDISTRO_SECURITY_KEYPASS);
String cacert = null;
String cert = null;
String key = null;
boolean si;
boolean whoami;
final boolean promptForPassword;
String explicitReplicas = null;
String backup = null;
String migrate = null;
final boolean resolveEnvVars;
Integer validateConfig = null;
String migrateOffline = null;
InjectableValues.Std injectableValues = new InjectableValues.Std();
injectableValues.addValue(Settings.class, Settings.builder().build());
DefaultObjectMapper.inject(injectableValues);
NonValidatingObjectMapper.inject(injectableValues);
CommandLineParser parser = new DefaultParser();
try {
CommandLine line = parser.parse( options, args );
validate(line);
hostname = line.getOptionValue("h", hostname);
port = Integer.parseInt(line.getOptionValue("p", String.valueOf(port)));
promptForPassword = line.hasOption("prompt");
if(kspass == null || kspass.isEmpty()) {
kspass = line.getOptionValue("kspass",promptForPassword?null:"changeit");
}
if(tspass == null || tspass.isEmpty()) {
tspass = line.getOptionValue("tspass",promptForPassword?null:kspass);
}
cd = line.getOptionValue("cd", cd);
if(!cd.endsWith(File.separator)) {
cd += File.separator;
}
ks = line.getOptionValue("ks",ks);
ts = line.getOptionValue("ts",ts);
kst = line.getOptionValue("kst", kst);
tst = line.getOptionValue("tst", tst);
nhnv = line.hasOption("nhnv");
clustername = line.getOptionValue("cn", clustername);
file = line.getOptionValue("f", file);
type = line.getOptionValue("t", type);
retrieve = line.hasOption("r");
ksAlias = line.getOptionValue("ksalias", ksAlias);
index = line.getOptionValue("i", index);
String enabledCiphersString = line.getOptionValue("ec", null);
String enabledProtocolsString = line.getOptionValue("ep", null);
if(enabledCiphersString != null) {
enabledCiphers = enabledCiphersString.split(",");
}
if(enabledProtocolsString != null) {
enabledProtocols = enabledProtocolsString.split(",");
}
updateSettings = line.hasOption("us")?Integer.parseInt(line.getOptionValue("us")):null;
reload = line.hasOption("rl");
if(line.hasOption("era")) {
replicaAutoExpand = true;
}
if(line.hasOption("dra")) {
replicaAutoExpand = false;
}
failFast = line.hasOption("ff");
diagnose = line.hasOption("dg");
deleteConfigIndex = line.hasOption("dci");
enableShardAllocation = line.hasOption("esa");
acceptRedCluster = line.hasOption("arc");
cacert = line.getOptionValue("cacert");
cert = line.getOptionValue("cert");
key = line.getOptionValue("key");
keypass = line.getOptionValue("keypass", keypass);
si = line.hasOption("si");
whoami = line.hasOption("w");
explicitReplicas = line.getOptionValue("er", explicitReplicas);
backup = line.getOptionValue("backup");
migrate = line.getOptionValue("migrate");
resolveEnvVars = line.hasOption("rev");
validateConfig = !line.hasOption("vc")?null:Integer.parseInt(line.getOptionValue("vc", "7"));
if(validateConfig != null && validateConfig.intValue() != 6 && validateConfig.intValue() != 7) {
throw new ParseException("version must be 6 or 7");
}
migrateOffline = line.getOptionValue("mo");
}
catch( ParseException exp ) {
System.out.println("ERR: Parsing failed. Reason: " + exp.getMessage());
formatter.printHelp("securityadmin.sh", options, true);
return -1;
}
if(validateConfig != null) {
System.out.println("Validate configuration for Version "+validateConfig.intValue());
return validateConfig(cd, file, type, validateConfig.intValue());
}
if(migrateOffline != null) {
System.out.println("Migrate "+migrateOffline+" offline");
final boolean retVal = Migrater.migrateDirectory(new File(migrateOffline), true);
return retVal?0:-1;
}
System.out.print("Will connect to "+hostname+":"+port);
Socket socket = new Socket();
try {
socket.connect(new InetSocketAddress(hostname, port));
} catch (java.net.ConnectException ex) {
System.out.println();
System.out.println("ERR: Seems there is no OpenSearch running on "+hostname+":"+port+" - Will exit");
return (-1);
} finally {
try {
socket.close();
} catch (Exception e) {
//ignore
}
}
System.out.println(" ... done");
if(ks != null) {
kst = kst==null?(ks.endsWith(".jks")?"JKS":"PKCS12"):kst;
if(kspass == null && promptForPassword) {
kspass = promptForPassword("Keystore", "kspass", OPENDISTRO_SECURITY_KS_PASS);
}
}
if(ts != null) {
tst = tst==null?(ts.endsWith(".jks")?"JKS":"PKCS12"):tst;
if(tspass == null && promptForPassword) {
tspass = promptForPassword("Truststore", "tspass", OPENDISTRO_SECURITY_TS_PASS);
}
}
if(key != null) {
if(keypass == null && promptForPassword) {
keypass = promptForPassword("Pemkey", "keypass", OPENDISTRO_SECURITY_KEYPASS);
}
}
final SSLContext sslContext = sslContext(ts, tspass, tst, ks, kspass, kst, ksAlias, cacert, cert, key, keypass);
try (RestHighLevelClient restHighLevelClient = getRestHighLevelClient(sslContext, nhnv, enabledProtocols, enabledCiphers, hostname, port)) {
Response whoAmIRes = restHighLevelClient.getLowLevelClient().performRequest(new Request("GET", "/_plugins/_security/whoami"));
if (whoAmIRes.getStatusLine().getStatusCode() != 200) {
System.out.println("Unable to check whether cluster is sane because return code was " + whoAmIRes.getStatusLine());
return (-1);
}
JsonNode whoAmIResNode = DefaultObjectMapper.objectMapper.readTree(whoAmIRes.getEntity().getContent());
System.out.println("Connected as " + whoAmIResNode.get("dn"));
if (!whoAmIResNode.get("is_admin").asBoolean()) {
System.out.println("ERR: " + whoAmIResNode.get("dn") + " is not an admin user");
if (!whoAmIResNode.get("is_node_certificate_request").asBoolean()) {
System.out.println("Seems you use a client certificate but this one is not registered as admin_dn");
System.out.println("Make sure opensearch.yml on all nodes contains:");
System.out.println("plugins.security.authcz.admin_dn:"+System.lineSeparator()+
" - \"" + whoAmIResNode.get("dn") + "\"");
} else {
System.out.println("Seems you use a node certificate. This is not permitted, you have to use a client certificate and register it as admin_dn in opensearch.yml");
}
return (-1);
} else if (whoAmIResNode.get("is_node_certificate_request").asBoolean()) {
System.out.println("ERR: Seems you use a node certificate which is also an admin certificate");
System.out.println(" That may have worked with older OpenSearch Security versions but it indicates");
System.out.println(" a configuration error and is therefore forbidden now.");
if (failFast) {
return (-1);
}
}
try {
if(issueWarnings(restHighLevelClient) != 0) {
return (-1);
}
} catch (Exception e1) {
System.out.println("Unable to check whether cluster is sane");
throw e1;
}
if(updateSettings != null) {
Settings indexSettings = Settings.builder().put("index.number_of_replicas", updateSettings).build();
Response res = restHighLevelClient.getLowLevelClient()
.performRequest(new Request("PUT", "/_plugins/_security/configupdate?config_types=" + Joiner.on(",").join(getTypes(true))));
if (res.getStatusLine().getStatusCode() != 200) {
System.out.println("Unable to reload configuration because return code was " + res.getStatusLine());
return (-1);
}
JsonNode resNode = DefaultObjectMapper.objectMapper.readTree(res.getEntity().getContent());
if (resNode.get("configupdate_response").get("has_failures").asBoolean()) {
System.out.println("ERR: Unable to reload config due to " + responseToString(res, false) + "/" + resNode);
}
final AcknowledgedResponse response = restHighLevelClient.indices().putSettings((new UpdateSettingsRequest(index).settings(indexSettings)), RequestOptions.DEFAULT);
System.out.println("Reload config on all nodes");
System.out.println("Update number of replicas to "+(updateSettings) +" with result: "+response.isAcknowledged());
return ((response.isAcknowledged() && !resNode.get("configupdate_response").get("has_failures").asBoolean()) ? 0 : -1);
}
if(reload) {
Response res = restHighLevelClient.getLowLevelClient()
.performRequest(new Request("PUT", "/_plugins/_security/configupdate?config_types=" + Joiner.on(",").join(getTypes(false))));
if (res.getStatusLine().getStatusCode() != 200) {
System.out.println("Unable to reload configuration because return code was " + res.getStatusLine());
return (-1);
}
JsonNode resNode = DefaultObjectMapper.objectMapper.readTree(res.getEntity().getContent());
if (resNode.get("configupdate_response").get("has_failures").asBoolean()) {
System.out.println("ERR: Unable to reload config due to " + responseToString(res, false) + "/" + resNode);
return -1;
}
System.out.println("Reload config on all nodes");
return 0;
}
if(si) {
return (0);
}
if (whoami) {
System.out.println(whoAmIResNode.toPrettyString());
return (0);
}
if(replicaAutoExpand != null) {
Settings indexSettings = Settings.builder()
.put("index.auto_expand_replicas", replicaAutoExpand?"0-all":"false")
.build();
Response res = restHighLevelClient.getLowLevelClient().performRequest(new Request("PUT", "/_plugins/_security/configupdate?config_types=" + Joiner.on(",").join(getTypes(false))));
if (res.getStatusLine().getStatusCode() != 200) {
System.out.println("Unable to reload configuration because return code was " + whoAmIRes.getStatusLine());
return (-1);
}
JsonNode resNode = DefaultObjectMapper.objectMapper.readTree(res.getEntity().getContent());
if (resNode.get("configupdate_response").get("has_failures").asBoolean()) {
System.out.println("ERR: Unable to reload config due to " + responseToString(res, false) + "/" + resNode);
}
final AcknowledgedResponse response = restHighLevelClient.indices().putSettings((new UpdateSettingsRequest(index).settings(indexSettings)), RequestOptions.DEFAULT);
System.out.println("Reload config on all nodes");
System.out.println("Auto-expand replicas " + (replicaAutoExpand ? "enabled" : "disabled"));
return ((response.isAcknowledged() && !resNode.get("configupdate_response").get("has_failures").asBoolean()) ? 0 : -1);
}
if (enableShardAllocation) {
final boolean successful = restHighLevelClient.cluster()
.putSettings(new ClusterUpdateSettingsRequest()
.transientSettings(ENABLE_ALL_ALLOCATIONS_SETTINGS)
.persistentSettings(ENABLE_ALL_ALLOCATIONS_SETTINGS), RequestOptions.DEFAULT)
.isAcknowledged();
if(successful) {
System.out.println("Persistent and transient shard allocation enabled");
} else {
System.out.println("ERR: Unable to enable shard allocation");
}
return (successful?0:-1);
}
if(failFast) {
System.out.println("Fail-fast is activated");
}
if (diagnose) {
generateDiagnoseTrace(restHighLevelClient);
}
System.out.println("Contacting opensearch cluster '"+clustername+"'"+(acceptRedCluster?"":" and wait for YELLOW clusterstate")+" ...");
ClusterHealthResponse chResponse = null;
while (chResponse == null) {
try {
final ClusterHealthRequest chRequest = new ClusterHealthRequest().timeout(TimeValue.timeValueMinutes(5));
if (!acceptRedCluster) {
chRequest.waitForYellowStatus();
}
chResponse = restHighLevelClient.cluster().health(chRequest, RequestOptions.DEFAULT);
} catch (Exception e) {
Throwable rootCause = ExceptionUtils.getRootCause(e);
if(!failFast) {
System.out.println("Cannot retrieve cluster state due to: "+e.getMessage()+". This is not an error, will keep on trying ...");
System.out.println(" Root cause: "+rootCause+" ("+e.getClass().getName()+"/"+rootCause.getClass().getName()+")");
System.out.println(" * Try running securityadmin.sh with -icl (but no -cl) and -nhnv (If that works you need to check your clustername as well as hostnames in your TLS certificates)");
System.out.println(" * Make sure that your keystore or PEM certificate is a client certificate (not a node certificate) and configured properly in opensearch.yml");
System.out.println(" * If this is not working, try running securityadmin.sh with --diagnose and see diagnose trace log file)");
System.out.println(" * Add --accept-red-cluster to allow securityadmin to operate on a red cluster.");
} else {
System.out.println("ERR: Cannot retrieve cluster state due to: "+e.getMessage()+".");
System.out.println(" Root cause: "+rootCause+" ("+e.getClass().getName()+"/"+rootCause.getClass().getName()+")");
System.out.println(" * Try running securityadmin.sh with -icl (but no -cl) and -nhnv (If that works you need to check your clustername as well as hostnames in your TLS certificates)");
System.out.println(" * Make also sure that your keystore or PEM certificate is a client certificate (not a node certificate) and configured properly in opensearch.yml");
System.out.println(" * If this is not working, try running securityadmin.sh with --diagnose and see diagnose trace log file)");
System.out.println(" * Add --accept-red-cluster to allow securityadmin to operate on a red cluster.");
return (-1);
}
Thread.sleep(3000);
continue;
}
}
final boolean timedOut = chResponse.isTimedOut();
if (!acceptRedCluster && timedOut) {
System.out.println("ERR: Timed out while waiting for a green or yellow cluster state.");
System.out.println(" * Try running securityadmin.sh with -icl (but no -cl) and -nhnv (If that works you need to check your clustername as well as hostnames in your TLS certificates)");
System.out.println(" * Make also sure that your keystore or PEM certificate is a client certificate (not a node certificate) and configured properly in opensearch.yml");
System.out.println(" * If this is not working, try running securityadmin.sh with --diagnose and see diagnose trace log file)");
System.out.println(" * Add --accept-red-cluster to allow securityadmin to operate on a red cluster.");
return (-1);
}
System.out.println("Clustername: " + chResponse.getClusterName());
System.out.println("Clusterstate: " + chResponse.getStatus());
System.out.println("Number of nodes: " + chResponse.getNumberOfNodes());
System.out.println("Number of data nodes: " + chResponse.getNumberOfDataNodes());
GetIndexResponse securityIndex = null;
try {
securityIndex = restHighLevelClient.indices().get(new GetIndexRequest(index).addFeatures(Feature.MAPPINGS), RequestOptions.DEFAULT);
} catch (OpenSearchStatusException e1) {
if(e1.status() == RestStatus.NOT_FOUND) {
//ignore
} else {
System.out.println("Unable to get index because return code was " + e1.status().getStatus());
return (-1);
}
}
final boolean indexExists = securityIndex != null;
int expectedNodeCount = restHighLevelClient.cluster().health(new ClusterHealthRequest(), RequestOptions.DEFAULT).getNumberOfNodes();
if(deleteConfigIndex) {
return deleteConfigIndex(restHighLevelClient, index, indexExists);
}
if (!indexExists) {
System.out.print(index +" index does not exists, attempt to create it ... ");
final int created = createConfigIndex(restHighLevelClient, index, explicitReplicas);
if(created != 0) {
return created;
}
} else {
System.out.println(index+" index already exists, so we do not need to create one.");
try {
ClusterHealthResponse clusterHealthResponse = restHighLevelClient.cluster().health(new ClusterHealthRequest(index), RequestOptions.DEFAULT);
if (clusterHealthResponse.isTimedOut()) {
System.out.println("ERR: Timed out while waiting for "+index+" index state.");
}
if (clusterHealthResponse.getStatus() == ClusterHealthStatus.RED) {
System.out.println("ERR: "+index+" index state is RED.");
}
if (clusterHealthResponse.getStatus() == ClusterHealthStatus.YELLOW) {
System.out.println("INFO: "+index+" index state is YELLOW, it seems you miss some replicas");
}
} catch (Exception e) {
if(!failFast) {
System.out.println("Cannot retrieve "+index+" index state state due to "+e.getMessage()+". This is not an error, will keep on trying ...");
} else {
System.out.println("ERR: Cannot retrieve "+index+" index state state due to "+e.getMessage()+".");
return (-1);
}
}
}
final boolean createLegacyMode = !indexExists && CREATE_AS_LEGACY;
if(createLegacyMode) {
System.out.println("We forcibly create the new index in legacy mode so that ES 6 config can be uploaded. To move to v7 configs youneed to migrate.");
}
final boolean legacy = createLegacyMode || (indexExists
&& securityIndex.getMappings() != null
&& securityIndex.getMappings().get(index) != null);
if(legacy) {
System.out.println("Legacy index '"+index+"' (ES 6) detected (or forced). You should migrate the configuration!");
}
if(retrieve) {
String date = DATE_FORMAT.format(new Date());
boolean success = retrieveFile(restHighLevelClient, cd + "config_" + date + ".yml", index, "config", legacy);
success = retrieveFile(restHighLevelClient, cd + "roles_" + date + ".yml", index, "roles", legacy) && success;
success = retrieveFile(restHighLevelClient, cd + "roles_mapping_" + date + ".yml", index, "rolesmapping", legacy) && success;
success = retrieveFile(restHighLevelClient, cd + "internal_users_" + date + ".yml", index, "internalusers", legacy) && success;
success = retrieveFile(restHighLevelClient, cd + "action_groups_" + date + ".yml", index, "actiongroups", legacy) && success;
success = retrieveFile(restHighLevelClient, cd + "audit_" + date + ".yml", index, "audit", legacy) && success;
if(!legacy) {
success = retrieveFile(restHighLevelClient, cd + "security_tenants_" + date + ".yml", index, "tenants", legacy) && success;
}
final boolean populateFileIfEmpty = true;
success = retrieveFile(restHighLevelClient, cd+"nodes_dn_"+date+".yml", index, "nodesdn", legacy, populateFileIfEmpty) && success;
success = retrieveFile(restHighLevelClient, cd+"whitelist_"+date+".yml", index, "whitelist", legacy, populateFileIfEmpty) && success;
return (success?0:-1);
}
if(backup != null) {
return backup(restHighLevelClient, index, new File(backup), legacy);
}
if(migrate != null) {
if(!legacy) {
System.out.println("ERR: Seems cluster is already migrated");
return -1;
}
return migrate(restHighLevelClient, index, new File(migrate), expectedNodeCount, resolveEnvVars);
}
boolean isCdAbs = new File(cd).isAbsolute();
System.out.println("Populate config from "+(isCdAbs?cd:new File(".", cd).getCanonicalPath()));
if(file != null) {
if(type != null) {
System.out.println("Force type: "+type);
} else {
type = readTypeFromFile(new File(file));
if(type == null) {
System.out.println("ERR: Unable to read type from file");
return (-1);
}
}
if(!CType.lcStringValues().contains(type)) {
System.out.println("ERR: Invalid type '"+type+"'");
return (-1);
}
boolean success = uploadFile(restHighLevelClient, file, index, type, legacy, resolveEnvVars);
if(!success) {
System.out.println("ERR: cannot upload configuration, see errors above");
return -1;
}
Response cur = restHighLevelClient.getLowLevelClient().performRequest(new Request("PUT", "/_plugins/_security/configupdate?config_types=" + type));
success = checkConfigUpdateResponse(cur, expectedNodeCount, 1) && success;
System.out.println("Done with "+(success?"success":"failures"));
return (success?0:-1);
}
return upload(restHighLevelClient, index, cd, legacy, expectedNodeCount, resolveEnvVars);
}
}
private static boolean checkConfigUpdateResponse(Response response, int expectedNodeCount, int expectedConfigCount) throws IOException {
if (response.getStatusLine().getStatusCode() != 200) {
System.out.println("Unable to check configupdate response because return code was " + response.getStatusLine());
}
JsonNode resNode = DefaultObjectMapper.objectMapper.readTree(response.getEntity().getContent());
if (resNode.at("/configupdate_response/has_failures").asBoolean()) {
System.out.println("FAIL: " + resNode.at("/configupdate_response/failures_size").asInt() + " nodes reported failures. Failure is " + responseToString(response, false) + "/" + resNode);
}
boolean success = resNode.at("/configupdate_response/node_size").asInt() == expectedNodeCount;
if(!success) {
System.out.println("FAIL: Expected " + expectedNodeCount + " nodes to return response, but got " + resNode.at("/configupdate_response/node_size").asInt());
}
for (JsonNode n : resNode.at("/configupdate_response/nodes")) {
boolean successNode = (n.get("updated_config_types") != null && n.get("updated_config_size").asInt() == expectedConfigCount);
if(!successNode) {
System.out.println("FAIL: Expected " + expectedConfigCount + " config types for node " + n + " but got " + n.get("updated_config_size").asInt() + " (" + n.get("updated_config_types") + ") due to: " + (n.get("message") == null ? "unknown reason" : n.get("message")));
} else {
System.out.println("SUCC: Expected " + expectedConfigCount + " config types for node " + n + " is " + n.get("updated_config_size").asInt() + " (" + n.get("updated_config_types") + ") due to: " + (n.get("message") == null ? "unknown reason" : n.get("message")));
}
success = success && successNode;
}
return success && !resNode.at("/configupdate_response/has_failures").asBoolean();
}
private static boolean uploadFile(final RestHighLevelClient restHighLevelClient, final String filepath, final String index, final String _id, final boolean legacy, boolean resolveEnvVars) {
return uploadFile(restHighLevelClient, filepath, index, _id, legacy, resolveEnvVars, false);
}
private static boolean uploadFile(final RestHighLevelClient restHighLevelClient, final String filepath, final String index, final String _id, final boolean legacy, boolean resolveEnvVars,
final boolean populateEmptyIfMissing) {
String id = _id;
if(legacy) {
id = _id;
try {
ConfigHelper.fromYamlFile(filepath, CType.fromString(_id), 2, 0, 0);
} catch (Exception e) {
System.out.println("ERR: Seems "+filepath+" is not in legacy format: "+e);
return false;
}
} else {
try {
ConfigHelper.fromYamlFile(filepath, CType.fromString(_id), 2, 0, 0);
} catch (Exception e) {
System.out.println("ERR: Seems "+filepath+" is not in OpenSearch Security 7 format: "+e);
return false;
}
}
System.out.println("Will update '" + "/" + id + "' with " + filepath + " " + (legacy ? "(legacy mode)" : ""));
try (Reader reader = ConfigHelper.createFileOrStringReader(CType.fromString(_id), legacy ? 1 : 2, filepath, populateEmptyIfMissing)) {
final String content = CharStreams.toString(reader);
final String res = restHighLevelClient
.index(new IndexRequest(index).id(id).setRefreshPolicy(RefreshPolicy.IMMEDIATE)
.source(_id, readXContent(resolveEnvVars ? replaceEnvVars(content, Settings.EMPTY) : content, XContentType.YAML)), RequestOptions.DEFAULT).getId();
if (id.equals(res)) {
System.out.println(" SUCC: Configuration for '" + _id + "' created or updated");
return true;
} else {
System.out.println(" FAIL: Configuration for '" + _id
+ "' failed for unknown reasons. Please consult the OpenSearch logfile.");
}
} catch (Exception e) {
System.out.println(" FAIL: Configuration for '" + _id + "' failed because of " + e.toString());
}
return false;
}
private static boolean retrieveFile(final RestHighLevelClient restHighLevelClient, final String filepath, final String index, final String _id, final boolean legacy) {
return retrieveFile(restHighLevelClient, filepath, index, _id, legacy, false);
}
private static boolean retrieveFile(final RestHighLevelClient restHighLevelClient, final String filepath, final String index, final String _id, final boolean legacy, final boolean populateFileIfEmpty) {
String id = _id;
if(legacy) {
id = _id;
}
System.out.println("Will retrieve '"+"/" +id+"' into "+filepath+" "+(legacy?"(legacy mode)":""));
try (Writer writer = new FileWriter(filepath)) {
final GetResponse response = restHighLevelClient.get(new GetRequest(index).id(id).refresh(true).realtime(false), RequestOptions.DEFAULT);
boolean isEmpty = !response.isExists() || response.isSourceEmpty();
String yaml;
if (isEmpty) {
if (populateFileIfEmpty) {
yaml = ConfigHelper.createEmptySdcYaml(CType.fromString(_id), legacy ? 1 : 2);
} else {
System.out.println(" FAIL: Configuration for '"+_id+"' failed because of empty source");
return false;
}
} else {
yaml = convertToYaml(_id, response.getSourceAsBytesRef(), true);
if (null == yaml) {
System.out.println("ERR: YML conversion error for " + _id);
return false;
}
if (legacy) {
try {
ConfigHelper.fromYamlString(yaml, CType.fromString(_id), 1, 0, 0);
} catch (Exception e) {
System.out.println("ERR: Seems " + _id + " from cluster is not in legacy format: " + e);
return false;
}
} else {
try {
ConfigHelper.fromYamlString(yaml, CType.fromString(_id), 2, 0, 0);
} catch (Exception e) {
System.out.println("ERR: Seems " + _id + " from cluster is not in 7 format: " + e);
return false;
}
}
}
writer.write(yaml);
System.out.println(" SUCC: Configuration for '"+_id+"' stored in "+filepath);
return true;
} catch (Exception e) {
System.out.println(" FAIL: Get configuration for '"+_id+"' failed because of "+e.toString());
}
return false;
}
private static BytesReference readXContent(final String content, final XContentType xContentType) throws IOException {
BytesReference retVal;
XContentParser parser = null;
try {
parser = XContentFactory.xContent(xContentType).createParser(NamedXContentRegistry.EMPTY, THROW_UNSUPPORTED_OPERATION, content);
parser.nextToken();
final XContentBuilder builder = XContentFactory.jsonBuilder();
builder.copyCurrentStructure(parser);
retVal = BytesReference.bytes(builder);
} finally {
if (parser != null) {
parser.close();
}
}
//validate
return retVal;
}
private static String convertToYaml(String type, BytesReference bytes, boolean prettyPrint) throws IOException {
try (XContentParser parser = JsonXContent.jsonXContent.createParser(NamedXContentRegistry.EMPTY, THROW_UNSUPPORTED_OPERATION, bytes.streamInput())) {
parser.nextToken();
parser.nextToken();
if(!type.equals((parser.currentName()))) {
return null;
}
parser.nextToken();
XContentBuilder builder = XContentFactory.yamlBuilder();
if (prettyPrint) {
builder.prettyPrint();
}
builder.rawValue(new ByteArrayInputStream(parser.binaryValue()), XContentType.YAML);
return Strings.toString(builder);
}
}
protected static void generateDiagnoseTrace(final RestHighLevelClient restHighLevelClient) {
final String date = DATE_FORMAT.format(new Date());
final StringBuilder sb = new StringBuilder();
sb.append("Diagnostic securityadmin trace"+System.lineSeparator());
sb.append("OpenSearch client version: "+Version.CURRENT+System.lineSeparator());
sb.append("Client properties: "+System.getProperties()+System.lineSeparator());
sb.append(date+System.lineSeparator());
sb.append(System.lineSeparator());
try {
sb.append("Who am i:"+System.lineSeparator());
final Response whoAmIRes = restHighLevelClient.getLowLevelClient().performRequest(new Request("GET", "/_plugins/_security/whoami"));
sb.append(responseToString(whoAmIRes, true));
} catch (Exception e1) {
sb.append(ExceptionsHelper.stackTrace(e1));
}
try {
sb.append("ClusterHealthRequest:"+System.lineSeparator());
ClusterHealthResponse nir = restHighLevelClient.cluster().health(new ClusterHealthRequest(), RequestOptions.DEFAULT);
sb.append(Strings.toString(nir, true, true));