1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
|
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.commons.io.input;
import java.io.IOException;
import java.io.InputStream;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import java.util.Objects;
import org.apache.commons.io.build.AbstractStreamBuilder;
/**
* This class is an example for using an {@link ObservableInputStream}. It creates its own {@link org.apache.commons.io.input.ObservableInputStream.Observer},
* which calculates a checksum using a {@link MessageDigest}, for example, a SHA-512 sum.
* <p>
* To build an instance, see {@link Builder}.
* </p>
* <p>
* See the MessageDigest section in the <a href= "https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#MessageDigest"> Java
* Cryptography Architecture Standard Algorithm Name Documentation</a> for information about standard algorithm names.
* </p>
* <p>
* You must specify a message digest algorithm name or instance.
* </p>
* <p>
* <em>Note</em>: Neither {@link ObservableInputStream}, nor {@link MessageDigest}, are thread safe, so is {@link MessageDigestInputStream}.
* </p>
*
* @since 2.15.0
*/
public final class MessageDigestInputStream extends ObservableInputStream {
/**
* Builds new {@link MessageDigestInputStream} instances.
* <p>
* For example:
* </p>
* <pre>{@code
* MessageDigestInputStream s = MessageDigestInputStream.builder()
* .setPath(path)
* .setMessageDigest("SHA-512")
* .get();}
* </pre>
* <p>
* You must specify a message digest algorithm name or instance.
* </p>
*/
public static class Builder extends AbstractStreamBuilder<MessageDigestInputStream, Builder> {
private MessageDigest messageDigest;
/**
* Constructs a new Builder.
*/
public Builder() {
// empty
}
/**
* Constructs a new instance.
* <p>
* This builder use the aspects InputStream, OpenOption[], and MessageDigest.
* </p>
* <p>
* You must provide an origin that can be converted to an InputStream by this builder, otherwise, this call will throw an
* {@link UnsupportedOperationException}.
* </p>
*
* @return a new instance.
* @throws UnsupportedOperationException if the origin cannot provide an InputStream.
* @see #getInputStream()
*/
@SuppressWarnings("resource")
@Override
public MessageDigestInputStream get() throws IOException {
return new MessageDigestInputStream(getInputStream(), messageDigest);
}
/**
* Sets the message digest.
* <p>
* The MD5 cryptographic algorithm is weak and should not be used.
* </p>
*
* @param messageDigest the message digest.
* @return this
*/
public Builder setMessageDigest(final MessageDigest messageDigest) {
this.messageDigest = messageDigest;
return this;
}
/**
* Sets the name of the name of the message digest algorithm.
* <p>
* The MD5 cryptographic algorithm is weak and should not be used.
* </p>
*
* @param algorithm the name of the algorithm. See the MessageDigest section in the
* <a href= "https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#MessageDigest"> Java Cryptography
* Architecture Standard Algorithm Name Documentation</a> for information about standard algorithm names.
* @return this
* @throws NoSuchAlgorithmException if no Provider supports a MessageDigestSpi implementation for the specified algorithm.
*/
public Builder setMessageDigest(final String algorithm) throws NoSuchAlgorithmException {
this.messageDigest = MessageDigest.getInstance(algorithm);
return this;
}
}
/**
* Maintains the message digest.
*/
public static class MessageDigestMaintainingObserver extends Observer {
private final MessageDigest messageDigest;
/**
* Constructs an MessageDigestMaintainingObserver for the given MessageDigest.
*
* @param messageDigest the message digest to use
* @throws NullPointerException if messageDigest is null.
*/
public MessageDigestMaintainingObserver(final MessageDigest messageDigest) {
this.messageDigest = Objects.requireNonNull(messageDigest, "messageDigest");
}
@Override
public void data(final byte[] input, final int offset, final int length) throws IOException {
messageDigest.update(input, offset, length);
}
@Override
public void data(final int input) throws IOException {
messageDigest.update((byte) input);
}
}
/**
* Constructs a new {@link Builder}.
*
* @return a new {@link Builder}.
*/
public static Builder builder() {
return new Builder();
}
private final MessageDigest messageDigest;
/**
* Constructs a new instance, which calculates a signature on the given stream, using the given {@link MessageDigest}.
* <p>
* The MD5 cryptographic algorithm is weak and should not be used.
* </p>
*
* @param inputStream the stream to calculate the message digest for
* @param messageDigest the message digest to use
* @throws NullPointerException if messageDigest is null.
*/
private MessageDigestInputStream(final InputStream inputStream, final MessageDigest messageDigest) {
super(inputStream, new MessageDigestMaintainingObserver(messageDigest));
this.messageDigest = messageDigest;
}
/**
* Gets the {@link MessageDigest}, which is being used for generating the checksum.
* <p>
* <em>Note</em>: The checksum will only reflect the data, which has been read so far. This is probably not, what you expect. Make sure, that the complete
* data has been read, if that is what you want. The easiest way to do so is by invoking {@link #consume()}.
* </p>
*
* @return the message digest used
*/
public MessageDigest getMessageDigest() {
return messageDigest;
}
}
|
