runtime-core/io.matthewnelson.kmp.tor.runtime.core.key/AuthKey/Private

Private

sealed class Private(key: ByteArray) : Key.Private(source)

Holder for a private key associated with a Hidden Service's client authentication configuration.

This would be the key added to a tor client by a user who wishes to connect to a Hidden Service that has been configured using the AuthKey.Public associated with this AuthKey.Private.

Inheritors

PrivateKey

Constructors

Private

protected constructor(key: ByteArray)

Functions

algorithm

expect abstract fun algorithm(): String

base16

expect fun base16(): String

Key bytes formatted in uppercase Base16 (hex)

base16OrNull

expect override fun base16OrNull(): String?

base32

expect fun base32(): String

Key bytes formatted in uppercase Base32 without padding

base32OrNull

expect override fun base32OrNull(): String?

base64

expect fun base64(): String

Key bytes formatted in Base64 without padding

base64OrNull

expect override fun base64OrNull(): String?

checkIsNotDestroyed

@JvmStatic

fun Destroyable.checkIsNotDestroyed()

Checks if a Destroyable instance has been destroyed or not.

descriptorBase32

fun descriptorBase32(publicKey: AddressKey.Public): String

fun descriptorBase32(address: OnionAddress): String

Produces the base 32 descriptor string for this AuthKey.Private in the form of {onion-address}:descriptor:{algorithm}:{base-32}.

descriptorBase32OrNull

fun descriptorBase32OrNull(publicKey: AddressKey.Public): String?

fun descriptorBase32OrNull(address: OnionAddress): String?

Produces the base 32 descriptor string for this AuthKey.Private in the form of {address-w/o-.onion}:descriptor:{algorithm}:{base-32}, or null if isDestroyed is true.

descriptorBase64

fun descriptorBase64(publicKey: AddressKey.Public): String

Produces the base 64 descriptor string for this AuthKey.Private in the form of {address-w/o-.onion}:descriptor:{algorithm}:{base-64}.

fun descriptorBase64(address: OnionAddress): String

Produces the base 64 descriptor string for this AuthKey.Private in the form of {address-w/o-.onion}:{algorithm}:{base-64}.

descriptorBase64OrNull

fun descriptorBase64OrNull(publicKey: AddressKey.Public): String?

fun descriptorBase64OrNull(address: OnionAddress): String?

Produces the base 64 descriptor string for this AuthKey.Private in the form of {address-w/o-.onion}:descriptor:{algorithm}:{base-64}, or null if isDestroyed is true.

destroy

expect override fun destroy()

destroyedException

@JvmStatic

@JvmOverloads

fun Destroyable.destroyedException(namePrefix: String = ""): IllegalStateException

Creates an IllegalStateException with a default message of

encoded

expect fun encoded(): ByteArray

Key bytes

encodedOrNull