File 1671-kernel-Search-XDG_CONFIG_HOME-for-erlang-c... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 1671-kernel-Search-XDG_CONFIG_HOME-for-erlang-cookie.patch of Package erlang (Revision 0e04b8d79a55adf8ba49c177393a4846)

Currently displaying revision 0e04b8d79a55adf8ba49c177393a4846 , Show latest

From 9a05c83298ce197d26488d11074c49b23d5eb3df Mon Sep 17 00:00:00 2001
From: Lukas Larsson <lukas@erlang.org>
Date: Tue, 26 Oct 2021 16:01:44 +0200
Subject: [PATCH 1/7] kernel: Search $XDG_CONFIG_HOME for erlang cookie

---
 erts/doc/src/erl_cmd.xml                    | 17 ++--
 erts/doc/src/erlang.xml                     | 11 ++-
 erts/doc/src/init.xml                       |  2 +-
 lib/kernel/src/auth.erl                     | 90 +++++++++++++++------
 lib/kernel/test/erl_distribution_SUITE.erl  | 58 ++++++++++++-
 lib/observer/src/observer_wx.erl            | 19 +++--
 lib/stdlib/doc/src/filename.xml             | 12 +--
 system/doc/reference_manual/distributed.xml | 11 ++-
 8 files changed, 166 insertions(+), 54 deletions(-)

diff --git a/erts/doc/src/erl_cmd.xml b/erts/doc/src/erl_cmd.xml
index fac35b6aab..a89586362d 100644
--- a/erts/doc/src/erl_cmd.xml
+++ b/erts/doc/src/erl_cmd.xml
@@ -461,10 +461,12 @@ $ <input>erl \
         <p>Makes the Erlang runtime system into a distributed node.
           This flag invokes all network servers necessary for a node to
           become distributed; see <seeerl marker="kernel:net_kernel">
-          <c>net_kernel(3)</c></seeerl>. It is also ensured that
+          <c>net_kernel(3)</c></seeerl>. It also ensures that
           <c><![CDATA[epmd]]></c> runs on the current host before Erlang is
-          started; see <seecom marker="epmd"><c>epmd(1)</c></seecom> and the
-          <seecom marker="#start_epmd"><c>-start_epmd</c></seecom> option.</p>
+          started (see <seecom marker="epmd"><c>epmd(1)</c></seecom> and the
+          <seecom marker="#start_epmd"><c>-start_epmd</c></seecom> option) and
+          that a magic cookie has been set
+          (see <seecom marker="#setcookie">-setcookie</seecom>).</p>
         <p>The node name will be <c><![CDATA[Name@Host]]></c>, where
           <c><![CDATA[Host]]></c> is the fully qualified host name of the
           current host. For short names, use flag <c><![CDATA[-sname]]></c>
@@ -626,11 +628,14 @@ $ <input>erl \
           passed as atoms. See <seeerl marker="init">
           <c>init(3)</c></seeerl>.</p>
       </item>
-      <tag><c><![CDATA[-setcookie Cookie]]></c></tag>
+      <tag><marker id="setcookie"/><c><![CDATA[-setcookie Cookie]]></c></tag>
       <item>
         <p>Sets the magic cookie of the node to <c><![CDATA[Cookie]]></c>; see
-          <seemfa marker="erlang#set_cookie/2">
-          <c>erlang:set_cookie/2</c></seemfa>.</p>
+          <seemfa marker="erlang#set_cookie/1"><c>erlang:set_cookie/1</c></seemfa>.
+          See see section
+          <seeguide marker="system/reference_manual:distributed">Distributed Erlang</seeguide>
+          in the Erlang Reference Manual for more details.
+        </p>
       </item>
       <tag><c><![CDATA[-setcookie Node Cookie]]></c></tag>
       <item>
diff --git a/erts/doc/src/erlang.xml b/erts/doc/src/erlang.xml
index b0d393350c..d771aa99db 100644
--- a/erts/doc/src/erlang.xml
+++ b/erts/doc/src/erlang.xml
@@ -2513,7 +2513,9 @@ uncompiled code with the same arity are mapped to the same list by
       <fsummary>Get the magic cookie of the local node.</fsummary>
       <desc>
         <p>Returns the magic cookie of the local node if the node is
-          alive, otherwise the atom <c>nocookie</c>.</p>
+          alive, otherwise the atom <c>nocookie</c>. This value is set by
+          <seemfa marker="#set_cookie/1"><c>set_cookie/1</c></seemfa>.
+        </p>
       </desc>
     </func>
 
@@ -2523,7 +2525,8 @@ uncompiled code with the same arity are mapped to the same list by
       <desc>
         <p>Returns the magic cookie for node <c><anno>Node</anno></c>
           if the local node is alive,
-          otherwise the atom <c>nocookie</c>.</p>
+          otherwise the atom <c>nocookie</c>. This value is set by
+          <seemfa marker="#set_cookie/2"><c>set_cookie/2</c></seemfa>.</p>
       </desc>
     </func>
 
@@ -6967,6 +6970,8 @@ true</pre>
           <seeguide marker="system/reference_manual:distributed">
           Distributed Erlang</seeguide>
           in the Erlang Reference Manual in System Documentation).</p>
+        <p>You can get this value using
+          <seemfa marker="#get_cookie/0"><c>get_cookie/0</c></seemfa>.</p>
         <p>Failure: <c>function_clause</c> if the local node is not
           alive.</p>
       </desc>
@@ -6984,6 +6989,8 @@ true</pre>
           <seeguide marker="system/reference_manual:distributed">
           Distributed Erlang</seeguide>
           in the Erlang Reference Manual in System Documentation).</p>
+        <p>You can get this value using
+          <seemfa marker="#get_cookie/1"><c>get_cookie/1</c></seemfa>.</p>
         <p>Failure: <c>function_clause</c> if the local node is not
           alive.</p>
       </desc>
diff --git a/erts/doc/src/init.xml b/erts/doc/src/init.xml
index 1b22cbe478..bf2a593dcd 100644
--- a/erts/doc/src/init.xml
+++ b/erts/doc/src/init.xml
@@ -108,7 +108,7 @@
 3> <input>init:get_argument(progname).</input>
 {ok,[["erl"]]}</pre>
           </item>
-          <tag><c>home</c></tag>
+          <tag><marker id="home"/><c>home</c></tag>
           <item>
             <p>The home directory (on Unix, the value of $HOME):</p>
             <pre>
diff --git a/lib/kernel/src/auth.erl b/lib/kernel/src/auth.erl
index 8298175f9f..5401d9dba5 100644
--- a/lib/kernel/src/auth.erl
+++ b/lib/kernel/src/auth.erl
@@ -355,26 +355,64 @@ init_setcookie([], OurCookies, OtherCookies) ->
 ets_new_cookies() ->
     ets:new(cookies, [?COOKIE_ETS_PROTECTION]).
 
+%% Read cookie from:
+%%  1. $HOME/.erlang.cookie
+%%  2. $XDG_CONFIG_HOME/erlang/.erlang.cookie
+%%
+%% If neither are present, we generate $HOME/.erlang.cookie
 read_cookie() ->
+    XDGPath = filename:join(
+                filename:basedir(user_config, "erlang"),
+                ".erlang.cookie"),
     case init:get_argument(home) of
 	{ok, [[Home]]} ->
-	    read_cookie(filename:join(Home, ".erlang.cookie"));
+            HomePath = filename:join(Home, ".erlang.cookie"),
+	    case read_cookie(HomePath) of
+                {error, enoent} ->
+                    case read_cookie(XDGPath) of
+                        {error, enoent} ->
+                            case create_cookie(HomePath) of
+                                ok ->
+                                    {ok, Cookie} = read_cookie(HomePath),
+                                    Cookie;
+                                Error -> Error
+                            end;
+                        {ok, Cookie} ->
+                            Cookie;
+                        Error ->
+                            Error
+                    end;
+                {ok, Cookie} ->
+                    Cookie;
+                Error ->
+                    Error
+            end;
 	_ ->
-	    {error, "No home for cookie file"}
+            %% Failed to read find home, try xdg path
+            case read_cookie(XDGPath) of
+                {error, enoent} ->
+                    case create_cookie(XDGPath) of
+                        ok ->
+                            {ok, Cookie} = read_cookie(XDGPath),
+                            Cookie;
+                        Error -> Error
+                    end;
+                {ok, Cookie} ->
+                    Cookie;
+                _Error ->
+                    {error, "No home for cookie file"}
+            end
     end.
 
 read_cookie(Name) ->
     case file:raw_read_file_info(Name) of
 	{ok, #file_info {type=Type, mode=Mode, size=Size}} ->
 	    case check_attributes(Name, Type, Mode, os:type()) of
-		ok -> read_cookie(Name, Size);
-		Error -> Error
-	    end;
-	{error, enoent} ->
-	    case create_cookie(Name) of
-		ok -> read_cookie(Name);
+		ok -> {ok, read_cookie(Name, Size)};
 		Error -> Error
 	    end;
+        {error, enoent} ->
+            {error, enoent};
 	{error, Reason} ->
 	    {error, make_error(Name, Reason)}
     end.
@@ -434,24 +472,24 @@ create_cookie(Name) ->
 	       bxor erlang:unique_integer()),
     Cookie = random_cookie(20, Seed, []),
     case file:open(Name, [write, raw]) of
-	{ok, File} ->
-	    R1 = file:write(File, Cookie),
-	    ok = file:close(File),
-	    R2 = file:raw_write_file_info(Name, make_info(Name)),
-	    case {R1, R2} of
-		{ok, ok} ->
-		    ok;
-		{{error,Reason}, _} ->
-		    {error,
-		     lists:flatten(
-		       io_lib:format("Failed to write to cookie file '~ts': ~p", [Name, Reason]))};
-		{ok, {error, Reason}} ->
-		    {error, "Failed to change mode: " ++ atom_to_list(Reason)}
-	    end;
-	{error,Reason} ->
-	    {error,
-	     lists:flatten(
-	       io_lib:format("Failed to create cookie file '~ts': ~p", [Name, Reason]))}
+        {ok, File} ->
+            R1 = file:write(File, Cookie),
+            ok = file:close(File),
+            R2 = file:raw_write_file_info(Name, make_info(Name)),
+            case {R1, R2} of
+                {ok, ok} ->
+                    ok;
+                {{error,Reason}, _} ->
+                    {error,
+                     lists:flatten(
+                       io_lib:format("Failed to write to cookie file '~ts': ~p", [Name, Reason]))};
+                {ok, {error, Reason}} ->
+                    {error, "Failed to change mode: " ++ atom_to_list(Reason)}
+            end;
+        {error,Reason} ->
+            {error,
+             lists:flatten(
+               io_lib:format("Failed to create cookie file '~ts': ~p", [Name, Reason]))}
     end.
 
 random_cookie(0, _, Result) ->
diff --git a/lib/kernel/test/erl_distribution_SUITE.erl b/lib/kernel/test/erl_distribution_SUITE.erl
index 859369a916..fbfe47e2da 100644
--- a/lib/kernel/test/erl_distribution_SUITE.erl
+++ b/lib/kernel/test/erl_distribution_SUITE.erl
@@ -21,6 +21,8 @@
 
 -include_lib("common_test/include/ct.hrl").
 -include_lib("kernel/include/dist.hrl").
+-include_lib("stdlib/include/assert.hrl").
+-include_lib("kernel/include/file.hrl").
 
 -export([all/0, suite/0,groups/0,init_per_suite/1, end_per_suite/1, 
 	 init_per_group/2,end_per_group/2]).
@@ -51,7 +53,8 @@
          erl_uds_dist_smoke_test/1,
          erl_1424/1, differing_cookies/1,
          cmdline_setcookie_2/1, connection_cookie/1,
-         dyn_differing_cookies/1]).
+         dyn_differing_cookies/1,
+         xdg_cookie/1]).
 
 %% Performs the test at another node.
 -export([get_socket_priorities/0,
@@ -116,7 +119,8 @@ groups() ->
       [differing_cookies,
        cmdline_setcookie_2,
        connection_cookie,
-       dyn_differing_cookies]}].
+       dyn_differing_cookies,
+       xdg_cookie]}].
 
 init_per_suite(Config) ->
     start_gen_tcp_dist_test_type_server(),
@@ -2304,6 +2308,56 @@ dyn_differing_cookies(MotherNode, _Args) ->
             error({unexpected, Other})
     end.
 
+xdg_cookie(Config) when is_list(Config) ->
+    PrivDir = proplists:get_value(priv_dir, Config),
+
+    TestHome = filename:join(PrivDir, ?FUNCTION_NAME),
+    ok = file:make_dir(TestHome),
+
+    HomeEnv = case os:type() of
+              {win32, _} ->
+                  [Drive | Path] = filename:split(TestHome),
+                  [{"APPDATA", filename:join(TestHome,"AppData")},
+                   {"HOMEDRIVE", Drive}, {"HOMEPATH", Path}];
+              _ ->
+                  [{"HOME", TestHome}]
+          end,
+
+    NodeOpts = #{ env => HomeEnv ++
+                      [{"ERL_CRASH_DUMP", filename:join([TestHome,"erl_crash.dump"])}],
+                  connection => 0 },
+
+    %% Test that a default .erlang.cookie file is created
+    {ok, CreatorPeer, _} = peer:start_link(NodeOpts#{ name => peer:random_name(?FUNCTION_NAME) }),
+    UserConfig = peer:call(CreatorPeer, filename, basedir, [user_config,"erlang"]),
+    ?assert(peer:call(CreatorPeer, filelib, is_regular,
+                      [filename:join(TestHome, ".erlang.cookie")])),
+    OrigCookie = peer:call(CreatorPeer, erlang, get_cookie, []),
+    peer:stop(CreatorPeer),
+
+    %% Test that the $HOME/.erlang.cookie file takes precedence over XDG
+    XDGCookie = filename:join([UserConfig, ".erlang.cookie"]),
+    ok = filelib:ensure_dir(XDGCookie),
+    ok = file:write_file(XDGCookie, "Me want cookie!"),
+    {ok, XDGFI} = file:read_file_info(XDGCookie),
+    ok = file:write_file_info(XDGCookie, XDGFI#file_info{ mode = 8#600 }),
+
+    {ok, Peer, _} = peer:start_link(NodeOpts#{ name => peer:random_name(?FUNCTION_NAME) }),
+
+    ?assertEqual(OrigCookie, peer:call(Peer, erlang, get_cookie, [])),
+
+    peer:stop(Peer),
+
+    %% Check that XDG cookie works after we delete the $HOME cookie
+    ok = file:delete(filename:join(TestHome, ".erlang.cookie")),
+    {ok, Peer2, _} = peer:start_link(NodeOpts#{ name => peer:random_name(?FUNCTION_NAME) }),
+    ?assertEqual('Me want cookie!', peer:call(Peer2, erlang, get_cookie, [])),
+
+    peer:stop(Peer2),
+
+    ok.
+
+
 
 %% Misc. functions
 
diff --git a/lib/observer/src/observer_wx.erl b/lib/observer/src/observer_wx.erl
index 07e2fb1b29..eb7d802876 100644
--- a/lib/observer/src/observer_wx.erl
+++ b/lib/observer/src/observer_wx.erl
@@ -29,6 +29,7 @@
 
 %% Includes
 -include_lib("wx/include/wx.hrl").
+-include_lib("kernel/include/file.hrl").
 
 -include("observer_defs.hrl").
 
@@ -658,14 +659,16 @@ create_connect_dialog(connect, #state{frame = Frame}) ->
     wxWindow:setSizerAndFit(Dialog, VSizer),
     wxSizer:setSizeHints(VSizer, Dialog),
     {ok,[[HomeDir]]} = init:get_argument(home),
-    CookiePath = filename:join(HomeDir, ".erlang.cookie"),
-    DefaultCookie = case filelib:is_file(CookiePath) of
-			true ->
-			    {ok, Bin} = file:read_file(CookiePath),
-			    binary_to_list(Bin);
-			false ->
-			    ""
-		    end,
+    XDGHome = filename:basedir(user_config,"erlang"),
+    DefaultCookie =
+        case file:path_open([HomeDir,XDGHome], ".erlang.cookie", read) of
+            {ok, File, _} ->
+                {ok, #file_info{ size = Sz }} = file:read_file_info(File),
+                {ok, Data} = file:read(File, Sz),
+                Data;
+            _ ->
+                ""
+        end,
     wxTextCtrl:setValue(CookieCtrl, DefaultCookie),
     case wxDialog:showModal(Dialog) of
 	?wxID_OK ->
diff --git a/lib/stdlib/doc/src/filename.xml b/lib/stdlib/doc/src/filename.xml
index 168be3a4dd..a933ab4ed6 100644
--- a/lib/stdlib/doc/src/filename.xml
+++ b/lib/stdlib/doc/src/filename.xml
@@ -188,7 +188,7 @@ basedir(<anno>PathsType</anno>, <anno>Application</anno>, #{})</seeerl>.
               The options <c>'author'</c> and <c>'version'</c> are only used with <c>'windows'</c> option mode.
           </p>
         <list type="bulleted">
-            <item><c>user_cache</c>
+            <item><marker id="user_cache"/><c>user_cache</c>
                 <p>The path location is intended for transient data files on a local machine.</p>
                 <p>
                     On Linux:
@@ -212,7 +212,7 @@ basedir(<anno>PathsType</anno>, <anno>Application</anno>, #{})</seeerl>.
 5> <input>filename:basedir(user_cache, "My App", #{author=>"Erlang",version=>"1.2"}).</input>
 "c:/Users/otptest/AppData/Local/Erlang/My App/1.2/Cache"</pre>
             </item>
-            <item><c>user_config</c>
+            <item><marker id="user_config"/><c>user_config</c>
                 <p>
                     The path location is intended for persistent configuration files.
                 </p>
@@ -232,7 +232,7 @@ basedir(<anno>PathsType</anno>, <anno>Application</anno>, #{})</seeerl>.
 2> <input>filename:basedir(user_config, "My App", #{author=>"Erlang", version=>"1.2"}).</input>
 "c:/Users/otptest/AppData/Roaming/Erlang/My App/1.2"</pre>
             </item>
-            <item><c>user_data</c>
+            <item><marker id="user_data"/><c>user_data</c>
                 <p>
                     The path location is intended for persistent data files.
                 </p>
@@ -252,7 +252,7 @@ basedir(<anno>PathsType</anno>, <anno>Application</anno>, #{})</seeerl>.
 9> <input>filename:basedir(user_data, "My App",#{author=>"Erlang",version=>"1.2"}).</input>
 "c:/Users/otptest/AppData/Local/Erlang/My App/1.2"</pre>
             </item>
-            <item><c>user_log</c>
+            <item><marker id="user_log"/><c>user_log</c>
                 <p>The path location is intended for transient log files on a local machine.</p>
                 <p>
                 On Linux:
@@ -269,7 +269,7 @@ basedir(<anno>PathsType</anno>, <anno>Application</anno>, #{})</seeerl>.
 13> <input>filename:basedir(user_log, "My App",#{author=>"Erlang",version=>"1.2"}).</input>
 "c:/Users/otptest/AppData/Local/Erlang/My App/1.2/Logs"</pre>
             </item>
-            <item><c>site_config</c><p>
+            <item><marker id="site_config"/><c>site_config</c><p>
                 On Linux:
                 Respects the os environment variable <c>XDG_CONFIG_DIRS</c>.</p>
 <pre>
@@ -290,7 +290,7 @@ true
 5> <input>filename:basedir(site_config, "my_application", #{os=>darwin}).</input>
 ["/Library/Application Support/my_application"]</pre>
             </item>
-            <item><c>site_data</c><p>
+            <item><marker id="site_data"/><c>site_data</c><p>
                     On Linux:
                     Respects the os environment variable <c>XDG_DATA_DIRS</c>.</p>
                 <pre>
diff --git a/system/doc/reference_manual/distributed.xml b/system/doc/reference_manual/distributed.xml
index c90da696e4..df0c64f9ec 100644
--- a/system/doc/reference_manual/distributed.xml
+++ b/system/doc/reference_manual/distributed.xml
@@ -180,9 +180,14 @@ dilbert@uab</pre>
     <p>At start-up, a node has a random atom assigned as its default
       magic cookie and the cookie of other nodes is assumed to be
       <c>nocookie</c>. The first action of the Erlang network
-      authentication server (<c>auth</c>) is then to read a file named
-      <c>$HOME/.erlang.cookie</c>. If the file does not exist, it is
-      created. The UNIX permissions mode of the file is set to octal
+      authentication server (<c>auth</c>) is then to search for a file named
+      <c>.erlang.cookie</c> in the <seeerl marker="erts:init#home">
+      user&apos;s home directory</seeerl> and then in
+      <seeerl marker="stdlib:filename#user_config">
+        <c>filename:basedir(user_config, "erlang")</c></seeerl>.
+      If none of the files exist, a <c>.erlang.cooke</c> file is created
+      in the user&apos;s home directory.
+      The UNIX permissions mode of the file is set to octal
       400 (read-only by user) and its content is a random string. An
       atom <c>Cookie</c> is created from the contents of the file and
       the cookie of the local node is set to this using
-- 
2.31.1

Places

File 1671-kernel-Search-XDG_CONFIG_HOME-for-erlang-cookie.patch of Package erlang (Revision 0e04b8d79a55adf8ba49c177393a4846)

Places