public class PGPSignatureGenerator
extends java.lang.Object
| Modifier and Type | Field and Description |
|---|---|
protected byte |
lastb |
protected java.io.OutputStream |
legacyTextSigOut
Verification only: a second stream fed the pre-1.87 canonical text form, in which a bare CR
was hashed as CR LF, or null if no such fallback is wanted.
|
protected boolean |
sawBareCR
Set once the text-mode input has contained a CR not followed by LF, the only input on which
the current and the legacy canonical text forms differ.
|
protected java.io.OutputStream |
sigOut |
protected int |
sigType |
protected int |
version |
| Constructor and Description |
|---|
PGPSignatureGenerator(PGPContentSignerBuilder contentSignerBuilder)
Deprecated.
|
PGPSignatureGenerator(PGPContentSignerBuilder contentSignerBuilder,
PGPPublicKey signingKey)
Create a signature generator built on the passed in contentSignerBuilder.
|
PGPSignatureGenerator(PGPContentSignerBuilder contentSignerBuilder,
PGPPublicKey signingKey,
int signatureVersion) |
| Modifier and Type | Method and Description |
|---|---|
protected void |
blockUpdate(byte[] block,
int off,
int len) |
PGPSignature |
generate()
Return a signature object containing the current signature state.
|
PGPSignature |
generateCertification(PGPPublicKey pubKey)
Generate a certification, such as a revocation, for the passed in key.
|
PGPSignature |
generateCertification(PGPPublicKey masterKey,
PGPPublicKey pubKey)
Generate a certification for the passed in key against the passed in
master key.
|
PGPSignature |
generateCertification(PGPUserAttributeSubpacketVector userAttributes,
PGPPublicKey pubKey)
Generate a certification for the passed in userAttributes
|
PGPSignature |
generateCertification(java.lang.String id,
PGPPublicKey pubKey)
Generate a certification for the passed in id and key.
|
PGPOnePassSignature |
generateOnePassVersion(boolean isNested)
Return the one pass header associated with the current signature.
|
protected void |
getAttributesHash(PGPUserAttributeSubpacketVector userAttributes) |
void |
init(int signatureType,
PGPPrivateKey key)
Initialize the generator for signing.
|
protected static boolean |
isLegacyTextFormAllowed()
Return true if a text signature should also be checked against the pre-1.87 canonical text
form (see
update(byte)). |
protected boolean |
isLegacyTextFormDifferent()
Return true if the text-mode data hashed so far is one the legacy canonical text form
hashes differently - that is, it holds a bare CR, a trailing CR included.
|
protected void |
prepareSignatureSubpackets() |
protected void |
resetTextState()
Reset the text canonicalisation state for a new signature calculation.
|
void |
setHashedSubpackets(PGPSignatureSubpacketVector hashedPcks)
Set the hashed signature subpackets.
|
void |
setUnhashedSubpackets(PGPSignatureSubpacketVector unhashedPcks)
Set the unhashed signature subpackets.
|
void |
update(byte b)
Update the signature with a byte of the signed data.
|
void |
update(byte[] b) |
void |
update(byte[] b,
int off,
int len) |
protected void |
updateWithIdData(int header,
byte[] idBytes) |
protected void |
updateWithPublicKey(PGPPublicKey key) |
protected boolean |
verifyLegacyTextForm(PGPContentVerifier legacyVerifier,
byte[] trailer,
byte[] signature)
Second chance for a text signature that did not verify over the current canonical form:
check it over the legacy form, if a legacy hash was kept and the data is one on which the two
forms differ (on any other data they are the same bytes, so the answer cannot change).
|
protected byte lastb
protected java.io.OutputStream sigOut
protected int sigType
protected final int version
protected java.io.OutputStream legacyTextSigOut
update(byte).protected boolean sawBareCR
public PGPSignatureGenerator(PGPContentSignerBuilder contentSignerBuilder)
PGPSignatureGenerator(PGPContentSignerBuilder, PGPPublicKey) instead.contentSignerBuilder - builder to produce PGPContentSigner objects for generating signatures.public PGPSignatureGenerator(PGPContentSignerBuilder contentSignerBuilder, PGPPublicKey signingKey)
contentSignerBuilder - builder to produce PGPContentSigner objects for generating signaturessigningKey - signing keypublic PGPSignatureGenerator(PGPContentSignerBuilder contentSignerBuilder, PGPPublicKey signingKey, int signatureVersion)
public void init(int signatureType,
PGPPrivateKey key)
throws PGPException
signatureType - type of signaturekey - private signing keyPGPExceptionpublic void setHashedSubpackets(PGPSignatureSubpacketVector hashedPcks)
hashedPcks - hashed signature subpacketspublic void setUnhashedSubpackets(PGPSignatureSubpacketVector unhashedPcks)
unhashedPcks - unhashed signature subpacketspublic PGPOnePassSignature generateOnePassVersion(boolean isNested) throws PGPException
isNested - true if the signature is nested, false otherwise.PGPExceptionpublic PGPSignature generate() throws PGPException
PGPExceptionprotected void prepareSignatureSubpackets()
throws PGPException
PGPExceptionpublic PGPSignature generateCertification(java.lang.String id, PGPPublicKey pubKey) throws PGPException
id - the id we are certifying against the public key.pubKey - the key we are certifying against the id.PGPExceptionpublic PGPSignature generateCertification(PGPUserAttributeSubpacketVector userAttributes, PGPPublicKey pubKey) throws PGPException
userAttributes - the id we are certifying against the public key.pubKey - the key we are certifying against the id.PGPExceptionpublic PGPSignature generateCertification(PGPPublicKey masterKey, PGPPublicKey pubKey) throws PGPException
masterKey - the key we are certifying against.pubKey - the key we are certifying.PGPExceptionpublic PGPSignature generateCertification(PGPPublicKey pubKey) throws PGPException
pubKey - the key we are certifying.PGPExceptionprotected void resetTextState()
public void update(byte b)
For a text signature (type 0x01) the data is hashed in canonical text form, as RFC 9580
sec. 5.2.1.2 describes: a LF not preceded by a CR is hashed as CR LF, and every other byte,
a CR not followed by a LF included, is hashed unaltered. A bare CR is therefore not a line
ending, which is what GnuPG, GopenPGP, OpenPGP.js, rpgpie, RNP and PGPy do (github #2553).
Releases before 1.87 hashed a bare CR as CR LF; when verifying, that form is also accepted
unless Properties.OPENPGP_TEXT_SIG_ALLOW_LEGACY_CR is set to
false.
protected boolean isLegacyTextFormDifferent()
protected static boolean isLegacyTextFormAllowed()
update(byte)).protected boolean verifyLegacyTextForm(PGPContentVerifier legacyVerifier, byte[] trailer, byte[] signature) throws PGPException
PGPExceptionpublic void update(byte[] b)
public void update(byte[] b,
int off,
int len)
protected void blockUpdate(byte[] block,
int off,
int len)
protected void updateWithIdData(int header,
byte[] idBytes)
protected void updateWithPublicKey(PGPPublicKey key) throws PGPException
PGPExceptionprotected void getAttributesHash(PGPUserAttributeSubpacketVector userAttributes) throws PGPException
PGPException