Package Summary  Overview Summary

class:DrbgParameters.Capability [NONE]

All Implemented Interfaces:
Serializable, Comparable<DrbgParameters.Capability>, Constable
Enclosing class:
DrbgParameters

public static enum DrbgParameters.Capability
extends Enum<DrbgParameters.Capability>
The reseedable and prediction resistance capabilities of a DRBG.

When this object is passed to a SecureRandom.getInstance() call, it is the requested minimum capability. When it's returned from SecureRandom.getParameters(), it is the effective capability.

Please note that while the Instantiate_function defined in NIST SP 800-90Ar1 only includes a prediction_resistance_flag parameter, the Capability type includes an extra value RESEED_ONLY because reseeding is an optional function. If NONE is used in an Instantiation object in calling the SecureRandom.getInstance method, the returned DRBG instance is not guaranteed to support reseeding. If RESEED_ONLY or PR_AND_RESEED is used, the instance must support reseeding.

The table below lists possible effective values if a certain capability is requested, i.e.

 Capability requested = ...;
 SecureRandom s = SecureRandom.getInstance("DRBG",
         DrbgParameters(-1, requested, null));
 Capability effective = ((DrbgParametes.Initiate) s.getParameters())
         .getCapability();
requested and effective capabilities
Requested Value Possible Effective Values
NONENONE, RESEED_ONLY, PR_AND_RESEED
RESEED_ONLYRESEED_ONLY, PR_AND_RESEED
PR_AND_RESEEDPR_AND_RESEED

A DRBG implementation supporting prediction resistance must also support reseeding.

Since:
9

field:PR_AND_RESEED [NONE]

  • PR_AND_RESEED

    public static final  DrbgParameters.Capability PR_AND_RESEED
    Both prediction resistance and reseed.
  • field:RESEED_ONLY [NONE]

    RESEED_ONLY

    public static final  DrbgParameters.Capability RESEED_ONLY
    Reseed but no prediction resistance.

    field:NONE [NONE]

    NONE

    public static final  DrbgParameters.Capability NONE
    Neither prediction resistance nor reseed.

    method:values() [NONE]

  • values

    public static  DrbgParameters.Capability[] values()
    Returns an array containing the constants of this enum type, in the order they are declared.
    Returns:
    an array containing the constants of this enum type, in the order they are declared
  • method:valueOf(java.lang.String) [NONE]

    valueOf

    public static  DrbgParameters.Capability valueOf?(String name)
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    Parameters:
    name - the name of the enum constant to be returned.
    Returns:
    the enum constant with the specified name
    Throws:
    IllegalArgumentException - if this enum type has no constant with the specified name
    NullPointerException - if the argument is null

    method:toString() [NONE]

    toString

    public String toString()
    Description copied from class: Enum
    Returns the name of this enum constant, as contained in the declaration. This method may be overridden, though it typically isn't necessary or desirable. An enum type should override this method when a more "programmer-friendly" string form exists.
    Overrides:
    toString in class Enum<DrbgParameters.Capability>
    Returns:
    the name of this enum constant

    method:supportsReseeding() [NONE]

    supportsReseeding

    public boolean supportsReseeding()
    Returns whether this capability supports reseeding.
    Returns:
    true for PR_AND_RESEED and RESEED_ONLY, and false for NONE

    method:supportsPredictionResistance() [NONE]

    supportsPredictionResistance

    public boolean supportsPredictionResistance()
    Returns whether this capability supports prediction resistance.
    Returns:
    true for PR_AND_RESEED, and false for RESEED_ONLY and NONE

    © 2020 Oracle Corporation and/or its affiliates