Package org.torproject.descriptor

Interface RelayDirectory

  • All Superinterfaces:
    Descriptor, java.io.Serializable
    public interface RelayDirectory
extends Descriptor
    Contains a signed directory in the version 1 directory protocol.

    Directory authorities in the (long outdated) version 1 of the directory protocol served signed directory documents containing a list of signed server descriptors (ServerDescriptor) along with short summaries of the status of each server (RouterStatusEntry).

    Clients in that version of the directory protocol would fetch this signed directory to get up-to-date information on the state of the network and be certain that the list was attested by a trusted directory authority.

    Signed directories in the version 1 directory protocol have first been superseded by network status documents in the version 2 directory protocol (RelayNetworkStatus) and later by network status consensuses (RelayNetworkStatusConsensus) in the version 3 directory protocol.

    Since:
    1.0.0

    • Method Detail

      • getPublishedMillis

        long getPublishedMillis()
        Return the time in milliseconds since the epoch when this descriptor was published.
        Since:
        1.0.0

      • getDirSigningKey

        java.lang.String getDirSigningKey()
        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.
        Since:
        1.0.0

      • getRecommendedSoftware

        java.util.List<java.lang.String> getRecommendedSoftware()
        Return recommended Tor versions.
        Since:
        1.0.0

      • getDirectorySignature

        java.lang.String getDirectorySignature()
        Return the directory signature string made with the authority's identity key.
        Since:
        1.0.0

      • getRouterStatusEntries

        java.util.List<RouterStatusEntry> getRouterStatusEntries()
        Return router status entries, one for each contained relay.
        Since:
        1.0.0

      • getServerDescriptors

        java.util.List<ServerDescriptor> getServerDescriptors()
        Return a list of server descriptors contained in the signed directory.
        Since:
        1.0.0

      • getServerDescriptorParseExceptions

        java.util.List<java.lang.Exception> getServerDescriptorParseExceptions()
        Return a (very likely empty) list of exceptions from parsing the contained server descriptors.
        Since:
        1.0.0

      • getNickname

        java.lang.String getNickname()
        Return the directory nickname consisting of 1 to 19 alphanumeric characters.
        Since:
        1.0.0

      • getDigestSha1Hex

        java.lang.String getDigestSha1Hex()
        Return the SHA-1 directory digest, encoded as 40 lower-case hexadecimal characters, that the directory authority used to sign the directory.
        Since:
        1.7.0