SignaturePrivateKey

java.lang.Object
- com.google.crypto.tink.Key
- - com.google.crypto.tink.signature.SignaturePrivateKey

All Implemented Interfaces:

PrivateKey

Direct Known Subclasses:

EcdsaPrivateKey, Ed25519PrivateKey, RsaSsaPkcs1PrivateKey, RsaSsaPssPrivateKey
```
@Immutable
public abstract class SignaturePrivateKey
extends Key
implements PrivateKey
```
A SignaturePrivateKey represents a digital signature primitive, which consists of a sign and a verify function.
The verify function is only available indirectly, with getPublicKey().

Constructor Summary

Constructors
Constructor Description

SignaturePrivateKey()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.Integer`	`getIdRequirementOrNull()`	Returns null if this key has no id requirement, otherwise the required id.
`Bytes`	`getOutputPrefix()`	Returns a `Bytes` instance which is prefixed to every signature.
`SignatureParameters`	`getParameters()`	Returns the parameters of this key.
`abstract SignaturePublicKey`	`getPublicKey()`	Returns the `SignaturePublicKey`, which contains the verify function of the digital signature primitive.

Methods inherited from class com.google.crypto.tink.Key
equalsKey

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SignaturePrivateKey
```
public SignaturePrivateKey()
```
- Method Detail
  - getPublicKey
```
public abstract SignaturePublicKey getPublicKey()
```
    Returns the SignaturePublicKey, which contains the verify function of the digital signature primitive.
    
    Specified by:
    
    getPublicKey in interface PrivateKey
  - getOutputPrefix
```
public final Bytes getOutputPrefix()
```
    Returns a Bytes instance which is prefixed to every signature.
    Returns the same as getPublicKey().getOutputPrefix().
  - getIdRequirementOrNull
```
@Nullable
public java.lang.Integer getIdRequirementOrNull()
```
    Description copied from class: Key
    
    Returns null if this key has no id requirement, otherwise the required id.
    Some keys, when they are in a keyset, are required to have a certain ID to work properly. This comes from the fact that Tink in some cases prefixes ciphertexts or signatures with the string 0x01<id>, where the ID is encoded in big endian (see the documentation of the key type for details), in which case the key requires a certain ID.
    
    Specified by:
    
    getIdRequirementOrNull in class Key
  - getParameters
```
public SignatureParameters getParameters()
```
    Returns the parameters of this key.
    Returns the same as getPublicKey().getParameters().
    
    Specified by:
    
    getParameters in class Key