org.apache.poi.poifs.crypt

Class Encryptor

java.lang.Object

org.apache.poi.poifs.crypt.Encryptor

All Implemented Interfaces:

GenericRecord

Direct Known Subclasses:

AgileEncryptor, BinaryRC4Encryptor, CryptoAPIEncryptor, StandardEncryptor, XOREncryptor

public abstract class Encryptor
extends java.lang.Object
implements GenericRecord

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	DEFAULT_POIFS_ENTRY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Encryptor()
protected	Encryptor(Encryptor other)

Method Summary

Modifier and Type	Method and Description
abstract void	confirmPassword(java.lang.String password)
abstract void	confirmPassword(java.lang.String password, byte[] keySpec, byte[] keySalt, byte[] verifier, byte[] verifierSalt, byte[] integritySalt)
abstract Encryptor	copy()
abstract java.io.OutputStream	getDataStream(DirectoryNode dir) Return a output stream for encrypted data.
ChunkedCipherOutputStream	getDataStream(java.io.OutputStream stream, int initialOffset)
java.io.OutputStream	getDataStream(POIFSFileSystem fs)
EncryptionInfo	getEncryptionInfo()
java.util.Map<java.lang.String,java.util.function.Supplier<?>>	getGenericProperties()
static Encryptor	getInstance(EncryptionInfo info)
javax.crypto.SecretKey	getSecretKey()
void	setChunkSize(int chunkSize) Sets the chunk size of the data stream.
void	setEncryptionInfo(EncryptionInfo encryptionInfo)
void	setSecretKey(javax.crypto.SecretKey secretKey)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.poi.common.usermodel.GenericRecord

getGenericChildren, getGenericRecordType

Field Detail

DEFAULT_POIFS_ENTRY

protected static final java.lang.String DEFAULT_POIFS_ENTRY

See Also:

Constant Field Values

Constructor Detail

Encryptor

protected Encryptor()

Encryptor

protected Encryptor(Encryptor other)

Method Detail

getDataStream

public abstract java.io.OutputStream getDataStream(DirectoryNode dir)
                                            throws java.io.IOException,
                                                   java.security.GeneralSecurityException

Return a output stream for encrypted data.

Parameters:

dir - the node to write to

Returns:

encrypted stream

Throws:

java.io.IOException

java.security.GeneralSecurityException

confirmPassword

public abstract void confirmPassword(java.lang.String password,
                                     byte[] keySpec,
                                     byte[] keySalt,
                                     byte[] verifier,
                                     byte[] verifierSalt,
                                     byte[] integritySalt)

confirmPassword

public abstract void confirmPassword(java.lang.String password)

getInstance

public static Encryptor getInstance(EncryptionInfo info)

getDataStream

public java.io.OutputStream getDataStream(POIFSFileSystem fs)
                                   throws java.io.IOException,
                                          java.security.GeneralSecurityException

Throws:

java.io.IOException

java.security.GeneralSecurityException

getDataStream

public ChunkedCipherOutputStream getDataStream(java.io.OutputStream stream,
                                               int initialOffset)
                                        throws java.io.IOException,
                                               java.security.GeneralSecurityException

Throws:

java.io.IOException

java.security.GeneralSecurityException

getSecretKey

public javax.crypto.SecretKey getSecretKey()

setSecretKey

public void setSecretKey(javax.crypto.SecretKey secretKey)

getEncryptionInfo

public EncryptionInfo getEncryptionInfo()

setEncryptionInfo

public void setEncryptionInfo(EncryptionInfo encryptionInfo)

setChunkSize

public void setChunkSize(int chunkSize)

Sets the chunk size of the data stream. Needs to be set before the data stream is requested. When not set, the implementation uses method specific default values

Parameters:

chunkSize - the chunk size, i.e. the block size with the same encryption key

copy

public abstract Encryptor copy()

getGenericProperties

public java.util.Map<java.lang.String,java.util.function.Supplier<?>> getGenericProperties()

Specified by:

getGenericProperties in interface GenericRecord