Method Details

• getDate

  public long getDate()

  Same as getEarliestLeaseDate().

  Specified by:

  getDate in class DatabaseEntry

  Returns:

  milliseconds since the epoch of the earliest lease expiry

• getKeysAndCert

  public KeysAndCert getKeysAndCert()

  Keys and certificate for this lease set.

  Specified by:

  getKeysAndCert in class DatabaseEntry

  Returns:

  KAC or null

• getType

  public int getType()

  Lease set type for the network database.

  Specified by:

  getType in class DatabaseEntry

  Returns:

  KEY_TYPE_ROUTERINFO or KEY_TYPE_LEASESET or LS2 types

• getDestination

  public Destination getDestination()

  Warning - will be null for LS2 EncryptedLeaseSets if not decrypted.

  Returns:

  Destination or null

• setDestination

  public void setDestination(Destination dest)

  Destination for this leaseset.

  Parameters:

  dest - the destination this leaseset is published under

  Throws:

  IllegalStateException - if already signed

• getEncryptionKey

  public PublicKey getEncryptionKey()

  Encryption public key.

  Returns:

  the encryption public key

• getEncryptionKey

  public PublicKey getEncryptionKey(Set<EncType> supported)

  If more than one key, return the first supported one. If none supported, return null.

  Parameters:

  supported - what return types are allowed

  Returns:

  ElGamal key or null if ElGamal not in supported

• setEncryptionKey

  public void setEncryptionKey(PublicKey encryptionKey)

  Encryption public key for this leaseset.

  Parameters:

  encryptionKey - the ElGamal or ECIES key tunnel build requests are encrypted to, matched to the receiver by the key type

  Throws:

  IllegalStateException - if already signed

• getSigningKey

  public SigningPublicKey getSigningKey()

  The revocation key. Undeprecated as of 0.9.38, used for the blinded key in EncryptedLeaseSet.

  Returns:

  the revocation key for LS1, null for LS2 except blinded key for encrypted LS2

• setSigningKey

  public void setSigningKey(SigningPublicKey key)

  The revocation key. Unused except for encrypted LS2. Must be the same type as the Destination's SigningPublicKey.

  Parameters:

  key - the revocation key, which must match the signing public key type of the destination or the leaseset cannot be verified

  Throws:

  IllegalArgumentException - if different type

• setReceivedBy

  public void setReceivedBy(Hash localClient)

  Record the local client that received this leaseset.

  As of 0.9.65, no longer sets receivedAsReply to true.

  Overrides:

  setReceivedBy in class DatabaseEntry

  Parameters:

  localClient - may be null

• addLease

  public void addLease(Lease lease)

  Adds a lease to this leaseset.

  Parameters:

  lease - the lease to add, which must have a gateway and, outside a meta LeaseSet2, a tunnel ID

  Throws:

  IllegalStateException - if already signed

• getLeaseCount

  public int getLeaseCount()

  Number of leases in this leaseset.

  Returns:

  0-16 A LeaseSet with no leases is revoked.

• getLease

  public Lease getLease(int index)

  Lease at the given index.

  Parameters:

  index - the lease index

  Returns:

  the decrypted lease when encrypted, otherwise the stored one

• getEarliestLeaseDate

  public long getEarliestLeaseDate()

  Retrieve the end date of the earliest lease included in this leaseSet. This is the date that should be used in comparisons for leaseSet age - to determine which LeaseSet was published more recently (later earliestLeaseSetDate means it was published later)

  Warning - do not use this for version comparison for LeaseSet2. Use LeaseSet2.getPublished() instead.

  Returns:

  earliest end date of any lease in the set, or -1 if there are no leases

• getLatestLeaseDate

  public long getLatestLeaseDate()

  Retrieve the end date of the latest lease included in this leaseSet. This is the date used in isCurrent().

  Returns:

  latest end date of any lease in the set, or 0 if there are no leases

• verifySignature

  public boolean verifySignature()

  Verify that the signature matches the leaseset's destination's signing public key. As of 0.9.47, revocation is not checked.

  Overrides:

  verifySignature in class DatabaseEntry

  Returns:

  true only if the signature matches

• isCurrent

  public boolean isCurrent(long fudge)

  Determine whether ANY lease is currently valid, at least within a given fudge factor.

  Parameters:

  fudge - milliseconds fudge factor to allow between the current time

  Returns:

  true if there are current leases, false otherwise

• getBytes

  protected byte[] getBytes()

  Without the signature!

  Specified by:

  getBytes in class DatabaseEntry

  Returns:

  the raw payload data, or null on error (for example, if this is a RouterInfo, a DataFormatException is thrown instead)

• readBytes

  public void readBytes(InputStream in) throws DataFormatException, IOException

  This does NOT validate the signature.

  Parameters:

  in - stream to read from

  Throws:

  IllegalStateException - if called more than once or Destination already set

  DataFormatException - if the data is improperly formatted

  IOException - if there was a problem reading the stream

• writeBytes

  public void writeBytes(OutputStream out) throws DataFormatException, IOException

  This does NOT validate the signature.

  Parameters:

  out - stream to write to

  Throws:

  DataFormatException - if the data was incomplete or not yet ready to be written

  IOException - if there was a problem writing to the stream

• size

  public int size()

  Number of bytes, NOT including signature.

  Returns:

  the size in bytes

• equals

  public boolean equals(Object object)

  Overrides:

  equals in class Object

• hashCode

  public int hashCode()

  The destination has enough randomness in it to use it by itself for speed.

  Overrides:

  hashCode in class Object

• toString

  public String toString()

  Overrides:

  toString in class Object

• encrypt

  public void encrypt(SessionKey key)

  Encrypt the gateway and tunnel ID of each lease, leaving the expire dates unchanged. This adds an extra dummy lease, because AES data must be padded to 16 bytes. The fact that it is encrypted is not stored anywhere. Must be called after all the leases are in place, but before sign().

  Parameters:

  key - the session key whose first block is the AES key, with the remainder used to derive the initialization vector

• encryp

  private void encryp(SessionKey key) throws DataFormatException, IOException

  Encrypts the lease set in seven steps.

  • Put the {Gateway Hash, TunnelID} pairs for all the leases in a buffer
  • Pad with random data to a multiple of 16 bytes
  • Use the first part of the dest's public key as an IV
  • Encrypt
  • Pad with random data to a multiple of 36 bytes
  • Add an extra lease
  • Replace the Hash and TunnelID in each Lease

  Parameters:

  key - the AES session key to encrypt the lease data with

  Throws:

  DataFormatException - if a lease's gateway or tunnel ID is not set

  IOException - if the lease data cannot be written

• decrypt

  private void decrypt(SessionKey key) throws DataFormatException, IOException

  Decrypt the leases, except for the last one which is partially padding. Store the new decrypted leases in a backing store, and keep the original leases so that verify() still works and the encrypted leaseset can be sent on to others (via writeBytes(OutputStream)).

  Parameters:

  key - the AES session key to decrypt the lease data with

  Throws:

  DataFormatException - if there are fewer than two leases, or the data is invalid

  IOException - if the lease data cannot be read

• isEncrypted

  private boolean isEncrypted()

  True if it was encrypted, and we decrypted it successfully.

  Returns:

  true if it was encrypted, and we decrypted it successfully. Decrypts on first call.