Interface KeyEntryResolver

All Superinterfaces:

KeyTypeNamesSupport

All Known Subinterfaces:

PrivateKeyEntryDecoder, PublicKeyEntryDecoder

All Known Implementing Classes:

AbstractKeyEntryResolver, AbstractPrivateKeyEntryDecoder, AbstractPublicKeyEntryDecoder, DSSPublicKeyEntryDecoder, ECDSAPublicKeyEntryDecoder, Ed25519PublicKeyDecoder, OpenSSHCertificateDecoder, OpenSSHDSSPrivateKeyEntryDecoder, OpenSSHECDSAPrivateKeyEntryDecoder, OpenSSHEd25519PrivateKeyEntryDecoder, OpenSSHRSAPrivateKeyDecoder, RSAPublicKeyDecoder, SkECDSAPublicKeyEntryDecoder, SkED25519PublicKeyEntryDecoder

public interface KeyEntryResolver
extends KeyTypeNamesSupport

Author:

Apache MINA SSHD Project

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_BIGINT_OCTETS_COUNT	A reasonable max. number of octets used for a BigInteger in the context of keys based on such numbers

Method Summary

Modifier and Type	Method	Description
static BigInteger	decodeBigInt(InputStream s)
static int	decodeInt(byte[] buf)
static int	decodeInt(byte[] buf, int offset, int available)
static int	decodeInt(InputStream s)
static Map.Entry<String,Integer>	decodeString(byte[] buf, int maxChars)
static Map.Entry<String,Integer>	decodeString(byte[] buf, int offset, int available, int maxChars)
static Map.Entry<String,Integer>	decodeString(byte[] buf, int offset, int available, Charset cs, int maxChars)	Decodes a run-length encoded string
static Map.Entry<String,Integer>	decodeString(byte[] buf, Charset cs, int maxChars)
static String	decodeString(InputStream s, int maxChars)
static String	decodeString(InputStream s, String charset, int maxChars)
static String	decodeString(InputStream s, Charset cs, int maxChars)
static int	encodeBigInt(OutputStream s, BigInteger v)
static byte[]	encodeInt(OutputStream s, int v)
static int	encodeString(OutputStream s, String v)
static int	encodeString(OutputStream s, String v, String charset)
static int	encodeString(OutputStream s, String v, Charset cs)
default KeyPair	generateKeyPair(int keySize)
KeyFactory	getKeyFactoryInstance()
KeyPairGenerator	getKeyPairGenerator()
static Map.Entry<byte[],Integer>	readRLEBytes(byte[] buf, int maxAllowed)
static Map.Entry<byte[],Integer>	readRLEBytes(byte[] buf, int offset, int available, int maxAllowed)	Decodes a run-length encoded byte array
static byte[]	readRLEBytes(InputStream s, int maxAllowed)
static int	writeRLEBytes(OutputStream s, byte... bytes)
static int	writeRLEBytes(OutputStream s, byte[] bytes, int off, int len)

Methods inherited from interface KeyTypeNamesSupport

getSupportedKeyTypes

Field Details

MAX_BIGINT_OCTETS_COUNT

static final int MAX_BIGINT_OCTETS_COUNT

A reasonable max. number of octets used for a BigInteger in the context of keys based on such numbers

See Also:

• Constant Field Values

Method Details

generateKeyPair

default KeyPair generateKeyPair(int keySize)
                         throws GeneralSecurityException

Parameters:

keySize - Key size in bits

Returns:

A KeyPair with the specified key size

Throws:

GeneralSecurityException - if unable to generate the pair

getKeyPairGenerator

KeyPairGenerator getKeyPairGenerator()
                              throws GeneralSecurityException

Returns:

A KeyPairGenerator suitable for this decoder

Throws:

GeneralSecurityException - If failed to create the generator

getKeyFactoryInstance

KeyFactory getKeyFactoryInstance()
                          throws GeneralSecurityException

Returns:

A KeyFactory suitable for the specific decoder type

Throws:

GeneralSecurityException - If failed to create one

encodeString

static int encodeString(OutputStream s,
 String v)
                 throws IOException

Throws:

IOException

encodeString

static int encodeString(OutputStream s,
 String v,
 String charset)
                 throws IOException

Throws:

IOException

encodeString

static int encodeString(OutputStream s,
 String v,
 Charset cs)
                 throws IOException

Throws:

IOException

encodeBigInt

static int encodeBigInt(OutputStream s,
 BigInteger v)
                 throws IOException

Throws:

IOException

writeRLEBytes

static int writeRLEBytes(OutputStream s,
 byte... bytes)
                  throws IOException

Throws:

IOException

writeRLEBytes

static int writeRLEBytes(OutputStream s,
 byte[] bytes,
 int off,
 int len)
                  throws IOException

Throws:

IOException

encodeInt

static byte[] encodeInt(OutputStream s,
 int v)
                 throws IOException

Throws:

IOException

decodeString

static String decodeString(InputStream s,
 int maxChars)
                    throws IOException

Throws:

IOException

decodeString

static String decodeString(InputStream s,
 String charset,
 int maxChars)
                    throws IOException

Throws:

IOException

decodeString

static String decodeString(InputStream s,
 Charset cs,
 int maxChars)
                    throws IOException

Throws:

IOException

decodeBigInt

static BigInteger decodeBigInt(InputStream s)
                        throws IOException

Throws:

IOException

readRLEBytes

static byte[] readRLEBytes(InputStream s,
 int maxAllowed)
                    throws IOException

Throws:

IOException

decodeInt

static int decodeInt(InputStream s)
              throws IOException

Throws:

IOException

decodeString

static Map.Entry<String,Integer> decodeString(byte[] buf,
 int maxChars)

decodeString

static Map.Entry<String,Integer> decodeString(byte[] buf,
 int offset,
 int available,
 int maxChars)

decodeString

static Map.Entry<String,Integer> decodeString(byte[] buf,
 Charset cs,
 int maxChars)

decodeString

static Map.Entry<String,Integer> decodeString(byte[] buf,
 int offset,
 int available,
 Charset cs,
 int maxChars)

Decodes a run-length encoded string

Parameters:

buf - The buffer with the data bytes

offset - The offset in the buffer to decode the string

available - The max. available data starting from the offset

cs - The Charset to use to decode the string

maxChars - Max. allowed characters in string - if more than that is encoded then an IndexOutOfBoundsException will be thrown

Returns:

The decoded string + the offset of the next byte after it

See Also:

• readRLEBytes(byte[], int, int, int)

readRLEBytes

static Map.Entry<byte[],Integer> readRLEBytes(byte[] buf,
 int maxAllowed)

readRLEBytes

static Map.Entry<byte[],Integer> readRLEBytes(byte[] buf,
 int offset,
 int available,
 int maxAllowed)

Decodes a run-length encoded byte array

Parameters:

buf - The buffer with the data bytes

offset - The offset in the buffer to decode the array

available - The max. available data starting from the offset

maxAllowed - Max. allowed data in decoded buffer - if more than that is encoded then an IndexOutOfBoundsException will be thrown

Returns:

The decoded data buffer + the offset of the next byte after it

decodeInt

static int decodeInt(byte[] buf)

decodeInt

static int decodeInt(byte[] buf,
 int offset,
 int available)