com.sshtools.publickey.SshPrivateKeyFile Maven / Gradle / Ivy
The newest version!
/**
* Copyright 2003-2016 SSHTOOLS Limited. All Rights Reserved.
*
* For product documentation visit https://www.sshtools.com/
*
* This file is part of J2SSH Maverick.
*
* J2SSH Maverick is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* J2SSH Maverick is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with J2SSH Maverick. If not, see .
*/
package com.sshtools.publickey;
import java.io.IOException;
import com.sshtools.ssh.components.SshKeyPair;
/**
* Interface which all private key formats must implement to provide decoding
* and decryption of the private key into a suitable format for the API.
*
* @author Lee David Painter
*/
public interface SshPrivateKeyFile {
/**
* Determine if the private key file is protected by a passphrase.
*
* @return true if the key file is encrypted with a passphrase,
* otherwise false
* @throws IOException
*/
public boolean isPassphraseProtected();
/**
* Decode the private key using the users passphrase.
*
* @param passphrase
* the users passphrase
* @return the key pair stored in this private key file.
* @throws IOException
* @throws InvalidPassphraseException
*/
public SshKeyPair toKeyPair(String passphrase) throws IOException,
InvalidPassphraseException;
/**
* Method to determine whether the format supports changing of passphrases.
* This typically would indicate that the format is read-only and that keys
* cannot be saved into this format.
*
* @return boolean
*/
public boolean supportsPassphraseChange();
/**
* Get a description of the format type e.g. "OpenSSH"
*
* @return String
*/
public String getType();
/**
* Change the passphrase of the key file.
*
* @param oldpassphrase
* the old passphrase
* @param newpassprase
* the new passphrase
* @throws IOException
* @throws InvalidPassphraseException
*/
public void changePassphrase(String oldpassphrase, String newpassprase)
throws IOException, InvalidPassphraseException;
/**
* Get the formatted key
*
* @return byte[]
* @throws IOException
*/
public byte[] getFormattedKey() throws IOException;
}