[go: up one dir, main page]

File: txtorcon-onion.rst

package info (click to toggle)
txtorcon 20.0.0-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 1,644 kB
  • sloc: python: 17,429; makefile: 229
file content (74 lines) | stat: -rw-r--r-- 1,735 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
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
.. _onion_api:

Onion APIs
==========

See the :ref:`programming_guide` for "prose" documentation of these
(and other) APIs.

For non-authenticated services:

IOnionService
-------------
.. autointerface:: txtorcon.IOnionService

IFilesystemOnionService
-----------------------
.. autointerface:: txtorcon.IFilesystemOnionService



Both kinds of authenticated service (ephemeral or disk) implement
these interfaces:

IAuthenticatedOnionClients
--------------------------
.. autointerface:: txtorcon.IAuthenticatedOnionClients

IOnionClient
------------
.. autointerface:: txtorcon.IOnionClient


Concrete classes implementing specific variations of Onion
services. First, ephemeral services (private keys do not live on
disk). See :ref:`server_use` for an overview of the variations.

EphemeralOnionService
---------------------
.. autoclass:: txtorcon.EphemeralOnionService

EphemeralAuthenticatedOnionService
----------------------------------
.. autoclass:: txtorcon.EphemeralAuthenticatedOnionService

EphemeralAuthenticatedOnionServiceClient
----------------------------------------
.. autoclass:: txtorcon.EphemeralAuthenticatedOnionServiceClient


Onion services which store their secret keys on disk:

FilesystemOnionService
----------------------
.. autoclass:: txtorcon.FilesystemOnionService

FilesystemAuthenticatedOnionService
-----------------------------------
.. autoclass:: txtorcon.FilesystemAuthenticatedOnionService

FilesystemAuthenticatedOnionServiceClient
-----------------------------------------
.. autoclass:: txtorcon.FilesystemAuthenticatedOnionServiceClient


Some utility-style classes:

AuthBasic
---------
.. autoclass:: txtorcon.AuthBasic

AuthStealth
-----------
.. autoclass:: txtorcon.AuthStealth