ssl: Further error handling enhancments

follow up enhancments done in commit
e56167dd6ca8d37d26ea7f19933691a3bda41113

Make sure format_error return good strings. Replace confusing legacy atoms
with more descriptive atoms.

5 files changed, 63 insertions, 60 deletions

diff --git a/lib/ssl/test/ssl_basic_SUITE.erl b/lib/ssl/test/ssl_basic_SUITE.erl
index db203a47c4..b5c6a1da49 100644
--- a/lib/ssl/test/ssl_basic_SUITE.erl
+++ b/lib/ssl/test/ssl_basic_SUITE.erl
@@ -99,10 +99,10 @@ options_tests() ->
      invalid_inet_set_option_not_list,
      invalid_inet_set_option_improper_list,
      dh_params,
-     ecertfile,
-     ecacertfile,
-     ekeyfile,
-     eoptions,
+     invalid_certfile,
+     invalid_cacertfile,
+     invalid_keyfile,
+     invalid_options,
      protocol_versions,
      empty_protocol_versions,
      ipv6,
@@ -822,7 +822,7 @@ invalid_inet_get_option_not_list(Config) when is_list(Config) ->
 
 
 get_invalid_inet_option_not_list(Socket) ->
-    {error, {eoptions, {socket_options, some_invalid_atom_here}}}
+    {error, {options, {socket_options, some_invalid_atom_here}}}
      = ssl:getopts(Socket, some_invalid_atom_here),
      ok.
 
@@ -854,7 +854,7 @@ invalid_inet_get_option_improper_list(Config) when is_list(Config) ->
 
 
 get_invalid_inet_option_improper_list(Socket) ->
-    {error, {eoptions, {socket_options, foo,_}}} = ssl:getopts(Socket, [packet | foo]),
+    {error, {options, {socket_options, foo,_}}} = ssl:getopts(Socket, [packet | foo]),
     ok.
 
 %%--------------------------------------------------------------------
@@ -884,10 +884,10 @@ invalid_inet_set_option(Config) when is_list(Config) ->
     ssl_test_lib:close(Client).
 
 set_invalid_inet_option(Socket) ->
-    {error, {eoptions, {socket_option, {packet, foo}}}} = ssl:setopts(Socket, [{packet, foo}]),
-    {error, {eoptions, {socket_option, {header, foo}}}} = ssl:setopts(Socket, [{header, foo}]),
-    {error, {eoptions, {socket_option, {active, foo}}}} = ssl:setopts(Socket, [{active, foo}]),
-    {error, {eoptions, {socket_option, {mode, foo}}}}   = ssl:setopts(Socket, [{mode, foo}]),
+    {error, {options, {socket_options, {packet, foo}}}} = ssl:setopts(Socket, [{packet, foo}]),
+    {error, {options, {socket_options, {header, foo}}}} = ssl:setopts(Socket, [{header, foo}]),
+    {error, {options, {socket_options, {active, foo}}}} = ssl:setopts(Socket, [{active, foo}]),
+    {error, {options, {socket_options, {mode, foo}}}}   = ssl:setopts(Socket, [{mode, foo}]),
     ok.
 %%--------------------------------------------------------------------
 invalid_inet_set_option_not_list() ->
@@ -917,7 +917,7 @@ invalid_inet_set_option_not_list(Config) when is_list(Config) ->
 
 
 set_invalid_inet_option_not_list(Socket) ->
-    {error, {eoptions, {not_a_proplist, some_invalid_atom_here}}}
+    {error, {options, {not_a_proplist, some_invalid_atom_here}}}
 	= ssl:setopts(Socket, some_invalid_atom_here),
     ok.
 
@@ -948,7 +948,7 @@ invalid_inet_set_option_improper_list(Config) when is_list(Config) ->
     ssl_test_lib:close(Client).
 
 set_invalid_inet_option_improper_list(Socket) ->
-    {error, {eoptions, {not_a_proplist, [{packet, 0} | {foo, 2}]}}} =
+    {error, {options, {not_a_proplist, [{packet, 0} | {foo, 2}]}}} =
 	ssl:setopts(Socket, [{packet, 0} | {foo, 2}]),
     ok.
 
@@ -1286,9 +1286,9 @@ ipv6(Config) when is_list(Config) ->
 
 %%--------------------------------------------------------------------
 
-ekeyfile() ->
+invalid_keyfile() ->
     [{doc,"Test what happens with an invalid key file"}].
-ekeyfile(Config) when is_list(Config) -> 
+invalid_keyfile(Config) when is_list(Config) -> 
     ClientOpts = ?config(client_opts, Config),
     BadOpts = ?config(server_bad_key, Config),
     {ClientNode, ServerNode, Hostname} = ssl_test_lib:run_where(Config),
@@ -1304,16 +1304,17 @@ ekeyfile(Config) when is_list(Config) ->
 	ssl_test_lib:start_client_error([{node, ClientNode}, 
 			    {port, Port}, {host, Hostname},
 			    {from, self()},  {options, ClientOpts}]),
-    
-    ssl_test_lib:check_result(Server, {error, ekeyfile}, Client,  
-			      {error, closed}).
+
+    File = proplists:get_value(keyfile,BadOpts),    
+    ssl_test_lib:check_result(Server, {error,{options, {keyfile, File, {error,enoent}}}}, Client,  
+				       {error, closed}).
 
 %%--------------------------------------------------------------------
 
-ecertfile() ->
+invalid_certfile() ->
     [{doc,"Test what happens with an invalid cert file"}].
 
-ecertfile(Config) when is_list(Config) -> 
+invalid_certfile(Config) when is_list(Config) -> 
     ClientOpts = ?config(client_opts, Config),
     ServerBadOpts = ?config(server_bad_cert, Config),
     {ClientNode, ServerNode, Hostname} = ssl_test_lib:run_where(Config),
@@ -1330,16 +1331,16 @@ ecertfile(Config) when is_list(Config) ->
 					 {port, Port}, {host, Hostname},
 					 {from, self()}, 
 					 {options, ClientOpts}]),
-    
-    ssl_test_lib:check_result(Server, {error, ecertfile}, Client, 
-			      {error, closed}).
+    File = proplists:get_value(certfile, ServerBadOpts),
+    ssl_test_lib:check_result(Server, {error,{options, {certfile, File, {error,enoent}}}}, 
+			      Client, {error, closed}).
     
 
 %%--------------------------------------------------------------------
-ecacertfile() ->
+invalid_cacertfile() ->
     [{doc,"Test what happens with an invalid cacert file"}].
 
-ecacertfile(Config) when is_list(Config) ->
+invalid_cacertfile(Config) when is_list(Config) ->
     ClientOpts    = [{reuseaddr, true}|?config(client_opts, Config)],
     ServerBadOpts = [{reuseaddr, true}|?config(server_bad_ca, Config)],
     {ClientNode, ServerNode, Hostname} = ssl_test_lib:run_where(Config),
@@ -1357,11 +1358,12 @@ ecacertfile(Config) when is_list(Config) ->
 					 {port, Port0}, {host, Hostname},
 					 {from, self()}, 
 					 {options, ClientOpts}]),
+
+    File0 = proplists:get_value(cacertfile, ServerBadOpts),
     
-    ssl_test_lib:check_result(Server0, {error, ecacertfile},
+    ssl_test_lib:check_result(Server0, {error, {options, {cacertfile, File0,{error,enoent}}}},
 			      Client0, {error, closed}),
     
-    File0 = proplists:get_value(cacertfile, ServerBadOpts),
     File = File0 ++ "do_not_exit.pem",
     ServerBadOpts1 = [{cacertfile, File}|proplists:delete(cacertfile, ServerBadOpts)],
             
@@ -1378,31 +1380,32 @@ ecacertfile(Config) when is_list(Config) ->
 					 {from, self()}, 
 					 {options, ClientOpts}]),
 
-    ssl_test_lib:check_result(Server1, {error, ecacertfile},
+
+    ssl_test_lib:check_result(Server1, {error, {options, {cacertfile, File,{error,enoent}}}},
 			      Client1, {error, closed}),
     ok.
     
     
 
 %%--------------------------------------------------------------------
-eoptions() ->
+invalid_options() ->
     [{doc,"Test what happens when we give invalid options"}].
        
-eoptions(Config) when is_list(Config) -> 
+invalid_options(Config) when is_list(Config) -> 
     ClientOpts = ?config(client_opts, Config),
     ServerOpts = ?config(server_opts, Config),
     {ClientNode, ServerNode, Hostname} = ssl_test_lib:run_where(Config),
     
     Check = fun(Client, Server, {versions, [sslv2, sslv3]} = Option) ->
 		    ssl_test_lib:check_result(Server, 
-					      {error, {eoptions, {sslv2, Option}}}, 
+					      {error, {options, {sslv2, Option}}}, 
 					      Client,
-					      {error, {eoptions, {sslv2, Option}}});
+					      {error, {options, {sslv2, Option}}});
 	       (Client, Server, Option) ->
 		    ssl_test_lib:check_result(Server, 
-					      {error, {eoptions, Option}}, 
+					      {error, {options, Option}}, 
 					      Client,
-					      {error, {eoptions, Option}})
+					      {error, {options, Option}})
 	    end,
 
     TestOpts = [{versions, [sslv2, sslv3]}, 
@@ -1593,8 +1596,8 @@ default_reject_anonymous(Config) when is_list(Config) ->
 			    [{ciphers,[Cipher]} |
 			     ClientOpts]}]),
 
-    ssl_test_lib:check_result(Server, {error, {essl, "insufficient security"}},
-			      Client, {error, {essl, "insufficient security"}}).
+    ssl_test_lib:check_result(Server, {error, {tls_alert, "insufficient security"}},
+			      Client, {error, {tls_alert, "insufficient security"}}).
 
 %%--------------------------------------------------------------------
 reuse_session() ->
@@ -3147,7 +3150,7 @@ treashold(N, _) ->
     N + 1.
 
 get_invalid_inet_option(Socket) ->
-    {error, {eoptions, {socket_option, foo, _}}} = ssl:getopts(Socket, [foo]),
+    {error, {options, {socket_options, foo, _}}} = ssl:getopts(Socket, [foo]),
     ok.
 
 shutdown_result(Socket, server) ->
diff --git a/lib/ssl/test/ssl_certificate_verify_SUITE.erl b/lib/ssl/test/ssl_certificate_verify_SUITE.erl
index 86e1d47be7..26938bda50 100644
--- a/lib/ssl/test/ssl_certificate_verify_SUITE.erl
+++ b/lib/ssl/test/ssl_certificate_verify_SUITE.erl
@@ -252,8 +252,8 @@ server_require_peer_cert_fail(Config) when is_list(Config) ->
 					      {from, self()},
 					      {options, [{active, false} | BadClientOpts]}]),
 
-    ssl_test_lib:check_result(Server, {error, {essl, "handshake failure"}},
-			      Client, {error, {essl, "handshake failure"}}).
+    ssl_test_lib:check_result(Server, {error, {tls_alert, "handshake failure"}},
+			      Client, {error, {tls_alert, "handshake failure"}}).
 
 
 %%--------------------------------------------------------------------
@@ -293,14 +293,14 @@ verify_fun_always_run_client(Config) when is_list(Config) ->
 					       [{verify, verify_peer},
 						{verify_fun, FunAndState}
 						| ClientOpts]}]),
-    %% Server error may be {essl,"handshake failure"} or closed depending on timing
+    %% Server error may be {tls_alert,"handshake failure"} or closed depending on timing
     %% this is not a bug it is a circumstance of how tcp works!
     receive
 	{Server, ServerError} ->
 	    ct:print("Server Error ~p~n", [ServerError])
     end,
 
-    ssl_test_lib:check_result(Client, {error, {essl, "handshake failure"}}).
+    ssl_test_lib:check_result(Client, {error, {tls_alert, "handshake failure"}}).
 
 %%--------------------------------------------------------------------
 verify_fun_always_run_server() ->
@@ -342,14 +342,14 @@ verify_fun_always_run_server(Config) when is_list(Config) ->
 					       [{verify, verify_peer}
 						| ClientOpts]}]),
 
-    %% Client error may be {essl, "handshake failure" } or closed depending on timing
+    %% Client error may be {tls_alert, "handshake failure" } or closed depending on timing
     %% this is not a bug it is a circumstance of how tcp works!
     receive
 	{Client, ClientError} ->
 	    ct:print("Client Error ~p~n", [ClientError])
     end,
 
-    ssl_test_lib:check_result(Server, {error, {essl, "handshake failure"}}).
+    ssl_test_lib:check_result(Server, {error, {tls_alert, "handshake failure"}}).
 
 %%--------------------------------------------------------------------
 
@@ -432,8 +432,8 @@ cert_expired(Config) when is_list(Config) ->
 					      {from, self()},
 					      {options, [{verify, verify_peer} | ClientOpts]}]),
 
-    ssl_test_lib:check_result(Server, {error, {essl, "certificate expired"}},
-			      Client, {error, {essl, "certificate expired"}}).
+    ssl_test_lib:check_result(Server, {error, {tls_alert, "certificate expired"}},
+			      Client, {error, {tls_alert, "certificate expired"}}).
 
 two_digits_str(N) when N < 10 ->
     lists:flatten(io_lib:format("0~p", [N]));
@@ -710,8 +710,8 @@ invalid_signature_server(Config) when is_list(Config) ->
 					      {from, self()},
 					      {options, [{verify, verify_peer} | ClientOpts]}]),
 
-    tcp_delivery_workaround(Server, {error, {essl, "bad certificate"}},
-			    Client, {error, {essl, "bad certificate"}}).
+    tcp_delivery_workaround(Server, {error, {tls_alert, "bad certificate"}},
+			    Client, {error, {tls_alert, "bad certificate"}}).
 
 %%--------------------------------------------------------------------
 
@@ -747,8 +747,8 @@ invalid_signature_client(Config) when is_list(Config) ->
 					      {from, self()},
 					      {options, NewClientOpts}]),
 
-    tcp_delivery_workaround(Server, {error, {essl, "bad certificate"}},
-			    Client, {error, {essl, "bad certificate"}}).
+    tcp_delivery_workaround(Server, {error, {tls_alert, "bad certificate"}},
+			    Client, {error, {tls_alert, "bad certificate"}}).
 
 
 %%--------------------------------------------------------------------
@@ -792,7 +792,7 @@ server_verify_no_cacerts(Config) when is_list(Config) ->
 					      {options, [{verify, verify_peer}
 							 | ServerOpts]}]),
 
-    ssl_test_lib:check_result(Server, {error, {eoptions, {cacertfile, ""}}}).
+    ssl_test_lib:check_result(Server, {error, {options, {cacertfile, ""}}}).
 
 
 %%--------------------------------------------------------------------
@@ -829,8 +829,8 @@ unknown_server_ca_fail(Config) when is_list(Config) ->
 						{verify_fun, FunAndState}
 						| ClientOpts]}]),
 
-    ssl_test_lib:check_result(Server, {error, {essl, "unknown ca"}},
-			      Client, {error, {essl, "unknown ca"}}).
+    ssl_test_lib:check_result(Server, {error, {tls_alert, "unknown ca"}},
+			      Client, {error, {tls_alert, "unknown ca"}}).
 
 %%--------------------------------------------------------------------
 unknown_server_ca_accept_verify_none() ->
diff --git a/lib/ssl/test/ssl_npn_handshake_SUITE.erl b/lib/ssl/test/ssl_npn_handshake_SUITE.erl
index 4e848095a5..862690cd7b 100644
--- a/lib/ssl/test/ssl_npn_handshake_SUITE.erl
+++ b/lib/ssl/test/ssl_npn_handshake_SUITE.erl
@@ -106,15 +106,15 @@ end_per_group(_GroupName, Config) ->
 %%--------------------------------------------------------------------
 
 validate_empty_protocols_are_not_allowed(Config) when is_list(Config) ->
-    {error, {eoptions, {next_protocols_advertised, {invalid_protocol, <<>>}}}}
+    {error, {options, {next_protocols_advertised, {invalid_protocol, <<>>}}}}
 	= (catch ssl:listen(9443,
 			    [{next_protocols_advertised, [<<"foo/1">>, <<"">>]}])),
-    {error, {eoptions, {client_preferred_next_protocols, {invalid_protocol, <<>>}}}}
+    {error, {options, {client_preferred_next_protocols, {invalid_protocol, <<>>}}}}
 	= (catch ssl:connect({127,0,0,1}, 9443,
 			     [{client_preferred_next_protocols,
 			       {client, [<<"foo/1">>, <<"">>], <<"foox/1">>}}], infinity)),
     Option = {client_preferred_next_protocols, {invalid_protocol, <<"">>}},
-    {error, {eoptions, Option}} = (catch ssl:connect({127,0,0,1}, 9443, [Option], infinity)).
+    {error, {options, Option}} = (catch ssl:connect({127,0,0,1}, 9443, [Option], infinity)).
 
 %--------------------------------------------------------------------------------
 
@@ -126,12 +126,12 @@ validate_empty_advertisement_list_is_allowed(Config) when is_list(Config) ->
 
 validate_advertisement_must_be_a_binary_list(Config) when is_list(Config) ->
     Option = {next_protocols_advertised, blah},
-    {error, {eoptions, Option}} = (catch ssl:listen(9443, [Option])).
+    {error, {options, Option}} = (catch ssl:listen(9443, [Option])).
 %--------------------------------------------------------------------------------
 
 validate_client_protocols_must_be_a_tuple(Config) when is_list(Config)  ->
     Option = {client_preferred_next_protocols, [<<"foo/1">>]},
-    {error, {eoptions, Option}} = (catch ssl:connect({127,0,0,1}, 9443, [Option])).
+    {error, {options, Option}} = (catch ssl:connect({127,0,0,1}, 9443, [Option])).
 
 %--------------------------------------------------------------------------------
 
@@ -220,7 +220,7 @@ npn_not_supported_client(Config) when is_list(Config) ->
 			    {from, self()},  {options, ClientOpts}]),
     
     ssl_test_lib:check_result(Client, {error, 
-				       {eoptions, 
+				       {options, 
 					{not_supported_in_sslv3, PrefProtocols}}}).
 
 %--------------------------------------------------------------------------------
@@ -229,7 +229,7 @@ npn_not_supported_server(Config) when is_list(Config)->
     AdvProtocols = {next_protocols_advertised, [<<"spdy/2">>, <<"http/1.1">>, <<"http/1.0">>]},
     ServerOpts = [AdvProtocols] ++  ServerOpts0,
   
-    {error, {eoptions, {not_supported_in_sslv3, AdvProtocols}}} = ssl:listen(0, ServerOpts).
+    {error, {options, {not_supported_in_sslv3, AdvProtocols}}} = ssl:listen(0, ServerOpts).
 
 %%--------------------------------------------------------------------
 %% Internal functions ------------------------------------------------
diff --git a/lib/ssl/test/ssl_test_lib.erl b/lib/ssl/test/ssl_test_lib.erl
index 8d96a70a6e..d58541df52 100644
--- a/lib/ssl/test/ssl_test_lib.erl
+++ b/lib/ssl/test/ssl_test_lib.erl
@@ -206,7 +206,7 @@ close(Pid) ->
 
 check_result(Server, {error, SReason} = ServerMsg, Client,  {error, closed} = ClientMsg) -> 
     receive 
-	{Server, {error, {SReason, _}}} -> 
+	{Server, {error, SReason}} -> 
 	    receive 
 		{Client, ClientMsg} ->
 		    ok;
diff --git a/lib/ssl/test/ssl_to_openssl_SUITE.erl b/lib/ssl/test/ssl_to_openssl_SUITE.erl
index 7c0c00bf36..4f53132d5d 100644
--- a/lib/ssl/test/ssl_to_openssl_SUITE.erl
+++ b/lib/ssl/test/ssl_to_openssl_SUITE.erl
@@ -902,7 +902,7 @@ ssl2_erlang_server_openssl_client(Config) when is_list(Config) ->
 	    ok
 
     end,
-    ssl_test_lib:check_result(Server, {error, {essl, "protocol version"}}),
+    ssl_test_lib:check_result(Server, {error, {tls_alert, "protocol version"}}),
     process_flag(trap_exit, false).
 
 %%--------------------------------------------------------------------