Package eu.europa.esig.dss.spi.x509.revocation.ocsp

Class OCSPToken

java.lang.Object

eu.europa.esig.dss.model.x509.Token

eu.europa.esig.dss.spi.x509.revocation.RevocationToken<OCSP>

eu.europa.esig.dss.spi.x509.revocation.ocsp.OCSPToken

All Implemented Interfaces:

Serializable

public class OCSPToken
extends RevocationToken<OCSP>

OCSP Signed Token which encapsulate BasicOCSPResp (BC).

See Also:

Serialized Form

Field Summary

Fields inherited from class eu.europa.esig.dss.spi.x509.revocation.RevocationToken

archiveCutOff, certHashMatch, certHashPresent, expiredCertsOnCRL, externalOrigin, nextUpdate, productionDate, reason, relatedCertificate, revocationDate, revocationTokenKey, sourceURL, status, thisUpdate

Fields inherited from class eu.europa.esig.dss.model.x509.Token

publicKeyOfTheSigner, signatureAlgorithm, signatureInvalidityReason, signatureValidity

Constructor Summary

Constructors

Constructor	Description
OCSPToken(org.bouncycastle.cert.ocsp.BasicOCSPResp basicOCSPResp, org.bouncycastle.cert.ocsp.SingleResp latestSingleResp, CertificateToken certificate, CertificateToken issuer)	The default constructor to instantiate an OCSPToken with BasicOCSPResp only

Method Summary

Modifier and Type	Method	Description
protected SignatureValidity	checkIsSignedBy(CertificateToken candidate)	Verifies if the current token has been signed by the specified certificateToken
String	getAbbreviation()	This method returns the DSS abbreviation of the token.
org.bouncycastle.cert.ocsp.BasicOCSPResp	getBasicOCSPResp()
OCSPCertificateSource	getCertificateSource()	Returns a source of embedded into a revocation token certificates
byte[]	getEncoded()	Returns the encoded form of the wrapped token.
CertificateToken	getIssuerCertificateToken()	Returns issuer CertificateToken
X500Principal	getIssuerX500Principal()	Returns the X500Principal of the certificate which was used to sign this token.
org.bouncycastle.cert.ocsp.SingleResp	getLatestSingleResp()
String	getRevocationTokenKey()	Returns compiled revocation token key
RevocationType	getRevocationType()	Returns the Revocation Token type (CRL or OCSP)
SignatureAlgorithm	getSignatureAlgorithm()	Returns the algorithm that was used to sign the token (ex: SHA1WithRSAEncryption, SHA1withRSA...).
boolean	isSignedBy(CertificateToken token)	Checks if the token is signed by the given token in the parameter.
boolean	isValid()	Indicates if the token signature is intact.
String	toString(String indentStr)	Returns a string representation of the token.

Methods inherited from class eu.europa.esig.dss.spi.x509.revocation.RevocationToken

buildTokenIdentifier, equals, getArchiveCutOff, getCreationDate, getExpiredCertsOnCRL, getExternalOrigin, getNextUpdate, getProductionDate, getReason, getRelatedCertificateID, getRevocationDate, getSourceURL, getStatus, getThisUpdate, hashCode, isCertHashMatch, isCertHashPresent, isInternal, setExternalOrigin, setRelatedCertificate, setRevocationTokenKey, setSourceURL

Methods inherited from class eu.europa.esig.dss.model.x509.Token

getDigest, getDSSId, getDSSIdAsString, getPublicKeyOfTheSigner, getSignatureValidity, isSelfSigned, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

OCSPToken

public OCSPToken(org.bouncycastle.cert.ocsp.BasicOCSPResp basicOCSPResp, org.bouncycastle.cert.ocsp.SingleResp latestSingleResp, CertificateToken certificate, CertificateToken issuer)

The default constructor to instantiate an OCSPToken with BasicOCSPResp only

Parameters:

basicOCSPResp - BasicOCSPResp containing the response binaries

latestSingleResp - SingleResp to be used with the current certificate

certificate - CertificateToken to which the revocation data is provided for

issuer - CertificateToken issued the certificateToken

Method Details

getSignatureAlgorithm

public SignatureAlgorithm getSignatureAlgorithm()

Description copied from class: Token

Returns the algorithm that was used to sign the token (ex: SHA1WithRSAEncryption, SHA1withRSA...).

Overrides:

getSignatureAlgorithm in class Token

Returns:

the used signature algorithm to sign this token

getRevocationTokenKey

public String getRevocationTokenKey()

Description copied from class: RevocationToken

Returns compiled revocation token key

Overrides:

getRevocationTokenKey in class RevocationToken<OCSP>

Returns:

String key

getBasicOCSPResp

public org.bouncycastle.cert.ocsp.BasicOCSPResp getBasicOCSPResp()

getLatestSingleResp

public org.bouncycastle.cert.ocsp.SingleResp getLatestSingleResp()

getCertificateSource

public OCSPCertificateSource getCertificateSource()

Description copied from class: RevocationToken

Returns a source of embedded into a revocation token certificates

Specified by:

getCertificateSource in class RevocationToken<OCSP>

Returns:

RevocationCertificateSource

getEncoded

public byte[] getEncoded()

Description copied from class: Token

Returns the encoded form of the wrapped token.

Specified by:

getEncoded in class Token

Returns:

the encoded form of the wrapped token

getIssuerX500Principal

public X500Principal getIssuerX500Principal()

Description copied from class: Token

Returns the X500Principal of the certificate which was used to sign this token.

Specified by:

getIssuerX500Principal in class Token

Returns:

the issuer's X500Principal

getIssuerCertificateToken

public CertificateToken getIssuerCertificateToken()

Description copied from class: RevocationToken

Returns issuer CertificateToken

Specified by:

getIssuerCertificateToken in class RevocationToken<OCSP>

Returns:

issuer CertificateToken

isValid

public boolean isValid()

Indicates if the token signature is intact. NOTE: The method isSignedBy(token) must be called before!

Specified by:

isValid in class RevocationToken<OCSP>

Returns:

true or false

isSignedBy

public boolean isSignedBy(CertificateToken token)

Description copied from class: Token

Checks if the token is signed by the given token in the parameter.

Overrides:

isSignedBy in class Token

Parameters:

token - the candidate to be tested

Returns:

true if this token is signed by the given certificate token

checkIsSignedBy

protected SignatureValidity checkIsSignedBy(CertificateToken candidate)

Description copied from class: Token

Verifies if the current token has been signed by the specified certificateToken

Specified by:

checkIsSignedBy in class Token

Parameters:

candidate - CertificateToken signed candidate

Returns:

SignatureValidity

getRevocationType

public RevocationType getRevocationType()

Description copied from class: RevocationToken

Returns the Revocation Token type (CRL or OCSP)

Specified by:

getRevocationType in class RevocationToken<OCSP>

Returns:

RevocationType of the token

getAbbreviation

public String getAbbreviation()

Description copied from class: Token

This method returns the DSS abbreviation of the token. It is used for debugging purpose.

Overrides:

getAbbreviation in class Token

Returns:

an abbreviation for the certificate

toString

public String toString(String indentStr)

Description copied from class: Token

Returns a string representation of the token.

Specified by:

toString in class Token

Parameters:

indentStr - the indentation to use

Returns:

string representation of the token