org.apache.commons.crypto.stream.output.StreamOutput Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of commons-crypto Show documentation
Show all versions of commons-crypto Show documentation
Apache Commons Crypto is a cryptographic library optimized with AES-NI (Advanced Encryption
Standard New Instructions). It provides Java API for both cipher level and Java stream level.
Developers can use it to implement high performance AES encryption/decryption with the minimum
code and effort. Please note that Crypto doesn't implement the cryptographic algorithm such as
AES directly. It wraps to Openssl or JCE which implement the algorithms.
Features
--------
1. Cipher API for low level cryptographic operations.
2. Java stream API (CryptoInputStream/CryptoOutputStream) for high level stream encyrption/decryption.
3. Both optimized with high performance AES encryption/decryption. (1400 MB/s - 1700 MB/s throughput in modern Xeon processors).
4. JNI-based implementation to achieve comparable performance to the native C++ version based on OpenSsl.
5. Portable across various operating systems (currently only Linux/MacOSX/Windows);
Apache Commons Crypto loads the library according to your machine environment (it checks system properties, `os.name` and `os.arch`).
6. Simple usage. Add the commons-crypto-(version).jar file to your classpath.
Export restrictions
-------------------
This distribution includes cryptographic software.
The country in which you currently reside may have restrictions
on the import, possession, use, and/or re-export to another country,
of encryption software. BEFORE using any encryption software,
please check your country's laws, regulations and policies
concerning the import, possession, or use, and re-export of
encryption software, to see if this is permitted.
See <http://www.wassenaar.org/> for more information.
The U.S. Government Department of Commerce, Bureau of Industry and Security (BIS),
has classified this software as Export Commodity Control Number (ECCN) 5D002.C.1,
which includes information security software using or performing
cryptographic functions with asymmetric algorithms.
The form and manner of this Apache Software Foundation distribution makes
it eligible for export under the License Exception
ENC Technology Software Unrestricted (TSU) exception
(see the BIS Export Administration Regulations, Section 740.13)
for both object code and source code.
The following provides more details on the included cryptographic software:
* Commons Crypto use [Java Cryptography Extension](http://docs.oracle.com/javase/8/docs/technotes/guides/security/crypto/CryptoSpec.html) provided by Java
* Commons Crypto link to and use [OpenSSL](https://www.openssl.org/) ciphers
/**
* 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.crypto.stream.output;
import java.io.IOException;
import java.io.OutputStream;
import java.nio.ByteBuffer;
/**
* The StreamOutput class takes a OutputStream object and wraps it
* as Output object acceptable by CryptoOutputStream
* as the output target.
*/
public class StreamOutput implements Output {
private final byte[] buf;
private final int bufferSize;
private final OutputStream out;
/**
* Constructs a {@link org.apache.commons.crypto.stream.output.StreamOutput}
* .
*
* @param out the OutputStream object.
* @param bufferSize the buffersize.
*/
public StreamOutput(OutputStream out, int bufferSize) {
this.out = out;
this.bufferSize = bufferSize;
buf = new byte[bufferSize];
}
/**
* Overrides the
* {@link org.apache.commons.crypto.stream.output.Output#write(ByteBuffer)}.
* Writes a sequence of bytes to this output from the given buffer.
*
* @param src The buffer from which bytes are to be retrieved.
*
* @return The number of bytes written, possibly zero.
* @throws IOException if an I/O error occurs.
*/
@Override
public int write(ByteBuffer src) throws IOException {
final int len = src.remaining();
int remaining = len;
while (remaining > 0) {
final int n = Math.min(remaining, bufferSize);
src.get(buf, 0, n);
out.write(buf, 0, n);
remaining = src.remaining();
}
return len;
}
/**
* Overrides the {@link Output#flush()}. Flushes this output and forces any
* buffered output bytes to be written out if the under layer output method
* support.
*
* @throws IOException if an I/O error occurs.
*/
@Override
public void flush() throws IOException {
out.flush();
}
/**
* Overrides the {@link Output#close()}. Closes this output and releases any
* system resources associated with the under layer output.
*
* @throws IOException if an I/O error occurs.
*/
@Override
public void close() throws IOException {
out.close();
}
/**
* Gets the output stream.
*
* @return the output stream.
*/
protected OutputStream getOut() {
return out;
}
}