Package-level declarations

Types

Link copied to clipboard
object NtStatus

Common NTSTATUS status codes returned in SMB2/SMB3 headers ([MS-ERREF] 2.3).

Link copied to clipboard

DesiredAccess bitmask constants for SMB2 CREATE requests ([MS-SMB2] 2.2.13.1).

Link copied to clipboard
enum class SmbCipherId : Enum<SmbCipherId>

Encryption cipher identifiers negotiated via SMB2_ENCRYPTION_CAPABILITIES in SMB 3.1.1 ([MS-SMB2] 2.2.3.1.2).

Link copied to clipboard
enum class SmbCommand : Enum<SmbCommand>

SMB2/SMB3 command codes ([MS-SMB2] 2.2.1).

Link copied to clipboard

CreateDisposition values for SMB2 CREATE requests ([MS-SMB2] 2.2.13).

Link copied to clipboard

CreateOptions bitmask constants for SMB2 CREATE requests ([MS-SMB2] 2.2.13).

Link copied to clipboard
enum class SmbDialect : Enum<SmbDialect>

Supported SMB2 and SMB3 protocol dialects ([MS-SMB2] 2.2.3).

Link copied to clipboard
data class SmbDirectoryEntry(val name: String, val size: Long, val allocationSize: Long, val fileAttributes: UInt, val creationTimeMillis: Long, val lastAccessTimeMillis: Long, val lastWriteTimeMillis: Long, val changeTimeMillis: Long, val fileId: ULong)

Directory entry metadata returned by directory enumeration (FileIdBothDirectoryInformation).

Link copied to clipboard
class SmbException(val ntStatus: UInt, message: String = "SMB operation failed with ", cause: Throwable? = null) : Exception

Exception thrown when an SMB protocol operation fails.

Link copied to clipboard

File attribute bitmask constants ([MS-FSCC] 2.6).

Link copied to clipboard
data class SmbFileId(val persistent: ULong, val volatile: ULong)

16-byte SMB2 file handle identifier ([MS-SMB2] 2.2.14.1), consisting of a 64-bit persistent handle and a 64-bit volatile handle.

Link copied to clipboard
data class SmbFileMetadata(val size: Long, val allocationSize: Long, val fileAttributes: UInt, val creationTimeMillis: Long, val lastAccessTimeMillis: Long, val lastWriteTimeMillis: Long, val changeTimeMillis: Long)

Metadata for a single file or directory returned by SMB2 CREATE ([SmbShare.stat]).

Link copied to clipboard

ShareAccess (sharing mode) bitmask constants for SMB2 CREATE requests ([MS-SMB2] 2.2.13).

Link copied to clipboard
data class SmbShareInfo(val name: String, val rawType: UInt, val comment: String)

Information about a shared folder enumerated via DCE/RPC NetrShareEnum.

Link copied to clipboard
enum class SmbShareType : Enum<SmbShareType>

Type of shared resource on an SMB server ([MS-SRVS] 2.2.2.4).