diff options
Diffstat (limited to 'spec/bridgedb-spec.md')
| -rw-r--r-- | spec/bridgedb-spec.md | 13 |
1 files changed, 12 insertions, 1 deletions
diff --git a/spec/bridgedb-spec.md b/spec/bridgedb-spec.md index fddd8bd..2080e5d 100644 --- a/spec/bridgedb-spec.md +++ b/spec/bridgedb-spec.md @@ -21,6 +21,7 @@ Table of Contents ``` <a id="bridgedb-spec.txt-0"></a> + # Preliminaries This document specifies how BridgeDB processes bridge descriptor files @@ -33,6 +34,7 @@ specify current behavior as of August 2013, not to specify ideal behavior. <a id="bridgedb-spec.txt-1"></a> + # Importing bridge network statuses and bridge descriptors BridgeDB learns about bridges by parsing bridge network statuses, @@ -48,6 +50,7 @@ files: the operator needs to make sure that these documents have come from a Tor instance that did the validation for us. <a id="bridgedb-spec.txt-1.1"></a> + ## Parsing bridge network statuses Bridge network status documents contain the information of which bridges @@ -75,6 +78,7 @@ bridges given out should contain at least a given number of bridges with these flags. <a id="bridgedb-spec.txt-1.2"></a> + ## Parsing bridge descriptors BridgeDB learns about a bridge's most recent IP address and OR port @@ -116,6 +120,7 @@ the bridge network status parsed before, it does not add that bridge to the set of bridges to be given out to bridge users. <a id="bridgedb-spec.txt-1.3"></a> + ## Parsing extra-info documents BridgeDB learns if a bridge supports a pluggable transport by parsing @@ -142,6 +147,7 @@ fingerprint. Arguments are comma-separated and are of the form k=v,k=v. Bridges that do not have an associated extra-info entry are not invalid. <a id="bridgedb-spec.txt-2"></a> + # Assigning bridges to distributors A "distributor" is a mechanism by which bridges are given (or not @@ -163,6 +169,7 @@ distributors, even if probabilities for assigning bridges to distributors change or distributors are disabled entirely. <a id="bridgedb-spec.txt-3"></a> + # Giving out bridges upon requests Upon receiving a client request, a BridgeDB distributor provides a @@ -179,6 +186,7 @@ transport type, bridge relay flag, or country in which the bridge should not be blocked. <a id="bridgedb-spec.txt-4"></a> + # Selecting bridges to be given out based on IP addresses ```text @@ -282,6 +290,7 @@ total." To do this, BridgeDB combines to the results: ``` <a id="bridgedb-spec.txt-5"></a> + # Selecting bridges to be given out based on email addresses ```text @@ -356,6 +365,7 @@ proceeds as follows: ``` <a id="bridgedb-spec.txt-6"></a> + # Selecting unallocated bridges to be stored in file buckets # Kaner should have a look at this section. -NM @@ -384,6 +394,7 @@ proceeds as follows: ``` <a id="bridgedb-spec.txt-7"></a> + # Displaying Bridge Information After bridges are selected using one of the methods described in @@ -409,6 +420,7 @@ Previously, each line was prepended with the "bridge" keyword, such as > See the commit message for b70347a9c5fd769c6d5d0c0eb5171ace2999a736. <a id="bridgedb-spec.txt-8"></a> + # Writing bridge assignments for statistics BridgeDB can be configured to write bridge assignments to disk for @@ -437,4 +449,3 @@ value to indicate to which IP address area the bridge is returned. The "unallocated" distributor allows the key "bucket" with the file bucket name as value to indicate which file bucket a bridge is assigned to. - |