com.sshtools.ssh.components.SshPublicKey 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.ssh.components;
import com.sshtools.ssh.SshException;
/**
*
* Interface for SSH supported public keys.
*
*
* @author Lee David Painter
*/
public interface SshPublicKey {
/**
* Initialize the public key from a blob of binary data.
*
* @param blob
* @param start
* @param len
* @throws SshException
*/
public void init(byte[] blob, int start, int len) throws SshException;
/**
* Get the algorithm name for the public key.
*
* @return the algorithm name, for example "ssh-dss"
*/
public String getAlgorithm();
/**
* Get the bit length of the public key
*
* @return the bit length of the public key
*/
public int getBitLength();
/**
* Encode the public key into a blob of binary data, the encoded result will
* be passed into init to recreate the key.
*
* @return an encoded byte array
* @throws SshException
*/
public byte[] getEncoded() throws SshException;
/**
* Return an SSH fingerprint of the public key
*
* @return String
* @throws SshException
*/
public String getFingerprint() throws SshException;
/**
* Verify the signature.
*
* @param signature
* @param data
* @return true
if the signature was produced by the
* corresponding private key that owns this public key, otherwise
* false
.
* @throws SshException
*/
public boolean verifySignature(byte[] signature, byte[] data)
throws SshException;
}