runtime-core/io.matthewnelson.kmp.tor.runtime.core.net/OnionAddress

OnionAddress

Base abstraction for denoting a String value as a .onion address

e.g.

val string = "2gzyxa5ihm7nsggfxnu52rck2vv4rvmdlkiu3zzui5du4xyclen53wid"

string.toOnionAddress()
"http://${string}.onion:8080/some/path".toOnionAddress()
"http://subdomain.${string}.onion:8080/some/path".toOnionAddress()

Inheritors

Types

Companion

object Companion

class V3 : OnionAddress

Holder for a 56 character v3 onion address without the scheme or .onion appended.

Properties

value

@JvmField

val value: String

Functions

asPublicKey

abstract fun asPublicKey(): AddressKey.Public

Wraps the OnionAddress in its AddressKey.Public format for extended functionality.

canonicalHostName

fun canonicalHostName(): String

Returns value in its canonicalized hostname form

compareTo

operator override fun compareTo(other: Address): Int

decode

abstract fun decode(): ByteArray

mappingToAnyHostIPv4

@JvmStatic

@JvmName(name = "anyHostIPv4To")

fun OnionAddress.mappingToAnyHostIPv4(): AddressMapping

Creates a AddressMapping that instructs tor to generate a virtual IPAddress.V4 address and map the provided OnionAddress to it.

mappingToAnyHostIPv6