sop.operation.ExtractCert Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sop-java Show documentation

Stateless OpenPGP Protocol API for Java

There is a newer version: 10.0.3

// SPDX-FileCopyrightText: 2021 Paul Schaub 
//
// SPDX-License-Identifier: Apache-2.0

package sop.operation;

import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;

import sop.Ready;
import sop.exception.SOPGPException;

public interface ExtractCert {

    /**
     * Disable ASCII armor encoding.
     *
     * @return builder instance
     */
    ExtractCert noArmor();

    /**
     * Extract the cert(s) from the provided key(s).
     *
     * @param keyInputStream input stream containing the encoding of one or more OpenPGP keys
     * @return result containing the encoding of the keys certs
     *
     * @throws IOException in case of an IO error
     * @throws sop.exception.SOPGPException.BadData if the {@link InputStream} does not contain an OpenPGP key
     */
    Ready key(InputStream keyInputStream)
            throws IOException,
            SOPGPException.BadData;

    /**
     * Extract the cert(s) from the provided key(s).
     *
     * @param key byte array containing the encoding of one or more OpenPGP key
     * @return result containing the encoding of the keys certs
     *
     * @throws IOException in case of an IO error
     * @throws sop.exception.SOPGPException.BadData if the byte array does not contain an OpenPGP key
     */
    default Ready key(byte[] key)
            throws IOException,
            SOPGPException.BadData {
        return key(new ByteArrayInputStream(key));
    }
}