Merge "Update Javadocs: all new features supported for asymmetric crypto." into mnc-dev

This commit is contained in:
Alex Klyubin
2015-06-12 00:26:07 +00:00
committed by Android (Google) Code Review
2 changed files with 0 additions and 50 deletions

View File

@@ -449,9 +449,6 @@ public final class KeyGenParameterSpec implements AlgorithmParameterSpec {
* invalid signature. This is OK if the certificate is only used for obtaining the * invalid signature. This is OK if the certificate is only used for obtaining the
* public key from Android KeyStore. * public key from Android KeyStore.
* *
* <p><b>NOTE: The {@code purposes} parameter has currently no effect on asymmetric
* key pairs.</b>
*
* <p>See {@link KeyProperties}.{@code PURPOSE} flags. * <p>See {@link KeyProperties}.{@code PURPOSE} flags.
*/ */
public Builder(@NonNull String keystoreAlias, @KeyProperties.PurposeEnum int purposes) { public Builder(@NonNull String keystoreAlias, @KeyProperties.PurposeEnum int purposes) {
@@ -556,8 +553,6 @@ public final class KeyGenParameterSpec implements AlgorithmParameterSpec {
* *
* <p>By default, the key is valid at any instant. * <p>By default, the key is valid at any instant.
* *
* <p><b>NOTE: This has currently no effect on asymmetric key pairs.</b>
*
* @see #setKeyValidityEnd(Date) * @see #setKeyValidityEnd(Date)
*/ */
@NonNull @NonNull
@@ -571,8 +566,6 @@ public final class KeyGenParameterSpec implements AlgorithmParameterSpec {
* *
* <p>By default, the key is valid at any instant. * <p>By default, the key is valid at any instant.
* *
* <p><b>NOTE: This has currently no effect on asymmetric key pairs.</b>
*
* @see #setKeyValidityStart(Date) * @see #setKeyValidityStart(Date)
* @see #setKeyValidityForConsumptionEnd(Date) * @see #setKeyValidityForConsumptionEnd(Date)
* @see #setKeyValidityForOriginationEnd(Date) * @see #setKeyValidityForOriginationEnd(Date)
@@ -589,8 +582,6 @@ public final class KeyGenParameterSpec implements AlgorithmParameterSpec {
* *
* <p>By default, the key is valid at any instant. * <p>By default, the key is valid at any instant.
* *
* <p><b>NOTE: This has currently no effect on asymmetric key pairs.</b>
*
* @see #setKeyValidityForConsumptionEnd(Date) * @see #setKeyValidityForConsumptionEnd(Date)
*/ */
@NonNull @NonNull
@@ -605,8 +596,6 @@ public final class KeyGenParameterSpec implements AlgorithmParameterSpec {
* *
* <p>By default, the key is valid at any instant. * <p>By default, the key is valid at any instant.
* *
* <p><b>NOTE: This has currently no effect on asymmetric key pairs.</b>
*
* @see #setKeyValidityForOriginationEnd(Date) * @see #setKeyValidityForOriginationEnd(Date)
*/ */
@NonNull @NonNull
@@ -624,8 +613,6 @@ public final class KeyGenParameterSpec implements AlgorithmParameterSpec {
* keys, the set of digests defaults to the digest associated with the key algorithm (e.g., * keys, the set of digests defaults to the digest associated with the key algorithm (e.g.,
* {@code SHA-256} for key algorithm {@code HmacSHA256} * {@code SHA-256} for key algorithm {@code HmacSHA256}
* *
* <p><b>NOTE: This has currently no effect on asymmetric key pairs.</b>
*
* @see KeyProperties.Digest * @see KeyProperties.Digest
*/ */
@NonNull @NonNull
@@ -642,8 +629,6 @@ public final class KeyGenParameterSpec implements AlgorithmParameterSpec {
* *
* <p>This must be specified for keys which are used for encryption/decryption. * <p>This must be specified for keys which are used for encryption/decryption.
* *
* <p><b>NOTE: This has currently no effect on asymmetric key pairs.</b>
*
* <p>See {@link KeyProperties}.{@code ENCRYPTION_PADDING} constants. * <p>See {@link KeyProperties}.{@code ENCRYPTION_PADDING} constants.
*/ */
@NonNull @NonNull
@@ -660,8 +645,6 @@ public final class KeyGenParameterSpec implements AlgorithmParameterSpec {
* *
* <p>This must be specified for RSA keys which are used for signing/verification. * <p>This must be specified for RSA keys which are used for signing/verification.
* *
* <p><b>NOTE: This has currently no effect on asymmetric key pairs.</b>
*
* <p>See {@link KeyProperties}.{@code SIGNATURE_PADDING} constants. * <p>See {@link KeyProperties}.{@code SIGNATURE_PADDING} constants.
*/ */
@NonNull @NonNull
@@ -678,8 +661,6 @@ public final class KeyGenParameterSpec implements AlgorithmParameterSpec {
* *
* <p>This must be specified for encryption/decryption keys. * <p>This must be specified for encryption/decryption keys.
* *
* <p><b>NOTE: This has currently no effect on asymmetric key pairs.</b>
*
* <p>See {@link KeyProperties}.{@code BLOCK_MODE} constants. * <p>See {@link KeyProperties}.{@code BLOCK_MODE} constants.
*/ */
@NonNull @NonNull
@@ -723,8 +704,6 @@ public final class KeyGenParameterSpec implements AlgorithmParameterSpec {
* <li>If you are using RSA encryption without padding, consider switching to encryption * <li>If you are using RSA encryption without padding, consider switching to encryption
* padding schemes which offer {@code IND-CPA}, such as PKCS#1 or OAEP.</li> * padding schemes which offer {@code IND-CPA}, such as PKCS#1 or OAEP.</li>
* </ul> * </ul>
*
* <p><b>NOTE: This has currently no effect on asymmetric key pairs.</b>
*/ */
@NonNull @NonNull
public Builder setRandomizedEncryptionRequired(boolean required) { public Builder setRandomizedEncryptionRequired(boolean required) {
@@ -748,8 +727,6 @@ public final class KeyGenParameterSpec implements AlgorithmParameterSpec {
* <p>This restriction applies only to private key operations. Public key operations are not * <p>This restriction applies only to private key operations. Public key operations are not
* restricted. * restricted.
* *
* <p><b>NOTE: This has currently no effect on asymmetric key pairs.</b>
*
* @see #setUserAuthenticationValidityDurationSeconds(int) * @see #setUserAuthenticationValidityDurationSeconds(int)
*/ */
@NonNull @NonNull
@@ -764,8 +741,6 @@ public final class KeyGenParameterSpec implements AlgorithmParameterSpec {
* *
* <p>By default, the user needs to authenticate for every use of the key. * <p>By default, the user needs to authenticate for every use of the key.
* *
* <p><b>NOTE: This has currently no effect on asymmetric key pairs.</b>
*
* @param seconds duration in seconds or {@code -1} if the user needs to authenticate for * @param seconds duration in seconds or {@code -1} if the user needs to authenticate for
* every use of the key. * every use of the key.
* *

View File

@@ -305,9 +305,6 @@ public final class KeyProtection implements ProtectionParameter {
* @param purposes set of purposes (e.g., encrypt, decrypt, sign) for which the key can be * @param purposes set of purposes (e.g., encrypt, decrypt, sign) for which the key can be
* used. Attempts to use the key for any other purpose will be rejected. * used. Attempts to use the key for any other purpose will be rejected.
* *
* <p><b>NOTE: The {@code purposes} parameter has currently no effect on asymmetric
* key pairs.</b>
*
* <p>See {@link KeyProperties}.{@code PURPOSE} flags. * <p>See {@link KeyProperties}.{@code PURPOSE} flags.
*/ */
public Builder(@KeyProperties.PurposeEnum int purposes) { public Builder(@KeyProperties.PurposeEnum int purposes) {
@@ -319,8 +316,6 @@ public final class KeyProtection implements ProtectionParameter {
* *
* <p>By default, the key is valid at any instant. * <p>By default, the key is valid at any instant.
* *
* <p><b>NOTE: This has currently no effect on asymmetric key pairs.</b>
*
* @see #setKeyValidityEnd(Date) * @see #setKeyValidityEnd(Date)
*/ */
@NonNull @NonNull
@@ -334,8 +329,6 @@ public final class KeyProtection implements ProtectionParameter {
* *
* <p>By default, the key is valid at any instant. * <p>By default, the key is valid at any instant.
* *
* <p><b>NOTE: This has currently no effect on asymmetric key pairs.</b>
*
* @see #setKeyValidityStart(Date) * @see #setKeyValidityStart(Date)
* @see #setKeyValidityForConsumptionEnd(Date) * @see #setKeyValidityForConsumptionEnd(Date)
* @see #setKeyValidityForOriginationEnd(Date) * @see #setKeyValidityForOriginationEnd(Date)
@@ -352,8 +345,6 @@ public final class KeyProtection implements ProtectionParameter {
* *
* <p>By default, the key is valid at any instant. * <p>By default, the key is valid at any instant.
* *
* <p><b>NOTE: This has currently no effect on asymmetric key pairs.</b>
*
* @see #setKeyValidityForConsumptionEnd(Date) * @see #setKeyValidityForConsumptionEnd(Date)
*/ */
@NonNull @NonNull
@@ -368,8 +359,6 @@ public final class KeyProtection implements ProtectionParameter {
* *
* <p>By default, the key is valid at any instant. * <p>By default, the key is valid at any instant.
* *
* <p><b>NOTE: This has currently no effect on asymmetric key pairs.</b>
*
* @see #setKeyValidityForOriginationEnd(Date) * @see #setKeyValidityForOriginationEnd(Date)
*/ */
@NonNull @NonNull
@@ -385,8 +374,6 @@ public final class KeyProtection implements ProtectionParameter {
* *
* <p>This must be specified for keys which are used for encryption/decryption. * <p>This must be specified for keys which are used for encryption/decryption.
* *
* <p><b>NOTE: This has currently no effect on asymmetric key pairs.</b>
*
* <p>See {@link KeyProperties}.{@code ENCRYPTION_PADDING} constants. * <p>See {@link KeyProperties}.{@code ENCRYPTION_PADDING} constants.
*/ */
@NonNull @NonNull
@@ -403,8 +390,6 @@ public final class KeyProtection implements ProtectionParameter {
* *
* <p>This must be specified for RSA keys which are used for signing/verification. * <p>This must be specified for RSA keys which are used for signing/verification.
* *
* <p><b>NOTE: This has currently no effect on asymmetric key pairs.</b>
*
* <p>See {@link KeyProperties}.{@code SIGNATURE_PADDING} constants. * <p>See {@link KeyProperties}.{@code SIGNATURE_PADDING} constants.
*/ */
@NonNull @NonNull
@@ -423,8 +408,6 @@ public final class KeyProtection implements ProtectionParameter {
* {@link Key#getAlgorithm()}. For asymmetric signing keys the set of digest algorithms * {@link Key#getAlgorithm()}. For asymmetric signing keys the set of digest algorithms
* must be specified. * must be specified.
* *
* <p><b>NOTE: This has currently no effect on asymmetric key pairs.</b>
*
* <p>See {@link KeyProperties}.{@code DIGEST} constants. * <p>See {@link KeyProperties}.{@code DIGEST} constants.
*/ */
@NonNull @NonNull
@@ -440,8 +423,6 @@ public final class KeyProtection implements ProtectionParameter {
* *
* <p>This must be specified for encryption/decryption keys. * <p>This must be specified for encryption/decryption keys.
* *
* <p><b>NOTE: This has currently no effect on asymmetric key pairs.</b>
*
* <p>See {@link KeyProperties}.{@code BLOCK_MODE} constants. * <p>See {@link KeyProperties}.{@code BLOCK_MODE} constants.
*/ */
@NonNull @NonNull
@@ -483,8 +464,6 @@ public final class KeyProtection implements ProtectionParameter {
* <li>If you are using RSA encryption without padding, consider switching to padding * <li>If you are using RSA encryption without padding, consider switching to padding
* schemes which offer {@code IND-CPA}, such as PKCS#1 or OAEP.</li> * schemes which offer {@code IND-CPA}, such as PKCS#1 or OAEP.</li>
* </ul> * </ul>
*
* <p><b>NOTE: This has currently no effect on asymmetric key pairs.</b>
*/ */
@NonNull @NonNull
public Builder setRandomizedEncryptionRequired(boolean required) { public Builder setRandomizedEncryptionRequired(boolean required) {
@@ -505,8 +484,6 @@ public final class KeyProtection implements ProtectionParameter {
* <a href="{@docRoot}training/articles/keystore.html#UserAuthentication">More * <a href="{@docRoot}training/articles/keystore.html#UserAuthentication">More
* information</a>. * information</a>.
* *
* <p><b>NOTE: This has currently no effect on asymmetric key pairs.</b>
*
* @see #setUserAuthenticationValidityDurationSeconds(int) * @see #setUserAuthenticationValidityDurationSeconds(int)
*/ */
@NonNull @NonNull
@@ -521,8 +498,6 @@ public final class KeyProtection implements ProtectionParameter {
* *
* <p>By default, the user needs to authenticate for every use of the key. * <p>By default, the user needs to authenticate for every use of the key.
* *
* <p><b>NOTE: This has currently no effect on asymmetric key pairs.</b>
*
* @param seconds duration in seconds or {@code -1} if the user needs to authenticate for * @param seconds duration in seconds or {@code -1} if the user needs to authenticate for
* every use of the key. * every use of the key.
* *