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

Public

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

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

This would be the key a Hidden Service operator adds, to only allow connections from tor clients who have the AuthKey.Private associated with this AuthKey.Public.

Inheritors

PublicKey

Constructors

Public

protected constructor(key: ByteArray)

Functions

algorithm

expect abstract fun algorithm(): String

Returns the algorithm name for this key. For example, ED25519-V3 or x25519

base16

override fun base16(): String

Returns a Base16 (uppercase) encoded String of the raw key value.

base16Chars

override fun base16Chars(): CharArray

Returns a Base16 (uppercase) encoded CharArray of the raw key value.

base16CharsOrNull

expect override fun base16CharsOrNull(): CharArray

Returns a Base16 (uppercase) encoded CharArray of the raw key value, or null if the key does not support encoding or Key.Private.isDestroyed is true.

base16OrNull

expect override fun base16OrNull(): String

Returns a Base16 (uppercase) encoded String of the raw key value, or null if the key does not support encoding or Key.Private.isDestroyed is true.

base32

override fun base32(): String

Returns a Base32 (uppercase & no padding) encoded String of the raw key value.

base32Chars

override fun base32Chars(): CharArray

Returns a Base32 (uppercase & no padding) encoded CharArray of the raw key value.

base32CharsOrNull

expect override fun base32CharsOrNull(): CharArray

Returns a Base32 (uppercase & no padding) encoded CharArray of the raw key value, or null if the key does not support encoding or Key.Private.isDestroyed is true.

base32OrNull

expect override fun base32OrNull(): String

Returns a Base32 (uppercase & no padding) encoded String of the raw key value, or null if the key does not support encoding or Key.Private.isDestroyed is true.

base64

override fun base64(): String

Returns a Base64 (no padding) encoded String of the raw key value.

base64Chars

override fun base64Chars(): CharArray

Returns a Base64 (no padding) encoded CharArray of the raw key value.

base64CharsOrNull

expect override fun base64CharsOrNull(): CharArray

Returns a Base64 (no padding) encoded CharArray of the raw key value, or null if the key does not support encoding or Key.Private.isDestroyed is true.

base64OrNull

expect override fun base64OrNull(): String

Returns a Base64 (no padding) encoded String of the raw key value, or null if the key does not support encoding or Key.Private.isDestroyed is true.

descriptorBase32

fun descriptorBase32(): String

Produces the descriptor String using the Base32 encoding of the key in the form of descriptor:{algorithm}:{base32 encoded key}.

descriptorBase32Utf8

fun descriptorBase32Utf8(): ByteArray

Produces the descriptor using the Base32 encoding of the key in the form of descriptor:{algorithm}:{base32 encoded key} as UTF-8 bytes.

descriptorBase64

fun descriptorBase64(): String

Produces the descriptor String using the Base64 encoding of the key in the form of descriptor:{algorithm}:{base64 encoded key}.

descriptorBase64Utf8

fun descriptorBase64Utf8(): ByteArray

Produces the descriptor using the Base64 encoding of the key in the form of descriptor:{algorithm}:{base64 encoded key} as UTF-8 bytes.

encoded

override fun encoded(): ByteArray

Returns the key in its primary encoding.

encodedOrNull

expect override fun encodedOrNull(): ByteArray

Returns the key in its primary encoding, or null if the key does not support encoding or Key.Private.isDestroyed is true.

Public

See also

Inheritors

Constructors

Functions