Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding proxy socks #87

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Adding proxy socks #87

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3be4138
Adding proxy socks
kacem-expereo Dec 28, 2022
3ffe25a
updating readme with proxy socks option
kacem-expereo Dec 29, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@ routeros_api.RouterOsApiPool(
ssl_verify=True,
ssl_verify_hostname=True,
ssl_context=None,
proxy_socks_host=None,
proxy_socks_port=None,
)
```

Expand All @@ -52,6 +54,8 @@ Optional Parameters:
* `ssl_verify` - Boolean - Verify the SSL certificate? - Default **True**
* `ssl_verify_hostname` - Boolean - Verify the SSL certificate hostname matches? - Default **True**
* `ssl_context` - Object - Pass in a custom SSL context object. Overrides other options. - Default **None**
* `proxy_socks_host` - String - IP address for socks5 proxy - Default **None**
* `proxy_socks_port` - Integer - Port number for socks5 proxy - Default **None**

#### Using SSL

Expand Down
11 changes: 6 additions & 5 deletions routeros_api/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,19 @@
from routeros_api import resource


def connect(host, username='admin', password='', port=None, plaintext_login=False, use_ssl=False, ssl_verify=True, ssl_verify_hostname=True, ssl_context=None):
return RouterOsApiPool(host, username, password, port, plaintext_login, use_ssl, ssl_verify, ssl_verify_hostname, ssl_context).get_api()
def connect(host, username='admin', password='', port=None, plaintext_login=False, use_ssl=False, ssl_verify=True, ssl_verify_hostname=True, ssl_context=None, proxy_socks_host=None, proxy_socks_port=None):
return RouterOsApiPool(host, username, password, port, plaintext_login, use_ssl, ssl_verify, ssl_verify_hostname, ssl_context, proxy_socks_host, proxy_socks_port).get_api()


class RouterOsApiPool(object):
socket_timeout = 15.0

def __init__(self, host, username='admin', password='', port=None, plaintext_login=False, use_ssl=False, ssl_verify=True, ssl_verify_hostname=True, ssl_context=None):
def __init__(self, host, username='admin', password='', port=None, plaintext_login=False, use_ssl=False, ssl_verify=True, ssl_verify_hostname=True, ssl_context=None, proxy_socks_host=None, proxy_socks_port=None):
self.host = host
self.username = username
self.password = password

self.proxy_socks_host = proxy_socks_host
self.proxy_socks_port = proxy_socks_port
self.plaintext_login = plaintext_login

self.ssl_context = ssl_context
Expand All @@ -43,7 +44,7 @@ def __init__(self, host, username='admin', password='', port=None, plaintext_log
def get_api(self):
if not self.connected:
self.socket = api_socket.get_socket(self.host, self.port,
timeout=self.socket_timeout, use_ssl=self.use_ssl, ssl_verify=self.ssl_verify, ssl_verify_hostname=self.ssl_verify_hostname, ssl_context=self.ssl_context)
timeout=self.socket_timeout, use_ssl=self.use_ssl, ssl_verify=self.ssl_verify, ssl_verify_hostname=self.ssl_verify_hostname, ssl_context=self.ssl_context, proxy_socks_host=self.proxy_socks_host, proxy_socks_port=self.proxy_socks_port)
base = base_api.Connection(self.socket)
communicator = api_communicator.ApiCommunicator(base)
self.api = RouterOsApi(communicator)
Expand Down
12 changes: 9 additions & 3 deletions routeros_api/api_socket.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import socket
import socks
import ssl
from routeros_api import exceptions
try:
Expand All @@ -8,8 +9,14 @@

EINTR = getattr(errno, 'EINTR', 4)

def get_socket(hostname, port, use_ssl=False, ssl_verify=True, ssl_verify_hostname=True, ssl_context=None, timeout=15.0):
api_socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
def get_socket(hostname, port, use_ssl=False, ssl_verify=True, ssl_verify_hostname=True, ssl_context=None, timeout=15.0, proxy_socks_host=None, proxy_socks_port=None):

if proxy_socks_host and proxy_socks_port is not None:
socks.setdefaultproxy(socks.PROXY_TYPE_SOCKS5, proxy_socks_host, proxy_socks_port)
socket.socket = socks.socksocket
api_socket = socks.socksocket(socket.AF_INET, socket.SOCK_STREAM)
else:
api_socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
api_socket.settimeout(timeout)
while True:
try:
Expand Down Expand Up @@ -50,7 +57,6 @@ def set_keepalive(sock, after_idle_sec=1, interval_sec=3, max_fails=5):
if hasattr(socket, "TCP_KEEPCNT"):
sock.setsockopt(socket.IPPROTO_TCP, socket.TCP_KEEPCNT, max_fails)


class DummySocket(object):
def close(self):
pass
Expand Down