2ce625ac87
* to get rid of global state * to have a testable architecture * to allow for authenticated encryption * to have a backup format version * to potentially allow for other storage plugins
43 lines
1.3 KiB
Kotlin
43 lines
1.3 KiB
Kotlin
package com.stevesoltys.backup.header
|
|
|
|
import java.nio.charset.Charset
|
|
|
|
internal const val VERSION: Byte = 0
|
|
internal const val MAX_PACKAGE_LENGTH_SIZE = 255
|
|
internal const val MAX_KEY_LENGTH_SIZE = MAX_PACKAGE_LENGTH_SIZE
|
|
internal const val MAX_VERSION_HEADER_SIZE = 1 + Short.SIZE_BYTES * 2 + MAX_PACKAGE_LENGTH_SIZE + MAX_KEY_LENGTH_SIZE
|
|
|
|
/**
|
|
* After the first version byte of each backup stream
|
|
* must follow followed this header encrypted with authentication.
|
|
*/
|
|
data class VersionHeader(
|
|
internal val version: Byte = VERSION, // 1 byte
|
|
internal val packageName: String, // ?? bytes (max 255)
|
|
internal val key: String? = null // ?? bytes
|
|
) {
|
|
init {
|
|
check(packageName.length <= MAX_PACKAGE_LENGTH_SIZE)
|
|
key?.let { check(key.length <= MAX_KEY_LENGTH_SIZE) }
|
|
}
|
|
}
|
|
|
|
|
|
internal const val SEGMENT_LENGTH_SIZE: Int = Short.SIZE_BYTES
|
|
internal const val MAX_SEGMENT_LENGTH: Int = Short.MAX_VALUE.toInt()
|
|
internal const val IV_SIZE: Int = 12
|
|
internal const val SEGMENT_HEADER_SIZE = SEGMENT_LENGTH_SIZE + IV_SIZE
|
|
|
|
/**
|
|
* Each data segment must start with this header
|
|
*/
|
|
class SegmentHeader(
|
|
internal val segmentLength: Short, // 2 bytes
|
|
internal val nonce: ByteArray // 12 bytes
|
|
) {
|
|
init {
|
|
check(nonce.size == IV_SIZE)
|
|
}
|
|
}
|
|
|
|
val Utf8: Charset = Charset.forName("UTF-8")
|