Package org.h2.store.fs.encrypt

Class FileEncrypt

java.lang.Object

java.nio.channels.spi.AbstractInterruptibleChannel

java.nio.channels.FileChannel

org.h2.store.fs.FileBase

org.h2.store.fs.FileBaseDefault

org.h2.store.fs.encrypt.FileEncrypt

All Implemented Interfaces:

Closeable, AutoCloseable, ByteChannel, Channel, GatheringByteChannel, InterruptibleChannel, ReadableByteChannel, ScatteringByteChannel, SeekableByteChannel, WritableByteChannel

public class FileEncrypt
extends FileBaseDefault

An encrypted file with a read cache.

Nested Class Summary

Nested classes/interfaces inherited from class java.nio.channels.FileChannel

FileChannel.MapMode

Field Summary

Fields

Modifier and Type	Field	Description
private final FileChannel	base
static final int	BLOCK_SIZE	The block size.
(package private) static final int	BLOCK_SIZE_MASK	The block size bit mask.
private byte[]	encryptionKey
private static final int	HASH_ITERATIONS	The number of iterations.
private static final byte[]	HEADER
(package private) static final int	HEADER_LENGTH	The length of the file header.
private final String	name
private static final int	SALT_LENGTH	The length of the salt, in bytes.
private static final int	SALT_POS
private long	size	The current file size, from a user perspective.
private XTS	xts

Constructor Summary

Constructors

Constructor	Description
FileEncrypt(String name, byte[] encryptionKey, FileChannel base)

Method Summary

Modifier and Type	Method	Description
private XTS	createXTS()
void	force(boolean metaData)
protected void	implCloseChannel()
protected void	implTruncate(long newSize)	The truncate implementation.
private XTS	init()
int	read(ByteBuffer dst, long position)
private static void	readFully(FileChannel file, long pos, ByteBuffer dst)
private void	readInternal(ByteBuffer dst, long position, int len, XTS xts)
long	size()
String	toString()
FileLock	tryLock(long position, long size, boolean shared)
int	write(ByteBuffer src, long position)
private static void	writeFully(FileChannel file, long pos, ByteBuffer src)
private void	writeInternal(ByteBuffer src, long position, int len, XTS xts)

Methods inherited from class org.h2.store.fs.FileBaseDefault

position, position, read, truncate, write

Methods inherited from class org.h2.store.fs.FileBase

lock, map, read, transferFrom, transferTo, write

Methods inherited from class java.nio.channels.FileChannel

lock, map, open, open, read, tryLock, write

Methods inherited from class java.nio.channels.spi.AbstractInterruptibleChannel

begin, close, end, isOpen

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.nio.channels.Channel

isOpen

Field Details

BLOCK_SIZE

public static final int BLOCK_SIZE

The block size.

See Also:

• Constant Field Values

BLOCK_SIZE_MASK

static final int BLOCK_SIZE_MASK

The block size bit mask.

See Also:

• Constant Field Values

HEADER_LENGTH

static final int HEADER_LENGTH

The length of the file header. Using a smaller header is possible, but would mean reads and writes are not aligned to the block size.

See Also:

• Constant Field Values

HEADER

private static final byte[] HEADER

SALT_POS

private static final int SALT_POS

SALT_LENGTH

private static final int SALT_LENGTH

The length of the salt, in bytes.

See Also:

• Constant Field Values

HASH_ITERATIONS

private static final int HASH_ITERATIONS

The number of iterations. It is relatively low; a higher value would slow down opening files on Android too much.

See Also:

• Constant Field Values

base

private final FileChannel base

size

private volatile long size

The current file size, from a user perspective.

name

private final String name

xts

private volatile XTS xts

encryptionKey

private byte[] encryptionKey

Constructor Details

FileEncrypt

public FileEncrypt(String name,
 byte[] encryptionKey,
 FileChannel base)

Method Details

init

private XTS init()
          throws IOException

Throws:

IOException

createXTS

private XTS createXTS()
               throws IOException

Throws:

IOException

implCloseChannel

protected void implCloseChannel()
                         throws IOException

Overrides:

implCloseChannel in class FileBase

Throws:

IOException

read

public int read(ByteBuffer dst,
 long position)
         throws IOException

Overrides:

read in class FileBase

Throws:

IOException

readInternal

private void readInternal(ByteBuffer dst,
 long position,
 int len,
 XTS xts)
                   throws IOException

Throws:

IOException

readFully

private static void readFully(FileChannel file,
 long pos,
 ByteBuffer dst)
                       throws IOException

Throws:

IOException

write

public int write(ByteBuffer src,
 long position)
          throws IOException

Overrides:

write in class FileBase

Throws:

IOException

writeInternal

private void writeInternal(ByteBuffer src,
 long position,
 int len,
 XTS xts)
                    throws IOException

Throws:

IOException

writeFully

private static void writeFully(FileChannel file,
 long pos,
 ByteBuffer src)
                        throws IOException

Throws:

IOException

size

public long size()
          throws IOException

Specified by:

size in interface SeekableByteChannel

Specified by:

size in class FileChannel

Throws:

IOException

implTruncate

protected void implTruncate(long newSize)
                     throws IOException

Description copied from class: FileBaseDefault

The truncate implementation.

Specified by:

implTruncate in class FileBaseDefault

Parameters:

newSize - the new size

Throws:

IOException - on failure

force

public void force(boolean metaData)
           throws IOException

Overrides:

force in class FileBase

Throws:

IOException

tryLock

public FileLock tryLock(long position,
 long size,
 boolean shared)
                 throws IOException

Overrides:

tryLock in class FileBase

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object