Bouncy Castle OpenPGP APIs (FIPS Distribution) 1.0.7.1 · org.bouncycastle.openpgp.PGPSignature

Field Summary

Modifier and Type	Field and Description
public static final int	BINARY_DOCUMENT
public static final int	CANONICAL_TEXT_DOCUMENT
public static final int	CASUAL_CERTIFICATION
public static final int	CERTIFICATION_REVOCATION
public static final int	DEFAULT_CERTIFICATION
public static final int	DIRECT_KEY
public static final int	KEY_REVOCATION
private byte	lastb
public static final int	NO_CERTIFICATION
public static final int	POSITIVE_CERTIFICATION
public static final int	PRIMARYKEY_BINDING
private int	signatureType
private OutputStream	sigOut
private SignaturePacket	sigPck
public static final int	STAND_ALONE
public static final int	SUBKEY_BINDING
public static final int	SUBKEY_REVOCATION
public static final int	THIRD_PARTY_CONFIRMATION
public static final int	TIMESTAMP
private TrustPacket	trustPck
private PGPContentVerifier	verifier

Constructor Summary

Access	Constructor and Description
public	PGPSignature(BCPGInputStream pIn)
pack-priv	PGPSignature(SignaturePacket sigPacket)
pack-priv	PGPSignature(SignaturePacket sigPacket, TrustPacket trustPacket)

Method Summary

Modifier and Type	Method and Description
private void	addTrailer()
private void	blockUpdate(byte[] block, int off, int len)
private void	byteUpdate(byte b)
private static SignaturePacket	cast(Packet packet)
private PGPSignatureSubpacketVector	createSubpacketVector(SignatureSubpacket[] pcks)
public void	encode(OutputStream outStream)
public void	encode(OutputStream stream to write the key encoding to. outStream, boolean if the purpose of encoding is to send key to other users. forTransfer) Encode the signature to outStream, with trust packets stripped out if forTransfer is true.
public Date	Returns: the signature creation time. getCreationTime() Return the creation time of the signature.
public byte[]	Returns: digest prefix getDigestPrefix() Return the digest prefix of the signature.
public byte[]	getEncoded()
public byte[]	Returns: a encoded byte array representing the key. getEncoded(boolean if the purpose of encoding is to send key to other users. forTransfer) Return an encoding of the signature, with trust packets stripped out if forTransfer is true.
private byte[]	getEncodedPublicKey(PGPPublicKey pubKey)
public int	Returns: signature hash algorithm. getHashAlgorithm() Return the hash algorithm associated with this signature.
public PGPSignatureSubpacketVector	getHashedSubPackets()
public int	Returns: signature key algorithm. getKeyAlgorithm() Return the key algorithm associated with this signature.
public long	Returns: keyID of the signatures corresponding key. getKeyID() Return the id of the key that created the signature.
public byte[]	getSignature()
public byte[]	getSignatureTrailer()
public int	getSignatureType()
public PGPSignatureSubpacketVector	getUnhashedSubPackets()
public int	Returns: signature version number. getVersion() Return the OpenPGP version number for this signature.
public boolean	Returns: true if either hashed or unhashed subpackets are present, false otherwise. hasSubpackets() Return true if the signature has either hashed or unhashed subpackets.
public void	init(PGPContentVerifierBuilderProvider verifierBuilderProvider, PGPPublicKey pubKey)
public boolean	Returns: true if this signature represents a certification, false otherwise. isCertification() Return true if this signature represents a certification.
public static boolean	Returns: true if signatureType is a certification, false otherwise. isCertification(int signatureType) Return true if the passed in signature type represents a certification, false if the signature type is not.
public static boolean	isSignatureEncodingEqual(PGPSignature sig1, PGPSignature sig2)
public static PGPSignature	join(PGPSignature sig1, PGPSignature sig2)
public void	update(byte b)
public void	update(byte[] bytes)
public void	update(byte[] bytes, int off, int length)
private void	updateWithIdData(int header, byte[] idBytes)
private void	updateWithPublicKey(PGPPublicKey key)
public boolean	verify()
public boolean	Returns: true if the signature matches, false otherwise. verifyCertification(PGPUserAttributeSubpacketVector user attributes the key was stored under userAttributes, PGPPublicKey the key to be verified. key) Verify the signature as certifying the passed in public key as associated with the passed in user attributes.
public boolean	Returns: true if the signature matches, false otherwise. verifyCertification(String id the key was stored under id, PGPPublicKey the key to be verified. key) Verify the signature as certifying the passed in public key as associated with the passed in id.
public boolean	Returns: true if the signature matches, false otherwise. verifyCertification(byte[] id the key was stored under in its raw byte form. rawID, PGPPublicKey the key to be verified. key) Verify the signature as certifying the passed in public key as associated with the passed in rawID.
public boolean	Returns: true if the certification is valid, false otherwise. verifyCertification(PGPPublicKey the key we are verifying against. masterKey, PGPPublicKey the key we are verifying. pubKey) Verify a certification for the passed in key against the passed in master key.
public boolean	Returns: true if the certification is valid, false otherwise. verifyCertification(PGPPublicKey the key we are checking. pubKey) Verify a key certification, such as a revocation, for the passed in key.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

BINARY_DOCUMENT	back to summary
public static final int BINARY_DOCUMENT

CANONICAL_TEXT_DOCUMENT	back to summary
public static final int CANONICAL_TEXT_DOCUMENT

CASUAL_CERTIFICATION	back to summary
public static final int CASUAL_CERTIFICATION

CERTIFICATION_REVOCATION	back to summary
public static final int CERTIFICATION_REVOCATION

DEFAULT_CERTIFICATION	back to summary
public static final int DEFAULT_CERTIFICATION

DIRECT_KEY	back to summary
public static final int DIRECT_KEY

KEY_REVOCATION	back to summary
public static final int KEY_REVOCATION

lastb	back to summary
private byte lastb

NO_CERTIFICATION	back to summary
public static final int NO_CERTIFICATION

POSITIVE_CERTIFICATION	back to summary
public static final int POSITIVE_CERTIFICATION

PRIMARYKEY_BINDING	back to summary
public static final int PRIMARYKEY_BINDING

signatureType	back to summary
private int signatureType

sigOut	back to summary
private OutputStream sigOut

sigPck	back to summary
private SignaturePacket sigPck

STAND_ALONE	back to summary
public static final int STAND_ALONE

SUBKEY_BINDING	back to summary
public static final int SUBKEY_BINDING

SUBKEY_REVOCATION	back to summary
public static final int SUBKEY_REVOCATION

THIRD_PARTY_CONFIRMATION	back to summary
public static final int THIRD_PARTY_CONFIRMATION

TIMESTAMP	back to summary
public static final int TIMESTAMP

trustPck	back to summary
private TrustPacket trustPck

verifier	back to summary
private PGPContentVerifier verifier

Constructor Detail

PGPSignature	back to summary
public PGPSignature(BCPGInputStream pIn) throws IOException, PGPException

PGPSignature	back to summary
pack-priv PGPSignature(SignaturePacket sigPacket)

PGPSignature	back to summary
pack-priv PGPSignature(SignaturePacket sigPacket, TrustPacket trustPacket)

Method Detail

addTrailer	back to summary
private void addTrailer()

blockUpdate	back to summary
private void blockUpdate(byte[] block, int off, int len)

byteUpdate	back to summary
private void byteUpdate(byte b)

cast	back to summary
private static SignaturePacket cast(Packet packet) throws IOException

createSubpacketVector	back to summary
private PGPSignatureSubpacketVector createSubpacketVector(SignatureSubpacket[] pcks)

encode	back to summary
public void encode(OutputStream outStream) throws IOException

encode	back to summary
public void encode(OutputStream outStream, boolean forTransfer) throws IOException Encode the signature to outStream, with trust packets stripped out if forTransfer is true. Parameters outStream:OutputStream stream to write the key encoding to. forTransfer:boolean if the purpose of encoding is to send key to other users. Exceptions IOException: in case of encoding error.

encode

back to summary

public void encode(OutputStream outStream, boolean forTransfer) throws IOException

Encode the signature to outStream, with trust packets stripped out if forTransfer is true.

Parameters

outStream:OutputStream: stream to write the key encoding to.
forTransfer:boolean: if the purpose of encoding is to send key to other users.

Exceptions

IOException:: in case of encoding error.

getCreationTime	back to summary
public Date getCreationTime() Return the creation time of the signature. Returns:Date the signature creation time.

getCreationTime

back to summary

public Date getCreationTime()

Return the creation time of the signature.

Returns:Date: the signature creation time.

getDigestPrefix	back to summary
public byte[] getDigestPrefix() Return the digest prefix of the signature. Returns:byte[] digest prefix

getDigestPrefix

back to summary

public byte[] getDigestPrefix()

Return the digest prefix of the signature.

Returns:byte[]: digest prefix

getEncoded	back to summary
public byte[] getEncoded() throws IOException

getEncoded	back to summary
public byte[] getEncoded(boolean forTransfer) throws IOException Return an encoding of the signature, with trust packets stripped out if forTransfer is true. Parameters forTransfer:boolean if the purpose of encoding is to send key to other users. Returns:byte[] a encoded byte array representing the key. Exceptions IOException: in case of encoding error.

getEncoded

back to summary

public byte[] getEncoded(boolean forTransfer) throws IOException

Return an encoding of the signature, with trust packets stripped out if forTransfer is true.

Parameters

forTransfer:boolean: if the purpose of encoding is to send key to other users.

Returns:byte[]

a encoded byte array representing the key.

Exceptions

IOException:: in case of encoding error.

getEncodedPublicKey	back to summary
private byte[] getEncodedPublicKey(PGPPublicKey pubKey) throws PGPException

getHashAlgorithm	back to summary
public int getHashAlgorithm() Return the hash algorithm associated with this signature. Returns:int signature hash algorithm.

getHashAlgorithm

back to summary

public int getHashAlgorithm()

Return the hash algorithm associated with this signature.

Returns:int: signature hash algorithm.

getHashedSubPackets	back to summary
public PGPSignatureSubpacketVector getHashedSubPackets()

getKeyAlgorithm	back to summary
public int getKeyAlgorithm() Return the key algorithm associated with this signature. Returns:int signature key algorithm.

getKeyAlgorithm

back to summary

public int getKeyAlgorithm()

Return the key algorithm associated with this signature.

Returns:int: signature key algorithm.

getKeyID	back to summary
public long getKeyID() Return the id of the key that created the signature. Returns:long keyID of the signatures corresponding key.

getKeyID

back to summary

public long getKeyID()

Return the id of the key that created the signature.

Returns:long: keyID of the signatures corresponding key.

getSignature	back to summary
public byte[] getSignature() throws PGPException

getSignatureTrailer	back to summary
public byte[] getSignatureTrailer()

getSignatureType	back to summary
public int getSignatureType()

getUnhashedSubPackets	back to summary
public PGPSignatureSubpacketVector getUnhashedSubPackets()

getVersion	back to summary
public int getVersion() Return the OpenPGP version number for this signature. Returns:int signature version number.

getVersion

back to summary

public int getVersion()

Return the OpenPGP version number for this signature.

Returns:int: signature version number.

hasSubpackets	back to summary
public boolean hasSubpackets() Return true if the signature has either hashed or unhashed subpackets. Returns:boolean true if either hashed or unhashed subpackets are present, false otherwise.

hasSubpackets

back to summary

public boolean hasSubpackets()

Return true if the signature has either hashed or unhashed subpackets.

Returns:boolean: true if either hashed or unhashed subpackets are present, false otherwise.

init	back to summary
public void init(PGPContentVerifierBuilderProvider verifierBuilderProvider, PGPPublicKey pubKey) throws PGPException

isCertification

back to summary

public boolean isCertification()

Return true if this signature represents a certification.

Returns:boolean: true if this signature represents a certification, false otherwise.

isCertification

back to summary

public static boolean isCertification(int signatureType)

Return true if the passed in signature type represents a certification, false if the signature type is not.

Returns:boolean: true if signatureType is a certification, false otherwise.

isSignatureEncodingEqual	back to summary
public static boolean isSignatureEncodingEqual(PGPSignature sig1, PGPSignature sig2)

join	back to summary
public static PGPSignature join(PGPSignature sig1, PGPSignature sig2) throws PGPException

update	back to summary
public void update(byte b)

update	back to summary
public void update(byte[] bytes)

update	back to summary
public void update(byte[] bytes, int off, int length)

updateWithIdData	back to summary
private void updateWithIdData(int header, byte[] idBytes)

updateWithPublicKey	back to summary
private void updateWithPublicKey(PGPPublicKey key) throws PGPException

verify	back to summary
public boolean verify() throws PGPException

verifyCertification

back to summary

public boolean verifyCertification(PGPUserAttributeSubpacketVector userAttributes, PGPPublicKey key) throws PGPException

Verify the signature as certifying the passed in public key as associated with the passed in user attributes.

Parameters

userAttributes:PGPUserAttributeSubpacketVector: user attributes the key was stored under
key:PGPPublicKey: the key to be verified.

Returns:boolean

true if the signature matches, false otherwise.

verifyCertification

back to summary

public boolean verifyCertification(String id, PGPPublicKey key) throws PGPException

Verify the signature as certifying the passed in public key as associated with the passed in id.

Parameters

id:String: id the key was stored under
key:PGPPublicKey: the key to be verified.

Returns:boolean

true if the signature matches, false otherwise.

verifyCertification

back to summary

public boolean verifyCertification(byte[] rawID, PGPPublicKey key) throws PGPException

Verify the signature as certifying the passed in public key as associated with the passed in rawID.

Parameters

rawID:byte[]: id the key was stored under in its raw byte form.
key:PGPPublicKey: the key to be verified.

Returns:boolean

true if the signature matches, false otherwise.

verifyCertification

back to summary

public boolean verifyCertification(PGPPublicKey masterKey, PGPPublicKey pubKey) throws PGPException

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

Parameters

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

Returns:boolean

true if the certification is valid, false otherwise.

verifyCertification

back to summary

public boolean verifyCertification(PGPPublicKey pubKey) throws PGPException

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

Parameters

pubKey:PGPPublicKey: the key we are checking.

Returns:boolean

true if the certification is valid, false otherwise.

public Class PGPSignature

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail