From fca2bc64b691cac529625a8ad36aefe9a4f9ad59 Mon Sep 17 00:00:00 2001 From: Laurent Bercot Date: Thu, 13 Oct 2022 19:20:47 +0000 Subject: More doc fixes Signed-off-by: Laurent Bercot --- doc/libsbearssl/index.html | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/doc/libsbearssl/index.html b/doc/libsbearssl/index.html index e9e7f88..d8ea6ee 100644 --- a/doc/libsbearssl/index.html +++ b/doc/libsbearssl/index.html @@ -473,7 +473,7 @@ means the given date doesn't fit the days/seconds format).

Sets the validation time for the X.509 context in *ctx to the absolute time contained in *t, which is a -tai_t. +tai. Returns 1 if it succeeds, or 0 if it fails - probably because *t does not represent a valid time.

@@ -482,8 +482,8 @@ because *t does not represent a valid time.

Same as the above function, except the time is given as a -tain_t, -i.e. a tai_t plus nanoseconds (which are simply ignored). +tain, +i.e. a tai plus nanoseconds (which are simply ignored).

void sbearssl_drop (void)

@@ -512,7 +512,7 @@ transmitted. The function returns 1 if it succeeds and 0 if it fails.

Running the TLS/SSL engine (internal function for both clients and servers)

-

void sbearssl_run (br_ssl_engine_context *ctx, int *fds, tain_t const *tto, uint32_t options, unsigned int verbosity, sbearssl_handshake_cb_t_ref cb, sbearssl_handshake_cb_context_t *cbarg)

+

void sbearssl_run (br_ssl_engine_context *ctx, int *fds, tain const *tto, uint32_t options, unsigned int verbosity, sbearssl_handshake_cb_t_ref cb, sbearssl_handshake_cb_context_t *cbarg)

This function runs a full-duplex TLS/SSL engine, reading/writing @@ -530,7 +530,7 @@ TLS/SSL handshake does not have to be completed. order: fd reading clear text, fd writing clear text, fd reading ciphertext, fd writing ciphertext.

  • tto is a pointer to a - tain_t + tain containing a relative time (i.e. a timeout) If *tto time elapses with no application data being exchanged, the engine will forcibly close the connection (with the method defined by options & 1). @@ -572,7 +572,7 @@ SSL/TLS connection closed cleanly, the process exits 0.

    Initializing and running the engine

    -

    void sbearssl_client_init_and_run (int *fds, tain_t const *tto, uint32_t preoptions, uint32_t options, unsigned int verbosity, char const *servername, sbearssl_handshake_cb_t_ref cb, unsigned int notif)

    +

    void sbearssl_client_init_and_run (int *fds, tain const *tto, uint32_t preoptions, uint32_t options, unsigned int verbosity, char const *servername, sbearssl_handshake_cb_t_ref cb, unsigned int notif)

    This function initializes a TLS context for a client-side connection, @@ -629,7 +629,7 @@ valid fd on which to write SSL data information once the handshake has completed.

    • -

    void sbearssl_server_init_and_run (int *fds, tain_t const *tto, uint32_t preoptions, uint32_t options, unsigned int verbosity, sbearssl_handshake_cb_t_ref cb, unsigned int notif)

    +

    void sbearssl_server_init_and_run (int *fds, tain const *tto, uint32_t preoptions, uint32_t options, unsigned int verbosity, sbearssl_handshake_cb_t_ref cb, unsigned int notif)

    Same as the previous function, but on the server side. No servername -- cgit v1.2.3