MetaLeaseSet

net.i2p.data.MetaLeaseSet

All Implemented Interfaces:: Serializable, DataStructure

public class MetaLeaseSetextends LeaseSet2

Implementation of MetaLeaseSet as specified in Proposal 123: New NetDb Entries.

MetaLeaseSet is a specialized LeaseSet2 that contains references to other LeaseSets rather than direct tunnel endpoints. This enables advanced routing and load balancing strategies.

Key characteristics of MetaLeaseSet:

Contains MetaLease objects instead of regular Lease objects
Does not support encryption keys (throws UnsupportedOperationException)
References other LeaseSets by hash rather than containing tunnel endpoints directly
Supports offline signatures for reduced router load
Includes options and statistics support

Usage: MetaLeaseSets are used for:

Load balancing across multiple LeaseSets
Geographic or performance-based routing decisions
Fallback and redundancy strategies
Service discovery and aggregation

Implementation Status: PRELIMINARY - Subject to change as the proposal evolves.

See Also:

Field Summary
Fields inherited from class LeaseSet2
_expires, _flags, _offlineSignature, _options, _published, _transientExpires, _transientSigningPublicKey
Modifier and Type
Field
Description
protected long
_expires
Expiration timestamp in ms (1-second resolution).
protected int
_flags
Flags for options, offline, unpublished, blinded.
protected Signature
_offlineSignature
Offline signature.
protected Properties
_options
Options and statistics properties, may be null.
protected long
_published
Published timestamp in ms (1-second resolution).
protected long
_transientExpires
Transient key expiration in ms.
protected SigningPublicKey
_transientSigningPublicKey
Transient signing public key for offline signing.
Fields inherited from class LeaseSet
_byteified, _checked, _destination, _encryptionKey, _lastExpiration, _leases, _signingKey, MAX_LEASES
Modifier and Type
Field
Description
protected byte[]
_byteified
Cached serialized byte array for performance.
protected boolean
_checked
Whether decryption has been attempted.
protected Destination
_destination
Destination this LeaseSet is for.
protected PublicKey
_encryptionKey
Encryption public key for the destination.
protected long
_lastExpiration
Latest expiration time among all leases.
protected final List<Lease>
_leases
Leases must stay in the order received, or signature verification will fail.
protected SigningPublicKey
_signingKey
Revocation or blinded signing key.
static final int
MAX_LEASES
Unlimited before 0.6.3; 6 as of 0.6.3; Increased in version 0.9.
Fields inherited from class DatabaseEntry
_signature, KEY_TYPE_ENCRYPTED_LS2, KEY_TYPE_LEASESET, KEY_TYPE_LS2, KEY_TYPE_META_LS2, KEY_TYPE_ROUTERINFO, KEY_TYPE_SERVICE_LIST, KEY_TYPE_SERVICE_RECORD
Modifier and Type
Field
Description
protected Signature
_signature
Cryptographic signature.
static final int
KEY_TYPE_ENCRYPTED_LS2
Encrypted LeaseSet 2 type.
static final int
KEY_TYPE_LEASESET
LeaseSet (v1) type.
static final int
KEY_TYPE_LS2
LeaseSet 2 type.
static final int
KEY_TYPE_META_LS2
Meta LeaseSet 2 type.
static final int
KEY_TYPE_ROUTERINFO
Router info type.
static final int
KEY_TYPE_SERVICE_LIST
Service list type.
static final int
KEY_TYPE_SERVICE_RECORD
Service record type.
Constructor Summary
Constructors
Constructor
Description
MetaLeaseSet()
Creates a new MetaLeaseSet with default values.
Method Summary
Public Methods
Modifier and Type
Method
Description
void
addEncryptionKey(PublicKey key)
UnsupportedOperationException always.
void
addLease(Lease lease)
Must be a MetaLease.
boolean
equals(Object object)
Compares this MetaLeaseSet with another object for equality.
int
getType()
Entry type for the network database.
int
hashCode()
The destination has enough randomness in it to use it by itself for speed.
void
readBytes(InputStream in)
This does NOT validate the signature.
void
setEncryptionKey(PublicKey key)
UnsupportedOperationException always.
int
size()
Number of bytes, NOT including signature.
String
toString()
Returns a string representation of this MetaLeaseSet.
protected void
writeBytesWithoutSig(OutputStream out)
Without sig.
Methods inherited from class LeaseSet2
encrypt, getBlindedHash, getBytes, getEncryptionKey, getEncryptionKey, getEncryptionKeys, getExpires, getOption, getOptions, getPublished, getReceivedAsPublished, getTransientExpiration, getTransientSigningKey, isBlindedWhenPublished, isCurrent, isOffline, isUnpublished, offlineSign, readHeader, readOfflineBytes, setBlindedHash, setBlindedWhenPublished, setOfflineSignature, setOptions, setPublished, setSigningKey, setUnpublished, sign, verifyOfflineSignature, verifyOfflineSignature, verifySignature, writeBody, writeBytes, writeHeader, writeOfflineBytes
Modifier and Type
Method
Description
void
encrypt(SessionKey key)
Encrypt the gateway and tunnel ID of each lease, leaving the expire dates unchanged.
Hash
getBlindedHash()
The original blinded hash, where this came from.
protected byte[]
getBytes()
Without the signature!
PublicKey
getEncryptionKey()
If more than one key, return the first supported one.
PublicKey
getEncryptionKey(Set<EncType> supported)
If more than one key, return the first supported one.
List<PublicKey>
getEncryptionKeys()
This returns all the keys.
long
getExpires()
Published expiration, as received.
String
getOption(String opt)
Option value for the given key.
Properties
getOptions()
Leaseset options.
long
getPublished()
Published timestamp, as received.
boolean
getReceivedAsPublished()
If true, we received this LeaseSet by a remote peer publishing it to us, AND the unpublished flag is not set.
long
getTransientExpiration()
Absolute time, not time from now.
SigningPublicKey
getTransientSigningKey()
Transient public key for offline signing.
boolean
isBlindedWhenPublished()
Whether the unencrypted LS, when published, will be blinded/encrypted.
boolean
isCurrent(long fudge)
Determine whether the leaseset is currently valid, at least within a given fudge factor.
boolean
isOffline()
Checks if this leaseset uses offline keys.
boolean
isUnpublished()
True if unpublished.
static Signature
offlineSign(long expires, SigningPublicKey transientSPK, SigningPrivateKey priv)
Generate a Signature to pass to LeaseSet2.setOfflineSignature(long, SigningPublicKey, Signature).
protected void
readHeader(InputStream in)
Read the LeaseSet2 header from a stream.
protected void
readOfflineBytes(InputStream in)
Read the offline signing section from a stream.
void
setBlindedHash(Hash bh)
Blinded hash, if known at creation.
void
setBlindedWhenPublished()
Mark the unencrypted LS to be blinded/encrypted when published.
boolean
setOfflineSignature(long expires, SigningPublicKey transientSPK, Signature offlineSig)
Destination must be previously set.
void
setOptions(Properties options)
Configure a set of options or statistics that the router can expose.
void
setPublished(long now)
Published timestamp.
void
setSigningKey(SigningPublicKey key)
The revocation key.
void
setUnpublished()
Marks this leaseset as unpublished.
void
sign(SigningPrivateKey key)
Sign the structure using the supplied signing key.
boolean
verifyOfflineSignature()
Verify the offline signature.
protected boolean
verifyOfflineSignature(SigningPublicKey spk)
Verify the offline signature with the given key.
boolean
verifySignature()
Verify with the SPK in the dest for online sigs.
protected void
writeBody(OutputStream out)
Without sig.
void
writeBytes(OutputStream out)
Including sig.
protected void
writeHeader(OutputStream out)
Write the LeaseSet2 header to a stream.
protected void
writeOfflineBytes(OutputStream out)
Write the offline signing section to a stream.
Methods inherited from class LeaseSet
getDate, getDestination, getEarliestLeaseDate, getKeysAndCert, getLatestLeaseDate, getLease, getLeaseCount, getSigningKey, setDestination, setReceivedBy
Modifier and Type
Method
Description
long
getDate()
Same as LeaseSet.getEarliestLeaseDate().
Destination
getDestination()
Warning - will be null for LS2 EncryptedLeaseSets if not decrypted.
long
getEarliestLeaseDate()
Retrieve the end date of the earliest lease included in this leaseSet.
KeysAndCert
getKeysAndCert()
Keys and certificate for this lease set.
long
getLatestLeaseDate()
Retrieve the end date of the latest lease included in this leaseSet.
Lease
getLease(int index)
Lease at the given index.
int
getLeaseCount()
Number of leases in this leaseset.
SigningPublicKey
getSigningKey()
The revocation key.
void
setDestination(Destination dest)
Destination for this leaseset.
void
setReceivedBy(Hash localClient)
Record the local client that received this leaseset.
Methods inherited from class DatabaseEntry
getHash, getReceivedAsReply, getReceivedBy, getRoutingKey, getSignature, getSigningPublicKey, isLeaseSet, isLeaseSet, isRouterInfo, setReceivedAsPublished, setReceivedAsReply, setSignature, validateRoutingKey
Modifier and Type
Method
Description
Hash
getHash()
A common interface to the Hash of the two subclasses.
boolean
getReceivedAsReply()
If true, we received this LeaseSet by searching for it Default false.
Hash
getReceivedBy()
The Hash of the local client that received this LS, null if the router or unknown.
Hash
getRoutingKey()
Routing key for the structure using the current modifier in the RoutingKeyGenerator.
Signature
getSignature()
Retrieve the proof that the identity stands behind the info here.
protected SigningPublicKey
getSigningPublicKey()
Identical to getDestination().DatabaseEntry.getSigningPublicKey() in LeaseSet, and getIdentity().getSigningPublicKey() in RouterInfo.
boolean
isLeaseSet()
Convenience method, is the type any variant of leaseset?
static boolean
isLeaseSet(int type)
Convenience method, is the type any variant of leaseset?
boolean
isRouterInfo()
Convenience method, is the type any variant of router info?
void
setReceivedAsPublished()
Marks this entry as received via published mode.
void
setReceivedAsReply()
Marks this entry as received via reply.
void
setSignature(Signature signature)
Configure the proof that the entity stands behind the info here.
boolean
validateRoutingKey()
Validates the routing key for this entry.
Methods inherited from class DataStructureImpl
calculateHash, fromBase64, fromByteArray, read, toBase64, toByteArray
Modifier and Type
Method
Description
Hash
calculateHash()
Calculate the SHA256 value of this object (useful for a few scenarios).
void
fromBase64(String data)
Load the structure from the provided base64 string.
void
fromByteArray(byte[] data)
Loads structure from the data provided
protected int
read(InputStream in, byte[] target)
Repeated reads until buffer is full or IOException is thrown.
String
toBase64()
Render the structure into modified base 64 notation.
byte[]
toByteArray()
Convert the structure to a byte array.
Methods inherited from class Object
clone, getClass, notify, notifyAll, wait, wait, wait

Constructor Details
- MetaLeaseSet
  public MetaLeaseSet()
  Creates a new MetaLeaseSet with default values.
Method Details
- getType
  public int getType()
  Entry type for the network database.
  Overrides:
  getType in class LeaseSet2
  Returns:
  KEY_TYPE_META_LS2
- setEncryptionKey
  public void setEncryptionKey(PublicKey key)
  UnsupportedOperationException always.
  Overrides:
  setEncryptionKey in class LeaseSet
  Parameters:
  key - the ElGamal or ECIES key tunnel build requests are encrypted to, matched to the receiver by the key type
  Throws:
  UnsupportedOperationException - always, as a MetaLeaseSet carries no encryption keys
- addEncryptionKey
  public void addEncryptionKey(PublicKey key)
  UnsupportedOperationException always.
  Overrides:
  addEncryptionKey in class LeaseSet2
  Parameters:
  key - the key to append; the first one added becomes the key returned by LeaseSet2.getEncryptionKey()
  Throws:
  UnsupportedOperationException - always, as a MetaLeaseSet carries no encryption keys
- readBytes
  public void readBytes(InputStream in) throws DataFormatException, IOException
  This does NOT validate the signature.
  Specified by:
  readBytes in interface DataStructure
  Overrides:
  readBytes in class LeaseSet2
  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
- writeBytesWithoutSig
  protected void writeBytesWithoutSig(OutputStream out) throws DataFormatException, IOException
  Without sig. This does NOT validate the signature.
  Overrides:
  writeBytesWithoutSig in class LeaseSet2
  Parameters:
  out - the stream to write the header and body to
  Throws:
  DataFormatException - if the destination or encryption key is unset
  IOException - if the stream cannot be written
- size
  public int size()
  Number of bytes, NOT including signature.
  Overrides:
  size in class LeaseSet2
  Returns:
  the size in bytes
- addLease
  public void addLease(Lease lease)
  Must be a MetaLease.
  Overrides:
  addLease in class LeaseSet2
  Parameters:
  lease - must be a MetaLease
  Throws:
  IllegalArgumentException - if not a MetaLease
- equals
  public boolean equals(Object object)
  Compares this MetaLeaseSet with another object for equality.
  Overrides:
  equals in class LeaseSet2
- hashCode
  public int hashCode()
  The destination has enough randomness in it to use it by itself for speed.
  Overrides:
  hashCode in class LeaseSet2
- toString
  public String toString()
  Returns a string representation of this MetaLeaseSet.
  Overrides:
  toString in class LeaseSet2

Field Summary

Fields inherited from class LeaseSet2

Fields inherited from class LeaseSet

Fields inherited from class DatabaseEntry

Constructor Summary

Method Summary

Methods inherited from class LeaseSet2

Methods inherited from class LeaseSet

Methods inherited from class DatabaseEntry

Methods inherited from class DataStructureImpl

Methods inherited from class Object

Constructor Details

Method Details

getType

setEncryptionKey

addEncryptionKey

readBytes

writeBytesWithoutSig

size

addLease

equals

hashCode

toString