SshtoolsPrivateKeyFormat (J2SSH Javadocs)

java.lang.Object
- com.sshtools.j2ssh.transport.publickey.Base64EncodedFileFormat
- - com.sshtools.j2ssh.transport.publickey.SshtoolsPrivateKeyFormat

All Implemented Interfaces:

SshKeyFormatConversion, SshPrivateKeyFormat
```
public class SshtoolsPrivateKeyFormat
extends Base64EncodedFileFormat
implements SshPrivateKeyFormat
```
Version:

$Revision: 1.22 $

Author:

$author$

Field Summary
- Fields inherited from class com.sshtools.j2ssh.transport.publickey.Base64EncodedFileFormat
  begin, end

Constructor Summary

Constructors
Constructor and Description
`SshtoolsPrivateKeyFormat()` Creates a new SshtoolsPrivateKeyFormat object.
`SshtoolsPrivateKeyFormat(java.lang.String subject, java.lang.String comment)` Creates a new SshtoolsPrivateKeyFormat object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`byte[]`	`decryptKeyblob(byte[] formattedKey, java.lang.String passphrase)`
`byte[]`	`encryptKeyblob(byte[] keyblob, java.lang.String passphrase)`
`java.lang.String`	`getFormatType()`
`boolean`	`isPassphraseProtected(byte[] formattedKey)`
`boolean`	`supportsAlgorithm(java.lang.String algorithm)`

Methods inherited from class com.sshtools.j2ssh.transport.publickey.Base64EncodedFileFormat
formatKey, getHeaderValue, getKeyBlob, isFormatted, setHeaderValue

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.sshtools.j2ssh.transport.publickey.SshPrivateKeyFormat
isFormatted

- Constructor Detail
  - SshtoolsPrivateKeyFormat
```
public SshtoolsPrivateKeyFormat(java.lang.String subject,
                                java.lang.String comment)
```
    Creates a new SshtoolsPrivateKeyFormat object.
    
    Parameters:
    
    subject -
    
    comment -
  - SshtoolsPrivateKeyFormat
```
public SshtoolsPrivateKeyFormat()
```
    Creates a new SshtoolsPrivateKeyFormat object.
- Method Detail
  - getFormatType
```
public java.lang.String getFormatType()
```
    Specified by:
    
    getFormatType in interface SshKeyFormatConversion
    
    Specified by:
    
    getFormatType in interface SshPrivateKeyFormat
    
    Overrides:
    
    getFormatType in class Base64EncodedFileFormat
    
    Returns:
  - isPassphraseProtected
```
public boolean isPassphraseProtected(byte[] formattedKey)
```
    Specified by:
    
    isPassphraseProtected in interface SshPrivateKeyFormat
    
    Parameters:
    
    formattedKey -
    
    Returns:
  - decryptKeyblob
```
public byte[] decryptKeyblob(byte[] formattedKey,
                             java.lang.String passphrase)
                      throws InvalidSshKeyException
```
    Specified by:
    
    decryptKeyblob in interface SshPrivateKeyFormat
    
    Parameters:
    
    formattedKey -
    
    passphrase -
    
    Returns:
    
    Throws:
    
    InvalidSshKeyException
  - encryptKeyblob
```
public byte[] encryptKeyblob(byte[] keyblob,
                             java.lang.String passphrase)
```
    Specified by:
    
    encryptKeyblob in interface SshPrivateKeyFormat
    
    Parameters:
    
    keyblob -
    
    passphrase -
    
    Returns:
  - supportsAlgorithm
```
public boolean supportsAlgorithm(java.lang.String algorithm)
```
    Specified by:
    
    supportsAlgorithm in interface SshPrivateKeyFormat
    
    Parameters:
    
    algorithm -
    
    Returns:

Class SshtoolsPrivateKeyFormat

Field Summary

Fields inherited from class com.sshtools.j2ssh.transport.publickey.Base64EncodedFileFormat

Constructor Summary

Method Summary

Methods inherited from class com.sshtools.j2ssh.transport.publickey.Base64EncodedFileFormat

Methods inherited from class java.lang.Object

Methods inherited from interface com.sshtools.j2ssh.transport.publickey.SshPrivateKeyFormat

Constructor Detail

SshtoolsPrivateKeyFormat

SshtoolsPrivateKeyFormat

Method Detail

getFormatType

isPassphraseProtected

decryptKeyblob

encryptKeyblob

supportsAlgorithm