org.apache.sshd.common.signature

Interface Signature

All Superinterfaces:

AlgorithmNameProvider

All Known Implementing Classes:

AbstractSecurityKeySignature, AbstractSignature, SignatureDSA, SignatureECDSA, SignatureECDSA.SignatureECDSA256, SignatureECDSA.SignatureECDSA384, SignatureECDSA.SignatureECDSA521, SignatureEd25519, SignatureRSA, SignatureRSASHA1, SignatureRSASHA256, SignatureRSASHA512, SignatureSkECDSA, SignatureSkED25519

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(SessionContext session, java.security.PrivateKey key)
void	initVerifier(SessionContext session, java.security.PublicKey key)
byte[]	sign(SessionContext session) Compute the signature
default void	update(SessionContext session, byte[] hash) Update the computed signature with the given data
void	update(SessionContext session, byte[] hash, int off, int len) Update the computed signature with the given data
boolean	verify(SessionContext session, byte[] sig) Verify against the given signature

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

getAlgorithm

Method Detail

initVerifier

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

Parameters:

session - The SessionContext for calling this method - may be null if not called within a session context

key - The PublicKey to be used for verifying signatures

Throws:

java.lang.Exception - If failed to initialize

initSigner

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

Parameters:

session - The SessionContext for calling this method - may be null if not called within a session context

key - The PrivateKey to be used for signing

Throws:

java.lang.Exception - If failed to initialize

update

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

Update the computed signature with the given data

Parameters:

session - The SessionContext for calling this method - may be null if not called within a session context

hash - The hash data buffer

Throws:

java.lang.Exception - If failed to update

See Also:

update(SessionContext, byte[], int, int)

update

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

Update the computed signature with the given data

Parameters:

session - The SessionContext for calling this method - may be null if not called within a session context

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(SessionContext session,
               byte[] sig)
        throws java.lang.Exception

Verify against the given signature

Parameters:

session - The SessionContext for calling this method - may be null if not called within a session context

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(SessionContext session)
     throws java.lang.Exception

Compute the signature

Parameters:

session - The SessionContext for calling this method - may be null if not called within a session context

Returns:

The signature value

Throws:

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