diff options
Diffstat (limited to 'doc/functions/gnutls_fips140_set_mode')
-rw-r--r-- | doc/functions/gnutls_fips140_set_mode | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/doc/functions/gnutls_fips140_set_mode b/doc/functions/gnutls_fips140_set_mode new file mode 100644 index 0000000..703a1b4 --- /dev/null +++ b/doc/functions/gnutls_fips140_set_mode @@ -0,0 +1,26 @@ + + + + +@deftypefun {void} {gnutls_fips140_set_mode} (gnutls_fips_mode_t @var{mode}, unsigned @var{flags}) +@var{mode}: the FIPS140-2 mode to switch to + +@var{flags}: should be zero or @code{GNUTLS_FIPS140_SET_MODE_THREAD} + +That function is not thread-safe when changing the mode with no flags +(globally), and should be called prior to creating any threads. Its +behavior with no flags after threads are created is undefined. + +When the flag @code{GNUTLS_FIPS140_SET_MODE_THREAD} is specified +then this call will change the FIPS140-2 mode for this particular +thread and not for the whole process. That way an application +can utilize this function to set and reset mode for specific +operations. + +This function never fails but will be a no-op if used when +the library is not in FIPS140-2 mode. When asked to switch to unknown +values for @code{mode} or to @code{GNUTLS_FIPS140_SELFTESTS} mode, the library +switches to @code{GNUTLS_FIPS140_STRICT} mode. + +@strong{Since:} 3.6.2 +@end deftypefun |