on master help sign in
Document newly-added tlsWantClientCert and tlsServerHooks fields.
0aede8dClint Adams
warp-tls/Network/Wai/Handler/WarpTLS.hs+16
@@ -84,7 +84,23 @@ data TLSSettings = TLSSettings {
84 --
84 --
85 -- Since 1.4.2
85 -- Since 1.4.2
86 , tlsWantClientCert :: Bool
86 , tlsWantClientCert :: Bool
87+ -- ^ Whether or not to demand a certificate from the client. If this
88+ -- is set to True, you must handle received certificates in a server hook
89+ -- or all connections will fail.
90+ --
91+ -- Default: False
92+ , tlsServerHooks :: TLS.ServerHooks
93+ -- ^ Whether or not to demand a certificate from the client. If this
94+ -- is set to True, you must handle received certificates in a server hook
95+ -- or all connections will fail.
96+ --
97+ -- Default: False
87 , tlsServerHooks :: TLS.ServerHooks
98 , tlsServerHooks :: TLS.ServerHooks
99+ -- ^ The server-side hooks called by the tls package, including actions
100+ -- to take when a client certificate is received. See the "Network.TLS"
101+ -- module for details.
102+ --
103+ -- Default: def
88 }
104 }
89
105
90-- | Default 'TLSSettings'. Use this to create 'TLSSettings' with the field record name.
106-- | Default 'TLSSettings'. Use this to create 'TLSSettings' with the field record name.