Warning in docs about :crypto usage

voltone · Feb 20, 2019 · 8360ae1 · 8360ae1
1 parent fda856f
commit 8360ae1
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/lib/x509/private_key.ex b/lib/x509/private_key.ex
@@ -24,6 +24,10 @@ defmodule X509.PrivateKey do
       iex> :public_key.verify(message, :sha256, signature, public_key)
       true
 
+  Note that in practice it is not a good idea to directly encrypt a message
+  with asymmetrical cryptography, and signatures should be calculated over
+  message hashes rather than raw messages. The examples above are deliberate
+  over-simpliciations intended to highlight the `:crypto` API calls.
   """
 
   @typedoc "RSA or EC private key"