From: Stephan Bosch <stephan.bosch@open-xchange.com>
Date: Tue, 21 Mar 2023 23:49:04 +0000 (+0100)
Subject: auth: Move contents of mech.h to sasl-server headers
X-Git-Tag: 2.4.2~297
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=537dd456afb6eb944ed2a6344a532c27dca43fe2;p=thirdparty%2Fdovecot%2Fcore.git

auth: Move contents of mech.h to sasl-server headers
---

diff --git a/src/auth/Makefile.am b/src/auth/Makefile.am
index a13f719810..b8ed497414 100644
--- a/src/auth/Makefile.am
+++ b/src/auth/Makefile.am
@@ -163,9 +163,10 @@ headers = \
 	db-sql.h \
 	db-passwd-file.h \
 	db-oauth2.h \
-	mech.h \
 	mech-otp.h \
 	mech-digest-md5-private.h \
+	sasl-server.h \
+	sasl-server-protected.h \
 	sasl-server-mech-plain-common.h \
 	sasl-server-mech-scram.h \
 	passdb.h \
diff --git a/src/auth/auth-client-connection.c b/src/auth/auth-client-connection.c
index e281ad3800..48a1a6dfde 100644
--- a/src/auth/auth-client-connection.c
+++ b/src/auth/auth-client-connection.c
@@ -10,7 +10,7 @@
 #include "str-sanitize.h"
 #include "randgen.h"
 #include "master-service.h"
-#include "mech.h"
+#include "sasl-server-protected.h" // FIXME: remove
 #include "auth-request-handler.h"
 #include "auth-client-interface.h"
 #include "auth-client-connection.h"
diff --git a/src/auth/auth-request-handler-private.h b/src/auth/auth-request-handler-private.h
index 4d733dfb16..f2dbca0c11 100644
--- a/src/auth/auth-request-handler-private.h
+++ b/src/auth/auth-request-handler-private.h
@@ -1,6 +1,8 @@
 #ifndef AUTH_REQUEST_HANDLER_PRIVATE_H
 #define AUTH_REQUEST_HANDLER_PRIVATE_H
 
+#include "auth-request-handler.h"
+
 struct auth_request;
 struct auth_client_connection;
 
diff --git a/src/auth/auth-request.h b/src/auth/auth-request.h
index cfe3d223f3..414283382a 100644
--- a/src/auth/auth-request.h
+++ b/src/auth/auth-request.h
@@ -8,7 +8,7 @@
 #include "array.h"
 #include "net.h"
 #include "var-expand.h"
-#include "mech.h"
+#include "sasl-server-protected.h" // FIXME: Use public API only
 #include "userdb.h"
 #include "passdb.h"
 #include "auth-request-var-expand.h"
diff --git a/src/auth/auth-sasl-mech-apop.c b/src/auth/auth-sasl-mech-apop.c
index a3d3c5bdf3..d00533ee27 100644
--- a/src/auth/auth-sasl-mech-apop.c
+++ b/src/auth/auth-sasl-mech-apop.c
@@ -7,10 +7,10 @@
  */
 
 #include "auth-common.h"
-#include "mech.h"
 #include "passdb.h"
 #include "md5.h"
 #include "buffer.h"
+#include "sasl-server-protected.h"
 #include "auth-client-connection.h"
 #include "auth-master-connection.h"
 
diff --git a/src/auth/auth-sasl-mech-dovecot-token.c b/src/auth/auth-sasl-mech-dovecot-token.c
index 7282269cf2..e48c609f2e 100644
--- a/src/auth/auth-sasl-mech-dovecot-token.c
+++ b/src/auth/auth-sasl-mech-dovecot-token.c
@@ -4,8 +4,8 @@
    (e.g. imap to imap-urlauth). See auth-token.c */
 
 #include "auth-common.h"
-#include "mech.h"
 #include "safe-memset.h"
+#include "sasl-server-protected.h"
 #include "auth-token.h"
 
 static void
diff --git a/src/auth/auth.c b/src/auth/auth.c
index bb6ead9141..738d07cc20 100644
--- a/src/auth/auth.c
+++ b/src/auth/auth.c
@@ -3,7 +3,6 @@
 #include "auth-common.h"
 #include "array.h"
 #include "settings.h"
-#include "mech.h"
 #include "userdb.h"
 #include "passdb.h"
 #include "auth.h"
diff --git a/src/auth/main.c b/src/auth/main.c
index 6151eb521a..a85b8dca39 100644
--- a/src/auth/main.c
+++ b/src/auth/main.c
@@ -19,7 +19,7 @@
 #include "dict.h"
 #include "password-scheme.h"
 #include "passdb-cache.h"
-#include "mech.h"
+#include "sasl-server-protected.h"
 #include "otp.h"
 #include "mech-otp.h"
 #include "auth.h"
diff --git a/src/auth/mech.c b/src/auth/mech.c
index cd3c186fd1..c1fcabbdac 100644
--- a/src/auth/mech.c
+++ b/src/auth/mech.c
@@ -2,11 +2,12 @@
 
 #include "auth-common.h"
 #include "ioloop.h"
-#include "mech.h"
 #include "str.h"
 #include "strfuncs.h"
 #include "passdb.h"
 
+#include "sasl-server-private.h"
+
 #include <ctype.h>
 
 static struct mech_module_list *mech_modules;
diff --git a/src/auth/sasl-server-mech-anonymous.c b/src/auth/sasl-server-mech-anonymous.c
index 6503bf13fd..d0a729bb60 100644
--- a/src/auth/sasl-server-mech-anonymous.c
+++ b/src/auth/sasl-server-mech-anonymous.c
@@ -1,7 +1,8 @@
 /* Copyright (c) 2002-2018 Dovecot authors, see the included COPYING file */
 
 #include "auth-common.h"
-#include "mech.h"
+
+#include "sasl-server-protected.h"
 
 static void
 mech_anonymous_auth_continue(struct auth_request *request,
diff --git a/src/auth/sasl-server-mech-cram-md5.c b/src/auth/sasl-server-mech-cram-md5.c
index 9536d065e7..e5956073cf 100644
--- a/src/auth/sasl-server-mech-cram-md5.c
+++ b/src/auth/sasl-server-mech-cram-md5.c
@@ -11,10 +11,11 @@
 #include "hmac.h"
 #include "md5.h"
 #include "randgen.h"
-#include "mech.h"
 #include "passdb.h"
 #include "hostpid.h"
 
+#include "sasl-server-protected.h"
+
 #include <time.h>
 
 struct cram_auth_request {
diff --git a/src/auth/sasl-server-mech-digest-md5.c b/src/auth/sasl-server-mech-digest-md5.c
index cf65a993fd..f6b9f586d1 100644
--- a/src/auth/sasl-server-mech-digest-md5.c
+++ b/src/auth/sasl-server-mech-digest-md5.c
@@ -11,10 +11,11 @@
 #include "randgen.h"
 #include "str.h"
 #include "str-sanitize.h"
-#include "mech.h"
 #include "passdb.h"
 #include "settings-parser.h"
 
+#include "sasl-server-protected.h"
+
 /* Linear whitespace */
 #define IS_LWS(c) ((c) == ' ' || (c) == '\t')
 
diff --git a/src/auth/sasl-server-mech-external.c b/src/auth/sasl-server-mech-external.c
index a2c3511729..281fd32ab7 100644
--- a/src/auth/sasl-server-mech-external.c
+++ b/src/auth/sasl-server-mech-external.c
@@ -2,7 +2,8 @@
 
 #include "auth-common.h"
 #include "passdb.h"
-#include "mech.h"
+
+#include "sasl-server-protected.h"
 #include "sasl-server-mech-plain-common.h"
 
 static void
diff --git a/src/auth/sasl-server-mech-gssapi.c b/src/auth/sasl-server-mech-gssapi.c
index 0ce1c06034..efcee7bb81 100644
--- a/src/auth/sasl-server-mech-gssapi.c
+++ b/src/auth/sasl-server-mech-gssapi.c
@@ -18,9 +18,10 @@
 #include "str-sanitize.h"
 #include "hex-binary.h"
 #include "safe-memset.h"
-#include "mech.h"
 #include "passdb.h"
 
+#include "sasl-server-protected.h"
+
 #if defined(BUILTIN_GSSAPI) || defined(PLUGIN_BUILD)
 
 #ifdef HAVE_GSSAPI_GSSAPI_H
diff --git a/src/auth/sasl-server-mech-login.c b/src/auth/sasl-server-mech-login.c
index cf5c86ae35..f0bcfc8c2c 100644
--- a/src/auth/sasl-server-mech-login.c
+++ b/src/auth/sasl-server-mech-login.c
@@ -7,11 +7,11 @@
  */
 
 #include "auth-common.h"
-#include "mech.h"
 #include "passdb.h"
 #include "safe-memset.h"
-#include "sasl-server-mech-plain-common.h"
 
+#include "sasl-server-protected.h"
+#include "sasl-server-mech-plain-common.h"
 
 static void
 mech_login_auth_continue(struct auth_request *request,
diff --git a/src/auth/sasl-server-mech-oauth2.c b/src/auth/sasl-server-mech-oauth2.c
index 5650532db9..af4e26a2f2 100644
--- a/src/auth/sasl-server-mech-oauth2.c
+++ b/src/auth/sasl-server-mech-oauth2.c
@@ -7,12 +7,13 @@
 #include "str.h"
 #include "strescape.h"
 #include "json-ostream.h"
-#include "mech.h"
 #include "passdb.h"
 #include "auth-gs2.h"
 #include "db-oauth2.h"
 #include "oauth2.h"
 
+#include "sasl-server-protected.h"
+
 struct oauth2_auth_request {
 	struct auth_request request;
 	struct db_oauth2 *db;
diff --git a/src/auth/sasl-server-mech-otp.c b/src/auth/sasl-server-mech-otp.c
index 9f1272df93..cd6fbc1953 100644
--- a/src/auth/sasl-server-mech-otp.c
+++ b/src/auth/sasl-server-mech-otp.c
@@ -9,11 +9,11 @@
 #include "auth-common.h"
 #include "safe-memset.h"
 #include "hash.h"
-#include "mech.h"
 #include "passdb.h"
 #include "hex-binary.h"
 #include "otp.h"
 
+#include "sasl-server-protected.h"
 #include "mech-otp.h"
 
 struct otp_auth_request {
diff --git a/src/auth/sasl-server-mech-plain-common.c b/src/auth/sasl-server-mech-plain-common.c
index 41a15b4f3a..377f1e03ff 100644
--- a/src/auth/sasl-server-mech-plain-common.c
+++ b/src/auth/sasl-server-mech-plain-common.c
@@ -1,8 +1,9 @@
 /* Copyright (c) 2009-2018 Dovecot authors, see the included COPYING file */
 
 #include "auth-common.h"
-#include "mech.h"
 #include "passdb.h"
+
+#include "sasl-server-protected.h"
 #include "sasl-server-mech-plain-common.h"
 
 void plain_verify_callback(enum passdb_result result,
diff --git a/src/auth/sasl-server-mech-plain.c b/src/auth/sasl-server-mech-plain.c
index 47f8470f26..5bebeb3770 100644
--- a/src/auth/sasl-server-mech-plain.c
+++ b/src/auth/sasl-server-mech-plain.c
@@ -2,8 +2,9 @@
 
 #include "auth-common.h"
 #include "safe-memset.h"
-#include "mech.h"
 #include "passdb.h"
+
+#include "sasl-server-protected.h"
 #include "sasl-server-mech-plain-common.h"
 
 static void
diff --git a/src/auth/sasl-server-mech-scram.c b/src/auth/sasl-server-mech-scram.c
index 8d5ffd747d..7522e3fe36 100644
--- a/src/auth/sasl-server-mech-scram.c
+++ b/src/auth/sasl-server-mech-scram.c
@@ -4,7 +4,8 @@
 #include "sha1.h"
 #include "sha2.h"
 #include "auth-scram-server.h"
-#include "mech.h"
+
+#include "sasl-server-protected.h"
 #include "sasl-server-mech-scram.h"
 
 struct scram_auth_request {
diff --git a/src/auth/sasl-server-mech-winbind.c b/src/auth/sasl-server-mech-winbind.c
index d8022d8be1..0b67c38b0e 100644
--- a/src/auth/sasl-server-mech-winbind.c
+++ b/src/auth/sasl-server-mech-winbind.c
@@ -9,7 +9,6 @@
 
 #include "auth-common.h"
 #include "lib-signals.h"
-#include "mech.h"
 #include "str.h"
 #include "buffer.h"
 #include "base64.h"
@@ -17,6 +16,8 @@
 #include "istream.h"
 #include "ostream.h"
 
+#include "sasl-server-protected.h"
+
 #include <unistd.h>
 #include <sys/wait.h>
 
diff --git a/src/auth/sasl-server-private.h b/src/auth/sasl-server-private.h
new file mode 100644
index 0000000000..a19d3421eb
--- /dev/null
+++ b/src/auth/sasl-server-private.h
@@ -0,0 +1,6 @@
+#ifndef SASL_SERVER_PRIVATE_H
+#define SASL_SERVER_PRIVATE_H
+
+#include "sasl-server-protected.h"
+
+#endif
diff --git a/src/auth/mech.h b/src/auth/sasl-server-protected.h
similarity index 67%
rename from src/auth/mech.h
rename to src/auth/sasl-server-protected.h
index ffd7838da9..8b5110dbfd 100644
--- a/src/auth/mech.h
+++ b/src/auth/sasl-server-protected.h
@@ -1,28 +1,11 @@
-#ifndef MECH_H
-#define MECH_H
+#ifndef SASL_SERVER_PROTECTED_H
+#define SASL_SERVER_PROTECTED_H
 
-#include "auth-client-interface.h"
-
-struct auth_settings;
-struct auth_request;
-
-#include "auth-request.h"
 #include "auth-request-handler.h"
 
-enum mech_passdb_need {
-	/* Mechanism doesn't need a passdb at all */
-	MECH_PASSDB_NEED_NOTHING = 0,
-	/* Mechanism just needs to verify a given plaintext password */
-	MECH_PASSDB_NEED_VERIFY_PLAIN,
-	/* Mechanism needs to verify a given challenge+response combination,
-	   i.e. there is only a single response from client.
-	   (Currently implemented the same as _LOOKUP_CREDENTIALS) */
-	MECH_PASSDB_NEED_VERIFY_RESPONSE,
-	/* Mechanism needs to look up credentials with appropriate scheme */
-	MECH_PASSDB_NEED_LOOKUP_CREDENTIALS,
-	/* Mechanism needs to look up credentials and also modify them */
-	MECH_PASSDB_NEED_SET_CREDENTIALS
-};
+#include "sasl-server.h"
+
+struct auth_request;
 
 struct mech_module {
 	const char *mech_name;
diff --git a/src/auth/sasl-server.h b/src/auth/sasl-server.h
new file mode 100644
index 0000000000..8cba0788a2
--- /dev/null
+++ b/src/auth/sasl-server.h
@@ -0,0 +1,23 @@
+#ifndef SASL_SERVER_H
+#define SASL_SERVER_H
+
+#include "auth-client-interface.h"
+
+#include "passdb.h"
+
+enum mech_passdb_need {
+	/* Mechanism doesn't need a passdb at all */
+	MECH_PASSDB_NEED_NOTHING = 0,
+	/* Mechanism just needs to verify a given plaintext password */
+	MECH_PASSDB_NEED_VERIFY_PLAIN,
+	/* Mechanism needs to verify a given challenge+response combination,
+	   i.e. there is only a single response from client.
+	   (Currently implemented the same as _LOOKUP_CREDENTIALS) */
+	MECH_PASSDB_NEED_VERIFY_RESPONSE,
+	/* Mechanism needs to look up credentials with appropriate scheme */
+	MECH_PASSDB_NEED_LOOKUP_CREDENTIALS,
+	/* Mechanism needs to look up credentials and also modify them */
+	MECH_PASSDB_NEED_SET_CREDENTIALS
+};
+
+#endif
diff --git a/src/auth/test-auth.c b/src/auth/test-auth.c
index be8b42ebc6..7d6c8a20e9 100644
--- a/src/auth/test-auth.c
+++ b/src/auth/test-auth.c
@@ -6,7 +6,7 @@
 #include "auth-settings.h"
 #include "auth-token.h"
 #include "auth-penalty.h"
-#include "mech.h"
+#include "sasl-server-protected.h" // FIXME: remove
 #include "otp.h"
 #include "mech-otp.h"
 #include "db-oauth2.h"