Bouncy Castle Cryptography Library 1.80 · org.bouncycastle.bcpg.OnePassSignaturePacket

See Also: Definition of version 3 OPS packets in RFC4880, Definition of version 3 and 6 OPS packets in RFC9580, Definition of version 3 and 6 OPS packets in librepgp

Field Summary

Modifier and Type	Field and Description
private final byte[]	fingerprint
private final int	hashAlgorithm
private final int	isContaining
private final int	keyAlgorithm
private final long	keyID
private final byte[]	salt
private final int	sigType
private final int	version
public static final int	VERSION_3
public static final int	VERSION_6

Constructor Summary

Access	Constructor and Description
pack-priv	OnePassSignaturePacket(BCPGInputStream OpenPGP packet input stream in) Parse a `OnePassSignaturePacket` from an OpenPGP packet input stream.
pack-priv	OnePassSignaturePacket(BCPGInputStream in, boolean newPacketFormat)
public	OnePassSignaturePacket(int signature type sigType, int hash algorithm tag hashAlgorithm, int public key algorithm tag keyAlgorithm, long id of the signing key keyID, boolean if false, there is another OPS packet after this one, which applies to the same data. it true, the corresponding signature is calculated also over succeeding additional OPS packets. isNested) Create a version 3 `OnePassSignaturePacket`.
public	OnePassSignaturePacket(int signature type sigType, int hash algorithm tag hashAlgorithm, int public key algorithm tag keyAlgorithm, byte[] random salt. The length of this array depends on the hash algorithm in use. salt, byte[] 32 octet fingerprint of the (v6) signing key fingerprint, boolean if false, there is another OPS packet after this one, which applies to the same data. it true, the corresponding signature is calculated also over succeeding additional OPS packets. isNested) Create a version 6 `OnePassSignaturePacket`.

Method Summary

Modifier and Type	Method and Description
public void	encode(BCPGOutputStream OpenPGP packet output stream out) Implements abstract org.bouncycastle.bcpg.ContainedPacket.encode. Encode the contents of this packet into the given packet output stream.
public byte[]	Returns: 32 bytes issuer fingerprint getFingerprint() Return the version 6 fingerprint of the issuer.
public int	Returns: hash algorithm tag getHashAlgorithm() Return the algorithm ID of the hash algorithm.
public int	Returns: public key algorithm tag getKeyAlgorithm() Return the ID of the public key encryption algorithm.
public long	Returns: key id getKeyID() Return the key-id of the signing key.
public byte[]	Returns: salt getSalt() Return the salt used in the signature.
public int	Returns: the signature type getSignatureType() Return the signature type.
public int	Returns: version getVersion() Return the packet version.
public boolean	Returns: true if encapsulating, false otherwise isContaining() Return true, if the signature contains any signatures that follow.

Inherited from org.bouncycastle.bcpg.ContainedPacket:: getEncoded getEncoded

Field Detail

fingerprint	back to summary
private final byte[] fingerprint

hashAlgorithm	back to summary
private final int hashAlgorithm

isContaining	back to summary
private final int isContaining

keyAlgorithm	back to summary
private final int keyAlgorithm

keyID	back to summary
private final long keyID

salt	back to summary
private final byte[] salt

sigType	back to summary
private final int sigType

version	back to summary
private final int version

VERSION_3	back to summary
public static final int VERSION_3

VERSION_6	back to summary
public static final int VERSION_6

Constructor Detail

OnePassSignaturePacket back to summary

OnePassSignaturePacket	back to summary
pack-priv OnePassSignaturePacket(BCPGInputStream in) throws IOException Parse a `OnePassSignaturePacket` from an OpenPGP packet input stream. Parameters in:BCPGInputStream OpenPGP packet input stream Exceptions IOException: when the end of stream is prematurely reached, or when the packet is malformed

pack-priv OnePassSignaturePacket(BCPGInputStream in) throws IOException

Parse a OnePassSignaturePacket from an OpenPGP packet input stream.

Parameters

in:BCPGInputStream: OpenPGP packet input stream

Exceptions

IOException:: when the end of stream is prematurely reached, or when the packet is malformed

OnePassSignaturePacket	back to summary
pack-priv OnePassSignaturePacket(BCPGInputStream in, boolean newPacketFormat) throws IOException

OnePassSignaturePacket back to summary

OnePassSignaturePacket	back to summary
public OnePassSignaturePacket(int sigType, int hashAlgorithm, int keyAlgorithm, long keyID, boolean isNested) Create a version 3 `OnePassSignaturePacket`. Version 3 OPS packets are used with version 3 and version 4 `SignaturePackets`. To create an OPS packet for use with a version 6 `SignaturePacket`, see `OnePassSignaturePacket#OnePassSignaturePacket(int, int, int, byte[], byte[], boolean)`. Parameters sigType:int signature type hashAlgorithm:int hash algorithm tag keyAlgorithm:int public key algorithm tag keyID:long id of the signing key isNested:boolean if false, there is another OPS packet after this one, which applies to the same data. it true, the corresponding signature is calculated also over succeeding additional OPS packets.

public OnePassSignaturePacket(int sigType, int hashAlgorithm, int keyAlgorithm, long keyID, boolean isNested)

Create a version 3 OnePassSignaturePacket. Version 3 OPS packets are used with version 3 and version 4 SignaturePackets. To create an OPS packet for use with a version 6 SignaturePacket, see OnePassSignaturePacket#OnePassSignaturePacket(int, int, int, byte[], byte[], boolean).

Parameters: sigType:int
signature type
hashAlgorithm:int
hash algorithm tag
keyAlgorithm:int
public key algorithm tag
keyID:long
id of the signing key
isNested:boolean
if false, there is another OPS packet after this one, which applies to the same data. it true, the corresponding signature is calculated also over succeeding additional OPS packets.

OnePassSignaturePacket back to summary

OnePassSignaturePacket	back to summary
public OnePassSignaturePacket(int sigType, int hashAlgorithm, int keyAlgorithm, byte[] salt, byte[] fingerprint, boolean isNested) Create a version 6 `OnePassSignaturePacket`. Parameters sigType:int signature type hashAlgorithm:int hash algorithm tag keyAlgorithm:int public key algorithm tag salt:byte[] random salt. The length of this array depends on the hash algorithm in use. fingerprint:byte[] 32 octet fingerprint of the (v6) signing key isNested:boolean if false, there is another OPS packet after this one, which applies to the same data. it true, the corresponding signature is calculated also over succeeding additional OPS packets.

public OnePassSignaturePacket(int sigType, int hashAlgorithm, int keyAlgorithm, byte[] salt, byte[] fingerprint, boolean isNested)

Create a version 6 OnePassSignaturePacket.

Parameters

sigType:int: signature type
hashAlgorithm:int: hash algorithm tag
keyAlgorithm:int: public key algorithm tag
salt:byte[]: random salt. The length of this array depends on the hash algorithm in use.
fingerprint:byte[]: 32 octet fingerprint of the (v6) signing key
isNested:boolean: if false, there is another OPS packet after this one, which applies to the same data. it true, the corresponding signature is calculated also over succeeding additional OPS packets.

Method Detail

encode	back to summary
public void encode(BCPGOutputStream out) throws IOException Implements abstract org.bouncycastle.bcpg.ContainedPacket.encode. Encode the contents of this packet into the given packet output stream. Parameters out:BCPGOutputStream OpenPGP packet output stream

encode

back to summary

public void encode(BCPGOutputStream out) throws IOException

Implements abstract org.bouncycastle.bcpg.ContainedPacket.encode.

Encode the contents of this packet into the given packet output stream.

Parameters

out:BCPGOutputStream: OpenPGP packet output stream

getFingerprint	back to summary
public byte[] getFingerprint() Return the version 6 fingerprint of the issuer. Only for version 6 packets. Returns:byte[] 32 bytes issuer fingerprint

getFingerprint

back to summary

public byte[] getFingerprint()

Return the version 6 fingerprint of the issuer. Only for version 6 packets.

Returns:byte[]: 32 bytes issuer fingerprint

getHashAlgorithm	back to summary
public int getHashAlgorithm() Return the algorithm ID of the hash algorithm. Returns:int hash algorithm tag

getHashAlgorithm

back to summary

public int getHashAlgorithm()

Return the algorithm ID of the hash algorithm.

Returns:int: hash algorithm tag

getKeyAlgorithm	back to summary
public int getKeyAlgorithm() Return the ID of the public key encryption algorithm. Returns:int public key algorithm tag

getKeyAlgorithm

back to summary

public int getKeyAlgorithm()

Return the ID of the public key encryption algorithm.

Returns:int: public key algorithm tag

getKeyID	back to summary
public long getKeyID() Return the key-id of the signing key. Returns:long key id

getKeyID

back to summary

public long getKeyID()

Return the key-id of the signing key.

Returns:long: key id

getSalt	back to summary
public byte[] getSalt() Return the salt used in the signature. Only for version 6 packets. Returns:byte[] salt

getSalt

back to summary

public byte[] getSalt()

Return the salt used in the signature. Only for version 6 packets.

Returns:byte[]: salt

getSignatureType	back to summary
public int getSignatureType() Return the signature type. Returns:int the signature type

getSignatureType

back to summary

public int getSignatureType()

Return the signature type.

Returns:int: the signature type

getVersion	back to summary
public int getVersion() Return the packet version. Returns:int version

getVersion

back to summary

public int getVersion()

Return the packet version.

Returns:int: version

isContaining	back to summary
public boolean isContaining() Return true, if the signature contains any signatures that follow. A bracketing OPS is followed by additional OPS packets and is calculated over all the data between itself and its corresponding signature (it is an attestation for encapsulated signatures). Returns:boolean true if encapsulating, false otherwise

isContaining

back to summary

public boolean isContaining()

Return true, if the signature contains any signatures that follow. A bracketing OPS is followed by additional OPS packets and is calculated over all the data between itself and its corresponding signature (it is an attestation for encapsulated signatures).

Returns:boolean: true if encapsulating, false otherwise

public Class OnePassSignaturePacket

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail