Skip to content

Commit

Permalink
4964430: (spec) missing IllegalStateException exception requirement f…
Browse files Browse the repository at this point in the history 
…or javax.crypto.Cipher.doFinal

Reviewed-by: mullan, valeriep
  • Loading branch information
@blperez01
blperez01 authored and Valerie Peng committed Oct 6, 2023
1 parent 8a30c2a commit 991ce84
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 32 deletions.
75 changes: 45 additions & 30 deletions src/java.base/share/classes/javax/crypto/Cipher.java
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 1997, 2022, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1997, 2023, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
Expand Down Expand Up @@ -1815,8 +1815,8 @@ public final void init(int opmode, Certificate certificate,

/**
* Ensures that {@code Cipher} object is in a valid state for update() and
* doFinal() calls - should be initialized and in ENCRYPT_MODE or
* DECRYPT_MODE.
* doFinal() calls - should be initialized and in {@code ENCRYPT_MODE} or
* {@code DECRYPT_MODE}.
* @throws IllegalStateException if this {@code Cipher} object is not in
* valid state
*/
Expand Down Expand Up @@ -1851,7 +1851,8 @@ private void checkCipherState() {
* new block
*
* @throws IllegalStateException if this {@code Cipher} object is in a
* wrong state (e.g., has not been initialized)
* wrong state (e.g., has not been initialized, or is not
* in {@code ENCRYPT_MODE} or {@code DECRYPT_MODE})
*/
public final byte[] update(byte[] input) {
checkCipherState();
Expand Down Expand Up @@ -1890,7 +1891,8 @@ public final byte[] update(byte[] input) {
* new block.
*
* @throws IllegalStateException if this {@code Cipher} object
* is in a wrong state (e.g., has not been initialized)
* is in a wrong state (e.g., has not been initialized, or is not
* in {@code ENCRYPT_MODE} or {@code DECRYPT_MODE})
*/
public final byte[] update(byte[] input, int inputOffset, int inputLen) {
checkCipherState();
Expand Down Expand Up @@ -1940,7 +1942,8 @@ public final byte[] update(byte[] input, int inputOffset, int inputLen) {
* @return the number of bytes stored in {@code output}
*
* @throws IllegalStateException if this {@code Cipher} object
* is in a wrong state (e.g., has not been initialized)
* is in a wrong state (e.g., has not been initialized, or is not
* in {@code ENCRYPT_MODE} or {@code DECRYPT_MODE})
* @throws ShortBufferException if the given output buffer is too small
* to hold the result
*/
Expand Down Expand Up @@ -1998,7 +2001,8 @@ public final int update(byte[] input, int inputOffset, int inputLen,
* @return the number of bytes stored in {@code output}
*
* @throws IllegalStateException if this {@code Cipher} object
* is in a wrong state (e.g., has not been initialized)
* is in a wrong state (e.g., has not been initialized, or is not
* in {@code ENCRYPT_MODE} or {@code DECRYPT_MODE})
* @throws ShortBufferException if the given output buffer is too small
* to hold the result
*/
Expand Down Expand Up @@ -2052,7 +2056,8 @@ public final int update(byte[] input, int inputOffset, int inputLen,
* @return the number of bytes stored in {@code output}
*
* @throws IllegalStateException if this {@code Cipher} object
* is in a wrong state (e.g., has not been initialized)
* is in a wrong state (e.g., has not been initialized, or is not
* in {@code ENCRYPT_MODE} or {@code DECRYPT_MODE})
* @throws IllegalArgumentException if input and output are the
* same object
* @throws ReadOnlyBufferException if the output buffer is read-only
Expand Down Expand Up @@ -2104,7 +2109,8 @@ public final int update(ByteBuffer input, ByteBuffer output)
* @return the new buffer with the result
*
* @throws IllegalStateException if this {@code Cipher} object
* is in a wrong state (e.g., has not been initialized)
* is in a wrong state (e.g., has not been initialized, or is not
* in {@code ENCRYPT_MODE} or {@code DECRYPT_MODE})
* @throws IllegalBlockSizeException if this cipher is a block cipher,
* no padding has been requested (only in encryption mode), and the total
* input length of the data processed by this cipher is not a multiple of
Expand Down Expand Up @@ -2161,7 +2167,8 @@ public final byte[] doFinal()
* @return the number of bytes stored in {@code output}
*
* @throws IllegalStateException if this {@code Cipher} object
* is in a wrong state (e.g., has not been initialized)
* is in a wrong state (e.g., has not been initialized, or is not
* in {@code ENCRYPT_MODE} or {@code DECRYPT_MODE})
* @throws IllegalBlockSizeException if this cipher is a block cipher,
* no padding has been requested (only in encryption mode), and the total
* input length of the data processed by this cipher is not a multiple of
Expand Down Expand Up @@ -2218,7 +2225,8 @@ public final int doFinal(byte[] output, int outputOffset)
* @return the new buffer with the result
*
* @throws IllegalStateException if this {@code Cipher} object
* is in a wrong state (e.g., has not been initialized)
* is in a wrong state (e.g., has not been initialized, or is not
* in {@code ENCRYPT_MODE} or {@code DECRYPT_MODE})
* @throws IllegalBlockSizeException if this cipher is a block cipher,
* no padding has been requested (only in encryption mode), and the total
* input length of the data processed by this cipher is not a multiple of
Expand Down Expand Up @@ -2276,7 +2284,8 @@ public final byte[] doFinal(byte[] input)
* @return the new buffer with the result
*
* @throws IllegalStateException if this {@code Cipher} object
* is in a wrong state (e.g., has not been initialized)
* is in a wrong state (e.g., has not been initialized, or is not
* in {@code ENCRYPT_MODE} or {@code DECRYPT_MODE})
* @throws IllegalBlockSizeException if this cipher is a block cipher,
* no padding has been requested (only in encryption mode), and the total
* input length of the data processed by this cipher is not a multiple of
Expand Down Expand Up @@ -2347,7 +2356,8 @@ public final byte[] doFinal(byte[] input, int inputOffset, int inputLen)
* @return the number of bytes stored in {@code output}
*
* @throws IllegalStateException if this {@code Cipher} object
* is in a wrong state (e.g., has not been initialized)
* is in a wrong state (e.g., has not been initialized, or is not
* in or {@code ENCRYPT_MODE} or {@code DECRYPT_MODE})
* @throws IllegalBlockSizeException if this cipher is a block cipher,
* no padding has been requested (only in encryption mode), and the total
* input length of the data processed by this cipher is not a multiple of
Expand Down Expand Up @@ -2427,7 +2437,8 @@ public final int doFinal(byte[] input, int inputOffset, int inputLen,
* @return the number of bytes stored in {@code output}
*
* @throws IllegalStateException if this {@code Cipher} object
* is in a wrong state (e.g., has not been initialized)
* is in a wrong state (e.g., has not been initialized, or is not
* in {@code ENCRYPT_MODE} or {@code DECRYPT_MODE})
* @throws IllegalBlockSizeException if this cipher is a block cipher,
* no padding has been requested (only in encryption mode), and the total
* input length of the data processed by this cipher is not a multiple of
Expand Down Expand Up @@ -2503,7 +2514,8 @@ public final int doFinal(byte[] input, int inputOffset, int inputLen,
* @return the number of bytes stored in {@code output}
*
* @throws IllegalStateException if this {@code Cipher} object
* is in a wrong state (e.g., has not been initialized)
* is in a wrong state (e.g., has not been initialized, or is not
* in {@code ENCRYPT_MODE} or {@code DECRYPT_MODE})
* @throws IllegalArgumentException if input and output are the
* same object
* @throws ReadOnlyBufferException if the output buffer is read-only
Expand Down Expand Up @@ -2551,7 +2563,7 @@ public final int doFinal(ByteBuffer input, ByteBuffer output)
* @return the wrapped key
*
* @throws IllegalStateException if this {@code Cipher} object is in a wrong
* state (e.g., has not been initialized)
* state (e.g., has not been initialized, or is not in {@code WRAP_MODE})
*
* @throws IllegalBlockSizeException if this cipher is a block
* cipher, no padding has been requested, and the length of the
Expand Down Expand Up @@ -2595,8 +2607,8 @@ public final byte[] wrap(Key key)
*
* @return the unwrapped key
*
* @throws IllegalStateException if this {@code Cipher} object
* is in a wrong state (e.g., has not been initialized)
* @throws IllegalStateException if this {@code Cipher} object is in a wrong
* state (e.g., has not been initialized, or is not in {@code UNWRAP_MODE})
*
* @throws NoSuchAlgorithmException if no installed providers
* can create keys of type {@code wrappedKeyType} for the
Expand Down Expand Up @@ -2732,10 +2744,11 @@ public static final AlgorithmParameterSpec getMaxAllowedParameterSpec(
* @throws IllegalArgumentException if the {@code src}
* byte array is {@code null}
* @throws IllegalStateException if this {@code Cipher} object
* is in a wrong state (e.g., has not been initialized),
* does not accept AAD, or if operating in either GCM or CCM mode and
* one of the {@code update} methods has already been called for the active
* encryption/decryption operation
* is in a wrong state (e.g., has not been initialized, or is not in
* {@code ENCRYPT_MODE} or {@code DECRYPT_MODE}), does not accept AAD,
* or if operating in either GCM or CCM mode and one of the {@code update}
* methods has already been called for the active encryption/decryption
* operation
* @throws UnsupportedOperationException if the corresponding method
* in the {@code CipherSpi} has not been overridden by an
* implementation
Expand Down Expand Up @@ -2770,10 +2783,11 @@ public final void updateAAD(byte[] src) {
* {@code len} is greater than the length of the
* {@code src} byte array
* @throws IllegalStateException if this {@code Cipher} object
* is in a wrong state (e.g., has not been initialized),
* does not accept AAD, or if operating in either GCM or CCM mode and
* one of the {@code update} methods has already been called for the active
* encryption/decryption operation
* is in a wrong state (e.g., has not been initialized, or is not in
* {@code ENCRYPT_MODE} or {@code DECRYPT_MODE}), does not accept AAD,
* or if operating in either GCM or CCM mode and one of the {@code update}
* methods has already been called for the active encryption/decryption
* operation
* @throws UnsupportedOperationException if the corresponding method
* in the {@code CipherSpi} has not been overridden by an
* implementation
Expand Down Expand Up @@ -2816,10 +2830,11 @@ public final void updateAAD(byte[] src, int offset, int len) {
* @throws IllegalArgumentException if the {@code src ByteBuffer}
* is {@code null}
* @throws IllegalStateException if this {@code Cipher} object
* is in a wrong state (e.g., has not been initialized),
* does not accept AAD, or if operating in either GCM or CCM mode and
* one of the {@code update} methods has already been called for the active
* encryption/decryption operation
* is in a wrong state (e.g., has not been initialized, or is not in
* {@code ENCRYPT_MODE} or {@code DECRYPT_MODE}), does not accept AAD,
* or if operating in either GCM or CCM mode and one of the {@code update}
* methods has already been called for the active encryption/decryption
* operation
* @throws UnsupportedOperationException if the corresponding method
* in the {@code CipherSpi} has not been overridden by an
* implementation
Expand Down
6 changes: 4 additions & 2 deletions src/java.base/share/classes/javax/crypto/NullCipher.java
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 1997, 2022, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1997, 2023, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
Expand Down Expand Up @@ -30,7 +30,9 @@
* "identity cipher" -- one that does not transform the plain text. As
* a consequence, the ciphertext is identical to the plaintext. All
* initialization methods do nothing, while the blocksize is set to 1
* byte.
* byte. Unlike other ciphers, the {@code NullCipher} has no state, and
* will never throw an {@code IllegalStateException} when {@code Cipher}
* methods are called.
*
* @author Li Gong
* @since 1.4
Expand Down

1 comment on commit 991ce84

@openjdk-notifier
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review

Issues

Please sign in to comment.