SMBClient
.ConnectSMBInfoMode(host, port)
⇒ SMBLog
.DetectSMBGhost(host, port)
⇒ boolean
.ListSMBv2Metadata(host, port)
⇒ ServiceSMB
.ListShares(host, port, user, password)
⇒ Array.<string>
SMBLog
: object
ServiceSMB
: object
SMBClient is a client for SMB servers.
Kind: inner class of smb
SMBClient
.ConnectSMBInfoMode(host, port)
⇒ SMBLog
.DetectSMBGhost(host, port)
⇒ boolean
.ListSMBv2Metadata(host, port)
⇒ ServiceSMB
.ListShares(host, port, user, password)
⇒ Array.<string>
SMBLog
ConnectSMBInfoMode tries to connect to provided host and port and discover SMB information
Kind: instance method of SMBClient
Returns: SMBLog
- - The log of the SMB handshake.
Throws:
error
- The error encountered during the connection.Param | Type | Description |
---|---|---|
host | string | The host to connect to. |
port | string | The port to connect to. |
Example
boolean
DetectSMBGhost tries to detect SMBGhost vulnerability by using SMBv3 compression feature.
Kind: instance method of SMBClient
Returns: boolean
- - The result of the SMBGhost vulnerability detection.
Throws:
error
- The error encountered during the detection.Param | Type | Description |
---|---|---|
host | string | The host to connect to. |
port | string | The port to connect to. |
Example
ServiceSMB
ListSMBv2Metadata tries to connect to provided host and port and list SMBv2 metadata.
Kind: instance method of SMBClient
Returns: ServiceSMB
- - The metadata of the SMBv2 service.
Throws:
error
- The error encountered during the listing.Param | Type | Description |
---|---|---|
host | string | The host to connect to. |
port | string | The port to connect to. |
Example
Array.<string>
ListShares tries to connect to provided host and port and list shares by using given credentials.
Kind: instance method of SMBClient
Returns: Array.<string>
- - The list of shares.
Throws:
error
- The error encountered during the listing.Param | Type | Description |
---|---|---|
host | string | The host to connect to. |
port | string | The port to connect to. |
user | string | The username for authentication. |
password | string | The password for authentication. |
Example
object
SMBLog is an object containing the log of the SMB handshake.
Kind: inner typedef of smb
object
ServiceSMB is an object containing the metadata of the SMBv2 service.
Kind: inner typedef of smb
SMBClient
.ConnectSMBInfoMode(host, port)
⇒ SMBLog
.DetectSMBGhost(host, port)
⇒ boolean
.ListSMBv2Metadata(host, port)
⇒ ServiceSMB
.ListShares(host, port, user, password)
⇒ Array.<string>
SMBLog
: object
ServiceSMB
: object
SMBClient is a client for SMB servers.
Kind: inner class of smb
SMBClient
.ConnectSMBInfoMode(host, port)
⇒ SMBLog
.DetectSMBGhost(host, port)
⇒ boolean
.ListSMBv2Metadata(host, port)
⇒ ServiceSMB
.ListShares(host, port, user, password)
⇒ Array.<string>
SMBLog
ConnectSMBInfoMode tries to connect to provided host and port and discover SMB information
Kind: instance method of SMBClient
Returns: SMBLog
- - The log of the SMB handshake.
Throws:
error
- The error encountered during the connection.Param | Type | Description |
---|---|---|
host | string | The host to connect to. |
port | string | The port to connect to. |
Example
boolean
DetectSMBGhost tries to detect SMBGhost vulnerability by using SMBv3 compression feature.
Kind: instance method of SMBClient
Returns: boolean
- - The result of the SMBGhost vulnerability detection.
Throws:
error
- The error encountered during the detection.Param | Type | Description |
---|---|---|
host | string | The host to connect to. |
port | string | The port to connect to. |
Example
ServiceSMB
ListSMBv2Metadata tries to connect to provided host and port and list SMBv2 metadata.
Kind: instance method of SMBClient
Returns: ServiceSMB
- - The metadata of the SMBv2 service.
Throws:
error
- The error encountered during the listing.Param | Type | Description |
---|---|---|
host | string | The host to connect to. |
port | string | The port to connect to. |
Example
Array.<string>
ListShares tries to connect to provided host and port and list shares by using given credentials.
Kind: instance method of SMBClient
Returns: Array.<string>
- - The list of shares.
Throws:
error
- The error encountered during the listing.Param | Type | Description |
---|---|---|
host | string | The host to connect to. |
port | string | The port to connect to. |
user | string | The username for authentication. |
password | string | The password for authentication. |
Example
object
SMBLog is an object containing the log of the SMB handshake.
Kind: inner typedef of smb
object
ServiceSMB is an object containing the metadata of the SMBv2 service.
Kind: inner typedef of smb