DrbgParameters.Capability (Java SE 9 & JDK 9 ) (original) (raw)

• java.lang.Object

• • java.lang.Enum<DrbgParameters.Capability>
  • • java.security.DrbgParameters.Capability

• All Implemented Interfaces:
  [Serializable](../../java/io/Serializable.html "interface in java.io"), [Comparable](../../java/lang/Comparable.html "interface in java.lang")<[DrbgParameters.Capability](../../java/security/DrbgParameters.Capability.html "enum in java.security")>
  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 fromSecureRandom.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 valueRESEED_ONLY because reseeding is an optional function. If NONE is used in an Instantiation object in calling theSecureRandom.getInstance method, the returned DRBG instance is not guaranteed to support reseeding. If RESEED_ONLY orPR_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
NONE	NONE, RESEED_ONLY, PR_AND_RESEED
RESEED_ONLY	RESEED_ONLY, PR_AND_RESEED
PR_AND_RESEED	PR_AND_RESEED
A DRBG implementation supporting prediction resistance must also support reseeding.
Since:
9

• • Enum Constant Summary

  Enum Constants

  Enum Constant	Description
  NONE	Neither prediction resistance nor reseed.
  PR_AND_RESEED	Both prediction resistance and reseed.
  RESEED_ONLY	Reseed but no prediction resistance.

  • Method Summary

  All Methods Static Methods Instance Methods Concrete Methods

  Modifier and Type	Method	Description
  boolean	supportsPredictionResistance​()	Returns whether this capability supports prediction resistance.
  boolean	supportsReseeding​()	Returns whether this capability supports reseeding.
  String	toString​()	Returns the name of this enum constant, as contained in the declaration.
  static DrbgParameters.Capability	valueOf​(String name)	Returns the enum constant of this type with the specified name.
  static DrbgParameters.Capability[]	values​()	Returns an array containing the constants of this enum type, in the order they are declared.

     * ### Methods inherited from class java.lang.[Enum](../../java/lang/Enum.html "class in java.lang")  
     `[clone](../../java/lang/Enum.html#clone--), [compareTo](../../java/lang/Enum.html#compareTo-E-), [equals](../../java/lang/Enum.html#equals-java.lang.Object-), [finalize](../../java/lang/Enum.html#finalize--), [getDeclaringClass](../../java/lang/Enum.html#getDeclaringClass--), [hashCode](../../java/lang/Enum.html#hashCode--), [name](../../java/lang/Enum.html#name--), [ordinal](../../java/lang/Enum.html#ordinal--), [valueOf](../../java/lang/Enum.html#valueOf-java.lang.Class-java.lang.String-)`  
     * ### Methods inherited from class java.lang.[Object](../../java/lang/Object.html "class in java.lang")  
     `[getClass](../../java/lang/Object.html#getClass--), [notify](../../java/lang/Object.html#notify--), [notifyAll](../../java/lang/Object.html#notifyAll--), [wait](../../java/lang/Object.html#wait--), [wait](../../java/lang/Object.html#wait-long-), [wait](../../java/lang/Object.html#wait-long-int-)`

• • Enum Constant Detail

     * #### PR\_AND\_RESEED  
     public static final [DrbgParameters.Capability](../../java/security/DrbgParameters.Capability.html "enum in java.security") PR_AND_RESEED  
     Both prediction resistance and reseed.  
     * #### RESEED\_ONLY  
     public static final [DrbgParameters.Capability](../../java/security/DrbgParameters.Capability.html "enum in java.security") RESEED_ONLY  
     Reseed but no prediction resistance.  
     * #### NONE  
     public static final [DrbgParameters.Capability](../../java/security/DrbgParameters.Capability.html "enum in java.security") NONE  
     Neither prediction resistance nor reseed.  

  • Method Detail

    * #### values  
    public static [DrbgParameters.Capability](../../java/security/DrbgParameters.Capability.html "enum in java.security")[] values​()  
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:  
    for (DrbgParameters.Capability c : DrbgParameters.Capability.values())  
        System.out.println(c);  
    Returns:  
    an array containing the constants of this enum type, in the order they are declared  
    * #### valueOf  
    public static [DrbgParameters.Capability](../../java/security/DrbgParameters.Capability.html "enum in java.security") valueOf​([String](../../java/lang/String.html "class in java.lang") 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](../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if this enum type has no constant with the specified name  
    `[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang")` \- if the argument is null  
    * #### toString  
    public [String](../../java/lang/String.html "class in java.lang") toString​()  
    Description copied from class: `[Enum](../../java/lang/Enum.html#toString--)`  
    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](../../java/lang/Enum.html#toString--)` in class `[Enum](../../java/lang/Enum.html "class in java.lang")<[DrbgParameters.Capability](../../java/security/DrbgParameters.Capability.html "enum in java.security")>`  
    Returns:  
    the name of this enum constant  
    * #### supportsReseeding  
    public boolean supportsReseeding​()  
    Returns whether this capability supports reseeding.  
    Returns:  
    `true` for [PR\_AND\_RESEED](../../java/security/DrbgParameters.Capability.html#PR%5FAND%5FRESEED) and[RESEED\_ONLY](../../java/security/DrbgParameters.Capability.html#RESEED%5FONLY), and `false` for [NONE](../../java/security/DrbgParameters.Capability.html#NONE)  
    * #### supportsPredictionResistance  
    public boolean supportsPredictionResistance​()  
    Returns whether this capability supports prediction resistance.  
    Returns:  
    `true` for [PR\_AND\_RESEED](../../java/security/DrbgParameters.Capability.html#PR%5FAND%5FRESEED), and `false` for [RESEED\_ONLY](../../java/security/DrbgParameters.Capability.html#RESEED%5FONLY) and [NONE](../../java/security/DrbgParameters.Capability.html#NONE)

Report a bug or suggest an enhancement
For further API reference and developer documentation see the Java SE Documentation, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples.
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2017, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
All rights reserved. Use is subject to license terms and the documentation redistribution policy.