com.itextpdf.commons.bouncycastle.cert.ocsp.ICertificateID Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of commons-android Show documentation
There is a newer version: 9.0.0
/*
    This file is part of the iText (R) project.
    Copyright (c) 1998-2023 Apryse Group NV
    Authors: Apryse Software.

    This program is offered under a commercial and under the AGPL license.
    For commercial licensing, contact us at https://itextpdf.com/sales.  For AGPL licensing, see below.

    AGPL licensing:
    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU Affero General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Affero General Public License for more details.

    You should have received a copy of the GNU Affero General Public License
    along with this program.  If not, see .
 */
package com.itextpdf.commons.bouncycastle.cert.ocsp;

import com.itextpdf.commons.bouncycastle.asn1.IASN1ObjectIdentifier;
import com.itextpdf.commons.bouncycastle.asn1.x509.IAlgorithmIdentifier;
import com.itextpdf.commons.bouncycastle.cert.IX509CertificateHolder;
import com.itextpdf.commons.bouncycastle.operator.IDigestCalculatorProvider;

import java.math.BigInteger;

/**
 * This interface represents the wrapper for CertificateID that provides the ability
 * to switch between bouncy-castle and bouncy-castle FIPS implementations.
 */
public interface ICertificateID {
    /**
     * Calls actual {@code getHashAlgOID} method for the wrapped CertificateID object.
     *
     * @return {@link IASN1ObjectIdentifier} hash algorithm OID wrapper.
     */
    IASN1ObjectIdentifier getHashAlgOID();

    /**
     * Gets {@code getHashSha1} constant for the wrapped CertificateID.
     *
     * @return CertificateID.HASH_SHA1 wrapper.
     */
    IAlgorithmIdentifier getHashSha1();

    /**
     * Calls actual {@code matchesIssuer} method for the wrapped CertificateID object.
     *
     * @param certificateHolder X509CertificateHolder wrapper
     * @param provider          DigestCalculatorProvider wrapper
     *
     * @return boolean value.
     *
     * @throws AbstractOCSPException OCSPException wrapper.
     */
    boolean matchesIssuer(IX509CertificateHolder certificateHolder, IDigestCalculatorProvider provider)
            throws AbstractOCSPException;

    /**
     * Calls actual {@code getSerialNumber} method for the wrapped CertificateID object.
     *
     * @return serial number value.
     */
    BigInteger getSerialNumber();
}