Class Session

java.lang.Object

com.hierynomus.smbj.session.Session

All Implemented Interfaces:

AutoCloseable

public class Session
extends Object
implements AutoCloseable

A Session

Field Summary

Fields

Modifier and Type	Field	Description
private SMBEventBus	bus
private final SmbConfig	config
private Connection	connection
private PacketEncryptor	encryptor
private static final org.slf4j.Logger	logger
private Map<String,Session>	nestedSessionsByHost
private ReentrantReadWriteLock	nestedSessionsRwLock
private final PathResolver	pathResolver
private SessionContext	sessionContext
private long	sessionId
private Signatory	signatory
private TreeConnectTable	treeConnectTable
private AuthenticationContext	userCredentials

Constructor Summary

Constructors

Constructor	Description
Session(Connection connection, SmbConfig config, AuthenticationContext userCredentials, SMBEventBus bus, PathResolver pathResolver, Signatory signatory, PacketEncryptor encryptor)

Method Summary

Modifier and Type	Method	Description
void	close()
Share	connectShare(String shareName)	Connect to a share on the remote machine over the authenticated session.
private Share	connectTree(String shareName)
private Session	createNestedSession(SmbPath smbPath)
private void	disconnectTree(TreeDisconnected disconnectEvent)
AuthenticationContext	getAuthenticationContext()
Connection	getConnection()
Session	getNestedSession(SmbPath resolvedSharePath)
SessionContext	getSessionContext()
long	getSessionId()
SecretKey	getSigningKey(SMB2PacketHeader header, boolean signing)	If Connection.Dialect belongs to the SMB 3.x dialect family, and the received message is an SMB2 SESSION_SETUP Response without a status code equal to STATUS_SUCCESS in the header, the client MUST verify the signature of the message as specified in section 3.1.5.1, using Session.SigningKey as the signing key, and passing the response message.
boolean	isAnonymous()
boolean	isGuest()
boolean	isSigningRequired()
void	logoff()
<T extends SMB2Packet> T	processSendResponse(SMB2CreateRequest packet)
<T extends SMB2Packet> Future<T>	send(SMB2Packet packet)	send a packet.
void	setSessionId(long sessionId)
boolean	shouldEncryptData()	Returns whether packets for this session should be encrypted.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

logger

private static final org.slf4j.Logger logger

sessionId

private long sessionId

connection

private Connection connection

config

private final SmbConfig config

bus

private SMBEventBus bus

pathResolver

private final PathResolver pathResolver

signatory

private Signatory signatory

encryptor

private PacketEncryptor encryptor

treeConnectTable

private TreeConnectTable treeConnectTable

nestedSessionsByHost

private Map<String,Session> nestedSessionsByHost

nestedSessionsRwLock

private ReentrantReadWriteLock nestedSessionsRwLock

userCredentials

private AuthenticationContext userCredentials

sessionContext

private SessionContext sessionContext

Constructor Details

Session

public Session(Connection connection,
 SmbConfig config,
 AuthenticationContext userCredentials,
 SMBEventBus bus,
 PathResolver pathResolver,
 Signatory signatory,
 PacketEncryptor encryptor)

Method Details

getSessionId

public long getSessionId()

setSessionId

public void setSessionId(long sessionId)

connectShare

public Share connectShare(String shareName)

Connect to a share on the remote machine over the authenticated session.

[MS-SMB2] 3.2.4.2 Application Requests a Connection to a Share [MS-SMB2] 3.2.4.2.4 Connecting to the Share [MS-SMB2] 3.2.5.5 Receiving an SMB2 TREE_CONNECT Response

Parameters:

shareName - The name of the share to connect to.

Returns:

the handle to the connected share.

connectTree

private Share connectTree(String shareName)

getNestedSession

public Session getNestedSession(SmbPath resolvedSharePath)

createNestedSession

private Session createNestedSession(SmbPath smbPath)

disconnectTree

private void disconnectTree(TreeDisconnected disconnectEvent)

logoff

public void logoff()
            throws TransportException

Throws:

TransportException

isSigningRequired

public boolean isSigningRequired()

isGuest

public boolean isGuest()

isAnonymous

public boolean isAnonymous()

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Throws:

IOException

getConnection

public Connection getConnection()

send

public <T extends SMB2Packet> Future<T> send(SMB2Packet packet)
                                      throws TransportException

send a packet. The packet will be signed or not depending on the session's flags.

Parameters:

packet - SMBPacket to send

Returns:

a Future to be used to retrieve the response packet

Throws:

TransportException

processSendResponse

public <T extends SMB2Packet> T processSendResponse(SMB2CreateRequest packet)
                                             throws TransportException

Throws:

TransportException

getSigningKey

public SecretKey getSigningKey(SMB2PacketHeader header,
 boolean signing)

If Connection.Dialect belongs to the SMB 3.x dialect family, and the received message is an SMB2 SESSION_SETUP Response without a status code equal to STATUS_SUCCESS in the header, the client MUST verify the signature of the message as specified in section 3.1.5.1, using Session.SigningKey as the signing key, and passing the response message. For all other messages, the client MUST look up the Channel in Session.ChannelList, where the Channel.Connection matches the connection on which this message is received, and MUST use Channel.SigningKey for verifying the signature as specified in section 3.1.5.1.  Otherwise, the client MUST verify the signature of the message as specified in section 3.1.5.1, using Session.SessionKey as the signing key, and passing the response message.

Parameters:

signing - If true, check for signing mode, else get for verification mode

Returns:

shouldEncryptData

public boolean shouldEncryptData()
                          throws TransportException

Returns whether packets for this session should be encrypted.

Returns:

Throws:

TransportException - When encryption is required and encryption key is missing.

getSessionContext

public SessionContext getSessionContext()

getAuthenticationContext

public AuthenticationContext getAuthenticationContext()