source: mod_gnutls/docs/mod_gnutls_manual.mdwn @ f030883

debian/masterdebian/stretch-backportsjessie-backportsproxy-ticketupstream
Last change on this file since f030883 was f030883, checked in by Thomas Klute <thomas2.klute@…>, 5 years ago

Set GnuTLS priorities for proxy connections separately

Until now, proxy connections were configured with the same priorities as
the server side. This commit introduces the new configuration option
"GnuTLSProxyPriorities" to set the priorities for proxy connections
separately. Note that GnuTLSProxyPriorities MUST be set when
SSLProxyEngine is enabled.

Since the parameters to GnuTLSPriorities and GnuTLSProxyPriorities need
the same processing, mgs_set_priorities has been rewritten to select the
priority cache to write to based on the option name, rather than adding
a new function to handle GnuTLSProxyPriorities.

  • Property mode set to 100644
File size: 23.7 KB
Line 
1% `mod_gnutls` Manual
2
3* * * * *
4
5`mod_gnutls` is a module for the Apache web server that provides HTTPS
6(HTTP over Transport Layer Security (TLS) or the older Secure Sockets
7Layer (SSL)) using the GnuTLS library.  More information about the
8module can be found at [the project's website](https://mod.gnutls.org/).
9
10* * * * *
11
12Compilation & Installation
13==========================
14
15`mod_gnutls` uses the `./configure && make && make install` mechanism
16common to many Open Source programs.  Most of the dirty work is
17handled by either `./configure` or Apache's `apxs` utility. If you have
18built Apache modules before, there shouldn't be any surprises for you.
19
20The interesting options you can pass to configure are:
21
22`--with-apxs=PATH`
23:   This option is used to specify the location of the apxs utility that
24    was installed as part of apache. Specify the location of the
25    binary, not the directory it is located in.
26
27`--with-libgnutls=PATH`
28:   Full path to the libgnutls-config program.
29
30`--with-apr-memcache=PREFIX`
31:   Prefix to where apr\_memcache is installed.
32
33`--help`
34:   Provides a list of all available configure options.
35
36* * * * *
37
38Integration
39===========
40
41To activate `mod_gnutls` just add the following line to your httpd.conf
42and restart Apache:
43
44    LoadModule gnutls_module modules/mod_gnutls.so
45
46* * * * *
47
48Configuration Directives
49========================
50
51`GnuTLSEnable`
52--------------
53
54Enable GnuTLS for this virtual host
55
56    GnuTLSEnable [on|off]
57
58Default: *off*\
59Context: virtual host
60
61This directive enables SSL/TLS Encryption for a Virtual Host.
62
63`GnuTLSCache`
64-------------
65
66Configure SSL Session Cache
67
68    GnuTLSCache [dbm|gdbm|memcache|none] [PATH|SERVERLIST|-]
69
70Default: `GnuTLSCache none`\
71Context: server config
72
73This directive configures the SSL Session Cache for `mod_gnutls`.
74This could be shared between machines of different architectures.
75
76`dbm` (Requires Berkeley DBM)
77:   Uses the default Berkeley DB backend of APR DBM to cache SSL
78    Sessions results.  The argument is a relative or absolute path to
79    be used as the DBM Cache file. This is compatible with most
80    operating systems, but needs the Apache Runtime to be compiled
81    with Berkeley DBM support.
82
83`gdbm`
84:   Uses the GDBM backend of APR DBM to cache SSL Sessions results.
85
86    The argument is a relative or absolute path to be used as the DBM Cache
87    file.  This is the recommended option.
88
89`memcache`
90:   Uses a memcached server to cache the SSL Session.
91
92    The argument is a space separated list of servers. If no port
93    number is supplied, the default of 11211 is used.  This can be
94    used to share a session cache between all servers in a cluster.
95
96`none`
97:   Turns off all caching of SSL Sessions.
98
99    This can significantly reduce the performance of `mod_gnutls` since
100    even followup connections by a client must renegotiate parameters
101    instead of reusing old ones.  This is the default, since it
102    requires no configuration.
103
104`GnuTLSCacheTimeout`
105--------------------
106
107Timeout for SSL Session Cache expiration
108
109    GnuTLSCacheTimeout SECONDS
110
111Default: `GnuTLSCacheTimeout 300`\
112Context: server config
113
114Sets the timeout for SSL Session Cache entries expiration.  This
115directive is valid even if Session Tickets are used, and indicates the
116expiration time of the ticket in seconds.
117
118`GnuTLSSessionTickets`
119----------------------
120
121Enable Session Tickets for the server
122
123    GnuTLSSessionTickets [on|off]
124
125Default: `off`\
126Context: server config, virtual host
127
128To avoid storing data for TLS session resumption it is allowed to
129provide client with a ticket, to use on return.  Use for servers with
130limited storage, and don't combine with GnuTLSCache. For a pool of
131servers this option is not recommended since the tickets are unique
132for the issuing server only.
133
134
135`GnuTLSCertificateFile`
136-----------------------
137
138Set to the PEM Encoded Server Certificate
139
140    GnuTLSCertificateFile FILEPATH
141
142Default: *none*\
143Context: server config, virtual host
144
145Takes an absolute or relative path to a PEM-encoded X.509 certificate to
146use as this Server's End Entity (EE) certificate. If you need to supply
147certificates for intermediate Certificate Authorities (iCAs), they
148should be listed in sequence in the file, from EE to the iCA closest to
149the root CA. Optionally, you can also include the root CA's certificate
150as the last certificate in the list.
151
152`GnuTLSKeyFile`
153---------------
154
155Set to the PEM Encoded Server Private Key
156
157    GnuTLSKeyFile FILEPATH
158
159Default: *none*\
160Context: server config, virtual host
161
162Takes an absolute or relative path to the Server Private Key. This key
163cannot currently be password protected.
164
165**Security Warning:**\
166 This private key must be protected. It is read while Apache is still
167running as root, and does not need to be readable by the nobody or
168apache user.
169
170`GnuTLSPGPCertificateFile`
171--------------------------
172
173Set to a base64 Encoded Server OpenPGP Certificate
174
175    GnuTLSPGPCertificateFile FILEPATH
176
177Default: *none*\
178Context: server config, virtual host
179
180Takes an absolute or relative path to a base64 Encoded OpenPGP
181Certificate to use as this Server's Certificate.
182
183`GnuTLSPGPKeyFile`
184------------------
185
186Set to the Server OpenPGP Secret Key
187
188    GnuTLSPGPKeyFile FILEPATH
189
190Default: *none*\
191Context: server config, virtual host
192
193Takes an absolute or relative path to the Server Private Key. This key
194cannot currently be password protected.
195
196**Security Warning:**\
197 This private key must be protected. It is read while Apache is still
198running as root, and does not need to be readable by the nobody or
199apache user.
200
201`GnuTLSClientVerify`
202--------------------
203
204Enable Client Certificate Verification\
205
206    GnuTLSClientVerify [ignore|request|require]
207
208Default: `ignore`\
209Context: server config, virtual host, directory, .htaccess
210
211This directive controls the use of SSL Client Certificate
212Authentication. If used in the .htaccess context, it can force TLS
213re-negotiation.
214
215`ignore`
216:   `mod_gnutls` will ignore the contents of any SSL Client Certificates
217    sent. It will not request that the client sends a certificate.
218
219`request`
220:   The client certificate will be requested, but not required.
221    The Certificate will be validated if sent.  The output of the
222    validation status will be stored in the `SSL_CLIENT_VERIFY`
223    environment variable and can be `SUCCESS`, `FAILED` or `NONE`.
224
225`require`
226:   A Client certificate will be required. Any requests without a valid
227    client certificate will be denied.  The `SSL_CLIENT_VERIFY`
228    environment variable will only be set to `SUCCESS`.
229
230`GnuTLSClientCAFile`
231--------------------
232
233Set to the PEM Encoded Certificate Authority Certificate
234
235    GnuTLSClientCAFile FILEPATH
236
237Default: *none*
238Context: server config, virtual host
239
240Takes an absolute or relative path to a PEM Encoded Certificate to use
241as a Certificate Authority with Client Certificate Authentication.
242This file may contain a list of trusted authorities.
243
244`GnuTLSPGPKeyringFile`
245----------------------
246
247Set to a base64 Encoded key ring
248
249    GnuTLSPGPKeyringFile FILEPATH
250
251Default: *none*\
252Context: server config, virtual host
253
254Takes an absolute or relative path to a base64 Encoded Certificate
255list (key ring) to use as a means of verification of Client
256Certificates.  This file should contain a list of trusted signers.
257
258`GnuTLSDHFile`
259--------------
260
261Set to the PKCS \#3 encoded Diffie Hellman parameters
262
263    GnuTLSDHFile FILEPATH
264
265Default: *none*\
266Context: server config, virtual host
267
268Takes an absolute or relative path to a PKCS \#3 encoded DH
269parameters.Those are used when the DHE key exchange method is enabled.
270You can generate this file using `certtool --generate-dh-params --bits
2712048`.  If not set `mod_gnutls` will use the included parameters.
272
273`GnuTLSSRPPasswdFile`
274---------------------
275
276Set to the SRP password file for SRP ciphersuites
277
278    GnuTLSSRPPasswdFile FILEPATH
279
280Default: *none*\
281Context: server config, virtual host
282
283Takes an absolute or relative path to an SRP password file. This is
284the same format as used in libsrp.  You can generate such file using
285the command `srptool --passwd /etc/tpasswd --passwd-conf
286/etc/tpasswd.conf -u test` to set a password for user test.  This
287password file holds the username, a password verifier and the
288dependency to the SRP parameters.
289
290`GnuTLSSRPPasswdConfFile`
291-------------------------
292
293Set to the SRP password.conf file for SRP ciphersuites
294
295    GnuTLSSRPPasswdConfFile FILEPATH
296
297Default: *none*\
298Context: server config, virtual host
299
300Takes an absolute or relative path to an SRP password.conf file. This
301is the same format as used in `libsrp`.  You can generate such file
302using the command `srptool --create-conf /etc/tpasswd.conf`.  This
303file holds the SRP parameters and is associate with the password file
304(the verifiers depends on these parameters).
305
306`GnuTLSPriorities`
307------------------
308
309Set the allowed ciphers, key exchange algorithms, MACs and compression
310methods
311
312    GnuTLSPriorities NORMAL:+CIPHER_0:+CIPHER_1:...:+CIPHER_N
313
314Default: *none*\
315Context: server config, virtual host
316
317Takes a semi-colon separated list of ciphers, key exchange methods
318Message authentication codes and compression methods to enable.
319The allowed keywords are specified in the `gnutls_priority_init()`
320function of GnuTLS.
321
322Full details can be found at [the GnuTLS documentation](http://gnutls.org/manual/html_node/Priority-Strings.html#Priority-Strings).
323In brief you can specify a set of ciphersuites from the choices:
324
325`NONE`
326:   The empty list.
327
328`EXPORT`
329:   A list with all the supported cipher combinations
330    including the `EXPORT` strength algorithms.
331
332`PERFORMANCE`
333:   A list with all the secure cipher combinations sorted in terms of performance.
334
335`NORMAL`
336:   A list with all the secure cipher combinations sorted
337    with respect to security margin (subjective term).
338
339`SECURE`
340:   A list with all the secure cipher combinations including
341    the 256-bit ciphers sorted with respect to security margin.
342
343Additionally you can add or remove algorithms using the `+` and `!`
344prefixes respectively.
345
346For example, in order to disable the `ARCFOUR` cipher from the `NORMAL` set
347you can use the string `NORMAL:!ARCFOUR-128`
348
349Other options such as the protocol version and the compression method
350can be specified using the `VERS-` and `COMP-` prefixes.
351
352So in order to remove or add a specific TLS version from the `NORMAL`
353set, use `NORMAL:!VERS-SSL3.0`.  And to enable zlib compression use
354`NORMAL:+COMP-DEFLATE`.
355
356
357However it is recommended not to add compression at this level.  With
358the `NONE` set, in order to be usable, you have to specify a complete
359set of combinations of protocol versions, cipher algorithms
360(`AES-128-CBC`), key exchange algorithms (`RSA`), message
361authentication codes (`SHA1`) and compression methods (`COMP-NULL`).
362
363You can find a list of all supported Ciphers, Versions, MACs, etc.  by
364running `gnutls-cli --list`.
365
366The special keyword `%COMPAT` will disable some security features such
367as protection against statistical attacks to ciphertext data in order to
368achieve maximum compatibility (some broken mobile clients need this).
369
370`GnuTLSExportCertificates`
371--------------------------
372
373Export the PEM encoded certificates to CGIs
374
375    GnuTLSExportCertificates [off|on|SIZE]
376
377Default: `off`\
378Context: server config, virtual host
379
380This directive configures exporting the full certificates of the
381server and the client to CGI scripts via the `SSL_SERVER_CERT` and
382`SSL_CLIENT_CERT` environment variables. The exported certificates
383will be PEM-encoded (if X.509) or ASCII-armored (if OpenPGP) up to the
384size given.  The type of the certificate will be exported in
385`SSL_SERVER_CERT_TYPE` and `SSL_CLIENT_CERT_TYPE`.
386
387SIZE should be an integer number of bytes, or may be written with a
388trailing `K` to indicate kibibytes.  `off` means the same thing as
389`0`, in which case the certificates will not be exported to the
390environment.  `on` is an alias for `16K`.  If a non-zero size is
391specified for this directive, but a certificate is too large to fit in
392the buffer, then the corresponding environment variable will contain
393the fixed string `GNUTLS_CERTIFICATE_SIZE_LIMIT_EXCEEDED`.
394
395With GnuTLSExportCertificates enabled, `mod_gnutls` exports the same
396environment variables to the CGI process as `mod_ssl`.
397
398
399`SSLProxyEngine`
400--------------
401
402Enable TLS proxy connections for this virtual host
403
404    SSLProxyEngine [on|off]
405
406Default: *off*\
407Context: virtual host
408
409This directive enables support for TLS proxy connections for a virtual
410host.
411
412`GnuTLSProxyCAFile`
413--------------------
414
415Set to the PEM encoded Certificate Authority Certificate
416
417    GnuTLSProxyCAFile FILEPATH
418
419Default: *none*\
420Context: server config, virtual host
421
422Takes an absolute or relative path to a PEM encoded certificate to use
423as a Certificate Authority when verifying certificates provided by
424proxy back end servers. This file may contain a list of trusted
425authorities. If not set, verification of TLS back end servers will
426always fail due to lack of a trusted CA.
427
428`GnuTLSProxyCRLFile`
429--------------------
430
431Set to the PEM encoded Certificate Revocation List
432
433    GnuTLSProxyCRLFile FILEPATH
434
435Default: *none*\
436Context: server config, virtual host
437
438Takes an absolute or relative path to a PEM encoded Certificate
439Revocation List to use when verifying certificates provided by proxy
440back end servers. The file may contain a list of CRLs.
441
442`GnuTLSProxyCertificateFile`
443-----------------------
444
445Set to the PEM encoded Client Certificate
446
447    GnuTLSProxyCertificateFile FILEPATH
448
449Default: *none*\
450Context: server config, virtual host
451
452Takes an absolute or relative path to a PEM encoded X.509 certificate
453to use as this Server's End Entity (EE) client certificate for TLS
454client authentication in proxy TLS connections. If you need to supply
455certificates for intermediate Certificate Authorities (iCAs), they
456should be listed in sequence in the file, from EE to the iCA closest
457to the root CA. Optionally, you can also include the root CA's
458certificate as the last certificate in the list.
459
460If not set, TLS client authentication will be disabled for TLS proxy
461connections. If set, `GnuTLSProxyKeyFile` must be set as well to
462provide the matching private key.
463
464`GnuTLSProxyKeyFile`
465---------------
466
467Set to the PEM encoded Private Key
468
469    GnuTLSProxyKeyFile FILEPATH
470
471Default: *none*\
472Context: server config, virtual host
473
474Takes an absolute or relative path to the Private Key matching the
475certificate configured using the `GnuTLSProxyCertificateFile`
476directive. This key cannot currently be password protected.
477
478**Security Warning:**\
479This private key must be protected. It is read while Apache is still
480running as root, and does not need to be readable by the nobody or
481apache user.
482
483`GnuTLSProxyPriorities`
484------------------
485
486Set the allowed ciphers, key exchange algorithms, MACs and compression
487methods for proxy connections
488
489    GnuTLSProxyPriorities NORMAL:+CIPHER_0:+CIPHER_1:...:+CIPHER_N
490
491Default: *none*\
492Context: server config, virtual host
493
494This option is used to set the allowed ciphers, key exchange
495algorithms, MACs and compression methods for proxy connections. It
496takes the same parameters as `GnuTLSPriorities`. Required if
497`SSLProxyEngine` is `On`.
498
499* * * * *
500
501Configuration Examples
502======================
503
504Simple Standard SSL Example
505---------------------------
506
507The following is an example of standard SSL Hosting, using one IP
508Addresses for each virtual host
509
510     # Load the module into Apache.
511     LoadModule gnutls_module modules/mod_gnutls.so
512     GnuTLSCache gdbm /var/cache/www-tls-cache
513     GnuTLSCacheTimeout 500
514     # With normal SSL Websites, you need one IP Address per-site.
515     Listen 1.2.3.1:443
516     Listen 1.2.3.2:443
517     Listen 1.2.3.3:443
518     Listen 1.2.3.4:443
519     <VirtualHost 1.2.3.1:443>
520     GnuTLSEnable on
521     GnuTLSPriorities NONE:+AES-128-CBC:+3DES-CBC:+ARCFOUR-128:+RSA:+DHE-RSA:+DHE-DSS:+SHA1:+MD5:+COMP-NULL
522     DocumentRoot /www/site1.example.com/html
523     ServerName site1.example.com:443
524     GnuTLSCertificateFile conf/ssl/site1.crt
525     GnuTLSKeyFile conf/ss/site1.key
526     </VirtualHost>
527     <VirtualHost 1.2.3.2:443>
528     # This virtual host enables SRP authentication
529     GnuTLSEnable on
530     GnuTLSPriorities NORMAL:+SRP
531     DocumentRoot /www/site2.example.com/html
532     ServerName site2.example.com:443
533     GnuTLSSRPPasswdFile conf/ssl/tpasswd.site2
534     GnuTLSSRPPasswdConfFile conf/ssl/tpasswd.site2.conf
535     </VirtualHost>
536     <VirtualHost 1.2.3.3:443>
537     # This server enables SRP, OpenPGP and X.509 authentication.
538     GnuTLSEnable on
539     GnuTLSPriorities NORMAL:+SRP:+SRP-RSA:+SRP-DSS
540     DocumentRoot /www/site3.example.com/html
541     ServerName site3.example.com:443
542     GnuTLSCertificateFile conf/ssl/site3.crt
543     GnuTLSKeyFile conf/ss/site3.key
544     GnuTLSClientVerify ignore
545     GnuTLSPGPCertificateFile conf/ss/site3.pub.asc
546     GnuTLSPGPKeyFile conf/ss/site3.sec.asc
547     GnuTLSSRPPasswdFile conf/ssl/tpasswd.site3
548     GnuTLSSRPPasswdConfFile conf/ssl/tpasswd.site3.conf
549     </VirtualHost>
550     <VirtualHost 1.2.3.4:443>
551     GnuTLSEnable on
552     # %COMPAT disables some security features to enable maximum compatibility with clients.
553     GnuTLSPriorities NONE:+AES-128-CBC:+ARCFOUR-128:+RSA:+SHA1:+MD5:+COMP-NULL:%COMPAT
554     DocumentRoot /www/site4.example.com/html
555     ServerName site4.example.com:443
556     GnuTLSCertificateFile conf/ssl/site4.crt
557     GnuTLSKeyFile conf/ss/site4.key
558     </VirtualHost>
559
560Server Name Indication Example
561------------------------------
562
563`mod_gnutls` can also use "Server Name Indication", as specified in
564RFC 3546.  This allows hosting many SSL Websites, with a Single IP
565Address.  Currently all the recent browsers support this
566standard. Here is an example, using SNI: ` `
567
568
569     # Load the module into Apache.
570     LoadModule gnutls_module modules/mod_gnutls.so
571     # With normal SSL Websites, you need one IP Address per-site.
572     Listen 1.2.3.1:443
573     # This could also be 'Listen *:443',
574     # just like '*:80' is common for non-https
575     # No caching. Enable session tickets. Timeout is still used for
576     # ticket expiration.
577     GnuTLSCacheTimeout 600
578     # This tells apache, that for this IP/Port combination, we want to use
579     # Name Based Virtual Hosting. In the case of Server Name Indication,
580     # it lets mod_gnutls pick the correct Server Certificate.
581     NameVirtualHost 1.2.3.1:443
582     <VirtualHost 1.2.3.1:443>
583     GnuTLSEnable on
584     GnuTLSSessionTickets on
585     GnuTLSPriorities NORMAL
586     DocumentRoot /www/site1.example.com/html
587     ServerName site1.example.com:443
588     GnuTLSCertificateFile conf/ssl/site1.crt
589     GnuTLSKeyFile conf/ss/site1.key
590     </VirtualHost>
591     <VirtualHost 1.2.3.1:443>
592     GnuTLSEnable on
593     GnuTLSPriorities NORMAL
594     DocumentRoot /www/site2.example.com/html
595     ServerName site2.example.com:443
596     GnuTLSCertificateFile conf/ssl/site2.crt
597     GnuTLSKeyFile conf/ss/site2.key
598     </VirtualHost>
599     <VirtualHost 1.2.3.1:443>
600     GnuTLSEnable on
601     GnuTLSPriorities NORMAL
602     DocumentRoot /www/site3.example.com/html
603     ServerName site3.example.com:443
604     GnuTLSCertificateFile conf/ssl/site3.crt
605     GnuTLSKeyFile conf/ss/site3.key
606     </VirtualHost>
607     <VirtualHost 1.2.3.1:443>
608     GnuTLSEnable on
609     GnuTLSPriorities NORMAL
610     DocumentRoot /www/site4.example.com/html
611     ServerName site4.example.com:443
612     GnuTLSCertificateFile conf/ssl/site4.crt
613     GnuTLSKeyFile conf/ss/site4.key
614     </VirtualHost>
615
616
617* * * * *
618
619Performance Issues
620==================
621
622`mod_gnutls` by default uses conservative settings for the server.
623You can fine tune the configuration to reduce the load on a busy
624server.  The following examples do exactly this:
625
626
627     # Load the module into Apache.
628     LoadModule gnutls_module modules/mod_gnutls.so
629     # Using 4 memcache servers to distribute the SSL Session Cache.
630     GnuTLSCache memcache "mc1.example.com mc2.example.com mc3.example.com mc4.example.com"
631     GnuTLSCacheTimeout 600
632     Listen 1.2.3.1:443
633     NameVirtualHost 1.2.3.1:443
634     <VirtualHost 1.2.3.1:443>
635     GnuTLSEnable on
636     # Here we disable the Perfect forward secrecy ciphersuites (DHE)
637     # and disallow AES-256 since AES-128 is just fine.
638     GnuTLSPriorities NORMAL:!DHE-RSA:!DHE-DSS:!AES-256-CBC:%COMPAT
639     DocumentRoot /www/site1.example.com/html
640     ServerName site1.example.com:443
641     GnuTLSCertificateFile conf/ssl/site1.crt
642     GnuTLSKeyFile conf/ss/site1.key
643     </VirtualHost>
644     <VirtualHost 1.2.3.1:443>
645     GnuTLSEnable on
646     # Here we instead of disabling the DHE ciphersuites we use
647     # Diffie Hellman parameters of smaller size than the default (2048 bits).
648     # Using small numbers from 768 to 1024 bits should be ok once they are
649     # regenerated every few hours.
650     # Use "certtool --generate-dh-params --bits 1024" to get those
651     GnuTLSDHFile /etc/apache2/dh.params
652     GnuTLSPriorities NORMAL:!AES-256-CBC:%COMPAT
653     DocumentRoot /www/site2.example.com/html
654     ServerName site2.example.com:443
655     GnuTLSCertificateFile conf/ssl/site2.crt
656     GnuTLSKeyFile conf/ss/site2.key
657     </VirtualHost>
658
659* * * * *
660
661Environment Variables
662=====================
663
664`mod_gnutls` exports the following environment variables to scripts.
665These are compatible with `mod_ssl`.
666
667`HTTPS`
668-------
669
670Can be `on` or `off`
671
672`SSL_VERSION_LIBRARY`
673---------------------
674
675The version of the GnuTLS library
676
677`SSL_VERSION_INTERFACE`
678-----------------------
679
680The version of this module
681
682`SSL_PROTOCOL`
683--------------
684
685The SSL or TLS protocol name (such as `TLS 1.0` etc.)
686
687`SSL_CIPHER`
688------------
689
690The SSL or TLS cipher suite name
691
692`SSL_COMPRESS_METHOD`
693---------------------
694
695The negotiated compression method (`NULL` or `DEFLATE`)
696
697`SSL_SRP_USER`
698--------------
699
700The SRP username used for authentication (only set when
701`GnuTLSSRPPasswdFile` and `GnuTLSSRPPasswdConfFile` are configured).
702
703`SSL_CIPHER_USEKEYSIZE` & `SSL_CIPHER_ALGKEYSIZE`
704-------------------------------------------------
705
706The number if bits used in the used cipher algorithm.
707
708This does not fully reflect the security level since the size of
709RSA or DHE key exchange parameters affect the security level too.
710
711`SSL_DH_PRIME_BITS`
712-------------------
713
714The number if bits in the modulus for the DH group, if DHE or static
715DH is used.
716
717This will not be set if DH is not used.
718
719`SSL_CIPHER_EXPORT`
720-------------------
721
722`True` or `False`. Whether the cipher suite negotiated is an export one.
723
724`SSL_SESSION_ID`
725----------------
726
727The session ID negotiated in this session. Can be the same during client
728reloads.
729
730`SSL_CLIENT_V_REMAIN`
731---------------------
732
733The number of days until the client's certificate is expired.
734
735`SSL_CLIENT_V_START`
736--------------------
737
738The activation time of client's certificate.
739
740`SSL_CLIENT_V_END`
741------------------
742
743The expiration time of client's certificate.
744
745`SSL_CLIENT_S_DN`
746-----------------
747
748The distinguished name of client's certificate in RFC2253 format.
749
750`SSL_CLIENT_I_DN`
751-----------------
752
753The SSL or TLS cipher suite name
754
755`SSL_CLIENT_S_AN%`
756------------------
757
758These will contain the alternative names of the client certificate (`%` is
759a number starting from zero).
760
761The values will be prepended by `DNSNAME:`, `RFC822NAME:` or `URI:`
762depending on the type.
763
764If it is not supported the value `UNSUPPORTED` will be set.
765
766`SSL_SERVER_M_SERIAL`
767---------------------
768
769The serial number of the server's certificate.
770
771`SSL_SERVER_M_VERSION`
772----------------------
773
774The version of the server's certificate.
775
776`SSL_SERVER_A_SIG`
777------------------
778
779The algorithm used for the signature in server's certificate.
780
781`SSL_SERVER_A_KEY`
782------------------
783
784The public key algorithm in server's certificate.
785
786`SSL_SERVER_CERT`
787------------------
788
789The PEM-encoded (X.509) or ASCII-armored (OpenPGP) server certificate
790(see the `GnuTLSExportCertificates` directive).
791
792`SSL_SERVER_CERT_TYPE`
793----------------------
794
795The certificate type can be `X.509` or `OPENPGP`.
796
797`SSL_CLIENT_CERT`
798------------------
799
800The PEM-encoded (X.509) or ASCII-armored (OpenPGP) client certificate
801(see the `GnuTLSExportCertificates` directive).
802
803`SSL_CLIENT_CERT_TYPE`
804----------------------
805
806The certificate type can be `X.509` or `OPENPGP`.
Note: See TracBrowser for help on using the repository browser.