From 09d28e3088ecc8435b25bda49b5be52f0c453ba9 Mon Sep 17 00:00:00 2001 From: Laurent Bercot Date: Thu, 13 Oct 2022 19:18:47 +0000 Subject: Doc fixes Signed-off-by: Laurent Bercot --- doc/libsbearssl/index.html | 26 +++++++++++++++++++++----- 1 file changed, 21 insertions(+), 5 deletions(-) diff --git a/doc/libsbearssl/index.html b/doc/libsbearssl/index.html index 0c53c14..e9e7f88 100644 --- a/doc/libsbearssl/index.html +++ b/doc/libsbearssl/index.html @@ -452,7 +452,23 @@ interpreted via this function. looks like a DER-encoded object. Returns 1 if it does and 0 otherwise.

-

int sbearssl_x509_minimal_set_tai (br_x509_minimal_context *ctx, tai_t t)

+

int sbearssl_tai_from_dayseconds (tai *t, uint32_t days, uint32_t seconds)

+ +

+ Makes a TAI absolute time from the date given in days and seconds as +provided in an x509 certificate. Returns 1 on success and 0 on failure +(which probably means days/seconds don't encode a valid date). +

+ +

int sbearssl_dayseconds_from_tai (uint32_t *days, uint32_t *seconds, tai const *t)

+ +

+ Compute suitable days and seconds, for an x509 certificate, from an +absolute TAI date. Returns 1 on success and 0 on failure (which probably +means the given date doesn't fit the days/seconds format). +

+ +

int sbearssl_x509_minimal_set_tai (br_x509_minimal_context *ctx, tai const *t)

Sets the validation time for the X.509 context in *ctx to @@ -462,7 +478,7 @@ Returns 1 if it succeeds, or 0 if it fails - probably because *t does not represent a valid time.

-

int sbearssl_x509_minimal_set_tain (br_x509_minimal_context *ctx, tain_t a)

+

int sbearssl_x509_minimal_set_tain (br_x509_minimal_context *ctx, tain const *a)

Same as the above function, except the time is given as a @@ -470,7 +486,7 @@ because *t does not represent a valid time. i.e. a tai_t plus nanoseconds (which are simply ignored).

-

void sbearssl_drop ()

+

void sbearssl_drop (void)

If the process is running as root, then this function drops its privileges @@ -584,7 +600,7 @@ exits 100 with an error message. order: the fd reading from the application (cleartext), the fd writing to the application (cleartext), the fd reading from the network, the fd writing to the network. -

  • preoptions : a bitfield. +
  • preoptions : a bitfield.
    • Bit 0: if clear, no client authentication is performed. If set, the CERTFILE and KEYFILE environment variables are read, @@ -593,7 +609,7 @@ they must contain the path to a valid client certificate and private key server for client authentication. This feature is currently unsupported and will not work; leave that bit clear for now.
  • -
  • options : a bitfield, which will be passed to +
  • options : a bitfield, which will be passed to sbearssl_run().
    • Bit 0: if clear, no close_notify is performed and the engine -- cgit v1.2.3