class

RNS::Destination

Inherits RNS::Destination::DestinationInterface < Reference < Object

A named endpoint for sending or receiving packets, identified by a hash derived from the application name, aspects, and an optional identity.

Constants

ALLOW_ALL = 1_u8

ALLOW_LIST = 2_u8

ALLOW_NONE = 0_u8

─── Request policy constants ─────────────────────────────────────

DIRECTIONS = [IN, OUT]

GROUP = 1_u8

IN = 17_u8

─── Direction constants ──────────────────────────────────────────

LINK = 3_u8

OUT = 18_u8

PLAIN = 2_u8

PR_TAG_WINDOW = 30

─── Ratchet constants ────────────────────────────────────────────

PROOF_STRATEGIES = [PROVE_NONE, PROVE_APP, PROVE_ALL]

PROVE_ALL = 35_u8

PROVE_APP = 34_u8

PROVE_NONE = 33_u8

─── Proof strategy constants ─────────────────────────────────────

RATCHET_COUNT = 512

RATCHET_INTERVAL = 30 * 60

REQUEST_POLICIES = [ALLOW_NONE, ALLOW_ALL, ALLOW_LIST]

SINGLE = 0_u8

─── Type constants ───────────────────────────────────────────────

TYPES = [SINGLE, GROUP, PLAIN, LINK]

Constructors

new(identity : Identity | Nil, direction : UInt8, type : UInt8, app_name : String, aspects : Array(String) = [] of String, register : Bool = true)

Creates a new destination.

identity: the Identity that owns this destination (nil for PLAIN type)
direction: IN (receive) or OUT (send)
type: SINGLE, GROUP, PLAIN, or LINK
app_name: application name (no dots allowed)
aspects: additional name components appended after app_name
register: whether to register with Transport immediately

Class methods

app_and_aspects_from_name(full_name : String) : Tuple(String, Array(String))

expand_name(identity : Identity | Nil, app_name : String, aspects : Array(String)) : String

expand_name(identity : Identity | Nil, app_name : String, *aspects : String) : String

hash(identity_hash : Bytes, app_name : String, aspects : Array(String)) : Bytes

hash(identity : Identity | Nil, app_name : String, aspects : Array(String)) : Bytes

hash(identity : Identity | Nil, app_name : String, *aspects : String) : Bytes

hash_from_name_and_identity(full_name : String, identity : Identity | Nil) : Bytes

Derives a destination hash from a dot-separated full_name and an optional identity.

Instance methods

accept_link_requests

accept_link_requests=(accept_link_requests : Bool)

accepts_links

accepts_links=(accepts : Bool)

announce(app_data : Bytes | Nil = nil, path_response : Bool = false, attached_interface = nil, tag : Bytes | Nil = nil, send : Bool = true) : Packet | Nil

Sends an announce packet for this destination, advertising its public key and optional app_data to the network. Only valid for SINGLE/IN destinations.

callbacks

callbacks=(callbacks : DestinationCallbacks)

clear_default_app_data

create_keys

decrypt(ciphertext : Bytes) : Bytes | Nil

Decrypts ciphertext using this destination's identity or group key. Returns nil if decryption fails. PLAIN destinations return data unmodified.

default_app_data

default_app_data=(default_app_data : Bytes | Proc(Bytes | Nil) | Nil)

deregister_request_handler(path : String) : Bool

direction

enable_ratchets(ratchets_path : String) : Bool

encrypt(plaintext : Bytes) : Bytes

Encrypts plaintext using this destination's identity or group key. PLAIN destinations return data unmodified.

enforce_ratchets

get_private_key

hash

─── Instance properties ──────────────────────────────────────────

hash=(hash : Bytes)

─── Instance properties ──────────────────────────────────────────

hexhash

hexhash=(hexhash : String)

identity

latest_ratchet_id

latest_ratchet_id=(latest_ratchet_id : Bytes | Nil)

latest_ratchet_time

latest_ratchet_time=(latest_ratchet_time : Float64 | Nil)

links

Link tracking

links=(links : Array(Link))

Link tracking

load_private_key(key : Bytes)

load_public_key(key : Bytes)

mtu

mtu=(mtu : Int32)

name

name_hash

proof_strategy

proof_strategy=(proof_strategy : UInt8)

prv

prv=(prv : Cryptography::Token | Nil)

prv_bytes

GROUP key properties

prv_bytes=(prv_bytes : Bytes | Nil)

GROUP key properties

ratchet_interval

ratchet_interval=(ratchet_interval : Int32)

ratchets

Ratchet properties

ratchets=(ratchets : Array(Bytes) | Nil)

Ratchet properties

ratchets_path

ratchets_path=(ratchets_path : String | Nil)

receive(packet : Packet) : Bool

register_request_handler(path : String, response_generator : Proc(String, Bytes | Nil, Bytes, Bytes, Identity | Nil, Float64, Bytes | Nil), allow : UInt8 = ALLOW_NONE, allowed_list : Array(Bytes) | Nil = nil, auto_compress : Bool = true)

Registers a request handler for the given path. The response_generator proc is called when a matching request arrives; allow controls the access policy.

request_handlers

retained_ratchets

retained_ratchets=(retained_ratchets : Int32)

rotate_ratchets

set_default_app_data(app_data : Bytes | Proc(Bytes | Nil) | Nil = nil)

set_link_established_callback(callback : Proc(Link, Nil))

Sets the callback invoked when a new Link is established to this destination.

set_packet_callback(callback : Proc(Bytes, Packet, Nil))

Sets the callback invoked when a data packet is received at this destination.

set_proof_requested_callback(callback : Proc(Packet, Bool))

Sets the callback invoked to decide whether a proof should be sent for a packet. Used when proof_strategy is PROVE_APP.

set_proof_strategy(proof_strategy : UInt8)

Configures the proof strategy: PROVE_NONE, PROVE_ALL, or PROVE_APP.

set_ratchet_interval(interval : Int32) : Bool

set_retained_ratchets(retained_ratchets : Int32) : Bool

sign(message : Bytes) : Bytes | Nil

Signs message using the identity's private key. Only works for SINGLE destinations.

to_s(io : IO) : Nil

Appends a short String representation of this object which includes its class name and its object address.

class Person
  def initialize(@name : String, @age : Int32)
  end
end

Person.new("John", 32).to_s # => #<Person:0x10a199f20>

type

Nested types