Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
org.xipki.ca.mgmt.shell.MiscCaActions Maven / Gradle / Ivy
/*
*
* Copyright (c) 2013 - 2020 Lijun Liao
*
* 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.
*/
package org.xipki.ca.mgmt.shell;
import org.apache.karaf.shell.api.action.Argument;
import org.apache.karaf.shell.api.action.Command;
import org.apache.karaf.shell.api.action.Completion;
import org.apache.karaf.shell.api.action.Option;
import org.apache.karaf.shell.api.action.lifecycle.Service;
import org.apache.karaf.shell.support.completers.FileCompleter;
import org.xipki.ca.api.mgmt.CaConfs;
import org.xipki.ca.api.mgmt.CaMgmtException;
import org.xipki.ca.api.mgmt.CaSystemStatus;
import org.xipki.ca.mgmt.shell.CaActions.CaAction;
import org.xipki.security.X509Cert;
import org.xipki.shell.CmdFailure;
import org.xipki.shell.Completers;
import org.xipki.util.CollectionUtil;
import org.xipki.util.IoUtil;
import java.io.File;
import java.io.InputStream;
import java.nio.file.Files;
import java.nio.file.Paths;
import java.util.List;
import java.util.Map;
/**
* Misc actions to manage CA.
*
* @author Lijun Liao
*
*/
public class MiscCaActions {
@Command(scope = "ca", name = "clear-publishqueue", description = "clear publish queue")
@Service
public static class ClearPublishqueue extends CaAction {
@Option(name = "--ca", required = true, description = "CA name or 'all' for all CAs")
@Completion(CaCompleters.CaNamePlusAllCompleter.class)
private String caName;
@Option(name = "--publisher", required = true, multiValued = true,
description = "publisher name or 'all' for all publishers")
@Completion(CaCompleters.PublisherNamePlusAllCompleter.class)
private List publisherNames;
@Override
protected Object execute0()
throws Exception {
if (publisherNames == null) {
throw new IllegalStateException("should not reach here");
}
boolean allPublishers = false;
for (String publisherName : publisherNames) {
if ("all".equalsIgnoreCase(publisherName)) {
allPublishers = true;
break;
}
}
if (allPublishers) {
publisherNames = null;
}
if ("all".equalsIgnoreCase(caName)) {
caName = null;
}
String msg = "publish queue of CA " + caName + " for publishers " + toString(publisherNames);
try {
caManager.clearPublishQueue(caName, publisherNames);
println("cleared " + msg);
return null;
} catch (CaMgmtException ex) {
throw new CmdFailure("could not clear " + msg + ", error: " + ex.getMessage(), ex);
}
} // method execute0
} // class ClearPublishqueue
@Command(scope = "ca", name = "export-conf", description = "export configuration to zip file")
@Service
public static class ExportConf extends CaAction {
@Option(name = "--conf-file", required = true,
description = "zip file that saves the exported configuration")
@Completion(FileCompleter.class)
private String confFile;
@Option(name = "--ca", multiValued = true,
description = "CAs whose configuration should be exported. Empty list means all CAs")
@Completion(CaCompleters.CaNameCompleter.class)
private List caNames;
@Override
protected Object execute0()
throws Exception {
String msg = "configuration to file " + confFile;
try {
InputStream is = caManager.exportConf(caNames);
save(new File(confFile), IoUtil.read(is));
println("exported " + msg);
return null;
} catch (CaMgmtException ex) {
throw new CmdFailure("could not export " + msg + ", error: " + ex.getMessage(), ex);
}
} // method execute0
} // class ExportConf
@Command(scope = "ca", name = "load-conf", description = "load configuration")
@Service
public static class LoadConf extends CaAction {
@Option(name = "--conf-file", description = "CA system configuration file (XML or zip file")
@Completion(FileCompleter.class)
private String confFile;
@Option(name = "--outform", description = "output format of the root certificates")
@Completion(Completers.DerPemCompleter.class)
protected String outform = "der";
@Option(name = "--out-dir",
description = "directory to save the root certificates")
@Completion(FileCompleter.class)
private String outDir = ".";
@Override
protected Object execute0()
throws Exception {
String msg = "configuration " + confFile;
try {
InputStream confStream;
if (confFile.endsWith(".json")) {
confStream = CaConfs.convertFileConfToZip(confFile);
} else {
confStream = Files.newInputStream(Paths.get(confFile));
}
Map rootCerts = caManager.loadConf(confStream);
if (CollectionUtil.isEmpty(rootCerts)) {
println("loaded " + msg);
} else {
println("loaded " + msg);
for (String caname : rootCerts.keySet()) {
String filename = "ca-" + caname + ".crt";
saveVerbose("saved certificate of root CA " + caname + " to",
new File(outDir, filename),
encodeCert(rootCerts.get(caname).getEncoded(), outform));
}
}
return null;
} catch (CaMgmtException ex) {
throw new CmdFailure("could not load " + msg + ", error: " + ex.getMessage(), ex);
}
} // method execute0
} // class LoadConf
@Command(scope = "ca", name = "notify-change", description = "notify the change of CA system")
@Service
public static class NotifyChange extends CaAction {
@Override
protected Object execute0()
throws Exception {
String msg = "the change of CA system";
try {
caManager.notifyCaChange();
println("notified " + msg);
return null;
} catch (CaMgmtException ex) {
throw new CmdFailure("could not notify " + msg + ", error: " + ex.getMessage(), ex);
}
} // method execute0
} // class NotifyChange
@Command(scope = "ca", name = "refresh-token", description = "refresh token for signers")
@Service
public static class RefreshToken extends CaAction {
@Option(name = "--type", required = true, description = "type of the signer")
@Completion(CaCompleters.SignerTypeCompleter.class)
protected String type;
@Override
protected Object execute0()
throws Exception {
caManager.refreshTokenForSignerType(type);
println("refreshed token for signer type " + type);
return null;
} // method execute0
} // class RefreshToken
@Command(scope = "ca", name = "republish", description = "republish certificates")
@Service
public static class Republish extends CaAction {
@Option(name = "--thread", description = "number of threads")
private Integer numThreads = 5;
@Option(name = "--ca", required = true, description = "CA name")
@Completion(CaCompleters.CaNameCompleter.class)
private String caName;
@Option(name = "--publisher", required = true, multiValued = true,
description = "publisher name or 'all' for all publishers")
@Completion(CaCompleters.PublisherNamePlusAllCompleter.class)
private List publisherNames;
@Override
protected Object execute0()
throws Exception {
if (publisherNames == null) {
throw new IllegalStateException("should not reach here");
}
boolean allPublishers = false;
for (String publisherName : publisherNames) {
if ("all".equalsIgnoreCase(publisherName)) {
allPublishers = true;
break;
}
}
if (allPublishers) {
publisherNames = null;
}
if ("all".equalsIgnoreCase(caName)) {
caName = null;
}
String msg = "certificates";
try {
caManager.republishCertificates(caName, publisherNames, numThreads);
println("republished " + msg);
return null;
} catch (CaMgmtException ex) {
throw new CmdFailure("could not republish " + msg + ", error: " + ex.getMessage(), ex);
}
} // method execute0
} // class Republish
@Command(scope = "ca", name = "restart-ca", description = "restart CA")
@Service
public static class RestartCa extends CaAction {
@Argument(index = 0, name = "name", required = true, description = "CA name")
@Completion(CaCompleters.CaNameCompleter.class)
private String name;
@Override
protected Object execute0()
throws Exception {
try {
caManager.restartCa(name);
System.out.println("restarted CA " + name);
} catch (CaMgmtException ex) {
throw new CmdFailure("could not restart CA " + name + ", error: " + ex.getMessage(), ex);
}
return null;
} // method execute0
} // class RestartCa
@Command(scope = "ca", name = "restart", description = "restart CA system")
@Service
public static class Restart extends CaAction {
@Override
protected Object execute0()
throws Exception {
try {
caManager.restartCaSystem();
} catch (CaMgmtException ex) {
throw new CmdFailure("could not restart CA system, error: " + ex.getMessage(), ex);
}
StringBuilder sb = new StringBuilder("restarted CA system\n");
sb.append(" successful CAs:\n");
String prefix = " ";
printCaNames(sb, caManager.getSuccessfulCaNames(), prefix);
sb.append(" failed CAs:\n");
printCaNames(sb, caManager.getFailedCaNames(), prefix);
sb.append(" inactive CAs:\n");
printCaNames(sb, caManager.getInactiveCaNames(), prefix);
print(sb.toString());
return null;
} // method execute0
} // class Restart
@Command(scope = "ca", name = "system-status", description = "show CA system status")
@Service
public static class SystemStatus extends CaAction {
@Override
protected Object execute0()
throws Exception {
CaSystemStatus status = caManager.getCaSystemStatus();
if (status != null) {
println(status.toString());
} else {
throw new CmdFailure("status is null");
}
return null;
} // method execute0
} // class SystemStatus
@Command(scope = "ca", name = "unlock", description = "unlock CA system")
@Service
public static class Unlock extends CaAction {
@Override
protected Object execute0()
throws Exception {
try {
caManager.unlockCa();
println("unlocked CA system, calling ca:restart to restart CA system");
return null;
} catch (CaMgmtException ex) {
throw new CmdFailure("could not unlock CA system, error: " + ex.getMessage(), ex);
}
} // method execute0
} // class Unlock
}
