uk.ac.ed.epcc.webapp.ssh

Class PublicKeyReaderUtil

java.lang.Object

uk.ac.ed.epcc.webapp.ssh.PublicKeyReaderUtil

public final class PublicKeyReaderUtil
extends java.lang.Object

The class is a utility class to read OpenSSH or SECSH encoded public key texts.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PublicKeyReaderUtil.PublicKeyParseException The Exception is throws if the public key encoded text could not be parsed.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SSH2_DSA_KEY Key name of the type of public key for DSA algorithm.
static java.lang.String	SSH2_RSA_KEY Key name of the type of public key for RSA algorithm.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	extractOpenSSHBase64(java.lang.String _key) Extracts from the OpenSSH public key format the base64 encoded SSH public key.
static java.lang.String	format(java.security.PublicKey key) format a key (of the types supported by the load(String) method.
static java.security.PublicKey	load(java.lang.String _key) Decodes given public _key text and returns the related public key instance.
static java.lang.String	normalise(java.lang.String key)
static void	packDSAkey(java.security.interfaces.DSAPublicKey pub, uk.ac.ed.epcc.webapp.ssh.PublicKeyReaderUtil.SSH2ByteBuffer buf)
static void	packDSAKeyParams(java.security.interfaces.DSAPublicKey pub, uk.ac.ed.epcc.webapp.ssh.PublicKeyReaderUtil.SSH2ByteBuffer buf)
static void	packRSAkey(java.security.interfaces.RSAPublicKey pub, uk.ac.ed.epcc.webapp.ssh.PublicKeyReaderUtil.SSH2ByteBuffer buf)
static void	packRSAKeyParams(java.security.interfaces.RSAPublicKey pub, uk.ac.ed.epcc.webapp.ssh.PublicKeyReaderUtil.SSH2ByteBuffer buf)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SSH2_DSA_KEY

public static final java.lang.String SSH2_DSA_KEY

Key name of the type of public key for DSA algorithm.

See Also:

load(String), Constant Field Values

SSH2_RSA_KEY

public static final java.lang.String SSH2_RSA_KEY

Key name of the type of public key for RSA algorithm.

See Also:

load(String), Constant Field Values

Method Detail

load

public static java.security.PublicKey load(java.lang.String _key)
                                    throws PublicKeyReaderUtil.PublicKeyParseException

Decodes given public _key text and returns the related public key instance.

Parameters:

_key - text key of the encoded public key

Returns:

decoded public key

Throws:

PublicKeyReaderUtil.PublicKeyParseException - if the public key could not be parsed from _key

See Also:

PublicKeyReaderUtil.PublicKeyParseException.ErrorCode.UNKNOWN_PUBLIC_KEY_FILE_FORMAT, PublicKeyReaderUtil.PublicKeyParseException.ErrorCode.UNKNOWN_PUBLIC_KEY_CERTIFICATE_FORMAT

format

public static java.lang.String format(java.security.PublicKey key)
                               throws PublicKeyReaderUtil.PublicKeyParseException,
                                      java.io.IOException

format a key (of the types supported by the load(String) method.

Parameters:

key -

Returns:

public key string

Throws:

PublicKeyReaderUtil.PublicKeyParseException

java.io.IOException

packDSAkey

public static void packDSAkey(java.security.interfaces.DSAPublicKey pub,
                              uk.ac.ed.epcc.webapp.ssh.PublicKeyReaderUtil.SSH2ByteBuffer buf)
                       throws java.io.IOException

Parameters:

pub -

buf -

Throws:

java.io.IOException

packDSAKeyParams

public static void packDSAKeyParams(java.security.interfaces.DSAPublicKey pub,
                                    uk.ac.ed.epcc.webapp.ssh.PublicKeyReaderUtil.SSH2ByteBuffer buf)
                             throws java.io.IOException

Parameters:

pub -

buf -

Throws:

java.io.IOException

packRSAkey

public static void packRSAkey(java.security.interfaces.RSAPublicKey pub,
                              uk.ac.ed.epcc.webapp.ssh.PublicKeyReaderUtil.SSH2ByteBuffer buf)
                       throws java.io.IOException

Parameters:

pub -

buf -

Throws:

java.io.IOException

packRSAKeyParams

public static void packRSAKeyParams(java.security.interfaces.RSAPublicKey pub,
                                    uk.ac.ed.epcc.webapp.ssh.PublicKeyReaderUtil.SSH2ByteBuffer buf)
                             throws java.io.IOException

Parameters:

pub -

buf -

Throws:

java.io.IOException

normalise

public static java.lang.String normalise(java.lang.String key)
                                  throws PublicKeyReaderUtil.PublicKeyParseException,
                                         java.io.IOException

Throws:

PublicKeyReaderUtil.PublicKeyParseException

java.io.IOException

extractOpenSSHBase64

public static java.lang.String extractOpenSSHBase64(java.lang.String _key)
                                             throws PublicKeyReaderUtil.PublicKeyParseException

Extracts from the OpenSSH public key format the base64 encoded SSH public key.

An example of such a definition is:
ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAIEA1on8gxCGJJWSRT4uOrR130....

Parameters:

_key - text of the public key defined in the OpenSSH format

Returns:

base64 encoded public-key data

Throws:

PublicKeyReaderUtil.PublicKeyParseException - if the OpenSSH public key string is corrupt

See Also:

PublicKeyReaderUtil.PublicKeyParseException.ErrorCode.CORRUPT_OPENSSH_PUBLIC_KEY_STRING, OpenSSH