org.xipki.ca.client.shell.GetCRLCommand.java Source code

Introduction

Here is the source code for org.xipki.ca.client.shell.GetCRLCommand.java

Source

/*
 *
 * This file is part of the XiPKI project.
 * Copyright (c) 2014 - 2015 Lijun Liao
 * Author: Lijun Liao
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License version 3
 * as published by the Free Software Foundation with the addition of the
 * following permission added to Section 15 as permitted in Section 7(a):
 * FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY
 * THE AUTHOR LIJUN LIAO. LIJUN LIAO DISCLAIMS THE WARRANTY OF NON INFRINGEMENT
 * OF THIRD PARTY RIGHTS.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * The interactive user interfaces in modified source and object code versions
 * of this program must display Appropriate Legal Notices, as required under
 * Section 5 of the GNU Affero General Public License.
 *
 * You can be released from the requirements of the license by purchasing
 * a commercial license. Buying such a license is mandatory as soon as you
 * develop commercial activities involving the XiPKI software without
 * disclosing the source code of your own applications.
 *
 * For more information, please contact Lijun Liao at this
 * address: lijun.liao@gmail.com
 */

package org.xipki.ca.client.shell;

import java.io.File;
import java.math.BigInteger;
import java.security.cert.X509CRL;
import java.util.Set;

import org.apache.karaf.shell.commands.Command;
import org.apache.karaf.shell.commands.Option;
import org.bouncycastle.asn1.ASN1Integer;
import org.bouncycastle.asn1.DEROctetString;
import org.bouncycastle.asn1.x509.Extension;
import org.xipki.ca.client.api.CAClientException;
import org.xipki.ca.client.api.PKIErrorException;
import org.xipki.common.RequestResponseDebug;
import org.xipki.console.karaf.CmdFailure;
import org.xipki.console.karaf.IllegalCmdParamException;

/**
 * @author Lijun Liao
 */

@Command(scope = "xipki-cli", name = "getcrl", description = "download CRL")
public class GetCRLCommand extends CRLCommand {
    @Option(name = "--with-basecrl", description = "whether to retrieve the baseCRL if the current CRL is a delta CRL")
    private Boolean withBaseCRL = Boolean.FALSE;

    @Option(name = "--basecrl-out", description = "where to save the baseCRL\n" + "(defaults to <out>-baseCRL)")
    private String baseCRLOut;

    @Override
    protected X509CRL retrieveCRL(final String caName) throws CAClientException, PKIErrorException {
        RequestResponseDebug debug = getRequestResponseDebug();
        try {
            return caClient.downloadCRL(caName, debug);
        } finally {
            saveRequestResponse(debug);
        }
    }

    @Override
    protected Object _doExecute() throws Exception {
        Set<String> caNames = caClient.getCaNames();
        if (isEmpty(caNames)) {
            throw new IllegalCmdParamException("no CA is configured");
        }

        if (caName != null && !caNames.contains(caName)) {
            throw new IllegalCmdParamException("CA " + caName + " is not within the configured CAs " + caNames);
        }

        if (caName == null) {
            if (caNames.size() == 1) {
                caName = caNames.iterator().next();
            } else {
                throw new IllegalCmdParamException("no caname is specified, one of " + caNames + " is required");
            }
        }

        X509CRL crl = null;
        try {
            crl = retrieveCRL(caName);
        } catch (PKIErrorException e) {
            throw new CmdFailure("received no CRL from server: " + e.getMessage());
        }

        if (crl == null) {
            throw new CmdFailure("received no CRL from server");
        }

        saveVerbose("saved CRL to file", new File(outFile), crl.getEncoded());

        if (withBaseCRL.booleanValue()) {
            byte[] octetString = crl.getExtensionValue(Extension.deltaCRLIndicator.getId());
            if (octetString != null) {
                if (baseCRLOut == null) {
                    baseCRLOut = outFile + "-baseCRL";
                }

                byte[] extnValue = DEROctetString.getInstance(octetString).getOctets();
                BigInteger baseCrlNumber = ASN1Integer.getInstance(extnValue).getPositiveValue();

                RequestResponseDebug debug = getRequestResponseDebug();
                try {
                    crl = caClient.downloadCRL(caName, baseCrlNumber, debug);
                } catch (PKIErrorException e) {
                    throw new CmdFailure("received no baseCRL from server: " + e.getMessage());
                } finally {
                    saveRequestResponse(debug);
                }

                if (crl == null) {
                    throw new CmdFailure("received no baseCRL from server");
                } else {
                    saveVerbose("saved baseCRL to file", new File(baseCRLOut), crl.getEncoded());
                }
            }
        }

        return null;
    }
}