org.apache.sshd.common.signature

Interface Signature

All Superinterfaces:

AlgorithmNameProvider

All Known Implementing Classes:

AbstractSignature, SignatureDSA, SignatureECDSA, SignatureECDSA.SignatureECDSA256, SignatureECDSA.SignatureECDSA384, SignatureECDSA.SignatureECDSA521, SignatureEd25519, SignatureRSA

public interface Signature
extends AlgorithmNameProvider

Signature interface for SSH used to sign or verify packets. Usually wraps a javax.crypto.Signature object. The reported algorithm name refers to the signature type being applied.

Method Summary

Modifier and Type	Method and Description
void	initSigner(java.security.PrivateKey key)
void	initVerifier(java.security.PublicKey key)
byte[]	sign() Compute the signature
default void	update(byte[] hash) Update the computed signature with the given data
void	update(byte[] hash, int off, int len) Update the computed signature with the given data
boolean	verify(byte[] sig) Verify against the given signature

Methods inherited from interface org.apache.sshd.common.AlgorithmNameProvider

getAlgorithm

Method Detail

initVerifier

void initVerifier(java.security.PublicKey key)
           throws java.lang.Exception

Parameters:

key - The PublicKey to be used for verifying signatures

Throws:

java.lang.Exception - If failed to initialize

initSigner

void initSigner(java.security.PrivateKey key)
         throws java.lang.Exception

Parameters:

key - The PrivateKey to be used for signing

Throws:

java.lang.Exception - If failed to initialize

update

default void update(byte[] hash)
             throws java.lang.Exception

Update the computed signature with the given data

Parameters:

hash - The hash data buffer

Throws:

java.lang.Exception - If failed to update

See Also:

update(byte[], int, int)

update

void update(byte[] hash,
            int off,
            int len)
     throws java.lang.Exception

Update the computed signature with the given data

Parameters:

hash - The hash data buffer

off - Offset of hash data in buffer

len - Length of hash data

Throws:

java.lang.Exception - If failed to update

verify

boolean verify(byte[] sig)
        throws java.lang.Exception

Verify against the given signature

Parameters:

sig - The signed data

Returns:

true if signature is valid

Throws:

java.lang.Exception - If failed to extract signed data for validation

sign

byte[] sign()
     throws java.lang.Exception

Compute the signature

Returns:

The signature value

Throws:

java.lang.Exception - If failed to calculate the signature