diff options
| -rw-r--r-- | doc/Makefile.am | 10 | ||||
| -rw-r--r-- | doc/cha-intro-tls.texi | 14 | ||||
| -rw-r--r-- | doc/invoke-gnutls-cli.texi | 3 | ||||
| -rw-r--r-- | doc/invoke-gnutls-serv.texi | 9 | ||||
| -rw-r--r-- | doc/manpages/Makefile.am | 6 |
5 files changed, 31 insertions, 11 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index d224c5a670..c279057af1 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -882,6 +882,10 @@ FUNCS += functions/gnutls_handshake_get_last_out FUNCS += functions/gnutls_handshake_get_last_out.short FUNCS += functions/gnutls_handshake_get_last_in FUNCS += functions/gnutls_handshake_get_last_in.short +FUNCS += functions/gnutls_heartbeat_ping +FUNCS += functions/gnutls_heartbeat_ping.short +FUNCS += functions/gnutls_heartbeat_ping_rnd +FUNCS += functions/gnutls_heartbeat_ping_rnd.short FUNCS += functions/gnutls_record_send FUNCS += functions/gnutls_record_send.short FUNCS += functions/gnutls_record_recv @@ -908,6 +912,12 @@ FUNCS += functions/gnutls_server_name_set FUNCS += functions/gnutls_server_name_set.short FUNCS += functions/gnutls_server_name_get FUNCS += functions/gnutls_server_name_get.short +FUNCS += functions/gnutls_heartbeat_enable +FUNCS += functions/gnutls_heartbeat_enable.short +FUNCS += functions/gnutls_heartbeat_allowed +FUNCS += functions/gnutls_heartbeat_allowed.short +FUNCS += functions/gnutls_heartbeat_timeout +FUNCS += functions/gnutls_heartbeat_timeout.short FUNCS += functions/gnutls_safe_renegotiation_status FUNCS += functions/gnutls_safe_renegotiation_status.short FUNCS += functions/gnutls_supplemental_get_name diff --git a/doc/cha-intro-tls.texi b/doc/cha-intro-tls.texi index 1f56ec55e6..88ca94cb60 100644 --- a/doc/cha-intro-tls.texi +++ b/doc/cha-intro-tls.texi @@ -446,21 +446,19 @@ idea, which is implemented in GnuTLS. The TLS extension which allows to request response from the peer in a way similar to ping command described in @xcite{RFC6520}. This extension is disabled by default - user have to call -@funcref{gnutls_heartbeat_allow} to enable it. Note: this will set +@funcref{gnutls_heartbeat_enable} to enable it. Note: this will set local policy affecting HeartBeat messages coming from the peer - the policy -could be checked via @funcref{gnutls_heartbeat_enabled_local}. The -same policy set by the peer for our messages could be checked via -@funcref{gnutls_heartbeat_enabled_remote}. The requests coming from -peer are answered automatically (if policy permits) inside -@funcref{record_add_to_buffers}, requests to peer could be send via +could be checked via @funcref{gnutls_heartbeat_allowed}. +The requests coming from peer are answered automatically (if policy permits) +inside @funcref{gnutls_record_recv}, requests to peer could be send via @funcref{gnutls_heartbeat_ping} or @funcref{gnutls_heartbeat_ping_rnd}. Each request triggers timeout which could be checked and manipulated with @funcref{gnutls_heartbeat_timeout}. Policy-related functions: -@showfuncB{gnutls_heartbeat_allow,gnutls_heartbeat_deny}, @showfuncB{gnutls_heartbeat_enabled_local,gnutls_heartbeat_enabled_remote} +@showfuncB{gnutls_heartbeat_allowed,gnutls_heartbeat_enable} Operational functions: -@showfuncB{gnutls_heartbeat_timeout},@showfuncB{gnutls_heartbeat_ping,gnutls_heartbeat_ping_rnd} +@showfuncC{gnutls_heartbeat_timeout,gnutls_heartbeat_ping,gnutls_heartbeat_ping_rnd} @node Safe renegotiation @subsection Safe renegotiation diff --git a/doc/invoke-gnutls-cli.texi b/doc/invoke-gnutls-cli.texi index b7c35c957c..f00fa04431 100644 --- a/doc/invoke-gnutls-cli.texi +++ b/doc/invoke-gnutls-cli.texi @@ -7,7 +7,7 @@ # # DO NOT EDIT THIS FILE (invoke-gnutls-cli.texi) # -# It has been AutoGen-ed June 6, 2012 at 09:11:09 PM by AutoGen 5.16 +# It has been AutoGen-ed September 1, 2012 at 11:10:28 AM by AutoGen 5.16 # From the definitions ../src/cli-args.def # and the template file agtexi-cmd.tpl @end ignore @@ -48,6 +48,7 @@ USAGE: gnutls-cli [ -<flag> [<val>] | --<name>[@{=| @}<val>] ]... [hostname] --ocsp Enable OCSP certificate verification - disabled as --no-ocsp -r, --resume Establish a session and resume + -b, --heartbeat Activate heartbeat support -e, --rehandshake Establish a session and rehandshake --noticket Don't accept session tickets -s, --starttls Connect, establish a plain session and start TLS. diff --git a/doc/invoke-gnutls-serv.texi b/doc/invoke-gnutls-serv.texi index bd7b686468..57da3b7205 100644 --- a/doc/invoke-gnutls-serv.texi +++ b/doc/invoke-gnutls-serv.texi @@ -7,7 +7,7 @@ # # DO NOT EDIT THIS FILE (invoke-gnutls-serv.texi) # -# It has been AutoGen-ed May 9, 2012 at 08:06:12 PM by AutoGen 5.16 +# It has been AutoGen-ed September 1, 2012 at 11:10:28 AM by AutoGen 5.16 # From the definitions ../src/serv-args.def # and the template file agtexi-cmd.tpl @end ignore @@ -52,6 +52,7 @@ USAGE: gnutls-serv [ -<flag> [<val>] | --<name>[@{=| @}<val>] ]... 0 to 17000 -a, --disable-client-cert Do not request a client certificate -r, --require-client-cert Require a client certificate + -b, --heartbeat Activate heartbeat support --x509fmtder Use DER format for certificates to read from --priority=str Priorities string --dhparams=file DH params file to use @@ -103,6 +104,12 @@ please send bug reports to: bug-gnutls@@gnu.org This is the ``enable debugging.'' option. This option takes an argument number. Specifies the debug level. +@anchor{gnutls-serv heartbeat} +@subheading heartbeat option (-b) +@cindex gnutls-serv-heartbeat + +This is the ``activate heartbeat support'' option. +Regularly ping client via heartbeat extension messages @anchor{gnutls-serv priority} @subheading priority option @cindex gnutls-serv-priority diff --git a/doc/manpages/Makefile.am b/doc/manpages/Makefile.am index 50492548b4..d599f882f2 100644 --- a/doc/manpages/Makefile.am +++ b/doc/manpages/Makefile.am @@ -268,6 +268,8 @@ APIMANS += gnutls_strerror_name.3 APIMANS += gnutls_handshake_set_private_extensions.3 APIMANS += gnutls_handshake_get_last_out.3 APIMANS += gnutls_handshake_get_last_in.3 +APIMANS += gnutls_heartbeat_ping.3 +APIMANS += gnutls_heartbeat_ping_rnd.3 APIMANS += gnutls_record_send.3 APIMANS += gnutls_record_recv.3 APIMANS += gnutls_record_recv_seq.3 @@ -281,7 +283,9 @@ APIMANS += gnutls_prf.3 APIMANS += gnutls_prf_raw.3 APIMANS += gnutls_server_name_set.3 APIMANS += gnutls_server_name_get.3 -APIMANS += gnutls_heartbeat_policy_set.3 +APIMANS += gnutls_heartbeat_enable.3 +APIMANS += gnutls_heartbeat_allowed.3 +APIMANS += gnutls_heartbeat_timeout.3 APIMANS += gnutls_safe_renegotiation_status.3 APIMANS += gnutls_supplemental_get_name.3 APIMANS += gnutls_session_ticket_key_generate.3 |