mirror of
https://github.com/pgpainless/pgpainless.git
synced 2024-11-19 10:52:05 +01:00
Kotlin conversion: KeyRingReader
This commit is contained in:
parent
e3f51fbf56
commit
bbd956dbb7
GPG key ID:
62BEE9264BF17311
3 changed files with 333 additions and 423 deletions
|
|
@ -1,415 +0,0 @@
|
||||||
// SPDX-FileCopyrightText: 2018 Paul Schaub <vanitasvitae@fsfe.org>
|
|
||||||
//
|
|
||||||
// SPDX-License-Identifier: Apache-2.0
|
|
||||||
|
|
||||||
package org.pgpainless.key.parsing;
|
|
||||||
|
|
||||||
import java.io.ByteArrayInputStream;
|
|
||||||
import java.io.IOException;
|
|
||||||
import java.io.InputStream;
|
|
||||||
import java.nio.charset.Charset;
|
|
||||||
import java.util.ArrayList;
|
|
||||||
import java.util.Iterator;
|
|
||||||
import java.util.List;
|
|
||||||
import javax.annotation.Nonnull;
|
|
||||||
import javax.annotation.Nullable;
|
|
||||||
|
|
||||||
import org.bouncycastle.openpgp.PGPException;
|
|
||||||
import org.bouncycastle.openpgp.PGPKeyRing;
|
|
||||||
import org.bouncycastle.openpgp.PGPMarker;
|
|
||||||
import org.bouncycastle.openpgp.PGPObjectFactory;
|
|
||||||
import org.bouncycastle.openpgp.PGPPublicKeyRing;
|
|
||||||
import org.bouncycastle.openpgp.PGPPublicKeyRingCollection;
|
|
||||||
import org.bouncycastle.openpgp.PGPSecretKeyRing;
|
|
||||||
import org.bouncycastle.openpgp.PGPSecretKeyRingCollection;
|
|
||||||
import org.bouncycastle.util.io.Streams;
|
|
||||||
import org.pgpainless.PGPainless;
|
|
||||||
import org.pgpainless.implementation.ImplementationFactory;
|
|
||||||
import org.pgpainless.key.collection.PGPKeyRingCollection;
|
|
||||||
import org.pgpainless.util.ArmorUtils;
|
|
||||||
|
|
||||||
public class KeyRingReader {
|
|
||||||
|
|
||||||
public static final int MAX_ITERATIONS = 10000;
|
|
||||||
|
|
||||||
@SuppressWarnings("CharsetObjectCanBeUsed")
|
|
||||||
public static final Charset UTF8 = Charset.forName("UTF-8");
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Read a {@link PGPKeyRing} (either {@link PGPSecretKeyRing} or {@link PGPPublicKeyRing}) from the given
|
|
||||||
* {@link InputStream}.
|
|
||||||
*
|
|
||||||
* @param inputStream inputStream containing the OpenPGP key or certificate
|
|
||||||
* @return key ring
|
|
||||||
* @throws IOException in case of an IO error
|
|
||||||
*/
|
|
||||||
@Nullable
|
|
||||||
public PGPKeyRing keyRing(@Nonnull InputStream inputStream)
|
|
||||||
throws IOException {
|
|
||||||
return readKeyRing(inputStream);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Read a {@link PGPKeyRing} (either {@link PGPSecretKeyRing} or {@link PGPPublicKeyRing}) from the given
|
|
||||||
* byte array.
|
|
||||||
*
|
|
||||||
* @param bytes byte array containing the OpenPGP key or certificate
|
|
||||||
* @return key ring
|
|
||||||
* @throws IOException in case of an IO error
|
|
||||||
*/
|
|
||||||
@Nullable
|
|
||||||
public PGPKeyRing keyRing(@Nonnull byte[] bytes)
|
|
||||||
throws IOException {
|
|
||||||
return keyRing(new ByteArrayInputStream(bytes));
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Read a {@link PGPKeyRing} (either {@link PGPSecretKeyRing} or {@link PGPPublicKeyRing}) from the given
|
|
||||||
* ASCII armored string.
|
|
||||||
*
|
|
||||||
* @param asciiArmored ASCII armored OpenPGP key or certificate
|
|
||||||
* @return key ring
|
|
||||||
* @throws IOException in case of an IO error
|
|
||||||
*/
|
|
||||||
@Nullable
|
|
||||||
public PGPKeyRing keyRing(@Nonnull String asciiArmored)
|
|
||||||
throws IOException {
|
|
||||||
return keyRing(asciiArmored.getBytes(UTF8));
|
|
||||||
}
|
|
||||||
|
|
||||||
@Nullable
|
|
||||||
public PGPPublicKeyRing publicKeyRing(@Nonnull InputStream inputStream)
|
|
||||||
throws IOException {
|
|
||||||
return readPublicKeyRing(inputStream);
|
|
||||||
}
|
|
||||||
|
|
||||||
@Nullable
|
|
||||||
public PGPPublicKeyRing publicKeyRing(@Nonnull byte[] bytes)
|
|
||||||
throws IOException {
|
|
||||||
return publicKeyRing(new ByteArrayInputStream(bytes));
|
|
||||||
}
|
|
||||||
|
|
||||||
@Nullable
|
|
||||||
public PGPPublicKeyRing publicKeyRing(@Nonnull String asciiArmored)
|
|
||||||
throws IOException {
|
|
||||||
return publicKeyRing(asciiArmored.getBytes(UTF8));
|
|
||||||
}
|
|
||||||
|
|
||||||
@Nonnull
|
|
||||||
public PGPPublicKeyRingCollection publicKeyRingCollection(@Nonnull InputStream inputStream)
|
|
||||||
throws IOException {
|
|
||||||
return readPublicKeyRingCollection(inputStream);
|
|
||||||
}
|
|
||||||
|
|
||||||
@Nonnull
|
|
||||||
public PGPPublicKeyRingCollection publicKeyRingCollection(@Nonnull byte[] bytes)
|
|
||||||
throws IOException {
|
|
||||||
return publicKeyRingCollection(new ByteArrayInputStream(bytes));
|
|
||||||
}
|
|
||||||
|
|
||||||
@Nonnull
|
|
||||||
public PGPPublicKeyRingCollection publicKeyRingCollection(@Nonnull String asciiArmored)
|
|
||||||
throws IOException {
|
|
||||||
return publicKeyRingCollection(asciiArmored.getBytes(UTF8));
|
|
||||||
}
|
|
||||||
|
|
||||||
@Nullable
|
|
||||||
public PGPSecretKeyRing secretKeyRing(@Nonnull InputStream inputStream)
|
|
||||||
throws IOException {
|
|
||||||
return readSecretKeyRing(inputStream);
|
|
||||||
}
|
|
||||||
|
|
||||||
@Nullable
|
|
||||||
public PGPSecretKeyRing secretKeyRing(@Nonnull byte[] bytes)
|
|
||||||
throws IOException {
|
|
||||||
return secretKeyRing(new ByteArrayInputStream(bytes));
|
|
||||||
}
|
|
||||||
|
|
||||||
@Nullable
|
|
||||||
public PGPSecretKeyRing secretKeyRing(@Nonnull String asciiArmored)
|
|
||||||
throws IOException {
|
|
||||||
return secretKeyRing(asciiArmored.getBytes(UTF8));
|
|
||||||
}
|
|
||||||
|
|
||||||
@Nonnull
|
|
||||||
public PGPSecretKeyRingCollection secretKeyRingCollection(@Nonnull InputStream inputStream)
|
|
||||||
throws IOException {
|
|
||||||
return readSecretKeyRingCollection(inputStream);
|
|
||||||
}
|
|
||||||
|
|
||||||
@Nonnull
|
|
||||||
public PGPSecretKeyRingCollection secretKeyRingCollection(@Nonnull byte[] bytes)
|
|
||||||
throws IOException {
|
|
||||||
return secretKeyRingCollection(new ByteArrayInputStream(bytes));
|
|
||||||
}
|
|
||||||
|
|
||||||
@Nonnull
|
|
||||||
public PGPSecretKeyRingCollection secretKeyRingCollection(@Nonnull String asciiArmored)
|
|
||||||
throws IOException {
|
|
||||||
return secretKeyRingCollection(asciiArmored.getBytes(UTF8));
|
|
||||||
}
|
|
||||||
|
|
||||||
@Nonnull
|
|
||||||
public PGPKeyRingCollection keyRingCollection(@Nonnull InputStream inputStream, boolean isSilent)
|
|
||||||
throws IOException, PGPException {
|
|
||||||
return readKeyRingCollection(inputStream, isSilent);
|
|
||||||
}
|
|
||||||
|
|
||||||
@Nonnull
|
|
||||||
public PGPKeyRingCollection keyRingCollection(@Nonnull byte[] bytes, boolean isSilent)
|
|
||||||
throws IOException, PGPException {
|
|
||||||
return keyRingCollection(new ByteArrayInputStream(bytes), isSilent);
|
|
||||||
}
|
|
||||||
|
|
||||||
@Nonnull
|
|
||||||
public PGPKeyRingCollection keyRingCollection(@Nonnull String asciiArmored, boolean isSilent)
|
|
||||||
throws IOException, PGPException {
|
|
||||||
return keyRingCollection(asciiArmored.getBytes(UTF8), isSilent);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Read a {@link PGPKeyRing} (either {@link PGPSecretKeyRing} or {@link PGPPublicKeyRing}) from the given
|
|
||||||
* {@link InputStream}.
|
|
||||||
* This method will attempt to read at most {@link #MAX_ITERATIONS} objects from the stream before aborting.
|
|
||||||
* The first {@link PGPPublicKeyRing} or {@link PGPSecretKeyRing} will be returned.
|
|
||||||
*
|
|
||||||
* @param inputStream inputStream containing the OpenPGP key or certificate
|
|
||||||
* @return key ring
|
|
||||||
* @throws IOException in case of an IO error
|
|
||||||
*/
|
|
||||||
@Nullable
|
|
||||||
public static PGPKeyRing readKeyRing(@Nonnull InputStream inputStream)
|
|
||||||
throws IOException {
|
|
||||||
return readKeyRing(inputStream, MAX_ITERATIONS);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Read a {@link PGPKeyRing} (either {@link PGPSecretKeyRing} or {@link PGPPublicKeyRing}) from the given
|
|
||||||
* {@link InputStream}.
|
|
||||||
* This method will attempt to read at most <pre>maxIterations</pre> objects from the stream before aborting.
|
|
||||||
* The first {@link PGPPublicKeyRing} or {@link PGPSecretKeyRing} will be returned.
|
|
||||||
*
|
|
||||||
* @param inputStream inputStream containing the OpenPGP key or certificate
|
|
||||||
* @param maxIterations maximum number of objects that are read before the method will abort
|
|
||||||
* @return key ring
|
|
||||||
* @throws IOException in case of an IO error
|
|
||||||
*/
|
|
||||||
@Nullable
|
|
||||||
public static PGPKeyRing readKeyRing(@Nonnull InputStream inputStream, int maxIterations)
|
|
||||||
throws IOException {
|
|
||||||
PGPObjectFactory objectFactory = ImplementationFactory.getInstance().getPGPObjectFactory(
|
|
||||||
ArmorUtils.getDecoderStream(inputStream));
|
|
||||||
int i = 0;
|
|
||||||
Object next;
|
|
||||||
do {
|
|
||||||
next = objectFactory.nextObject();
|
|
||||||
if (next == null) {
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
if (next instanceof PGPMarker) {
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
if (next instanceof PGPSecretKeyRing) {
|
|
||||||
return (PGPSecretKeyRing) next;
|
|
||||||
}
|
|
||||||
if (next instanceof PGPPublicKeyRing) {
|
|
||||||
return (PGPPublicKeyRing) next;
|
|
||||||
}
|
|
||||||
} while (++i < maxIterations);
|
|
||||||
|
|
||||||
throw new IOException("Loop exceeded max iteration count.");
|
|
||||||
}
|
|
||||||
|
|
||||||
@Nullable
|
|
||||||
public static PGPPublicKeyRing readPublicKeyRing(@Nonnull InputStream inputStream)
|
|
||||||
throws IOException {
|
|
||||||
return readPublicKeyRing(inputStream, MAX_ITERATIONS);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Read a public key ring from the provided {@link InputStream}.
|
|
||||||
* If more than maxIterations PGP packets are encountered before a {@link PGPPublicKeyRing} is read,
|
|
||||||
* an {@link IOException} is thrown.
|
|
||||||
*
|
|
||||||
* @param inputStream input stream
|
|
||||||
* @param maxIterations max iterations before abort
|
|
||||||
* @return public key ring
|
|
||||||
*
|
|
||||||
* @throws IOException in case of an IO error or exceeding of max iterations
|
|
||||||
*/
|
|
||||||
@Nullable
|
|
||||||
public static PGPPublicKeyRing readPublicKeyRing(@Nonnull InputStream inputStream, int maxIterations)
|
|
||||||
throws IOException {
|
|
||||||
PGPObjectFactory objectFactory = ImplementationFactory.getInstance().getPGPObjectFactory(
|
|
||||||
ArmorUtils.getDecoderStream(inputStream));
|
|
||||||
int i = 0;
|
|
||||||
Object next;
|
|
||||||
do {
|
|
||||||
next = objectFactory.nextObject();
|
|
||||||
if (next == null) {
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
if (next instanceof PGPMarker) {
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
if (next instanceof PGPPublicKeyRing) {
|
|
||||||
return (PGPPublicKeyRing) next;
|
|
||||||
}
|
|
||||||
} while (++i < maxIterations);
|
|
||||||
|
|
||||||
throw new IOException("Loop exceeded max iteration count.");
|
|
||||||
}
|
|
||||||
|
|
||||||
@Nonnull
|
|
||||||
public static PGPPublicKeyRingCollection readPublicKeyRingCollection(@Nonnull InputStream inputStream)
|
|
||||||
throws IOException {
|
|
||||||
return readPublicKeyRingCollection(inputStream, MAX_ITERATIONS);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Read a public key ring collection from the provided {@link InputStream}.
|
|
||||||
* If more than maxIterations PGP packets are encountered before the stream is exhausted,
|
|
||||||
* an {@link IOException} is thrown.
|
|
||||||
* If the stream contain secret key packets, their public key parts are extracted and returned.
|
|
||||||
*
|
|
||||||
* @param inputStream input stream
|
|
||||||
* @param maxIterations max iterations before abort
|
|
||||||
* @return public key ring collection
|
|
||||||
*
|
|
||||||
* @throws IOException in case of an IO error or exceeding of max iterations
|
|
||||||
*/
|
|
||||||
@Nonnull
|
|
||||||
public static PGPPublicKeyRingCollection readPublicKeyRingCollection(@Nonnull InputStream inputStream, int maxIterations)
|
|
||||||
throws IOException {
|
|
||||||
PGPObjectFactory objectFactory = ImplementationFactory.getInstance().getPGPObjectFactory(
|
|
||||||
ArmorUtils.getDecoderStream(inputStream));
|
|
||||||
|
|
||||||
List<PGPPublicKeyRing> rings = new ArrayList<>();
|
|
||||||
int i = 0;
|
|
||||||
Object next;
|
|
||||||
do {
|
|
||||||
next = objectFactory.nextObject();
|
|
||||||
if (next == null) {
|
|
||||||
return new PGPPublicKeyRingCollection(rings);
|
|
||||||
}
|
|
||||||
if (next instanceof PGPMarker) {
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
if (next instanceof PGPPublicKeyRing) {
|
|
||||||
rings.add((PGPPublicKeyRing) next);
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
// Parse public keys from secret keys
|
|
||||||
if (next instanceof PGPSecretKeyRing) {
|
|
||||||
rings.add(PGPainless.extractCertificate((PGPSecretKeyRing) next));
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
if (next instanceof PGPPublicKeyRingCollection) {
|
|
||||||
PGPPublicKeyRingCollection collection = (PGPPublicKeyRingCollection) next;
|
|
||||||
Iterator<PGPPublicKeyRing> iterator = collection.getKeyRings();
|
|
||||||
while (iterator.hasNext()) {
|
|
||||||
rings.add(iterator.next());
|
|
||||||
}
|
|
||||||
}
|
|
||||||
} while (++i < maxIterations);
|
|
||||||
|
|
||||||
throw new IOException("Loop exceeded max iteration count.");
|
|
||||||
}
|
|
||||||
|
|
||||||
@Nullable
|
|
||||||
public static PGPSecretKeyRing readSecretKeyRing(@Nonnull InputStream inputStream)
|
|
||||||
throws IOException {
|
|
||||||
return readSecretKeyRing(inputStream, MAX_ITERATIONS);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Read a secret key ring from the provided {@link InputStream}.
|
|
||||||
* If more than maxIterations PGP packets are encountered before a {@link PGPSecretKeyRing} is read,
|
|
||||||
* an {@link IOException} is thrown.
|
|
||||||
*
|
|
||||||
* @param inputStream input stream
|
|
||||||
* @param maxIterations max iterations before abort
|
|
||||||
* @return public key ring
|
|
||||||
*
|
|
||||||
* @throws IOException in case of an IO error or exceeding of max iterations
|
|
||||||
*/
|
|
||||||
@Nullable
|
|
||||||
public static PGPSecretKeyRing readSecretKeyRing(@Nonnull InputStream inputStream, int maxIterations)
|
|
||||||
throws IOException {
|
|
||||||
InputStream decoderStream = ArmorUtils.getDecoderStream(inputStream);
|
|
||||||
PGPObjectFactory objectFactory = ImplementationFactory.getInstance().getPGPObjectFactory(decoderStream);
|
|
||||||
int i = 0;
|
|
||||||
Object next;
|
|
||||||
do {
|
|
||||||
next = objectFactory.nextObject();
|
|
||||||
if (next == null) {
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
if (next instanceof PGPMarker) {
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
if (next instanceof PGPSecretKeyRing) {
|
|
||||||
Streams.drain(decoderStream);
|
|
||||||
return (PGPSecretKeyRing) next;
|
|
||||||
}
|
|
||||||
} while (++i < maxIterations);
|
|
||||||
|
|
||||||
throw new IOException("Loop exceeded max iteration count.");
|
|
||||||
}
|
|
||||||
|
|
||||||
@Nonnull
|
|
||||||
public static PGPSecretKeyRingCollection readSecretKeyRingCollection(@Nonnull InputStream inputStream)
|
|
||||||
throws IOException {
|
|
||||||
return readSecretKeyRingCollection(inputStream, MAX_ITERATIONS);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Read a secret key ring collection from the provided {@link InputStream}.
|
|
||||||
* If more than maxIterations PGP packets are encountered before the stream is exhausted,
|
|
||||||
* an {@link IOException} is thrown.
|
|
||||||
*
|
|
||||||
* @param inputStream input stream
|
|
||||||
* @param maxIterations max iterations before abort
|
|
||||||
* @return secret key ring collection
|
|
||||||
*
|
|
||||||
* @throws IOException in case of an IO error or exceeding of max iterations
|
|
||||||
*/
|
|
||||||
@Nonnull
|
|
||||||
public static PGPSecretKeyRingCollection readSecretKeyRingCollection(@Nonnull InputStream inputStream,
|
|
||||||
int maxIterations)
|
|
||||||
throws IOException {
|
|
||||||
PGPObjectFactory objectFactory = ImplementationFactory.getInstance().getPGPObjectFactory(
|
|
||||||
ArmorUtils.getDecoderStream(inputStream));
|
|
||||||
|
|
||||||
List<PGPSecretKeyRing> rings = new ArrayList<>();
|
|
||||||
int i = 0;
|
|
||||||
Object next;
|
|
||||||
do {
|
|
||||||
next = objectFactory.nextObject();
|
|
||||||
if (next == null) {
|
|
||||||
return new PGPSecretKeyRingCollection(rings);
|
|
||||||
}
|
|
||||||
if (next instanceof PGPMarker) {
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
if (next instanceof PGPSecretKeyRing) {
|
|
||||||
rings.add((PGPSecretKeyRing) next);
|
|
||||||
}
|
|
||||||
if (next instanceof PGPSecretKeyRingCollection) {
|
|
||||||
PGPSecretKeyRingCollection collection = (PGPSecretKeyRingCollection) next;
|
|
||||||
Iterator<PGPSecretKeyRing> iterator = collection.getKeyRings();
|
|
||||||
while (iterator.hasNext()) {
|
|
||||||
rings.add(iterator.next());
|
|
||||||
}
|
|
||||||
}
|
|
||||||
} while (++i < maxIterations);
|
|
||||||
|
|
||||||
throw new IOException("Loop exceeded max iteration count.");
|
|
||||||
}
|
|
||||||
|
|
||||||
@Nonnull
|
|
||||||
public static PGPKeyRingCollection readKeyRingCollection(@Nonnull InputStream inputStream, boolean isSilent)
|
|
||||||
throws IOException, PGPException {
|
|
||||||
return new PGPKeyRingCollection(inputStream, isSilent);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
@ -1,8 +0,0 @@
|
||||||
// SPDX-FileCopyrightText: 2018 Paul Schaub <vanitasvitae@fsfe.org>
|
|
||||||
//
|
|
||||||
// SPDX-License-Identifier: Apache-2.0
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Classes related to OpenPGP key reading.
|
|
||||||
*/
|
|
||||||
package org.pgpainless.key.parsing;
|
|
||||||
|
|
@ -0,0 +1,333 @@
|
||||||
|
// SPDX-FileCopyrightText: 2023 Paul Schaub <vanitasvitae@fsfe.org>
|
||||||
|
//
|
||||||
|
// SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
|
package org.pgpainless.key.parsing
|
||||||
|
|
||||||
|
import org.bouncycastle.openpgp.*
|
||||||
|
import org.bouncycastle.util.io.Streams
|
||||||
|
import org.pgpainless.PGPainless
|
||||||
|
import org.pgpainless.implementation.ImplementationFactory
|
||||||
|
import org.pgpainless.key.collection.PGPKeyRingCollection
|
||||||
|
import org.pgpainless.util.ArmorUtils
|
||||||
|
import java.io.IOException
|
||||||
|
import java.io.InputStream
|
||||||
|
import java.nio.charset.Charset
|
||||||
|
import kotlin.jvm.Throws
|
||||||
|
|
||||||
|
class KeyRingReader {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Read a [PGPKeyRing] (either [PGPSecretKeyRing] or [PGPPublicKeyRing]) from the given [InputStream].
|
||||||
|
*
|
||||||
|
* @param inputStream inputStream containing the OpenPGP key or certificate
|
||||||
|
* @return key ring
|
||||||
|
* @throws IOException in case of an IO error
|
||||||
|
*/
|
||||||
|
@Throws(IOException::class)
|
||||||
|
fun keyRing(inputStream: InputStream): PGPKeyRing? =
|
||||||
|
readKeyRing(inputStream)
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Read a [PGPKeyRing] (either [PGPSecretKeyRing] or [PGPPublicKeyRing]) from the given byte array.
|
||||||
|
*
|
||||||
|
* @param bytes byte array containing the OpenPGP key or certificate
|
||||||
|
* @return key ring
|
||||||
|
* @throws IOException in case of an IO error
|
||||||
|
*/
|
||||||
|
@Throws(IOException::class)
|
||||||
|
fun keyRing(bytes: ByteArray): PGPKeyRing? =
|
||||||
|
keyRing(bytes.inputStream())
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Read a [PGPKeyRing] (either [PGPSecretKeyRing] or [PGPPublicKeyRing]) from the given
|
||||||
|
* ASCII armored string.
|
||||||
|
*
|
||||||
|
* @param asciiArmored ASCII armored OpenPGP key or certificate
|
||||||
|
* @return key ring
|
||||||
|
* @throws IOException in case of an IO error
|
||||||
|
*/
|
||||||
|
@Throws(IOException::class)
|
||||||
|
fun keyRing(asciiArmored: String): PGPKeyRing? =
|
||||||
|
keyRing(asciiArmored.toByteArray(UTF8))
|
||||||
|
|
||||||
|
@Throws(IOException::class)
|
||||||
|
fun publicKeyRing(inputStream: InputStream): PGPPublicKeyRing? =
|
||||||
|
readPublicKeyRing(inputStream)
|
||||||
|
|
||||||
|
@Throws(IOException::class)
|
||||||
|
fun publicKeyRing(bytes: ByteArray): PGPPublicKeyRing? =
|
||||||
|
publicKeyRing(bytes.inputStream())
|
||||||
|
|
||||||
|
@Throws(IOException::class)
|
||||||
|
fun publicKeyRing(asciiArmored: String): PGPPublicKeyRing? =
|
||||||
|
publicKeyRing(asciiArmored.toByteArray(UTF8))
|
||||||
|
|
||||||
|
@Throws(IOException::class)
|
||||||
|
fun publicKeyRingCollection(inputStream: InputStream): PGPPublicKeyRingCollection =
|
||||||
|
readPublicKeyRingCollection(inputStream)
|
||||||
|
|
||||||
|
@Throws(IOException::class)
|
||||||
|
fun publicKeyRingCollection(bytes: ByteArray): PGPPublicKeyRingCollection =
|
||||||
|
publicKeyRingCollection(bytes.inputStream())
|
||||||
|
|
||||||
|
@Throws(IOException::class)
|
||||||
|
fun publicKeyRingCollection(asciiArmored: String): PGPPublicKeyRingCollection =
|
||||||
|
publicKeyRingCollection(asciiArmored.toByteArray(UTF8))
|
||||||
|
|
||||||
|
@Throws(IOException::class)
|
||||||
|
fun secretKeyRing(inputStream: InputStream): PGPSecretKeyRing? =
|
||||||
|
readSecretKeyRing(inputStream)
|
||||||
|
|
||||||
|
@Throws(IOException::class)
|
||||||
|
fun secretKeyRing(bytes: ByteArray): PGPSecretKeyRing? =
|
||||||
|
secretKeyRing(bytes.inputStream())
|
||||||
|
|
||||||
|
@Throws(IOException::class)
|
||||||
|
fun secretKeyRing(asciiArmored: String): PGPSecretKeyRing? =
|
||||||
|
secretKeyRing(asciiArmored.toByteArray(UTF8))
|
||||||
|
|
||||||
|
@Throws(IOException::class)
|
||||||
|
fun secretKeyRingCollection(inputStream: InputStream): PGPSecretKeyRingCollection =
|
||||||
|
readSecretKeyRingCollection(inputStream)
|
||||||
|
|
||||||
|
@Throws(IOException::class)
|
||||||
|
fun secretKeyRingCollection(bytes: ByteArray): PGPSecretKeyRingCollection =
|
||||||
|
secretKeyRingCollection(bytes.inputStream())
|
||||||
|
|
||||||
|
@Throws(IOException::class)
|
||||||
|
fun secretKeyRingCollection(asciiArmored: String): PGPSecretKeyRingCollection =
|
||||||
|
secretKeyRingCollection(asciiArmored.toByteArray(UTF8))
|
||||||
|
|
||||||
|
@Throws(IOException::class)
|
||||||
|
fun keyRingCollection(inptStream: InputStream, isSilent: Boolean): PGPKeyRingCollection =
|
||||||
|
readKeyRingCollection(inptStream, isSilent)
|
||||||
|
|
||||||
|
@Throws(IOException::class)
|
||||||
|
fun keyRingCollection(bytes: ByteArray, isSilent: Boolean): PGPKeyRingCollection =
|
||||||
|
keyRingCollection(bytes.inputStream(), isSilent)
|
||||||
|
|
||||||
|
@Throws(IOException::class)
|
||||||
|
fun keyRingCollection(asciiArmored: String, isSilent: Boolean): PGPKeyRingCollection =
|
||||||
|
keyRingCollection(asciiArmored.toByteArray(UTF8), isSilent)
|
||||||
|
|
||||||
|
companion object {
|
||||||
|
private const val MAX_ITERATIONS = 10000
|
||||||
|
|
||||||
|
@JvmStatic
|
||||||
|
val UTF8: Charset = charset("UTF8")
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Read a [PGPKeyRing] (either [PGPSecretKeyRing] or [PGPPublicKeyRing]) from the given [InputStream].
|
||||||
|
* This method will attempt to read at most <pre>maxIterations</pre> objects from the stream before aborting.
|
||||||
|
* The first [PGPPublicKeyRing] or [PGPSecretKeyRing] will be returned.
|
||||||
|
*
|
||||||
|
* @param inputStream inputStream containing the OpenPGP key or certificate
|
||||||
|
* @param maxIterations maximum number of objects that are read before the method will abort
|
||||||
|
* @return key ring
|
||||||
|
* @throws IOException in case of an IO error
|
||||||
|
*/
|
||||||
|
@JvmStatic
|
||||||
|
@JvmOverloads
|
||||||
|
@Throws(IOException::class)
|
||||||
|
fun readKeyRing(inputStream: InputStream,
|
||||||
|
maxIterations: Int = MAX_ITERATIONS): PGPKeyRing? {
|
||||||
|
val objectFactory = ImplementationFactory.getInstance().getPGPObjectFactory(
|
||||||
|
ArmorUtils.getDecoderStream(inputStream))
|
||||||
|
|
||||||
|
try {
|
||||||
|
for ((i, next) in objectFactory.withIndex()) {
|
||||||
|
if (i >= maxIterations) {
|
||||||
|
throw IOException("Loop exceeded max iteration count.")
|
||||||
|
}
|
||||||
|
if (next is PGPMarker) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if (next is PGPSecretKeyRing) {
|
||||||
|
return next
|
||||||
|
}
|
||||||
|
if (next is PGPPublicKeyRing) {
|
||||||
|
return next
|
||||||
|
}
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
} catch (e : PGPRuntimeOperationException) {
|
||||||
|
throw e.cause!!
|
||||||
|
}
|
||||||
|
return null
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Read a public key ring from the provided [InputStream].
|
||||||
|
* If more than maxIterations PGP packets are encountered before a [PGPPublicKeyRing] is read,
|
||||||
|
* an [IOException] is thrown.
|
||||||
|
*
|
||||||
|
* @param inputStream input stream
|
||||||
|
* @param maxIterations max iterations before abort
|
||||||
|
* @return public key ring
|
||||||
|
*
|
||||||
|
* @throws IOException in case of an IO error or exceeding of max iterations
|
||||||
|
*/
|
||||||
|
@JvmStatic
|
||||||
|
@JvmOverloads
|
||||||
|
@Throws(IOException::class)
|
||||||
|
fun readPublicKeyRing(inputStream: InputStream,
|
||||||
|
maxIterations: Int = MAX_ITERATIONS): PGPPublicKeyRing? {
|
||||||
|
val objectFactory = ImplementationFactory.getInstance().getPGPObjectFactory(
|
||||||
|
ArmorUtils.getDecoderStream(inputStream))
|
||||||
|
|
||||||
|
try {
|
||||||
|
for ((i, next) in objectFactory.withIndex()) {
|
||||||
|
if (i >= maxIterations) {
|
||||||
|
throw IOException("Loop exceeded max iteration count.")
|
||||||
|
}
|
||||||
|
if (next is PGPMarker) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if (next is PGPPublicKeyRing) {
|
||||||
|
return next
|
||||||
|
}
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
} catch (e : PGPRuntimeOperationException) {
|
||||||
|
throw e.cause!!
|
||||||
|
}
|
||||||
|
return null
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Read a public key ring collection from the provided [InputStream].
|
||||||
|
* If more than maxIterations PGP packets are encountered before the stream is exhausted,
|
||||||
|
* an [IOException] is thrown.
|
||||||
|
* If the stream contain secret key packets, their public key parts are extracted and returned.
|
||||||
|
*
|
||||||
|
* @param inputStream input stream
|
||||||
|
* @param maxIterations max iterations before abort
|
||||||
|
* @return public key ring collection
|
||||||
|
*
|
||||||
|
* @throws IOException in case of an IO error or exceeding of max iterations
|
||||||
|
*/
|
||||||
|
@JvmStatic
|
||||||
|
@JvmOverloads
|
||||||
|
@Throws(IOException::class)
|
||||||
|
fun readPublicKeyRingCollection(inputStream: InputStream,
|
||||||
|
maxIterations: Int = MAX_ITERATIONS): PGPPublicKeyRingCollection {
|
||||||
|
val objectFactory = ImplementationFactory.getInstance().getPGPObjectFactory(
|
||||||
|
ArmorUtils.getDecoderStream(inputStream))
|
||||||
|
val certificates = mutableListOf<PGPPublicKeyRing>()
|
||||||
|
try {
|
||||||
|
for ((i, next) in objectFactory.withIndex()) {
|
||||||
|
if (i >= maxIterations) {
|
||||||
|
throw IOException("Loop exceeded max iteration count.")
|
||||||
|
}
|
||||||
|
if (next is PGPMarker) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if (next is PGPPublicKeyRing) {
|
||||||
|
certificates.add(next)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if (next is PGPSecretKeyRing) {
|
||||||
|
certificates.add(PGPainless.extractCertificate(next))
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if (next is PGPPublicKeyRingCollection) {
|
||||||
|
certificates.addAll(next)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} catch (e : PGPRuntimeOperationException) {
|
||||||
|
throw e.cause!!
|
||||||
|
}
|
||||||
|
return PGPPublicKeyRingCollection(certificates)
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Read a secret key ring from the provided [InputStream].
|
||||||
|
* If more than maxIterations PGP packets are encountered before a [PGPSecretKeyRing] is read,
|
||||||
|
* an [IOException] is thrown.
|
||||||
|
*
|
||||||
|
* @param inputStream input stream
|
||||||
|
* @param maxIterations max iterations before abort
|
||||||
|
* @return public key ring
|
||||||
|
*
|
||||||
|
* @throws IOException in case of an IO error or exceeding of max iterations
|
||||||
|
*/
|
||||||
|
@JvmStatic
|
||||||
|
@JvmOverloads
|
||||||
|
@Throws(IOException::class)
|
||||||
|
fun readSecretKeyRing(inputStream: InputStream,
|
||||||
|
maxIterations: Int = MAX_ITERATIONS): PGPSecretKeyRing? {
|
||||||
|
val decoderStream = ArmorUtils.getDecoderStream(inputStream)
|
||||||
|
val objectFactory = ImplementationFactory.getInstance().getPGPObjectFactory(decoderStream)
|
||||||
|
|
||||||
|
try {
|
||||||
|
for ((i, next) in objectFactory.withIndex()) {
|
||||||
|
if (i >= maxIterations) {
|
||||||
|
throw IOException("Loop exceeded max iteration count.")
|
||||||
|
}
|
||||||
|
if (next is PGPMarker) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if (next is PGPSecretKeyRing) {
|
||||||
|
Streams.drain(decoderStream)
|
||||||
|
return next
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} catch (e : PGPRuntimeOperationException) {
|
||||||
|
throw e.cause!!
|
||||||
|
}
|
||||||
|
return null
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Read a secret key ring collection from the provided [InputStream].
|
||||||
|
* If more than maxIterations PGP packets are encountered before the stream is exhausted,
|
||||||
|
* an [IOException] is thrown.
|
||||||
|
*
|
||||||
|
* @param inputStream input stream
|
||||||
|
* @param maxIterations max iterations before abort
|
||||||
|
* @return secret key ring collection
|
||||||
|
*
|
||||||
|
* @throws IOException in case of an IO error or exceeding of max iterations
|
||||||
|
*/
|
||||||
|
@JvmStatic
|
||||||
|
@JvmOverloads
|
||||||
|
@Throws(IOException::class)
|
||||||
|
fun readSecretKeyRingCollection(inputStream: InputStream,
|
||||||
|
maxIterations: Int = MAX_ITERATIONS): PGPSecretKeyRingCollection {
|
||||||
|
val objectFactory = ImplementationFactory.getInstance().getPGPObjectFactory(
|
||||||
|
ArmorUtils.getDecoderStream(inputStream))
|
||||||
|
|
||||||
|
val secretKeys = mutableListOf<PGPSecretKeyRing>()
|
||||||
|
try {
|
||||||
|
for ((i, next) in objectFactory.withIndex()) {
|
||||||
|
if (i >= maxIterations) {
|
||||||
|
throw IOException("Loop exceeded max iteration count.")
|
||||||
|
}
|
||||||
|
if (next is PGPMarker) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if (next is PGPSecretKeyRing) {
|
||||||
|
secretKeys.add(next)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if (next is PGPSecretKeyRingCollection) {
|
||||||
|
secretKeys.addAll(next)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} catch (e : PGPRuntimeOperationException) {
|
||||||
|
throw e.cause!!
|
||||||
|
}
|
||||||
|
return PGPSecretKeyRingCollection(secretKeys)
|
||||||
|
}
|
||||||
|
|
||||||
|
@JvmStatic
|
||||||
|
@Throws(IOException::class)
|
||||||
|
fun readKeyRingCollection(inputStream: InputStream, isSilent: Boolean): PGPKeyRingCollection =
|
||||||
|
PGPKeyRingCollection(inputStream, isSilent)
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
Loading…
Reference in a new issue