Opened 8 months ago

Last modified 16 hours ago

#31913 new enhancement

Add more robust Tor API documentation

Reported by: chelseakomlo Owned by:
Priority: Medium Milestone: Tor: 0.4.4.x-final
Component: Core Tor/Tor Version:
Severity: Normal Keywords: api doc 043-can 044-can
Cc: Actual Points:
Parent ID: Points:
Reviewer: Sponsor:

Description

Currently, Tor's API is not well-documented- adding more rich documentation (and ideally a separate how-to technical guide) would be helpful for external applications to learn how to embed tor.

For example, tor_control_socket_t needs documentation. https://gitweb.torproject.org/tor.git/tree/src/feature/api/tor_api.h#n60

Furthermore, it isn't clear what are the tradeoffs between embedding Tor or running it as an executable: https://gitweb.torproject.org/tor.git/tree/src/feature/api/tor_api.h#n11

Also, it would be helpful to add additional documentation about how to interface with tor once it has been invoked (e.g, reading/writing from the control port via SOCKS). https://gitweb.torproject.org/tor.git/tree/src/feature/api/tor_api.h#n26

Child Tickets

Change History (4)

comment:1 Changed 8 months ago by nickm

Keywords: doc added
Milestone: Tor: 0.4.3.x-final

comment:2 Changed 5 months ago by ahf

Keywords: 043-can added

comment:3 Changed 2 weeks ago by nickm

Milestone: Tor: 0.4.3.x-finalTor: 0.4.4.x-final

0.4.3 was released: Move non merge-ready 0.4.3 tickets to 044.

comment:4 Changed 16 hours ago by nickm

Keywords: 044-can added
Note: See TracTickets for help on using tickets.