net.shibboleth.metadata.validate.x509

Class X509RSAExponentValidator

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent

net.shibboleth.metadata.validate.BaseValidator

net.shibboleth.metadata.validate.x509.AbstractX509Validator

net.shibboleth.metadata.validate.x509.X509RSAExponentValidator

All Implemented Interfaces:

Validator<X509Certificate>, net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.IdentifiableComponent, net.shibboleth.utilities.java.support.component.IdentifiedComponent, net.shibboleth.utilities.java.support.component.InitializableComponent

@ThreadSafe
public class X509RSAExponentValidator
extends AbstractX509Validator

Validator class to check RSA public exponent values in X.509 certificates. An instance of the class can be configured to have both a warning boundary and an error boundary. The default is to give an error for any exponent less than or equal to three, with no provision for warnings. This NIST recommendation is for at least 65537 (2**16+1) but it's not obvious where this came from so doesn't seem worth insisting on by default.

Nested Class Summary

Nested classes/interfaces inherited from interface net.shibboleth.metadata.validate.Validator

Validator.Action

Field Summary

Fields

Modifier and Type	Field and Description
private BigInteger	errorBoundary The RSA public exponent value below which an error should result.
private BigInteger	warningBoundary The RSA public exponent value below which a warning should result.

Constructor Summary

Constructors

Constructor and Description
X509RSAExponentValidator() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	doValidate(X509Certificate cert, Item<?> item, String stageId) Apply the validator to the object in the given Item context.
long	getErrorBoundary() Get the RSA public exponent below which an error will result.
long	getWarningBoundary() Get the RSA public exponent below which a warning will result.
void	setErrorBoundary(long length) Set the RSA public exponent below which an error should result.
void	setWarningBoundary(long length) Set the RSA public exponent below which a warning should result.

Methods inherited from class net.shibboleth.metadata.validate.x509.AbstractX509Validator

validate

Methods inherited from class net.shibboleth.metadata.validate.BaseValidator

addError, addStatus, addWarning

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent

setId

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

doInitialize, getId

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

destroy, doDestroy, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.shibboleth.utilities.java.support.component.DestructableComponent

destroy, isDestroyed

Methods inherited from interface net.shibboleth.utilities.java.support.component.IdentifiableComponent

setId

Methods inherited from interface net.shibboleth.utilities.java.support.component.IdentifiedComponent

getId

Methods inherited from interface net.shibboleth.utilities.java.support.component.InitializableComponent

initialize, isInitialized

Field Detail

errorBoundary

private BigInteger errorBoundary

The RSA public exponent value below which an error should result. Default: 5.

warningBoundary

private BigInteger warningBoundary

The RSA public exponent value below which a warning should result. Default: 0 (disabled).

Constructor Detail

X509RSAExponentValidator

public X509RSAExponentValidator()

Constructor.

Method Detail

getErrorBoundary

public long getErrorBoundary()

Get the RSA public exponent below which an error will result.

Returns:

the RSA public exponent below which an error will result.

setErrorBoundary

public void setErrorBoundary(long length)

Set the RSA public exponent below which an error should result.

Parameters:

length - the RSA public exponent below which an error should result

getWarningBoundary

public long getWarningBoundary()

Get the RSA public exponent below which a warning will result.

Returns:

the RSA public exponent below which a warning will result.

setWarningBoundary

public void setWarningBoundary(long length)

Set the RSA public exponent below which a warning should result.

Parameters:

length - the RSA public exponent below which a warning should result

doValidate

public void doValidate(@Nonnull
              X509Certificate cert,
              @Nonnull
              Item<?> item,
              @Nonnull
              String stageId)

Description copied from class: AbstractX509Validator

Apply the validator to the object in the given Item context. The validator influences future processing by adding item metadata to the Item.

Specified by:

doValidate in class AbstractX509Validator

Parameters:

cert - the certificate to be validated

item - the Item context for the validation

stageId - the identifier for the stage that is requesting the validation, for inclusion in status metadata