From: Filippo Valsorda <filippo@golang.org>
Date: Wed, 29 Sep 2021 11:09:34 +0000 (+0200)
Subject: crypto: document the extended key interfaces
X-Git-Tag: go1.18beta1~1111
X-Git-Url: http://www.git.cypherpunks.su/?a=commitdiff_plain;h=7162c4c7caf72a3f29d3ceee48ff352dab659472;p=gostls13.git

crypto: document the extended key interfaces

Change-Id: Iaff3f77b0a168e8bde981c791035a6451b3a49ac
Reviewed-on: https://go-review.googlesource.com/c/go/+/353049
Trust: Filippo Valsorda <filippo@golang.org>
Run-TryBot: Filippo Valsorda <filippo@golang.org>
TryBot-Result: Go Bot <gobot@golang.org>
Reviewed-by: Julie Qiu <julie@golang.org>
---

diff --git a/src/crypto/crypto.go b/src/crypto/crypto.go
index ce473b5afe..cb87972afc 100644
--- a/src/crypto/crypto.go
+++ b/src/crypto/crypto.go
@@ -150,9 +150,29 @@ func RegisterHash(h Hash, f func() hash.Hash) {
 }
 
 // PublicKey represents a public key using an unspecified algorithm.
+//
+// Although this type is an empty interface for backwards compatibility reasons,
+// all public key types in the standard library implement the following interface
+//
+//     interface{
+//         Equal(x crypto.PublicKey) bool
+//     }
+//
+// which can be used for increased type safety within applications.
 type PublicKey interface{}
 
 // PrivateKey represents a private key using an unspecified algorithm.
+//
+// Although this type is an empty interface for backwards compatibility reasons,
+// all private key types in the standard library implement the following interface
+//
+//     interface{
+//         Public() crypto.PublicKey
+//         Equal(x crypto.PrivateKey) bool
+//     }
+//
+// as well as purpose-specific interfaces such as Signer and Decrypter, which
+// can be used for increased type safety within applications.
 type PrivateKey interface{}
 
 // Signer is an interface for an opaque private key that can be used for