From: Andreas Schneider <asn@samba.org>
Date: Thu, 18 Jul 2019 07:03:51 +0000 (+0200)
Subject: lib:crypto: Document gnutls_error_to_ntstatus()
X-Git-Tag: tdb-1.4.2~476
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=5e62358fbf9ed107ed4a5eb82b62e82ae5638262;p=thirdparty%2Fsamba.git

lib:crypto: Document gnutls_error_to_ntstatus()

Signed-off-by: Andreas Schneider <asn@samba.org>
Reviewed-by: Andrew Bartlett <abartlet@samba.org>
---

diff --git a/lib/crypto/gnutls_helpers.h b/lib/crypto/gnutls_helpers.h
index 8a2a49baf73..797bfaaabf4 100644
--- a/lib/crypto/gnutls_helpers.h
+++ b/lib/crypto/gnutls_helpers.h
@@ -32,6 +32,21 @@
 #define GNUTLS_FIPS140_SET_STRICT_MODE()
 #endif
 
+#ifdef DOXYGEN
+/**
+ * @brief Convert a gnutls error code to a corresponding NTSTATUS.
+ *
+ * @param[in]  gnutls_rc      The GnuTLS return code.
+ *
+ * @param[in]  blocked_status The NTSTATUS return code which should be returned
+ *                            in case the e.g. the cipher might be blocked due
+ *                            to FIPS mode.
+ *
+ * @return A corresponding NTSTATUS code.
+ */
+NTSTATUS gnutls_error_to_ntstatus(int gnutls_rc,
+				  NTSTATUS blocked_status);
+#else
 NTSTATUS _gnutls_error_to_ntstatus(int gnutls_rc,
 				   NTSTATUS blocked_status,
 				   const char *function,
@@ -39,6 +54,7 @@ NTSTATUS _gnutls_error_to_ntstatus(int gnutls_rc,
 #define gnutls_error_to_ntstatus(gnutls_rc, blocked_status) \
 	_gnutls_error_to_ntstatus(gnutls_rc, blocked_status, \
 				  __FUNCTION__, __location__)
+#endif
 
 WERROR _gnutls_error_to_werror(int gnutls_rc,
 			       WERROR blocked_werr,