File 0999-ssl-extend-pem-cache-tests.patch of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 0999-ssl-extend-pem-cache-tests.patch of Package erlang

From cf83bb7166af2932f7fce68a45b8c9861aa122d7 Mon Sep 17 00:00:00 2001
From: Jakub Witczak <kuba@erlang.org>
Date: Mon, 27 Jun 2022 12:39:11 +0200
Subject: [PATCH] ssl: extend pem cache tests

---
 lib/ssl/test/ssl_pem_cache_SUITE.erl | 738 +++++++++++++++++++++------
 1 file changed, 579 insertions(+), 159 deletions(-)

diff --git a/lib/ssl/test/ssl_pem_cache_SUITE.erl b/lib/ssl/test/ssl_pem_cache_SUITE.erl
index ed74917d63..9133bd65ce 100644
--- a/lib/ssl/test/ssl_pem_cache_SUITE.erl
+++ b/lib/ssl/test/ssl_pem_cache_SUITE.erl
@@ -39,40 +39,62 @@
          end_per_testcase/2]).
 
 %% Testcases
--export([pem_cleanup/0,
-         pem_cleanup/1,
-         clear_pem_cache/0,
-         clear_pem_cache/1,
+-export([pem_certfile_keyfile_periodical_cleanup/0,
+         pem_certfile_keyfile_periodical_cleanup/1,
+         pem_cacertfile_periodical_cleanup/0,
+         pem_cacertfile_periodical_cleanup/1,
+         pem_manual_cleanup/0,
+         pem_manual_cleanup/1,
          invalid_insert/0,
          invalid_insert/1,
-         new_root_pem/0,
-         new_root_pem/1,
+         new_root_pem_manual_cleanup/0,
+         new_root_pem_manual_cleanup/1,
+         new_root_pem_periodical_cleanup/0,
+         new_root_pem_periodical_cleanup/1,
+         new_root_pem_no_cleanup/0,
+         new_root_pem_no_cleanup/1,
+         new_root_pem_no_cleanup_symlink/0,
+         new_root_pem_no_cleanup_symlink/1,
+         new_root_pem_no_cleanup_hardlink/0,
+         new_root_pem_no_cleanup_hardlink/1,
+         alternative_path_hardlink/0,
+         alternative_path_hardlink/1,
+         alternative_path_symlink/0,
+         alternative_path_symlink/1,
+         alternative_path_noabspath/0,
+         alternative_path_noabspath/1,
          check_cert/3
         ]).
 
 
 -define(CLEANUP_INTERVAL, 5000).
+-define(SLEEP_AMOUNT, 1000).
 
 %%--------------------------------------------------------------------
 %% Common Test interface functions -----------------------------------
 %%--------------------------------------------------------------------
 all() ->
-    [
-     pem_cleanup, 
-     clear_pem_cache,
+    [pem_certfile_keyfile_periodical_cleanup,
+     pem_cacertfile_periodical_cleanup,
+     pem_manual_cleanup,
      invalid_insert,
-     new_root_pem
-    ].
+     new_root_pem_manual_cleanup,
+     new_root_pem_periodical_cleanup,
+     new_root_pem_no_cleanup,
+     new_root_pem_no_cleanup_symlink,
+     new_root_pem_no_cleanup_hardlink,
+     alternative_path_noabspath,
+     alternative_path_hardlink,
+     alternative_path_symlink].
 
-groups() ->
-    [].
+groups() -> [].
 
 init_per_suite(Config0) ->
     catch crypto:stop(),
     try crypto:start() of
 	ok ->
 	    ssl_test_lib:clean_start(),
-	    %% make rsa certs  
+	    %% make rsa certs
             ssl_test_lib:make_rsa_cert(Config0)
     catch _:_ ->
 	    {skip, "Crypto did not start"}
@@ -87,17 +109,26 @@ init_per_group(_GroupName, Config) ->
 end_per_group(_GroupName, Config) ->
     Config.
 
-init_per_testcase(pem_cleanup = Case, Config) ->
+init_per_testcase(pem_certfile_keyfile_periodical_cleanup = Case, Config) ->
+    adjust_pem_periodical_cleanup_interval(Case, Config),
+    Config;
+init_per_testcase(pem_cacertfile_periodical_cleanup = Case, Config) ->
+    adjust_pem_periodical_cleanup_interval(Case, Config),
+    Config;
+init_per_testcase(new_root_pem_periodical_cleanup = Case, Config) ->
+    adjust_pem_periodical_cleanup_interval(Case, Config),
+    Config;
+init_per_testcase(_Case, Config) ->
+    ssl_test_lib:clean_start(),
+    ct:timetrap({seconds, 20}),
+    Config.
+
+adjust_pem_periodical_cleanup_interval(Case, Config)->
     application:load(ssl),
     end_per_testcase(Case, Config) ,
     application:set_env(ssl, ssl_pem_cache_clean, ?CLEANUP_INTERVAL),
     ssl:start(),
-    ct:timetrap({minutes, 1}),
-    Config;
-init_per_testcase(_, Config) ->
-    ssl_test_lib:clean_start(),
-    ct:timetrap({seconds, 10}),
-    Config.
+    ct:timetrap({minutes, 1}).
 
 end_per_testcase(_TestCase, Config) ->
     ssl_test_lib:clean_env(),
@@ -107,77 +138,79 @@ end_per_testcase(_TestCase, Config) ->
 %%--------------------------------------------------------------------
 %% Test Cases --------------------------------------------------------
 %%--------------------------------------------------------------------
-pem_cleanup() ->
-    [{doc, "Test pem cache invalidate mechanism"}].
-pem_cleanup(Config)when is_list(Config) ->
-    process_flag(trap_exit, true),
-    ClientOpts = proplists:get_value(client_rsa_verify_opts, Config),
-    ServerOpts = proplists:get_value(server_rsa_verify_opts, Config),
-    {ClientNode, ServerNode, Hostname} = ssl_test_lib:run_where(Config),
-
-    Server =
-	ssl_test_lib:start_server([{node, ServerNode}, {port, 0},
-				   {from, self()},
-				   {mfa, {ssl_test_lib, no_result, []}},
-				   {options, ServerOpts}]),
-    Port = ssl_test_lib:inet_port(Server),
-    Client =
-	ssl_test_lib:start_client([{node, ClientNode},
-		      {port, Port}, {host, Hostname},
-				   {mfa, {ssl_test_lib, no_result, []}},
-				   {from, self()}, {options, ClientOpts}]),
+pem_certfile_keyfile_periodical_cleanup() ->
+    [{doc, "Test pem cache invalidate mechanism using mtime attribute "
+      "adjustment - certfile and keyfile."}].
+pem_certfile_keyfile_periodical_cleanup(Config) when is_list(Config) ->
+    Expected = #{init => [0, 0, 0, 0], connected => [6, 6, 2, 2],
+                cleaned => [4, 6, 2, 2], disconnected => [4, 0, 0, 0]},
+    pem_periodical_cleanup(Config, [certfile, keyfile], Expected),
+    ok.
 
-    Size = ssl_pkix_db:db_size(get_pem_cache()),
-    Certfile = proplists:get_value(certfile, ServerOpts),
-    {ok, FileInfo} = file:read_file_info(Certfile),
-    Time = later(), 
-    ok = file:write_file_info(Certfile, FileInfo#file_info{mtime = Time}),
-    ct:sleep(2 * ?CLEANUP_INTERVAL),
-    Size1 = ssl_pkix_db:db_size(get_pem_cache()),
-    ssl_test_lib:close(Server),
-    ssl_test_lib:close(Client),
-    false = Size == Size1.
+pem_cacertfile_periodical_cleanup() ->
+    [{doc, "Test pem cache invalidate mechanism using mtime attribute "
+      "adjustment - cacertfile."}].
+pem_cacertfile_periodical_cleanup(Config) when is_list(Config) ->
+    Expected = #{init => [0, 0, 0, 0], connected => [6, 6, 2, 2],
+                 cleaned => [5, 6, 2, 2], disconnected => [5, 0, 0, 0]},
+    pem_periodical_cleanup(Config, [cacertfile], Expected),
+    ok.
 
-clear_pem_cache() ->
+pem_manual_cleanup() ->
     [{doc,"Test that internal reference table is cleaned properly even when "
-     " the PEM cache is cleared" }].
-clear_pem_cache(Config) when is_list(Config) -> 
-    {status, _, _, StatusInfo} = sys:get_status(whereis(ssl_manager)),
-    [_, _,_, _, Prop] = StatusInfo,
-    State = ssl_test_lib:state(Prop),
-    [_,{FilRefDb, _} |_] = element(5, State),
+      " the PEM cache is cleared" }].
+pem_manual_cleanup(Config) when is_list(Config) ->
+    [0, 0, 0, 0] = get_table_sizes(),
     {Server, Client} = basic_verify_test_no_close(Config),
-    CountReferencedFiles = fun({_, -1}, Acc) ->
-				   Acc;
-			      ({_, N}, Acc) ->
-				   N + Acc
-			   end,
-    
-    2 = ets:foldl(CountReferencedFiles, 0, FilRefDb), 
+    2 = get_total_counter(),
+    [6, 6, 2, 2] = get_table_sizes(),
+    [{pem_cache, PemCacheData0}, {cert, CertData0}, {ca_ref_cnt, CaRefCntData0},
+     {ca_file_ref, CaFileRefData0}] = get_tables(),
+
     ssl:clear_pem_cache(),
     _ = sys:get_status(whereis(ssl_manager)),
+    [0, 6, 2, 2] = get_table_sizes(),
+    [{pem_cache, PemCacheData1}, {cert, CertData0}, {ca_ref_cnt, CaRefCntData0},
+     {ca_file_ref, CaFileRefData0}] = get_tables(),
+    [true = lists:member(Row, PemCacheData0) || Row <- PemCacheData1],
+
     {Server1, Client1} = basic_verify_test_no_close(Config),
-    4 =  ets:foldl(CountReferencedFiles, 0, FilRefDb), 
-    ssl_test_lib:close(Server),
-    ssl_test_lib:close(Client),
-    ct:sleep(2000),
+    4 = get_total_counter(),
+    [4, 6, 2, 2] = get_table_sizes(),
+    [{pem_cache, PemCacheData2}, {cert, CertData0}, {ca_ref_cnt, _CaRefCntData1},
+     {ca_file_ref, CaFileRefData0}] = get_tables(),
+    [true = lists:member(Row, PemCacheData0) || Row <- PemCacheData2],
+
+    [ssl_test_lib:close(A) || A <- [Server, Client]],
+    ct:sleep(2 * ?SLEEP_AMOUNT),
+
     _ = sys:get_status(whereis(ssl_manager)),
-    2 =  ets:foldl(CountReferencedFiles, 0, FilRefDb), 
-    ssl_test_lib:close(Server1),
-    ssl_test_lib:close(Client1),
-    ct:sleep(2000),
+    2 = get_total_counter(),
+
+    [4, 6, 2, 2] = get_table_sizes(),
+    [{pem_cache, PemCacheData2}, {cert, CertData0}, {ca_ref_cnt, CaRefCntData0},
+     {ca_file_ref, CaFileRefData0}] = get_tables(),
+
+    [ssl_test_lib:close(A) || A <- [Server1, Client1]],
+    ct:sleep(2 * ?SLEEP_AMOUNT),
+
     _ = sys:get_status(whereis(ssl_manager)),
-    0 =  ets:foldl(CountReferencedFiles, 0, FilRefDb).
+    0 = get_total_counter(),
+    [4, 0, 0, 0] = get_table_sizes(),
+    [{pem_cache, PemCacheData2}, {cert, []}, {ca_ref_cnt, []},
+     {ca_file_ref, []}] = get_tables(),
+    ok.
 
 invalid_insert() ->
     [{doc, "Test that insert of invalid pem does not cause empty cache entry"}].
-invalid_insert(Config)when is_list(Config) ->      
+invalid_insert(Config) when is_list(Config) ->
     process_flag(trap_exit, true),
-    
+    [0, 0, 0, 0] = get_table_sizes(),
     ClientOpts = proplists:get_value(client_rsa_verify_opts, Config),
     ServerOpts = proplists:get_value(server_rsa_verify_opts, Config),
     {ClientNode, ServerNode, Hostname} = ssl_test_lib:run_where(Config),
-    BadClientOpts = [{cacertfile, "tmp/does_not_exist.pem"} | proplists:delete(cacertfile, ClientOpts)],
+    BadClientOpts = [{cacertfile, "tmp/does_not_exist.pem"} |
+                     proplists:delete(cacertfile, ClientOpts)],
     Server =
 	ssl_test_lib:start_server([{node, ServerNode}, {port, 0},
 				   {from, self()},
@@ -187,37 +220,346 @@ invalid_insert(Config)when is_list(Config) ->
     ssl_test_lib:start_client_error([{node, ClientNode},
                                {port, Port}, {host, Hostname},
                                {from, self()}, {options, BadClientOpts}]),
+    [3, 0, 0, 0] = get_table_sizes(),
     ssl_test_lib:close(Server),
-    1 = ssl_pkix_db:db_size(get_fileref_db()).
+    ct:sleep(?SLEEP_AMOUNT),
+    [3, 0, 0, 0] = get_table_sizes().
+
+new_root_pem_manual_cleanup() ->
+    [{doc, "Test that changed PEM-files on disk followed by ssl:clear_pem_cache()"
+      " invalidates trusted CA cache as well as ordinary PEM cache. "
+      "This test case recreates a PEM file, resulting with its actual content change."}].
+new_root_pem_manual_cleanup(Config) when is_list(Config) ->
+    Expected = #{init => [0, 0, 0, 0], connected1 => [6, 6, 2, 2],
+                 cleaned => [0, 6, 2, 2], connected2 => [4, 6, 2, 2],
+                 disconnected1 => [4, 6, 2, 2], disconnected2 => [4,0,0,0]},
+    new_root_pem_helper(Config, manual, Expected, direct).
+
+new_root_pem_periodical_cleanup() ->
+    [{doc, "Test that changed PEM-files on disk followed by periodical cleanup"
+      " invalidates trusted CA cache as well as ordinary PEM cache. "
+      "This test case recreates a PEM file, resulting with its actual content change."}].
+new_root_pem_periodical_cleanup(Config) when is_list(Config) ->
+    ExpectedStats = #{init => [0, 0, 0, 0], connected1 => [6, 6, 2, 2],
+                      cleaned => [0, 6, 2, 2], connected2 => [4, 6, 2, 2],
+                      disconnected1 => [4, 6, 2, 2], disconnected2 => [4,0,0,0]},
+    new_root_pem_helper(Config, periodical, ExpectedStats, direct).
+
+new_root_pem_no_cleanup() ->
+    [{doc, "Test that changed PEM-files on disk not followed by any cleanup"
+      " will be used for making connection. "
+      "This test case recreates a PEM file, resulting with its actual content change."}].
+new_root_pem_no_cleanup(Config) when is_list(Config) ->
+    ExpectedStats = #{init => [0, 0, 0, 0], connected1 => [6, 6, 2, 2],
+                      cleaned => [6, 6, 2, 2], connected2 => [6, 6, 2, 2],
+                      disconnected1 => [6, 6, 2, 2], disconnected2 => [6,0,0,0]},
+    new_root_pem_helper(Config, no_cleanup, ExpectedStats, direct).
+
+new_root_pem_no_cleanup_symlink() ->
+    [{doc, "Test that changed PEM-files on disk not followed by any cleanup"
+      " will be used for making connection - even with symlink. "
+      "This test case recreates a PEM file, resulting with its actual content change."}].
+new_root_pem_no_cleanup_symlink(Config) when is_list(Config) ->
+    ExpectedStats = #{init => [0, 0, 0, 0], connected1 => [6, 6, 2, 2],
+                      cleaned => [6, 6, 2, 2], connected2 => [6, 6, 2, 2],
+                      disconnected1 => [6, 6, 2, 2], disconnected2 => [6,0,0,0]},
+    new_root_pem_helper(Config, no_cleanup, ExpectedStats, symlink).
+
+new_root_pem_no_cleanup_hardlink() ->
+    [{doc, "Test that changed PEM-files on disk not followed by any cleanup"
+      " will be used for making connection - even with hardlink. "
+      "This test case recreates a PEM file, resulting with its actual content change."}].
+new_root_pem_no_cleanup_hardlink(Config) when is_list(Config) ->
+    ExpectedStats = #{init => [0, 0, 0, 0], connected1 => [6, 6, 2, 2],
+                      cleaned => [6, 6, 2, 2], connected2 => [6, 6, 2, 2],
+                      disconnected1 => [6, 6, 2, 2], disconnected2 => [6,0,0,0]},
+    new_root_pem_helper(Config, no_cleanup, ExpectedStats, hardlink).
+
+alternative_path_hardlink() ->
+    [{doc,"Test that internal reference table contains expected data for"
+      " absolute and hard link. "
+      "This test verifies handling of same file with an alternative reference."}].
+alternative_path_hardlink(Config) when is_list(Config) ->
+    Expected = #{init => [0, 0, 0, 0], connected1 => [6, 6, 2, 2],
+                 connected2 => [7, 9, 3, 3], connected3 => [8, 12, 4, 4],
+                 disconnected => [8, 0, 0, 0]},
+    alternative_path_helper(Config, fun make_hardlink/1, Expected).
+
+alternative_path_symlink() ->
+    [{doc,"Test that internal reference table contains expected data for"
+      " absolute and symbolic link. "
+      "This test verifies handling of same file with an alternative reference."}].
+alternative_path_symlink(Config) when is_list(Config) ->
+    Expected = #{init => [0, 0, 0, 0], connected1 => [6, 6, 2, 2],
+                 connected2 => [7, 9, 3, 3], connected3 => [8, 12, 4, 4],
+                 disconnected => [8, 0, 0, 0]},
+    alternative_path_helper(Config, fun make_symlink/1, Expected).
+
+alternative_path_noabspath() ->
+    [{doc,"Test that internal reference table contains expected data for"
+      " absolute and relative paths. "
+      "This test verifies handling of same file with an alternative reference."}].
+alternative_path_noabspath(Config) when is_list(Config) ->
+    Expected = #{init => [0, 0, 0, 0], connected1 => [6, 6, 2, 2],
+                 connected2 => [7, 9, 3, 3], connected3 => [7, 9, 3, 3],
+                 disconnected => [7, 0, 0, 0]},
+    alternative_path_helper(Config, fun strip_path/1, Expected).
 
+%%--------------------------------------------------------------------
+%% Internal functions
+%%--------------------------------------------------------------------
+%% |---------------|                   |------------------------|
+%% | PemCache      |                   | Cert                   |
+%% |---------------|0,1               *|------------------------|
+%% | FilePath (PK) |-------------------| {Ref, SN, Issuer} (PK) |
+%% | FileContent   |                   | Cert                   |
+%% |---------------|                   |------------------------|
+%%    |0,1     |0,1
+%%    |        +------------------------+
+%%    |0,1                              |0,1
+%% |-----------------|               |------------|
+%% | CaFileRef       |               | CaRefCnt   |
+%% |-----------------|               |------------|
+%% | CaCertFile (PK) |               | Ref (PK)   |
+%% | Ref (FK)        |               | Counter    |
+%% |-----------------|               |------------|
+get_table_sizes() ->
+    ct:sleep(?SLEEP_AMOUNT),
+    DbSizes = [{Label, Db, ssl_pkix_db:db_size(Db)} ||
+                {Label, Db} <- get_table_refs()],
+    [Size || {_, _, Size} <- DbSizes].
+
+get_total_counter() ->
+    CaFileRef = proplists:get_value(ca_ref_cnt, get_table_refs()),
+    CountReferencedFiles = fun({_, -1}, Acc) ->
+				   Acc;
+			      ({_, N}, Acc) ->
+				   N + Acc
+			   end,
+    ets:foldl(CountReferencedFiles, 0, CaFileRef).
 
-new_root_pem() ->
-    [{doc, "Test that changed PEM-files on disk followed by ssl:clear_pem_cache() invalidates"
-      "trusted CA cache as well as ordinary PEM cache"}].
-new_root_pem(Config)when is_list(Config) ->
-    PrivDir = proplists:get_value(priv_dir, Config),
-    #{cert := OrgSRoot} = SRoot = 
-        public_key:pkix_test_root_cert("OTP test server ROOT",  [{key, ssl_test_lib:hardcode_rsa_key(6)}]),
-    
-    DerConfig = public_key:pkix_test_data(#{server_chain => #{root => SRoot,
-                                                              intermediates => [[{key, ssl_test_lib:hardcode_rsa_key(5)}]],
-                                                              peer =>  [{key, ssl_test_lib:hardcode_rsa_key(4)}]},
-                                            client_chain => #{root => [{key, ssl_test_lib:hardcode_rsa_key(1)}],
-                                                              intermediates => [[{key, ssl_test_lib:hardcode_rsa_key(2)}]],
-                                                              peer =>  [{key, ssl_test_lib:hardcode_rsa_key(3)}]}}),
+get_table_refs() ->
+    _ = sys:get_status(whereis(ssl_manager)),
+    _ = sys:get_status(whereis(ssl_pem_cache)),
+    {status, _, _, StatusInfo} = sys:get_status(whereis(ssl_manager)),
+    [_, _,_, _, Prop] = StatusInfo,
+    State = ssl_test_lib:state(Prop),
+    case element(5, State) of
+        [Cert, {CaRefCnt, CaFileRef}, PemCache| _] ->
+            [{pem_cache, PemCache},
+             {cert, Cert},
+             {ca_ref_cnt, CaRefCnt},
+             {ca_file_ref, CaFileRef}];
+        _ ->
+            undefined
+    end.
 
-    ClientBase = filename:join(PrivDir, "client_test"),
-    SeverBase =  filename:join(PrivDir, "server_test"),
-    PemConfig = x509_test:gen_pem_config_files(DerConfig, ClientBase, SeverBase),
-    ClientConf = proplists:get_value(client_config, PemConfig),
-    ServerConf = proplists:get_value(server_config, PemConfig),
+get_tables() ->
+    [{Id, get_table(T, Id)} || {Id, T} <- get_table_refs()].
 
-    SCAFile =  proplists:get_value(cacertfile, ServerConf),
+get_table(TableRef, Id) ->
+    get_table(TableRef, Id, ets:first(TableRef), []).
 
-    {ClientNode, ServerNode, Hostname} = ssl_test_lib:run_where(Config),
+get_table(TableRef, Id, Key, Acc) ->
+    case Key of
+        '$end_of_table' ->
+            Acc;
+        _ ->
+            get_table(TableRef, Id, ets:next(TableRef, Key),
+                      [ets:lookup(TableRef, Key) | Acc])
+    end.
+
+new_root_pem_helper(Config, CleanMode,
+                   #{init := Init, connected1 := Connected1, cleaned := Cleaned,
+                    connected2 := Connected2, disconnected1 := Disconnected1,
+                    disconnected2 := Disconnected2} = _ExpectedStats, AccessMode) ->
+    %% ExpectedStats map passed to function contains expected sizes of tables
+    %% holding various cert, cacert, keyfile data.
+    %% Init - represents initial state
+    %% ConnectedN - state after establishing Nth connection
+    %% Cleaned - state after periodical cleanup
+    %% DisconnectedN - state after closing Nth connection
+    {SCAFile, ClientConf0, ServerConf, OrgSRoot, ClientBase, ServerBase} =
+        create_initial_config(Config),
+
+    TryLink =
+        fun(MakeLink, Conf0) ->
+                CACertfilePath = proplists:get_value(cacertfile, Conf0),
+                case MakeLink(CACertfilePath) of
+                    {ok, LinkPath} ->
+                         [{cacertfile, LinkPath} | proplists:delete(cacertfile, Conf0)];
+                    {skip, Reason} ->
+                        [{skip, Reason}]
+                end
+        end,
+    ClientConf = case AccessMode of
+                     direct -> ClientConf0;
+                     hardlink->
+                         TryLink(fun make_hardlink/1, ClientConf0);
+                     symlink->
+                         TryLink(fun make_symlink/1, ClientConf0)
+                 end,
+
+    case proplists:lookup(skip, ClientConf) of
+        none ->
+            {ClientNode, ServerNode, Hostname} = ssl_test_lib:run_where(Config),
+            Init = get_table_sizes(),
+            {Client0, Server0} =
+                make_connection_check_cert(OrgSRoot, ClientNode, ClientConf,
+                                           ServerNode, ServerConf, Hostname, SCAFile),
+            Connected1 = get_table_sizes(),
+            [{pem_cache, PemCacheData0}, {cert, CertData0}, {ca_ref_cnt, CaRefCntData0},
+             {ca_file_ref, CaFileRefData0}] = get_tables(),
+
+            NewCert = overwrite_files_with_new_configuration(OrgSRoot, ClientBase, ServerBase),
+            Connected1 = get_table_sizes(),
+            [{pem_cache, PemCacheData0}, {cert, CertData0}, {ca_ref_cnt, CaRefCntData0},
+             {ca_file_ref, CaFileRefData0}] = get_tables(),
+
+            case CleanMode of
+                manual -> ssl:clear_pem_cache();
+                periodical -> ct:sleep(round(1.5 * ?CLEANUP_INTERVAL));
+                no_cleanup -> ok
+            end,
+            Cleaned = get_table_sizes(),
+
+            [{pem_cache, PemCacheData1}, {cert, CertData1}, {ca_ref_cnt, CaRefCntData1},
+             {ca_file_ref, CaFileRefData1}] = get_tables(),
+            case CleanMode of
+                no_cleanup ->
+                    PemCacheData0 = PemCacheData1,
+                    CertData0 = CertData1,
+                    CaRefCntData0 = CaRefCntData1,
+                    CaFileRefData0 = CaFileRefData1;
+                _ ->
+                    CaRefCntData0 = CaRefCntData1,
+                    CaFileRefData0 = CaFileRefData1,
+                    false = (CertData1 == CertData0)
+            end,
+            {Client1, Server1} =
+                make_connection_check_cert(NewCert, ClientNode, ClientConf,
+                                           ServerNode, ServerConf, Hostname, SCAFile),
+            4 = get_total_counter(),
+            Connected2 = get_table_sizes(),
+            [{pem_cache, PemCacheData2}, {cert, CertData2}, {ca_ref_cnt, CaRefCntData2},
+             {ca_file_ref, CaFileRefData2}] = get_tables(),
+            case CleanMode of
+                no_cleanup ->
+                    PemCacheData0 = PemCacheData2,
+                    CertData0 = CertData2;
+                _ ->
+                    CaFileRefData0 = CaFileRefData2,
+                    false = (CertData0 == CertData2),
+                    true = (PemCacheData0 /= PemCacheData2)
+            end,
+            true = (CaRefCntData2 /= CaRefCntData1),
+
+            [ssl_test_lib:close(A) || A <- [Client1, Server1]],
+            2 = get_total_counter(),
+            Disconnected1 = get_table_sizes(),
+
+            [{pem_cache, PemCacheData3}, {cert, CertData3}, {ca_ref_cnt, CaRefCntData3},
+             {ca_file_ref, CaFileRefData3}] = get_tables(),
+            case CleanMode of
+                no_cleanup ->
+                    PemCacheData1 = PemCacheData3;
+                _ ->
+                    PemCacheData2 = PemCacheData3
+            end,
+            CertData1 = CertData3,
+            CaRefCntData0 = CaRefCntData3,
+            CaFileRefData0 = CaFileRefData3,
+
+            [ssl_test_lib:close(A) || A <- [Client0, Server0]],
+            0 = get_total_counter(),
+            Disconnected2 = get_table_sizes(),
+            [{pem_cache, PemCacheData4}, {cert, []}, {ca_ref_cnt, []},
+             {ca_file_ref, []}] = get_tables(),
+            case CleanMode of
+                no_cleanup ->
+                    PemCacheData1 = PemCacheData4;
+                _ ->
+                    PemCacheData2 = PemCacheData4
+            end,
+
+            ssl:clear_pem_cache(),
+            [0, 0, 0, 0] = get_table_sizes(),
+            ok;
+        {skip, Reason} ->
+            {skip, Reason}
+    end.
 
-    %% Start a connection and keep it up for a little while, so that 
-    %% it will be up when the second connection is started.
+alternative_path_helper(Config, GetAlternative,
+                  #{init := Init, connected1 := Connected1,
+                    connected2 := Connected2, connected3 := Connected3,
+                    disconnected := Disconnected}) ->
+    %% ExpectedStats map passed to function contains expected sizes of tables
+    %% holding various cert, cacert, keyfile data.
+    %% Init - represents initial state
+    %% ConnectedN - state after establishing Nth connection
+    %% Disconnected - state after closing connections
+    ClientOpts = proplists:get_value(client_rsa_verify_opts, Config),
+    CACertFilePath0 = proplists:get_value(cacertfile, ClientOpts),
+    {ok, CACertFilename} = strip_path(CACertFilePath0),
+    {ok, Cwd} = file:get_cwd(),
+
+    CACertFilePath1 = filename:join([Cwd, CACertFilename]),
+    {ok, _} = file:copy(CACertFilePath0, CACertFilePath1),
+    0 = get_total_counter(),
+    Init = get_table_sizes(),
+
+    %% connect with full path
+    {Server0, Client0} = basic_verify_test_no_close(
+                         replace_cacertfile(Config, CACertFilePath1)),
+    2 = get_total_counter(),
+    Connected1 = get_table_sizes(),
+
+    TestAlternative = fun(ExpectedTotalCounter, ExpectedSizes, CertPath) ->
+                              case GetAlternative(CertPath) of
+                                  {skip, _} = R ->
+                                      [{skip, R}];
+                                  {ok, Alternative} ->
+                                      %% connect with filename only
+                                      {Server, Client} = basic_verify_test_no_close(
+                                                           replace_cacertfile(Config, Alternative)),
+                                      ExpectedTotalCounter = get_total_counter(),
+                                      ExpectedSizes = get_table_sizes(),
+                                      [Server, Client]
+                              end
+                      end,
+
+    R1 = TestAlternative(4, Connected2, CACertFilePath1),
+
+    %% check that same filenames in different folders don't collide
+    SubDir = "subdir",
+    SubDirPath = filename:join([Cwd, SubDir]),
+    CACertFilePath2 = filename:join([SubDirPath, CACertFilename]),
+    case file:read_file_info(SubDirPath) of
+        {error, enoent} ->
+            ok = file:make_dir(SubDirPath);
+        _ ->
+            ok
+    end,
+    {ok, _} = file:copy(CACertFilePath0, CACertFilePath2),
+    ok = c:cd(SubDirPath),
+    R2 = TestAlternative(6, Connected3, CACertFilePath2),
+
+    ProcessesCreated = R1 ++ R2,
+    case proplists:lookup(skip, ProcessesCreated) of
+        none ->
+            [ssl_test_lib:close(Actor) || Actor <- [Server0, Client0] ++
+                                              ProcessesCreated],
+            ct:sleep(?SLEEP_AMOUNT),
+            _ = sys:get_status(whereis(ssl_manager)),
+            0 = get_total_counter(),
+            Disconnected = get_table_sizes(),
+            ok;
+        {skip, Reason} ->
+            {skip, Reason}
+    end.
+
+make_connection_check_cert(Cert, ClientNode, ClientConf, ServerNode, ServerConf,
+                          Hostname, SCAFile) ->
     Server =
 	ssl_test_lib:start_server([{node, ServerNode}, {port, 0},
 				   {from, self()},
@@ -227,12 +569,43 @@ new_root_pem(Config)when is_list(Config) ->
     Client =
 	ssl_test_lib:start_client([{node, ClientNode},
                                    {port, Port}, {host, Hostname},
-				   {mfa, {?MODULE, check_cert, [OrgSRoot, SCAFile]}},
-				   {from, self()}, {options, [{verify, verify_peer} |ClientConf]}]),
+				   {from, self()},
+				   {mfa, {?MODULE, check_cert, [Cert, SCAFile]}},
+                                   {options, [{verify, verify_peer} | ClientConf]}]),
 
     ssl_test_lib:check_result(Client, ok),
+    {Client, Server}.
 
-    %% Create new configuration
+create_initial_config(Config) ->
+    PrivDir = proplists:get_value(priv_dir, Config),
+    #{cert := OrgSRoot} = SRoot =
+        public_key:pkix_test_root_cert("OTP test server ROOT",
+                                       [{key, ssl_test_lib:hardcode_rsa_key(6)}]),
+
+    DerConfig = public_key:pkix_test_data(
+                  #{server_chain =>
+                        #{root => SRoot,
+                          intermediates =>
+                              [[{key, ssl_test_lib:hardcode_rsa_key(5)}]],
+                          peer =>
+                              [{key, ssl_test_lib:hardcode_rsa_key(4)}]},
+                    client_chain => #{root =>
+                                          [{key, ssl_test_lib:hardcode_rsa_key(1)}],
+                                      intermediates =>
+                                          [[{key, ssl_test_lib:hardcode_rsa_key(2)}]],
+                                      peer =>
+                                          [{key, ssl_test_lib:hardcode_rsa_key(3)}]}}),
+
+    ClientBase = filename:join(PrivDir, "client_test"),
+    ServerBase =  filename:join(PrivDir, "server_test"),
+    PemConfig = x509_test:gen_pem_config_files(DerConfig, ClientBase, ServerBase),
+    ClientConf = proplists:get_value(client_config, PemConfig),
+    ServerConf = proplists:get_value(server_config, PemConfig),
+
+    {proplists:get_value(cacertfile, ServerConf), ClientConf, ServerConf, OrgSRoot,
+    ClientBase, ServerBase}.
+
+overwrite_files_with_new_configuration(OrgSRoot, ClientBase, ServerBase) ->
     Key = ssl_test_lib:hardcode_rsa_key(1),
     OTPCert = public_key:pkix_decode_cert(OrgSRoot, otp),
     TBS = OTPCert#'OTPCertificate'.tbsCertificate,
@@ -243,70 +616,93 @@ new_root_pem(Config)when is_list(Config) ->
                                       subjectPublicKey = Public},
     NewCert = public_key:pkix_sign(TBS#'OTPTBSCertificate'{subjectPublicKeyInfo = SPKI}, Key),
 
-    DerConfig1 = public_key:pkix_test_data(#{server_chain =>
-                                                 #{root =>  #{cert => NewCert, key => Key},
-                                                   intermediates => [[{key, ssl_test_lib:hardcode_rsa_key(5)}]],
-                                                   peer => [{key, ssl_test_lib:hardcode_rsa_key(4)}]},
-                                             client_chain =>
-                                                 #{root => [{key, ssl_test_lib:hardcode_rsa_key(1)}],
-                                                   intermediates =>  [[{key, ssl_test_lib:hardcode_rsa_key(2)}]],
-                                                   peer => [{key, ssl_test_lib:hardcode_rsa_key(3)}]}}),
-
+    DerConfig1 = public_key:pkix_test_data(
+                   #{server_chain =>
+                         #{root =>
+                               #{cert => NewCert, key => Key},
+                           intermediates =>
+                               [[{key, ssl_test_lib:hardcode_rsa_key(5)}]],
+                           peer =>
+                               [{key, ssl_test_lib:hardcode_rsa_key(4)}]},
+                     client_chain =>
+                         #{root =>
+                               [{key, ssl_test_lib:hardcode_rsa_key(1)}],
+                           intermediates =>
+                               [[{key, ssl_test_lib:hardcode_rsa_key(2)}]],
+                           peer =>
+                               [{key, ssl_test_lib:hardcode_rsa_key(3)}]}}),
     %% Overwrite old config files
-    _ = x509_test:gen_pem_config_files(DerConfig1, ClientBase, SeverBase),
+    _ = x509_test:gen_pem_config_files(DerConfig1, ClientBase, ServerBase),
+    NewCert.
+
+pem_periodical_cleanup(Config, FileIds,
+            #{init := Init, connected := Connected,
+              cleaned := Cleaned, disconnected := Disconnected} = _ExpectedStats)->
+    %% ExpectedStats map passed to function contains expected sizes of tables
+    %% holding various cert, cacert, keyfile data.
+    %% Init - represents initial state
+    %% Connected - state after connection is established
+    %% Cleaned - state after periodical cleanup
+    %% Disconnected - state after disconnecting
+    process_flag(trap_exit, true),
+    %% wait so that certificate mtime is smaller the ssl_pem_cache start time
+    %% we want to avoid invalidation of all cert files - happens when server
+    %% start time and file mtime is the same number in seconds
+    %% and all files get invalidated
+    ct:sleep(4 * ?SLEEP_AMOUNT),
+    Init = get_table_sizes(),
 
-    %% Make sure cache is cleared 
-    ssl:clear_pem_cache(),
-    
-    Server1 =
+    ClientOpts = proplists:get_value(client_rsa_verify_opts, Config),
+    ServerOpts = proplists:get_value(server_rsa_verify_opts, Config),
+    {ClientNode, ServerNode, Hostname} = ssl_test_lib:run_where(Config),
+    Server =
 	ssl_test_lib:start_server([{node, ServerNode}, {port, 0},
 				   {from, self()},
 				   {mfa, {ssl_test_lib, no_result, []}},
-				   {options, ServerConf}]),
-    Port1 = ssl_test_lib:inet_port(Server1),
-
-    %% Start second connection
-    Client1 = ssl_test_lib:start_client([{node, ClientNode},
-                                         {port, Port1}, {host, Hostname},
-                                         {from, self()},
-                                         {mfa, {?MODULE, check_cert, [NewCert, SCAFile]}},
-                                         {options, [{verify, verify_peer} | ClientConf]}]),
-    ssl_test_lib:check_result(Client1, ok),
-    ssl_test_lib:close(Server),
-    ssl_test_lib:close(Server1),
-    ssl_test_lib:close(Client),
-    ssl_test_lib:close(Client1).
-    
-%%--------------------------------------------------------------------
-%% Internal funcations 
-%%--------------------------------------------------------------------
+				   {options, ServerOpts}]),
+    Port = ssl_test_lib:inet_port(Server),
+    Client =
+	ssl_test_lib:start_client([{node, ClientNode},
+                                   {port, Port}, {host, Hostname},
+				   {mfa, {ssl_test_lib, no_result, []}},
+				   {from, self()}, {options, ClientOpts}]),
 
-get_pem_cache() ->
-    {status, _, _, StatusInfo} = sys:get_status(whereis(ssl_manager)),
-    [_, _,_, _, Prop] = StatusInfo,
-    State = ssl_test_lib:state(Prop),
-    case element(5, State) of
-	[_CertDb, _FileRefDb, PemCache| _] ->
-	    PemCache;
-	_ ->
-	    undefined
-    end.
+    Connected = get_table_sizes(),
+    [{pem_cache, PemCacheData0}, {cert, CertData0}, {ca_ref_cnt, CaRefCntData0},
+     {ca_file_ref, CaFileRefData0}] = get_tables(),
+
+    MakeLookingYounger =
+        fun (Type) ->
+                %% make file looking like modified recently
+                Certfile = proplists:get_value(Type, ServerOpts),
+                {ok, #file_info{mtime = OriginalTime} = FileInfo} =
+                    file:read_file_info(Certfile),
+                Time = later(),
+                ok = file:write_file_info(Certfile, FileInfo#file_info{mtime = Time}),
+                {Certfile, FileInfo, OriginalTime}
+        end,
+
+    Memory = [MakeLookingYounger(F) || F <- FileIds],
+    ct:sleep(round(1.5 * ?CLEANUP_INTERVAL)),
+
+    Cleaned = get_table_sizes(),
+    [{pem_cache, PemCacheData1}, {cert, CertData0}, {ca_ref_cnt, CaRefCntData0},
+     {ca_file_ref, CaFileRefData0}] = get_tables(),
+    [true = lists:member(Row, PemCacheData0) || Row <- PemCacheData1],
+
+    [ssl_test_lib:close(A) || A <- [Server, Client]],
+    ct:sleep(?SLEEP_AMOUNT),
+
+    Disconnected = get_table_sizes(),
+    %% restore original mtime attributes
+    [ok = file:write_file_info(C, F#file_info{mtime = OT}) ||
+        {C, F, OT} <- Memory].
 
-get_fileref_db() ->
-    {status, _, _, StatusInfo} = sys:get_status(whereis(ssl_manager)),
-    [_, _,_, _, Prop] = StatusInfo,
-    State = ssl_test_lib:state(Prop),
-    case element(5, State) of
-	[_CertDb, {FileRefDb,_} | _] ->
-	    FileRefDb;
-	_ ->
-	    undefined
-    end.
 later()->
-    DateTime = calendar:now_to_local_time(os:timestamp()), 
+    DateTime = calendar:now_to_local_time(os:timestamp()),
     Gregorian = calendar:datetime_to_gregorian_seconds(DateTime),
     calendar:gregorian_seconds_to_datetime(Gregorian + (2 * ?CLEANUP_INTERVAL)).
-	
+
 basic_verify_test_no_close(Config) ->
     ClientOpts = ssl_test_lib:ssl_options(client_rsa_opts, Config),
     ServerOpts = ssl_test_lib:ssl_options(server_rsa_opts, Config),
@@ -323,14 +719,38 @@ basic_verify_test_no_close(Config) ->
 					{from, self()},
 					{mfa, {ssl_test_lib, send_recv_result_active, []}},
 					{options, ClientOpts}]),
-
     ssl_test_lib:check_result(Server, ok, Client, ok),
     {Server, Client}.
 
+replace_cacertfile(Config, CACertFile) ->
+    ClientOpts0 = ssl_test_lib:ssl_options(client_rsa_opts, Config),
+    ClientOpts = [{cacertfile, CACertFile} | proplists:delete(cacertfile, ClientOpts0)],
+    [{client_rsa_opts, ClientOpts} | proplists:delete(client_rsa_opts, Config)].
 
 check_cert(Socket, RootCert, File) ->
     {ok, Cert} = ssl:peercert(Socket),
     {ok, Extracted} = ssl_pkix_db:extract_trusted_certs(File),
-    {ok, RootCert, _} = ssl_certificate:certificate_chain(Cert, ets:new(foo, []), Extracted, [], encoded),
+    {ok, RootCert, _} = ssl_certificate:certificate_chain(Cert, ets:new(foo, []),
+                                                          Extracted, [], encoded),
     ok.
 
+strip_path(AbsPath) ->
+    {ok, lists:last(filename:split(AbsPath))}.
+
+make_hardlink(AbsPath) ->
+    LinkPath = AbsPath ++ "_hardlink",
+    case file:make_link(AbsPath, LinkPath) of
+        ok ->
+            {ok, LinkPath};
+        Reason ->
+            {skip, Reason}
+    end.
+
+make_symlink(AbsPath) ->
+    LinkPath = AbsPath ++ "_symlink",
+    case file:make_symlink(AbsPath, LinkPath) of
+        ok ->
+            {ok, LinkPath};
+        Reason ->
+            {skip, Reason}
+    end.
-- 
2.35.3

Places

File 0999-ssl-extend-pem-cache-tests.patch of Package erlang

Places