File tree 1 file changed +13
-0
lines changed
1 file changed +13
-0
lines changed Original file line number Diff line number Diff line change @@ -66,6 +66,15 @@ declare module 'fastly:backend' {
66
66
betweenBytesTimeout ?: number ;
67
67
/**
68
68
* Whether or not to require TLS for connections to this backend.
69
+ *
70
+ * When using TLS, Fastly checks the validity of the backend's certificate, and fails the connection if the certificate is invalid.
71
+ * This check is not optional: an invalid certificate will cause the backend connection to fail (but read on).
72
+ *
73
+ * By default, the validity check does not require that the certificate hostname matches the hostname of your request.
74
+ * You can use {@link BackendConfiguration.certificateHostname} to request a check of the certificate hostname.
75
+ *
76
+ * By default, certificate validity uses a set of public certificate authorities.
77
+ * You can specify an alternative CA using {@link caCertificate}.
69
78
*/
70
79
useSSL ?: boolean ;
71
80
/**
@@ -93,6 +102,8 @@ declare module 'fastly:backend' {
93
102
/**
94
103
* The CA certificate to use when checking the validity of the backend.
95
104
*
105
+ * If not provided (default), the backend's certificate is validated using a set of public root CAs.
106
+ *
96
107
* @throws {TypeError } Throws a TypeError if the value is an empty string.
97
108
*/
98
109
caCertificate ?: string ;
@@ -187,6 +198,8 @@ declare module 'fastly:backend' {
187
198
/**
188
199
* Define the hostname that the server certificate should declare.
189
200
*
201
+ * If not set (default), the server certificate may present any hostname.
202
+ *
190
203
* @throws {TypeError } Throws a TypeError if the value is an empty string.
191
204
*/
192
205
certificateHostname ?: string ;
You can’t perform that action at this time.
0 commit comments