SAMv2Handler

net.i2p.sam.SAMv2Handler

All Implemented Interfaces:: Runnable, Handler, SAMDatagramReceiver, SAMRawReceiver, SAMStreamReceiver

class SAMv2Handlerextends SAMv1Handler implements SAMRawReceiver, SAMDatagramReceiver, SAMStreamReceiver

SAM version 2 handler.

Field Summary
Fields inherited from class SAMv1Handler
_id, datagramSession, rawSession, SESSION_ERROR, streamSession
Modifier and Type
Field
Description
protected final long
_id
Identifier of this connection, unique among a router's SAM handlers.
protected SAMMessageSess
datagramSession
The session used for datagram style messages.
protected SAMMessageSess
rawSession
The SAM raw and datagram session, held after a successful HELLO.
protected static final String
SESSION_ERROR
Reply sent to a SESSION CREATE whose stream could not be established.
protected SAMStreamSession
streamSession
The session used for STREAM CONNECT connections.
Fields inherited from class SAMHandler
_log, bridge, i2cpProps, socket, stopHandler, stopLock, thread, verMajor, verMinor
Modifier and Type
Field
Description
protected final Log
_log
Log scoped to this handler's class.
protected final SAMBridge
bridge
Router bridge this handler routes sessions over.
protected final Properties
i2cpProps
I2CP options configuring the I2CP connection (port, host, numHops, etc).
protected final SocketChannel
socket
Client channel this handler reads commands from.
protected boolean
stopHandler
Whether shutdown has been requested for this handler.
protected final Object
stopLock
Monitor guarding the stop flag.
protected I2PAppThread
thread
Thread running the SAM protocol loop for this connection.
final int
verMajor
Major version this handler was negotiated at.
final int
verMinor
Minor version this handler was negotiated at.
Constructor Summary
Constructors
Constructor
Description
SAMv2Handler(SocketChannel s, int verMajor, int verMinor, Properties i2cpProps, SAMBridge parent)
Create a new SAM version 2 handler.
SAMv2Handler(SocketChannel s, int verMajor, int verMinor, SAMBridge parent)
Create a new SAM version 2 handler with default I2CP properties.
Method Summary
Modifier and Type
Method
Description
protected boolean
execStreamMessage(String opcode, Properties props)
Parse and execute a STREAM message.
private boolean
execStreamReceive(Properties props)
Execute STREAM RECEIVE message.
(package private) SAMStreamSession
newSAMv2StreamSession(String destKeystream, String direction, Properties props)
New SAMv2 stream session.
boolean
verifVersion()
Verify the SAM protocol version is supported by this handler.
Methods inherited from class SAMv1Handler
createMessageString, execDatagramMessage, execDestMessage, execNamingMessage, execRawMessage, execSessionMessage, execStreamClose, execStreamConnect, execStreamSend, getDatagramSession, getRawSession, getStreamSession, handle, notifyStreamDisconnection, notifyStreamIncomingConnection, notifyStreamOutgoingConnection, notifyStreamSendBufferFree, receiveDatagramBytes, receiveRawBytes, receiveStreamBytes, stopDatagramReceiving, stopRawReceiving, stopStreamReceiving, streamSendAnswer, writeString
Modifier and Type
Method
Description
protected static String
createMessageString(String msg)
Create a string to be appended to a status.
protected boolean
execDatagramMessage(String opcode, Properties props)
Parse and execute a DATAGRAM message.
protected boolean
execDestMessage(String opcode, Properties props)
Parse and execute a DEST message.
protected boolean
execNamingMessage(String opcode, Properties props)
Parse and execute a NAMING message.
protected boolean
execRawMessage(String opcode, Properties props)
Parse and execute a RAW message.
protected boolean
execSessionMessage(String opcode, Properties props)
Parse and execute a SESSION message.
protected boolean
execStreamClose(Properties props)
Parse and execute a STREAM CLOSE message.
protected boolean
execStreamConnect(Properties props)
Parse and execute a STREAM CONNECT message.
protected boolean
execStreamSend(Properties props)
Parse and execute a STREAM SEND message.
protected final SAMMessageSess
getDatagramSession()
Return the datagram session.
protected final SAMMessageSess
getRawSession()
Return the raw session.
protected final SAMStreamSession
getStreamSession()
Return the stream session.
void
handle()
Handle a SAM v1 client connection by reading and dispatching commands in a loop until the connection is closed or an error occurs.
void
notifyStreamDisconnection(int id, String result, String msg)
Notify the SAM client that a stream connection has been disconnected.
void
notifyStreamIncomingConnection(int id, Destination d)
Notify the SAM client of an incoming stream connection.
void
notifyStreamOutgoingConnection(int id, String result, String msg)
Report the result of an outgoing stream connection.
void
notifyStreamSendBufferFree(int id)
Notify the SAM client that the stream send buffer is free for more data.
void
receiveDatagramBytes(Destination sender, byte[] data, int proto, int fromPort, int toPort)
Receive datagram bytes from the network and forward them to the SAM client.
void
receiveRawBytes(byte[] data, int proto, int fromPort, int toPort)
Receive raw bytes from the network and forward them to the SAM client.
void
receiveStreamBytes(int id, ByteBuffer data)
Receive stream bytes from the network and forward them to the SAM client.
void
stopDatagramReceiving()
Stop receiving datagram bytes and close the client socket.
void
stopRawReceiving()
Stop receiving raw bytes and close the client socket.
void
stopStreamReceiving()
Stop receiving stream bytes and close the client socket.
void
streamSendAnswer(int id, String result, String bufferState)
Notify the SAM client of the result of a stream SEND operation.
protected boolean
writeString(String s, String msg)
Write a string and message, escaping the message.
Methods inherited from class SAMHandler
closeClientSocket, getAuthUser, getClientSocket, getRemoteAddrPort, getWriteLock, isLoopbackAddress, logSessionError, run, sameClient, sameClient, setAuthUser, shouldStop, startHandling, stopHandling, toString, writeBytes, writeString, writeString
Modifier and Type
Method
Description
protected final void
closeClientSocket()
Close the socket connected to the SAM client.
(package private) final String
getAuthUser()
Get the username this connection authenticated with, if any.
protected final SocketChannel
getClientSocket()
Get the channel of the socket connected to the SAM client.
(package private) final String
getRemoteAddrPort()
Get the remote address and port of this connection, bracketing IPv6, for rejection and ban logging.
protected Object
getWriteLock()
If you're crazy enough to write to the raw socket, grab the write lock with SAMHandler.getWriteLock(), synchronize against it, and write to the getOut().
(package private) static boolean
isLoopbackAddress(String host)
Determine whether an address is a loopback address, in any of the forms the platform may report it.
protected void
logSessionError(String msg, Exception e)
Log a session startup failure.
final void
run()
Register with the bridge, call SAMHandler.handle(), unregister with the bridge.
(package private) static boolean
sameClient(String myAuthUser, String otherAuthUser, String myHost, String otherHost)
Decide whether two SAM connections belong to the same client.
(package private) final boolean
sameClient(SAMHandler other)
Determine whether two connections belong to the same client, which is what decides whether one of them may use a session nickname owned by the other.
(package private) final void
setAuthUser(String user)
Record the username this connection authenticated with.
protected final boolean
shouldStop()
Should the handler be stopped?
void
startHandling()
Start handling the SAM connection, detaching a handling thread.
void
stopHandling()
Stop the SAM handler, close the client socket, unregister with the bridge.
final String
toString()
Get a string describing the handler.
protected final void
writeBytes(ByteBuffer data)
Write a byte array on the handler's socket.
protected final boolean
writeString(String str)
Write a string to the handler's socket.
static boolean
writeString(String str, SocketChannel out)
Unsynchronized, use with caution.
Methods inherited from class Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details
- SAMv2Handler
  public SAMv2Handler(SocketChannel s, int verMajor, int verMinor, SAMBridge parent) throws SAMException, IOException
  Create a new SAM version 2 handler with default I2CP properties. This constructor expects that the SAM HELLO message has been still answered (and stripped) from the socket input stream.
  Parameters:
  s - Socket attached to a SAM client
  verMajor - SAM major version to manage (should be 2)
  verMinor - SAM minor version to manage
  parent - bridge holding the shared SAM server state this handler joins
  Throws:
  SAMException - if the version is not supported
  IOException - if an I/O error occurs
- SAMv2Handler
  public SAMv2Handler(SocketChannel s, int verMajor, int verMinor, Properties i2cpProps, SAMBridge parent) throws SAMException, IOException
  Create a new SAM version 2 handler. This constructor expects that the SAM HELLO message has been still answered (and stripped) from the socket input stream.
  Parameters:
  s - Socket attached to a SAM client
  verMajor - SAM major version to manage (should be 2)
  verMinor - SAM minor version to manage
  i2cpProps - properties to configure the I2CP connection (host, port, etc)
  parent - bridge holding the shared SAM server state this handler joins
  Throws:
  SAMException - if the version is not supported
  IOException - if an I/O error occurs
Method Details
- verifVersion
  public boolean verifVersion()
  Verify the SAM protocol version is supported by this handler.
  Overrides:
  verifVersion in class SAMv1Handler
  Returns:
  true if the major version matches this handler's version
- newSAMv2StreamSession
  SAMStreamSession newSAMv2StreamSession(String destKeystream, String direction, Properties props) throws IOException, DataFormatException, SAMException
  New SAMv2 stream session.
  Parameters:
  destKeystream - the destination and private key stream of the peer
  direction - the STREAM connection direction, "INBOUND" or "OUTBOUND"
  props - the parsed STREAM message properties, including the port and options
  Returns:
  the newly created STREAM session
  Throws:
  IOException - if the destination cannot be read from the keystream
  DataFormatException - if the keystream is not in the expected key file format
  SAMException - if a session with this nickname is already registered
- execStreamMessage
  protected boolean execStreamMessage(String opcode, Properties props)
  Parse and execute a STREAM message.
  Overrides:
  execStreamMessage in class SAMv1Handler
  Parameters:
  opcode - the STREAM sub-command
  props - the parsed message properties
  Returns:
  true if the handler should continue processing commands
- execStreamReceive
  private boolean execStreamReceive(Properties props)
  Execute STREAM RECEIVE message.
  Parameters:
  props - the parameters parsed from the message
  Returns:
  true if the receive was set up, false if the parameters were bad

Field Summary

Fields inherited from class SAMv1Handler

Fields inherited from class SAMHandler

Constructor Summary

Method Summary

Methods inherited from class SAMv1Handler

Methods inherited from class SAMHandler

Methods inherited from class Object

Constructor Details

SAMv2Handler

Method Details

verifVersion

newSAMv2StreamSession

execStreamMessage

execStreamReceive