1524bc
From 8391caf4f4aa8fed5167b5e5cf04197a29ba40e8 Mon Sep 17 00:00:00 2001
1524bc
From: Andreas Schneider <asn@samba.org>
1524bc
Date: Thu, 18 Jul 2019 13:27:57 +0200
1524bc
Subject: [PATCH 006/187] lib:crypto: Document gnutls_error_to_werror()
1524bc
1524bc
Signed-off-by: Andreas Schneider <asn@samba.org>
1524bc
Reviewed-by: Andrew Bartlett <abartlet@samba.org>
1524bc
(cherry picked from commit e43678b84a3434b977f44b265599f1d9207d3b78)
1524bc
---
1524bc
 lib/crypto/gnutls_helpers.h | 16 ++++++++++++++++
1524bc
 1 file changed, 16 insertions(+)
1524bc
1524bc
diff --git a/lib/crypto/gnutls_helpers.h b/lib/crypto/gnutls_helpers.h
1524bc
index 8a2a49baf73..debaa701554 100644
1524bc
--- a/lib/crypto/gnutls_helpers.h
1524bc
+++ b/lib/crypto/gnutls_helpers.h
1524bc
@@ -40,6 +40,21 @@ NTSTATUS _gnutls_error_to_ntstatus(int gnutls_rc,
1524bc
 	_gnutls_error_to_ntstatus(gnutls_rc, blocked_status, \
1524bc
 				  __FUNCTION__, __location__)
1524bc
 
1524bc
+#ifdef DOXYGEN
1524bc
+/**
1524bc
+ * @brief Convert a gnutls error code to a corresponding WERROR.
1524bc
+ *
1524bc
+ * @param[in]  gnutls_rc      The GnuTLS return code.
1524bc
+ *
1524bc
+ * @param[in]  blocked_werr   The WERROR code which should be returned if e.g
1524bc
+ *                            the cipher we want to used it not allowed to be
1524bc
+ *                            used because of FIPS mode.
1524bc
+ *
1524bc
+ * @return A corresponding WERROR code.
1524bc
+ */
1524bc
+WERROR gnutls_error_to_werror(int gnutls_rc,
1524bc
+			       WERROR blocked_werr);
1524bc
+#else
1524bc
 WERROR _gnutls_error_to_werror(int gnutls_rc,
1524bc
 			       WERROR blocked_werr,
1524bc
 			       const char *function,
1524bc
@@ -47,6 +62,7 @@ WERROR _gnutls_error_to_werror(int gnutls_rc,
1524bc
 #define gnutls_error_to_werror(gnutls_rc, blocked_werr) \
1524bc
 	_gnutls_error_to_werror(gnutls_rc, blocked_werr, \
1524bc
 				__FUNCTION__, __location__)
1524bc
+#endif
1524bc
 
1524bc
 enum samba_gnutls_direction {
1524bc
 	SAMBA_GNUTLS_ENCRYPT,
1524bc
-- 
1524bc
2.23.0
1524bc