Package org.pgpainless.key.parsing
Class KeyRingReader
java.lang.Object
org.pgpainless.key.parsing.KeyRingReader
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionorg.bouncycastle.openpgp.PGPKeyRing
keyRing
(byte[] bytes) Read aPGPKeyRing
(eitherPGPSecretKeyRing
orPGPPublicKeyRing
) from the given byte array.org.bouncycastle.openpgp.PGPKeyRing
keyRing
(InputStream inputStream) org.bouncycastle.openpgp.PGPKeyRing
Read aPGPKeyRing
(eitherPGPSecretKeyRing
orPGPPublicKeyRing
) from the given ASCII armored string.keyRingCollection
(byte[] bytes, boolean isSilent) keyRingCollection
(InputStream inputStream, boolean isSilent) keyRingCollection
(String asciiArmored, boolean isSilent) org.bouncycastle.openpgp.PGPPublicKeyRing
publicKeyRing
(byte[] bytes) org.bouncycastle.openpgp.PGPPublicKeyRing
publicKeyRing
(InputStream inputStream) org.bouncycastle.openpgp.PGPPublicKeyRing
publicKeyRing
(String asciiArmored) org.bouncycastle.openpgp.PGPPublicKeyRingCollection
publicKeyRingCollection
(byte[] bytes) org.bouncycastle.openpgp.PGPPublicKeyRingCollection
publicKeyRingCollection
(InputStream inputStream) org.bouncycastle.openpgp.PGPPublicKeyRingCollection
publicKeyRingCollection
(String asciiArmored) static org.bouncycastle.openpgp.PGPKeyRing
readKeyRing
(InputStream inputStream) static org.bouncycastle.openpgp.PGPKeyRing
readKeyRing
(InputStream inputStream, int maxIterations) static PGPKeyRingCollection
readKeyRingCollection
(InputStream inputStream, boolean isSilent) static org.bouncycastle.openpgp.PGPPublicKeyRing
readPublicKeyRing
(InputStream inputStream) static org.bouncycastle.openpgp.PGPPublicKeyRing
readPublicKeyRing
(InputStream inputStream, int maxIterations) Read a public key ring from the providedInputStream
.static org.bouncycastle.openpgp.PGPPublicKeyRingCollection
readPublicKeyRingCollection
(InputStream inputStream) static org.bouncycastle.openpgp.PGPPublicKeyRingCollection
readPublicKeyRingCollection
(InputStream inputStream, int maxIterations) Read a public key ring collection from the providedInputStream
.static org.bouncycastle.openpgp.PGPSecretKeyRing
readSecretKeyRing
(InputStream inputStream) static org.bouncycastle.openpgp.PGPSecretKeyRing
readSecretKeyRing
(InputStream inputStream, int maxIterations) Read a secret key ring from the providedInputStream
.static org.bouncycastle.openpgp.PGPSecretKeyRingCollection
readSecretKeyRingCollection
(InputStream inputStream) static org.bouncycastle.openpgp.PGPSecretKeyRingCollection
readSecretKeyRingCollection
(InputStream inputStream, int maxIterations) Read a secret key ring collection from the providedInputStream
.org.bouncycastle.openpgp.PGPSecretKeyRing
secretKeyRing
(byte[] bytes) org.bouncycastle.openpgp.PGPSecretKeyRing
secretKeyRing
(InputStream inputStream) org.bouncycastle.openpgp.PGPSecretKeyRing
secretKeyRing
(String asciiArmored) org.bouncycastle.openpgp.PGPSecretKeyRingCollection
secretKeyRingCollection
(byte[] bytes) org.bouncycastle.openpgp.PGPSecretKeyRingCollection
secretKeyRingCollection
(InputStream inputStream) org.bouncycastle.openpgp.PGPSecretKeyRingCollection
secretKeyRingCollection
(String asciiArmored)
-
Field Details
-
MAX_ITERATIONS
public static final int MAX_ITERATIONS- See Also:
-
UTF8
-
-
Constructor Details
-
KeyRingReader
public KeyRingReader()
-
-
Method Details
-
keyRing
public org.bouncycastle.openpgp.PGPKeyRing keyRing(@Nonnull InputStream inputStream) throws IOException - Parameters:
inputStream
- inputStream containing the OpenPGP key or certificate- Returns:
- key ring
- Throws:
IOException
- in case of an IO error
-
keyRing
Read aPGPKeyRing
(eitherPGPSecretKeyRing
orPGPPublicKeyRing
) from the given byte array.- Parameters:
bytes
- byte array containing the OpenPGP key or certificate- Returns:
- key ring
- Throws:
IOException
- in case of an IO error
-
keyRing
Read aPGPKeyRing
(eitherPGPSecretKeyRing
orPGPPublicKeyRing
) from the given ASCII armored string.- Parameters:
asciiArmored
- ASCII armored OpenPGP key or certificate- Returns:
- key ring
- Throws:
IOException
- in case of an IO error
-
publicKeyRing
public org.bouncycastle.openpgp.PGPPublicKeyRing publicKeyRing(@Nonnull InputStream inputStream) throws IOException - Throws:
IOException
-
publicKeyRing
public org.bouncycastle.openpgp.PGPPublicKeyRing publicKeyRing(@Nonnull byte[] bytes) throws IOException - Throws:
IOException
-
publicKeyRing
public org.bouncycastle.openpgp.PGPPublicKeyRing publicKeyRing(@Nonnull String asciiArmored) throws IOException - Throws:
IOException
-
publicKeyRingCollection
public org.bouncycastle.openpgp.PGPPublicKeyRingCollection publicKeyRingCollection(@Nonnull InputStream inputStream) throws IOException, org.bouncycastle.openpgp.PGPException - Throws:
IOException
org.bouncycastle.openpgp.PGPException
-
publicKeyRingCollection
public org.bouncycastle.openpgp.PGPPublicKeyRingCollection publicKeyRingCollection(@Nonnull byte[] bytes) throws IOException, org.bouncycastle.openpgp.PGPException - Throws:
IOException
org.bouncycastle.openpgp.PGPException
-
publicKeyRingCollection
public org.bouncycastle.openpgp.PGPPublicKeyRingCollection publicKeyRingCollection(@Nonnull String asciiArmored) throws IOException, org.bouncycastle.openpgp.PGPException - Throws:
IOException
org.bouncycastle.openpgp.PGPException
-
secretKeyRing
public org.bouncycastle.openpgp.PGPSecretKeyRing secretKeyRing(@Nonnull InputStream inputStream) throws IOException - Throws:
IOException
-
secretKeyRing
public org.bouncycastle.openpgp.PGPSecretKeyRing secretKeyRing(@Nonnull byte[] bytes) throws IOException - Throws:
IOException
-
secretKeyRing
public org.bouncycastle.openpgp.PGPSecretKeyRing secretKeyRing(@Nonnull String asciiArmored) throws IOException - Throws:
IOException
-
secretKeyRingCollection
public org.bouncycastle.openpgp.PGPSecretKeyRingCollection secretKeyRingCollection(@Nonnull InputStream inputStream) throws IOException, org.bouncycastle.openpgp.PGPException - Throws:
IOException
org.bouncycastle.openpgp.PGPException
-
secretKeyRingCollection
public org.bouncycastle.openpgp.PGPSecretKeyRingCollection secretKeyRingCollection(@Nonnull byte[] bytes) throws IOException, org.bouncycastle.openpgp.PGPException - Throws:
IOException
org.bouncycastle.openpgp.PGPException
-
secretKeyRingCollection
public org.bouncycastle.openpgp.PGPSecretKeyRingCollection secretKeyRingCollection(@Nonnull String asciiArmored) throws IOException, org.bouncycastle.openpgp.PGPException - Throws:
IOException
org.bouncycastle.openpgp.PGPException
-
keyRingCollection
public PGPKeyRingCollection keyRingCollection(@Nonnull InputStream inputStream, boolean isSilent) throws IOException, org.bouncycastle.openpgp.PGPException - Throws:
IOException
org.bouncycastle.openpgp.PGPException
-
keyRingCollection
public PGPKeyRingCollection keyRingCollection(@Nonnull byte[] bytes, boolean isSilent) throws IOException, org.bouncycastle.openpgp.PGPException - Throws:
IOException
org.bouncycastle.openpgp.PGPException
-
keyRingCollection
public PGPKeyRingCollection keyRingCollection(@Nonnull String asciiArmored, boolean isSilent) throws IOException, org.bouncycastle.openpgp.PGPException - Throws:
IOException
org.bouncycastle.openpgp.PGPException
-
readKeyRing
public static org.bouncycastle.openpgp.PGPKeyRing readKeyRing(@Nonnull InputStream inputStream) throws IOException Read aPGPKeyRing
(eitherPGPSecretKeyRing
orPGPPublicKeyRing
) from the givenInputStream
. This method will attempt to read at mostMAX_ITERATIONS
objects from the stream before aborting. The firstPGPPublicKeyRing
orPGPSecretKeyRing
will be returned.- Parameters:
inputStream
- inputStream containing the OpenPGP key or certificate- Returns:
- key ring
- Throws:
IOException
- in case of an IO error
-
readKeyRing
public static org.bouncycastle.openpgp.PGPKeyRing readKeyRing(@Nonnull InputStream inputStream, int maxIterations) throws IOException Read aPGPKeyRing
(eitherPGPSecretKeyRing
orPGPPublicKeyRing
) from the givenInputStream
. This method will attempt to read at mostmaxIterations
objects from the stream before aborting. The firstPGPPublicKeyRing
orPGPSecretKeyRing
will be returned.- Parameters:
inputStream
- inputStream containing the OpenPGP key or certificatemaxIterations
- maximum number of objects that are read before the method will abort- Returns:
- key ring
- Throws:
IOException
- in case of an IO error
-
readPublicKeyRing
public static org.bouncycastle.openpgp.PGPPublicKeyRing readPublicKeyRing(@Nonnull InputStream inputStream) throws IOException - Throws:
IOException
-
readPublicKeyRing
public static org.bouncycastle.openpgp.PGPPublicKeyRing readPublicKeyRing(@Nonnull InputStream inputStream, int maxIterations) throws IOException Read a public key ring from the providedInputStream
. If more than maxIterations PGP packets are encountered before aPGPPublicKeyRing
is read, anIOException
is thrown.- Parameters:
inputStream
- input streammaxIterations
- max iterations before abort- Returns:
- public key ring
- Throws:
IOException
- in case of an IO error or exceeding of max iterations
-
readPublicKeyRingCollection
public static org.bouncycastle.openpgp.PGPPublicKeyRingCollection readPublicKeyRingCollection(@Nonnull InputStream inputStream) throws IOException, org.bouncycastle.openpgp.PGPException - Throws:
IOException
org.bouncycastle.openpgp.PGPException
-
readPublicKeyRingCollection
public static org.bouncycastle.openpgp.PGPPublicKeyRingCollection readPublicKeyRingCollection(@Nonnull InputStream inputStream, int maxIterations) throws IOException, org.bouncycastle.openpgp.PGPException Read a public key ring collection from the providedInputStream
. If more than maxIterations PGP packets are encountered before the stream is exhausted, anIOException
is thrown.- Parameters:
inputStream
- input streammaxIterations
- max iterations before abort- Returns:
- public key ring collection
- Throws:
IOException
- in case of an IO error or exceeding of max iterationsorg.bouncycastle.openpgp.PGPException
- in case of a broken key
-
readSecretKeyRing
public static org.bouncycastle.openpgp.PGPSecretKeyRing readSecretKeyRing(@Nonnull InputStream inputStream) throws IOException - Throws:
IOException
-
readSecretKeyRing
public static org.bouncycastle.openpgp.PGPSecretKeyRing readSecretKeyRing(@Nonnull InputStream inputStream, int maxIterations) throws IOException Read a secret key ring from the providedInputStream
. If more than maxIterations PGP packets are encountered before aPGPSecretKeyRing
is read, anIOException
is thrown.- Parameters:
inputStream
- input streammaxIterations
- max iterations before abort- Returns:
- public key ring
- Throws:
IOException
- in case of an IO error or exceeding of max iterations
-
readSecretKeyRingCollection
public static org.bouncycastle.openpgp.PGPSecretKeyRingCollection readSecretKeyRingCollection(@Nonnull InputStream inputStream) throws IOException, org.bouncycastle.openpgp.PGPException - Throws:
IOException
org.bouncycastle.openpgp.PGPException
-
readSecretKeyRingCollection
public static org.bouncycastle.openpgp.PGPSecretKeyRingCollection readSecretKeyRingCollection(@Nonnull InputStream inputStream, int maxIterations) throws IOException, org.bouncycastle.openpgp.PGPException Read a secret key ring collection from the providedInputStream
. If more than maxIterations PGP packets are encountered before the stream is exhausted, anIOException
is thrown.- Parameters:
inputStream
- input streammaxIterations
- max iterations before abort- Returns:
- secret key ring collection
- Throws:
IOException
- in case of an IO error or exceeding of max iterationsorg.bouncycastle.openpgp.PGPException
- in case of a broken secret key
-
readKeyRingCollection
public static PGPKeyRingCollection readKeyRingCollection(@Nonnull InputStream inputStream, boolean isSilent) throws IOException, org.bouncycastle.openpgp.PGPException - Throws:
IOException
org.bouncycastle.openpgp.PGPException
-