Skip to content

Commit b5fa57e

Browse files
Add some documentation for CA certificate validation (#1176)
1 parent fcf2a54 commit b5fa57e

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

types/backend.d.ts

+13
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,15 @@ declare module 'fastly:backend' {
6666
betweenBytesTimeout?: number;
6767
/**
6868
* 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}.
6978
*/
7079
useSSL?: boolean;
7180
/**
@@ -93,6 +102,8 @@ declare module 'fastly:backend' {
93102
/**
94103
* The CA certificate to use when checking the validity of the backend.
95104
*
105+
* If not provided (default), the backend's certificate is validated using a set of public root CAs.
106+
*
96107
* @throws {TypeError} Throws a TypeError if the value is an empty string.
97108
*/
98109
caCertificate?: string;
@@ -187,6 +198,8 @@ declare module 'fastly:backend' {
187198
/**
188199
* Define the hostname that the server certificate should declare.
189200
*
201+
* If not set (default), the server certificate may present any hostname.
202+
*
190203
* @throws {TypeError} Throws a TypeError if the value is an empty string.
191204
*/
192205
certificateHostname?: string;

0 commit comments

Comments
 (0)