archive/jdk
1
0
Fork 0
mirror of https://github.com/openjdk/jdk.git synced 2025-08-27 06:45:07 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

8182484: Remove 1024-bit default requirement from javadoc of java.security.interfaces.DSAKeyPairGenerator

Browse source 
Updated javadoc to remove the text of using 1024 as the default key size

Reviewed-by: mullan
This commit is contained in:
Valerie Peng 2017-11-29 00:43:59 +00:00
parent 93438246bc
commit 4c7e794ad9
1 changed files with 14 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

25
src/java.base/share/classes/java/security/interfaces/DSAKeyPairGenerator.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 1997, 2017, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -32,9 +32,12 @@ import java.security.*;
* *
* <p>The {@code initialize} methods may each be called any number * <p>The {@code initialize} methods may each be called any number
* of times. If no {@code initialize} method is called on a * of times. If no {@code initialize} method is called on a
* DSAKeyPairGenerator, the default is to generate 1024-bit keys, using * DSAKeyPairGenerator, each provider that implements this interface
* precomputed p, q and g parameters and an instance of SecureRandom as * should supply (and document) a default initialization. Note that
* the random bit source. * defaults may vary across different providers. Additionally, the default
* value for a provider may change in a future version. Therefore, it is
* recommended to explicitly initialize the DSAKeyPairGenerator instead
* of relying on provider-specific defaults.
* *
* <p>Users wishing to indicate DSA-specific parameters, and to generate a key * <p>Users wishing to indicate DSA-specific parameters, and to generate a key
* pair suitable for use with the DSA algorithm typically * pair suitable for use with the DSA algorithm typically
@ -45,12 +48,13 @@ import java.security.*;
* KeyPairGenerator {@code getInstance} method with "DSA" * KeyPairGenerator {@code getInstance} method with "DSA"
* as its argument. * as its argument.
* *
* <li>Initialize the generator by casting the result to a DSAKeyPairGenerator * <li>Check if the returned key pair generator is an instance of
* and calling one of the * DSAKeyPairGenerator before casting the result to a DSAKeyPairGenerator
* {@code initialize} methods from this DSAKeyPairGenerator interface. * and calling one of the {@code initialize} methods from this
* DSAKeyPairGenerator interface.
* *
* <li>Generate a key pair by calling the {@code generateKeyPair} * <li>Generate a key pair by calling the {@code generateKeyPair}
* method from the KeyPairGenerator class. * method of the KeyPairGenerator class.
* *
* </ol> * </ol>
* *
@ -63,7 +67,7 @@ import java.security.*;
* parameters. * parameters.
* *
* <p>Note: Some earlier implementations of this interface may not support * <p>Note: Some earlier implementations of this interface may not support
* larger sizes of DSA parameters such as 2048 and 3072-bit. * larger values of DSA parameters such as 3072-bit.
* *
* @since 1.1 * @since 1.1
* @see java.security.KeyPairGenerator * @see java.security.KeyPairGenerator
@ -97,8 +101,7 @@ public interface DSAKeyPairGenerator {
* p, q and g parameters. If it is false, the method uses precomputed * p, q and g parameters. If it is false, the method uses precomputed
* parameters for the modulus length requested. If there are no * parameters for the modulus length requested. If there are no
* precomputed parameters for that modulus length, an exception will be * precomputed parameters for that modulus length, an exception will be
* thrown. It is guaranteed that there will always be * thrown.
* default parameters for modulus lengths of 512 and 1024 bits.
* *
* @param modlen the modulus length in bits. Valid values are any * @param modlen the modulus length in bits. Valid values are any
* multiple of 64 between 512 and 1024, inclusive, 2048, and 3072. * multiple of 64 between 512 and 1024, inclusive, 2048, and 3072.