public class BuildRequestRecord extends Object
bytes 0-3: tunnel ID to receive messages as bytes 4-35: local router identity hash (Unused and no accessor here) bytes 36-39: next tunnel ID bytes 40-71: next router identity hash bytes 72-103: AES-256 tunnel layer key bytes 104-135: AES-256 tunnel IV key bytes 136-167: AES-256 reply key bytes 168-183: reply IV byte 184: flags bytes 185-188: request time (in hours since the epoch) bytes 189-192: next message ID bytes 193-221: uninterpreted / random paddingEncrypted:
bytes 0-15: First 16 bytes of router hash bytes 16-527: ElGamal encrypted block (discarding zero bytes at elg[0] and elg[257])New ECIES format, ref: proposal 152: Holds the unencrypted 464-byte tunnel request record, with a constructor for ECIES decryption and a method for ECIES encryption. Iterative AES encryption/decryption is done elsewhere. Cleartext:
bytes 0-3: tunnel ID to receive messages as, nonzero bytes 4-7: next tunnel ID, nonzero bytes 8-39: next router identity hash bytes 40-71: AES-256 tunnel layer key bytes 72-103: AES-256 tunnel IV key bytes 104-135: AES-256 reply key bytes 136-151: AES-256 reply IV byte 152: flags bytes 153-155: more flags, unused, set to 0 for compatibility bytes 156-159: request time (in minutes since the epoch, rounded down) bytes 160-163: request expiration (in seconds since creation) bytes 164-167: next message ID bytes 168-x: tunnel build options (Mapping) bytes x-x: other data as implied by flags or options bytes x-463: random paddingEncrypted:
bytes 0-15: Hop's truncated identity hash bytes 16-47: Sender's ephemeral X25519 public key bytes 48-511: ChaCha20 encrypted BuildRequestRecord bytes 512-527: Poly1305 MAC
Modifier and Type | Field and Description |
---|---|
static int |
IV_SIZE |
static int |
OFF_REPLY_KEY |
static int |
OFF_REPLY_KEY_EC |
static int |
PEER_SIZE
we show 16 bytes of the peer hash outside the elGamal block
|
Constructor and Description |
---|
BuildRequestRecord(I2PAppContext ctx,
long receiveTunnelId,
Hash peer,
long nextTunnelId,
Hash nextHop,
long nextMsgId,
SessionKey layerKey,
SessionKey ivKey,
SessionKey replyKey,
byte[] iv,
boolean isInGateway,
boolean isOutEndpoint)
Populate this instance with data.
|
BuildRequestRecord(I2PAppContext ctx,
long receiveTunnelId,
long nextTunnelId,
Hash nextHop,
long nextMsgId,
SessionKey layerKey,
SessionKey ivKey,
SessionKey replyKey,
byte[] iv,
boolean isInGateway,
boolean isOutEndpoint,
Properties options)
Populate this instance with data.
|
BuildRequestRecord(RouterContext ctx,
PrivateKey ourKey,
EncryptedBuildRecord encryptedRecord)
Decrypt the data from the specified record, writing the decrypted record into this instance's
data buffer
Caller MUST check that first 16 bytes of our hash matches first 16 bytes of encryptedRecord
before calling this.
|
Modifier and Type | Method and Description |
---|---|
EncryptedBuildRecord |
encryptECIESRecord(RouterContext ctx,
PublicKey toKey,
Hash toPeer)
Encrypt the record to the specified peer.
|
EncryptedBuildRecord |
encryptRecord(I2PAppContext ctx,
PublicKey toKey,
Hash toPeer)
Encrypt the record to the specified peer.
|
byte[] |
getChaChaReplyAD()
Valid after calling encryptECIESRecord() or after the decrypting constructor
with an ECIES private key.
|
SessionKey |
getChaChaReplyKey()
Valid after calling encryptECIESRecord() or after the decrypting constructor
with an ECIES private key.
|
byte[] |
getData() |
long |
readExpiration()
The expiration in milliseconds from now.
|
boolean |
readIsInboundGateway()
The current hop is the inbound gateway.
|
boolean |
readIsOutboundEndpoint()
The current hop is the outbound endpoint.
|
SessionKey |
readIVKey()
Tunnel IV encryption key that the current hop should use
|
SessionKey |
readLayerKey()
Tunnel layer encryption key that the current hop should use
|
Hash |
readNextIdentity()
Read the next hop from the record.
|
long |
readNextTunnelId()
What tunnel ID the next hop receives messages on.
|
Properties |
readOptions()
ECIES only.
|
long |
readReceiveTunnelId()
what tunnel ID should this receive messages on
|
byte[] |
readReplyIV()
IV that should be used to encrypt the reply
|
SessionKey |
readReplyKey()
Session key that should be used to encrypt the reply
|
long |
readReplyMessageId()
What message ID should we send the request to the next hop with.
|
long |
readRequestTime()
For ElGamal, time that the request was sent (ms), truncated to the nearest hour.
|
String |
toString() |
public static final int IV_SIZE
public static final int PEER_SIZE
public static final int OFF_REPLY_KEY
public static final int OFF_REPLY_KEY_EC
public BuildRequestRecord(RouterContext ctx, PrivateKey ourKey, EncryptedBuildRecord encryptedRecord) throws DataFormatException
DataFormatException
- on decrypt failpublic BuildRequestRecord(I2PAppContext ctx, long receiveTunnelId, Hash peer, long nextTunnelId, Hash nextHop, long nextMsgId, SessionKey layerKey, SessionKey ivKey, SessionKey replyKey, byte[] iv, boolean isInGateway, boolean isOutEndpoint)
receiveTunnelId
- tunnel the current hop will receive messages onpeer
- current hop's identity, unused, no read() methodnextTunnelId
- id for the next hop, or where we send the reply (if we are the outbound endpoint)nextHop
- next hop's identity, or where we send the reply (if we are the outbound endpoint)nextMsgId
- message ID to use when sending on to the next hop (or for the reply)layerKey
- tunnel layer key to be used by the peerivKey
- tunnel IV key to be used by the peerreplyKey
- key to be used when encrypting the reply to this build requestiv
- iv to be used when encrypting the reply to this build requestisInGateway
- are we the gateway of an inbound tunnel?isOutEndpoint
- are we the endpoint of an outbound tunnel?public BuildRequestRecord(I2PAppContext ctx, long receiveTunnelId, long nextTunnelId, Hash nextHop, long nextMsgId, SessionKey layerKey, SessionKey ivKey, SessionKey replyKey, byte[] iv, boolean isInGateway, boolean isOutEndpoint, Properties options)
receiveTunnelId
- tunnel the current hop will receive messages onnextTunnelId
- id for the next hop, or where we send the reply (if we are the outbound endpoint)nextHop
- next hop's identity, or where we send the reply (if we are the outbound endpoint)nextMsgId
- message ID to use when sending on to the next hop (or for the reply)layerKey
- tunnel layer key to be used by the peerivKey
- tunnel IV key to be used by the peerreplyKey
- key to be used when encrypting the reply to this build requestiv
- iv to be used when encrypting the reply to this build requestisInGateway
- are we the gateway of an inbound tunnel?isOutEndpoint
- are we the endpoint of an outbound tunnel?options
- 296 bytes max when serializedIllegalArgumentException
- if options too longpublic byte[] getData()
public long readReceiveTunnelId()
public long readNextTunnelId()
public Hash readNextIdentity()
public SessionKey readLayerKey()
public SessionKey readIVKey()
public SessionKey readReplyKey()
public byte[] readReplyIV()
public boolean readIsInboundGateway()
public boolean readIsOutboundEndpoint()
public long readRequestTime()
public long readReplyMessageId()
public long readExpiration()
public Properties readOptions()
public EncryptedBuildRecord encryptRecord(I2PAppContext ctx, PublicKey toKey, Hash toPeer)
bytes 0-15: truncated SHA-256 of the current hop's identity (the toPeer parameter) bytes 15-527: ElGamal-2048 encrypted blockElGamal only
public EncryptedBuildRecord encryptECIESRecord(RouterContext ctx, PublicKey toKey, Hash toPeer)
public SessionKey getChaChaReplyKey()
public byte[] getChaChaReplyAD()