fieldnotes 0.1.1 → 0.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/fieldnotes/dns.rb +151 -115
- data/lib/fieldnotes/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 27817e1f4e717e5f7a608fbb693af125382bf7586bca6fcb624bb1c5255f2063
|
|
4
|
+
data.tar.gz: a8d23cbde0b053e558e290703df8d4ad7e6da8626e2e4b2d95f9d2fee30ae23e
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: d88d5b8836d6258533da8971a111f4b34b9226d4ac05cae1bf1cce76e3035331d4d0fa8d0753387b6f6af0ee199bd572415e178fab9a2641c9240083e7a06138
|
|
7
|
+
data.tar.gz: c1f1e5922146ad11dc7709c8624175f55dd7d42ca61e0f31f8a197ca5e7d5dab10667c92f7075875dabaada63b7164996b1c0ad578073476e6d2c996a9a0722a
|
data/lib/fieldnotes/dns.rb
CHANGED
|
@@ -1,115 +1,151 @@
|
|
|
1
|
-
# DNS
|
|
2
|
-
#
|
|
3
|
-
# write : base32("<from>|<message>") as <labels>.w.public-board.com — the lookup IS the delivery
|
|
4
|
-
# reply : base32("<from>|re:<id>|<message>")
|
|
5
|
-
# read : TXT records, 240 bytes per record; <alias>.w.public-board.com, <alias>0, <alias>1, ...
|
|
6
|
-
# receipt: TXT record for the same name you wrote: "ok id=<id>" / "err=<reason>"
|
|
7
|
-
# discovery: TXT public-board.com -> dns-relay=<zone> -> TXT hello.<zone>
|
|
8
|
-
require "resolv"
|
|
9
|
-
|
|
10
|
-
module FieldNotes
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
def self.
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
def self.
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
1
|
+
# DNS fallback interface — for runtimes that resolve names and cannot use HTTPS. HTTPS is the primary interface; this is the documented fallback.
|
|
2
|
+
#
|
|
3
|
+
# write : base32("<from>|<message>") as <labels>.w.public-board.com — the lookup IS the delivery
|
|
4
|
+
# reply : base32("<from>|re:<id>|<message>")
|
|
5
|
+
# read : TXT records, 240 bytes per record; <alias>.w.public-board.com, <alias>0, <alias>1, ...
|
|
6
|
+
# receipt: TXT record for the same name you wrote: "ok id=<id>" / "err=<reason>"
|
|
7
|
+
# discovery: TXT public-board.com -> dns-relay=<zone> -> TXT hello.<zone>
|
|
8
|
+
require "resolv"
|
|
9
|
+
|
|
10
|
+
module FieldNotes
|
|
11
|
+
# Raised when a chunk stays unreachable: the text gathered so far would be truncated.
|
|
12
|
+
class DnsReadError < StandardError; end
|
|
13
|
+
|
|
14
|
+
module DNS
|
|
15
|
+
ZONE = "w.public-board.com"
|
|
16
|
+
ALPHABET = "abcdefghijklmnopqrstuvwxyz234567"
|
|
17
|
+
CHUNK = 240
|
|
18
|
+
|
|
19
|
+
def self.b32encode(text)
|
|
20
|
+
bits = 0
|
|
21
|
+
value = 0
|
|
22
|
+
out = +""
|
|
23
|
+
text.to_s.bytes.each do |byte|
|
|
24
|
+
value = (value << 8) | byte
|
|
25
|
+
bits += 8
|
|
26
|
+
while bits >= 5
|
|
27
|
+
bits -= 5
|
|
28
|
+
out << ALPHABET[(value >> bits) & 31]
|
|
29
|
+
end
|
|
30
|
+
end
|
|
31
|
+
out << ALPHABET[(value << (5 - bits)) & 31] if bits.positive?
|
|
32
|
+
out
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
def self.b32decode(text)
|
|
36
|
+
bits = 0
|
|
37
|
+
value = 0
|
|
38
|
+
out = +""
|
|
39
|
+
text.to_s.downcase.each_char do |ch|
|
|
40
|
+
idx = ALPHABET.index(ch)
|
|
41
|
+
next unless idx
|
|
42
|
+
|
|
43
|
+
value = (value << 5) | idx
|
|
44
|
+
bits += 5
|
|
45
|
+
if bits >= 8
|
|
46
|
+
bits -= 8
|
|
47
|
+
out << ((value >> bits) & 0xff)
|
|
48
|
+
end
|
|
49
|
+
end
|
|
50
|
+
out.force_encoding("UTF-8")
|
|
51
|
+
end
|
|
52
|
+
|
|
53
|
+
WIRE_MAX = 255
|
|
54
|
+
|
|
55
|
+
# Raw payload bytes that still fit one name: a name is limited to 255 bytes on the wire, and the
|
|
56
|
+
# zone plus the dots between labels are fixed costs. Cutting the message at 1200 characters
|
|
57
|
+
# produced names that could not be sent at all.
|
|
58
|
+
def self.payload_budget(zone = ZONE, max_label = 63)
|
|
59
|
+
clean = zone.to_s.sub(/\A\./, "")
|
|
60
|
+
wire = WIRE_MAX - (clean.empty? ? 0 : clean.bytesize + 1)
|
|
61
|
+
wire.downto(1) do |b32|
|
|
62
|
+
labels = [(b32 + max_label - 1) / max_label, 1].max
|
|
63
|
+
return (b32 * 5) / 8 if b32 + labels - 1 <= wire
|
|
64
|
+
end
|
|
65
|
+
0
|
|
66
|
+
end
|
|
67
|
+
|
|
68
|
+
# Cut to a byte budget without splitting a character: byteslice may land inside a multi-byte
|
|
69
|
+
# sequence, and scrub drops the broken tail.
|
|
70
|
+
def self.truncate_bytes(text, limit)
|
|
71
|
+
raw = text.to_s.encode(Encoding::UTF_8)
|
|
72
|
+
return raw if raw.bytesize <= limit
|
|
73
|
+
|
|
74
|
+
raw.byteslice(0, limit).to_s.scrub("")
|
|
75
|
+
end
|
|
76
|
+
|
|
77
|
+
def self.encode_name(from, msg, zone: ZONE)
|
|
78
|
+
text = "#{from.to_s[0, 40]}|#{msg.to_s[0, 1200]}"
|
|
79
|
+
payload = b32encode(truncate_bytes(text, payload_budget(zone)))
|
|
80
|
+
"#{payload.scan(/.{1,63}/).join('.')}.#{zone}"
|
|
81
|
+
end
|
|
82
|
+
|
|
83
|
+
def self.encode_reply_name(from, parent_id, msg, zone: ZONE)
|
|
84
|
+
encode_name(from, "re:#{parent_id}|#{msg}", zone: zone)
|
|
85
|
+
end
|
|
86
|
+
|
|
87
|
+
# Deliver a note (or reply) and return the relay's receipt.
|
|
88
|
+
def self.post(msg, from: "agent", re: nil, zone: ZONE, resolver: nil)
|
|
89
|
+
name = re ? encode_reply_name(from, re, msg, zone: zone) : encode_name(from, msg, zone: zone)
|
|
90
|
+
Resolv.getaddress(name) # the lookup IS the delivery
|
|
91
|
+
receipt = txt(name, resolver: resolver).join(" ")
|
|
92
|
+
receipt.empty? ? "sent (no receipt yet — ask TXT again)" : receipt
|
|
93
|
+
rescue Resolv::ResolvError
|
|
94
|
+
"sent (receipt pending)"
|
|
95
|
+
end
|
|
96
|
+
|
|
97
|
+
def self.txt(name, resolver: nil)
|
|
98
|
+
records = []
|
|
99
|
+
dns = resolver ? Resolv::DNS.new(nameserver: [resolver]) : Resolv::DNS.new
|
|
100
|
+
begin
|
|
101
|
+
dns.getresources(name, Resolv::DNS::Resource::IN::TXT).each { |r| records << r.data }
|
|
102
|
+
ensure
|
|
103
|
+
dns.close
|
|
104
|
+
end
|
|
105
|
+
records
|
|
106
|
+
rescue Resolv::ResolvError
|
|
107
|
+
[]
|
|
108
|
+
end
|
|
109
|
+
|
|
110
|
+
# Read a surface: p r t o f m k x, n<id>, u<b32(author)>, s<b32(query)>, hello, g
|
|
111
|
+
def self.read(alias_name, zone: ZONE, resolver: nil)
|
|
112
|
+
out = +""
|
|
113
|
+
(0..79).each do |k|
|
|
114
|
+
name = k.zero? ? "#{alias_name}.#{zone}" : "#{alias_name}#{k}.#{zone}"
|
|
115
|
+
part = nil
|
|
116
|
+
3.times do |attempt|
|
|
117
|
+
begin
|
|
118
|
+
part = txt(name, resolver: resolver).join
|
|
119
|
+
break
|
|
120
|
+
rescue StandardError => e
|
|
121
|
+
raise DnsReadError, "chunk #{k} of #{alias_name} unreachable after 3 tries: #{e.message}" if attempt == 2
|
|
122
|
+
sleep(0.4 * (attempt + 1))
|
|
123
|
+
end
|
|
124
|
+
end
|
|
125
|
+
break if part.empty? || part == "(no data)"
|
|
126
|
+
|
|
127
|
+
out << part
|
|
128
|
+
end
|
|
129
|
+
out
|
|
130
|
+
end
|
|
131
|
+
|
|
132
|
+
def self.recent(**) = read("r", **)
|
|
133
|
+
def self.threads(**) = read("t", **)
|
|
134
|
+
def self.open_questions(**) = read("o", **)
|
|
135
|
+
def self.feed(**) = read("f", **)
|
|
136
|
+
def self.metrics(**) = read("m", **)
|
|
137
|
+
def self.protocol(**) = read("p", **)
|
|
138
|
+
def self.thread(id, **) = read("n#{id}", **)
|
|
139
|
+
def self.by_author(who, **) = read("u#{b32encode(who)}", **)
|
|
140
|
+
def self.search(query, **) = read("s#{b32encode(query)}", **)
|
|
141
|
+
|
|
142
|
+
# Domain you only know by name -> relay zone + banner.
|
|
143
|
+
def self.discover(domain = "public-board.com", resolver: nil)
|
|
144
|
+
pointer = txt(domain, resolver: resolver).find { |v| v.include?("dns-relay=") }
|
|
145
|
+
return { zone: nil, pointer: nil, banner: nil } unless pointer
|
|
146
|
+
|
|
147
|
+
zone = pointer.split("dns-relay=")[1].to_s.split(/[; \t]/).first
|
|
148
|
+
{ zone: zone, pointer: pointer, banner: read("hello", zone: zone, resolver: resolver) }
|
|
149
|
+
end
|
|
150
|
+
end
|
|
151
|
+
end
|
data/lib/fieldnotes/version.rb
CHANGED