Opened 5 years ago

Closed 5 years ago

#12434 closed task (fixed)

Clean up the PT spec

Reported by: asn Owned by:
Priority: Medium Milestone: Tor: 0.2.6.x-final
Component: Core Tor/Tor Version:
Severity: Keywords: tor-spec tor-pt 026-triaged-1
Cc: dcf@… Actual Points:
Parent ID: Points:
Reviewer: Sponsor:

Description

While the PT spec is not terrible, it's certainly a bit of a mess.

It contains unimplemented stuff that will probably never get implemented. It's all a big blob of text and it doesn't have any sections. It doesn't say anything about ExtORPort.

Also, other projects (I2P, psiphon, lantern, uproxy, etc.) want to use these 'Pluggable Transport' things, but they don't like how our pt-spec.txt is Tor specific. We should probably split our current pt-spec.txt to a tor-pt-spec.txt and to a platform-independent pt-spec.txt (that might or might not reside in gitweb.tpo). This is related to #10629.

Child Tickets

Attachments (1)

pt-spec-fixt.diff (23.3 KB) - added by yawning 5 years ago.
Suggested changes…

Download all attachments as: .zip

Change History (11)

comment:1 Changed 5 years ago by asn

I have an initial draft in pt_spec_draft at https://git.torproject.org/user/asn/torspec.git:
https://gitweb.torproject.org/user/asn/torspec.git/blob/refs/heads/pt_spec_draft:/tor-pt-spec.txt

It still doesn't talk about ExtORPort, and there are many XXXs that I want to resolve.

comment:2 Changed 5 years ago by dcf

Cc: dcf@… added

comment:3 Changed 5 years ago by asn

I should also mention that people asked for test vectors wrt managed proxy protocol behavior. To unit test their *ptlib implementations.

comment:4 Changed 5 years ago by nickm

Keywords: 026-triaged-1 added
Milestone: Tor: 0.2.6.x-final

Seems better than the status quo; let me know when you think this is ready for merge

comment:5 Changed 5 years ago by asn

Status: newneeds_review

Pushed some more stuff to my pt_spec_draft branch. Also cleaned up the XXXs.

I also added a paragraph about TOR_PT_PROXY that should resolve #11674.

Please review and merge if it gives you satisfaction.

comment:6 Changed 5 years ago by asn

Further TODO items include test vectors for the managed proxy protocol and clarifications for IPv6 support (as will develop from #12138, #11211 and #7961).

Also, we need to document the way bridges pass transport info in extra-info descriptors (which is also related to #12442).

comment:7 Changed 5 years ago by asn

Hello,

please see branch bug12434 in https://git.torproject.org/user/asn/torspec.git.

As discussed in the dev meeting, I replaced pt-spec.txt with the new PT spec.

Please review and I will push it.

Thanks!

Changed 5 years ago by yawning

Attachment: pt-spec-fixt.diff added

Suggested changes...

comment:8 Changed 5 years ago by yawning

Mostly phrasing/consistency. I additionally re-wrapped text to 72 cols (per the RFC style guide).

Someone that's better at English than I am should proof read my corrections.

comment:9 Changed 5 years ago by nickm

For the record: I've given asn push rights on the main torspec repository, for the purpose of keeping pt-spec.txt up to date. asn, please maintain pt-spec.txt as you think best. :)

comment:10 in reply to:  8 Changed 5 years ago by asn

Resolution: fixed
Status: needs_reviewclosed

Replying to yawning:

Mostly phrasing/consistency. I additionally re-wrapped text to 72 cols (per the RFC style guide).

Someone that's better at English than I am should proof read my corrections.

Applied patch and pushed!

Thanks! :)

Note: See TracTickets for help on using tickets.