diff options
| author | Axel Wagner <axel.wagner.hh@googlemail.com> | 2022-10-11 09:15:35 +0200 |
|---|---|---|
| committer | Gopher Robot <gobot@golang.org> | 2022-10-12 13:47:37 +0000 |
| commit | 56aed061732aaf690a941aa617c5b0e322727650 (patch) | |
| tree | 60f97fc2aa864930ec5d95cead0c95ea242dcdfd | |
| parent | 9be5aaad42d5e8b858864f1bec7f0fb3844130a9 (diff) | |
| download | go-x-crypto-56aed061732aaf690a941aa617c5b0e322727650.tar.xz | |
all: use automatic RFC linking
pkgsite automatically links /RFC \d+/ to the mentioned RFC. Insert a
bunch of spaces into doc-comments for that to match.
Change-Id: I01834d7573428563f21c37e43316442e148dd8c4
Reviewed-on: https://go-review.googlesource.com/c/crypto/+/442055
Reviewed-by: Joedian Reid <joedian@golang.org>
Run-TryBot: Ian Lance Taylor <iant@google.com>
TryBot-Result: Gopher Robot <gobot@golang.org>
Reviewed-by: Ian Lance Taylor <iant@google.com>
Auto-Submit: Ian Lance Taylor <iant@google.com>
| -rw-r--r-- | acme/acme.go | 2 | ||||
| -rw-r--r-- | acme/http.go | 2 | ||||
| -rw-r--r-- | acme/rfc8555_test.go | 2 | ||||
| -rw-r--r-- | acme/types.go | 4 | ||||
| -rw-r--r-- | ssh/agent/client.go | 2 | ||||
| -rw-r--r-- | ssh/cipher.go | 8 | ||||
| -rw-r--r-- | ssh/common.go | 4 | ||||
| -rw-r--r-- | ssh/connection.go | 2 |
8 files changed, 13 insertions, 13 deletions
diff --git a/acme/acme.go b/acme/acme.go index 7f1cd80..aaafea2 100644 --- a/acme/acme.go +++ b/acme/acme.go @@ -88,7 +88,7 @@ type Client struct { // // The following algorithms are supported: // RS256, ES256, ES384 and ES512. - // See RFC7518 for more details about the algorithms. + // See RFC 7518 for more details about the algorithms. Key crypto.Signer // HTTPClient optionally specifies an HTTP client to use diff --git a/acme/http.go b/acme/http.go index 2617b00..58836e5 100644 --- a/acme/http.go +++ b/acme/http.go @@ -156,7 +156,7 @@ func (c *Client) get(ctx context.Context, url string, ok resOkay) (*http.Respons } } -// postAsGet is POST-as-GET, a replacement for GET in RFC8555 +// postAsGet is POST-as-GET, a replacement for GET in RFC 8555 // as described in https://tools.ietf.org/html/rfc8555#section-6.3. // It makes a POST request in KID form with zero JWS payload. // See nopayload doc comments in jws.go. diff --git a/acme/rfc8555_test.go b/acme/rfc8555_test.go index 4ab98f6..e92f658 100644 --- a/acme/rfc8555_test.go +++ b/acme/rfc8555_test.go @@ -200,7 +200,7 @@ func TestRFC_postKID(t *testing.T) { } } -// acmeServer simulates a subset of RFC8555 compliant CA. +// acmeServer simulates a subset of RFC 8555 compliant CA. // // TODO: We also have x/crypto/acme/autocert/acmetest and startACMEServerStub in autocert_test.go. // It feels like this acmeServer is a sweet spot between usefulness and added complexity. diff --git a/acme/types.go b/acme/types.go index 67b8252..4888726 100644 --- a/acme/types.go +++ b/acme/types.go @@ -297,7 +297,7 @@ type Directory struct { // CAA consists of lowercase hostname elements, which the ACME server // recognises as referring to itself for the purposes of CAA record validation - // as defined in RFC6844. + // as defined in RFC 6844. CAA []string // ExternalAccountRequired indicates that the CA requires for all account-related @@ -440,7 +440,7 @@ func DomainIDs(names ...string) []AuthzID { // IPIDs creates a slice of AuthzID with "ip" identifier type. // Each element of addr is textual form of an address as defined -// in RFC1123 Section 2.1 for IPv4 and in RFC5952 Section 4 for IPv6. +// in RFC 1123 Section 2.1 for IPv4 and in RFC 5952 Section 4 for IPv6. func IPIDs(addr ...string) []AuthzID { a := make([]AuthzID, len(addr)) for i, v := range addr { diff --git a/ssh/agent/client.go b/ssh/agent/client.go index a2fa36f..c3e112a 100644 --- a/ssh/agent/client.go +++ b/ssh/agent/client.go @@ -93,7 +93,7 @@ type ExtendedAgent interface { type ConstraintExtension struct { // ExtensionName consist of a UTF-8 string suffixed by the // implementation domain following the naming scheme defined - // in Section 4.2 of [RFC4251], e.g. "foo@example.com". + // in Section 4.2 of RFC 4251, e.g. "foo@example.com". ExtensionName string // ExtensionDetails contains the actual content of the extended // constraint. diff --git a/ssh/cipher.go b/ssh/cipher.go index c3062cf..87f4855 100644 --- a/ssh/cipher.go +++ b/ssh/cipher.go @@ -96,13 +96,13 @@ func streamCipherMode(skip int, createFunc func(key, iv []byte) (cipher.Stream, // are not supported and will not be negotiated, even if explicitly requested in // ClientConfig.Crypto.Ciphers. var cipherModes = map[string]*cipherMode{ - // Ciphers from RFC4344, which introduced many CTR-based ciphers. Algorithms + // Ciphers from RFC 4344, which introduced many CTR-based ciphers. Algorithms // are defined in the order specified in the RFC. "aes128-ctr": {16, aes.BlockSize, streamCipherMode(0, newAESCTR)}, "aes192-ctr": {24, aes.BlockSize, streamCipherMode(0, newAESCTR)}, "aes256-ctr": {32, aes.BlockSize, streamCipherMode(0, newAESCTR)}, - // Ciphers from RFC4345, which introduces security-improved arcfour ciphers. + // Ciphers from RFC 4345, which introduces security-improved arcfour ciphers. // They are defined in the order specified in the RFC. "arcfour128": {16, 0, streamCipherMode(1536, newRC4)}, "arcfour256": {32, 0, streamCipherMode(1536, newRC4)}, @@ -110,7 +110,7 @@ var cipherModes = map[string]*cipherMode{ // Cipher defined in RFC 4253, which describes SSH Transport Layer Protocol. // Note that this cipher is not safe, as stated in RFC 4253: "Arcfour (and // RC4) has problems with weak keys, and should be used with caution." - // RFC4345 introduces improved versions of Arcfour. + // RFC 4345 introduces improved versions of Arcfour. "arcfour": {16, 0, streamCipherMode(0, newRC4)}, // AEAD ciphers @@ -641,7 +641,7 @@ const chacha20Poly1305ID = "chacha20-poly1305@openssh.com" // // https://tools.ietf.org/html/draft-josefsson-ssh-chacha20-poly1305-openssh-00 // -// the methods here also implement padding, which RFC4253 Section 6 +// the methods here also implement padding, which RFC 4253 Section 6 // also requires of stream ciphers. type chacha20Poly1305Cipher struct { lengthKey [32]byte diff --git a/ssh/common.go b/ssh/common.go index 2a47a61..7a5ff2d 100644 --- a/ssh/common.go +++ b/ssh/common.go @@ -149,7 +149,7 @@ type directionAlgorithms struct { // rekeyBytes returns a rekeying intervals in bytes. func (a *directionAlgorithms) rekeyBytes() int64 { - // According to RFC4344 block ciphers should rekey after + // According to RFC 4344 block ciphers should rekey after // 2^(BLOCKSIZE/4) blocks. For all AES flavors BLOCKSIZE is // 128. switch a.Cipher { @@ -158,7 +158,7 @@ func (a *directionAlgorithms) rekeyBytes() int64 { } - // For others, stick with RFC4253 recommendation to rekey after 1 Gb of data. + // For others, stick with RFC 4253 recommendation to rekey after 1 Gb of data. return 1 << 30 } diff --git a/ssh/connection.go b/ssh/connection.go index fd6b068..35661a5 100644 --- a/ssh/connection.go +++ b/ssh/connection.go @@ -52,7 +52,7 @@ type Conn interface { // SendRequest sends a global request, and returns the // reply. If wantReply is true, it returns the response status - // and payload. See also RFC4254, section 4. + // and payload. See also RFC 4254, section 4. SendRequest(name string, wantReply bool, payload []byte) (bool, []byte, error) // OpenChannel tries to open an channel. If the request is |
