Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 1 | // Copyright 2009 The Go Authors. All rights reserved. |
| 2 | // Use of this source code is governed by a BSD-style |
| 3 | // license that can be found in the LICENSE file. |
| 4 | |
Adam Langley | dc7e9c4 | 2015-09-29 15:21:04 -0700 | [diff] [blame] | 5 | package runner |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 6 | |
| 7 | import ( |
| 8 | "container/list" |
| 9 | "crypto" |
David Benjamin | d30a990 | 2014-08-24 01:44:23 -0400 | [diff] [blame] | 10 | "crypto/ecdsa" |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 11 | "crypto/rand" |
| 12 | "crypto/x509" |
| 13 | "fmt" |
| 14 | "io" |
| 15 | "math/big" |
| 16 | "strings" |
| 17 | "sync" |
| 18 | "time" |
| 19 | ) |
| 20 | |
| 21 | const ( |
| 22 | VersionSSL30 = 0x0300 |
| 23 | VersionTLS10 = 0x0301 |
| 24 | VersionTLS11 = 0x0302 |
| 25 | VersionTLS12 = 0x0303 |
Nick Harper | 1fd39d8 | 2016-06-14 18:14:35 -0700 | [diff] [blame] | 26 | VersionTLS13 = 0x0304 |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 27 | ) |
| 28 | |
Nick Harper | 4d90c10 | 2016-07-17 10:53:26 +0200 | [diff] [blame] | 29 | // The draft version of TLS 1.3 that is implemented here and sent in the draft |
| 30 | // indicator extension. |
Nick Harper | 0b3625b | 2016-07-25 16:16:28 -0700 | [diff] [blame] | 31 | const tls13DraftVersion = 14 |
Nick Harper | 4d90c10 | 2016-07-17 10:53:26 +0200 | [diff] [blame] | 32 | |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 33 | const ( |
David Benjamin | 83c0bc9 | 2014-08-04 01:23:53 -0400 | [diff] [blame] | 34 | maxPlaintext = 16384 // maximum plaintext payload length |
| 35 | maxCiphertext = 16384 + 2048 // maximum ciphertext payload length |
| 36 | tlsRecordHeaderLen = 5 // record header length |
| 37 | dtlsRecordHeaderLen = 13 |
| 38 | maxHandshake = 65536 // maximum handshake we support (protocol max is 16 MB) |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 39 | |
| 40 | minVersion = VersionSSL30 |
Nick Harper | 1fd39d8 | 2016-06-14 18:14:35 -0700 | [diff] [blame] | 41 | maxVersion = VersionTLS13 |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 42 | ) |
| 43 | |
| 44 | // TLS record types. |
| 45 | type recordType uint8 |
| 46 | |
| 47 | const ( |
| 48 | recordTypeChangeCipherSpec recordType = 20 |
| 49 | recordTypeAlert recordType = 21 |
| 50 | recordTypeHandshake recordType = 22 |
| 51 | recordTypeApplicationData recordType = 23 |
| 52 | ) |
| 53 | |
| 54 | // TLS handshake message types. |
| 55 | const ( |
David Benjamin | cedff87 | 2016-06-30 18:55:18 -0400 | [diff] [blame] | 56 | typeHelloRequest uint8 = 0 |
| 57 | typeClientHello uint8 = 1 |
| 58 | typeServerHello uint8 = 2 |
| 59 | typeHelloVerifyRequest uint8 = 3 |
| 60 | typeNewSessionTicket uint8 = 4 |
| 61 | typeHelloRetryRequest uint8 = 6 // draft-ietf-tls-tls13-13 |
| 62 | typeEncryptedExtensions uint8 = 8 // draft-ietf-tls-tls13-13 |
| 63 | typeCertificate uint8 = 11 |
| 64 | typeServerKeyExchange uint8 = 12 |
| 65 | typeCertificateRequest uint8 = 13 |
| 66 | typeServerHelloDone uint8 = 14 |
| 67 | typeCertificateVerify uint8 = 15 |
| 68 | typeClientKeyExchange uint8 = 16 |
| 69 | typeFinished uint8 = 20 |
| 70 | typeCertificateStatus uint8 = 22 |
David Benjamin | 21c0028 | 2016-07-18 21:56:23 +0200 | [diff] [blame] | 71 | typeKeyUpdate uint8 = 24 // draft-ietf-tls-tls13-13 |
David Benjamin | cedff87 | 2016-06-30 18:55:18 -0400 | [diff] [blame] | 72 | typeNextProtocol uint8 = 67 // Not IANA assigned |
| 73 | typeChannelID uint8 = 203 // Not IANA assigned |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 74 | ) |
| 75 | |
| 76 | // TLS compression types. |
| 77 | const ( |
| 78 | compressionNone uint8 = 0 |
| 79 | ) |
| 80 | |
| 81 | // TLS extension numbers |
| 82 | const ( |
David Benjamin | 61f9527 | 2014-11-25 01:55:35 -0500 | [diff] [blame] | 83 | extensionServerName uint16 = 0 |
| 84 | extensionStatusRequest uint16 = 5 |
| 85 | extensionSupportedCurves uint16 = 10 |
| 86 | extensionSupportedPoints uint16 = 11 |
| 87 | extensionSignatureAlgorithms uint16 = 13 |
| 88 | extensionUseSRTP uint16 = 14 |
| 89 | extensionALPN uint16 = 16 |
| 90 | extensionSignedCertificateTimestamp uint16 = 18 |
| 91 | extensionExtendedMasterSecret uint16 = 23 |
| 92 | extensionSessionTicket uint16 = 35 |
David Benjamin | cedff87 | 2016-06-30 18:55:18 -0400 | [diff] [blame] | 93 | extensionKeyShare uint16 = 40 // draft-ietf-tls-tls13-13 |
| 94 | extensionPreSharedKey uint16 = 41 // draft-ietf-tls-tls13-13 |
| 95 | extensionEarlyData uint16 = 42 // draft-ietf-tls-tls13-13 |
| 96 | extensionCookie uint16 = 44 // draft-ietf-tls-tls13-13 |
David Benjamin | 399e7c9 | 2015-07-30 23:01:27 -0400 | [diff] [blame] | 97 | extensionCustom uint16 = 1234 // not IANA assigned |
David Benjamin | 61f9527 | 2014-11-25 01:55:35 -0500 | [diff] [blame] | 98 | extensionNextProtoNeg uint16 = 13172 // not IANA assigned |
| 99 | extensionRenegotiationInfo uint16 = 0xff01 |
Nick Harper | 4d90c10 | 2016-07-17 10:53:26 +0200 | [diff] [blame] | 100 | extensionTLS13Draft uint16 = 0xff02 |
David Benjamin | 61f9527 | 2014-11-25 01:55:35 -0500 | [diff] [blame] | 101 | extensionChannelID uint16 = 30032 // not IANA assigned |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 102 | ) |
| 103 | |
| 104 | // TLS signaling cipher suite values |
| 105 | const ( |
| 106 | scsvRenegotiation uint16 = 0x00ff |
| 107 | ) |
| 108 | |
| 109 | // CurveID is the type of a TLS identifier for an elliptic curve. See |
| 110 | // http://www.iana.org/assignments/tls-parameters/tls-parameters.xml#tls-parameters-8 |
| 111 | type CurveID uint16 |
| 112 | |
| 113 | const ( |
David Benjamin | cba2b62 | 2015-12-18 22:13:41 -0500 | [diff] [blame] | 114 | CurveP224 CurveID = 21 |
| 115 | CurveP256 CurveID = 23 |
| 116 | CurveP384 CurveID = 24 |
| 117 | CurveP521 CurveID = 25 |
| 118 | CurveX25519 CurveID = 29 |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 119 | ) |
| 120 | |
| 121 | // TLS Elliptic Curve Point Formats |
| 122 | // http://www.iana.org/assignments/tls-parameters/tls-parameters.xml#tls-parameters-9 |
| 123 | const ( |
| 124 | pointFormatUncompressed uint8 = 0 |
| 125 | ) |
| 126 | |
| 127 | // TLS CertificateStatusType (RFC 3546) |
| 128 | const ( |
| 129 | statusTypeOCSP uint8 = 1 |
| 130 | ) |
| 131 | |
| 132 | // Certificate types (for certificateRequestMsg) |
| 133 | const ( |
David Benjamin | 7b03051 | 2014-07-08 17:30:11 -0400 | [diff] [blame] | 134 | CertTypeRSASign = 1 // A certificate containing an RSA key |
| 135 | CertTypeDSSSign = 2 // A certificate containing a DSA key |
| 136 | CertTypeRSAFixedDH = 3 // A certificate containing a static DH key |
| 137 | CertTypeDSSFixedDH = 4 // A certificate containing a static DH key |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 138 | |
| 139 | // See RFC4492 sections 3 and 5.5. |
David Benjamin | 7b03051 | 2014-07-08 17:30:11 -0400 | [diff] [blame] | 140 | CertTypeECDSASign = 64 // A certificate containing an ECDSA-capable public key, signed with ECDSA. |
| 141 | CertTypeRSAFixedECDH = 65 // A certificate containing an ECDH-capable public key, signed with RSA. |
| 142 | CertTypeECDSAFixedECDH = 66 // A certificate containing an ECDH-capable public key, signed with ECDSA. |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 143 | |
| 144 | // Rest of these are reserved by the TLS spec |
| 145 | ) |
| 146 | |
Nick Harper | 60edffd | 2016-06-21 15:19:24 -0700 | [diff] [blame] | 147 | // signatureAlgorithm corresponds to a SignatureScheme value from TLS 1.3. Note |
| 148 | // that TLS 1.3 names the production 'SignatureScheme' to avoid colliding with |
| 149 | // TLS 1.2's SignatureAlgorithm but otherwise refers to them as 'signature |
| 150 | // algorithms' throughout. We match the latter. |
| 151 | type signatureAlgorithm uint16 |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 152 | |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 153 | const ( |
Nick Harper | 60edffd | 2016-06-21 15:19:24 -0700 | [diff] [blame] | 154 | // RSASSA-PKCS1-v1_5 algorithms |
| 155 | signatureRSAPKCS1WithMD5 signatureAlgorithm = 0x0101 |
| 156 | signatureRSAPKCS1WithSHA1 signatureAlgorithm = 0x0201 |
| 157 | signatureRSAPKCS1WithSHA256 signatureAlgorithm = 0x0401 |
| 158 | signatureRSAPKCS1WithSHA384 signatureAlgorithm = 0x0501 |
| 159 | signatureRSAPKCS1WithSHA512 signatureAlgorithm = 0x0601 |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 160 | |
Nick Harper | 60edffd | 2016-06-21 15:19:24 -0700 | [diff] [blame] | 161 | // ECDSA algorithms |
| 162 | signatureECDSAWithSHA1 signatureAlgorithm = 0x0203 |
| 163 | signatureECDSAWithP256AndSHA256 signatureAlgorithm = 0x0403 |
| 164 | signatureECDSAWithP384AndSHA384 signatureAlgorithm = 0x0503 |
| 165 | signatureECDSAWithP521AndSHA512 signatureAlgorithm = 0x0603 |
| 166 | |
| 167 | // RSASSA-PSS algorithms |
| 168 | signatureRSAPSSWithSHA256 signatureAlgorithm = 0x0700 |
| 169 | signatureRSAPSSWithSHA384 signatureAlgorithm = 0x0701 |
| 170 | signatureRSAPSSWithSHA512 signatureAlgorithm = 0x0702 |
| 171 | |
| 172 | // EdDSA algorithms |
| 173 | signatureEd25519 signatureAlgorithm = 0x0703 |
| 174 | signatureEd448 signatureAlgorithm = 0x0704 |
| 175 | ) |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 176 | |
David Benjamin | 7a41d37 | 2016-07-09 11:21:54 -0700 | [diff] [blame] | 177 | // supportedSignatureAlgorithms contains the default supported signature |
| 178 | // algorithms. |
| 179 | var supportedSignatureAlgorithms = []signatureAlgorithm{ |
| 180 | signatureRSAPSSWithSHA256, |
Nick Harper | 60edffd | 2016-06-21 15:19:24 -0700 | [diff] [blame] | 181 | signatureRSAPKCS1WithSHA256, |
| 182 | signatureECDSAWithP256AndSHA256, |
| 183 | signatureRSAPKCS1WithSHA1, |
| 184 | signatureECDSAWithSHA1, |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 185 | } |
| 186 | |
David Benjamin | ca6c826 | 2014-11-15 19:06:08 -0500 | [diff] [blame] | 187 | // SRTP protection profiles (See RFC 5764, section 4.1.2) |
| 188 | const ( |
| 189 | SRTP_AES128_CM_HMAC_SHA1_80 uint16 = 0x0001 |
| 190 | SRTP_AES128_CM_HMAC_SHA1_32 = 0x0002 |
| 191 | ) |
| 192 | |
David Benjamin | 5810488 | 2016-07-18 01:25:41 +0200 | [diff] [blame] | 193 | // TicketFlags values (see draft-ietf-tls-tls13-14, section 4.4.1) |
| 194 | const ( |
| 195 | ticketAllowEarlyData = 1 |
| 196 | ticketAllowDHEResumption = 2 |
| 197 | ticketAllowPSKResumption = 4 |
| 198 | ) |
| 199 | |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 200 | // ConnectionState records basic TLS details about the connection. |
| 201 | type ConnectionState struct { |
| 202 | Version uint16 // TLS version used by the connection (e.g. VersionTLS12) |
| 203 | HandshakeComplete bool // TLS handshake is complete |
| 204 | DidResume bool // connection resumes a previous TLS connection |
| 205 | CipherSuite uint16 // cipher suite in use (TLS_RSA_WITH_RC4_128_SHA, ...) |
| 206 | NegotiatedProtocol string // negotiated next protocol (from Config.NextProtos) |
| 207 | NegotiatedProtocolIsMutual bool // negotiated protocol was advertised by server |
David Benjamin | fc7b086 | 2014-09-06 13:21:53 -0400 | [diff] [blame] | 208 | NegotiatedProtocolFromALPN bool // protocol negotiated with ALPN |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 209 | ServerName string // server name requested by client, if any (server side only) |
| 210 | PeerCertificates []*x509.Certificate // certificate chain presented by remote peer |
| 211 | VerifiedChains [][]*x509.Certificate // verified chains built from PeerCertificates |
David Benjamin | d30a990 | 2014-08-24 01:44:23 -0400 | [diff] [blame] | 212 | ChannelID *ecdsa.PublicKey // the channel ID for this connection |
David Benjamin | ca6c826 | 2014-11-15 19:06:08 -0500 | [diff] [blame] | 213 | SRTPProtectionProfile uint16 // the negotiated DTLS-SRTP protection profile |
David Benjamin | c057762 | 2015-09-12 18:28:38 -0400 | [diff] [blame] | 214 | TLSUnique []byte // the tls-unique channel binding |
Paul Lietar | 4fac72e | 2015-09-09 13:44:55 +0100 | [diff] [blame] | 215 | SCTList []byte // signed certificate timestamp list |
Nick Harper | 60edffd | 2016-06-21 15:19:24 -0700 | [diff] [blame] | 216 | PeerSignatureAlgorithm signatureAlgorithm // algorithm used by the peer in the handshake |
Steven Valdez | 5440fe0 | 2016-07-18 12:40:30 -0400 | [diff] [blame] | 217 | CurveID CurveID // the curve used in ECDHE |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 218 | } |
| 219 | |
| 220 | // ClientAuthType declares the policy the server will follow for |
| 221 | // TLS Client Authentication. |
| 222 | type ClientAuthType int |
| 223 | |
| 224 | const ( |
| 225 | NoClientCert ClientAuthType = iota |
| 226 | RequestClientCert |
| 227 | RequireAnyClientCert |
| 228 | VerifyClientCertIfGiven |
| 229 | RequireAndVerifyClientCert |
| 230 | ) |
| 231 | |
| 232 | // ClientSessionState contains the state needed by clients to resume TLS |
| 233 | // sessions. |
| 234 | type ClientSessionState struct { |
David Benjamin | fe8eb9a | 2014-11-17 03:19:02 -0500 | [diff] [blame] | 235 | sessionId []uint8 // Session ID supplied by the server. nil if the session has a ticket. |
Adam Langley | 7571292 | 2014-10-10 16:23:43 -0700 | [diff] [blame] | 236 | sessionTicket []uint8 // Encrypted ticket used for session resumption with server |
| 237 | vers uint16 // SSL/TLS version negotiated for the session |
| 238 | cipherSuite uint16 // Ciphersuite negotiated for the session |
| 239 | masterSecret []byte // MasterSecret generated by client on a full handshake |
| 240 | handshakeHash []byte // Handshake hash for Channel ID purposes. |
| 241 | serverCertificates []*x509.Certificate // Certificate chain presented by the server |
| 242 | extendedMasterSecret bool // Whether an extended master secret was used to generate the session |
Paul Lietar | 62be8ac | 2015-09-16 10:03:30 +0100 | [diff] [blame] | 243 | sctList []byte |
| 244 | ocspResponse []byte |
Nick Harper | 0b3625b | 2016-07-25 16:16:28 -0700 | [diff] [blame] | 245 | ticketCreationTime time.Time |
| 246 | ticketExpiration time.Time |
| 247 | ticketFlags uint32 |
| 248 | ticketAgeAdd uint32 |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 249 | } |
| 250 | |
| 251 | // ClientSessionCache is a cache of ClientSessionState objects that can be used |
| 252 | // by a client to resume a TLS session with a given server. ClientSessionCache |
| 253 | // implementations should expect to be called concurrently from different |
| 254 | // goroutines. |
| 255 | type ClientSessionCache interface { |
| 256 | // Get searches for a ClientSessionState associated with the given key. |
| 257 | // On return, ok is true if one was found. |
| 258 | Get(sessionKey string) (session *ClientSessionState, ok bool) |
| 259 | |
| 260 | // Put adds the ClientSessionState to the cache with the given key. |
| 261 | Put(sessionKey string, cs *ClientSessionState) |
| 262 | } |
| 263 | |
David Benjamin | fe8eb9a | 2014-11-17 03:19:02 -0500 | [diff] [blame] | 264 | // ServerSessionCache is a cache of sessionState objects that can be used by a |
| 265 | // client to resume a TLS session with a given server. ServerSessionCache |
| 266 | // implementations should expect to be called concurrently from different |
| 267 | // goroutines. |
| 268 | type ServerSessionCache interface { |
| 269 | // Get searches for a sessionState associated with the given session |
| 270 | // ID. On return, ok is true if one was found. |
| 271 | Get(sessionId string) (session *sessionState, ok bool) |
| 272 | |
| 273 | // Put adds the sessionState to the cache with the given session ID. |
| 274 | Put(sessionId string, session *sessionState) |
| 275 | } |
| 276 | |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 277 | // A Config structure is used to configure a TLS client or server. |
| 278 | // After one has been passed to a TLS function it must not be |
| 279 | // modified. A Config may be reused; the tls package will also not |
| 280 | // modify it. |
| 281 | type Config struct { |
| 282 | // Rand provides the source of entropy for nonces and RSA blinding. |
| 283 | // If Rand is nil, TLS uses the cryptographic random reader in package |
| 284 | // crypto/rand. |
| 285 | // The Reader must be safe for use by multiple goroutines. |
| 286 | Rand io.Reader |
| 287 | |
| 288 | // Time returns the current time as the number of seconds since the epoch. |
| 289 | // If Time is nil, TLS uses time.Now. |
| 290 | Time func() time.Time |
| 291 | |
| 292 | // Certificates contains one or more certificate chains |
| 293 | // to present to the other side of the connection. |
| 294 | // Server configurations must include at least one certificate. |
| 295 | Certificates []Certificate |
| 296 | |
| 297 | // NameToCertificate maps from a certificate name to an element of |
| 298 | // Certificates. Note that a certificate name can be of the form |
| 299 | // '*.example.com' and so doesn't have to be a domain name as such. |
| 300 | // See Config.BuildNameToCertificate |
| 301 | // The nil value causes the first element of Certificates to be used |
| 302 | // for all connections. |
| 303 | NameToCertificate map[string]*Certificate |
| 304 | |
| 305 | // RootCAs defines the set of root certificate authorities |
| 306 | // that clients use when verifying server certificates. |
| 307 | // If RootCAs is nil, TLS uses the host's root CA set. |
| 308 | RootCAs *x509.CertPool |
| 309 | |
| 310 | // NextProtos is a list of supported, application level protocols. |
| 311 | NextProtos []string |
| 312 | |
| 313 | // ServerName is used to verify the hostname on the returned |
| 314 | // certificates unless InsecureSkipVerify is given. It is also included |
| 315 | // in the client's handshake to support virtual hosting. |
| 316 | ServerName string |
| 317 | |
| 318 | // ClientAuth determines the server's policy for |
| 319 | // TLS Client Authentication. The default is NoClientCert. |
| 320 | ClientAuth ClientAuthType |
| 321 | |
| 322 | // ClientCAs defines the set of root certificate authorities |
| 323 | // that servers use if required to verify a client certificate |
| 324 | // by the policy in ClientAuth. |
| 325 | ClientCAs *x509.CertPool |
| 326 | |
David Benjamin | 7b03051 | 2014-07-08 17:30:11 -0400 | [diff] [blame] | 327 | // ClientCertificateTypes defines the set of allowed client certificate |
| 328 | // types. The default is CertTypeRSASign and CertTypeECDSASign. |
| 329 | ClientCertificateTypes []byte |
| 330 | |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 331 | // InsecureSkipVerify controls whether a client verifies the |
| 332 | // server's certificate chain and host name. |
| 333 | // If InsecureSkipVerify is true, TLS accepts any certificate |
| 334 | // presented by the server and any host name in that certificate. |
| 335 | // In this mode, TLS is susceptible to man-in-the-middle attacks. |
| 336 | // This should be used only for testing. |
| 337 | InsecureSkipVerify bool |
| 338 | |
| 339 | // CipherSuites is a list of supported cipher suites. If CipherSuites |
| 340 | // is nil, TLS uses a list of suites supported by the implementation. |
| 341 | CipherSuites []uint16 |
| 342 | |
| 343 | // PreferServerCipherSuites controls whether the server selects the |
| 344 | // client's most preferred ciphersuite, or the server's most preferred |
| 345 | // ciphersuite. If true then the server's preference, as expressed in |
| 346 | // the order of elements in CipherSuites, is used. |
| 347 | PreferServerCipherSuites bool |
| 348 | |
| 349 | // SessionTicketsDisabled may be set to true to disable session ticket |
| 350 | // (resumption) support. |
| 351 | SessionTicketsDisabled bool |
| 352 | |
| 353 | // SessionTicketKey is used by TLS servers to provide session |
| 354 | // resumption. See RFC 5077. If zero, it will be filled with |
| 355 | // random data before the first server handshake. |
| 356 | // |
| 357 | // If multiple servers are terminating connections for the same host |
| 358 | // they should all have the same SessionTicketKey. If the |
| 359 | // SessionTicketKey leaks, previously recorded and future TLS |
| 360 | // connections using that key are compromised. |
| 361 | SessionTicketKey [32]byte |
| 362 | |
David Benjamin | fe8eb9a | 2014-11-17 03:19:02 -0500 | [diff] [blame] | 363 | // ClientSessionCache is a cache of ClientSessionState entries |
| 364 | // for TLS session resumption. |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 365 | ClientSessionCache ClientSessionCache |
| 366 | |
David Benjamin | fe8eb9a | 2014-11-17 03:19:02 -0500 | [diff] [blame] | 367 | // ServerSessionCache is a cache of sessionState entries for TLS session |
| 368 | // resumption. |
| 369 | ServerSessionCache ServerSessionCache |
| 370 | |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 371 | // MinVersion contains the minimum SSL/TLS version that is acceptable. |
| 372 | // If zero, then SSLv3 is taken as the minimum. |
| 373 | MinVersion uint16 |
| 374 | |
| 375 | // MaxVersion contains the maximum SSL/TLS version that is acceptable. |
| 376 | // If zero, then the maximum version supported by this package is used, |
| 377 | // which is currently TLS 1.2. |
| 378 | MaxVersion uint16 |
| 379 | |
| 380 | // CurvePreferences contains the elliptic curves that will be used in |
| 381 | // an ECDHE handshake, in preference order. If empty, the default will |
| 382 | // be used. |
| 383 | CurvePreferences []CurveID |
| 384 | |
Nick Harper | dcfbc67 | 2016-07-16 17:47:31 +0200 | [diff] [blame] | 385 | // DefaultCurves contains the elliptic curves for which public values will |
| 386 | // be sent in the ClientHello's KeyShare extension. If this value is nil, |
| 387 | // all supported curves will have public values sent. This field is ignored |
| 388 | // on servers. |
| 389 | DefaultCurves []CurveID |
| 390 | |
David Benjamin | d30a990 | 2014-08-24 01:44:23 -0400 | [diff] [blame] | 391 | // ChannelID contains the ECDSA key for the client to use as |
| 392 | // its TLS Channel ID. |
| 393 | ChannelID *ecdsa.PrivateKey |
| 394 | |
| 395 | // RequestChannelID controls whether the server requests a TLS |
| 396 | // Channel ID. If negotiated, the client's public key is |
| 397 | // returned in the ConnectionState. |
| 398 | RequestChannelID bool |
| 399 | |
David Benjamin | 48cae08 | 2014-10-27 01:06:24 -0400 | [diff] [blame] | 400 | // PreSharedKey, if not nil, is the pre-shared key to use with |
| 401 | // the PSK cipher suites. |
| 402 | PreSharedKey []byte |
| 403 | |
| 404 | // PreSharedKeyIdentity, if not empty, is the identity to use |
| 405 | // with the PSK cipher suites. |
| 406 | PreSharedKeyIdentity string |
| 407 | |
David Benjamin | ca6c826 | 2014-11-15 19:06:08 -0500 | [diff] [blame] | 408 | // SRTPProtectionProfiles, if not nil, is the list of SRTP |
| 409 | // protection profiles to offer in DTLS-SRTP. |
| 410 | SRTPProtectionProfiles []uint16 |
| 411 | |
David Benjamin | 7a41d37 | 2016-07-09 11:21:54 -0700 | [diff] [blame] | 412 | // SignSignatureAlgorithms, if not nil, overrides the default set of |
| 413 | // supported signature algorithms to sign with. |
| 414 | SignSignatureAlgorithms []signatureAlgorithm |
| 415 | |
| 416 | // VerifySignatureAlgorithms, if not nil, overrides the default set of |
| 417 | // supported signature algorithms that are accepted. |
| 418 | VerifySignatureAlgorithms []signatureAlgorithm |
David Benjamin | 000800a | 2014-11-14 01:43:59 -0500 | [diff] [blame] | 419 | |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 420 | // Bugs specifies optional misbehaviour to be used for testing other |
| 421 | // implementations. |
| 422 | Bugs ProtocolBugs |
| 423 | |
| 424 | serverInitOnce sync.Once // guards calling (*Config).serverInit |
| 425 | } |
| 426 | |
| 427 | type BadValue int |
| 428 | |
| 429 | const ( |
| 430 | BadValueNone BadValue = iota |
| 431 | BadValueNegative |
| 432 | BadValueZero |
| 433 | BadValueLimit |
| 434 | BadValueLarge |
| 435 | NumBadValues |
| 436 | ) |
| 437 | |
David Benjamin | b36a395 | 2015-12-01 18:53:13 -0500 | [diff] [blame] | 438 | type RSABadValue int |
| 439 | |
| 440 | const ( |
| 441 | RSABadValueNone RSABadValue = iota |
| 442 | RSABadValueCorrupt |
| 443 | RSABadValueTooLong |
| 444 | RSABadValueTooShort |
| 445 | RSABadValueWrongVersion |
| 446 | NumRSABadValues |
| 447 | ) |
| 448 | |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 449 | type ProtocolBugs struct { |
David Benjamin | 5208fd4 | 2016-07-13 21:43:25 -0400 | [diff] [blame] | 450 | // InvalidSignature specifies that the signature in a ServerKeyExchange |
| 451 | // or CertificateVerify message should be invalid. |
| 452 | InvalidSignature bool |
David Benjamin | 6de0e53 | 2015-07-28 22:43:19 -0400 | [diff] [blame] | 453 | |
Steven Valdez | 5440fe0 | 2016-07-18 12:40:30 -0400 | [diff] [blame] | 454 | // SendCurve, if non-zero, causes the server to send the specified curve |
| 455 | // ID in ServerKeyExchange (TLS 1.2) or ServerHello (TLS 1.3) rather |
| 456 | // than the negotiated one. |
David Benjamin | 4c3ddf7 | 2016-06-29 18:13:53 -0400 | [diff] [blame] | 457 | SendCurve CurveID |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 458 | |
Steven Valdez | 5440fe0 | 2016-07-18 12:40:30 -0400 | [diff] [blame] | 459 | // SendHelloRetryRequestCurve, if non-zero, causes the server to send |
| 460 | // the specified curve in HelloRetryRequest rather than the negotiated |
| 461 | // one. |
| 462 | SendHelloRetryRequestCurve CurveID |
| 463 | |
David Benjamin | 2b07fa4 | 2016-03-02 00:23:57 -0500 | [diff] [blame] | 464 | // InvalidECDHPoint, if true, causes the ECC points in |
| 465 | // ServerKeyExchange or ClientKeyExchange messages to be invalid. |
| 466 | InvalidECDHPoint bool |
| 467 | |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 468 | // BadECDSAR controls ways in which the 'r' value of an ECDSA signature |
| 469 | // can be invalid. |
| 470 | BadECDSAR BadValue |
| 471 | BadECDSAS BadValue |
Adam Langley | 80842bd | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 472 | |
| 473 | // MaxPadding causes CBC records to have the maximum possible padding. |
| 474 | MaxPadding bool |
| 475 | // PaddingFirstByteBad causes the first byte of the padding to be |
| 476 | // incorrect. |
| 477 | PaddingFirstByteBad bool |
| 478 | // PaddingFirstByteBadIf255 causes the first byte of padding to be |
| 479 | // incorrect if there's a maximum amount of padding (i.e. 255 bytes). |
| 480 | PaddingFirstByteBadIf255 bool |
Adam Langley | ac61fa3 | 2014-06-23 12:03:11 -0700 | [diff] [blame] | 481 | |
| 482 | // FailIfNotFallbackSCSV causes a server handshake to fail if the |
| 483 | // client doesn't send the fallback SCSV value. |
| 484 | FailIfNotFallbackSCSV bool |
David Benjamin | 35a7a44 | 2014-07-05 00:23:20 -0400 | [diff] [blame] | 485 | |
| 486 | // DuplicateExtension causes an extra empty extension of bogus type to |
| 487 | // be emitted in either the ClientHello or the ServerHello. |
| 488 | DuplicateExtension bool |
David Benjamin | 1c375dd | 2014-07-12 00:48:23 -0400 | [diff] [blame] | 489 | |
| 490 | // UnauthenticatedECDH causes the server to pretend ECDHE_RSA |
| 491 | // and ECDHE_ECDSA cipher suites are actually ECDH_anon. No |
| 492 | // Certificate message is sent and no signature is added to |
| 493 | // ServerKeyExchange. |
| 494 | UnauthenticatedECDH bool |
David Benjamin | 9c651c9 | 2014-07-12 13:27:45 -0400 | [diff] [blame] | 495 | |
David Benjamin | b80168e | 2015-02-08 18:30:14 -0500 | [diff] [blame] | 496 | // SkipHelloVerifyRequest causes a DTLS server to skip the |
| 497 | // HelloVerifyRequest message. |
| 498 | SkipHelloVerifyRequest bool |
| 499 | |
David Benjamin | dcd979f | 2015-04-20 18:26:52 -0400 | [diff] [blame] | 500 | // SkipCertificateStatus, if true, causes the server to skip the |
| 501 | // CertificateStatus message. This is legal because CertificateStatus is |
| 502 | // optional, even with a status_request in ServerHello. |
| 503 | SkipCertificateStatus bool |
| 504 | |
David Benjamin | 9c651c9 | 2014-07-12 13:27:45 -0400 | [diff] [blame] | 505 | // SkipServerKeyExchange causes the server to skip sending |
| 506 | // ServerKeyExchange messages. |
| 507 | SkipServerKeyExchange bool |
David Benjamin | a0e5223 | 2014-07-19 17:39:58 -0400 | [diff] [blame] | 508 | |
David Benjamin | b80168e | 2015-02-08 18:30:14 -0500 | [diff] [blame] | 509 | // SkipNewSessionTicket causes the server to skip sending the |
| 510 | // NewSessionTicket message despite promising to in ServerHello. |
| 511 | SkipNewSessionTicket bool |
| 512 | |
David Benjamin | 0b7ca7d | 2016-03-10 15:44:22 -0500 | [diff] [blame] | 513 | // SkipClientCertificate causes the client to skip the Certificate |
| 514 | // message. |
| 515 | SkipClientCertificate bool |
| 516 | |
David Benjamin | a0e5223 | 2014-07-19 17:39:58 -0400 | [diff] [blame] | 517 | // SkipChangeCipherSpec causes the implementation to skip |
| 518 | // sending the ChangeCipherSpec message (and adjusting cipher |
| 519 | // state accordingly for the Finished message). |
| 520 | SkipChangeCipherSpec bool |
David Benjamin | f3ec83d | 2014-07-21 22:42:34 -0400 | [diff] [blame] | 521 | |
David Benjamin | b80168e | 2015-02-08 18:30:14 -0500 | [diff] [blame] | 522 | // SkipFinished causes the implementation to skip sending the Finished |
| 523 | // message. |
| 524 | SkipFinished bool |
| 525 | |
David Benjamin | f3ec83d | 2014-07-21 22:42:34 -0400 | [diff] [blame] | 526 | // EarlyChangeCipherSpec causes the client to send an early |
| 527 | // ChangeCipherSpec message before the ClientKeyExchange. A value of |
| 528 | // zero disables this behavior. One and two configure variants for 0.9.8 |
| 529 | // and 1.0.1 modes, respectively. |
| 530 | EarlyChangeCipherSpec int |
David Benjamin | d23f412 | 2014-07-23 15:09:48 -0400 | [diff] [blame] | 531 | |
David Benjamin | 8144f99 | 2016-06-22 17:05:13 -0400 | [diff] [blame] | 532 | // StrayChangeCipherSpec causes every pre-ChangeCipherSpec handshake |
| 533 | // message in DTLS to be prefaced by stray ChangeCipherSpec record. This |
| 534 | // may be used to test DTLS's handling of reordered ChangeCipherSpec. |
| 535 | StrayChangeCipherSpec bool |
| 536 | |
David Benjamin | 86271ee | 2014-07-21 16:14:03 -0400 | [diff] [blame] | 537 | // FragmentAcrossChangeCipherSpec causes the implementation to fragment |
| 538 | // the Finished (or NextProto) message around the ChangeCipherSpec |
| 539 | // messages. |
| 540 | FragmentAcrossChangeCipherSpec bool |
| 541 | |
David Benjamin | 6167281 | 2016-07-14 23:10:43 -0400 | [diff] [blame] | 542 | // SendUnencryptedFinished, if true, causes the Finished message to be |
| 543 | // send unencrypted before ChangeCipherSpec rather than after it. |
| 544 | SendUnencryptedFinished bool |
| 545 | |
David Benjamin | 7964b18 | 2016-07-14 23:36:30 -0400 | [diff] [blame] | 546 | // PartialEncryptedExtensionsWithServerHello, if true, causes the TLS |
| 547 | // 1.3 server to send part of EncryptedExtensions unencrypted |
| 548 | // in the same record as ServerHello. |
| 549 | PartialEncryptedExtensionsWithServerHello bool |
| 550 | |
| 551 | // PartialClientFinishedWithClientHello, if true, causes the TLS 1.3 |
| 552 | // client to send part of Finished unencrypted in the same record as |
| 553 | // ClientHello. |
| 554 | PartialClientFinishedWithClientHello bool |
| 555 | |
David Benjamin | d86c767 | 2014-08-02 04:07:12 -0400 | [diff] [blame] | 556 | // SendV2ClientHello causes the client to send a V2ClientHello |
| 557 | // instead of a normal ClientHello. |
| 558 | SendV2ClientHello bool |
David Benjamin | bef270a | 2014-08-02 04:22:02 -0400 | [diff] [blame] | 559 | |
| 560 | // SendFallbackSCSV causes the client to include |
| 561 | // TLS_FALLBACK_SCSV in the ClientHello. |
| 562 | SendFallbackSCSV bool |
David Benjamin | 43ec06f | 2014-08-05 02:28:57 -0400 | [diff] [blame] | 563 | |
Adam Langley | 5021b22 | 2015-06-12 18:27:58 -0700 | [diff] [blame] | 564 | // SendRenegotiationSCSV causes the client to include the renegotiation |
| 565 | // SCSV in the ClientHello. |
| 566 | SendRenegotiationSCSV bool |
| 567 | |
David Benjamin | 43ec06f | 2014-08-05 02:28:57 -0400 | [diff] [blame] | 568 | // MaxHandshakeRecordLength, if non-zero, is the maximum size of a |
David Benjamin | 9821454 | 2014-08-07 18:02:39 -0400 | [diff] [blame] | 569 | // handshake record. Handshake messages will be split into multiple |
| 570 | // records at the specified size, except that the client_version will |
David Benjamin | bd15a8e | 2015-05-29 18:48:16 -0400 | [diff] [blame] | 571 | // never be fragmented. For DTLS, it is the maximum handshake fragment |
| 572 | // size, not record size; DTLS allows multiple handshake fragments in a |
| 573 | // single handshake record. See |PackHandshakeFragments|. |
David Benjamin | 43ec06f | 2014-08-05 02:28:57 -0400 | [diff] [blame] | 574 | MaxHandshakeRecordLength int |
David Benjamin | a8e3e0e | 2014-08-06 22:11:10 -0400 | [diff] [blame] | 575 | |
David Benjamin | 9821454 | 2014-08-07 18:02:39 -0400 | [diff] [blame] | 576 | // FragmentClientVersion will allow MaxHandshakeRecordLength to apply to |
| 577 | // the first 6 bytes of the ClientHello. |
| 578 | FragmentClientVersion bool |
| 579 | |
Alex Chernyakhovsky | 4cd8c43 | 2014-11-01 19:39:08 -0400 | [diff] [blame] | 580 | // FragmentAlert will cause all alerts to be fragmented across |
| 581 | // two records. |
| 582 | FragmentAlert bool |
| 583 | |
David Benjamin | 0d3a8c6 | 2016-03-11 22:25:18 -0500 | [diff] [blame] | 584 | // DoubleAlert will cause all alerts to be sent as two copies packed |
| 585 | // within one record. |
| 586 | DoubleAlert bool |
| 587 | |
David Benjamin | 3fd1fbd | 2015-02-03 16:07:32 -0500 | [diff] [blame] | 588 | // SendSpuriousAlert, if non-zero, will cause an spurious, unwanted |
| 589 | // alert to be sent. |
| 590 | SendSpuriousAlert alert |
Alex Chernyakhovsky | 4cd8c43 | 2014-11-01 19:39:08 -0400 | [diff] [blame] | 591 | |
David Benjamin | b36a395 | 2015-12-01 18:53:13 -0500 | [diff] [blame] | 592 | // BadRSAClientKeyExchange causes the client to send a corrupted RSA |
| 593 | // ClientKeyExchange which would not pass padding checks. |
| 594 | BadRSAClientKeyExchange RSABadValue |
David Benjamin | bed9aae | 2014-08-07 19:13:38 -0400 | [diff] [blame] | 595 | |
| 596 | // RenewTicketOnResume causes the server to renew the session ticket and |
| 597 | // send a NewSessionTicket message during an abbreviated handshake. |
| 598 | RenewTicketOnResume bool |
David Benjamin | 98e882e | 2014-08-08 13:24:34 -0400 | [diff] [blame] | 599 | |
| 600 | // SendClientVersion, if non-zero, causes the client to send a different |
| 601 | // TLS version in the ClientHello than the maximum supported version. |
| 602 | SendClientVersion uint16 |
David Benjamin | 83c0bc9 | 2014-08-04 01:23:53 -0400 | [diff] [blame] | 603 | |
David Benjamin | 1f61f0d | 2016-07-10 12:20:35 -0400 | [diff] [blame] | 604 | // NegotiateVersion, if non-zero, causes the server to negotiate the |
| 605 | // specifed TLS version rather than the version supported by either |
| 606 | // peer. |
| 607 | NegotiateVersion uint16 |
| 608 | |
David Benjamin | e7e36aa | 2016-08-08 12:39:41 -0400 | [diff] [blame] | 609 | // NegotiateVersionOnRenego, if non-zero, causes the server to negotiate |
| 610 | // the specified TLS version on renegotiation rather than retaining it. |
| 611 | NegotiateVersionOnRenego uint16 |
| 612 | |
David Benjamin | e58c4f5 | 2014-08-24 03:47:07 -0400 | [diff] [blame] | 613 | // ExpectFalseStart causes the server to, on full handshakes, |
| 614 | // expect the peer to False Start; the server Finished message |
| 615 | // isn't sent until we receive an application data record |
| 616 | // from the peer. |
| 617 | ExpectFalseStart bool |
David Benjamin | 5c24a1d | 2014-08-31 00:59:27 -0400 | [diff] [blame] | 618 | |
David Benjamin | 1c63315 | 2015-04-02 20:19:11 -0400 | [diff] [blame] | 619 | // AlertBeforeFalseStartTest, if non-zero, causes the server to, on full |
| 620 | // handshakes, send an alert just before reading the application data |
| 621 | // record to test False Start. This can be used in a negative False |
| 622 | // Start test to determine whether the peer processed the alert (and |
| 623 | // closed the connection) before or after sending app data. |
| 624 | AlertBeforeFalseStartTest alert |
| 625 | |
David Benjamin | e78bfde | 2014-09-06 12:45:15 -0400 | [diff] [blame] | 626 | // ExpectServerName, if not empty, is the hostname the client |
| 627 | // must specify in the server_name extension. |
| 628 | ExpectServerName string |
David Benjamin | fc7b086 | 2014-09-06 13:21:53 -0400 | [diff] [blame] | 629 | |
David Benjamin | 76c2efc | 2015-08-31 14:24:29 -0400 | [diff] [blame] | 630 | // SwapNPNAndALPN switches the relative order between NPN and ALPN in |
| 631 | // both ClientHello and ServerHello. |
David Benjamin | fc7b086 | 2014-09-06 13:21:53 -0400 | [diff] [blame] | 632 | SwapNPNAndALPN bool |
David Benjamin | 01fe820 | 2014-09-24 15:21:44 -0400 | [diff] [blame] | 633 | |
Adam Langley | efb0e16 | 2015-07-09 11:35:04 -0700 | [diff] [blame] | 634 | // ALPNProtocol, if not nil, sets the ALPN protocol that a server will |
| 635 | // return. |
| 636 | ALPNProtocol *string |
| 637 | |
David Benjamin | 405da48 | 2016-08-08 17:25:07 -0400 | [diff] [blame] | 638 | // AcceptAnySession causes the server to resume sessions regardless of |
| 639 | // the version associated with the session or cipher suite. It also |
| 640 | // causes the server to look in both TLS 1.2 and 1.3 extensions to |
| 641 | // process a ticket. |
| 642 | AcceptAnySession bool |
| 643 | |
| 644 | // SendBothTickets, if true, causes the client to send tickets in both |
| 645 | // TLS 1.2 and 1.3 extensions. |
| 646 | SendBothTickets bool |
Adam Langley | 3831173 | 2014-10-16 19:04:35 -0700 | [diff] [blame] | 647 | |
| 648 | // CorruptTicket causes a client to corrupt a session ticket before |
| 649 | // sending it in a resume handshake. |
| 650 | CorruptTicket bool |
| 651 | |
| 652 | // OversizedSessionId causes the session id that is sent with a ticket |
| 653 | // resumption attempt to be too large (33 bytes). |
| 654 | OversizedSessionId bool |
Adam Langley | 7571292 | 2014-10-10 16:23:43 -0700 | [diff] [blame] | 655 | |
David Benjamin | 405da48 | 2016-08-08 17:25:07 -0400 | [diff] [blame] | 656 | // ExpectNoTLS12Session, if true, causes the server to fail the |
| 657 | // connection if either a session ID or TLS 1.2 ticket is offered. |
| 658 | ExpectNoTLS12Session bool |
| 659 | |
| 660 | // ExpectNoTLS13PSK, if true, causes the server to fail the connection |
| 661 | // if a TLS 1.3 PSK is offered. |
| 662 | ExpectNoTLS13PSK bool |
| 663 | |
Adam Langley | 7571292 | 2014-10-10 16:23:43 -0700 | [diff] [blame] | 664 | // RequireExtendedMasterSecret, if true, requires that the peer support |
| 665 | // the extended master secret option. |
| 666 | RequireExtendedMasterSecret bool |
| 667 | |
David Benjamin | ca6554b | 2014-11-08 12:31:52 -0500 | [diff] [blame] | 668 | // NoExtendedMasterSecret causes the client and server to behave as if |
Adam Langley | 7571292 | 2014-10-10 16:23:43 -0700 | [diff] [blame] | 669 | // they didn't support an extended master secret. |
| 670 | NoExtendedMasterSecret bool |
Adam Langley | 2ae77d2 | 2014-10-28 17:29:33 -0700 | [diff] [blame] | 671 | |
| 672 | // EmptyRenegotiationInfo causes the renegotiation extension to be |
| 673 | // empty in a renegotiation handshake. |
| 674 | EmptyRenegotiationInfo bool |
| 675 | |
| 676 | // BadRenegotiationInfo causes the renegotiation extension value in a |
| 677 | // renegotiation handshake to be incorrect. |
| 678 | BadRenegotiationInfo bool |
David Benjamin | 5e961c1 | 2014-11-07 01:48:35 -0500 | [diff] [blame] | 679 | |
David Benjamin | 3e052de | 2015-11-25 20:10:31 -0500 | [diff] [blame] | 680 | // NoRenegotiationInfo disables renegotiation info support in all |
| 681 | // handshakes. |
David Benjamin | ca6554b | 2014-11-08 12:31:52 -0500 | [diff] [blame] | 682 | NoRenegotiationInfo bool |
| 683 | |
David Benjamin | 3e052de | 2015-11-25 20:10:31 -0500 | [diff] [blame] | 684 | // NoRenegotiationInfoInInitial disables renegotiation info support in |
| 685 | // the initial handshake. |
| 686 | NoRenegotiationInfoInInitial bool |
| 687 | |
| 688 | // NoRenegotiationInfoAfterInitial disables renegotiation info support |
| 689 | // in renegotiation handshakes. |
| 690 | NoRenegotiationInfoAfterInitial bool |
| 691 | |
Adam Langley | 5021b22 | 2015-06-12 18:27:58 -0700 | [diff] [blame] | 692 | // RequireRenegotiationInfo, if true, causes the client to return an |
| 693 | // error if the server doesn't reply with the renegotiation extension. |
| 694 | RequireRenegotiationInfo bool |
| 695 | |
David Benjamin | 8e6db49 | 2015-07-25 18:29:23 -0400 | [diff] [blame] | 696 | // SequenceNumberMapping, if non-nil, is the mapping function to apply |
| 697 | // to the sequence number of outgoing packets. For both TLS and DTLS, |
| 698 | // the two most-significant bytes in the resulting sequence number are |
| 699 | // ignored so that the DTLS epoch cannot be changed. |
| 700 | SequenceNumberMapping func(uint64) uint64 |
David Benjamin | 9114fae | 2014-11-08 11:41:14 -0500 | [diff] [blame] | 701 | |
David Benjamin | a3e8949 | 2015-02-26 15:16:22 -0500 | [diff] [blame] | 702 | // RSAEphemeralKey, if true, causes the server to send a |
| 703 | // ServerKeyExchange message containing an ephemeral key (as in |
| 704 | // RSA_EXPORT) in the plain RSA key exchange. |
| 705 | RSAEphemeralKey bool |
David Benjamin | ca6c826 | 2014-11-15 19:06:08 -0500 | [diff] [blame] | 706 | |
| 707 | // SRTPMasterKeyIdentifer, if not empty, is the SRTP MKI value that the |
| 708 | // client offers when negotiating SRTP. MKI support is still missing so |
| 709 | // the peer must still send none. |
| 710 | SRTPMasterKeyIdentifer string |
| 711 | |
| 712 | // SendSRTPProtectionProfile, if non-zero, is the SRTP profile that the |
| 713 | // server sends in the ServerHello instead of the negotiated one. |
| 714 | SendSRTPProtectionProfile uint16 |
David Benjamin | 000800a | 2014-11-14 01:43:59 -0500 | [diff] [blame] | 715 | |
Nick Harper | 60edffd | 2016-06-21 15:19:24 -0700 | [diff] [blame] | 716 | // NoSignatureAlgorithms, if true, causes the client to omit the |
David Benjamin | 000800a | 2014-11-14 01:43:59 -0500 | [diff] [blame] | 717 | // signature and hashes extension. |
| 718 | // |
| 719 | // For a server, it will cause an empty list to be sent in the |
| 720 | // CertificateRequest message. None the less, the configured set will |
| 721 | // still be enforced. |
Nick Harper | 60edffd | 2016-06-21 15:19:24 -0700 | [diff] [blame] | 722 | NoSignatureAlgorithms bool |
David Benjamin | c44b1df | 2014-11-23 12:11:01 -0500 | [diff] [blame] | 723 | |
David Benjamin | 55a4364 | 2015-04-20 14:45:55 -0400 | [diff] [blame] | 724 | // NoSupportedCurves, if true, causes the client to omit the |
| 725 | // supported_curves extension. |
| 726 | NoSupportedCurves bool |
| 727 | |
David Benjamin | c44b1df | 2014-11-23 12:11:01 -0500 | [diff] [blame] | 728 | // RequireSameRenegoClientVersion, if true, causes the server |
| 729 | // to require that all ClientHellos match in offered version |
| 730 | // across a renego. |
| 731 | RequireSameRenegoClientVersion bool |
Feng Lu | 41aa325 | 2014-11-21 22:47:56 -0800 | [diff] [blame] | 732 | |
David Benjamin | 1e29a6b | 2014-12-10 02:27:24 -0500 | [diff] [blame] | 733 | // ExpectInitialRecordVersion, if non-zero, is the expected |
| 734 | // version of the records before the version is determined. |
| 735 | ExpectInitialRecordVersion uint16 |
David Benjamin | 13be1de | 2015-01-11 16:29:36 -0500 | [diff] [blame] | 736 | |
| 737 | // MaxPacketLength, if non-zero, is the maximum acceptable size for a |
| 738 | // packet. |
| 739 | MaxPacketLength int |
David Benjamin | 6095de8 | 2014-12-27 01:50:38 -0500 | [diff] [blame] | 740 | |
| 741 | // SendCipherSuite, if non-zero, is the cipher suite value that the |
| 742 | // server will send in the ServerHello. This does not affect the cipher |
| 743 | // the server believes it has actually negotiated. |
| 744 | SendCipherSuite uint16 |
David Benjamin | 4189bd9 | 2015-01-25 23:52:39 -0500 | [diff] [blame] | 745 | |
David Benjamin | 4cf369b | 2015-08-22 01:35:43 -0400 | [diff] [blame] | 746 | // AppDataBeforeHandshake, if not nil, causes application data to be |
| 747 | // sent immediately before the first handshake message. |
| 748 | AppDataBeforeHandshake []byte |
| 749 | |
| 750 | // AppDataAfterChangeCipherSpec, if not nil, causes application data to |
David Benjamin | 4189bd9 | 2015-01-25 23:52:39 -0500 | [diff] [blame] | 751 | // be sent immediately after ChangeCipherSpec. |
| 752 | AppDataAfterChangeCipherSpec []byte |
David Benjamin | 83f9040 | 2015-01-27 01:09:43 -0500 | [diff] [blame] | 753 | |
David Benjamin | dc3da93 | 2015-03-12 15:09:02 -0400 | [diff] [blame] | 754 | // AlertAfterChangeCipherSpec, if non-zero, causes an alert to be sent |
| 755 | // immediately after ChangeCipherSpec. |
| 756 | AlertAfterChangeCipherSpec alert |
| 757 | |
David Benjamin | 83f9040 | 2015-01-27 01:09:43 -0500 | [diff] [blame] | 758 | // TimeoutSchedule is the schedule of packet drops and simulated |
| 759 | // timeouts for before each handshake leg from the peer. |
| 760 | TimeoutSchedule []time.Duration |
| 761 | |
| 762 | // PacketAdaptor is the packetAdaptor to use to simulate timeouts. |
| 763 | PacketAdaptor *packetAdaptor |
David Benjamin | b3774b9 | 2015-01-31 17:16:01 -0500 | [diff] [blame] | 764 | |
| 765 | // ReorderHandshakeFragments, if true, causes handshake fragments in |
| 766 | // DTLS to overlap and be sent in the wrong order. It also causes |
| 767 | // pre-CCS flights to be sent twice. (Post-CCS flights consist of |
| 768 | // Finished and will trigger a spurious retransmit.) |
| 769 | ReorderHandshakeFragments bool |
David Benjamin | ddb9f15 | 2015-02-03 15:44:39 -0500 | [diff] [blame] | 770 | |
David Benjamin | 6167281 | 2016-07-14 23:10:43 -0400 | [diff] [blame] | 771 | // ReverseHandshakeFragments, if true, causes handshake fragments in |
| 772 | // DTLS to be reversed within a flight. |
| 773 | ReverseHandshakeFragments bool |
| 774 | |
David Benjamin | 7538122 | 2015-03-02 19:30:30 -0500 | [diff] [blame] | 775 | // MixCompleteMessageWithFragments, if true, causes handshake |
| 776 | // messages in DTLS to redundantly both fragment the message |
| 777 | // and include a copy of the full one. |
| 778 | MixCompleteMessageWithFragments bool |
| 779 | |
David Benjamin | ddb9f15 | 2015-02-03 15:44:39 -0500 | [diff] [blame] | 780 | // SendInvalidRecordType, if true, causes a record with an invalid |
| 781 | // content type to be sent immediately following the handshake. |
| 782 | SendInvalidRecordType bool |
David Benjamin | bcb2d91 | 2015-02-24 23:45:43 -0500 | [diff] [blame] | 783 | |
David Benjamin | 0b8d5da | 2016-07-15 00:39:56 -0400 | [diff] [blame] | 784 | // SendWrongMessageType, if non-zero, causes messages of the specified |
| 785 | // type to be sent with the wrong value. |
| 786 | SendWrongMessageType byte |
David Benjamin | 7538122 | 2015-03-02 19:30:30 -0500 | [diff] [blame] | 787 | |
| 788 | // FragmentMessageTypeMismatch, if true, causes all non-initial |
| 789 | // handshake fragments in DTLS to have the wrong message type. |
| 790 | FragmentMessageTypeMismatch bool |
| 791 | |
| 792 | // FragmentMessageLengthMismatch, if true, causes all non-initial |
| 793 | // handshake fragments in DTLS to have the wrong message length. |
| 794 | FragmentMessageLengthMismatch bool |
| 795 | |
David Benjamin | 11fc66a | 2015-06-16 11:40:24 -0400 | [diff] [blame] | 796 | // SplitFragments, if non-zero, causes the handshake fragments in DTLS |
| 797 | // to be split across two records. The value of |SplitFragments| is the |
| 798 | // number of bytes in the first fragment. |
| 799 | SplitFragments int |
David Benjamin | 7538122 | 2015-03-02 19:30:30 -0500 | [diff] [blame] | 800 | |
| 801 | // SendEmptyFragments, if true, causes handshakes to include empty |
| 802 | // fragments in DTLS. |
| 803 | SendEmptyFragments bool |
David Benjamin | cdea40c | 2015-03-19 14:09:43 -0400 | [diff] [blame] | 804 | |
David Benjamin | 9a41d1b | 2015-05-16 01:30:09 -0400 | [diff] [blame] | 805 | // SendSplitAlert, if true, causes an alert to be sent with the header |
| 806 | // and record body split across multiple packets. The peer should |
| 807 | // discard these packets rather than process it. |
| 808 | SendSplitAlert bool |
| 809 | |
David Benjamin | 4b27d9f | 2015-05-12 22:42:52 -0400 | [diff] [blame] | 810 | // FailIfResumeOnRenego, if true, causes renegotiations to fail if the |
| 811 | // client offers a resumption or the server accepts one. |
| 812 | FailIfResumeOnRenego bool |
David Benjamin | 3c9746a | 2015-03-19 15:00:10 -0400 | [diff] [blame] | 813 | |
David Benjamin | 67d1fb5 | 2015-03-16 15:16:23 -0400 | [diff] [blame] | 814 | // IgnorePeerCipherPreferences, if true, causes the peer's cipher |
| 815 | // preferences to be ignored. |
| 816 | IgnorePeerCipherPreferences bool |
David Benjamin | 72dc783 | 2015-03-16 17:49:43 -0400 | [diff] [blame] | 817 | |
| 818 | // IgnorePeerSignatureAlgorithmPreferences, if true, causes the peer's |
| 819 | // signature algorithm preferences to be ignored. |
| 820 | IgnorePeerSignatureAlgorithmPreferences bool |
David Benjamin | 340d5ed | 2015-03-21 02:21:37 -0400 | [diff] [blame] | 821 | |
David Benjamin | c574f41 | 2015-04-20 11:13:01 -0400 | [diff] [blame] | 822 | // IgnorePeerCurvePreferences, if true, causes the peer's curve |
| 823 | // preferences to be ignored. |
| 824 | IgnorePeerCurvePreferences bool |
| 825 | |
David Benjamin | 513f0ea | 2015-04-02 19:33:31 -0400 | [diff] [blame] | 826 | // BadFinished, if true, causes the Finished hash to be broken. |
| 827 | BadFinished bool |
Adam Langley | a7997f1 | 2015-05-14 17:38:50 -0700 | [diff] [blame] | 828 | |
| 829 | // DHGroupPrime, if not nil, is used to define the (finite field) |
| 830 | // Diffie-Hellman group. The generator used is always two. |
| 831 | DHGroupPrime *big.Int |
David Benjamin | bd15a8e | 2015-05-29 18:48:16 -0400 | [diff] [blame] | 832 | |
David Benjamin | 582ba04 | 2016-07-07 12:33:25 -0700 | [diff] [blame] | 833 | // PackHandshakeFragments, if true, causes handshake fragments in DTLS |
| 834 | // to be packed into individual handshake records, up to the specified |
| 835 | // record size. |
David Benjamin | bd15a8e | 2015-05-29 18:48:16 -0400 | [diff] [blame] | 836 | PackHandshakeFragments int |
| 837 | |
David Benjamin | 582ba04 | 2016-07-07 12:33:25 -0700 | [diff] [blame] | 838 | // PackHandshakeRecords, if true, causes handshake records in DTLS to be |
| 839 | // packed into individual packets, up to the specified packet size. |
David Benjamin | bd15a8e | 2015-05-29 18:48:16 -0400 | [diff] [blame] | 840 | PackHandshakeRecords int |
David Benjamin | 0fa4012 | 2015-05-30 17:13:12 -0400 | [diff] [blame] | 841 | |
David Benjamin | 582ba04 | 2016-07-07 12:33:25 -0700 | [diff] [blame] | 842 | // PackHandshakeFlight, if true, causes each handshake flight in TLS to |
| 843 | // be packed into records, up to the largest size record available. |
| 844 | PackHandshakeFlight bool |
| 845 | |
David Benjamin | 0407e76 | 2016-06-17 16:41:18 -0400 | [diff] [blame] | 846 | // EnableAllCiphers, if true, causes all configured ciphers to be |
| 847 | // enabled. |
| 848 | EnableAllCiphers bool |
David Benjamin | 8923c0b | 2015-06-07 11:42:34 -0400 | [diff] [blame] | 849 | |
| 850 | // EmptyCertificateList, if true, causes the server to send an empty |
| 851 | // certificate list in the Certificate message. |
| 852 | EmptyCertificateList bool |
David Benjamin | d98452d | 2015-06-16 14:16:23 -0400 | [diff] [blame] | 853 | |
| 854 | // ExpectNewTicket, if true, causes the client to abort if it does not |
| 855 | // receive a new ticket. |
| 856 | ExpectNewTicket bool |
Adam Langley | 33ad2b5 | 2015-07-20 17:43:53 -0700 | [diff] [blame] | 857 | |
| 858 | // RequireClientHelloSize, if not zero, is the required length in bytes |
| 859 | // of the ClientHello /record/. This is checked by the server. |
| 860 | RequireClientHelloSize int |
Adam Langley | 0950563 | 2015-07-30 18:10:13 -0700 | [diff] [blame] | 861 | |
| 862 | // CustomExtension, if not empty, contains the contents of an extension |
| 863 | // that will be added to client/server hellos. |
| 864 | CustomExtension string |
| 865 | |
| 866 | // ExpectedCustomExtension, if not nil, contains the expected contents |
| 867 | // of a custom extension. |
| 868 | ExpectedCustomExtension *string |
David Benjamin | 30789da | 2015-08-29 22:56:45 -0400 | [diff] [blame] | 869 | |
| 870 | // NoCloseNotify, if true, causes the close_notify alert to be skipped |
| 871 | // on connection shutdown. |
| 872 | NoCloseNotify bool |
| 873 | |
David Benjamin | fa214e4 | 2016-05-10 17:03:10 -0400 | [diff] [blame] | 874 | // SendAlertOnShutdown, if non-zero, is the alert to send instead of |
| 875 | // close_notify on shutdown. |
| 876 | SendAlertOnShutdown alert |
| 877 | |
David Benjamin | 30789da | 2015-08-29 22:56:45 -0400 | [diff] [blame] | 878 | // ExpectCloseNotify, if true, requires a close_notify from the peer on |
| 879 | // shutdown. Records from the peer received after close_notify is sent |
| 880 | // are not discard. |
| 881 | ExpectCloseNotify bool |
David Benjamin | 2c99d28 | 2015-09-01 10:23:00 -0400 | [diff] [blame] | 882 | |
| 883 | // SendLargeRecords, if true, allows outgoing records to be sent |
| 884 | // arbitrarily large. |
| 885 | SendLargeRecords bool |
David Benjamin | 76c2efc | 2015-08-31 14:24:29 -0400 | [diff] [blame] | 886 | |
| 887 | // NegotiateALPNAndNPN, if true, causes the server to negotiate both |
| 888 | // ALPN and NPN in the same connetion. |
| 889 | NegotiateALPNAndNPN bool |
David Benjamin | dd6fed9 | 2015-10-23 17:41:12 -0400 | [diff] [blame] | 890 | |
David Benjamin | 0c40a96 | 2016-08-01 12:05:50 -0400 | [diff] [blame] | 891 | // SendALPN, if non-empty, causes the server to send the specified |
David Benjamin | 3e51757 | 2016-08-11 11:52:23 -0400 | [diff] [blame] | 892 | // string in the ALPN extension regardless of the content or presence of |
| 893 | // the client offer. |
David Benjamin | 0c40a96 | 2016-08-01 12:05:50 -0400 | [diff] [blame] | 894 | SendALPN string |
| 895 | |
David Benjamin | dd6fed9 | 2015-10-23 17:41:12 -0400 | [diff] [blame] | 896 | // SendEmptySessionTicket, if true, causes the server to send an empty |
| 897 | // session ticket. |
| 898 | SendEmptySessionTicket bool |
| 899 | |
| 900 | // FailIfSessionOffered, if true, causes the server to fail any |
| 901 | // connections where the client offers a non-empty session ID or session |
| 902 | // ticket. |
| 903 | FailIfSessionOffered bool |
Adam Langley | 27a0d08 | 2015-11-03 13:34:10 -0800 | [diff] [blame] | 904 | |
| 905 | // SendHelloRequestBeforeEveryAppDataRecord, if true, causes a |
| 906 | // HelloRequest handshake message to be sent before each application |
| 907 | // data record. This only makes sense for a server. |
| 908 | SendHelloRequestBeforeEveryAppDataRecord bool |
Adam Langley | c4f25ce | 2015-11-26 16:39:08 -0800 | [diff] [blame] | 909 | |
David Benjamin | 71dd666 | 2016-07-08 14:10:48 -0700 | [diff] [blame] | 910 | // SendHelloRequestBeforeEveryHandshakeMessage, if true, causes a |
| 911 | // HelloRequest handshake message to be sent before each handshake |
| 912 | // message. This only makes sense for a server. |
| 913 | SendHelloRequestBeforeEveryHandshakeMessage bool |
| 914 | |
Steven Valdez | 1dc53d2 | 2016-07-26 12:27:38 -0400 | [diff] [blame] | 915 | // SendKeyUpdateBeforeEveryAppDataRecord, if true, causes a KeyUpdate |
| 916 | // handshake message to be sent before each application data record. |
| 917 | SendKeyUpdateBeforeEveryAppDataRecord bool |
| 918 | |
Adam Langley | c4f25ce | 2015-11-26 16:39:08 -0800 | [diff] [blame] | 919 | // RequireDHPublicValueLen causes a fatal error if the length (in |
| 920 | // bytes) of the server's Diffie-Hellman public value is not equal to |
| 921 | // this. |
| 922 | RequireDHPublicValueLen int |
David Benjamin | 8411b24 | 2015-11-26 12:07:28 -0500 | [diff] [blame] | 923 | |
| 924 | // BadChangeCipherSpec, if not nil, is the body to be sent in |
| 925 | // ChangeCipherSpec records instead of {1}. |
| 926 | BadChangeCipherSpec []byte |
David Benjamin | ef5dfd2 | 2015-12-06 13:17:07 -0500 | [diff] [blame] | 927 | |
| 928 | // BadHelloRequest, if not nil, is what to send instead of a |
| 929 | // HelloRequest. |
| 930 | BadHelloRequest []byte |
David Benjamin | ef1b009 | 2015-11-21 14:05:44 -0500 | [diff] [blame] | 931 | |
| 932 | // RequireSessionTickets, if true, causes the client to require new |
| 933 | // sessions use session tickets instead of session IDs. |
| 934 | RequireSessionTickets bool |
David Benjamin | f2b8363 | 2016-03-01 22:57:46 -0500 | [diff] [blame] | 935 | |
| 936 | // NullAllCiphers, if true, causes every cipher to behave like the null |
| 937 | // cipher. |
| 938 | NullAllCiphers bool |
David Benjamin | 80d1b35 | 2016-05-04 19:19:06 -0400 | [diff] [blame] | 939 | |
| 940 | // SendSCTListOnResume, if not nil, causes the server to send the |
| 941 | // supplied SCT list in resumption handshakes. |
| 942 | SendSCTListOnResume []byte |
Matt Braithwaite | 54217e4 | 2016-06-13 13:03:47 -0700 | [diff] [blame] | 943 | |
| 944 | // CECPQ1BadX25519Part corrupts the X25519 part of a CECPQ1 key exchange, as |
| 945 | // a trivial proof that it is actually used. |
| 946 | CECPQ1BadX25519Part bool |
| 947 | |
| 948 | // CECPQ1BadNewhopePart corrupts the Newhope part of a CECPQ1 key exchange, |
| 949 | // as a trivial proof that it is actually used. |
| 950 | CECPQ1BadNewhopePart bool |
David Benjamin | c9ae27c | 2016-06-24 22:56:37 -0400 | [diff] [blame] | 951 | |
| 952 | // RecordPadding is the number of bytes of padding to add to each |
| 953 | // encrypted record in TLS 1.3. |
| 954 | RecordPadding int |
| 955 | |
| 956 | // OmitRecordContents, if true, causes encrypted records in TLS 1.3 to |
| 957 | // be missing their body and content type. Padding, if configured, is |
| 958 | // still added. |
| 959 | OmitRecordContents bool |
| 960 | |
| 961 | // OuterRecordType, if non-zero, is the outer record type to use instead |
| 962 | // of application data. |
| 963 | OuterRecordType recordType |
David Benjamin | a95e9f3 | 2016-07-08 16:28:04 -0700 | [diff] [blame] | 964 | |
| 965 | // SendSignatureAlgorithm, if non-zero, causes all signatures to be sent |
| 966 | // with the given signature algorithm rather than the one negotiated. |
| 967 | SendSignatureAlgorithm signatureAlgorithm |
David Benjamin | 1fb125c | 2016-07-08 18:52:12 -0700 | [diff] [blame] | 968 | |
| 969 | // SkipECDSACurveCheck, if true, causes all ECDSA curve checks to be |
| 970 | // skipped. |
| 971 | SkipECDSACurveCheck bool |
David Benjamin | fd5c45f | 2016-06-30 18:30:40 -0400 | [diff] [blame] | 972 | |
| 973 | // IgnoreSignatureVersionChecks, if true, causes all signature |
| 974 | // algorithms to be enabled at all TLS versions. |
| 975 | IgnoreSignatureVersionChecks bool |
Steven Valdez | 143e8b3 | 2016-07-11 13:19:03 -0400 | [diff] [blame] | 976 | |
| 977 | // NegotiateRenegotiationInfoAtAllVersions, if true, causes |
| 978 | // Renegotiation Info to be negotiated at all versions. |
| 979 | NegotiateRenegotiationInfoAtAllVersions bool |
| 980 | |
| 981 | // NegotiateChannelIDAtAllVersions, if true, causes Channel ID to be |
| 982 | // negotiated at all versions. |
| 983 | NegotiateChannelIDAtAllVersions bool |
| 984 | |
| 985 | // NegotiateNPNAtAllVersions, if true, causes NPN to be negotiated at |
| 986 | // all versions. |
| 987 | NegotiateNPNAtAllVersions bool |
| 988 | |
| 989 | // NegotiateEMSAtAllVersions, if true, causes EMS to be negotiated at |
| 990 | // all versions. |
| 991 | NegotiateEMSAtAllVersions bool |
| 992 | |
| 993 | // AdvertiseTicketExtension, if true, causes the ticket extension to be |
| 994 | // advertised in server extensions |
| 995 | AdvertiseTicketExtension bool |
| 996 | |
| 997 | // MissingKeyShare, if true, causes the TLS 1.3 implementation to skip |
| 998 | // sending a key_share extension and use the zero ECDHE secret |
| 999 | // instead. |
| 1000 | MissingKeyShare bool |
| 1001 | |
Steven Valdez | 5440fe0 | 2016-07-18 12:40:30 -0400 | [diff] [blame] | 1002 | // SecondClientHelloMissingKeyShare, if true, causes the second TLS 1.3 |
| 1003 | // ClientHello to skip sending a key_share extension and use the zero |
| 1004 | // ECDHE secret instead. |
| 1005 | SecondClientHelloMissingKeyShare bool |
| 1006 | |
| 1007 | // MisinterpretHelloRetryRequestCurve, if non-zero, causes the TLS 1.3 |
| 1008 | // client to pretend the server requested a HelloRetryRequest with the |
| 1009 | // given curve rather than the actual one. |
| 1010 | MisinterpretHelloRetryRequestCurve CurveID |
| 1011 | |
Steven Valdez | 143e8b3 | 2016-07-11 13:19:03 -0400 | [diff] [blame] | 1012 | // DuplicateKeyShares, if true, causes the TLS 1.3 client to send two |
| 1013 | // copies of each KeyShareEntry. |
| 1014 | DuplicateKeyShares bool |
| 1015 | |
| 1016 | // EmptyEncryptedExtensions, if true, causes the TLS 1.3 server to |
| 1017 | // emit an empty EncryptedExtensions block. |
| 1018 | EmptyEncryptedExtensions bool |
| 1019 | |
| 1020 | // EncryptedExtensionsWithKeyShare, if true, causes the TLS 1.3 server to |
| 1021 | // include the KeyShare extension in the EncryptedExtensions block. |
| 1022 | EncryptedExtensionsWithKeyShare bool |
Steven Valdez | 5440fe0 | 2016-07-18 12:40:30 -0400 | [diff] [blame] | 1023 | |
| 1024 | // UnnecessaryHelloRetryRequest, if true, causes the TLS 1.3 server to |
| 1025 | // send a HelloRetryRequest regardless of whether it needs to. |
| 1026 | UnnecessaryHelloRetryRequest bool |
| 1027 | |
| 1028 | // SecondHelloRetryRequest, if true, causes the TLS 1.3 server to send |
| 1029 | // two HelloRetryRequests instead of one. |
| 1030 | SecondHelloRetryRequest bool |
| 1031 | |
| 1032 | // SendServerHelloVersion, if non-zero, causes the server to send the |
| 1033 | // specified version in ServerHello rather than the true version. |
| 1034 | SendServerHelloVersion uint16 |
| 1035 | |
| 1036 | // SkipHelloRetryRequest, if true, causes the TLS 1.3 server to not send |
| 1037 | // HelloRetryRequest. |
| 1038 | SkipHelloRetryRequest bool |
David Benjamin | 12d2c48 | 2016-07-24 10:56:51 -0400 | [diff] [blame] | 1039 | |
| 1040 | // PackHelloRequestWithFinished, if true, causes the TLS server to send |
| 1041 | // HelloRequest in the same record as Finished. |
| 1042 | PackHelloRequestWithFinished bool |
David Benjamin | 02edcd0 | 2016-07-27 17:40:37 -0400 | [diff] [blame] | 1043 | |
David Benjamin | e73c7f4 | 2016-08-17 00:29:33 -0400 | [diff] [blame] | 1044 | // ExpectMissingKeyShare, if true, causes the TLS server to fail the |
| 1045 | // connection if the selected curve appears in the client's initial |
| 1046 | // ClientHello. That is, it requires that a HelloRetryRequest be sent. |
| 1047 | ExpectMissingKeyShare bool |
| 1048 | |
David Benjamin | 02edcd0 | 2016-07-27 17:40:37 -0400 | [diff] [blame] | 1049 | // SendExtraFinished, if true, causes an extra Finished message to be |
| 1050 | // sent. |
| 1051 | SendExtraFinished bool |
David Benjamin | 8a8349b | 2016-08-18 02:32:23 -0400 | [diff] [blame^] | 1052 | |
| 1053 | // SendRequestContext, if not empty, is the request context to send in |
| 1054 | // a TLS 1.3 CertificateRequest. |
| 1055 | SendRequestContext []byte |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 1056 | } |
| 1057 | |
| 1058 | func (c *Config) serverInit() { |
| 1059 | if c.SessionTicketsDisabled { |
| 1060 | return |
| 1061 | } |
| 1062 | |
| 1063 | // If the key has already been set then we have nothing to do. |
| 1064 | for _, b := range c.SessionTicketKey { |
| 1065 | if b != 0 { |
| 1066 | return |
| 1067 | } |
| 1068 | } |
| 1069 | |
| 1070 | if _, err := io.ReadFull(c.rand(), c.SessionTicketKey[:]); err != nil { |
| 1071 | c.SessionTicketsDisabled = true |
| 1072 | } |
| 1073 | } |
| 1074 | |
| 1075 | func (c *Config) rand() io.Reader { |
| 1076 | r := c.Rand |
| 1077 | if r == nil { |
| 1078 | return rand.Reader |
| 1079 | } |
| 1080 | return r |
| 1081 | } |
| 1082 | |
| 1083 | func (c *Config) time() time.Time { |
| 1084 | t := c.Time |
| 1085 | if t == nil { |
| 1086 | t = time.Now |
| 1087 | } |
| 1088 | return t() |
| 1089 | } |
| 1090 | |
| 1091 | func (c *Config) cipherSuites() []uint16 { |
| 1092 | s := c.CipherSuites |
| 1093 | if s == nil { |
| 1094 | s = defaultCipherSuites() |
| 1095 | } |
| 1096 | return s |
| 1097 | } |
| 1098 | |
David Benjamin | cecee27 | 2016-06-30 13:33:47 -0400 | [diff] [blame] | 1099 | func (c *Config) minVersion(isDTLS bool) uint16 { |
| 1100 | ret := uint16(minVersion) |
| 1101 | if c != nil && c.MinVersion != 0 { |
| 1102 | ret = c.MinVersion |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 1103 | } |
David Benjamin | cecee27 | 2016-06-30 13:33:47 -0400 | [diff] [blame] | 1104 | if isDTLS { |
| 1105 | // The lowest version of DTLS is 1.0. There is no DSSL 3.0. |
| 1106 | if ret < VersionTLS10 { |
| 1107 | return VersionTLS10 |
| 1108 | } |
| 1109 | // There is no such thing as DTLS 1.1. |
| 1110 | if ret == VersionTLS11 { |
| 1111 | return VersionTLS12 |
| 1112 | } |
| 1113 | } |
| 1114 | return ret |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 1115 | } |
| 1116 | |
David Benjamin | cecee27 | 2016-06-30 13:33:47 -0400 | [diff] [blame] | 1117 | func (c *Config) maxVersion(isDTLS bool) uint16 { |
| 1118 | ret := uint16(maxVersion) |
| 1119 | if c != nil && c.MaxVersion != 0 { |
| 1120 | ret = c.MaxVersion |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 1121 | } |
David Benjamin | cecee27 | 2016-06-30 13:33:47 -0400 | [diff] [blame] | 1122 | if isDTLS { |
| 1123 | // We only implement up to DTLS 1.2. |
| 1124 | if ret > VersionTLS12 { |
| 1125 | return VersionTLS12 |
| 1126 | } |
| 1127 | // There is no such thing as DTLS 1.1. |
| 1128 | if ret == VersionTLS11 { |
| 1129 | return VersionTLS10 |
| 1130 | } |
| 1131 | } |
| 1132 | return ret |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 1133 | } |
| 1134 | |
David Benjamin | cba2b62 | 2015-12-18 22:13:41 -0500 | [diff] [blame] | 1135 | var defaultCurvePreferences = []CurveID{CurveX25519, CurveP256, CurveP384, CurveP521} |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 1136 | |
| 1137 | func (c *Config) curvePreferences() []CurveID { |
| 1138 | if c == nil || len(c.CurvePreferences) == 0 { |
| 1139 | return defaultCurvePreferences |
| 1140 | } |
| 1141 | return c.CurvePreferences |
| 1142 | } |
| 1143 | |
Nick Harper | dcfbc67 | 2016-07-16 17:47:31 +0200 | [diff] [blame] | 1144 | func (c *Config) defaultCurves() map[CurveID]bool { |
| 1145 | defaultCurves := make(map[CurveID]bool) |
| 1146 | curves := c.DefaultCurves |
| 1147 | if c == nil || c.DefaultCurves == nil { |
| 1148 | curves = c.curvePreferences() |
| 1149 | } |
| 1150 | for _, curveID := range curves { |
| 1151 | defaultCurves[curveID] = true |
| 1152 | } |
| 1153 | return defaultCurves |
| 1154 | } |
| 1155 | |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 1156 | // mutualVersion returns the protocol version to use given the advertised |
| 1157 | // version of the peer. |
David Benjamin | cecee27 | 2016-06-30 13:33:47 -0400 | [diff] [blame] | 1158 | func (c *Config) mutualVersion(vers uint16, isDTLS bool) (uint16, bool) { |
| 1159 | // There is no such thing as DTLS 1.1. |
| 1160 | if isDTLS && vers == VersionTLS11 { |
| 1161 | vers = VersionTLS10 |
| 1162 | } |
| 1163 | |
| 1164 | minVersion := c.minVersion(isDTLS) |
| 1165 | maxVersion := c.maxVersion(isDTLS) |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 1166 | |
| 1167 | if vers < minVersion { |
| 1168 | return 0, false |
| 1169 | } |
| 1170 | if vers > maxVersion { |
| 1171 | vers = maxVersion |
| 1172 | } |
| 1173 | return vers, true |
| 1174 | } |
| 1175 | |
| 1176 | // getCertificateForName returns the best certificate for the given name, |
| 1177 | // defaulting to the first element of c.Certificates if there are no good |
| 1178 | // options. |
| 1179 | func (c *Config) getCertificateForName(name string) *Certificate { |
| 1180 | if len(c.Certificates) == 1 || c.NameToCertificate == nil { |
| 1181 | // There's only one choice, so no point doing any work. |
| 1182 | return &c.Certificates[0] |
| 1183 | } |
| 1184 | |
| 1185 | name = strings.ToLower(name) |
| 1186 | for len(name) > 0 && name[len(name)-1] == '.' { |
| 1187 | name = name[:len(name)-1] |
| 1188 | } |
| 1189 | |
| 1190 | if cert, ok := c.NameToCertificate[name]; ok { |
| 1191 | return cert |
| 1192 | } |
| 1193 | |
| 1194 | // try replacing labels in the name with wildcards until we get a |
| 1195 | // match. |
| 1196 | labels := strings.Split(name, ".") |
| 1197 | for i := range labels { |
| 1198 | labels[i] = "*" |
| 1199 | candidate := strings.Join(labels, ".") |
| 1200 | if cert, ok := c.NameToCertificate[candidate]; ok { |
| 1201 | return cert |
| 1202 | } |
| 1203 | } |
| 1204 | |
| 1205 | // If nothing matches, return the first certificate. |
| 1206 | return &c.Certificates[0] |
| 1207 | } |
| 1208 | |
David Benjamin | 7a41d37 | 2016-07-09 11:21:54 -0700 | [diff] [blame] | 1209 | func (c *Config) signSignatureAlgorithms() []signatureAlgorithm { |
| 1210 | if c != nil && c.SignSignatureAlgorithms != nil { |
| 1211 | return c.SignSignatureAlgorithms |
David Benjamin | 000800a | 2014-11-14 01:43:59 -0500 | [diff] [blame] | 1212 | } |
David Benjamin | 7a41d37 | 2016-07-09 11:21:54 -0700 | [diff] [blame] | 1213 | return supportedSignatureAlgorithms |
David Benjamin | 000800a | 2014-11-14 01:43:59 -0500 | [diff] [blame] | 1214 | } |
| 1215 | |
David Benjamin | 7a41d37 | 2016-07-09 11:21:54 -0700 | [diff] [blame] | 1216 | func (c *Config) verifySignatureAlgorithms() []signatureAlgorithm { |
| 1217 | if c != nil && c.VerifySignatureAlgorithms != nil { |
| 1218 | return c.VerifySignatureAlgorithms |
David Benjamin | 000800a | 2014-11-14 01:43:59 -0500 | [diff] [blame] | 1219 | } |
David Benjamin | 7a41d37 | 2016-07-09 11:21:54 -0700 | [diff] [blame] | 1220 | return supportedSignatureAlgorithms |
David Benjamin | 000800a | 2014-11-14 01:43:59 -0500 | [diff] [blame] | 1221 | } |
| 1222 | |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 1223 | // BuildNameToCertificate parses c.Certificates and builds c.NameToCertificate |
| 1224 | // from the CommonName and SubjectAlternateName fields of each of the leaf |
| 1225 | // certificates. |
| 1226 | func (c *Config) BuildNameToCertificate() { |
| 1227 | c.NameToCertificate = make(map[string]*Certificate) |
| 1228 | for i := range c.Certificates { |
| 1229 | cert := &c.Certificates[i] |
| 1230 | x509Cert, err := x509.ParseCertificate(cert.Certificate[0]) |
| 1231 | if err != nil { |
| 1232 | continue |
| 1233 | } |
| 1234 | if len(x509Cert.Subject.CommonName) > 0 { |
| 1235 | c.NameToCertificate[x509Cert.Subject.CommonName] = cert |
| 1236 | } |
| 1237 | for _, san := range x509Cert.DNSNames { |
| 1238 | c.NameToCertificate[san] = cert |
| 1239 | } |
| 1240 | } |
| 1241 | } |
| 1242 | |
| 1243 | // A Certificate is a chain of one or more certificates, leaf first. |
| 1244 | type Certificate struct { |
| 1245 | Certificate [][]byte |
| 1246 | PrivateKey crypto.PrivateKey // supported types: *rsa.PrivateKey, *ecdsa.PrivateKey |
| 1247 | // OCSPStaple contains an optional OCSP response which will be served |
| 1248 | // to clients that request it. |
| 1249 | OCSPStaple []byte |
David Benjamin | 61f9527 | 2014-11-25 01:55:35 -0500 | [diff] [blame] | 1250 | // SignedCertificateTimestampList contains an optional encoded |
| 1251 | // SignedCertificateTimestampList structure which will be |
| 1252 | // served to clients that request it. |
| 1253 | SignedCertificateTimestampList []byte |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 1254 | // Leaf is the parsed form of the leaf certificate, which may be |
| 1255 | // initialized using x509.ParseCertificate to reduce per-handshake |
| 1256 | // processing for TLS clients doing client authentication. If nil, the |
| 1257 | // leaf certificate will be parsed as needed. |
| 1258 | Leaf *x509.Certificate |
| 1259 | } |
| 1260 | |
| 1261 | // A TLS record. |
| 1262 | type record struct { |
| 1263 | contentType recordType |
| 1264 | major, minor uint8 |
| 1265 | payload []byte |
| 1266 | } |
| 1267 | |
| 1268 | type handshakeMessage interface { |
| 1269 | marshal() []byte |
| 1270 | unmarshal([]byte) bool |
| 1271 | } |
| 1272 | |
David Benjamin | fe8eb9a | 2014-11-17 03:19:02 -0500 | [diff] [blame] | 1273 | // lruSessionCache is a client or server session cache implementation |
| 1274 | // that uses an LRU caching strategy. |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 1275 | type lruSessionCache struct { |
| 1276 | sync.Mutex |
| 1277 | |
| 1278 | m map[string]*list.Element |
| 1279 | q *list.List |
| 1280 | capacity int |
| 1281 | } |
| 1282 | |
| 1283 | type lruSessionCacheEntry struct { |
| 1284 | sessionKey string |
David Benjamin | fe8eb9a | 2014-11-17 03:19:02 -0500 | [diff] [blame] | 1285 | state interface{} |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 1286 | } |
| 1287 | |
| 1288 | // Put adds the provided (sessionKey, cs) pair to the cache. |
David Benjamin | fe8eb9a | 2014-11-17 03:19:02 -0500 | [diff] [blame] | 1289 | func (c *lruSessionCache) Put(sessionKey string, cs interface{}) { |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 1290 | c.Lock() |
| 1291 | defer c.Unlock() |
| 1292 | |
| 1293 | if elem, ok := c.m[sessionKey]; ok { |
| 1294 | entry := elem.Value.(*lruSessionCacheEntry) |
| 1295 | entry.state = cs |
| 1296 | c.q.MoveToFront(elem) |
| 1297 | return |
| 1298 | } |
| 1299 | |
| 1300 | if c.q.Len() < c.capacity { |
| 1301 | entry := &lruSessionCacheEntry{sessionKey, cs} |
| 1302 | c.m[sessionKey] = c.q.PushFront(entry) |
| 1303 | return |
| 1304 | } |
| 1305 | |
| 1306 | elem := c.q.Back() |
| 1307 | entry := elem.Value.(*lruSessionCacheEntry) |
| 1308 | delete(c.m, entry.sessionKey) |
| 1309 | entry.sessionKey = sessionKey |
| 1310 | entry.state = cs |
| 1311 | c.q.MoveToFront(elem) |
| 1312 | c.m[sessionKey] = elem |
| 1313 | } |
| 1314 | |
David Benjamin | fe8eb9a | 2014-11-17 03:19:02 -0500 | [diff] [blame] | 1315 | // Get returns the value associated with a given key. It returns (nil, |
| 1316 | // false) if no value is found. |
| 1317 | func (c *lruSessionCache) Get(sessionKey string) (interface{}, bool) { |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 1318 | c.Lock() |
| 1319 | defer c.Unlock() |
| 1320 | |
| 1321 | if elem, ok := c.m[sessionKey]; ok { |
| 1322 | c.q.MoveToFront(elem) |
| 1323 | return elem.Value.(*lruSessionCacheEntry).state, true |
| 1324 | } |
| 1325 | return nil, false |
| 1326 | } |
| 1327 | |
David Benjamin | fe8eb9a | 2014-11-17 03:19:02 -0500 | [diff] [blame] | 1328 | // lruClientSessionCache is a ClientSessionCache implementation that |
| 1329 | // uses an LRU caching strategy. |
| 1330 | type lruClientSessionCache struct { |
| 1331 | lruSessionCache |
| 1332 | } |
| 1333 | |
| 1334 | func (c *lruClientSessionCache) Put(sessionKey string, cs *ClientSessionState) { |
| 1335 | c.lruSessionCache.Put(sessionKey, cs) |
| 1336 | } |
| 1337 | |
| 1338 | func (c *lruClientSessionCache) Get(sessionKey string) (*ClientSessionState, bool) { |
| 1339 | cs, ok := c.lruSessionCache.Get(sessionKey) |
| 1340 | if !ok { |
| 1341 | return nil, false |
| 1342 | } |
| 1343 | return cs.(*ClientSessionState), true |
| 1344 | } |
| 1345 | |
| 1346 | // lruServerSessionCache is a ServerSessionCache implementation that |
| 1347 | // uses an LRU caching strategy. |
| 1348 | type lruServerSessionCache struct { |
| 1349 | lruSessionCache |
| 1350 | } |
| 1351 | |
| 1352 | func (c *lruServerSessionCache) Put(sessionId string, session *sessionState) { |
| 1353 | c.lruSessionCache.Put(sessionId, session) |
| 1354 | } |
| 1355 | |
| 1356 | func (c *lruServerSessionCache) Get(sessionId string) (*sessionState, bool) { |
| 1357 | cs, ok := c.lruSessionCache.Get(sessionId) |
| 1358 | if !ok { |
| 1359 | return nil, false |
| 1360 | } |
| 1361 | return cs.(*sessionState), true |
| 1362 | } |
| 1363 | |
| 1364 | // NewLRUClientSessionCache returns a ClientSessionCache with the given |
| 1365 | // capacity that uses an LRU strategy. If capacity is < 1, a default capacity |
| 1366 | // is used instead. |
| 1367 | func NewLRUClientSessionCache(capacity int) ClientSessionCache { |
| 1368 | const defaultSessionCacheCapacity = 64 |
| 1369 | |
| 1370 | if capacity < 1 { |
| 1371 | capacity = defaultSessionCacheCapacity |
| 1372 | } |
| 1373 | return &lruClientSessionCache{ |
| 1374 | lruSessionCache{ |
| 1375 | m: make(map[string]*list.Element), |
| 1376 | q: list.New(), |
| 1377 | capacity: capacity, |
| 1378 | }, |
| 1379 | } |
| 1380 | } |
| 1381 | |
| 1382 | // NewLRUServerSessionCache returns a ServerSessionCache with the given |
| 1383 | // capacity that uses an LRU strategy. If capacity is < 1, a default capacity |
| 1384 | // is used instead. |
| 1385 | func NewLRUServerSessionCache(capacity int) ServerSessionCache { |
| 1386 | const defaultSessionCacheCapacity = 64 |
| 1387 | |
| 1388 | if capacity < 1 { |
| 1389 | capacity = defaultSessionCacheCapacity |
| 1390 | } |
| 1391 | return &lruServerSessionCache{ |
| 1392 | lruSessionCache{ |
| 1393 | m: make(map[string]*list.Element), |
| 1394 | q: list.New(), |
| 1395 | capacity: capacity, |
| 1396 | }, |
| 1397 | } |
| 1398 | } |
| 1399 | |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 1400 | // TODO(jsing): Make these available to both crypto/x509 and crypto/tls. |
| 1401 | type dsaSignature struct { |
| 1402 | R, S *big.Int |
| 1403 | } |
| 1404 | |
| 1405 | type ecdsaSignature dsaSignature |
| 1406 | |
| 1407 | var emptyConfig Config |
| 1408 | |
| 1409 | func defaultConfig() *Config { |
| 1410 | return &emptyConfig |
| 1411 | } |
| 1412 | |
| 1413 | var ( |
| 1414 | once sync.Once |
| 1415 | varDefaultCipherSuites []uint16 |
| 1416 | ) |
| 1417 | |
| 1418 | func defaultCipherSuites() []uint16 { |
| 1419 | once.Do(initDefaultCipherSuites) |
| 1420 | return varDefaultCipherSuites |
| 1421 | } |
| 1422 | |
| 1423 | func initDefaultCipherSuites() { |
David Benjamin | 48cae08 | 2014-10-27 01:06:24 -0400 | [diff] [blame] | 1424 | for _, suite := range cipherSuites { |
| 1425 | if suite.flags&suitePSK == 0 { |
| 1426 | varDefaultCipherSuites = append(varDefaultCipherSuites, suite.id) |
| 1427 | } |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 1428 | } |
| 1429 | } |
| 1430 | |
| 1431 | func unexpectedMessageError(wanted, got interface{}) error { |
| 1432 | return fmt.Errorf("tls: received unexpected handshake message of type %T when waiting for %T", got, wanted) |
| 1433 | } |
David Benjamin | 000800a | 2014-11-14 01:43:59 -0500 | [diff] [blame] | 1434 | |
Nick Harper | 60edffd | 2016-06-21 15:19:24 -0700 | [diff] [blame] | 1435 | func isSupportedSignatureAlgorithm(sigAlg signatureAlgorithm, sigAlgs []signatureAlgorithm) bool { |
| 1436 | for _, s := range sigAlgs { |
| 1437 | if s == sigAlg { |
David Benjamin | 000800a | 2014-11-14 01:43:59 -0500 | [diff] [blame] | 1438 | return true |
| 1439 | } |
| 1440 | } |
| 1441 | return false |
| 1442 | } |
Nick Harper | 85f20c2 | 2016-07-04 10:11:59 -0700 | [diff] [blame] | 1443 | |
| 1444 | var ( |
| 1445 | // See draft-ietf-tls-tls13-13, section 6.3.1.2. |
| 1446 | downgradeTLS13 = []byte{0x44, 0x4f, 0x57, 0x4e, 0x47, 0x52, 0x44, 0x01} |
| 1447 | downgradeTLS12 = []byte{0x44, 0x4f, 0x57, 0x4e, 0x47, 0x52, 0x44, 0x00} |
| 1448 | ) |