KeySigned (velocity-api 3.2.0-SNAPSHOT API)

All Known Subinterfaces:

IdentifiedKey, SignedMessage
```
public interface KeySigned
```
Represents the signature of a signed object.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`Instant`	`getExpiryTemporal()`	Returns the expiry time point of the key.
`default byte[]`	`getSalt()`	Returns the signature salt or null if not salted.
`@org.checkerframework.checker.nullness.qual.Nullable byte[]`	`getSignature()`	Retrieves the signature of the signed object.
`PublicKey`	`getSigner()`	Returns the key used to sign the object.
`default boolean`	`hasExpired()`	Check if the signature has expired.
`default boolean`	`isSignatureValid()`	Validates the signature, expiry temporal and key against the signer public key.

- Method Detail
  - getSigner
```
PublicKey getSigner()
```
    Returns the key used to sign the object.
    
    Returns:
    
    the key
  - getExpiryTemporal
```
Instant getExpiryTemporal()
```
    Returns the expiry time point of the key. Note: this limit is arbitrary. RSA keys don't expire, but the signature of this key as provided by the session server will expire.
    
    Returns:
    
    the expiry time point
  - hasExpired
```
default boolean hasExpired()
```
    Check if the signature has expired.
    
    Returns:
    
    true if proxy time is after expiry time
  - getSignature
```
@org.checkerframework.checker.nullness.qual.Nullable byte[] getSignature()
```
    Retrieves the signature of the signed object.
    
    Returns:
    
    an RSA signature
  - isSignatureValid
```
@Beta
default boolean isSignatureValid()
```
    Validates the signature, expiry temporal and key against the signer public key. Note: This will **not** check for expiry. You can check for expiry with hasExpired().
    DOES NOT WORK YET FOR MESSAGES AND COMMANDS!
    Addendum: Does not work for 1.19.1 until the user has authenticated.
    
    Returns:
    
    validity of the signature
  - getSalt
```
default byte[] getSalt()
```
    Returns the signature salt or null if not salted.
    
    Returns:
    
    signature salt or null