org.bouncycastle.bcpg.sig.Features Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bcpg-jdk14 Show documentation

The Bouncy Castle Java API for handling the OpenPGP protocol. This jar contains the OpenPGP API for JDK 1.4. The APIs can be used in conjunction with a JCE/JCA provider such as the one provided with the Bouncy Castle Cryptography APIs.

The newest version!

package org.bouncycastle.bcpg.sig;

import org.bouncycastle.bcpg.SignatureSubpacket;
import org.bouncycastle.bcpg.SignatureSubpacketTags;

/**
 * Signature Subpacket encoding, which features are supported by the key-holders implementation.
 *
 * @see 
 *     RFC4880 - Features
 * @see 
 *     RFC9580 - Features
 */
public class Features
    extends SignatureSubpacket
{
    /**
     * Identifier for the Modification Detection (packets 18 and 19)
     * Symmetrically Encrypted Integrity Protected Data packet version 1.
     */
    public static final byte FEATURE_MODIFICATION_DETECTION = 0x01;

    /**
     * Identifier for the AEAD Encrypted Data Packet (packet 20) and version 5
     * Symmetric-Key Encrypted Session Key Packets (packet 3)
     */
    public static final byte FEATURE_AEAD_ENCRYPTED_DATA = 0x02;

    /**
     * Identifier for the Version 5 Public-Key Packet format and corresponding new
     * fingerprint format
     */
    public static final byte FEATURE_VERSION_5_PUBLIC_KEY = 0x04;

    /**
     * Symmetrically Encrypted Integrity Protected Data packet version 2.
     */
    public static final byte FEATURE_SEIPD_V2 = 0x08;

    private static final byte[] featureToByteArray(byte feature)
    {
        byte[] data = new byte[1];
        data[0] = feature;
        return data;
    }

    public Features(
        boolean critical,
        boolean isLongLength,
        byte[] data)
    {
        super(SignatureSubpacketTags.FEATURES, critical, isLongLength, data);
    }

    public Features(boolean critical, byte features)
    {
        super(SignatureSubpacketTags.FEATURES, critical, false, featureToByteArray(features));
    }

    public Features(boolean critical, int features)
    {
        super(SignatureSubpacketTags.FEATURES, critical, false, featureToByteArray((byte)features));
    }

    public byte getFeatures()
    {
        return data[0];
    }

    /**
     * Returns if modification detection is supported.
     */
    public boolean supportsModificationDetection()
    {
        return supportsFeature(FEATURE_MODIFICATION_DETECTION);
    }

    public boolean supportsSEIPDv2()
    {
        return supportsFeature(FEATURE_SEIPD_V2);
    }

    /**
     * Returns if a particular feature is supported.
     */
    public boolean supportsFeature(byte feature)
    {
        return (data[0] & feature) != 0;
    }
}