File 3902-pubkey-Deprecate-ssh-fingerprint-and-ssh_e... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 3902-pubkey-Deprecate-ssh-fingerprint-and-ssh_encode-ssh_.patch of Package erlang (Revision 21b388369a3543c411f87d7721308749)

Currently displaying revision 21b388369a3543c411f87d7721308749 , Show latest

From bc7fa6a8211965fffd6731c68909205e7348e4c4 Mon Sep 17 00:00:00 2001
From: Hans Nilsson <hans@erlang.org>
Date: Mon, 26 Apr 2021 10:43:14 +0200
Subject: [PATCH 2/4] pubkey: Deprecate ssh fingerprint and
 ssh_encode/ssh_decode functions

---
 lib/public_key/src/public_key.erl        | 29 ++++++++++++++++++------
 lib/public_key/test/pubkey_ssh_SUITE.erl |  9 ++++++++
 lib/stdlib/src/otp_internal.erl          |  8 +++++++
 system/doc/general_info/DEPRECATIONS     |  4 ++++
 4 files changed, 43 insertions(+), 7 deletions(-)

diff --git a/lib/public_key/src/public_key.erl b/lib/public_key/src/public_key.erl
index e6150739bd..a320646940 100644
--- a/lib/public_key/src/public_key.erl
+++ b/lib/public_key/src/public_key.erl
@@ -52,8 +52,6 @@
 	 pkix_path_validation/3,
 	 pkix_verify_hostname/2, pkix_verify_hostname/3,
          pkix_verify_hostname_match_fun/1,
-	 ssh_decode/2, ssh_encode/2,
-	 ssh_hostkey_fingerprint/1, ssh_hostkey_fingerprint/2,
 	 ssh_curvename2oid/1, oid2ssh_curvename/1,
 	 pkix_crls_validate/3,
 	 pkix_dist_point/1,
@@ -69,6 +67,28 @@
          ocsp_extensions/1
 	]).
 
+%%----------------
+%% To be moved to ssh and deprecated:
+-export([ssh_decode/2, ssh_encode/2,
+         ssh_hostkey_fingerprint/1, ssh_hostkey_fingerprint/2
+        ]).
+
+-deprecated([{ssh_decode,2, "use ssh_file:decode/2 instead"},
+             {ssh_encode,2, "use ssh_file:encode/2 instead"},
+             {ssh_hostkey_fingerprint,1, "use ssh:hostkey_fingerprint/1 instead"},
+             {ssh_hostkey_fingerprint,2, "use ssh:hostkey_fingerprint/2 instead"}
+            ]).
+
+%% When removing for OTP-25.0, remember to also remove
+%%   - most of pubkey_ssh.erl except
+%%       + dh_gex_group/4
+%%       + dh_gex_group_sizes/0
+%%   - pubkey_pem:pem_start({no_asn1, new_openssh})
+%%   - pubkey_pem:pem_end(<<"-----BEGIN OPENSSH PRIVATE KEY-----">>)
+%%   - pubkey_pem:asn1_type(<<"-----BEGIN OPENSSH PRIVATE KEY-----">>) -> {no_asn1, new_openssh}
+
+%%----------------------------------------------------------------
+%% Types
 -export_type([public_key/0, private_key/0, pem_entry/0,
 	      pki_asn1_type/0, asn1_type/0, ssh_file/0, der_encoded/0,
               key_params/0, digest_type/0, issuer_name/0, cert_id/0, oid/0]).
@@ -110,11 +130,6 @@
                               | #'PBES2-params'{} .
 
 -type salt()                 :: binary(). % crypto:strong_rand_bytes(8)
-%% -type cipher_info()          :: {Cipher :: string(), Salt :: binary()} |
-%%                                 {Cipher :: string(), #'PBES2-params'{}} | 
-%%                                 {Cipher :: string(), {#'PBEParameter'{}, atom()}} %% hash type
-%%                                 .
-
 -type asn1_type()            :: atom(). %% see "OTP-PUB-KEY.hrl
 -type ssh_file()             :: openssh_public_key | rfc4716_public_key | known_hosts |
 				auth_keys.
diff --git a/lib/public_key/test/pubkey_ssh_SUITE.erl b/lib/public_key/test/pubkey_ssh_SUITE.erl
index effaece8f2..cd7f42b1c0 100644
--- a/lib/public_key/test/pubkey_ssh_SUITE.erl
+++ b/lib/public_key/test/pubkey_ssh_SUITE.erl
@@ -21,6 +21,15 @@
 %%
 -module(pubkey_ssh_SUITE).
 
+%% This test suite tests thoose functions until they are removed
+-compile([{nowarn_deprecated_function,
+           [{public_key,ssh_decode,2},
+            {public_key,ssh_encode,2},
+            {public_key,ssh_hostkey_fingerprint,1},
+            {public_key,ssh_hostkey_fingerprint,2}
+           ]}
+         ]).
+
 -include_lib("common_test/include/ct.hrl").
 -include_lib("public_key/include/public_key.hrl").
 
diff --git a/lib/stdlib/src/otp_internal.erl b/lib/stdlib/src/otp_internal.erl
index 1e34728d0d..86196d47d1 100644
--- a/lib/stdlib/src/otp_internal.erl
+++ b/lib/stdlib/src/otp_internal.erl
@@ -87,6 +87,14 @@ obsolete(net, relay, 1) ->
     {deprecated, "use slave:relay/1 instead"};
 obsolete(net, sleep, 1) ->
     {deprecated, "use 'receive after T -> ok end' instead"};
+obsolete(public_key, ssh_decode, 2) ->
+    {deprecated, "use ssh_file:decode/2 instead", "OTP 26"};
+obsolete(public_key, ssh_encode, 2) ->
+    {deprecated, "use ssh_file:encode/2 instead", "OTP 26"};
+obsolete(public_key, ssh_hostkey_fingerprint, 1) ->
+    {deprecated, "use ssh:hostkey_fingerprint/1 instead", "OTP 26"};
+obsolete(public_key, ssh_hostkey_fingerprint, 2) ->
+    {deprecated, "use ssh:hostkey_fingerprint/2 instead", "OTP 26"};
 obsolete(queue, lait, 1) ->
     {deprecated, "use queue:liat/1 instead"};
 obsolete(snmpm, async_get, 3) ->
diff --git a/system/doc/general_info/DEPRECATIONS b/system/doc/general_info/DEPRECATIONS
index 7872b698c9..ab304db2a8 100644
--- a/system/doc/general_info/DEPRECATIONS
+++ b/system/doc/general_info/DEPRECATIONS
@@ -21,6 +21,10 @@
 # Added in OTP 24.
 #
 
+public_key:ssh_hostkey_fingerprint/1 since=24 remove=26
+public_key:ssh_hostkey_fingerprint/2 since=24 remove=26
+public_key:ssh_decode/2 since=24 remove=26
+public_key:ssh_encode/2 since=24 remove=26
 ftp:start_service/1 since=24 remove=26
 ftp:stop_service/1 since=24 remove=26
 httpd_util:flatlength/1 since=24 remove=26
-- 
2.26.2

Places

File 3902-pubkey-Deprecate-ssh-fingerprint-and-ssh_encode-ssh_.patch of Package erlang (Revision 21b388369a3543c411f87d7721308749)

Places