org.bouncycastle.tsp.TimeStampRequestGenerator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of bcpkix-debug-jdk15to18 Show documentation
The Bouncy Castle Java APIs for CMS, PKCS, EAC, TSP, CMP, CRMF, OCSP, and certificate generation. This jar contains APIs for JDK 1.5 to JDK 1.8. 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.tsp;

import java.io.IOException;
import java.math.BigInteger;

import org.bouncycastle.asn1.ASN1Boolean;
import org.bouncycastle.asn1.ASN1Encodable;
import org.bouncycastle.asn1.ASN1Integer;
import org.bouncycastle.asn1.ASN1ObjectIdentifier;
import org.bouncycastle.asn1.tsp.MessageImprint;
import org.bouncycastle.asn1.tsp.TimeStampReq;
import org.bouncycastle.asn1.x509.AlgorithmIdentifier;
import org.bouncycastle.asn1.x509.Extensions;
import org.bouncycastle.asn1.x509.ExtensionsGenerator;
import org.bouncycastle.operator.DefaultDigestAlgorithmIdentifierFinder;
import org.bouncycastle.operator.DigestAlgorithmIdentifierFinder;

/**
 * Generator for RFC 3161 Time Stamp Request objects.
 */
public class TimeStampRequestGenerator
{
    private static final DefaultDigestAlgorithmIdentifierFinder DEFAULT_DIGEST_ALG_FINDER =
        new DefaultDigestAlgorithmIdentifierFinder();

    private final ExtensionsGenerator extGenerator = new ExtensionsGenerator();

    private final DigestAlgorithmIdentifierFinder digestAlgFinder;

    private ASN1ObjectIdentifier reqPolicy;
    private ASN1Boolean certReq;

    public TimeStampRequestGenerator()
    {
        this(DEFAULT_DIGEST_ALG_FINDER);
    }

    public TimeStampRequestGenerator(DigestAlgorithmIdentifierFinder digestAlgFinder)
    {
        if (digestAlgFinder == null)
        {
            throw new NullPointerException("'digestAlgFinder' cannot be null");
        }

        this.digestAlgFinder = digestAlgFinder;
    }

    public void setReqPolicy(ASN1ObjectIdentifier reqPolicy)
    {
        this.reqPolicy = reqPolicy;
    }
    
    /**
     * @deprecated use method taking ASN1ObjectIdentifier
     * @param reqPolicy
     */
    public void setReqPolicy(String reqPolicy)
    {
        setReqPolicy(new ASN1ObjectIdentifier(reqPolicy));
    }

    public void setCertReq(ASN1Boolean certReq)
    {
        this.certReq = certReq;
    }

    public void setCertReq(boolean certReq)
    {
        setCertReq(ASN1Boolean.getInstance(certReq));
    }

    /**
     * add a given extension field for the standard extensions tag (tag 3)
     * @throws IOException
     * @deprecated use method taking ASN1ObjectIdentifier
     */
    public void addExtension(String OID, boolean critical, ASN1Encodable value) throws IOException
    {
        addExtension(new ASN1ObjectIdentifier(OID), critical, value);
    }

    /**
     * add a given extension field for the standard extensions tag
     * The value parameter becomes the contents of the octet string associated
     * with the extension.
     * @deprecated use method taking ASN1ObjectIdentifier
     */
    public void addExtension(String OID, boolean critical, byte[] value)
    {
        addExtension(new ASN1ObjectIdentifier(OID), critical, value);
    }

    /**
     * add a given extension field for the standard extensions tag (tag 3)
     * @throws TSPIOException
     */
    public void addExtension(ASN1ObjectIdentifier oid, boolean isCritical, ASN1Encodable value) throws TSPIOException
    {
        TSPUtil.addExtension(extGenerator, oid, isCritical, value);
    }

    /**
     * add a given extension field for the standard extensions tag
     * The value parameter becomes the contents of the octet string associated
     * with the extension.
     */
    public void addExtension(ASN1ObjectIdentifier oid, boolean isCritical, byte[] value)
    {
        extGenerator.addExtension(oid, isCritical, value);
    }

    /**
     * @deprecated use method taking ANS1ObjectIdentifier or AlgorithmIdentifier
     */
    public TimeStampRequest generate(String digestAlgorithm, byte[] digest)
    {
        return generate(digestAlgorithm, digest, null);
    }

    /**
     * @deprecated use method taking ANS1ObjectIdentifier or AlgorithmIdentifier
     */
    public TimeStampRequest generate(String digestAlgorithmOID, byte[] digest, BigInteger nonce)
    {
        if (digestAlgorithmOID == null)
        {
            throw new NullPointerException("'digestAlgorithmOID' cannot be null");
        }

        return generate(new ASN1ObjectIdentifier(digestAlgorithmOID), digest, nonce);
    }

    public TimeStampRequest generate(ASN1ObjectIdentifier digestAlgorithm, byte[] digest)
    {
        return generate(digestAlgorithm, digest, null);
    }

    public TimeStampRequest generate(ASN1ObjectIdentifier digestAlgorithm, byte[] digest, BigInteger nonce)
    {
        return generate(digestAlgFinder.find(digestAlgorithm), digest, nonce);
    }

    public TimeStampRequest generate(AlgorithmIdentifier digestAlgorithmID, byte[] digest)
    {
        return generate(digestAlgorithmID, digest, null);
    }

    public TimeStampRequest generate(AlgorithmIdentifier digestAlgorithmID, byte[] digest, BigInteger nonce)
    {
        if (digestAlgorithmID == null)
        {
            throw new NullPointerException("'digestAlgorithmID' cannot be null");
        }

        MessageImprint messageImprint = new MessageImprint(digestAlgorithmID, digest);
        ASN1Integer reqNonce = nonce == null ? null : new ASN1Integer(nonce);
        Extensions ext = extGenerator.isEmpty() ? null : extGenerator.generate();

        return new TimeStampRequest(new TimeStampReq(messageImprint, reqPolicy, reqNonce, certReq, ext));
    }
}