%%
%% %CopyrightBegin%
%%
%% Copyright Ericsson AB 2018-2018. All Rights Reserved.
%%
%% Licensed under the Apache License, Version 2.0 (the "License");
%% you may not use this file except in compliance with the License.
%% You may obtain a copy of the License at
%%
%%     http://www.apache.org/licenses/LICENSE-2.0
%%
%% Unless required by applicable law or agreed to in writing, software
%% distributed under the License is distributed on an "AS IS" BASIS,
%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
%% See the License for the specific language governing permissions and
%% limitations under the License.
%%
%% %CopyrightEnd%
%%

%%
-module(ssl_rfc_5869_SUITE).

%% Note: This directive should only be used in test suites.
-compile(export_all).

-include_lib("common_test/include/ct.hrl").

%%--------------------------------------------------------------------
%% Common Test interface functions -----------------------------------
%%--------------------------------------------------------------------
all() -> 
    [sha_256_basic,
     sha_256_long,
     sha_256_no_salt,
     sha_basic,
     sha_long,
     sha_no_salt,
     sha_default_salt
    ].

%%--------------------------------------------------------------------
init_per_suite(Config) ->
    catch crypto:stop(),
    try crypto:start() of
	ok ->
            Config
    catch _:_ ->
	    {skip, "Crypto did not start"}
    end.

end_per_suite(_Config) ->
    application:stop(crypto).

%%--------------------------------------------------------------------
init_per_testcase(_TestCase, Config) ->
    ct:timetrap({seconds, 5}),
    Config.

end_per_testcase(_TestCase, Config) ->
    Config.

%%--------------------------------------------------------------------
%% Test Cases --------------------------------------------------------
%%--------------------------------------------------------------------
  
sha_256_basic() ->
    [{doc, "Basic test case with SHA-256"}].
sha_256_basic(Config) when is_list(Config) ->
    %% Hash = SHA-256
    %% IKM  = 0x0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b (22 octets)
    %% salt = 0x000102030405060708090a0b0c (13 octets)
    %% info = 0xf0f1f2f3f4f5f6f7f8f9 (10 octets)
    %% L    = 42
    %% PRK  = 0x077709362c2e32df0ddc3f0dc47bba63
    %%        90b6c73bb50f9c3122ec844ad7c2b3e5 (32 octets)
    %% OKM  = 0x3cb25f25faacd57a90434f64d0362f2a
    %%        2d2d0a90cf1a5a4c5db02d56ecc4c5bf
    %%        34007208d5b887185865 (42 octets)
    IKM  = hexstr2bin("0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b"),
    Salt = hexstr2bin("000102030405060708090a0b0c"),
    Info = hexstr2bin("f0f1f2f3f4f5f6f7f8f9"),
    PRK  = hexstr2bin("077709362c2e32df0ddc3f0dc47bba63"
                      "90b6c73bb50f9c3122ec844ad7c2b3e5"),
    OKM  = hexstr2bin("3cb25f25faacd57a90434f64d0362f2a"
                      "2d2d0a90cf1a5a4c5db02d56ecc4c5bf"
                      "34007208d5b887185865"),
    hkdf_test(sha256, Salt, IKM, PRK, Info, 42, OKM).

sha_256_long() ->
    [{doc, "Test with SHA-256 and longer inputs/outputs"}].
sha_256_long(Config) when is_list(Config) ->
    %% Hash = SHA-256
    %% IKM  = 0x000102030405060708090a0b0c0d0e0f
    %%        101112131415161718191a1b1c1d1e1f
    %%        202122232425262728292a2b2c2d2e2f
    %%        303132333435363738393a3b3c3d3e3f
    %%        404142434445464748494a4b4c4d4e4f (80 octets)
    %% salt = 0x606162636465666768696a6b6c6d6e6f
    %%        707172737475767778797a7b7c7d7e7f
    %%        808182838485868788898a8b8c8d8e8f
    %%        909192939495969798999a9b9c9d9e9f
    %%        a0a1a2a3a4a5a6a7a8a9aaabacadaeaf (80 octets)
    %% info = 0xb0b1b2b3b4b5b6b7b8b9babbbcbdbebf
    %%        c0c1c2c3c4c5c6c7c8c9cacbcccdcecf
    %%        d0d1d2d3d4d5d6d7d8d9dadbdcdddedf
    %%        e0e1e2e3e4e5e6e7e8e9eaebecedeeef
    %%        f0f1f2f3f4f5f6f7f8f9fafbfcfdfeff (80 octets)
    %% L    = 82
    
    %% PRK  = 0x06a6b88c5853361a06104c9ceb35b45c
    %%        ef760014904671014a193f40c15fc244 (32 octets)
    %% OKM  = 0xb11e398dc80327a1c8e7f78c596a4934
    %%        4f012eda2d4efad8a050cc4c19afa97c
    %%        59045a99cac7827271cb41c65e590e09
    %%        da3275600c2f09b8367793a9aca3db71
    %%        cc30c58179ec3e87c14c01d5c1f3434f
    %%        1d87 (82 octets)
    IKM  = hexstr2bin("000102030405060708090a0b0c0d0e0f"
                      "101112131415161718191a1b1c1d1e1f"
                      "202122232425262728292a2b2c2d2e2f"
                      "303132333435363738393a3b3c3d3e3f"
                      "404142434445464748494a4b4c4d4e4f"
                     ),
    Salt = hexstr2bin("606162636465666768696a6b6c6d6e6f"
                      "707172737475767778797a7b7c7d7e7f"
                      "808182838485868788898a8b8c8d8e8f"
                      "909192939495969798999a9b9c9d9e9f"
                      "a0a1a2a3a4a5a6a7a8a9aaabacadaeaf"
                     ),
    Info = hexstr2bin("b0b1b2b3b4b5b6b7b8b9babbbcbdbebf"
                      "c0c1c2c3c4c5c6c7c8c9cacbcccdcecf"
                      "d0d1d2d3d4d5d6d7d8d9dadbdcdddedf"
                      "e0e1e2e3e4e5e6e7e8e9eaebecedeeef"
                      "f0f1f2f3f4f5f6f7f8f9fafbfcfdfeff"
                     ),
    PRK  = hexstr2bin("06a6b88c5853361a06104c9ceb35b45c"
                      "ef760014904671014a193f40c15fc244"),
    OKM  = hexstr2bin("b11e398dc80327a1c8e7f78c596a4934"
                      "4f012eda2d4efad8a050cc4c19afa97c"
                      "59045a99cac7827271cb41c65e590e09"
                      "da3275600c2f09b8367793a9aca3db71"
                      "cc30c58179ec3e87c14c01d5c1f3434f"
                      "1d87"
                     ),
    hkdf_test(sha256, Salt, IKM, PRK, Info, 82, OKM).
sha_256_no_salt() ->
    [{doc, "Test with SHA-256 and zero-length salt/info"}].
sha_256_no_salt(Config) when is_list(Config) ->
    %% Hash = SHA-256
    %% IKM  = 0x0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b (22 octets)
    %% salt = (0 octets)
    %% info = (0 octets)
    %% L    = 42
    
    %% PRK  = 0x19ef24a32c717b167f33a91d6f648bdf
    %%        96596776afdb6377ac434c1c293ccb04 (32 octets)
    %% OKM  = 0x8da4e775a563c18f715f802a063c5a31
    %%        b8a11f5c5ee1879ec3454e5f3c738d2d
    %%        9d201395faa4b61a96c8 (42 octets)
    IKM  = hexstr2bin("0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b"),
    Salt = <<>>,
    Info = <<>>,
    PRK  = hexstr2bin("19ef24a32c717b167f33a91d6f648bdf"
                      "96596776afdb6377ac434c1c293ccb04"),
    OKM  = hexstr2bin("8da4e775a563c18f715f802a063c5a31"
                      "b8a11f5c5ee1879ec3454e5f3c738d2d"
                      "9d201395faa4b61a96c8"),
    hkdf_test(sha256, Salt, IKM, PRK, Info, 42, OKM).

sha_basic() ->
    [{doc, " Basic test case with SHA-1"}].
sha_basic(Config) when is_list(Config) ->
    %% Hash = SHA-1
    %% IKM  = 0x0b0b0b0b0b0b0b0b0b0b0b (11 octets)
    %% salt = 0x000102030405060708090a0b0c (13 octets)
    %% info = 0xf0f1f2f3f4f5f6f7f8f9 (10 octets)
    %% L    = 42
    
    %% PRK  = 0x9b6c18c432a7bf8f0e71c8eb88f4b30baa2ba243 (20 octets)
    %% OKM  = 0x085a01ea1b10f36933068b56efa5ad81
    %%        a4f14b822f5b091568a9cdd4f155fda2
    %%        c22e422478d305f3f896 (42 octets)
    IKM  = hexstr2bin("0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b"),
    Salt = hexstr2bin("000102030405060708090a0b0c"),
    Info = hexstr2bin("f0f1f2f3f4f5f6f7f8f9"),
    PRK  = hexstr2bin("077709362c2e32df0ddc3f0dc47bba63"
                      "90b6c73bb50f9c3122ec844ad7c2b3e5"),
    OKM  = hexstr2bin("3cb25f25faacd57a90434f64d0362f2a"
                      "2d2d0a90cf1a5a4c5db02d56ecc4c5bf"
                      "34007208d5b887185865"),
    hkdf_test(sha256, Salt, IKM, PRK, Info, 42, OKM).

sha_long() ->
    [{doc, "Test with SHA-1 and longer inputs/outputs"}].
sha_long(Config) when is_list(Config) ->
    %% Hash = SHA-1
    %% IKM  = 0x000102030405060708090a0b0c0d0e0f
    %%        101112131415161718191a1b1c1d1e1f
    %%        202122232425262728292a2b2c2d2e2f
    %%        303132333435363738393a3b3c3d3e3f
    %%        404142434445464748494a4b4c4d4e4f (80 octets)
    %% salt = 0x606162636465666768696a6b6c6d6e6f
    %%        707172737475767778797a7b7c7d7e7f
    %%        808182838485868788898a8b8c8d8e8f
    %%        909192939495969798999a9b9c9d9e9f
    %%        a0a1a2a3a4a5a6a7a8a9aaabacadaeaf (80 octets)
    %% info = 0xb0b1b2b3b4b5b6b7b8b9babbbcbdbebf
    %%        c0c1c2c3c4c5c6c7c8c9cacbcccdcecf
    %%        d0d1d2d3d4d5d6d7d8d9dadbdcdddedf
    %%        e0e1e2e3e4e5e6e7e8e9eaebecedeeef
    %%        f0f1f2f3f4f5f6f7f8f9fafbfcfdfeff (80 octets)
    %% L    = 82
    
    %% PRK  = 0x8adae09a2a307059478d309b26c4115a224cfaf6 (20 octets)
    %% OKM  = 0x0bd770a74d1160f7c9f12cd5912a06eb
    %%        ff6adcae899d92191fe4305673ba2ffe
    %%        8fa3f1a4e5ad79f3f334b3b202b2173c
    %%        486ea37ce3d397ed034c7f9dfeb15c5e
    %%        927336d0441f4c4300e2cff0d0900b52
    %%        d3b4 (82 octets)
    IKM  = hexstr2bin("000102030405060708090a0b0c0d0e0f"
                      "101112131415161718191a1b1c1d1e1f"
                      "202122232425262728292a2b2c2d2e2f"
                      "303132333435363738393a3b3c3d3e3f"
                      "404142434445464748494a4b4c4d4e4f"
                     ),
    Salt = hexstr2bin("606162636465666768696a6b6c6d6e6f"
                      "707172737475767778797a7b7c7d7e7f"
                      "808182838485868788898a8b8c8d8e8f"
                      "909192939495969798999a9b9c9d9e9f"
                      "a0a1a2a3a4a5a6a7a8a9aaabacadaeaf"
                     ),
    Info = hexstr2bin("b0b1b2b3b4b5b6b7b8b9babbbcbdbebf"
                      "c0c1c2c3c4c5c6c7c8c9cacbcccdcecf"
                      "d0d1d2d3d4d5d6d7d8d9dadbdcdddedf"
                      "e0e1e2e3e4e5e6e7e8e9eaebecedeeef"
                      "f0f1f2f3f4f5f6f7f8f9fafbfcfdfeff"
                     ),
    PRK  = hexstr2bin("8adae09a2a307059478d309b26c4115a224cfaf6"),
    OKM  = hexstr2bin("0bd770a74d1160f7c9f12cd5912a06eb"
                      "ff6adcae899d92191fe4305673ba2ffe"
                      "8fa3f1a4e5ad79f3f334b3b202b2173c"
                      "486ea37ce3d397ed034c7f9dfeb15c5e"
                      "927336d0441f4c4300e2cff0d0900b52"
                      "d3b4"
                     ),
    hkdf_test(sha, Salt, IKM, PRK, Info, 82, OKM).

sha_no_salt() ->
    [{doc, "Test with SHA-1 and zero-length salt/info"}].
sha_no_salt(Config) when is_list(Config) ->
    %%   Hash = SHA-1
    %% IKM  = 0x0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b (22 octets)
    %% salt = (0 octets)
    %% info = (0 octets)
    %% L    = 42

    %% PRK  = 0xda8c8a73c7fa77288ec6f5e7c297786aa0d32d01 (20 octets)
    %% OKM  = 0x0ac1af7002b3d761d1e55298da9d0506
    %%        b9ae52057220a306e07b6b87e8df21d0
    %%        ea00033de03984d34918 (42 octets)
    IKM  = hexstr2bin("0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b"),
    Salt = <<>>,
    Info = <<>>,
    PRK  = hexstr2bin("da8c8a73c7fa77288ec6f5e7c297786aa0d32d01"),
    OKM  = hexstr2bin("0ac1af7002b3d761d1e55298da9d0506"
                      "b9ae52057220a306e07b6b87e8df21d0"
                      "ea00033de03984d34918"),
    hkdf_test(sha, Salt, IKM, PRK, Info, 42, OKM).


sha_default_salt() ->
    [{doc, "Test with SHA-1, salt not provided (defaults to HashLen zero octets),
   zero-length info"}].
sha_default_salt(Config) when is_list(Config) ->     
    %% Hash = SHA-1
    %% IKM  = 0x0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c (22 octets)
    %% salt = not provided (defaults to HashLen zero octets)
    %% info = (0 octets)
    %% L    = 42

    %% PRK  = 0x2adccada18779e7c2077ad2eb19d3f3e731385dd (20 octets)
    %% OKM  = 0x2c91117204d745f3500d636a62f64f0a
    %%        b3bae548aa53d423b0d1f27ebba6f5e5
    %%        673a081d70cce7acfc48 (42 octets)
    IKM  = hexstr2bin("0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c"),
    Salt = binary:copy(<<0>>, 20),
    Info = <<>>,
    PRK  = hexstr2bin("2adccada18779e7c2077ad2eb19d3f3e731385dd"),
    OKM  = hexstr2bin("2c91117204d745f3500d636a62f64f0a"
                      "b3bae548aa53d423b0d1f27ebba6f5e5"
                      "673a081d70cce7acfc48"),
    hkdf_test(sha, Salt, IKM, PRK, Info, 42, OKM).

hkdf_test(HashAlg, Salt, KeyingMaterial, PsedoRandKey, ContextInfo, Length, Key) ->   
    PsedoRandKey = tls_v1:hkdf_extract(HashAlg, Salt, KeyingMaterial),
    Key = tls_v1:hkdf_expand(PsedoRandKey, ContextInfo, Length, HashAlg).
    
hexstr2bin(S) when is_binary(S) ->
    list_to_binary(hexstr2list(binary_to_list(S)));
hexstr2bin(S) ->
    list_to_binary(hexstr2list(S)).

hexstr2list([$ |T]) ->
    hexstr2list(T);
hexstr2list([X,Y|T]) ->
    [mkint(X)*16 + mkint(Y) | hexstr2list(T)];
hexstr2list([]) ->
    [].
mkint(C) when $0 =< C, C =< $9 ->
    C - $0;
mkint(C) when $A =< C, C =< $F ->
    C - $A + 10;
mkint(C) when $a =< C, C =< $f ->
    C - $a + 10.