Index

A B C D E F G H I L M N O P R S T U V W 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

additionalKeyValues() - Method in interface org.torproject.descriptor.BandwidthFile.RelayLine
Additional relay key-value pairs, excluding the key value pairs already parsed for relay identities and bandwidths.

B

BandwidthFile - Interface in org.torproject.descriptor
A bandwidth file contains information on relays' bandwidth capacities and is produced by bandwidth generators, previously known as bandwidth scanners.
BandwidthFile.RelayLine - Interface in org.torproject.descriptor
 
BandwidthHistory - Interface in org.torproject.descriptor
Contains the bandwidth history of a relay or bridge.
bridgedbMetricCounts() - Method in interface org.torproject.descriptor.BridgedbMetrics
Return approximate request numbers to the BridgeDB service in the measurement interval broken down by distribution mechanism, obfuscation protocol, and country code.
BridgedbMetrics - Interface in org.torproject.descriptor
Contains aggregated information about requests to the BridgeDB service.
bridgedbMetricsEnd() - Method in interface org.torproject.descriptor.BridgedbMetrics
Return the end of the included measurement interval.
bridgedbMetricsIntervalLength() - Method in interface org.torproject.descriptor.BridgedbMetrics
Return the length of the included measurement interval.
bridgedbMetricsVersion() - Method in interface org.torproject.descriptor.BridgedbMetrics
Return the BridgeDB metrics format version.
BridgeExtraInfoDescriptor - Interface in org.torproject.descriptor
Contains a sanitized bridge extra-info descriptor.
BridgeNetworkStatus - Interface in org.torproject.descriptor
Contains a sanitized bridge network status document.
BridgePoolAssignment - Interface in org.torproject.descriptor
Contains a sanitized list of bridges together with the distribution pools they have been assigned to by the bridge distribution service BridgeDB.
BridgeServerDescriptor - Interface in org.torproject.descriptor
Contains a sanitized bridge server descriptor.
bridgestrapCachedRequests() - Method in interface org.torproject.descriptor.BridgestrapStats
 
BridgestrapStats - Interface in org.torproject.descriptor
 
bridgestrapStatsEnd() - Method in interface org.torproject.descriptor.BridgestrapStats
 
bridgestrapStatsIntervalLength() - Method in interface org.torproject.descriptor.BridgestrapStats
 
BridgestrapTestResult - Interface in org.torproject.descriptor
 
bridgestrapTests() - Method in interface org.torproject.descriptor.BridgestrapStats
 
bw() - Method in interface org.torproject.descriptor.BandwidthFile.RelayLine
Bandwidth of this relay in kilobytes per second.

C

clientDeniedCount() - Method in interface org.torproject.descriptor.SnowflakeStats
Return a count of the number of times a client has requested a proxy from the broker but no proxies were available, rounded up to the nearest multiple of 8.
clientRestrictedDeniedCount() - Method in interface org.torproject.descriptor.SnowflakeStats
Return a count of the number of times a client with a restricted or unknown NAT type has requested a proxy from the broker but no proxies were available, rounded up to the nearest multiple of 8.
clientSnowflakeMatchCount() - Method in interface org.torproject.descriptor.SnowflakeStats
Return a count of the number of times a client successfully received a proxy from the broker, rounded up to the nearest multiple of 8.
clientUnrestrictedDeniedCount() - Method in interface org.torproject.descriptor.SnowflakeStats
Return a count of the number of times a client with an unrestricted NAT type has requested a proxy from the broker but no proxies were available, rounded up to the nearest multiple of 8.
collectDescriptors(String, String[], long, File, boolean) - Method in interface org.torproject.descriptor.DescriptorCollector
Fetch remote files from a CollecTor instance that do not yet exist locally and possibly delete local files that do not exist remotely anymore.
COLLECTOR_DEFAULT - Static variable in class org.torproject.descriptor.DescriptorSourceFactory
Default implementation of the DescriptorCollector descriptor source.
COLLECTOR_PROPERTY - Static variable in class org.torproject.descriptor.DescriptorSourceFactory
Property name for overriding the implementation of the DescriptorCollector descriptor source, which is by default set to the class in DescriptorSourceFactory.COLLECTOR_DEFAULT.
containsStatusEntry(String) - Method in interface org.torproject.descriptor.RelayNetworkStatus
Return whether a status entry with the given relay fingerprint (SHA-1 digest of the server's public identity key, encoded as 40 upper-case hexadecimal characters) exists; convenience method for getStatusEntries().containsKey(fingerprint).
containsStatusEntry(String) - Method in interface org.torproject.descriptor.RelayNetworkStatusConsensus
Return whether a status entry with the given relay fingerprint (SHA-1 digest of the server's public identity key, encoded as 40 upper-case hexadecimal characters) exists; convenience method for getStatusEntries().containsKey(fingerprint).
containsStatusEntry(String) - Method in interface org.torproject.descriptor.RelayNetworkStatusVote
Return whether a status entry with the given relay fingerprint (SHA-1 digest of the server's public identity key, encoded as 40 upper-case hexadecimal characters) exists; convenience method for getStatusEntries().containsKey(fingerprint).
createDescriptorCollector() - Static method in class org.torproject.descriptor.DescriptorSourceFactory
Create a new DescriptorCollector by instantiating the class in DescriptorSourceFactory.COLLECTOR_PROPERTY.
createDescriptorParser() - Static method in class org.torproject.descriptor.DescriptorSourceFactory
Create a new DescriptorParser by instantiating the class in DescriptorSourceFactory.PARSER_PROPERTY.
createDescriptorReader() - Static method in class org.torproject.descriptor.DescriptorSourceFactory
Create a new DescriptorReader by instantiating the class in DescriptorSourceFactory.READER_PROPERTY.

D

decompressedByteStream() - Method in interface org.torproject.descriptor.LogDescriptor
Returns the decompressed raw descriptor bytes of the log as stream.
Descriptor - Interface in org.torproject.descriptor
Superinterface for any descriptor with access to generic information about the descriptor.
DescriptorCollector - Interface in org.torproject.descriptor
Descriptor source that synchronizes descriptors from the CollecTor service to a given local directory.
DescriptorParseException - Exception Class in org.torproject.descriptor
Thrown if raw descriptor contents cannot be parsed to one or more Descriptor instances, according to descriptor specifications.
DescriptorParseException(String) - Constructor for exception class org.torproject.descriptor.DescriptorParseException
 
DescriptorParseException(String, Exception) - Constructor for exception class org.torproject.descriptor.DescriptorParseException
 
DescriptorParser - Interface in org.torproject.descriptor
Descriptor source that parses descriptors from raw descriptor contents.
DescriptorReader - Interface in org.torproject.descriptor
Descriptor source that reads descriptors from local files and provides an iterator over parsed descriptors.
DescriptorSourceFactory - Class in org.torproject.descriptor
Factory for descriptor sources which in turn produce descriptors.
DescriptorSourceFactory() - Constructor for class org.torproject.descriptor.DescriptorSourceFactory
 
destinationsCountries() - Method in interface org.torproject.descriptor.BandwidthFile
Country, as in political geolocation, or countries where the destination web server(s) are located.
didTimeout() - Method in interface org.torproject.descriptor.TorperfResult
Return whether the request timed out (as opposed to failing), or null if the torperf line didn't contain that information.
digestSha256Base64() - Method in interface org.torproject.descriptor.BandwidthFile
Return the SHA-256 bandwidth file digest, encoded as 43 base64 characters without padding characters, that is used to reference this bandwidth file from a vote.
dirauthNickname() - Method in interface org.torproject.descriptor.BandwidthFile
The dirauth's nickname which publishes this V3BandwidthsFile.
DirectoryKeyCertificate - Interface in org.torproject.descriptor
Contains a key certificate in the version 3 directory protocol.
DirectorySignature - Interface in org.torproject.descriptor
Contains the signature of a network status consensus or vote.
DirSourceEntry - Interface in org.torproject.descriptor
Contains details about an authority and its vote that contributed to a consensus.

E

earliestBandwidth() - Method in interface org.torproject.descriptor.BandwidthFile
Timestamp in UTC time zone when the first relay bandwidth was obtained.
EOL - Static variable in interface org.torproject.descriptor.ExitList
End-of-line character expected in exit lists.
EOL - Static variable in interface org.torproject.descriptor.GeoipFile
 
EOL - Static variable in interface org.torproject.descriptor.GeoipNamesFile
 
ExitList - Interface in org.torproject.descriptor
Contains an exit list containing the IP addresses of relays that the exit list service TorDNSEL found when exiting through them.
ExitList.Entry - Interface in org.torproject.descriptor
Exit list entry containing results from a single exit scan.
ExtraInfoDescriptor - Interface in org.torproject.descriptor
Contains a relay or sanitized bridge extra-info descriptor.

F

fileCreated() - Method in interface org.torproject.descriptor.BandwidthFile
Timestamp in UTC time zone when the file was created.

G

generatorStarted() - Method in interface org.torproject.descriptor.BandwidthFile
Timestamp in UTC time zone when the generator was started.
GeoipFile - Interface in org.torproject.descriptor
A GeoIP file contains information about the geographical (country code) and topological (autonomous system) location of an IP address.
GeoipFile.GeoipEntry - Interface in org.torproject.descriptor
 
GeoipNamesFile - Interface in org.torproject.descriptor
 
GET - Enum constant in enum class org.torproject.descriptor.Method
 
getAddress() - Method in interface org.torproject.descriptor.DirectoryKeyCertificate
Return the authority's primary IPv4 address in dotted-quad format, or null if the certificate does not contain an address.
getAddress() - Method in interface org.torproject.descriptor.NetworkStatusEntry
Return the server's primary IPv4 address in dotted-quad format.
getAddress() - Method in interface org.torproject.descriptor.RelayNetworkStatus
Return the authority's primary IPv4 address in dotted-quad format, or null if the descriptor does not contain an address.
getAddress() - Method in interface org.torproject.descriptor.RelayNetworkStatusVote
Return the authority's primary IPv4 address in dotted-quad format, or null if the descriptor does not contain an address.
getAddress() - Method in interface org.torproject.descriptor.ServerDescriptor
Get the server's primary IPv4 address in dotted-quad format.
getAlgorithm() - Method in interface org.torproject.descriptor.DirectorySignature
Return the digest algorithm, which is "sha1" by default and which can be "sha256" or another digest algorithm.
getAllowSingleHopExits() - Method in interface org.torproject.descriptor.ServerDescriptor
Get whether this server allows single-hop circuits to make exit connections.
getAnnotations() - Method in interface org.torproject.descriptor.Descriptor
Return the (possibly empty) list of annotations in the format "@key( value)*".
getAnnotations() - Method in interface org.torproject.descriptor.LogDescriptor
Returns annotations found in the log file, which may be an empty List if a log format does not support adding annotations.
getAnnotations() - Method in interface org.torproject.descriptor.UnparseableDescriptor
Will always throw an UnsupportedOperationException.
getAutonomousSystemNumber() - Method in interface org.torproject.descriptor.GeoipFile.GeoipEntry
 
getBandwidth() - Method in interface org.torproject.descriptor.NetworkStatusEntry
Return the bandwidth weight of this server or -1 if the status entry didn't contain a bandwidth line.
getBandwidthBurst() - Method in interface org.torproject.descriptor.ServerDescriptor
Get the burst bandwidth in bytes per second that the server is willing to sustain in very short intervals.
getBandwidthFileDigestSha256Base64() - Method in interface org.torproject.descriptor.RelayNetworkStatusVote
Return the SHA256 digest of the bandwidth file, encoded as 43 base64 characters without padding characters, or null if the authority producing this vote is not configured with a bandwidth file or does not include the SHA256 digest of the configured bandwidth file in its vote.
getBandwidthFileHeaders() - Method in interface org.torproject.descriptor.RelayNetworkStatusVote
Return the headers from the bandwidth file used to generate this vote, or null if the authority producing this vote is not configured with a bandwidth file or does not include the headers of the configured bandwidth file in its vote.
getBandwidthObserved() - Method in interface org.torproject.descriptor.ServerDescriptor
Get the observed bandwidth in bytes per second as an estimate of the capacity that the server can handle, or -1 if the descriptor doesn't contain an observed bandwidth value (which is the case for Tor 0.0.8 or older).
getBandwidthRate() - Method in interface org.torproject.descriptor.ServerDescriptor
Get the average bandwidth in bytes per second that the server is willing to sustain over long periods.
getBandwidthValues() - Method in interface org.torproject.descriptor.BandwidthHistory
Return the (possibly empty) bandwidth history with map keys being times in milliseconds since the epoch when intervals end and map values being number of bytes used in the interval, ordered from oldest to newest interval.
getBandwidthWeights() - Method in interface org.torproject.descriptor.RelayNetworkStatusConsensus
Return optional weights to be applied to router bandwidths during path selection with map keys being case-sensitive weight identifiers and map values being weight values, or null if the consensus doesn't contain such weights.
getBridgeDistributionRequest() - Method in interface org.torproject.descriptor.ServerDescriptor
Get the method how a bridge requests to be distributed by BridgeDB, or null if no such request is contained in the descriptor.
getBridgeIps() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get statistics on bridge client IP addresses by country with map keys being country codes and map values being the number of unique IP addresses that have connected from that country rounded up to the nearest multiple of 8, or null if no such statistics are included.
getBridgeIpTransports() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get statistics on bridge client IP addresses by transport with map keys being pluggable transport names, e.g., "obfs2" or "obfs3" for known transports, "<OR>" for the default onion routing protocol, or "<??>" for an unknown transport, and map values being the number of unique IP addresses rounded up to the nearest multiple of 8, or null if no such statistics are included.
getBridgeIpVersions() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get statistics on bridge client IP addresses by IP version with map keys being protocol families, e.g., "v4" or "v6", and map values being the number of unique IP addresses rounded up to the nearest multiple of 8, or null if no such statistics are included.
getBridgeStatsEndMillis() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the time in milliseconds since the epoch when the included bridge statistics interval ended, or -1 if no such statistics are included.
getBridgeStatsIntervalLength() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the interval length of the included bridge statistics in seconds, or -1L if no such statistics are included.
getBuildTimes() - Method in interface org.torproject.descriptor.TorperfResult
Return a list of times in milliseconds between launching the circuit and extending to the next circuit hop, or null if the torperf line didn't contain that information.
getCachesExtraInfo() - Method in interface org.torproject.descriptor.ServerDescriptor
Return whether this server is a directory cache that provides extra-info descriptors.
getCellCircuitsPerDecile() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the mean number of circuits included in any of the cell statistics deciles, or -1 if no such statistics are included.
getCellProcessedCells() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the mean number of processed cells per circuit by circuit decile starting with the loudest decile at index 0 and the quietest decile at index 8, or null if no such statistics are included.
getCellQueuedCells() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the mean number of cells contained in circuit queues by circuit decile starting with the loudest decile at index 0 and the quietest decile at index 8, or null if no such statistics are included.
getCellStatsEndMillis() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the time in milliseconds since the epoch when the included cell statistics interval ended, or -1L if no such statistics are included.
getCellStatsIntervalLength() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the interval length of the included cell statistics in seconds, or -1L if no such statistics are included.
getCellTimeInQueue() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the mean times in milliseconds that cells spend in circuit queues by circuit decile starting with the loudest decile at index 0 and the quietest decile at index 8, or null if no such statistics are included.
getCircId() - Method in interface org.torproject.descriptor.TorperfResult
Return the identifier of the circuit used for this measurement, or -1 if the torperf line didn't contain that information.
getCircuitProtocolVersions() - Method in interface org.torproject.descriptor.ServerDescriptor
Get the list of circuit protocol versions that this server supports.
getConnBiDirectBelow() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the number of connections on which this server read and wrote less than 2 KiB/s in a 10-second interval, or -1 if no such statistics are included.
getConnBiDirectBoth() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the number of connections on which this server read and wrote at least 2 KiB/s in a 10-second interval but not 10 times more in either direction, or -1 if no such statistics are included.
getConnBiDirectRead() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the number of connections on which this server read and wrote at least 2 KiB/s in a 10-second interval and at least 10 times more in read direction than in write direction, or -1 if no such statistics are included.
getConnBiDirectStatsEndMillis() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the time in milliseconds since the epoch when the included statistics on bi-directional connection usage ended, or -1L if no such statistics are included.
getConnBiDirectStatsIntervalLength() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the interval length of the included statistics on bi-directional connection usage in seconds, or -1L if no such statistics are included.
getConnBiDirectWrite() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the number of connections on which this server read and wrote at least 2 KiB/s in a 10-second interval and at least 10 times more in write direction than in read direction, or -1 if no such statistics are included.
getConnectMillis() - Method in interface org.torproject.descriptor.TorperfResult
Return the time in milliseconds since the epoch when the socket was connected.
getConsensusFlavor() - Method in interface org.torproject.descriptor.RelayNetworkStatusConsensus
Return the consensus flavor name, which denotes the variant of the original, unflavored consensus, encoded as a string of alphanumeric characters and dashes, or null if this descriptor is the unflavored consensus.
getConsensusMethod() - Method in interface org.torproject.descriptor.RelayNetworkStatusConsensus
Return the consensus method number of this descriptor, which is the highest consensus method supported by more than 2/3 of voting authorities, or 0 if no consensus method is contained in the descriptor.
getConsensusMethods() - Method in interface org.torproject.descriptor.RelayNetworkStatusVote
Return the list of consensus method numbers supported by this authority, or null if the descriptor doesn't say so, which would mean that only method 1 is supported.
getConsensusParams() - Method in interface org.torproject.descriptor.RelayNetworkStatusConsensus
Return consensus parameters contained in this descriptor with map keys being case-sensitive parameter identifiers and map values being parameter values, or null if the consensus doesn't contain consensus parameters.
getConsensusParams() - Method in interface org.torproject.descriptor.RelayNetworkStatusVote
Return consensus parameters contained in this descriptor with map keys being case-sensitive parameter identifiers and map values being parameter values, or null if the authority doesn't include consensus parameters in its vote.
getContact() - Method in interface org.torproject.descriptor.ServerDescriptor
Get the contact information for this server, which may contain non-ASCII characters, or null if no contact information is included in the descriptor.
getContactLine() - Method in interface org.torproject.descriptor.DirSourceEntry
Return the contact information for this authority, which may contain non-ASCII characters.
getContactLine() - Method in interface org.torproject.descriptor.RelayNetworkStatus
Return the contact information for this authority, which may contain non-ASCII characters.
getContactLine() - Method in interface org.torproject.descriptor.RelayNetworkStatusVote
Return the contact information for this authority, which may contain non-ASCII characters, or null if no contact information is included in the descriptor.
getCountryCode() - Method in interface org.torproject.descriptor.GeoipFile.GeoipEntry
 
getDataCompleteMillis() - Method in interface org.torproject.descriptor.TorperfResult
Return the time in milliseconds since the epoch when the payload was complete.
getDataPercentiles() - Method in interface org.torproject.descriptor.TorperfResult
Return the times in milliseconds since the epoch when x% of expected bytes were read for 0 <= x <= 100, or null if the torperf line didn't contain that information.
getDataRequestMillis() - Method in interface org.torproject.descriptor.TorperfResult
Return the time in milliseconds since the epoch when the HTTP request was written.
getDataResponseMillis() - Method in interface org.torproject.descriptor.TorperfResult
Return the time in milliseconds since the epoch when the first response was received.
getDate() - Method in interface org.torproject.descriptor.WebServerAccessLog.Line
Returns the date when the request was received.
getDefaultPolicy() - Method in interface org.torproject.descriptor.Microdescriptor
Return the default policy, "accept" or "reject", of the IPv4 port summary, or null if the descriptor didn't contain an IPv4 exit-policy summary line which is equivalent to rejecting all streams to IPv4 targets.
getDefaultPolicy() - Method in interface org.torproject.descriptor.NetworkStatusEntry
Return the default policy of the port summary, which can be either "accept" or "reject", or null if the status entry didn't contain an exit policy summary.
getDescriptor() - Method in interface org.torproject.descriptor.NetworkStatusEntry
Return the SHA-1 digest of the server descriptor, or null if the containing network status does not contain server descriptor references, like a microdesc consensus.
getDescriptorFile() - Method in interface org.torproject.descriptor.Descriptor
Return the file, tarball or plain file, that contained this descriptor, or null if this descriptor was not read from a file.
getDescriptorParseException() - Method in interface org.torproject.descriptor.UnparseableDescriptor
Return the first exception thrown while attempting to parse this descriptor.
getDigestSha1Hex() - Method in interface org.torproject.descriptor.DirectoryKeyCertificate
Return the SHA-1 certificate digest, encoded as 40 lower-case hexadecimal characters.
getDigestSha1Hex() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the SHA-1 descriptor digest, encoded as 40 lower-case (relay descriptors) or upper-case (bridge descriptors) hexadecimal characters, that is used to reference this descriptor from a server descriptor.
getDigestSha1Hex() - Method in interface org.torproject.descriptor.RelayDirectory
Return the SHA-1 directory digest, encoded as 40 lower-case hexadecimal characters, that the directory authority used to sign the directory.
getDigestSha1Hex() - Method in interface org.torproject.descriptor.RelayNetworkStatus
Return the SHA-1 status digest, encoded as 40 lower-case hexadecimal characters, that the directory authority used to sign the network status.
getDigestSha1Hex() - Method in interface org.torproject.descriptor.RelayNetworkStatusConsensus
Return the SHA-1 digest of this consensus, encoded as 40 lower-case hexadecimal characters that directory authorities use to sign the consensus.
getDigestSha1Hex() - Method in interface org.torproject.descriptor.RelayNetworkStatusVote
Return the SHA-1 digest of this vote, encoded as 40 lower-case hexadecimal characters that is used to reference this vote from a consensus.
getDigestSha1Hex() - Method in interface org.torproject.descriptor.ServerDescriptor
Return the SHA-1 descriptor digest, encoded as 40 lower-case (relay descriptors) or upper-case (bridge descriptors) hexadecimal characters, that is used to reference this descriptor from a network status descriptor.
getDigestSha256Base64() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the SHA-256 descriptor digest, encoded as 43 base64 characters without padding characters, that may be used to reference this descriptor from a server descriptor.
getDigestSha256Base64() - Method in interface org.torproject.descriptor.Microdescriptor
Return the SHA-256 descriptor digest, encoded as 43 base64 characters without padding characters, that is used to reference this descriptor from a vote or microdescriptor consensus.
getDigestSha256Base64() - Method in interface org.torproject.descriptor.ServerDescriptor
Get the SHA-256 descriptor digest, encoded as 43 base64 characters without padding characters, that may be used to reference this server descriptor from a network status descriptor.
getDigestSha256Hex() - Method in interface org.torproject.descriptor.Microdescriptor
Return the SHA-256 descriptor digest, encoded as 64 lower-case hexadecimal characters, that can be used as file name when writing this descriptor to disk.
getDirectorySignature() - Method in interface org.torproject.descriptor.RelayDirectory
Return the directory signature string made with the authority's identity key.
getDirectorySignature() - Method in interface org.torproject.descriptor.RelayNetworkStatus
Return the directory signature string made with the authority's identity key.
getDirIdentityKey() - Method in interface org.torproject.descriptor.DirectoryKeyCertificate
Return the authority's identity key in PEM format.
getDirIdentityKey() - Method in interface org.torproject.descriptor.RelayNetworkStatusVote
Return the authority's identity key in PEM format.
getDirKeyCertificateVersion() - Method in interface org.torproject.descriptor.DirectoryKeyCertificate
Return the version of this descriptor, which must be 3 or higher.
getDirKeyCertificateVersion() - Method in interface org.torproject.descriptor.RelayNetworkStatusVote
Return the version of the directory key certificate used by this authority, which must be 3 or higher.
getDirKeyCertification() - Method in interface org.torproject.descriptor.DirectoryKeyCertificate
Return the certificate signature from the initial item "dir-key-certificate-version" until the final item "dir-key-certification", signed with the authority identity key.
getDirKeyCertification() - Method in interface org.torproject.descriptor.RelayNetworkStatusVote
Return the certificate signature from the initial item "dir-key-certificate-version" until the final item "dir-key-certification", signed with the authority identity key.
getDirKeyCrosscert() - Method in interface org.torproject.descriptor.DirectoryKeyCertificate
Return the signature of the authority's identity key made using the authority's signing key, or null if the certificate does not contain such a signature.
getDirKeyCrosscert() - Method in interface org.torproject.descriptor.RelayNetworkStatusVote
Return the signature of the authority's identity key made using the authority's signing key, or null if the vote does not contain such a signature.
getDirKeyExpiresMillis() - Method in interface org.torproject.descriptor.DirectoryKeyCertificate
Return the time in milliseconds since the epoch after which the authority's signing key is no longer valid.
getDirKeyExpiresMillis() - Method in interface org.torproject.descriptor.RelayNetworkStatusVote
Return the time in milliseconds since the epoch after which the authority's signing key is no longer valid.
getDirKeyPublishedMillis() - Method in interface org.torproject.descriptor.DirectoryKeyCertificate
Return the time in milliseconds since the epoch when the authority's signing key and this key certificate were generated.
getDirKeyPublishedMillis() - Method in interface org.torproject.descriptor.RelayNetworkStatusVote
Return the time in milliseconds since the epoch when the authority's signing key and corresponding key certificate were generated.
getDirOptions() - Method in interface org.torproject.descriptor.RelayNetworkStatus
Return the set of flags that this directory assigns to relays, or null if the status does not assign such flags.
getDirport() - Method in interface org.torproject.descriptor.RelayNetworkStatus
Return the TCP port where this authority accepts directory-related HTTP connections, or 0 if the authority does not accept such connections.
getDirport() - Method in interface org.torproject.descriptor.RelayNetworkStatusVote
Return the TCP port where this authority accepts directory-related HTTP connections, or 0 if the authority does not accept such connections.
getDirPort() - Method in interface org.torproject.descriptor.DirSourceEntry
Return the TCP port where this authority accepts directory-related HTTP connections.
getDirPort() - Method in interface org.torproject.descriptor.NetworkStatusEntry
Return the TCP port where this server accepts directory-related HTTP connections.
getDirPort() - Method in interface org.torproject.descriptor.ServerDescriptor
Get the TCP port where this server accepts directory-related HTTP connections, or 0 if the server does not accept such connections.
getDirreqReadHistory() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the directory request read history contained in this descriptor, ornull if no such history is contained.
getDirreqStatsEndMillis() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the time in milliseconds since the epoch when the included directory request statistics interval ended, or -1L if no such statistics are included.
getDirreqStatsIntervalLength() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the interval length of the included directory request statistics in seconds, or -1 if no such statistics are included.
getDirreqV2DirectDl() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get statistics on directory requests for v2 network statuses to the server's directory port with map keys being statistic keys and map values being statistic values like counts or quantiles, or null if no such statistics are included (which is the case with recent Tor versions).
getDirreqV2Ips() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get statistics on unique IP addresses requesting v2 network statuses with map keys being country codes and map values being numbers of unique IP addresses rounded up to the nearest multiple of 8, or null if no such statistics are included (which is the case with recent Tor versions).
getDirreqV2Reqs() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get statistics on directory requests for v2 network statuses with map keys being country codes and map values being request numbers rounded up to the nearest multiple of 8, or null if no such statistics are included (which is the case with recent Tor versions).
getDirreqV2Resp() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get statistics on responses to directory requests for v2 network statuses with map keys being response strings and map values being response numbers rounded up to the nearest multiple of 4, or null if no such statistics are included (which is the case with recent Tor versions).
getDirreqV2Share() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the share of requests for v2 network statuses that the server expects to receive from clients, or -1.0 if this share is not included (which is the case with recent Tor versions).
getDirreqV2TunneledDl() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get statistics on directory requests for v2 network statuses tunneled through a circuit with map keys being statistic keys and map values being statistic values, or null if no such statistics are included (which is the case with recent Tor versions).
getDirreqV3DirectDl() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get statistics on directory requests for v3 network status consensuses of any flavor to the server's directory port with map keys being statistic keys and map values being statistic values like counts or quantiles, or null if no such statistics are included.
getDirreqV3Ips() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get statistics on unique IP addresses requesting v3 network status consensuses of any flavor with map keys being country codes and map values being numbers of unique IP addresses rounded up to the nearest multiple of 8, or null if no such statistics are included.
getDirreqV3Reqs() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get statistics on directory requests for v3 network status consensuses of any flavor with map keys being country codes and map values being request numbers rounded up to the nearest multiple of 8, or null if no such statistics are included.
getDirreqV3Resp() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get statistics on responses to directory requests for v3 network status consensuses of any flavor with map keys being response strings and map values being response numbers rounded up to the nearest multiple of 4, or null if no such statistics are included.
getDirreqV3Share() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the share of requests for v3 network status consensuses of any flavor that the server expects to receive from clients, or -1.0 if this share is not included (which is the case with recent Tor versions).
getDirreqV3TunneledDl() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get statistics on directory requests for v3 network status consensuses of any flavor tunneled through a circuit with map keys being statistic keys and map values being statistic values, or null if no such statistics are included.
getDirreqWriteHistory() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the directory request write history contained in this descriptor, or null if no such history is contained.
getDirSigningKey() - Method in interface org.torproject.descriptor.DirectoryKeyCertificate
Return the authority's signing key in PEM format.
getDirSigningKey() - Method in interface org.torproject.descriptor.RelayDirectory
Return the RSA-1024 public key in PEM format used by this authority as long-term identity key and to sign network statuses, or null if this key is not included in the descriptor header.
getDirSigningKey() - Method in interface org.torproject.descriptor.RelayNetworkStatus
Return the RSA-1024 public key in PEM format used by this authority as long-term identity key and to sign network statuses.
getDirSigningKey() - Method in interface org.torproject.descriptor.RelayNetworkStatusVote
Return the authority's signing key in PEM format.
getDirSourceEntries() - Method in interface org.torproject.descriptor.RelayNetworkStatusConsensus
Return directory source entries for each directory authority that contributed to the consensus, with map keys being SHA-1 digests of the authorities' identity keys in the version 3 directory protocol, encoded as 40 upper-case hexadecimal characters.
getDirSourceEntryBytes() - Method in interface org.torproject.descriptor.DirSourceEntry
Return the raw directory source entry bytes.
getDistSeconds() - Method in interface org.torproject.descriptor.RelayNetworkStatusConsensus
Return the number of seconds that the directory authorities will allow to collect signatures from the other authorities when producing the next consensus.
getDistSeconds() - Method in interface org.torproject.descriptor.RelayNetworkStatusVote
Return the number of seconds that the directory authorities will allow to collect signatures from the other authorities when producing the next consensus.
getDownloadedMillis() - Method in interface org.torproject.descriptor.ExitList
Return the time in milliseconds since the epoch when this descriptor was downloaded.
getEd25519Identity() - Method in interface org.torproject.descriptor.Microdescriptor
Return a SHA-256 digest of the server's Ed25519 identity key, encoded as 43 base64 characters without padding characters, that is only included to prevent collisions between microdescriptors, or null if no such digest is included.
getEnd() - Method in interface org.torproject.descriptor.GeoipFile.GeoipEntry
 
getEndpointLocal() - Method in interface org.torproject.descriptor.TorperfResult
Return the hostname, IP address, and port that the TGen client used to connect to the local tor SOCKS port, formatted as hostname:ip:port, which may be "NULL:0.0.0.0:0" if TGen was not able to find this information or null if the OnionPerf line didn't contain this information.
getEndpointProxy() - Method in interface org.torproject.descriptor.TorperfResult
Return the hostname, IP address, and port that the TGen client used to connect to the SOCKS proxy server that tor runs, formatted as hostname:ip:port, which may be "NULL:0.0.0.0:0" if TGen was not able to find this information or null if the OnionPerf line didn't contain this information.
getEndpointRemote() - Method in interface org.torproject.descriptor.TorperfResult
Return the hostname, IP address, and port that the TGen client used to connect to the remote server, formatted as hostname:ip:port, which may be "NULL:0.0.0.0:0" if TGen was not able to find this information or null if the OnionPerf line didn't contain this information.
getEnoughMtbfInfo() - Method in interface org.torproject.descriptor.BridgeNetworkStatus
Return 1 if the authority has measured enough MTBF info to use the MTBF requirement instead of the uptime requirement for assigning the Stable flag, 0 if not, or -1 if the authority doesn't report this information.
getEnoughMtbfInfo() - Method in interface org.torproject.descriptor.RelayNetworkStatusVote
Return 1 if the authority has measured enough MTBF info to use the MTBF requirement instead of the uptime requirement for assigning the Stable flag, 0 if not, or -1 if the authority doesn't report this information.
getEntries() - Method in interface org.torproject.descriptor.BridgePoolAssignment
Return the entries contained in this bridge pool assignment list with map keys being SHA-1 digests of SHA-1 digest of the bridges' public identity keys, encoded as 40 upper-case hexadecimal characters, and map values being assignment strings, e.g.
getEntries() - Method in interface org.torproject.descriptor.ExitList
Return the unordered set of exit scan results.
getEntries() - Method in interface org.torproject.descriptor.GeoipFile
 
getEntry(InetAddress) - Method in interface org.torproject.descriptor.GeoipFile
 
getEntryIps() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get statistics on client IP addresses with map keys being country codes and map values being the number of unique IP addresses that have connected from that country rounded up to the nearest multiple of 8, or null if no such statistics are included.
getEntryStatsEndMillis() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the time in milliseconds since the epoch when the included entry statistics interval ended, or -1L if no such statistics are included.
getEntryStatsIntervalLength() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the interval length of the included entry statistics in seconds, or -1L if no such statistics are included.
getErrorCode() - Method in interface org.torproject.descriptor.TorperfResult
Return the combined error code contained in the tgen client logs and the tor client logs, or null if no error occured or if the OnionPerf line didn't contain this information.
getExcludedFiles() - Method in interface org.torproject.descriptor.DescriptorReader
Return files and last modified timestamps of files that exist in the input directory or directories, but that have been excluded from parsing, because they haven't changed since they were last read.
getExitAddresses() - Method in interface org.torproject.descriptor.ExitList.Entry
Return the IP addresses that were determined in the scan with map keys being IPv4 addresses in dotted-quad format and map values being scan times in milliseconds since the epoch.
getExitKibibytesRead() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get statistics on KiB read from streams exiting the Tor network by target TCP port with map keys being string representations of ports (or "other") and map values being KiB rounded up to the next full KiB, or null if no such statistics are included.
getExitKibibytesWritten() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get statistics on KiB written to streams exiting the Tor network by target TCP port with map keys being string representations of ports (or "other") and map values being KiB rounded up to the next full KiB, or null if no such statistics are included.
getExitPolicyLines() - Method in interface org.torproject.descriptor.ServerDescriptor
Get the server's exit policy consisting of one or more accept or reject rules that the server follows when deciding whether to allow a new stream to a given IP address and TCP port.
getExitStatsEndMillis() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the time in milliseconds since the epoch when the included exit statistics interval ended, or -1 if no such statistics are included.
getExitStatsIntervalLength() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the interval length of the included exit statistics in seconds, or -1 if no such statistics are included.
getExitStreamsOpened() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get statistics on opened streams exiting the Tor network by target TCP port with map keys being string representations of ports (or "other") and map values being the number of opened streams, rounded up to the nearest multiple of 4, or null if no such statistics are included.
getExtraInfoDigestSha1Hex() - Method in interface org.torproject.descriptor.ServerDescriptor
Get the SHA-1 digest of the server's extra-info descriptor, encoded as 40 upper-case hexadecimal characters, or null if the server did not upload a corresponding extra-info descriptor.
getExtraInfoDigestSha256Base64() - Method in interface org.torproject.descriptor.ServerDescriptor
Get the SHA-256 digest of the server's extra-info descriptor, encoded as 43 base64 characters without padding characters, or null if the server either did not upload a corresponding extra-info descriptor or did not refer to it using a SHA-256 digest.
getFamilyEntries() - Method in interface org.torproject.descriptor.Microdescriptor
Return nicknames, $-prefixed identity fingerprints, or tuples of the format $fingerprint=nickname or $fingerprint~nickname of servers contained in this server's family, or null if the descriptor does not contain a family line.
getFamilyEntries() - Method in interface org.torproject.descriptor.ServerDescriptor
Get nicknames, $-prefixed identity fingerprints, or tuples of the format $fingerprint=nickname or $fingerprint~nickname of servers contained in this server's family, or null if the descriptor does not contain a family line.
getFastBandwidth() - Method in interface org.torproject.descriptor.BridgeNetworkStatus
Return the minimum bandwidth that this authority requires for assigning the Fast flag, or -1 if the authority doesn't report this value.
getFastBandwidth() - Method in interface org.torproject.descriptor.RelayNetworkStatusVote
Return the minimum bandwidth that this authority requires for assigning the Fast flag, or -1 if the authority doesn't report this value.
getFileSize() - Method in interface org.torproject.descriptor.TorperfResult
Return the configured file size in bytes.
getFingerprint() - Method in interface org.torproject.descriptor.BridgeNetworkStatus
Return a SHA-1 digest of the bridge authority's identity key, encoded as 40 upper-case hexadecimal characters.
getFingerprint() - Method in interface org.torproject.descriptor.DirectoryKeyCertificate
Return a SHA-1 digest of the authority's long-term authority identity key used for the version 3 directory protocol, encoded as 40 upper-case hexadecimal characters.
getFingerprint() - Method in interface org.torproject.descriptor.ExitList.Entry
Return the scanned relay's fingerprint, which is a SHA-1 digest of the relays's public identity key, encoded as 40 upper-case hexadecimal characters.
getFingerprint() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the SHA-1 digest of the server's public identity key, encoded as 40 upper-case hexadecimal characters, that is typically used to uniquely identify the server.
getFingerprint() - Method in interface org.torproject.descriptor.NetworkStatusEntry
Return a SHA-1 digest of the server's identity key, encoded as 40 upper-case hexadecimal characters.
getFingerprint() - Method in interface org.torproject.descriptor.RelayNetworkStatus
Return a SHA-1 digest of the authority's public identity key, encoded as 40 upper-case hexadecimal characters, which is also used to sign network statuses.
getFingerprint() - Method in interface org.torproject.descriptor.RouterStatusEntry
Return a SHA-1 digest of the relay's identity key, encoded as 40 upper-case hexadecimal characters.
getFingerprint() - Method in interface org.torproject.descriptor.ServerDescriptor
Get a SHA-1 digest of the server's public identity key, encoded as 40 upper-case hexadecimal characters (without spaces after every 4 characters as opposed to the encoding in the descriptor), that is typically used to uniquely identify the server, or null if this descriptor does not contain a fingerprint line.
getFlags() - Method in interface org.torproject.descriptor.NetworkStatusEntry
Return the relay flags assigned to this server, or null if the status entry didn't contain any relay flags.
getFreshUntilMillis() - Method in interface org.torproject.descriptor.RelayNetworkStatusConsensus
Return the time in milliseconds since the epoch until which this descriptor is the freshest that is available.
getFreshUntilMillis() - Method in interface org.torproject.descriptor.RelayNetworkStatusVote
Return the time in milliseconds since the epoch until which the consensus is supposed to be the freshest that is available.
getGeoip6DbDigestSha1Hex() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the SHA-1 digest of the GeoIPv6 database file used by this server to resolve client IP addresses to country codes, encoded as 40 upper-case hexadecimal characters, or null if no GeoIPv6 database digest is included.
getGeoipClientOrigins() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get statistics on the origin of client IP addresses with map keys being country codes and map values being the number of unique IP addresses that have connected from that country between the start of the statistics interval and the descriptor publication time rounded up to the nearest multiple of 8, or null if no such statistics are included (which is the case except for very old Tor versions).
getGeoipDbDigestSha1Hex() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the SHA-1 digest of the GeoIP database file used by this server to resolve client IP addresses to country codes, encoded as 40 upper-case hexadecimal characters, or null if no GeoIP database digest is included.
getGeoipStartTimeMillis() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the time in milliseconds since the epoch when the included "geoip" statistics interval started, or -1L if no such statistics are included (which is the case except for very old Tor versions).
getGuardBandwidthExcludingExits() - Method in interface org.torproject.descriptor.BridgeNetworkStatus
Return the minimum bandwidth that this authority requires for assigning the Guard flag if exits can not be guards, or -1 if the authority doesn't report this value.
getGuardBandwidthExcludingExits() - Method in interface org.torproject.descriptor.RelayNetworkStatusVote
Return the minimum bandwidth that this authority requires for assigning the Guard flag if exits can not be guards, or -1 if the authority doesn't report this value.
getGuardBandwidthIncludingExits() - Method in interface org.torproject.descriptor.BridgeNetworkStatus
Return the minimum bandwidth that this authority requires for assigning the Guard flag if exits can be guards, or -1 if the authority doesn't report this value.
getGuardBandwidthIncludingExits() - Method in interface org.torproject.descriptor.RelayNetworkStatusVote
Return the minimum bandwidth that this authority requires for assigning the Guard flag if exits can be guards, or -1 if the authority doesn't report this value.
getGuardTk() - Method in interface org.torproject.descriptor.BridgeNetworkStatus
Return the minimum weighted time in seconds that this authority needs to know about a relay before assigning the Guard flag, or -1 if the authority doesn't report this information.
getGuardTk() - Method in interface org.torproject.descriptor.RelayNetworkStatusVote
Return the minimum weighted time in seconds that this authority needs to know about a relay before assigning the Guard flag, or -1 if the authority doesn't report this information.
getGuardWfu() - Method in interface org.torproject.descriptor.BridgeNetworkStatus
Return the minimum WFU (weighted fractional uptime) in percent that this authority requires for assigning the Guard flag, or -1 if the authority doesn't report this value.
getGuardWfu() - Method in interface org.torproject.descriptor.RelayNetworkStatusVote
Return the minimum WFU (weighted fractional uptime) in percent that this authority requires for assigning the Guard flag, or -1 if the authority doesn't report this value.
getHiddenServiceDirVersions() - Method in interface org.torproject.descriptor.ServerDescriptor
Deprecated.
Replaced with ServerDescriptor.isHiddenServiceDir(), because Tor has never supported versions in the hidden-service-dir descriptor line.
getHidservDirOnionsSeen() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the approximate number of unique hidden-service identities seen in descriptors published to and accepted by this hidden-service directory, or null if no such statistics are included.
getHidservDirOnionsSeenParameters() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the obfuscation parameters applied to the original measurement value of unique hidden-service identities seen in descriptors published to and accepted by this hidden-service directory, or null if no such statistics are included.
getHidservDirV3OnionsSeen() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the approximate number of unique version 3 onion service identities seen in descriptors published to and accepted by this onion service directory, or null if no such statistics are included.
getHidservDirV3OnionsSeenParameters() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the obfuscation parameters applied to the original measurement value of unique version 3 onion service identities seen in descriptors published to and accepted by this onion service directory, or null if no such statistics are included.
getHidservRendRelayedCells() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the approximate number of RELAY cells seen in either direction on a circuit after receiving and successfully processing a RENDEZVOUS1 cell, or null if no such statistics are included.
getHidservRendRelayedCellsParameters() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the obfuscation parameters applied to the original measurement value of RELAY cells seen in either direction on a circuit after receiving and successfully processing a RENDEZVOUS1 cell, or null if no such statistics are included.
getHidservRendV3RelayedCells() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the approximate number of RELAY cells seen in either direction on a version 3 onion service circuit after receiving and successfully processing a RENDEZVOUS1 cell, or null if no such statistics are included.
getHidservRendV3RelayedCellsParameters() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the obfuscation parameters applied to the original measurement value of RELAY cells seen in either direction on a version 3 onion service circuit after receiving and successfully processing a RENDEZVOUS1 cell, or null if no such statistics are included.
getHidservStatsEndMillis() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the time in milliseconds since the epoch when the included hidden-service statistics interval ended, or -1L if no such statistics are included.
getHidservStatsIntervalLength() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the interval length of the included hidden-service statistics in seconds, or -1L if no such statistics are included.
getHidservV3StatsEndMillis() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the time in milliseconds since the epoch when the included version 3 onion service statistics interval ended, or -1L if no such statistics are included.
getHidservV3StatsIntervalLength() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the interval length of the included version 3 onion service statistics in seconds, or -1L if no such statistics are included.
getHistoryEndMillis() - Method in interface org.torproject.descriptor.BandwidthHistory
Return the time in milliseconds since the epoch when the most recent interval ends.
getHostname() - Method in interface org.torproject.descriptor.DirSourceEntry
Return the authority's hostname.
getHostname() - Method in interface org.torproject.descriptor.RelayNetworkStatus
Return the authority's hostname.
getHostname() - Method in interface org.torproject.descriptor.RelayNetworkStatusVote
Return the authority's hostname.
getHostnameLocal() - Method in interface org.torproject.descriptor.TorperfResult
Return the client machine hostname, which may be "(NULL)" if the TGen client was not able to find this information or null if the OnionPerf line didn't contain this information.
getHostnameRemote() - Method in interface org.torproject.descriptor.TorperfResult
Return the server machine hostname, which may be "(NULL)" if the TGen server was not able to find this information or null if the OnionPerf line didn't contain this information.
getIdentity() - Method in interface org.torproject.descriptor.DirectorySignature
Return the SHA-1 digest of the authority's long-term identity key in the version 3 directory protocol, encoded as 40 upper-case hexadecimal characters.
getIdentity() - Method in interface org.torproject.descriptor.DirSourceEntry
Return a SHA-1 digest of the authority's long-term authority identity key used for the version 3 directory protocol, encoded as 40 upper-case hexadecimal characters.
getIdentity() - Method in interface org.torproject.descriptor.RelayNetworkStatusVote
Return a SHA-1 digest of the authority's long-term authority identity key used for the version 3 directory protocol, encoded as 40 upper-case hexadecimal characters.
getIdentityEd25519() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the Ed25519 certificate in PEM format, or null if the descriptor doesn't contain one.
getIdentityEd25519() - Method in interface org.torproject.descriptor.ServerDescriptor
Get the Ed25519 certificate in PEM format, or null if the descriptor doesn't contain one.
getIgnoringAdvertisedBws() - Method in interface org.torproject.descriptor.BridgeNetworkStatus
Return 1 if the authority has enough measured bandwidths that it'll ignore the advertised bandwidth claims of routers without measured bandwidth, 0 if not, or -1 if the authority doesn't report this information.
getIgnoringAdvertisedBws() - Method in interface org.torproject.descriptor.RelayNetworkStatusVote
Return 1 if the authority has enough measured bandwidths that it'll ignore the advertised bandwidth claims of routers without measured bandwidth, 0 if not, or -1 if the authority doesn't report this information.
getIntervalLength() - Method in interface org.torproject.descriptor.BandwidthHistory
Return the interval length in seconds.
getIp() - Method in interface org.torproject.descriptor.DirSourceEntry
Return the authority's primary IPv4 address in dotted-quad format.
getIp() - Method in interface org.torproject.descriptor.WebServerAccessLog.Line
Returns the IP address of the requesting host.
getIpv6ConnBiDirectBelow() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the number of IPv6 connections on which this server read and wrote less than 2 KiB/s in a 10-second interval, or -1 if no such statistics are included.
getIpv6ConnBiDirectBoth() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the number of IPv6 connections on which this server read and wrote at least 2 KiB/s in a 10-second interval but not 10 times more in either direction, or -1 if no such statistics are included.
getIpv6ConnBiDirectRead() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the number of IPv6 connections on which this server read and wrote at least 2 KiB/s in a 10-second interval and at least 10 times more in read direction than in write direction, or -1 if no such statistics are included.
getIpv6ConnBiDirectStatsEndMillis() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the time in milliseconds since the epoch when the included statistics on bi-directional IPv6 connection usage ended, or -1L if no such statistics are included.
getIpv6ConnBiDirectStatsIntervalLength() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the interval length of the included statistics on bi-directional IPv6 connection usage in seconds, or -1L if no such statistics are included.
getIpv6ConnBiDirectWrite() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the number of IPv6 connections on which this server read and wrote at least 2 KiB/s in a 10-second interval and at least 10 times more in write direction than in read direction, or -1 if no such statistics are included.
getIpv6DefaultPolicy() - Method in interface org.torproject.descriptor.Microdescriptor
Return the default policy, "accept" or "reject", of the IPv6 port summary, or null if the descriptor didn't contain an IPv6 exit-policy summary line which is equivalent to rejecting all streams to IPv6 targets.
getIpv6DefaultPolicy() - Method in interface org.torproject.descriptor.ServerDescriptor
Get the default policy, "accept" or "reject", of the IPv6 port summary, or null if the descriptor didn't contain an IPv6 exit-policy summary line which is equivalent to rejecting all streams to IPv6 targets.
getIpv6PortList() - Method in interface org.torproject.descriptor.Microdescriptor
Return the port list of the IPv6 exit-policy summary, or null if the descriptor didn't contain an IPv6 exit-policy summary line which is equivalent to rejecting all streams to IPv6 targets.
getIpv6PortList() - Method in interface org.torproject.descriptor.ServerDescriptor
Get the port list of the IPv6 exit-policy summary, or null if the descriptor didn't contain an IPv6 exit-policy summary line which is equivalent to rejecting all streams to IPv6 targets.
getIpv6ReadHistory() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the server's history of read IPv6 bytes, or null if the descriptor does not contain a bandwidth history.
getIpv6WriteHistory() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the server's history of written IPv6 bytes, or null if the descriptor does not contain a bandwidth history.
getKnownFlags() - Method in interface org.torproject.descriptor.RelayNetworkStatusConsensus
Return known relay flags in this descriptor that were contained in enough votes for this consensus to be an authoritative opinion for these relay flags.
getKnownFlags() - Method in interface org.torproject.descriptor.RelayNetworkStatusVote
Return known relay flags by this authority.
getLastStatusMillis() - Method in interface org.torproject.descriptor.ExitList.Entry
Return the time in milliseconds since the epoch when the network status that this scan was based on was published.
getLaunchMillis() - Method in interface org.torproject.descriptor.TorperfResult
Return the time in milliseconds since the epoch when the circuit was launched, or -1 if the torperf line didn't contain that information.
getLegacyDirKey() - Method in interface org.torproject.descriptor.RelayNetworkStatusVote
Return the SHA-1 digest for an obsolete authority identity key still used by this authority to keep older clients working, or null if this authority does not use such a key.
getLine() - Method in interface org.torproject.descriptor.BandwidthHistory
Return the original bandwidth history line as contained in the descriptor, possibly prefixed with "opt ".
getLinkProtocolVersions() - Method in interface org.torproject.descriptor.ServerDescriptor
Return the list of link protocol versions that this server supports.
getLogDate() - Method in interface org.torproject.descriptor.WebServerAccessLog
Returns the date when requests contained in the log have been started, which is parsed from the log file path.
getMasterKeyEd25519() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the Ed25519 master key, encoded as 43 base64 characters without padding characters, which was either parsed from the optional "master-key-ed25519" line or derived from the (likewise optional) Ed25519 certificate following the "identity-ed25519" line, or null if the descriptor contains neither Ed25519 master key nor Ed25519 certificate.
getMasterKeyEd25519() - Method in interface org.torproject.descriptor.NetworkStatusEntry
Return the server's Ed25519 master key, encoded as 43 base64 characters without padding characters, "none" if the relay doesn't have an Ed25519 identity, or null if the status entry didn't contain this information or if the status is not a vote.
getMasterKeyEd25519() - Method in interface org.torproject.descriptor.ServerDescriptor
Get the Ed25519 master key, encoded as 43 base64 characters without padding characters, which was either parsed from the optional "master-key-ed25519" line or derived from the (likewise optional) Ed25519 certificate following the "identity-ed25519" line, or null if the descriptor contains neither Ed25519 master key nor Ed25519 certificate.
getMeasured() - Method in interface org.torproject.descriptor.NetworkStatusEntry
Return the measured bandwidth or -1 if the status entry either didn't contain bandwidth information or didn't contain an indication that this information is based on measured bandwidth.
getMethod() - Method in interface org.torproject.descriptor.WebServerAccessLog.Line
Returns the HTTP method, e.g., GET.
getMicrodescriptorDigestsSha256Base64() - Method in interface org.torproject.descriptor.NetworkStatusEntry
Return the (possibly empty) set of microdescriptor digests, encoded as 43 base64 characters without padding characters, if the containing network status is a vote or microdesc consensus, or null otherwise.
getNegotiateMillis() - Method in interface org.torproject.descriptor.TorperfResult
Return the time in milliseconds since the epoch when SOCKS 5 authentication methods have been negotiated.
getNetworkStatusVersion() - Method in interface org.torproject.descriptor.RelayNetworkStatus
Return the document format version of this descriptor which is 2.
getNetworkStatusVersion() - Method in interface org.torproject.descriptor.RelayNetworkStatusConsensus
Return the document format version of this descriptor which is 3 or higher.
getNetworkStatusVersion() - Method in interface org.torproject.descriptor.RelayNetworkStatusVote
Return the document format version of this descriptor which is 3 or higher.
getNickname() - Method in interface org.torproject.descriptor.DirSourceEntry
Return the authority's nickname consisting of 1 to 19 alphanumeric characters.
getNickname() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the server's nickname consisting of 1 to 19 alphanumeric characters.
getNickname() - Method in interface org.torproject.descriptor.NetworkStatusEntry
Return the server nickname consisting of 1 to 19 alphanumeric characters.
getNickname() - Method in interface org.torproject.descriptor.RelayDirectory
Return the directory nickname consisting of 1 to 19 alphanumeric characters.
getNickname() - Method in interface org.torproject.descriptor.RelayNetworkStatus
Return the authority's nickname consisting of 1 to 19 alphanumeric characters.
getNickname() - Method in interface org.torproject.descriptor.RelayNetworkStatusVote
Return the authority's nickname consisting of 1 to 19 alphanumeric characters.
getNickname() - Method in interface org.torproject.descriptor.RouterStatusEntry
Return the relay nickname consisting of 1 to 19 alphanumeric characters, or null if the relay is unverified.
getNickname() - Method in interface org.torproject.descriptor.ServerDescriptor
Get the server's nickname consisting of 1 to 19 alphanumeric characters.
getNtorOnionKey() - Method in interface org.torproject.descriptor.Microdescriptor
Return the curve25519 public key, encoded as 43 base64 characters without padding characters, that is used for the ntor circuit extended handshake, or null if the descriptor didn't contain an ntor-onion-key line.
getNtorOnionKey() - Method in interface org.torproject.descriptor.ServerDescriptor
Get the curve25519 public key, encoded as 43 base64 characters without padding characters, that is used for the ntor circuit extended handshake, or null if the descriptor didn't contain an ntor-onion-key line.
getNtorOnionKeyCrosscert() - Method in interface org.torproject.descriptor.ServerDescriptor
Get an Ed25519 signature in PEM format, generated using the server's ntor onion key, that proves that the party creating the descriptor had control over the private key corresponding to the ntor onion key, or null if the descriptor does not contain such a signature.
getNtorOnionKeyCrosscertSign() - Method in interface org.torproject.descriptor.ServerDescriptor
Get the sign of the Ed25519 public key corresponding to the ntor onion key as 0 or 1, or -1 if the descriptor does not contain this information.
getOnionKey() - Method in interface org.torproject.descriptor.Microdescriptor
Return the RSA-1024 public key in PEM format used to encrypt CREATE cells for this server, or null if the descriptor doesn't contain an onion key.
getOnionKey() - Method in interface org.torproject.descriptor.ServerDescriptor
Get the RSA-1024 public key in PEM format used to encrypt CREATE cells for this server, or null if the descriptor doesn't contain an onion key (which is the case in sanitized bridge descriptors).
getOnionKeyCrosscert() - Method in interface org.torproject.descriptor.ServerDescriptor
Get an RSA-1024 signature in PEM format, generated using the server's onion key, that proves that the party creating the descriptor had control over the private key corresponding to the onion key, or null if the descriptor does not contain such a signature.
getOrAddresses() - Method in interface org.torproject.descriptor.Microdescriptor
Return IP addresses and TCP ports where this server accepts TLS connections for the main OR protocol, or an empty list if the server does not support additional addresses or ports; entries are given in the order as they are listed in the descriptor; IPv4 addresses are given in dotted-quad format, IPv6 addresses use the colon-separated hexadecimal format surrounded by square brackets, and TCP ports are separated from the IP address using a colon.
getOrAddresses() - Method in interface org.torproject.descriptor.NetworkStatusEntry
Return additional IP addresses and TCP ports where this server accepts TLS connections for the main OR protocol, or an empty list if the network status doesn't contain any such additional addresses and ports.
getOrAddresses() - Method in interface org.torproject.descriptor.ServerDescriptor
Get IP addresses and TCP ports where this server accepts TLS connections for the main OR protocol, or an empty list if the server does not support additional addresses or ports; entries are given in the order as they are listed in the descriptor; IPv4 addresses are given in dotted-quad format, IPv6 addresses use the colon-separated hexadecimal format surrounded by square brackets, and TCP ports are separated from the IP address using a colon.
getOrport() - Method in interface org.torproject.descriptor.RelayNetworkStatusVote
Return the TCP port where this authority accepts TLS connections for the main OR protocol, or 0 if the authority does not accept such connections.
getOrPort() - Method in interface org.torproject.descriptor.DirSourceEntry
Return the TCP port where this authority accepts TLS connections for the main OR protocol.
getOrPort() - Method in interface org.torproject.descriptor.NetworkStatusEntry
Return the TCP port where this server accepts TLS connections for the main OR protocol.
getOrPort() - Method in interface org.torproject.descriptor.ServerDescriptor
Get the TCP port where this server accepts TLS connections for the main OR protocol, or 0 if the server does not accept such connections.
getOverloadFdExhaustedTimestamp() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the server's descriptor exhaustion as a timestamp.
getOverloadFdExhaustedVersion() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the version number in the overload-fd-exhausted line.
getOverloadGeneralTimestamp() - Method in interface org.torproject.descriptor.ServerDescriptor
Get the timestamp of when the server was detected in an overloaded state
getOverloadGeneralVersion() - Method in interface org.torproject.descriptor.ServerDescriptor
Get the version number in the overload-general line.
getOverloadRatelimitsBurstLimit() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the server's burst-limit, or -1L if the descriptor does not contain a bandwidth overload rate limit.
getOverloadRatelimitsRateLimit() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the server's rate-limit, or -1L if the descriptor does not contain a bandwidth overload rate limit.
getOverloadRatelimitsReadCount() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the server's read-overload-count, or -1L if the descriptor does not contain a bandwidth overload rate limit.
getOverloadRatelimitsTimestamp() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the server's history exhausted bandwidth as a timestamp of the last time this happened, or -1 if the descriptor does not contain a bandwidth overload rate limit.
getOverloadRatelimitsVersion() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the version number in the overload-ratelimits line or 0 if no overload-ratelimits line is present.
getOverloadRatelimitsWriteCount() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the server's write-overload-count, or -1 if the descriptor does not contain a bandwidth overload rate limit.
getPackageLines() - Method in interface org.torproject.descriptor.RelayNetworkStatusConsensus
Return a list of software packages and their versions together with a URL and one or more digests in the format PackageName Version URL DIGESTS that are known by at least three directory authorities and agreed upon by the majority of directory authorities, or null if the consensus does not contain package information.
getPackageLines() - Method in interface org.torproject.descriptor.RelayNetworkStatusVote
Return a list of software packages and their versions together with a URL and one or more digests in the format PackageName Version URL DIGESTS that are known by this directory authority, or null if this descriptor does not contain package information.
getPaddingCounts() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get padding-counts statistics, or null if no such statistics are included.
getPaddingCountsStatsEndMillis() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the time in milliseconds since the epoch when the included padding-counts statistics ended, or -1L if no such statistics are included.
getPaddingCountsStatsIntervalLength() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the interval length of the included padding-counts statistics in seconds, or -1 if no such statistics are included.
getParsedFiles() - Method in interface org.torproject.descriptor.DescriptorReader
Return files and last modified timestamps of files that exist in the input directory or directories and that have been parsed.
getPartials() - Method in interface org.torproject.descriptor.TorperfResult
Return the times in milliseconds since the epoch when the given number of bytes were read, or null if the torperf line didn't contain that information.
getPath() - Method in interface org.torproject.descriptor.TorperfResult
Return a list of fingerprints of the relays in the circuit, or null if the torperf line didn't contain that information.
getPhysicalHost() - Method in interface org.torproject.descriptor.WebServerAccessLog
Returns the hostname of the physical host writing this log file, which is parsed from the log file path.
getPlatform() - Method in interface org.torproject.descriptor.ServerDescriptor
Get a human-readable string describing the Tor software version and the operating system of this server, which may contain non-ASCII characters, typically written as "Tor $version on $system", or null if this descriptor does not contain a platform line.
getPort() - Method in interface org.torproject.descriptor.DirectoryKeyCertificate
Return the TCP port where this authority accepts directory-related HTTP connections, or -1 if the certificate does not contain a port.
getPortList() - Method in interface org.torproject.descriptor.Microdescriptor
Return the port list of the IPv4 exit-policy summary, or null if the descriptor didn't contain an IPv4 exit-policy summary line which is equivalent to rejecting all streams to IPv4 targets.
getPortList() - Method in interface org.torproject.descriptor.NetworkStatusEntry
Return the list of ports or port intervals of the exit port summary, or null if the status entry didn't contain an exit policy summary.
getProtocol() - Method in interface org.torproject.descriptor.WebServerAccessLog.Line
Returns the protocol and version, e.g., HTTP/1.1.
getProtocols() - Method in interface org.torproject.descriptor.NetworkStatusEntry
Return the version numbers of all protocols supported by this server, or null if the status entry does not specify supported protocol versions.
getProtocols() - Method in interface org.torproject.descriptor.ServerDescriptor
Get the version numbers of all protocols supported by this server, or null if this descriptor does not specify supported protocol versions.
getPublishedMillis() - Method in interface org.torproject.descriptor.BridgeNetworkStatus
Return the time in milliseconds since the epoch when this descriptor was published.
getPublishedMillis() - Method in interface org.torproject.descriptor.BridgePoolAssignment
Return the time in milliseconds since the epoch when this descriptor was published.
getPublishedMillis() - Method in interface org.torproject.descriptor.ExitList.Entry
Return the time in milliseconds since the epoch when the scanned relay's last known descriptor was published.
getPublishedMillis() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the time in milliseconds since the epoch when this descriptor and the corresponding server descriptor were generated.
getPublishedMillis() - Method in interface org.torproject.descriptor.NetworkStatusEntry
Return the time in milliseconds since the epoch when this descriptor was published.
getPublishedMillis() - Method in interface org.torproject.descriptor.RelayDirectory
Return the time in milliseconds since the epoch when this descriptor was published.
getPublishedMillis() - Method in interface org.torproject.descriptor.RelayNetworkStatus
Return the time in milliseconds since the epoch when this descriptor was published.
getPublishedMillis() - Method in interface org.torproject.descriptor.RelayNetworkStatusVote
Return the time in milliseconds since the epoch when this descriptor was published.
getPublishedMillis() - Method in interface org.torproject.descriptor.ServerDescriptor
Get the time in milliseconds since the epoch when this descriptor and the corresponding extra-info descriptor were generated.
getQuantile() - Method in interface org.torproject.descriptor.TorperfResult
Return the circuit build time quantile that the Tor client uses to determine its circuit-build timeout, or -1 if the torperf line didn't contain that information.
getRawDescriptorBytes() - Method in interface org.torproject.descriptor.Descriptor
Return the raw descriptor bytes.
getRawDescriptorBytes() - Method in interface org.torproject.descriptor.LogDescriptor
Returns the raw compressed descriptor bytes of the log.
getRawDescriptorLength() - Method in interface org.torproject.descriptor.Descriptor
Return the raw descriptor length in bytes.
getReadBytes() - Method in interface org.torproject.descriptor.TorperfResult
Return the total number of bytes read.
getReadHistory() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the server's history of read bytes, or null if the descriptor does not contain a bandwidth history; older Tor versions included bandwidth histories in their server descriptors (ServerDescriptor.getReadHistory()).
getReadHistory() - Method in interface org.torproject.descriptor.ServerDescriptor
Get the server's history of read bytes, or null if the descriptor does not contain a bandwidth history; current Tor versions include bandwidth histories in their extra-info descriptors (ExtraInfoDescriptor.getReadHistory()), not in their server descriptors.
getRecommendedClientProtocols() - Method in interface org.torproject.descriptor.RelayNetworkStatusConsensus
Return the version numbers of all protocols that clients should support, or null if the consensus does not contain an opinion about protocol versions.
getRecommendedClientProtocols() - Method in interface org.torproject.descriptor.RelayNetworkStatusVote
Return the version numbers of all protocols that clients should support, or null if the vote does not contain an opinion about protocol versions.
getRecommendedClientVersions() - Method in interface org.torproject.descriptor.RelayNetworkStatus
Return recommended Tor versions for client usage, or null if the authority does not recommend client versions.
getRecommendedClientVersions() - Method in interface org.torproject.descriptor.RelayNetworkStatusConsensus
Return recommended Tor versions for client usage, or null if the consensus does not contain an opinion about client versions.
getRecommendedClientVersions() - Method in interface org.torproject.descriptor.RelayNetworkStatusVote
Return recommended Tor versions for client usage, or null if the authority does not recommend client versions.
getRecommendedRelayProtocols() - Method in interface org.torproject.descriptor.RelayNetworkStatusConsensus
Return the version numbers of all protocols that relays should support, or null if the consensus does not contain an opinion about protocol versions.
getRecommendedRelayProtocols() - Method in interface org.torproject.descriptor.RelayNetworkStatusVote
Return the version numbers of all protocols that relays should support, or null if the vote does not contain an opinion about protocol versions.
getRecommendedServerVersions() - Method in interface org.torproject.descriptor.RelayNetworkStatus
Return recommended Tor versions for server usage, or null if the authority does not recommend server versions.
getRecommendedServerVersions() - Method in interface org.torproject.descriptor.RelayNetworkStatusConsensus
Return recommended Tor versions for server usage, or null if the consensus does not contain an opinion about server versions.
getRecommendedServerVersions() - Method in interface org.torproject.descriptor.RelayNetworkStatusVote
Return recommended Tor versions for server usage, or null if the authority does not recommend server versions.
getRecommendedSoftware() - Method in interface org.torproject.descriptor.RelayDirectory
Return recommended Tor versions.
getRequest() - Method in interface org.torproject.descriptor.WebServerAccessLog.Line
Returns the requested resource.
getRequestMillis() - Method in interface org.torproject.descriptor.TorperfResult
Return the time in milliseconds since the epoch when the SOCKS request was sent.
getRequiredClientProtocols() - Method in interface org.torproject.descriptor.RelayNetworkStatusConsensus
Return the version numbers of all protocols that clients must support, or null if the consensus does not contain an opinion about protocol versions.
getRequiredClientProtocols() - Method in interface org.torproject.descriptor.RelayNetworkStatusVote
Return the version numbers of all protocols that clients must support, or null if the vote does not contain an opinion about protocol versions.
getRequiredRelayProtocols() - Method in interface org.torproject.descriptor.RelayNetworkStatusConsensus
Return the version numbers of all protocols that relays must support, or null if the consensus does not contain an opinion about protocol versions.
getRequiredRelayProtocols() - Method in interface org.torproject.descriptor.RelayNetworkStatusVote
Return the version numbers of all protocols that relays must support, or null if the vote does not contain an opinion about protocol versions.
getResponse() - Method in interface org.torproject.descriptor.WebServerAccessLog.Line
Returns the final status code, e.g., 200.
getResponseMillis() - Method in interface org.torproject.descriptor.TorperfResult
Return the time in milliseconds since the epoch when the SOCKS response was received.
getRouterSignature() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the RSA-1024 signature of the PKCS1-padded descriptor digest, taken from the beginning of the router line through the newline after the router-signature line, or null if the descriptor doesn't contain a signature (which is the case in sanitized bridge descriptors).
getRouterSignature() - Method in interface org.torproject.descriptor.ServerDescriptor
Get the RSA-1024 signature of the PKCS1-padded descriptor digest, taken from the beginning of the router line through the newline after the router-signature line, or null if the descriptor doesn't contain a signature (which is the case in sanitized bridge descriptors).
getRouterSignatureEd25519() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the Ed25519 signature of the SHA-256 digest of the entire descriptor, encoded as 86 base64 characters without padding characters, from the first character up to and including the first space after the "router-sig-ed25519" string, prefixed with the string "Tor router descriptor signature v1".
getRouterSignatureEd25519() - Method in interface org.torproject.descriptor.ServerDescriptor
Get the Ed25519 signature of the SHA-256 digest of the entire descriptor, encoded as 86 base64 characters without padding characters, from the first character up to and including the first space after the "router-sig-ed25519" string, prefixed with the string "Tor router descriptor signature v1".
getRouterStatusEntries() - Method in interface org.torproject.descriptor.RelayDirectory
Return router status entries, one for each contained relay.
getRsa1024Identity() - Method in interface org.torproject.descriptor.Microdescriptor
Return a SHA-1 digest of the server's RSA-1024 identity key, encoded as 27 base64 characters without padding characters, that is only included to prevent collisions between microdescriptors, or null if no such digest is included.
getServerDescriptorParseExceptions() - Method in interface org.torproject.descriptor.RelayDirectory
Return a (very likely empty) list of exceptions from parsing the contained server descriptors.
getServerDescriptors() - Method in interface org.torproject.descriptor.RelayDirectory
Return a list of server descriptors contained in the signed directory.
getSharedRandCommitLines() - Method in interface org.torproject.descriptor.RelayNetworkStatusVote
Return all currently known directory authority commit lines for the shared randomness protocol in the original format as they are contained in this vote, or null if this vote does not contain any such line.
getSharedRandCurrentNumReveals() - Method in interface org.torproject.descriptor.RelayNetworkStatusConsensus
Return the number of commits used to generate the latest shared random value, or -1 if the consensus does not contain the latest shared random value.
getSharedRandCurrentNumReveals() - Method in interface org.torproject.descriptor.RelayNetworkStatusVote
Return the number of commits used to generate the latest shared random value, or -1 if this vote does not contain the latest shared random value.
getSharedRandCurrentValue() - Method in interface org.torproject.descriptor.RelayNetworkStatusConsensus
Return the latest shared random value, encoded in base64, or null if the consensus does not contain the latest shared random value.
getSharedRandCurrentValue() - Method in interface org.torproject.descriptor.RelayNetworkStatusVote
Return the latest shared random value, encoded in base64, or null if this vote does not contain the latest shared random value.
getSharedRandPreviousNumReveals() - Method in interface org.torproject.descriptor.RelayNetworkStatusConsensus
Return the number of commits used to generate the second-to-last shared random value, or -1 if the consensus does not contain a second-to-last shared random value.
getSharedRandPreviousNumReveals() - Method in interface org.torproject.descriptor.RelayNetworkStatusVote
Return the number of commits used to generate the second-to-last shared random value, or -1 if this vote does not contain a second-to-last shared random value.
getSharedRandPreviousValue() - Method in interface org.torproject.descriptor.RelayNetworkStatusConsensus
Return the second-to-last shared random value, encoded in base64, or null if the consensus does not contain a second-to-last shared random value.
getSharedRandPreviousValue() - Method in interface org.torproject.descriptor.RelayNetworkStatusVote
Return the second-to-last shared random value, encoded in base64, or null if this vote does not contain a second-to-last shared random value.
getSignature() - Method in interface org.torproject.descriptor.DirectorySignature
Return the directory signature string made with the authority's identity key in the version 3 directory protocol.
getSignatures() - Method in interface org.torproject.descriptor.RelayNetworkStatusConsensus
Return the list of signatures contained in this consensus.
getSignatures() - Method in interface org.torproject.descriptor.RelayNetworkStatusVote
Return a list of signatures contained in this vote, which is typically a single signature made by the authority but which may also be more than one signature made with different keys or algorithms.
getSigningKey() - Method in interface org.torproject.descriptor.ServerDescriptor
Get the RSA-1024 public key in PEM format used by this server as long-term identity key, or null if the descriptor doesn't contain a signing key (which is the case in sanitized bridge descriptors).
getSigningKeyDigestSha1Hex() - Method in interface org.torproject.descriptor.DirectorySignature
Return the SHA-1 digest of the authority's medium-term signing key in the version 3 directory protocol, encoded as 40 upper-case hexadecimal characters.
getSize() - Method in interface org.torproject.descriptor.WebServerAccessLog.Line
Returns the size of the response in bytes, if available.
getSocketMillis() - Method in interface org.torproject.descriptor.TorperfResult
Return the time in milliseconds since the epoch when the socket was created.
getSocksPort() - Method in interface org.torproject.descriptor.ServerDescriptor
Get the TCP port where this server accepts SOCKS connections, which is deprecated in the Tor Protocol and should always be 0.
getSource() - Method in interface org.torproject.descriptor.TorperfResult
Return the configured name of the data source.
getSourceAddress() - Method in interface org.torproject.descriptor.TorperfResult
Return the public IP address of the OnionPerf host obtained by connecting to well-known servers and finding the IP address in the result, which may be "unknown" if OnionPerf was not able to find this information or null if the OnionPerf line didn't contain this information.
getStableMtbf() - Method in interface org.torproject.descriptor.BridgeNetworkStatus
Return the minimum MTBF (mean time between failure) that this authority requires for assigning the Stable flag, or -1 if the authority doesn't report this value.
getStableMtbf() - Method in interface org.torproject.descriptor.RelayNetworkStatusVote
Return the minimum MTBF (mean time between failure) that this authority requires for assigning the Stable flag, or -1 if the authority doesn't report this value.
getStableUptime() - Method in interface org.torproject.descriptor.BridgeNetworkStatus
Return the minimum uptime in seconds that this authority requires for assigning the Stable flag, or -1 if the authority doesn't report this value.
getStableUptime() - Method in interface org.torproject.descriptor.RelayNetworkStatusVote
Return the minimum uptime in seconds that this authority requires for assigning the Stable flag, or -1 if the authority doesn't report this value.
getStart() - Method in interface org.torproject.descriptor.GeoipFile.GeoipEntry
 
getStartMillis() - Method in interface org.torproject.descriptor.TorperfResult
Return the time in milliseconds since the epoch when the connection process started.
getStats() - Method in interface org.torproject.descriptor.NetworkStatusEntry
Return the various statistics that an authority has computed for this relay.
getStatusEntries() - Method in interface org.torproject.descriptor.BridgeNetworkStatus
Return status entries for each contained bridge, with map keys being SHA-1 digests of SHA-1 digest of the bridges' public identity keys, encoded as 40 upper-case hexadecimal characters.
getStatusEntries() - Method in interface org.torproject.descriptor.RelayNetworkStatus
Return status entries for each contained server, with map keys being SHA-1 digests of the servers' public identity keys, encoded as 40 upper-case hexadecimal characters.
getStatusEntries() - Method in interface org.torproject.descriptor.RelayNetworkStatusConsensus
Return status entries for each contained server, with map keys being SHA-1 digests of the servers' public identity keys, encoded as 40 upper-case hexadecimal characters.
getStatusEntries() - Method in interface org.torproject.descriptor.RelayNetworkStatusVote
Return status entries for each contained server, with map keys being SHA-1 digests of the servers' public identity keys, encoded as 40 upper-case hexadecimal characters.
getStatusEntry(String) - Method in interface org.torproject.descriptor.RelayNetworkStatus
Return a status entry by relay fingerprint (SHA-1 digest of the server's public identity key, encoded as 40 upper-case hexadecimal characters), or null if no such status entry exists; convenience method for getStatusEntries().get(fingerprint).
getStatusEntry(String) - Method in interface org.torproject.descriptor.RelayNetworkStatusConsensus
Return a status entry by relay fingerprint (SHA-1 digest of the server's public identity key, encoded as 40 upper-case hexadecimal characters), or null if no such status entry exists; convenience method for getStatusEntries().get(fingerprint).
getStatusEntry(String) - Method in interface org.torproject.descriptor.RelayNetworkStatusVote
Return a status entry by relay fingerprint (SHA-1 digest of the server's public identity key, encoded as 40 upper-case hexadecimal characters), or null if no such status entry exists; convenience method for getStatusEntries().get(fingerprint).
getStatusEntryBytes() - Method in interface org.torproject.descriptor.NetworkStatusEntry
Return the raw network status entry bytes.
getSupportedConsensusMethods() - Method in interface org.torproject.descriptor.NetworkStatusEntry
Return the server's supported consensus methods, or null if the status entry didn't contain this information or if the status is not a vote.
getTimeout() - Method in interface org.torproject.descriptor.TorperfResult
Return the circuit build timeout that the Tor client used when building this circuit, or -1 if the torperf line didn't contain that information.
getTransports() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the (possibly empty) list of pluggable transports supported by this server.
getTunnelledDirServer() - Method in interface org.torproject.descriptor.ServerDescriptor
Get whether the server accepts "tunneled" directory requests using a BEGIN_DIR cell over the server's OR port.
getUnmeasured() - Method in interface org.torproject.descriptor.NetworkStatusEntry
Return whether the status entry is yet unmeasured by the bandwidth authorities; only included in consensuses using method 17 or higher.
getUnrecognizedKeys() - Method in interface org.torproject.descriptor.TorperfResult
Return all unrecognized keys together with their values, or null if all keys were recognized.
getUnrecognizedLines() - Method in interface org.torproject.descriptor.Descriptor
Return any unrecognized lines when parsing this descriptor, or an empty list if there were no unrecognized lines.
getUnrecognizedLines() - Method in interface org.torproject.descriptor.LogDescriptor
Returns unrecognized lines encountered while parsing the log, which may be an empty list or a fixed-size list with only a few entries, depending on the log type.
getUnrecognizedLines() - Method in interface org.torproject.descriptor.UnparseableDescriptor
Will always throw an UnsupportedOperationException.
getUnrecognizedLines() - Method in interface org.torproject.descriptor.WebServerAccessLog
Returns at most three unrecognized lines encountered while parsing the log.
getUptime() - Method in interface org.torproject.descriptor.ServerDescriptor
Get the number of seconds that the server process has been running (which might even be negative in a few descriptors due to a bug that was fixed in Tor 0.1.2.7-alpha), or null if the descriptor does not contain an uptime line.
getUsedAtMillis() - Method in interface org.torproject.descriptor.TorperfResult
Return the time in milliseconds since the epoch when the circuit was used, or -1 if the torperf line didn't contain that information.
getUsedBy() - Method in interface org.torproject.descriptor.TorperfResult
Return the identifier of the stream used for this measurement, or -1 if the torperf line didn't contain that information.
getUsesEnhancedDnsLogic() - Method in interface org.torproject.descriptor.ServerDescriptor
Get the enhanced DNS logic value for the server.
getValidAfterMillis() - Method in interface org.torproject.descriptor.RelayNetworkStatusConsensus
Return the time in milliseconds since the epoch at which this descriptor became valid.
getValidAfterMillis() - Method in interface org.torproject.descriptor.RelayNetworkStatusVote
Return the time in milliseconds since the epoch at which the consensus is supposed to become valid.
getValidUntilMillis() - Method in interface org.torproject.descriptor.RelayNetworkStatusConsensus
Return the time in milliseconds since the epoch until which this descriptor was valid.
getValidUntilMillis() - Method in interface org.torproject.descriptor.RelayNetworkStatusVote
Return the time in milliseconds since the epoch until which the consensus is supposed to be valid.
getVersion() - Method in interface org.torproject.descriptor.NetworkStatusEntry
Return the Tor software version, or null if the status entry didn't contain version information.
getVirtualHost() - Method in interface org.torproject.descriptor.WebServerAccessLog
Returns the hostname of the virtual host that this log file was written for, which is parsed from the log file path.
getVoteDigestSha1Hex() - Method in interface org.torproject.descriptor.DirSourceEntry
Return the SHA-1 vote digest, encoded as 40 lower-case hexadecimal characters.
getVoteSeconds() - Method in interface org.torproject.descriptor.RelayNetworkStatusConsensus
Return the number of seconds that the directory authorities will allow to collect votes from the other authorities when producing the next consensus.
getVoteSeconds() - Method in interface org.torproject.descriptor.RelayNetworkStatusVote
Return the number of seconds that the directory authorities will allow to collect votes from the other authorities when producing the next consensus.
getWriteBytes() - Method in interface org.torproject.descriptor.TorperfResult
Return the total number of bytes written.
getWriteHistory() - Method in interface org.torproject.descriptor.ExtraInfoDescriptor
Get the server's history of written bytes, or null if the descriptor does not contain a bandwidth history; older Tor versions included bandwidth histories in their server descriptors (ServerDescriptor.getWriteHistory()).
getWriteHistory() - Method in interface org.torproject.descriptor.ServerDescriptor
Get the server's history of written bytes, or null if the descriptor does not contain a bandwidth history; current Tor versions include bandwidth histories in their extra-info descriptors (ExtraInfoDescriptor.getWriteHistory()), not in their server descriptors.

H

hashedFingerprint() - Method in interface org.torproject.descriptor.BridgestrapTestResult
 
HEAD - Enum constant in enum class org.torproject.descriptor.Method
 

I

isHibernating() - Method in interface org.torproject.descriptor.ServerDescriptor
Get whether the server was hibernating when this descriptor was published and should not be used to build circuits.
isHiddenServiceDir() - Method in interface org.torproject.descriptor.ServerDescriptor
Return whether this server stores and serves hidden service descriptors.
isLegacy() - Method in interface org.torproject.descriptor.DirSourceEntry
Return whether this directory source entry was created using a legacy key.
isLive() - Method in interface org.torproject.descriptor.RouterStatusEntry
Return whether the relay is live.
isReachable() - Method in interface org.torproject.descriptor.BridgestrapTestResult
 
isSharedRandParticipate() - Method in interface org.torproject.descriptor.RelayNetworkStatusVote
Return whether this directory authority supports and can participate in the shared random protocol.
isValid() - Method in interface org.torproject.descriptor.WebServerAccessLog.Line
True, if this is a valid web server access log line.
isVerified() - Method in interface org.torproject.descriptor.RouterStatusEntry
Return whether the relay is verified.

L

latestBandwidth() - Method in interface org.torproject.descriptor.BandwidthFile
Timestamp in UTC time zone of the most recent generator bandwidth result.
LogDescriptor - Interface in org.torproject.descriptor
Contains a log file.
LogDescriptor.Line - Interface in org.torproject.descriptor
Base interface for accessing log lines.
logLines() - Method in interface org.torproject.descriptor.LogDescriptor
Returns a stream of all parseable log lines.
logLines() - Method in interface org.torproject.descriptor.WebServerAccessLog
Returns a stream of all valid log lines.

M

masterKeyEd25519() - Method in interface org.torproject.descriptor.BandwidthFile.RelayLine
Relays's master Ed25519 key, base64 encoded, without trailing "="s.
Method - Enum Class in org.torproject.descriptor
Enum for web server access log methods.
Microdescriptor - Interface in org.torproject.descriptor
Contains a relay microdescriptor.
minimumNumberEligibleRelays() - Method in interface org.torproject.descriptor.BandwidthFile
Minimum number of relays that should be included in the bandwidth file.
minimumPercentEligibleRelays() - Method in interface org.torproject.descriptor.BandwidthFile
Percentage of relays in the consensus that should be included in every generated bandwidth file.
mu() - Method in interface org.torproject.descriptor.BandwidthFile
The network stream bandwidth average calculated as explained in the bandwidth file specification.
muf() - Method in interface org.torproject.descriptor.BandwidthFile
The network stream bandwidth average filtered calculated as explained in the bandwidth file specification.

N

NetworkStatusEntry - Interface in org.torproject.descriptor
Contains an entry in a network status in the version 2 or 3 directory protocol or in a bridge network status.
nodeId() - Method in interface org.torproject.descriptor.BandwidthFile.RelayLine
Fingerprint for the relay's RSA identity key.
numberConsensusRelays() - Method in interface org.torproject.descriptor.BandwidthFile
Number of relays in the consensus.
numberEligibleRelays() - Method in interface org.torproject.descriptor.BandwidthFile
Number of relays that have enough measurements to be included in the bandwidth file.

O

org.torproject.descriptor - package org.torproject.descriptor
Interfaces and essential classes for obtaining and processing Tor descriptors.

P

parseDescriptors(byte[], File, String) - Method in interface org.torproject.descriptor.DescriptorParser
Parse descriptors in the given byte array and return the parsed/unparseable descriptors.
PARSER_DEFAULT - Static variable in class org.torproject.descriptor.DescriptorSourceFactory
Default implementation of the DescriptorParser descriptor source.
PARSER_PROPERTY - Static variable in class org.torproject.descriptor.DescriptorSourceFactory
Property name for overriding the implementation of the DescriptorParser descriptor source, which is by default set to the class in DescriptorSourceFactory.PARSER_DEFAULT.
percentEligibleRelays() - Method in interface org.torproject.descriptor.BandwidthFile
The number of eligible relays, as a percentage of the number of relays in the consensus.
POST - Enum constant in enum class org.torproject.descriptor.Method
 

R

readDescriptors(File...) - Method in interface org.torproject.descriptor.DescriptorReader
Read descriptors from the given descriptor file(s) and return the parsed descriptors.
READER_DEFAULT - Static variable in class org.torproject.descriptor.DescriptorSourceFactory
Default implementation of the DescriptorReader descriptor source.
READER_PROPERTY - Static variable in class org.torproject.descriptor.DescriptorSourceFactory
Property name for overriding the implementation of the DescriptorReader descriptor source, which is by default set to the class in DescriptorSourceFactory.READER_DEFAULT.
recentConsensusCount() - Method in interface org.torproject.descriptor.BandwidthFile
Number of the different consensuses seen in the last data period.
recentMeasurementAttemptCount() - Method in interface org.torproject.descriptor.BandwidthFile
Number of times that any relay has been queued to be measured in the last data period.
recentMeasurementFailureCount() - Method in interface org.torproject.descriptor.BandwidthFile
Number of times that the scanner attempted to measure a relay in the last data period, but the relay has not been measured because of system, network or implementation issues.
recentMeasurementsExcludedErrorCount() - Method in interface org.torproject.descriptor.BandwidthFile
Number of relays that have no successful measurements in the last data period.
recentMeasurementsExcludedFewCount() - Method in interface org.torproject.descriptor.BandwidthFile
Number of relays that don't have enough recent successful measurements.
recentMeasurementsExcludedNearCount() - Method in interface org.torproject.descriptor.BandwidthFile
Number of relays that have some successful measurements in the last data period, but all those measurements were performed in a period of time that was too short.
recentMeasurementsExcludedOldCount() - Method in interface org.torproject.descriptor.BandwidthFile
Number of relays that have some successful measurements, but all those measurements are too old.
recentPriorityListCount() - Method in interface org.torproject.descriptor.BandwidthFile
Number of times that a list with a subset of relays prioritized to be measured has been created in the last data period.
recentPriorityRelayCount() - Method in interface org.torproject.descriptor.BandwidthFile
Number of relays that has been in in the list of relays prioritized to be measured in the last data period.
RelayDirectory - Interface in org.torproject.descriptor
Contains a signed directory in the version 1 directory protocol.
RelayExtraInfoDescriptor - Interface in org.torproject.descriptor
Contains a relay extra-info descriptor.
relayLines() - Method in interface org.torproject.descriptor.BandwidthFile
List of zero or more BandwidthFile.RelayLines containing relay identities and bandwidths in the order as they are contained in the bandwidth file.
RelayNetworkStatus - Interface in org.torproject.descriptor
Contains a network status document in the version 2 directory protocol.
RelayNetworkStatusConsensus - Interface in org.torproject.descriptor
Contains a network status consensus in the version 3 directory protocol.
RelayNetworkStatusVote - Interface in org.torproject.descriptor
Contains a network status vote in the version 3 directory protocol.
RelayServerDescriptor - Interface in org.torproject.descriptor
Contains a relay server descriptor.
RouterStatusEntry - Interface in org.torproject.descriptor
Contains a router status entry contained in a signed directory in the version 1 directory protocol.

S

saveHistoryFile(File) - Method in interface org.torproject.descriptor.DescriptorReader
Save a history file with file names and last modified timestamps of descriptor files that exist in the input directory or directories and that have either been parsed or excluded from parsing.
scannerCountry() - Method in interface org.torproject.descriptor.BandwidthFile
Country, as in political geolocation, where the generator is run.
ServerDescriptor - Interface in org.torproject.descriptor
Contains a relay or sanitized bridge server descriptor.
setExcludedFiles(SortedMap<String, Long>) - Method in interface org.torproject.descriptor.DescriptorReader
Exclude files if they haven't changed since the corresponding last modified timestamps.
setHistoryFile(File) - Method in interface org.torproject.descriptor.DescriptorReader
Set a history file to load before reading descriptors and exclude descriptor files that haven't changed since they have last been read.
setMaxDescriptorsInQueue(int) - Method in interface org.torproject.descriptor.DescriptorReader
Don't keep more than this number of descriptors in the queue (default: 100).
snowflakeIdleCount() - Method in interface org.torproject.descriptor.SnowflakeStats
Return a count of the number of times a proxy has polled but received no client offer, rounded up to the nearest multiple of 8.
snowflakeIps() - Method in interface org.torproject.descriptor.SnowflakeStats
Return a list of mappings from two-letter country codes to the number of unique IP addresses of snowflake proxies that have polled.
snowflakeIpsBadge() - Method in interface org.torproject.descriptor.SnowflakeStats
Return a count of the total number of unique IP addresses of snowflake proxies of type "badge" that have polled.
snowflakeIpsNatRestricted() - Method in interface org.torproject.descriptor.SnowflakeStats
Return a count of the total number of unique IP addresses of snowflake proxies that have a restricted NAT type.
snowflakeIpsNatUnknown() - Method in interface org.torproject.descriptor.SnowflakeStats
Return a count of the total number of unique IP addresses of snowflake proxies that have an unknown NAT type.
snowflakeIpsNatUnrestricted() - Method in interface org.torproject.descriptor.SnowflakeStats
Return a count of the total number of unique IP addresses of snowflake proxies that have an unrestricted NAT type.
snowflakeIpsStandalone() - Method in interface org.torproject.descriptor.SnowflakeStats
Return a count of the total number of unique IP addresses of snowflake proxies of type "standalone" that have polled.
snowflakeIpsTotal() - Method in interface org.torproject.descriptor.SnowflakeStats
Return a count of the total number of unique IP addresses of snowflake proxies that have polled.
snowflakeIpsWebext() - Method in interface org.torproject.descriptor.SnowflakeStats
Return a count of the total number of unique IP addresses of snowflake proxies of type "webext" that have polled.
SnowflakeStats - Interface in org.torproject.descriptor
Contain aggregated information about snowflake proxies and snowflake clients.
snowflakeStatsEnd() - Method in interface org.torproject.descriptor.SnowflakeStats
Return the end of the included measurement interval.
snowflakeStatsIntervalLength() - Method in interface org.torproject.descriptor.SnowflakeStats
Return the length of the included measurement interval.
software() - Method in interface org.torproject.descriptor.BandwidthFile
Name of the software that created the document.
softwareVersion() - Method in interface org.torproject.descriptor.BandwidthFile
Version of the software that created the document.

T

timestamp() - Method in interface org.torproject.descriptor.BandwidthFile
Time of the most recent generator bandwidth result.
timeToReportHalfNetwork() - Method in interface org.torproject.descriptor.BandwidthFile
Time that it would take to report measurements about half of the network, given the number of eligible relays and the time it took in the last days.
toLogString() - Method in interface org.torproject.descriptor.LogDescriptor.Line
Returns a log line string.
TorperfResult - Interface in org.torproject.descriptor
Contains performance measurement results from making simple HTTP requests over the Tor network.
torVersion() - Method in interface org.torproject.descriptor.BandwidthFile
The Tor version of the Tor process controlled by the generator.

U

UnparseableDescriptor - Interface in org.torproject.descriptor
Contains a descriptor that could not be parsed.

V

valueOf(String) - Static method in enum class org.torproject.descriptor.Method
Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.torproject.descriptor.Method
Returns an array containing the constants of this enum class, in the order they are declared.
version() - Method in interface org.torproject.descriptor.BandwidthFile
Document format version.

W

WebServerAccessLog - Interface in org.torproject.descriptor
Contains a sanitized web server access log file from a torproject.org web server.
WebServerAccessLog.Line - Interface in org.torproject.descriptor
Facilitates access to all log line fields that don't only contain default values post sanitization.
A B C D E F G H I L M N O P R S T U V W 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form