File 3904-ssh-Change-key-names.patch of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 3904-ssh-Change-key-names.patch of Package erlang (Revision d2a82c32ce0452ccd2b016fb84350e59)

Currently displaying revision d2a82c32ce0452ccd2b016fb84350e59 , Show latest

From 8810b5ec0329d30290a2b436fea646a5a348ad05 Mon Sep 17 00:00:00 2001
From: Hans Nilsson <hans@erlang.org>
Date: Fri, 30 Apr 2021 16:19:25 +0200
Subject: [PATCH 4/4] ssh: Change key names

---
 lib/ssh/doc/src/ssh_file.xml      | 24 ++++++++++---
 lib/ssh/src/ssh_file.erl          | 24 ++++++-------
 lib/ssh/test/ssh_pubkey_SUITE.erl | 60 +++++++++++++++----------------
 3 files changed, 62 insertions(+), 46 deletions(-)

diff --git a/lib/ssh/doc/src/ssh_file.xml b/lib/ssh/doc/src/ssh_file.xml
index 0858fd0359..ece3af90f5 100644
--- a/lib/ssh/doc/src/ssh_file.xml
+++ b/lib/ssh/doc/src/ssh_file.xml
@@ -350,8 +350,8 @@ key :: % encoded key from eg ssh_host_*.pub
 
 <func>
 <name since="OTP 24.0">decode(SshBin, ssh2_pubkey) -> Key</name>
- <name since="OTP 24.0">decode(SshBin, rfc4716_public_key) -> ResultRfc4716</name>
- <name since="OTP 24.0">decode(SshBin, openssh_public_key) -> ResultOpenSsh</name>
+ <name since="OTP 24.0">decode(SshBin, rfc4716_key) -> ResultRfc4716</name>
+ <name since="OTP 24.0">decode(SshBin, openssh_key) -> ResultOpenSsh</name>
 <name since="OTP 24.0">decode(SshBin, public_key) -> ResultRfc4716 | ResultOpenSsh</name>
 <fsummary>Decodes an SSH binary.</fsummary>
 <type>
@@ -366,13 +366,21 @@ key :: % encoded key from eg ssh_host_*.pub
 	Decodes an SSH file-binary.
 	If <c>Type</c> is <c>public_key</c> the binary can be either
 	an RFC4716 public key or an OpenSSH public key.
+	<note>
+	 The following key types have been renamed from the deprecated
+	 <seemfa marker="public_key:public_key#ssh_decode/2">public_key:ssh_decode/2</seemfa>:
+	 <list>
+	 <item>rfc4716_public_key -> rfc4716_key</item>
+	 <item>openssh_public_key -> openssh_key</item>
+	 </list>
+	</note>
 </desc>
 </func>
 
 <func>
 <name since="OTP 24.0">encode(Key, ssh2_pubkey) -> Result</name>
- <name since="OTP 24.0">encode(KeyAttrsRfc4716, rfc4716_public_key) -> Result</name>
- <name since="OTP 24.0">encode(KeyAttrsOpenSsh, openssh_public_key) -> Result</name>
+ <name since="OTP 24.0">encode(KeyAttrsRfc4716, rfc4716_key) -> Result</name>
+ <name since="OTP 24.0">encode(KeyAttrsOpenSsh, openssh_key) -> Result</name>
 <fsummary>Encodes a list of SSH file entries to a binary.</fsummary>
 <type>
 	<v>Key = <seetype marker="public_key:public_key#public_key">public_key:public_key()</seetype></v>
@@ -384,6 +392,14 @@ key :: % encoded key from eg ssh_host_*.pub
 </type>
 <desc>
 	Encodes a list of SSH file entries (public keys and attributes) to a binary.
+	<note>
+	 The following key types have been renamed from the deprecated
+	 <seemfa marker="public_key:public_key#ssh_encode/2">public_key:ssh_encode/2</seemfa>:
+	 <list>
+	 <item>rfc4716_public_key -> rfc4716_key</item>
+	 <item>openssh_public_key -> openssh_key</item>
+	 </list>
+	</note>
 </desc>
 </func>
 
diff --git a/lib/ssh/src/ssh_file.erl b/lib/ssh/src/ssh_file.erl
index 0fccbdd2fd..9381633faa 100644
--- a/lib/ssh/src/ssh_file.erl
+++ b/lib/ssh/src/ssh_file.erl
@@ -160,8 +160,8 @@ add_host_key(Hosts0, Port, Key, Opts) ->
 when SshBin :: binary(),
 Type :: ssh2_pubkey
 | public_key
- | openssh_public_key
- | rfc4716_public_key
+ | openssh_key
+ | rfc4716_key
 | openssh_key_v1 % Experimental
 | known_hosts
 | auth_keys,
@@ -175,10 +175,10 @@ decode(KeyBin, ssh2_pubkey) when is_binary(KeyBin) ->
 ssh_message:ssh2_pubkey_decode(KeyBin);
 
 decode(KeyBin, Type) when is_binary(KeyBin) andalso 
- (Type==rfc4716_public_key orelse
+ (Type==rfc4716_key orelse
 Type==openssh_key_v1 % Experimental
 ) ->
- %% Ex: <<"---- BEGIN SSH2 PUBLIC KEY ----\n....">> (rfc4716_public_key)
+ %% Ex: <<"---- BEGIN SSH2 PUBLIC KEY ----\n....">> (rfc4716_key)
 %% <<"-----BEGIN OPENSSH PRIVATE KEY-----\n....">> (openssh_key_v1)
 case ssh_file:decode_ssh_file(public, any, KeyBin, ignore) of
 {ok,Keys} ->
@@ -196,7 +196,7 @@ decode(KeyBin, Type) when is_binary(KeyBin) andalso
 {error,Error}
 end;
 
-decode(KeyBin0, openssh_public_key) when is_binary(KeyBin0) ->
+decode(KeyBin0, openssh_key) when is_binary(KeyBin0) ->
 %% Ex: <<"ssh-rsa AAAAB12....3BC someone@example.com">>
 try
 Lines = [L || L <- binary:split(KeyBin0, <<"\n">>, [global,trim_all]),
@@ -223,8 +223,8 @@ decode(KeyBin0, openssh_public_key) when is_binary(KeyBin0) ->
 decode(KeyBin, public_key) when is_binary(KeyBin) ->
 Type = case KeyBin of
 <<"-----BEGIN OPENSSH",_/binary>> -> openssh_key_v1;
- <<"----",_/binary>> -> rfc4716_public_key;
- _ -> openssh_public_key
+ <<"----",_/binary>> -> rfc4716_key;
+ _ -> openssh_key
 end,
 decode(KeyBin, Type);
 
@@ -239,8 +239,8 @@ decode(_KeyBin, _Type) ->
 %%%----------------------------------------------------------------
 -spec encode(InData, Type) -> binary() | {error,term()}
 when Type :: ssh2_pubkey
- | openssh_public_key
- | rfc4716_public_key
+ | openssh_key
+ | rfc4716_key
 | openssh_key_v1 % Experimental
 | known_hosts
 | auth_keys,
@@ -253,12 +253,12 @@ decode(_KeyBin, _Type) ->
 encode(Key, ssh2_pubkey) ->
 ssh_message:ssh2_pubkey_encode(Key);
 
-encode(KeyAttrs, Type) when Type==rfc4716_public_key ;
+encode(KeyAttrs, Type) when Type==rfc4716_key ;
 Type==openssh_key_v1 % Experimental
 ->
 {Begin, End, F} =
 case Type of
- rfc4716_public_key ->
+ rfc4716_key ->
 {"---- BEGIN SSH2 PUBLIC KEY ----\n",
 "---- END SSH2 PUBLIC KEY ----\n",
 fun ssh_message:ssh2_pubkey_encode/1};
@@ -279,7 +279,7 @@ encode(KeyAttrs, Type) when Type==rfc4716_public_key ;
 ]
 );
 
-encode(KeyAttrs, openssh_public_key) ->
+encode(KeyAttrs, openssh_key) ->
 iolist_to_binary(
 [begin
 <<?DEC_BIN(KeyType,__0),_/binary>> = Enc0 = ssh_message:ssh2_pubkey_encode(Key),
diff --git a/lib/ssh/test/ssh_pubkey_SUITE.erl b/lib/ssh/test/ssh_pubkey_SUITE.erl
index bb2e067323..aa3f6bc9b5 100644
--- a/lib/ssh/test/ssh_pubkey_SUITE.erl
+++ b/lib/ssh/test/ssh_pubkey_SUITE.erl
@@ -74,8 +74,8 @@
 ssh1_known_hosts/1,
 ssh_auth_keys/1,
 ssh1_auth_keys/1,
- ssh_openssh_public_key_with_comment/1,
- ssh_openssh_public_key_long_header/1,
+ ssh_openssh_key_with_comment/1,
+ ssh_openssh_key_long_header/1,
 
 ssh_hostkey_fingerprint_md5_implicit/1,
 ssh_hostkey_fingerprint_md5/1,
@@ -159,8 +159,8 @@ groups() ->
 ssh_rfc4716_rsa_subject,
 ssh_list_public_key,
 %% ssh_known_hosts, ssh_auth_keys, ssh1_known_hosts, ssh1_auth_keys,
- ssh_openssh_public_key_with_comment,
- ssh_openssh_public_key_long_header]}
+ ssh_openssh_key_with_comment,
+ ssh_openssh_key_long_header]}
 ].
 
 
@@ -476,17 +476,17 @@ ssh_rsa_public_key(Config) when is_list(Config) ->
 Datadir = proplists:get_value(pk_data_dir, Config),
 {ok, RSARawSsh2} = file:read_file(filename:join(Datadir, "ssh2_rsa_pub")),
 [{PubKey, Attributes1}] = ssh_file:decode(RSARawSsh2, public_key),
- [{PubKey, Attributes1}] = ssh_file:decode(RSARawSsh2, rfc4716_public_key),
+ [{PubKey, Attributes1}] = ssh_file:decode(RSARawSsh2, rfc4716_key),
 
 {ok, RSARawOpenSsh} = file:read_file(filename:join(Datadir, "openssh_rsa_pub")),
 [{PubKey, Attributes2}] = ssh_file:decode(RSARawOpenSsh, public_key),
- [{PubKey, Attributes2}] = ssh_file:decode(RSARawOpenSsh, openssh_public_key),
+ [{PubKey, Attributes2}] = ssh_file:decode(RSARawOpenSsh, openssh_key),
 
 %% Can not check EncodedSSh == RSARawSsh2 and EncodedOpenSsh
 %% = RSARawOpenSsh as line breakpoints may differ
 
- EncodedSSh = ssh_file:encode([{PubKey, Attributes1}], rfc4716_public_key),
- EncodedOpenSsh = ssh_file:encode([{PubKey, Attributes2}], openssh_public_key),
+ EncodedSSh = ssh_file:encode([{PubKey, Attributes1}], rfc4716_key),
+ EncodedOpenSsh = ssh_file:encode([{PubKey, Attributes2}], openssh_key),
 
 [{PubKey, Attributes1}] =
 	ssh_file:decode(EncodedSSh, public_key),
@@ -499,17 +499,17 @@ ssh_dsa_public_key(Config) when is_list(Config) ->
 
 {ok, DSARawSsh2} = file:read_file(filename:join(Datadir, "ssh2_dsa_pub")),
 [{PubKey, Attributes1}] = ssh_file:decode(DSARawSsh2, public_key),
- [{PubKey, Attributes1}] = ssh_file:decode(DSARawSsh2, rfc4716_public_key),
+ [{PubKey, Attributes1}] = ssh_file:decode(DSARawSsh2, rfc4716_key),
 
 {ok, DSARawOpenSsh} = file:read_file(filename:join(Datadir, "openssh_dsa_pub")),
 [{PubKey, Attributes2}] = ssh_file:decode(DSARawOpenSsh, public_key),
- [{PubKey, Attributes2}] = ssh_file:decode(DSARawOpenSsh, openssh_public_key),
+ [{PubKey, Attributes2}] = ssh_file:decode(DSARawOpenSsh, openssh_key),
 
 %% Can not check EncodedSSh == DSARawSsh2 and EncodedOpenSsh
 %% = DSARawOpenSsh as line breakpoints may differ
 
- EncodedSSh = ssh_file:encode([{PubKey, Attributes1}], rfc4716_public_key),
- EncodedOpenSsh = ssh_file:encode([{PubKey, Attributes2}], openssh_public_key),
+ EncodedSSh = ssh_file:encode([{PubKey, Attributes1}], rfc4716_key),
+ EncodedOpenSsh = ssh_file:encode([{PubKey, Attributes2}], openssh_key),
 
 [{PubKey, Attributes1}] =
 	ssh_file:decode(EncodedSSh, public_key),
@@ -522,17 +522,17 @@ ssh_ecdsa_public_key(Config) when is_list(Config) ->
 
 {ok, ECDSARawSsh2} = file:read_file(filename:join(Datadir, "ssh2_ecdsa_pub")),
 [{PubKey, Attributes1}] = ssh_file:decode(ECDSARawSsh2, public_key),
- [{PubKey, Attributes1}] = ssh_file:decode(ECDSARawSsh2, rfc4716_public_key),
+ [{PubKey, Attributes1}] = ssh_file:decode(ECDSARawSsh2, rfc4716_key),
 
 {ok, ECDSARawOpenSsh} = file:read_file(filename:join(Datadir, "openssh_ecdsa_pub")),
 [{PubKey, Attributes2}] = ssh_file:decode(ECDSARawOpenSsh, public_key),
- [{PubKey, Attributes2}] =ssh_file:decode(ECDSARawOpenSsh, openssh_public_key),
+ [{PubKey, Attributes2}] =ssh_file:decode(ECDSARawOpenSsh, openssh_key),
 
 %% Can not check EncodedSSh == ECDSARawSsh2 and EncodedOpenSsh
 %% = ECDSARawOpenSsh as line breakpoints may differ
 
- EncodedSSh = ssh_file:encode([{PubKey, Attributes1}], rfc4716_public_key),
- EncodedOpenSsh = ssh_file:encode([{PubKey, Attributes2}], openssh_public_key),
+ EncodedSSh = ssh_file:encode([{PubKey, Attributes1}], rfc4716_key),
+ EncodedOpenSsh = ssh_file:encode([{PubKey, Attributes2}], openssh_key),
 
 [{PubKey, Attributes1}] =
 	ssh_file:decode(EncodedSSh, public_key),
@@ -543,22 +543,22 @@ ssh_ecdsa_public_key(Config) when is_list(Config) ->
 ssh_list_public_key(Config) when is_list(Config) ->
 DataDir = proplists:get_value(pk_data_dir, Config),
 {Data_ssh2, Expect_ssh2} =
- collect_binaries_expected(DataDir, rfc4716_public_key,
+ collect_binaries_expected(DataDir, rfc4716_key,
 ["ssh2_rsa_pub", "ssh2_rsa_comment_pub",
 "ssh2_dsa_pub", "ssh2_dsa_comment_pub",
 "ssh2_ecdsa_pub", 
 "ssh2_subject_pub"]),
 {Data_openssh, Expect_openssh} =
- collect_binaries_expected(DataDir, openssh_public_key,
+ collect_binaries_expected(DataDir, openssh_key,
 ["openssh_rsa_pub", "openssh_dsa_pub", "openssh_ecdsa_pub"]),
 
 true =
- (chk_decode(Data_openssh, Expect_openssh, openssh_public_key) and
- chk_decode(Data_ssh2, Expect_ssh2, rfc4716_public_key) and
+ (chk_decode(Data_openssh, Expect_openssh, openssh_key) and
+ chk_decode(Data_ssh2, Expect_ssh2, rfc4716_key) and
 chk_decode(Data_openssh, Expect_openssh, public_key) and
 chk_decode(Data_ssh2, Expect_ssh2, public_key) and
- chk_encode(Expect_openssh, openssh_public_key) and
- chk_encode(Expect_ssh2, rfc4716_public_key)
+ chk_encode(Expect_openssh, openssh_key) and
+ chk_encode(Expect_ssh2, rfc4716_key)
 ).
 
 chk_encode(Data, Type) ->
@@ -623,7 +623,7 @@ ssh_rfc4716_rsa_comment(Config) when is_list(Config) ->
 
 Value = proplists:get_value("Comment", Headers, undefined),
 true = Value =/= undefined,
- RSARawSsh2 = ssh_file:encode([{PubKey, Attributes}], rfc4716_public_key).
+ RSARawSsh2 = ssh_file:encode([{PubKey, Attributes}], rfc4716_key).
 
 %%--------------------------------------------------------------------
 ssh_rfc4716_dsa_comment(Config) when is_list(Config) ->
@@ -639,7 +639,7 @@ ssh_rfc4716_dsa_comment(Config) when is_list(Config) ->
 true = Value =/= undefined,
 
 %% Can not check Encoded == DSARawSsh2 as line continuation breakpoints may differ
- Encoded = ssh_file:encode([{PubKey, Attributes}], rfc4716_public_key),
+ Encoded = ssh_file:encode([{PubKey, Attributes}], rfc4716_key),
 [{PubKey, Attributes}] =
 ssh_file:decode(Encoded, public_key).
 
@@ -657,7 +657,7 @@ ssh_rfc4716_rsa_subject(Config) when is_list(Config) ->
 true = Value =/= undefined,
 
 %% Can not check Encoded == RSARawSsh2 as line continuation breakpoints may differ
- Encoded = ssh_file:encode([{PubKey, Attributes}], rfc4716_public_key),
+ Encoded = ssh_file:encode([{PubKey, Attributes}], rfc4716_key),
 [{PubKey, Attributes}] =
 ssh_file:decode(Encoded, public_key).
 
@@ -756,21 +756,21 @@ ssh1_auth_keys(Config) when is_list(Config) ->
 Decoded = ssh_file:decode(Encoded, auth_keys).
 
 %%--------------------------------------------------------------------
-ssh_openssh_public_key_with_comment(Config) when is_list(Config) ->
+ssh_openssh_key_with_comment(Config) when is_list(Config) ->
 Datadir = proplists:get_value(pk_data_dir, Config),
 
 {ok, DSARawOpenSsh} = file:read_file(filename:join(Datadir, "openssh_dsa_with_comment_pub")),
- [{{_, #'Dss-Parms'{}}, _}] = ssh_file:decode(DSARawOpenSsh, openssh_public_key).
+ [{{_, #'Dss-Parms'{}}, _}] = ssh_file:decode(DSARawOpenSsh, openssh_key).
 
 %%--------------------------------------------------------------------
-ssh_openssh_public_key_long_header(Config) when is_list(Config) ->
+ssh_openssh_key_long_header(Config) when is_list(Config) ->
 Datadir = proplists:get_value(pk_data_dir, Config),
 
 {ok,RSARawOpenSsh} = file:read_file(filename:join(Datadir, "ssh_rsa_long_header_pub")),
 [{#'RSAPublicKey'{}, _}] = Decoded = ssh_file:decode(RSARawOpenSsh, public_key),
 
- Encoded = ssh_file:encode(Decoded, rfc4716_public_key),
- Decoded = ssh_file:decode(Encoded, rfc4716_public_key).
+ Encoded = ssh_file:encode(Decoded, rfc4716_key),
+ Decoded = ssh_file:decode(Encoded, rfc4716_key).
 
 %%%----------------------------------------------------------------
 %%% Test case helpers
-- 
2.26.2

Places

File 3904-ssh-Change-key-names.patch of Package erlang (Revision d2a82c32ce0452ccd2b016fb84350e59)

Places