summaryrefslogtreecommitdiff
path: root/ext/socket/sockssocket.c
diff options
context:
space:
mode:
Diffstat (limited to 'ext/socket/sockssocket.c')
-rw-r--r--ext/socket/sockssocket.c43
1 files changed, 31 insertions, 12 deletions
diff --git a/ext/socket/sockssocket.c b/ext/socket/sockssocket.c
index 71836f704d..30860ea257 100644
--- a/ext/socket/sockssocket.c
+++ b/ext/socket/sockssocket.c
@@ -11,42 +11,61 @@
#include "rubysocket.h"
#ifdef SOCKS
+/*
+ * call-seq:
+ * SOCKSSocket.new(host, port) => socket
+ *
+ * Opens a SOCKS connection to +host+ via the SOCKS server.
+ *
+ * The SOCKS server configuration varies by implementation
+ *
+ * When using the Dante libsocks/libsocksd implementation it is configured as SOCKS_SERVER env var.
+ *
+ * See: https://manpages.debian.org/testing/dante-client/socksify.1.en.html for full env variable support.
+ *
+ */
static VALUE
-socks_init(VALUE sock, VALUE host, VALUE serv)
+socks_init(VALUE sock, VALUE host, VALUE port)
{
static int init = 0;
if (init == 0) {
- SOCKSinit("ruby");
- init = 1;
+ char progname[] = "ruby";
+ SOCKSinit(progname);
+ init = 1;
}
- return rsock_init_inetsock(sock, host, serv, Qnil, Qnil, INET_SOCKS);
+ return rsock_init_inetsock(sock, host, port, Qnil, Qnil, INET_SOCKS, Qnil, Qnil, Qnil, Qfalse, Qnil);
}
#ifdef SOCKS5
+/*
+ * Closes the SOCKS connection.
+ *
+ */
static VALUE
socks_s_close(VALUE sock)
{
rb_io_t *fptr;
- if (rb_safe_level() >= 4 && !OBJ_TAINTED(sock)) {
- rb_raise(rb_eSecurityError, "Insecure: can't close socket");
- }
GetOpenFile(sock, fptr);
- shutdown(fptr->fd, 2);
+ shutdown(fptr->fd, SHUT_RDWR);
return rb_io_close(sock);
}
#endif
#endif
-/*
- * SOCKSSocket class
- */
void
-Init_sockssocket(void)
+rsock_init_sockssocket(void)
{
#ifdef SOCKS
+ /*
+ * Document-class: SOCKSSocket < TCPSocket
+ *
+ * SOCKS is an Internet protocol that routes packets between a client and
+ * a server through a proxy server. SOCKS5, if supported, additionally
+ * provides authentication so only authorized users may access a server.
+ */
rb_cSOCKSSocket = rb_define_class("SOCKSSocket", rb_cTCPSocket);
rb_define_method(rb_cSOCKSSocket, "initialize", socks_init, 2);
#ifdef SOCKS5