Bouncy Castle Cryptography Library 1.80 · org.bouncycastle.openpgp.PGPSignatureGenerator

Modifier and Type	Field and Description
private PGPContentSigner	contentSigner
private PGPContentSignerBuilder	contentSignerBuilder
private SignatureSubpacket[]	hashed
private int	providedKeyAlgorithm
private byte[]	salt
private PGPPublicKey	signingPubKey
private SignatureSubpacket[]	unhashed

Constructor Summary

Access	Constructor and Description
public	PGPSignatureGenerator(PGPContentSignerBuilder builder to produce PGPContentSigner objects for generating signatures. contentSignerBuilder) Deprecated use `PGPSignatureGenerator(PGPContentSignerBuilder, PGPPublicKey)` instead. Create a version 4 signature generator built on the passed in contentSignerBuilder.
pack-priv	PGPSignatureGenerator(PGPContentSignerBuilder builder to produce PGPContentSigner objects for generating signatures. contentSignerBuilder, int signature version version) Create a signature generator built on the passed in contentSignerBuilder.
public	PGPSignatureGenerator(PGPContentSignerBuilder builder to produce PGPContentSigner objects for generating signatures contentSignerBuilder, PGPPublicKey signing key signingKey) Create a signature generator built on the passed in contentSignerBuilder.
public	PGPSignatureGenerator(PGPContentSignerBuilder contentSignerBuilder, PGPPublicKey signingKey, int signatureVersion)

Method Summary

Modifier and Type	Method and Description
public PGPSignature	Returns: PGPSignature generate() Return a signature object containing the current signature state.
public PGPSignature	Returns: the certification. generateCertification(String the id we are certifying against the public key. id, PGPPublicKey the key we are certifying against the id. pubKey) Generate a certification for the passed in id and key.
public PGPSignature	Returns: the certification. generateCertification(PGPUserAttributeSubpacketVector the id we are certifying against the public key. userAttributes, PGPPublicKey the key we are certifying against the id. pubKey) Generate a certification for the passed in userAttributes
public PGPSignature	Returns: the certification. generateCertification(PGPPublicKey the key we are certifying against. masterKey, PGPPublicKey the key we are certifying. pubKey) Generate a certification for the passed in key against the passed in master key.
public PGPSignature	Returns: the certification. generateCertification(PGPPublicKey the key we are certifying. pubKey) Generate a certification, such as a revocation, for the passed in key.
public PGPOnePassSignature	Returns: PGPOnePassSignature generateOnePassVersion(boolean true if the signature is nested, false otherwise. isNested) Return the one pass header associated with the current signature.
public void	init(int type of signature signatureType, PGPPrivateKey private signing key key) Initialise the generator for signing.
private SignatureSubpacket[]	insertSubpacket(SignatureSubpacket[] packets, SignatureSubpacket subpacket)
private boolean	packetNotPresent(SignatureSubpacket[] packets, int type)
protected void	prepareSignatureSubpackets()
public void	setHashedSubpackets(PGPSignatureSubpacketVector hashed signature subpackets hashedPcks) Set the hashed signature subpackets.
public void	setUnhashedSubpackets(PGPSignatureSubpacketVector unhashed signature subpackets unhashedPcks) Set the unhashed signature subpackets.
private OnePassSignaturePacket	v3OPSPacket(boolean isNested)
private OnePassSignaturePacket	v6OPSPacket(boolean isNested)

Inherited from org.bouncycastle.openpgp.PGPDefaultSignatureGenerator:: blockUpdate getAttributesHash update update update updateWithIdData updateWithPublicKey

Field Detail

contentSigner	back to summary
private PGPContentSigner contentSigner

contentSignerBuilder	back to summary
private PGPContentSignerBuilder contentSignerBuilder

hashed	back to summary
private SignatureSubpacket[] hashed

providedKeyAlgorithm	back to summary
private int providedKeyAlgorithm

salt	back to summary
private byte[] salt

signingPubKey	back to summary
private PGPPublicKey signingPubKey

unhashed	back to summary
private SignatureSubpacket[] unhashed

Constructor Detail

PGPSignatureGenerator back to summary

PGPSignatureGenerator	back to summary
public PGPSignatureGenerator(PGPContentSignerBuilder contentSignerBuilder) Deprecated use `PGPSignatureGenerator(PGPContentSignerBuilder, PGPPublicKey)` instead. Create a version 4 signature generator built on the passed in contentSignerBuilder. Parameters contentSignerBuilder:PGPContentSignerBuilder builder to produce PGPContentSigner objects for generating signatures.

public PGPSignatureGenerator(PGPContentSignerBuilder contentSignerBuilder)

Deprecated

use PGPSignatureGenerator(PGPContentSignerBuilder, PGPPublicKey) instead.

Create a version 4 signature generator built on the passed in contentSignerBuilder.

Parameters

contentSignerBuilder:PGPContentSignerBuilder: builder to produce PGPContentSigner objects for generating signatures.

PGPSignatureGenerator	back to summary
pack-priv PGPSignatureGenerator(PGPContentSignerBuilder contentSignerBuilder, int version) Create a signature generator built on the passed in contentSignerBuilder. Parameters contentSignerBuilder:PGPContentSignerBuilder builder to produce PGPContentSigner objects for generating signatures. version:int signature version

PGPSignatureGenerator

back to summary

pack-priv PGPSignatureGenerator(PGPContentSignerBuilder contentSignerBuilder, int version)

Create a signature generator built on the passed in contentSignerBuilder.

Parameters

contentSignerBuilder:PGPContentSignerBuilder: builder to produce PGPContentSigner objects for generating signatures.
version:int: signature version

PGPSignatureGenerator	back to summary
public PGPSignatureGenerator(PGPContentSignerBuilder contentSignerBuilder, PGPPublicKey signingKey) Create a signature generator built on the passed in contentSignerBuilder. The produces signature version will match the version of the passed in signing key. Parameters contentSignerBuilder:PGPContentSignerBuilder builder to produce PGPContentSigner objects for generating signatures signingKey:PGPPublicKey signing key

PGPSignatureGenerator

back to summary

public PGPSignatureGenerator(PGPContentSignerBuilder contentSignerBuilder, PGPPublicKey signingKey)

Create a signature generator built on the passed in contentSignerBuilder. The produces signature version will match the version of the passed in signing key.

Parameters

contentSignerBuilder:PGPContentSignerBuilder: builder to produce PGPContentSigner objects for generating signatures
signingKey:PGPPublicKey: signing key

PGPSignatureGenerator	back to summary
public PGPSignatureGenerator(PGPContentSignerBuilder contentSignerBuilder, PGPPublicKey signingKey, int signatureVersion)

Method Detail

generate	back to summary
public PGPSignature generate() throws PGPException Return a signature object containing the current signature state. Returns:PGPSignature PGPSignature

generate

back to summary

public PGPSignature generate() throws PGPException

Return a signature object containing the current signature state.

Returns:PGPSignature: PGPSignature

generateCertification	back to summary
public PGPSignature generateCertification(String id, PGPPublicKey pubKey) throws PGPException Generate a certification for the passed in id and key. Parameters id:String the id we are certifying against the public key. pubKey:PGPPublicKey the key we are certifying against the id. Returns:PGPSignature the certification.

generateCertification

back to summary

public PGPSignature generateCertification(String id, PGPPublicKey pubKey) throws PGPException

Generate a certification for the passed in id and key.

Parameters

id:String: the id we are certifying against the public key.
pubKey:PGPPublicKey: the key we are certifying against the id.

Returns:PGPSignature

the certification.

generateCertification	back to summary
public PGPSignature generateCertification(PGPUserAttributeSubpacketVector userAttributes, PGPPublicKey pubKey) throws PGPException Generate a certification for the passed in userAttributes Parameters userAttributes:PGPUserAttributeSubpacketVector the id we are certifying against the public key. pubKey:PGPPublicKey the key we are certifying against the id. Returns:PGPSignature the certification.

generateCertification

back to summary

public PGPSignature generateCertification(PGPUserAttributeSubpacketVector userAttributes, PGPPublicKey pubKey) throws PGPException

Generate a certification for the passed in userAttributes

Parameters

userAttributes:PGPUserAttributeSubpacketVector: the id we are certifying against the public key.
pubKey:PGPPublicKey: the key we are certifying against the id.

Returns:PGPSignature

the certification.

generateCertification	back to summary
public PGPSignature generateCertification(PGPPublicKey masterKey, PGPPublicKey pubKey) throws PGPException Generate a certification for the passed in key against the passed in master key. Parameters masterKey:PGPPublicKey the key we are certifying against. pubKey:PGPPublicKey the key we are certifying. Returns:PGPSignature the certification.

generateCertification

back to summary

public PGPSignature generateCertification(PGPPublicKey masterKey, PGPPublicKey pubKey) throws PGPException

Generate a certification for the passed in key against the passed in master key.

Parameters

masterKey:PGPPublicKey: the key we are certifying against.
pubKey:PGPPublicKey: the key we are certifying.

Returns:PGPSignature

the certification.

generateCertification	back to summary
public PGPSignature generateCertification(PGPPublicKey pubKey) throws PGPException Generate a certification, such as a revocation, for the passed in key. Parameters pubKey:PGPPublicKey the key we are certifying. Returns:PGPSignature the certification.

generateCertification

back to summary

public PGPSignature generateCertification(PGPPublicKey pubKey) throws PGPException

Generate a certification, such as a revocation, for the passed in key.

Parameters

pubKey:PGPPublicKey: the key we are certifying.

Returns:PGPSignature

the certification.

generateOnePassVersion	back to summary
public PGPOnePassSignature generateOnePassVersion(boolean isNested) throws PGPException Return the one pass header associated with the current signature. Parameters isNested:boolean true if the signature is nested, false otherwise. Returns:PGPOnePassSignature PGPOnePassSignature

generateOnePassVersion

back to summary

public PGPOnePassSignature generateOnePassVersion(boolean isNested) throws PGPException

Return the one pass header associated with the current signature.

Parameters

isNested:boolean: true if the signature is nested, false otherwise.

Returns:PGPOnePassSignature

PGPOnePassSignature

init	back to summary
public void init(int signatureType, PGPPrivateKey key) throws PGPException Initialise the generator for signing. Parameters signatureType:int type of signature key:PGPPrivateKey private signing key

init

back to summary

public void init(int signatureType, PGPPrivateKey key) throws PGPException

Initialise the generator for signing.

Parameters

signatureType:int: type of signature
key:PGPPrivateKey: private signing key

insertSubpacket	back to summary
private SignatureSubpacket[] insertSubpacket(SignatureSubpacket[] packets, SignatureSubpacket subpacket)

packetNotPresent	back to summary
private boolean packetNotPresent(SignatureSubpacket[] packets, int type)

prepareSignatureSubpackets	back to summary
protected void prepareSignatureSubpackets() throws PGPException

setHashedSubpackets	back to summary
public void setHashedSubpackets(PGPSignatureSubpacketVector hashedPcks) Set the hashed signature subpackets. Hashed signature subpackets are covered by the signature. Parameters hashedPcks:PGPSignatureSubpacketVector hashed signature subpackets

setHashedSubpackets

back to summary

public void setHashedSubpackets(PGPSignatureSubpacketVector hashedPcks)

Set the hashed signature subpackets. Hashed signature subpackets are covered by the signature.

Parameters

hashedPcks:PGPSignatureSubpacketVector: hashed signature subpackets

setUnhashedSubpackets	back to summary
public void setUnhashedSubpackets(PGPSignatureSubpacketVector unhashedPcks) Set the unhashed signature subpackets. Unhashed signature subpackets are not covered by the signature. Parameters unhashedPcks:PGPSignatureSubpacketVector unhashed signature subpackets

setUnhashedSubpackets

back to summary

public void setUnhashedSubpackets(PGPSignatureSubpacketVector unhashedPcks)

Set the unhashed signature subpackets. Unhashed signature subpackets are not covered by the signature.

Parameters

unhashedPcks:PGPSignatureSubpacketVector: unhashed signature subpackets

v3OPSPacket	back to summary
private OnePassSignaturePacket v3OPSPacket(boolean isNested)

v6OPSPacket	back to summary
private OnePassSignaturePacket v6OPSPacket(boolean isNested)

public Class PGPSignatureGenerator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail