Skip to content

Commit 56aed06

Browse files
Meroviusgopherbot
authored andcommitted
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 <[email protected]> Run-TryBot: Ian Lance Taylor <[email protected]> TryBot-Result: Gopher Robot <[email protected]> Reviewed-by: Ian Lance Taylor <[email protected]> Auto-Submit: Ian Lance Taylor <[email protected]>
1 parent 9be5aaa commit 56aed06

File tree

8 files changed

+13
-13
lines changed

8 files changed

+13
-13
lines changed

acme/acme.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ type Client struct {
8888
//
8989
// The following algorithms are supported:
9090
// RS256, ES256, ES384 and ES512.
91-
// See RFC7518 for more details about the algorithms.
91+
// See RFC 7518 for more details about the algorithms.
9292
Key crypto.Signer
9393

9494
// HTTPClient optionally specifies an HTTP client to use

acme/http.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ func (c *Client) get(ctx context.Context, url string, ok resOkay) (*http.Respons
156156
}
157157
}
158158

159-
// postAsGet is POST-as-GET, a replacement for GET in RFC8555
159+
// postAsGet is POST-as-GET, a replacement for GET in RFC 8555
160160
// as described in https://tools.ietf.org/html/rfc8555#section-6.3.
161161
// It makes a POST request in KID form with zero JWS payload.
162162
// See nopayload doc comments in jws.go.

acme/rfc8555_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ func TestRFC_postKID(t *testing.T) {
200200
}
201201
}
202202

203-
// acmeServer simulates a subset of RFC8555 compliant CA.
203+
// acmeServer simulates a subset of RFC 8555 compliant CA.
204204
//
205205
// TODO: We also have x/crypto/acme/autocert/acmetest and startACMEServerStub in autocert_test.go.
206206
// It feels like this acmeServer is a sweet spot between usefulness and added complexity.

acme/types.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -297,7 +297,7 @@ type Directory struct {
297297

298298
// CAA consists of lowercase hostname elements, which the ACME server
299299
// recognises as referring to itself for the purposes of CAA record validation
300-
// as defined in RFC6844.
300+
// as defined in RFC 6844.
301301
CAA []string
302302

303303
// ExternalAccountRequired indicates that the CA requires for all account-related
@@ -440,7 +440,7 @@ func DomainIDs(names ...string) []AuthzID {
440440

441441
// IPIDs creates a slice of AuthzID with "ip" identifier type.
442442
// Each element of addr is textual form of an address as defined
443-
// in RFC1123 Section 2.1 for IPv4 and in RFC5952 Section 4 for IPv6.
443+
// in RFC 1123 Section 2.1 for IPv4 and in RFC 5952 Section 4 for IPv6.
444444
func IPIDs(addr ...string) []AuthzID {
445445
a := make([]AuthzID, len(addr))
446446
for i, v := range addr {

ssh/agent/client.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ type ExtendedAgent interface {
9393
type ConstraintExtension struct {
9494
// ExtensionName consist of a UTF-8 string suffixed by the
9595
// implementation domain following the naming scheme defined
96-
// in Section 4.2 of [RFC4251], e.g. "[email protected]".
96+
// in Section 4.2 of RFC 4251, e.g. "[email protected]".
9797
ExtensionName string
9898
// ExtensionDetails contains the actual content of the extended
9999
// constraint.

ssh/cipher.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -96,21 +96,21 @@ func streamCipherMode(skip int, createFunc func(key, iv []byte) (cipher.Stream,
9696
// are not supported and will not be negotiated, even if explicitly requested in
9797
// ClientConfig.Crypto.Ciphers.
9898
var cipherModes = map[string]*cipherMode{
99-
// Ciphers from RFC4344, which introduced many CTR-based ciphers. Algorithms
99+
// Ciphers from RFC 4344, which introduced many CTR-based ciphers. Algorithms
100100
// are defined in the order specified in the RFC.
101101
"aes128-ctr": {16, aes.BlockSize, streamCipherMode(0, newAESCTR)},
102102
"aes192-ctr": {24, aes.BlockSize, streamCipherMode(0, newAESCTR)},
103103
"aes256-ctr": {32, aes.BlockSize, streamCipherMode(0, newAESCTR)},
104104

105-
// Ciphers from RFC4345, which introduces security-improved arcfour ciphers.
105+
// Ciphers from RFC 4345, which introduces security-improved arcfour ciphers.
106106
// They are defined in the order specified in the RFC.
107107
"arcfour128": {16, 0, streamCipherMode(1536, newRC4)},
108108
"arcfour256": {32, 0, streamCipherMode(1536, newRC4)},
109109

110110
// Cipher defined in RFC 4253, which describes SSH Transport Layer Protocol.
111111
// Note that this cipher is not safe, as stated in RFC 4253: "Arcfour (and
112112
// RC4) has problems with weak keys, and should be used with caution."
113-
// RFC4345 introduces improved versions of Arcfour.
113+
// RFC 4345 introduces improved versions of Arcfour.
114114
"arcfour": {16, 0, streamCipherMode(0, newRC4)},
115115

116116
// AEAD ciphers
@@ -641,7 +641,7 @@ const chacha20Poly1305ID = "[email protected]"
641641
//
642642
// https://tools.ietf.org/html/draft-josefsson-ssh-chacha20-poly1305-openssh-00
643643
//
644-
// the methods here also implement padding, which RFC4253 Section 6
644+
// the methods here also implement padding, which RFC 4253 Section 6
645645
// also requires of stream ciphers.
646646
type chacha20Poly1305Cipher struct {
647647
lengthKey [32]byte

ssh/common.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ type directionAlgorithms struct {
149149

150150
// rekeyBytes returns a rekeying intervals in bytes.
151151
func (a *directionAlgorithms) rekeyBytes() int64 {
152-
// According to RFC4344 block ciphers should rekey after
152+
// According to RFC 4344 block ciphers should rekey after
153153
// 2^(BLOCKSIZE/4) blocks. For all AES flavors BLOCKSIZE is
154154
// 128.
155155
switch a.Cipher {
@@ -158,7 +158,7 @@ func (a *directionAlgorithms) rekeyBytes() int64 {
158158

159159
}
160160

161-
// For others, stick with RFC4253 recommendation to rekey after 1 Gb of data.
161+
// For others, stick with RFC 4253 recommendation to rekey after 1 Gb of data.
162162
return 1 << 30
163163
}
164164

ssh/connection.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ type Conn interface {
5252

5353
// SendRequest sends a global request, and returns the
5454
// reply. If wantReply is true, it returns the response status
55-
// and payload. See also RFC4254, section 4.
55+
// and payload. See also RFC 4254, section 4.
5656
SendRequest(name string, wantReply bool, payload []byte) (bool, []byte, error)
5757

5858
// OpenChannel tries to open an channel. If the request is

0 commit comments

Comments
 (0)