Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help 
oath_totp_generate(3)		     liboath		   oath_totp_generate(3)

NAME
     oath_totp_generate - API function

SYNOPSIS
     #include <oath.h>

     int  oath_totp_generate(const  char  * secret, size_t secret_length, time_t
     now, unsigned time_step_size, time_t start_offset, unsigned digits, char  *
     output_otp);

ARGUMENTS
     const char * secret
		 the shared secret string

     size_t secret_length
		 length of secret

     time_t now  Unix time value to compute TOTP for

     unsigned time_step_size
		 time step system parameter (typically 30)

     time_t start_offset
		 Unix time of when to start counting time steps (typically 0)

     unsigned digits
		 number of requested digits in the OTP, excluding checksum

     char * output_otp
		 output buffer, must have room for the output OTP plus zero

DESCRIPTION
     Generate  a  one-time-password  using  the  time-variant TOTP algorithm de-
     scribed in RFC 6238.  The input parameters are taken as time values.

     The system parameter time_step_size describes how long the time window  for
     each  OTP	is.   The  recommended	value is 30 seconds, and you can use the
     value 0 or the symbol OATH_TOTP_DEFAULT_TIME_STEP_SIZE to indicate this.

     The system parameter start_offset denote the Unix time when time steps  are
     started  to  be  counted.	 The recommended value is 0, to fall back on the
     Unix epoch) and you can use the symbol OATH_TOTP_DEFAULT_START_TIME to  in-
     dicate this.

     The  output_otp  buffer must have room for at least digits characters, plus
     one for the terminating NUL.

     Currently only values 6, 7 and 8 for digits are supported.   This	restric-
     tion may be lifted in future versions.

RETURNS
     On  success,  OATH_OK  (zero)  is	returned, otherwise an error code is re-
     turned.

SINCE
     1.4.0

REPORTING BUGS
     Report  bugs  to  <oath-toolkit-help@nongnu.org>.	  liboath   home   page:
     https://oath-toolkit.codeberg.page/   General   help  using  GNU  software:
     http://www.gnu.org/gethelp/

COPYRIGHT
     Copyright (C) 2009-2026 Simon Josefsson.
     Copying and distribution of this file, with or  without  modification,  are
     permitted	in  any medium without royalty provided the copyright notice and
     this notice are preserved.

liboath 			     2.6.14		   oath_totp_generate(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=oath_totp_generate&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>

home | help