[PATCH] Add option to ERC to make all connections use SSL.

[PATCH] Add option to ERC to make all connections use SSL.

[Vibhav Pant]

[-- Attachment #1: Type: text/plain, Size: 1936 bytes --]

Hello,
Presently, ERC can connect to IRC netowrks using SSL via the function 'erc-tls'.
However, it can be confusing for new users to find this function, so I
have added a patch to erc.el which adds an option (erc-use-ssl) to
make all connections use SSL. Its value can be changed from
the customize group "erc". (The default value is nil).

diff --git a/lisp/erc/erc.el b/lisp/erc/erc.el
index 3bd9ff3..458892a 100644
--- a/lisp/erc/erc.el
+++ b/lisp/erc/erc.el
@@ -222,6 +222,11 @@ prompt you for it.")
   :group 'erc
   :type 'boolean)

+(defcustom erc-use-ssl nil
+  "If set to non-nill, use SSL to connect to all networks."
+  :group 'erc
+  :type 'boolean)
+
 (defcustom erc-hide-prompt nil
   "If non-nil, do not display the prompt for commands.

@@ -2145,10 +2150,10 @@ functions in here get called with the paramete

 ;;;###autoload
 (cl-defun erc (&key (server (erc-compute-server))
-                    (port   (erc-compute-port))
-                    (nick   (erc-compute-nick))
-                    password
-                    (full-name (erc-compute-full-name)))
+                   (port   (erc-compute-port))
+                   (nick   (erc-compute-nick))
+                   password
+                   (full-name (erc-compute-full-name)))
   "ERC is a powerful, modular, and extensible IRC client.
 This function is the main entry point for ERC.

@@ -2169,7 +2174,9 @@ then the server and full-name will be set to tho
 `erc-compute-port', `erc-compute-nick' and `erc-compute-full-name' wi
 be invoked for the values of the other parameters."
   (interactive (erc-select-read-args))
-  (erc-open server port nick full-name t password))
+  (let ((erc-server-connect-function (if erc-use-ssl 'erc-open-tls-st
+                                      'erc-server-connect-function)))
+    (erc-open server port nick full-name t password)))

 ;;;###autoload
 (defalias 'erc-select 'erc)

-- 
Vibhav Pant
vibhavp@gmail.com

[-- Attachment #2: erc-ssl-option.patch --]
[-- Type: text/x-patch, Size: 1530 bytes --]

diff --git a/lisp/erc/erc.el b/lisp/erc/erc.el
index 3bd9ff3..458892a 100644
--- a/lisp/erc/erc.el
+++ b/lisp/erc/erc.el
@@ -222,6 +222,11 @@ prompt you for it.")
   :group 'erc
   :type 'boolean)
 
+(defcustom erc-use-ssl nil
+  "If set to non-nill, use SSL to connect to all networks."
+  :group 'erc
+  :type 'boolean)
+
 (defcustom erc-hide-prompt nil
   "If non-nil, do not display the prompt for commands.
 
@@ -2145,10 +2150,10 @@ functions in here get called with the parameters SERVER and NICK."
 
 ;;;###autoload
 (cl-defun erc (&key (server (erc-compute-server))
-                    (port   (erc-compute-port))
-                    (nick   (erc-compute-nick))
-                    password
-                    (full-name (erc-compute-full-name)))
+		    (port   (erc-compute-port))
+		    (nick   (erc-compute-nick))
+		    password
+		    (full-name (erc-compute-full-name)))
   "ERC is a powerful, modular, and extensible IRC client.
 This function is the main entry point for ERC.
 
@@ -2169,7 +2174,9 @@ then the server and full-name will be set to those values, whereas
 `erc-compute-port', `erc-compute-nick' and `erc-compute-full-name' will
 be invoked for the values of the other parameters."
   (interactive (erc-select-read-args))
-  (erc-open server port nick full-name t password))
+  (let ((erc-server-connect-function (if erc-use-ssl 'erc-open-tls-stream
+				       'erc-server-connect-function)))
+    (erc-open server port nick full-name t password))) 
 
 ;;;###autoload
 (defalias 'erc-select 'erc)

Re: [PATCH] Add option to ERC to make all connections use SSL.

[Ted Zlatanov]

On Wed, 30 Jul 2014 14:49:52 +0530 Vibhav Pant <vibhavp@gmail.com> wrote: 

VP> Presently, ERC can connect to IRC netowrks using SSL via the function 'erc-tls'.
VP> However, it can be confusing for new users to find this function, so I
VP> have added a patch to erc.el which adds an option (erc-use-ssl) to
VP> make all connections use SSL. Its value can be changed from
VP> the customize group "erc". (The default value is nil).

I like this and would like to add it, but is the trunk open for such new
features?

Also can this be t by default?  I don't know the state of IRC
these days.

Ted

Re: [PATCH] Add option to ERC to make all connections use SSL.

[Vibhav Pant]

> I like this and would like to add it, but is the trunk open for such new
> features?
Well, it can always get into the trunk after 24.4 is out.

> Also can this be t by default?  I don't know the state of IRC
> these days.

IIRC, most IRC networks have a seperate port(s) for SSL connections,
so setting it to t by default wouldnt work until the user knows the
port for the SSL connections (and IRC networks usually advertise their
"non-SSL" ports).
Also, networks like QuakeNet do not provide SSL, so connecting to the
quakenet network wouldnt work until the variable is nil.

-- 
Vibhav Pant
vibhavp@gmail.com

Re: [PATCH] Add option to ERC to make all connections use SSL.

[Glenn Morris]

Ted Zlatanov wrote:

> [...]is the trunk open for such new features?

Yes, it is.

Re: [PATCH] Add option to ERC to make all connections use SSL.

[Vibhav Pant]

>> [...]is the trunk open for such new features?
>
> Yes, it is.

So, could we get it into the trunk, or does the patch need more working?

-- 
Vibhav Pant
vibhavp@gmail.com

Re: [PATCH] Add option to ERC to make all connections use SSL.

[Ted Zlatanov]

On Fri, 1 Aug 2014 21:58:14 +0530 Vibhav Pant <vibhavp@gmail.com> wrote: 

>>> [...]is the trunk open for such new features?
>> 
>> Yes, it is.

VP> So, could we get it into the trunk, or does the patch need more working?

Is there a way to specify it per server?  e.g. maybe the variable could
be t, nil, or a list of server names?  Right now it seems pretty
radical: you're either all SSL or not.

Otherwise it looks good to me.

Ted

Re: [PATCH] Add option to ERC to make all connections use SSL.

[Vibhav Pant]

[-- Attachment #1: Type: text/plain, Size: 5395 bytes --]

> Is there a way to specify it per server?
Agreed. I have redone the patch and added some more features:
1. erc-ssl-servers: Alist of servers (ADDRESS PORT) for which ERC will
always connect to using SSL.
2. erc-use-ssl: If non-nill, all connections will be made using SSL.
3. erc-ssl-blacklist: Alist of server ERC will connect to without SSL.
Only useful when erc-use-ssl is non-nil.

erc-ssl-servers is also used to compute the initial port number
displayed on the minibuffer during user input when ERC is run
interactively.

Here's an example (non-interactive):
(setq erc-ssl-servers '(("irc.freenode.net" 7000)))
(erc :server "irc.freenode.net" :nick "foo") #creates a SSL connection
(setq erc-use-ssl t)
(erc :server "<some server supporting ssl>":port <ssl port>) # will
use a SSL connection
(setq erc-ssl-blacklist '(("irc.example.org"))) #assuming 1234 accepts
SSL connections
(erc :server "irc.example.org" :nick "foo") #connection does not use SSL

I have attached the patch, do tell me something else needs to be added/fixed.

diff --git a/lisp/erc/erc.el b/lisp/erc/erc.el
index 3bd9ff3..151482c 100644
--- a/lisp/erc/erc.el
+++ b/lisp/erc/erc.el
@@ -809,6 +809,27 @@ If nil, ERC will call `system-name' to get this
information."
   :type '(choice (const :tag "Default system name" nil)
                  string))

+(defcustom erc-ssl-servers nil
+  "Alist of networks to which ERC will connect to using SSL.
+(ADDRESS PORT) where ADDRESS is the address of the IRC network
+and PORT is the port on which the network accepts SSL connections."
+  :group 'erc
+  :type '(repeat
+      (list :tag "Network"
+        (string :tag "Network address")
+        (integer :tag "SSL Port"))))
+
+(defcustom erc-use-ssl nil
+  "If non-nil, all connections made by ERC will use SSL."
+  :group 'erc
+  :type 'boolean)
+
+(defcustom erc-ssl-blacklist nil
+  "List of server ERC will connect to without SSL.
+Only useful when `erc-use-ssl' is non-nil"
+  :group 'erc
+  :type '(repeat (list string)))
+
 (defcustom erc-ignore-list nil
   "List of regexps matching user identifiers to ignore.

@@ -2094,18 +2115,23 @@ functions in here get called with the
parameters SERVER and NICK."
 ;;;###autoload
 (defun erc-select-read-args ()
   "Prompt the user for values of nick, server, port, and password."
-  (let (user-input server port nick passwd)
+  (let (user-input server port nick passwd ssl-port)
     (setq user-input (read-from-minibuffer
                       "IRC server: "
                       (erc-compute-server) nil nil 'erc-server-history-list))
+    (setq ssl-port (if (not (assoc-string user-input erc-ssl-blacklist t))
+               (nth 1 (assoc-string user-input erc-ssl-servers t))
+             nil))

     (if (string-match "\\(.*\\):\\(.*\\)\\'" user-input)
         (setq port (erc-string-to-port (match-string 2 user-input))
               user-input (match-string 1 user-input))
       (setq port
             (erc-string-to-port (read-from-minibuffer
-                                 "IRC port: " (erc-port-to-string
-                                               (erc-compute-port))))))
+                                 "IRC port: " (if ssl-port
+                          (number-to-string ssl-port)
+                        (erc-port-to-string
+                         (erc-compute-port)))))))

     (if (string-match "\\`\\(.*\\)@\\(.*\\)" user-input)
         (setq nick (match-string 1 user-input)
@@ -2145,7 +2171,7 @@ functions in here get called with the parameters
SERVER and NICK."

 ;;;###autoload
 (cl-defun erc (&key (server (erc-compute-server))
-                    (port   (erc-compute-port))
+                    (port    nil)
                     (nick   (erc-compute-nick))
                     password
                     (full-name (erc-compute-full-name)))
@@ -2156,7 +2182,7 @@ It permits you to select connection parameters,
and then starts ERC.

 Non-interactively, it takes the keyword arguments
    (server (erc-compute-server))
-   (port   (erc-compute-port))
+   (port   nil)
    (nick   (erc-compute-nick))
    password
    (full-name (erc-compute-full-name)))
@@ -2166,10 +2192,23 @@ That is, if called with
    (erc :server \"irc.freenode.net\" :full-name \"Harry S Truman\")

 then the server and full-name will be set to those values, whereas
-`erc-compute-port', `erc-compute-nick' and `erc-compute-full-name' will
-be invoked for the values of the other parameters."
+ `erc-compute-nick' and `erc-compute-full-name' will be invoked
+ for the values of the other parameters. If the server address is found in
+ `erc-ssl-servers', the port corresponding to the server will be used, or
+ `erc-compute-port' will be invoked for its value."
   (interactive (erc-select-read-args))
-  (erc-open server port nick full-name t password))
+  (let* ((use-ssl (equal nil (assoc-string server erc-ssl-blacklist t)))
+     (erc-server-connect-function
+      (if (or (and erc-use-ssl use-ssl)
+           (assoc-string server erc-ssl-servers t))
+          'erc-open-tls-stream
+        'open-network-stream))
+     (ssl-port (nth 1 (assoc-string server erc-ssl-servers t))))
+
+    (if (and (numberp port) (numberp ssl-port) use-ssl)
+    (setq port ssl-port)
+      (setq port  (erc-compute-port)))
+    (erc-open server port nick full-name t password)))

 ;;;###autoload
 (defalias 'erc-select 'erc)

-- 
Vibhav Pant
vibhavp@gmail.com

[-- Attachment #2: erc-ssl-option.patch --]
[-- Type: text/x-patch, Size: 4228 bytes --]

diff --git a/lisp/erc/erc.el b/lisp/erc/erc.el
index 3bd9ff3..151482c 100644
--- a/lisp/erc/erc.el
+++ b/lisp/erc/erc.el
@@ -809,6 +809,27 @@ If nil, ERC will call `system-name' to get this information."
   :type '(choice (const :tag "Default system name" nil)
                  string))
 
+(defcustom erc-ssl-servers nil
+  "Alist of networks to which ERC will connect to using SSL.
+(ADDRESS PORT) where ADDRESS is the address of the IRC network
+and PORT is the port on which the network accepts SSL connections."
+  :group 'erc
+  :type '(repeat
+	  (list :tag "Network"
+		(string :tag "Network address")
+		(integer :tag "SSL Port"))))
+
+(defcustom erc-use-ssl nil
+  "If non-nil, all connections made by ERC will use SSL."
+  :group 'erc
+  :type 'boolean)
+
+(defcustom erc-ssl-blacklist nil
+  "List of server ERC will connect to without SSL.
+Only useful when `erc-use-ssl' is non-nil"
+  :group 'erc
+  :type '(repeat (list string)))
+
 (defcustom erc-ignore-list nil
   "List of regexps matching user identifiers to ignore.
 
@@ -2094,18 +2115,23 @@ functions in here get called with the parameters SERVER and NICK."
 ;;;###autoload
 (defun erc-select-read-args ()
   "Prompt the user for values of nick, server, port, and password."
-  (let (user-input server port nick passwd)
+  (let (user-input server port nick passwd ssl-port)
     (setq user-input (read-from-minibuffer
                       "IRC server: "
                       (erc-compute-server) nil nil 'erc-server-history-list))
+    (setq ssl-port (if (not (assoc-string user-input erc-ssl-blacklist t))
+		       (nth 1 (assoc-string user-input erc-ssl-servers t))
+		     nil))
 
     (if (string-match "\\(.*\\):\\(.*\\)\\'" user-input)
         (setq port (erc-string-to-port (match-string 2 user-input))
               user-input (match-string 1 user-input))
       (setq port
             (erc-string-to-port (read-from-minibuffer
-                                 "IRC port: " (erc-port-to-string
-                                               (erc-compute-port))))))
+                                 "IRC port: " (if ssl-port
+						  (number-to-string ssl-port)
+						(erc-port-to-string
+						 (erc-compute-port)))))))
 
     (if (string-match "\\`\\(.*\\)@\\(.*\\)" user-input)
         (setq nick (match-string 1 user-input)
@@ -2145,7 +2171,7 @@ functions in here get called with the parameters SERVER and NICK."
 
 ;;;###autoload
 (cl-defun erc (&key (server (erc-compute-server))
-                    (port   (erc-compute-port))
+                    (port    nil)
                     (nick   (erc-compute-nick))
                     password
                     (full-name (erc-compute-full-name)))
@@ -2156,7 +2182,7 @@ It permits you to select connection parameters, and then starts ERC.
 
 Non-interactively, it takes the keyword arguments
    (server (erc-compute-server))
-   (port   (erc-compute-port))
+   (port   nil)
    (nick   (erc-compute-nick))
    password
    (full-name (erc-compute-full-name)))
@@ -2166,10 +2192,23 @@ That is, if called with
    (erc :server \"irc.freenode.net\" :full-name \"Harry S Truman\")
 
 then the server and full-name will be set to those values, whereas
-`erc-compute-port', `erc-compute-nick' and `erc-compute-full-name' will
-be invoked for the values of the other parameters."
+ `erc-compute-nick' and `erc-compute-full-name' will be invoked
+ for the values of the other parameters. If the server address is found in
+ `erc-ssl-servers', the port corresponding to the server will be used, or
+ `erc-compute-port' will be invoked for its value."
   (interactive (erc-select-read-args))
-  (erc-open server port nick full-name t password))
+  (let* ((use-ssl (equal nil (assoc-string server erc-ssl-blacklist t)))
+	 (erc-server-connect-function
+	  (if (or (and erc-use-ssl use-ssl)
+		   (assoc-string server erc-ssl-servers t))
+	      'erc-open-tls-stream
+	    'open-network-stream))
+	 (ssl-port (nth 1 (assoc-string server erc-ssl-servers t))))
+    
+    (if (and (numberp port) (numberp ssl-port) use-ssl)
+	(setq port ssl-port)
+      (setq port  (erc-compute-port)))
+    (erc-open server port nick full-name t password)))
 
 ;;;###autoload
 (defalias 'erc-select 'erc)

Re: [PATCH] Add option to ERC to make all connections use SSL.

[Josh]

[-- Attachment #1: Type: text/plain, Size: 844 bytes --]

On Sat, Aug 2, 2014 at 10:47 AM, Vibhav Pant <vibhavp@gmail.com> wrote:

> > Is there a way to specify it per server?
> Agreed. I have redone the patch and added some more features:
> 1. erc-ssl-servers: Alist of servers (ADDRESS PORT) for which ERC will
> always connect to using SSL.
> 2. erc-use-ssl: If non-nill, all connections will be made using SSL.
> 3. erc-ssl-blacklist: Alist of server ERC will connect to without SSL.
> Only useful when erc-use-ssl is non-nil.


This seems likely to interact poorly with the existing server to port
mappings
in `erc-server-alist'.  Perhaps the information provided by the items above
could be specified in e-s-a instead, for example by accepting multiple
PORTS arguments of the form (:ssl-ports a b c) and (:non-ssl-ports x y z)
and attempting connections in the order in which they appeared.

jlf

[-- Attachment #2: Type: text/html, Size: 1409 bytes --]

Re: [PATCH] Add option to ERC to make all connections use SSL.

[John Zorn]

On Sat, 2 Aug 2014 23:17:13 +0530, 
Vibhav Pant <vibhavp@gmail.com> wrote:
> Agreed. I have redone the patch and added some more features:
> 1. erc-ssl-servers: Alist of servers (ADDRESS PORT) for which ERC will
> always connect to using SSL.
> 2. erc-use-ssl: If non-nill, all connections will be made using SSL.
> 3. erc-ssl-blacklist: Alist of server ERC will connect to without SSL.
> Only useful when erc-use-ssl is non-nil.
>
> erc-ssl-servers is also used to compute the initial port number
> displayed on the minibuffer during user input when ERC is run
> interactively.
>

All this extra code and complexity, for what exactly?
You said it yourself, `erc-tls' is already there,
it's even interactive!

If you think it's not "prominent enough", one can certainly
make it more prominent instead of producing the tangled
mess that is your patch. Similar situations have
led to ERC being bloated and messy as hell.

John

Re: [PATCH] Add option to ERC to make all connections use SSL.

[Josh]

[-- Attachment #1: Type: text/plain, Size: 793 bytes --]

On Sun, Aug 3, 2014 at 7:39 AM, John Zorn <jzornn@gmail.com> wrote:
 > All this extra code and complexity, for what exactly?
> You said it yourself, `erc-tls' is already there,
> it's even interactive!
>
> If you think it's not "prominent enough", one can certainly
> make it more prominent instead of producing the tangled
> mess that is your patch. Similar situations have
> led to ERC being bloated and messy as hell.
>
> John

What a bizarrely hostile and unproductive post.

Vibhav, technical issues aside, thanks for your efforts to improve
ERC; it could definitely use some more attention.  I'd recommend
disregarding that outburst entirely; it looks to have been written
by someone who has never contributed to Emacs in any way or
was trolling with a throw-away identity or both.

jlf

[-- Attachment #2: Type: text/html, Size: 1795 bytes --]

Re: [PATCH] Add option to ERC to make all connections use SSL.

[Ted Zlatanov]

On Sat, 2 Aug 2014 12:11:47 -0700 Josh <josh@foxtail.org> wrote: 

J> On Sat, Aug 2, 2014 at 10:47 AM, Vibhav Pant <vibhavp@gmail.com> wrote:
>> > Is there a way to specify it per server?
>> Agreed. I have redone the patch and added some more features:
>> 1. erc-ssl-servers: Alist of servers (ADDRESS PORT) for which ERC will
>> always connect to using SSL.
>> 2. erc-use-ssl: If non-nill, all connections will be made using SSL.
>> 3. erc-ssl-blacklist: Alist of server ERC will connect to without SSL.
>> Only useful when erc-use-ssl is non-nil.

J> This seems likely to interact poorly with the existing server to port
J> mappings
J> in `erc-server-alist'.  Perhaps the information provided by the items above
J> could be specified in e-s-a instead, for example by accepting multiple
J> PORTS arguments of the form (:ssl-ports a b c) and (:non-ssl-ports x y z)
J> and attempting connections in the order in which they appeared.

Agreed. In fact if the ERC maintainer(s) could take a look at this, it
would be greatly appreciated. The original patch was simple but too hard
to turn off, while the second version from Vibhav introduced too many
new configuration options IMO.  Something that fits better with ERC's
existing configuration would be best, as Josh suggested.  I'll stay out
of it to avoid confusing the issue further.

Ted

Re: [PATCH] Add option to ERC to make all connections use SSL.

[Vibhav Pant]

> new configuration options IMO.  Something that fits better with ERC's existing configuration would be best, as Josh suggested.

I'm working on a patch which works with erc-server-alist.
-- 
Vibhav Pant
vibhavp@gmail.com