1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
|
# Copyright (c) 2017, 2025, Oracle and/or its affiliates.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License, version 2.0,
# as published by the Free Software Foundation.
#
# This program is designed to work with certain software (including
# but not limited to OpenSSL) that is licensed under separate terms,
# as designated in a particular file or component or in included license
# documentation. The authors of MySQL hereby grant you an additional
# permission to link the program and your derivative works with the
# separately licensed software that they have either included with
# the program or referenced in the documentation.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License, version 2.0, for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
# cmake -DWITH_SASL=system|</path/to/custom/installation>
# system is the default
# Custom path is only supported for LINUX_STANDALONE and WIN32 platforms.
INCLUDE (CheckIncludeFile)
INCLUDE (CheckIncludeFiles)
SET(WITH_SASL_DOC "\nsystem (use the OS sasl library)")
STRING_APPEND(WITH_SASL_DOC ", \n</path/to/custom/installation>")
STRING(REPLACE "\n" "| " WITH_SASL_DOC_STRING "${WITH_SASL_DOC}")
MACRO(RESET_SASL_VARIABLES)
UNSET(SASL_INCLUDE_DIR)
UNSET(SASL_INCLUDE_DIR CACHE)
UNSET(SASL_LIBRARY)
UNSET(SASL_LIBRARY CACHE)
UNSET(SASL_ROOT_DIR)
UNSET(SASL_ROOT_DIR CACHE)
UNSET(WITH_SASL)
UNSET(WITH_SASL CACHE)
UNSET(WITH_SASL_PATH)
UNSET(WITH_SASL_PATH CACHE)
UNSET(HAVE_CUSTOM_SASL_SASL_H)
UNSET(HAVE_CUSTOM_SASL_SASL_H CACHE)
UNSET(HAVE_SASL_SASL_H)
UNSET(HAVE_SASL_SASL_H CACHE)
ENDMACRO()
FUNCTION(WARN_MISSING_SYSTEM_SASL OUTPUT_WARNING)
# The SASL scram plugin is not needed for build, but it is needed for testing.
IF(SASL_SYSTEM_LIBRARY)
IF(SASL_SYSTEM_SCRAM_LIBRARY)
RETURN()
ELSEIF(SASL_VERSION VERSION_LESS "2.1.25")
MESSAGE(WARNING "SASL version is ${SASL_VERSION} SCRAM not supported")
RETURN()
ENDIF()
ENDIF()
IF(WITH_SASL STREQUAL "system")
SET(DEBIAN_PKGS "libsasl2-dev libsasl2-modules-gssapi-mit")
SET(REDHAT_PKGS "cyrus-sasl-devel cyrus-sasl-scram")
SET(SUSE_PKGS "cyrus-sasl-devel cyrus-sasl-scram")
MESSAGE(WARNING "Cannot find SASL development libraries. "
"You need to install the required packages:\n"
" Debian/Ubuntu: apt install ${DEBIAN_PKGS}\n"
" RedHat/Fedora/Oracle Linux: yum install ${REDHAT_PKGS}\n"
" SuSE: zypper install ${SUSE_PKGS}\n"
)
SET(${OUTPUT_WARNING} 1 PARENT_SCOPE)
ENDIF()
ENDFUNCTION()
MACRO(FIND_SASL_VERSION)
IF(SASL_INCLUDE_DIR AND EXISTS "${SASL_INCLUDE_DIR}/sasl/sasl.h")
FOREACH(version_part
SASL_VERSION_MAJOR
SASL_VERSION_MINOR
SASL_VERSION_STEP)
# Find the #define and extract the number.
FILE(STRINGS "${SASL_INCLUDE_DIR}/sasl/sasl.h" ${version_part}
REGEX "^#[\t ]*define[\t ]+${version_part}[\t ]+([0-9]+).*")
STRING(REGEX REPLACE
"^.*${version_part}[\t ]+([0-9]+).*" "\\1"
${version_part} "${${version_part}}")
ENDFOREACH()
SET(SASL_VERSION
"${SASL_VERSION_MAJOR}.${SASL_VERSION_MINOR}.${SASL_VERSION_STEP}")
SET(SASL_VERSION "${SASL_VERSION}" CACHE INTERNAL "SASL major.minor.step")
MESSAGE(STATUS "SASL_VERSION (${WITH_SASL}) is ${SASL_VERSION}")
FILE(READ "${SASL_INCLUDE_DIR}/sasl/sasl.h" SASL_HEADER_TEXT)
STRING(FIND "${SASL_HEADER_TEXT}" "LIBSASL_API int sasl_client_done"
HAVE_SASL_CLIENT_DONE)
IF(${HAVE_SASL_CLIENT_DONE} EQUAL -1)
SET(SASL_CLIENT_DONE_SUPPORTED 0)
ELSE()
SET(SASL_CLIENT_DONE_SUPPORTED 1)
ENDIF()
ENDIF()
ENDMACRO()
MACRO(FIND_SYSTEM_SASL)
# Cyrus SASL 2.1.26 on Solaris 11.4 has a bug that requires sys/types.h
# to be included before checking if sasl/sasl.h exists
CHECK_INCLUDE_FILES("sys/types.h;sasl/sasl.h" HAVE_SASL_SASL_H)
IF(HAVE_SASL_SASL_H)
FIND_PATH(SASL_INCLUDE_DIR NAMES "sasl/sasl.h")
ENDIF()
FIND_LIBRARY(SASL_SYSTEM_LIBRARY NAMES "sasl2" "sasl")
FIND_LIBRARY(SASL_SYSTEM_SCRAM_LIBRARY NAMES scram PATH_SUFFIXES sasl2)
# SCRAM library found, setting SCRAM_LIB_CONFIGURED to 1.
# SCRAM_LIB_CONFIGURED will be used to construct supported SASL methods.
IF(SASL_SYSTEM_SCRAM_LIBRARY)
SET(SCRAM_LIB_CONFIGURED 1)
ENDIF()
IF (SASL_SYSTEM_LIBRARY)
SET(SASL_LIBRARY ${SASL_SYSTEM_LIBRARY})
MESSAGE(STATUS "SASL_LIBRARY ${SASL_LIBRARY}")
IF(APPLE)
SET(SASL_WITHOUT_KERBEROS 1)
ENDIF()
ENDIF()
ENDMACRO(FIND_SYSTEM_SASL)
# Lookup and copy all plugins
# lib/sasl2/libanonymous.so
# lib/sasl2/libcrammd5.so
# lib/sasl2/libdigestmd5.so
# lib/sasl2/libgs2.so
# lib/sasl2/libgssapiv2.so
# lib/sasl2/libplain.so
# lib/sasl2/libscram.so
SET(CUSTOM_SASL_PLUGINS
anonymous
crammd5
digestmd5
gs2
gssapiv2
plain
scram
)
MACRO(FIND_CUSTOM_SASL)
# First search in WITH_SASL_PATH.
FIND_PATH(SASL_ROOT_DIR
NAMES include/sasl/sasl.h
NO_CMAKE_PATH
NO_CMAKE_ENVIRONMENT_PATH
HINTS ${WITH_SASL_PATH}
)
# Then search in standard places (if not found above).
FIND_PATH(SASL_ROOT_DIR
NAMES include/sasl/sasl.h
)
FIND_PATH(SASL_INCLUDE_DIR
NAMES sasl/sasl.h
HINTS ${SASL_ROOT_DIR}/include
)
# The static library has all the plugins built-in.
LIST(REVERSE CMAKE_FIND_LIBRARY_SUFFIXES)
FIND_LIBRARY(SASL_STATIC_LIBRARY
NAMES sasl2 sasl libsasl
PATHS ${WITH_SASL}/lib
NO_DEFAULT_PATH
NO_CMAKE_ENVIRONMENT_PATH
NO_SYSTEM_ENVIRONMENT_PATH)
LIST(REVERSE CMAKE_FIND_LIBRARY_SUFFIXES)
FIND_LIBRARY(SASL_CUSTOM_LIBRARY
NAMES sasl2 sasl libsasl
PATHS ${WITH_SASL}/lib
NO_DEFAULT_PATH
NO_CMAKE_ENVIRONMENT_PATH
NO_SYSTEM_ENVIRONMENT_PATH
)
IF(SASL_CUSTOM_LIBRARY)
SET(SASL_LIBRARY ${SASL_CUSTOM_LIBRARY})
MESSAGE(STATUS "SASL_LIBRARY ${SASL_LIBRARY}")
ENDIF()
IF(LINUX_STANDALONE)
FOREACH(SASL_PLUGIN ${CUSTOM_SASL_PLUGINS})
SET(VAR_NAME "SASL_CUSTOM_PLUGIN_${SASL_PLUGIN}")
FIND_LIBRARY(${VAR_NAME}
NAMES "${SASL_PLUGIN}"
PATHS ${WITH_SASL}/lib/sasl2
NO_DEFAULT_PATH
NO_CMAKE_ENVIRONMENT_PATH
NO_SYSTEM_ENVIRONMENT_PATH
)
IF(NOT ${VAR_NAME})
MESSAGE(FATAL_ERROR
"Could not find plugin lib${SASL_PLUGIN}.so in ${WITH_SASL}/lib/sasl2")
ENDIF()
ENDFOREACH()
# SCRAM library found, setting SCRAM_LIB_CONFIGURED to 1.
# SCRAM_LIB_CONFIGURED will be used to construct supported SASL methods.
SET(SCRAM_LIB_CONFIGURED 1)
ENDIF()
IF(SASL_INCLUDE_DIR)
INCLUDE_DIRECTORIES(BEFORE SYSTEM "${SASL_INCLUDE_DIR}")
CMAKE_PUSH_CHECK_STATE()
SET(CMAKE_REQUIRED_INCLUDES "${SASL_INCLUDE_DIR}")
# Windows users doing 'git pull' will have cached HAVE_SASL_SASL_H=""
CHECK_INCLUDE_FILE(sasl/sasl.h HAVE_CUSTOM_SASL_SASL_H)
IF(HAVE_CUSTOM_SASL_SASL_H)
SET(HAVE_SASL_SASL_H 1 CACHE INTERNAL "Have include sasl/sasl.h" FORCE)
ENDIF()
CMAKE_POP_CHECK_STATE()
ENDIF()
IF(WIN32)
FIND_FILE(SASL_LIBRARY_DLL
NAMES libsasl.dll
PATHS ${WITH_SASL}/lib
NO_CMAKE_PATH
NO_CMAKE_ENVIRONMENT_PATH
NO_SYSTEM_ENVIRONMENT_PATH
)
FIND_FILE(SASL_SCRAM_PLUGIN
NAMES saslSCRAM.dll
PATHS ${WITH_SASL}/lib
NO_CMAKE_PATH
NO_CMAKE_ENVIRONMENT_PATH
NO_SYSTEM_ENVIRONMENT_PATH
)
# SCRAM library found, setting SCRAM_LIB_CONFIGURED to 1.
# SCRAM_LIB_CONFIGURED will be used to construct supported SASL methods.
IF(SASL_SCRAM_PLUGIN)
SET(SCRAM_LIB_CONFIGURED 1)
ENDIF()
ENDIF()
ENDMACRO()
MACRO(MYSQL_CHECK_SASL)
IF(NOT WITH_SASL)
SET(WITH_SASL "system" CACHE STRING "${WITH_SASL_DOC_STRING}" FORCE)
ENDIF()
# See if WITH_SASL is of the form </path/to/custom/installation>
FILE(GLOB WITH_SASL_HEADER ${WITH_SASL}/include/sasl/sasl.h)
IF (WITH_SASL_HEADER)
FILE(TO_CMAKE_PATH "${WITH_SASL}" WITH_SASL)
SET(WITH_SASL_PATH ${WITH_SASL})
ENDIF()
IF(WITH_SASL STREQUAL "system")
FIND_SYSTEM_SASL()
ELSEIF(WITH_SASL_PATH)
IF(LINUX_STANDALONE OR WIN32)
FIND_CUSTOM_SASL()
ELSE()
MESSAGE(FATAL_ERROR "-DWITH_SASL=<path> not supported on this platform")
ENDIF()
ELSE()
RESET_SASL_VARIABLES()
MESSAGE(FATAL_ERROR "Could not find SASL")
ENDIF()
IF(HAVE_SASL_SASL_H AND SASL_LIBRARY)
FIND_SASL_VERSION()
SET(SASL_FOUND TRUE)
ELSE()
SET(SASL_FOUND FALSE)
# FATAL_ERROR later if WITH_AUTHENTICATION_LDAP == ON
MESSAGE(WARNING "Could not find SASL")
ENDIF()
ENDMACRO()
MACRO(MYSQL_CHECK_SASL_DLLS)
IF(LINUX_STANDALONE AND SASL_CUSTOM_LIBRARY)
FIND_OBJECT_DEPENDENCIES(${SASL_CUSTOM_LIBRARY} SASL_DEPENDS_ON)
# On el6, the main library does not depend on krb5, but some plugins do.
FOREACH(SASL_PLUGIN ${CUSTOM_SASL_PLUGINS})
SET(VAR_NAME "SASL_CUSTOM_PLUGIN_${SASL_PLUGIN}")
FIND_OBJECT_DEPENDENCIES(${${VAR_NAME}} PLUGIN_DEPS)
MESSAGE(STATUS "SASL_PLUGIN ${SASL_PLUGIN} DEPENDS ON ${PLUGIN_DEPS}")
LIST(APPEND SASL_DEPENDS_ON ${PLUGIN_DEPS})
ENDFOREACH()
LIST(REMOVE_DUPLICATES SASL_DEPENDS_ON)
STRING(REPLACE ";" " " SASL_DEPENDS_ON "${SASL_DEPENDS_ON}")
MESSAGE(STATUS "SASL dependencies ${SASL_DEPENDS_ON}")
IF(NOT SASL_DEPENDS_ON MATCHES "libkrb5")
MESSAGE(WARNING "This SASL library is built without KERBEROS")
MESSAGE(WARNING "DEPENDENCIES are ${SASL_DEPENDS_ON}")
# Disable KERBEROS for LDAP client authentication plugin.
SET(SASL_WITHOUT_KERBEROS 1)
UNSET(KERBEROS_LIB_CONFIGURED CACHE)
UNSET(KERBEROS_LIB_CONFIGURED)
ENDIF()
COPY_CUSTOM_SHARED_LIBRARY("${SASL_CUSTOM_LIBRARY}" ""
SASL_LIBRARY sasl_target)
FOREACH(SASL_PLUGIN ${CUSTOM_SASL_PLUGINS})
SET(COPIED_LIBRARY_NAME)
SET(COPIED_TARGET_NAME)
SET(VAR_NAME "SASL_CUSTOM_PLUGIN_${SASL_PLUGIN}")
IF(${VAR_NAME})
COPY_CUSTOM_SHARED_LIBRARY("${${VAR_NAME}}" "sasl2"
COPIED_LIBRARY_NAME COPIED_TARGET_NAME
)
ADD_DEPENDENCIES(${sasl_target} ${COPIED_TARGET_NAME})
ELSEIF(SASL_WITHOUT_KERBEROS)
# This should be FATAL_ERROR
ELSE()
MESSAGE(FATAL_ERROR
"Could not find plugin lib${SASL_PLUGIN}.so in ${WITH_SASL}/lib/sasl2")
ENDIF()
ENDFOREACH()
ENDIF()
ENDMACRO()
|
