|
17 | 17 |
|
18 | 18 | import java.security.MessageDigest;
|
19 | 19 | import java.security.NoSuchAlgorithmException;
|
| 20 | +import java.util.Deque; |
| 21 | +import java.util.concurrent.LinkedBlockingDeque; |
| 22 | +import java.util.function.Supplier; |
20 | 23 | import software.amazon.awssdk.annotations.SdkInternalApi;
|
| 24 | +import software.amazon.awssdk.annotations.SdkTestInternalApi; |
| 25 | +import software.amazon.awssdk.utils.SdkAutoCloseable; |
21 | 26 |
|
22 | 27 | @SdkInternalApi
|
23 | 28 | public enum DigestAlgorithm {
|
24 |
| - |
25 | 29 | SHA1("SHA-1"),
|
| 30 | + |
26 | 31 | MD5("MD5"),
|
27 | 32 | SHA256("SHA-256")
|
28 | 33 | ;
|
29 | 34 |
|
| 35 | + private static final Supplier<MessageDigest> CLOSED_DIGEST = () -> { |
| 36 | + throw new IllegalStateException("This message digest is closed."); |
| 37 | + }; |
| 38 | + |
| 39 | + private static final int MAX_CACHED_DIGESTS = 10_000; |
30 | 40 | private final String algorithmName;
|
31 |
| - private final DigestThreadLocal digestReference; |
| 41 | + private final Deque<MessageDigest> digestCache = new LinkedBlockingDeque<>(MAX_CACHED_DIGESTS); // LIFO |
32 | 42 |
|
33 | 43 | DigestAlgorithm(String algorithmName) {
|
34 | 44 | this.algorithmName = algorithmName;
|
35 |
| - digestReference = new DigestThreadLocal(algorithmName); |
36 | 45 | }
|
37 | 46 |
|
38 | 47 | public String getAlgorithmName() {
|
39 | 48 | return algorithmName;
|
40 | 49 | }
|
41 | 50 |
|
42 | 51 | /**
|
43 |
| - * Returns the thread local reference for the {@link MessageDigest} algorithm |
| 52 | + * Returns a {@link CloseableMessageDigest} to use for this algorithm. |
44 | 53 | */
|
45 |
| - public MessageDigest getDigest() { |
46 |
| - MessageDigest digest = digestReference.get(); |
47 |
| - digest.reset(); |
48 |
| - return digest; |
| 54 | + public CloseableMessageDigest getDigest() { |
| 55 | + MessageDigest digest = digestCache.pollFirst(); |
| 56 | + if (digest != null) { |
| 57 | + digest.reset(); |
| 58 | + return new CloseableMessageDigest(digest); |
| 59 | + } |
| 60 | + return new CloseableMessageDigest(newDigest()); |
49 | 61 | }
|
50 | 62 |
|
51 |
| - private static class DigestThreadLocal extends ThreadLocal<MessageDigest> { |
52 |
| - private final String algorithmName; |
| 63 | + private MessageDigest newDigest() { |
| 64 | + try { |
| 65 | + return MessageDigest.getInstance(algorithmName); |
| 66 | + } catch (NoSuchAlgorithmException e) { |
| 67 | + throw new RuntimeException("Unable to fetch message digest instance for Algorithm " |
| 68 | + + algorithmName + ": " + e.getMessage(), e); |
| 69 | + } |
| 70 | + } |
| 71 | + |
| 72 | + @SdkTestInternalApi |
| 73 | + static void clearCaches() { |
| 74 | + for (DigestAlgorithm value : values()) { |
| 75 | + value.digestCache.clear(); |
| 76 | + } |
| 77 | + } |
| 78 | + |
| 79 | + public final class CloseableMessageDigest implements SdkAutoCloseable, Cloneable { |
| 80 | + |
| 81 | + private Supplier<MessageDigest> digest; |
| 82 | + private byte[] messageDigest; |
| 83 | + |
| 84 | + private CloseableMessageDigest(MessageDigest digest) { |
| 85 | + this.digest = () -> digest; |
| 86 | + } |
| 87 | + |
| 88 | + /** |
| 89 | + * Retrieve the message digest instance. |
| 90 | + */ |
| 91 | + public MessageDigest messageDigest() { |
| 92 | + return digest.get(); |
| 93 | + } |
| 94 | + |
| 95 | + /** |
| 96 | + * Retrieve the message digest bytes. This will close the message digest when invoked. This is because the underlying |
| 97 | + * message digest is reset on read, and we'd rather fail future interactions with the digest than act on the wrong data. |
| 98 | + */ |
| 99 | + public byte[] digest() { |
| 100 | + if (messageDigest != null) { |
| 101 | + return messageDigest; |
| 102 | + } |
| 103 | + messageDigest = messageDigest().digest(); |
| 104 | + close(); |
| 105 | + return messageDigest; |
| 106 | + } |
| 107 | + |
| 108 | + /** |
| 109 | + * Release this message digest back to the cache. Once released, you must not use the digest anymore. |
| 110 | + */ |
| 111 | + @Override |
| 112 | + public void close() { |
| 113 | + if (digest == CLOSED_DIGEST) { |
| 114 | + return; |
| 115 | + } |
| 116 | + |
| 117 | + // Drop this digest is the cache is full. |
| 118 | + digestCache.offerFirst(digest.get()); |
53 | 119 |
|
54 |
| - DigestThreadLocal(String algorithmName) { |
55 |
| - this.algorithmName = algorithmName; |
| 120 | + digest = CLOSED_DIGEST; |
56 | 121 | }
|
57 | 122 |
|
58 | 123 | @Override
|
59 |
| - protected MessageDigest initialValue() { |
| 124 | + public CloseableMessageDigest clone() { |
60 | 125 | try {
|
61 |
| - return MessageDigest.getInstance(algorithmName); |
62 |
| - } catch (NoSuchAlgorithmException e) { |
63 |
| - throw new RuntimeException("Unable to fetch message digest instance for Algorithm " |
64 |
| - + algorithmName + ": " + e.getMessage(), e); |
| 126 | + return new CloseableMessageDigest((MessageDigest) digest.get().clone()); |
| 127 | + } catch (CloneNotSupportedException e) { |
| 128 | + throw new IllegalStateException("Clone was not supported by this digest type.", e); |
65 | 129 | }
|
66 | 130 | }
|
67 | 131 | }
|
|
0 commit comments