hackthebox.vpn — HTB VPN Utilities

VPN Servers

class hackthebox.vpn.VPNServer(data: dict, client: HTBClient, summary=False)[source]

Class representing individual VPN servers provided by Hack The Box

friendly_name

Friendly name of the server

Example: 'US Free 1'

Type

str

current_clients

The number of currently connected clients

Type

int

location

The physical location of the server

Example: 'US'

Type

str

download(path=None, tcp=False) → str[source]
Parameters

  • path – The name of the OVPN file to download to. If none is provided, it is saved to the current directory.

  • tcp – Download TCP instead of UDP

Returns: The path of the file

switch() → bool[source]

Switches the client to use this VPN server

Returns: Whether the switch was completed successfully