mirror of
https://github.com/MariaDB/server.git
synced 2025-01-16 03:52:35 +01:00
23d53913fb
Docker when mounting a configuration file into a Windows exposes the file with permission 0777. These world writable files are ignored by by MariaDB. Add the access check such that filesystem RO or immutable file is counted as sufficient protection on the file. Test: $ mkdir /tmp/src $ vi /tmp/src/my.cnf $ chmod 666 /tmp/src/my.cnf $ mkdir /tmp/dst $ sudo mount --bind /tmp/src /tmp/dst -o ro $ ls -la /tmp/dst total 4 drwxr-xr-x. 2 dan dan 60 Jun 15 15:12 . drwxrwxrwt. 25 root root 660 Jun 15 15:13 .. -rw-rw-rw-. 1 dan dan 10 Jun 15 15:12 my.cnf $ mount | grep dst tmpfs on /tmp/dst type tmpfs (ro,seclabel,nr_inodes=1048576,inode64) strace client/mariadb --defaults-file=/tmp/dst/my.cnf newfstatat(AT_FDCWD, "/tmp/dst/my.cnf", {st_mode=S_IFREG|0666, st_size=10, ...}, 0) = 0 access("/tmp/dst/my.cnf", W_OK) = -1 EROFS (Read-only file system) openat(AT_FDCWD, "/tmp/dst/my.cnf", O_RDONLY|O_CLOEXEC) = 3 The one failing test, but this isn't a regression, just not a total fix: $ chmod u-w /tmp/src/my.cnf $ ls -la /tmp/src/my.cnf -r--rw-rw-. 1 dan dan 18 Jun 16 10:22 /tmp/src/my.cnf $ strace -fe trace=access client/mariadb --defaults-file=/tmp/dst/my.cnf access("/etc/ld.so.preload", R_OK) = -1 ENOENT (No such file or directory) access("/etc/system-fips", F_OK) = -1 ENOENT (No such file or directory) access("/tmp/dst/my.cnf", W_OK) = -1 EACCES (Permission denied) Warning: World-writable config file '/tmp/dst/my.cnf' is ignored Windows test (Docker Desktop ~4.21) which was the important one to fix: dan@LAPTOP-5B5P7RCK:~$ docker run --rm -v /mnt/c/Users/danie/Desktop/conf:/etc/mysql/conf.d/:ro -e MARIADB_ROOT_PASSWORD=bob quay.io/m ariadb-foundation/mariadb-devel:10.4-MDEV-27038-ro-mounts-pkgtest ls -la /etc/mysql/conf.d total 4 drwxrwxrwx 1 root root 512 Jun 15 13:57 . drwxr-xr-x 4 root root 4096 Jun 15 07:32 .. -rwxrwxrwx 1 root root 43 Jun 15 13:56 myapp.cnf root@a59b38b45af1:/# strace -fe trace=access mariadb access("/etc/ld.so.preload", R_OK) = -1 ENOENT (No such file or directory) access("/etc/mysql/conf.d/myapp.cnf", W_OK) = -1 EROFS (Read-only file system)
1242 lines
36 KiB
C
1242 lines
36 KiB
C
/* Copyright (c) 2000, 2017, Oracle and/or its affiliates. All rights reserved.
|
|
Copyright (c) 2011, 2018, MariaDB Corporation
|
|
|
|
This program is free software; you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation; version 2 of the License.
|
|
|
|
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 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 Street, Fifth Floor, Boston, MA 02110-1335 USA */
|
|
|
|
/****************************************************************************
|
|
Add all options from files named "group".cnf from the default_directories
|
|
before the command line arguments.
|
|
On Windows defaults will also search in the Windows directory for a file
|
|
called 'group'.ini
|
|
As long as the program uses the last argument for conflicting
|
|
options one only have to add a call to "load_defaults" to enable
|
|
use of default values.
|
|
pre- and end 'blank space' are removed from options and values. The
|
|
following escape sequences are recognized in values: \b \t \n \r \\
|
|
|
|
The following arguments are handled automatically; If used, they must be
|
|
first argument on the command line!
|
|
--no-defaults ; no options are read.
|
|
--defaults-file=full-path-to-default-file ; Only this file will be read.
|
|
--defaults-extra-file=full-path-to-default-file ; Read this file before ~/
|
|
--defaults-group-suffix ; Also read groups with concat(group, suffix)
|
|
--print-defaults ; Print the modified command line and exit
|
|
****************************************************************************/
|
|
|
|
#include "mysys_priv.h"
|
|
#include <my_default.h>
|
|
#include <m_string.h>
|
|
#include <m_ctype.h>
|
|
#include <my_dir.h>
|
|
#ifdef __WIN__
|
|
#include <winbase.h>
|
|
#endif
|
|
|
|
/**
|
|
arguments separator
|
|
|
|
load_defaults() loads arguments from config file and put them
|
|
before the arguments from command line, this separator is used to
|
|
separate the arguments loaded from config file and arguments user
|
|
provided on command line.
|
|
|
|
Options with value loaded from config file are always in the form
|
|
'--option=value', while for command line options, the value can be
|
|
given as the next argument. Thus we used a separator so that
|
|
handle_options() can distinguish them.
|
|
|
|
Note: any other places that does not need to distinguish them
|
|
should skip the separator.
|
|
|
|
The content of arguments separator does not matter, one should only
|
|
check the pointer, use "----args-separator----" here to ease debug
|
|
if someone misused it.
|
|
|
|
The args separator will only be added when
|
|
my_getopt_use_args_seprator is set to TRUE before calling
|
|
load_defaults();
|
|
|
|
See BUG#25192
|
|
*/
|
|
static const char *args_separator= "----args-separator----";
|
|
inline static void set_args_separator(char** arg)
|
|
{
|
|
DBUG_ASSERT(my_getopt_use_args_separator);
|
|
*arg= (char*)args_separator;
|
|
}
|
|
my_bool my_getopt_use_args_separator= FALSE;
|
|
my_bool my_getopt_is_args_separator(const char* arg)
|
|
{
|
|
return (arg == args_separator);
|
|
}
|
|
const char *my_defaults_file=0;
|
|
const char *my_defaults_group_suffix=0;
|
|
const char *my_defaults_extra_file=0;
|
|
|
|
static char my_defaults_file_buffer[FN_REFLEN];
|
|
static char my_defaults_extra_file_buffer[FN_REFLEN];
|
|
|
|
static my_bool defaults_already_read= FALSE;
|
|
|
|
/* Which directories are searched for options (and in which order) */
|
|
|
|
#define MAX_DEFAULT_DIRS 7
|
|
#define DEFAULT_DIRS_SIZE (MAX_DEFAULT_DIRS + 1) /* Terminate with NULL */
|
|
static const char **default_directories = NULL;
|
|
|
|
#ifdef __WIN__
|
|
static const char *f_extensions[]= { ".ini", ".cnf", 0 };
|
|
#define NEWLINE "\r\n"
|
|
#else
|
|
static const char *f_extensions[]= { ".cnf", 0 };
|
|
#define NEWLINE "\n"
|
|
#endif
|
|
|
|
static int handle_default_option(void *, const char *, const char *);
|
|
|
|
/*
|
|
This structure defines the context that we pass to callback
|
|
function 'handle_default_option' used in search_default_file
|
|
to process each option. This context is used if search_default_file
|
|
was called from load_defaults.
|
|
*/
|
|
|
|
struct handle_option_ctx
|
|
{
|
|
MEM_ROOT *alloc;
|
|
DYNAMIC_ARRAY *args;
|
|
TYPELIB *group;
|
|
};
|
|
|
|
static int search_default_file(Process_option_func func, void *func_ctx,
|
|
const char *dir, const char *config_file);
|
|
static int search_default_file_with_ext(Process_option_func func,
|
|
void *func_ctx,
|
|
const char *dir, const char *ext,
|
|
const char *config_file, int recursion_level);
|
|
|
|
|
|
/**
|
|
Create the list of default directories.
|
|
|
|
@param alloc MEM_ROOT where the list of directories is stored
|
|
|
|
@details
|
|
The directories searched, in order, are:
|
|
- Windows: GetSystemWindowsDirectory()
|
|
- Windows: GetWindowsDirectory()
|
|
- Windows: C:/
|
|
- Windows: Directory above where the executable is located
|
|
- Unix: /etc/ or the value of DEFAULT_SYSCONFDIR, if defined
|
|
- Unix: /etc/mysql/ unless DEFAULT_SYSCONFDIR is defined
|
|
- ALL: getenv("MYSQL_HOME")
|
|
- ALL: --defaults-extra-file=<path> (run-time option)
|
|
- Unix: ~/
|
|
|
|
On all systems, if a directory is already in the list, it will be moved
|
|
to the end of the list. This avoids reading defaults files multiple times,
|
|
while ensuring the correct precedence.
|
|
|
|
@retval NULL Failure (out of memory, probably)
|
|
@retval other Pointer to NULL-terminated array of default directories
|
|
*/
|
|
|
|
static const char **init_default_directories(MEM_ROOT *alloc);
|
|
|
|
|
|
static char *remove_end_comment(char *ptr);
|
|
|
|
|
|
/*
|
|
Expand a file name so that the current working directory is added if
|
|
the name is relative.
|
|
|
|
RETURNS
|
|
0 All OK
|
|
2 Out of memory or path to long
|
|
3 Not able to get working directory
|
|
*/
|
|
|
|
static int
|
|
fn_expand(const char *filename, char *result_buf)
|
|
{
|
|
char dir[FN_REFLEN];
|
|
const int flags= MY_UNPACK_FILENAME | MY_SAFE_PATH | MY_RELATIVE_PATH;
|
|
DBUG_ENTER("fn_expand");
|
|
DBUG_PRINT("enter", ("filename: %s, result_buf: %p",
|
|
filename, result_buf));
|
|
if (my_getwd(dir, sizeof(dir), MYF(0)))
|
|
DBUG_RETURN(3);
|
|
DBUG_PRINT("debug", ("dir: %s", dir));
|
|
if (fn_format(result_buf, filename, dir, "", flags) == NULL)
|
|
DBUG_RETURN(2);
|
|
DBUG_PRINT("return", ("result: %s", result_buf));
|
|
DBUG_RETURN(0);
|
|
}
|
|
|
|
/*
|
|
Process config files in default directories.
|
|
|
|
SYNOPSIS
|
|
my_search_option_files()
|
|
conf_file Basename for configuration file to search for.
|
|
If this is a path, then only this file is read.
|
|
argc Pointer to argc of original program
|
|
argv Pointer to argv of original program
|
|
args_used Pointer to variable for storing the number of
|
|
arguments used.
|
|
func Pointer to the function to process options
|
|
func_ctx It's context. Usually it is the structure to
|
|
store additional options.
|
|
DESCRIPTION
|
|
Process the default options from argc & argv
|
|
Read through each found config file looks and calls 'func' to process
|
|
each option.
|
|
|
|
NOTES
|
|
--defaults-group-suffix is only processed if we are called from
|
|
load_defaults().
|
|
|
|
|
|
RETURN
|
|
0 ok
|
|
1 given cinf_file doesn't exist
|
|
2 out of memory
|
|
3 Can't get current working directory
|
|
|
|
The global variable 'my_defaults_group_suffix' is updated with value for
|
|
--defaults_group_suffix
|
|
*/
|
|
|
|
int my_search_option_files(const char *conf_file, int *argc, char ***argv,
|
|
uint *args_used, Process_option_func func,
|
|
void *func_ctx, const char **default_directories)
|
|
{
|
|
const char **dirs, *forced_default_file, *forced_extra_defaults;
|
|
int error= 0;
|
|
DBUG_ENTER("my_search_option_files");
|
|
|
|
/* Check if we want to force the use a specific default file */
|
|
*args_used+= get_defaults_options(*argc - *args_used, *argv + *args_used,
|
|
(char **) &forced_default_file,
|
|
(char **) &forced_extra_defaults,
|
|
(char **) &my_defaults_group_suffix);
|
|
|
|
if (! my_defaults_group_suffix)
|
|
my_defaults_group_suffix= getenv("MYSQL_GROUP_SUFFIX");
|
|
|
|
if (forced_extra_defaults && !defaults_already_read)
|
|
{
|
|
int error= fn_expand(forced_extra_defaults, my_defaults_extra_file_buffer);
|
|
if (error)
|
|
DBUG_RETURN(error);
|
|
my_defaults_extra_file= my_defaults_extra_file_buffer;
|
|
}
|
|
|
|
if (forced_default_file && !defaults_already_read)
|
|
{
|
|
int error= fn_expand(forced_default_file, my_defaults_file_buffer);
|
|
if (error)
|
|
DBUG_RETURN(error);
|
|
my_defaults_file= my_defaults_file_buffer;
|
|
}
|
|
|
|
defaults_already_read= TRUE;
|
|
|
|
/*
|
|
We can only handle 'defaults-group-suffix' if we are called from
|
|
load_defaults() as otherwise we can't know the type of 'func_ctx'
|
|
*/
|
|
|
|
if (my_defaults_group_suffix && func == handle_default_option)
|
|
{
|
|
/* Handle --defaults-group-suffix= */
|
|
uint i;
|
|
const char **extra_groups;
|
|
const size_t instance_len= strlen(my_defaults_group_suffix);
|
|
struct handle_option_ctx *ctx= (struct handle_option_ctx*) func_ctx;
|
|
char *ptr;
|
|
TYPELIB *group= ctx->group;
|
|
|
|
if (!(extra_groups=
|
|
(const char**)alloc_root(ctx->alloc,
|
|
(2*group->count+1)*sizeof(char*))))
|
|
DBUG_RETURN(2);
|
|
|
|
for (i= 0; i < group->count; i++)
|
|
{
|
|
size_t len;
|
|
extra_groups[i]= group->type_names[i]; /** copy group */
|
|
|
|
len= strlen(extra_groups[i]);
|
|
if (!(ptr= alloc_root(ctx->alloc, (uint) (len+instance_len+1))))
|
|
DBUG_RETURN(2);
|
|
|
|
extra_groups[i+group->count]= ptr;
|
|
|
|
/** Construct new group */
|
|
memcpy(ptr, extra_groups[i], len);
|
|
memcpy(ptr+len, my_defaults_group_suffix, instance_len+1);
|
|
}
|
|
|
|
group->count*= 2;
|
|
group->type_names= extra_groups;
|
|
group->type_names[group->count]= 0;
|
|
}
|
|
|
|
if (my_defaults_file)
|
|
{
|
|
if ((error= search_default_file_with_ext(func, func_ctx, "", "",
|
|
my_defaults_file, 0)) < 0)
|
|
goto err;
|
|
if (error > 0)
|
|
{
|
|
fprintf(stderr, "Could not open required defaults file: %s\n",
|
|
my_defaults_file);
|
|
goto err;
|
|
}
|
|
}
|
|
else if (dirname_length(conf_file))
|
|
{
|
|
if ((error= search_default_file(func, func_ctx, NullS, conf_file)) < 0)
|
|
goto err;
|
|
}
|
|
else
|
|
{
|
|
for (dirs= default_directories ; *dirs; dirs++)
|
|
{
|
|
if (**dirs)
|
|
{
|
|
if (search_default_file(func, func_ctx, *dirs, conf_file) < 0)
|
|
goto err;
|
|
}
|
|
else if (my_defaults_extra_file)
|
|
{
|
|
if ((error= search_default_file_with_ext(func, func_ctx, "", "",
|
|
my_defaults_extra_file, 0)) < 0)
|
|
goto err; /* Fatal error */
|
|
if (error > 0)
|
|
{
|
|
fprintf(stderr, "Could not open required defaults file: %s\n",
|
|
my_defaults_extra_file);
|
|
goto err;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
DBUG_RETURN(0);
|
|
|
|
err:
|
|
fprintf(stderr,"Fatal error in defaults handling. Program aborted\n");
|
|
DBUG_RETURN(1);
|
|
}
|
|
|
|
|
|
/*
|
|
The option handler for load_defaults.
|
|
|
|
SYNOPSIS
|
|
handle_deault_option()
|
|
in_ctx Handler context. In this case it is a
|
|
handle_option_ctx structure.
|
|
group_name The name of the group the option belongs to.
|
|
option The very option to be processed. It is already
|
|
prepared to be used in argv (has -- prefix). If it
|
|
is NULL, we are handling a new group (section).
|
|
|
|
DESCRIPTION
|
|
This handler checks whether a group is one of the listed and adds an option
|
|
to the array if yes. Some other handler can record, for instance, all
|
|
groups and their options, not knowing in advance the names and amount of
|
|
groups.
|
|
|
|
RETURN
|
|
0 - ok
|
|
1 - error occurred
|
|
*/
|
|
|
|
static int handle_default_option(void *in_ctx, const char *group_name,
|
|
const char *option)
|
|
{
|
|
char *tmp;
|
|
struct handle_option_ctx *ctx= (struct handle_option_ctx *) in_ctx;
|
|
|
|
if (!option)
|
|
return 0;
|
|
|
|
if (find_type((char *)group_name, ctx->group, FIND_TYPE_NO_PREFIX))
|
|
{
|
|
if (!(tmp= alloc_root(ctx->alloc, strlen(option) + 1)))
|
|
return 1;
|
|
if (insert_dynamic(ctx->args, (uchar*) &tmp))
|
|
return 1;
|
|
strmov(tmp, option);
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
|
|
/*
|
|
Gets options from the command line
|
|
|
|
SYNOPSIS
|
|
get_defaults_options()
|
|
argc Pointer to argc of original program
|
|
argv Pointer to argv of original program
|
|
defaults --defaults-file option
|
|
extra_defaults --defaults-extra-file option
|
|
|
|
RETURN
|
|
# Number of arguments used from *argv
|
|
defaults and extra_defaults will be set to option of the appropriate
|
|
items of argv array, or to NULL if there are no such options
|
|
*/
|
|
|
|
int get_defaults_options(int argc, char **argv,
|
|
char **defaults,
|
|
char **extra_defaults,
|
|
char **group_suffix)
|
|
{
|
|
int org_argc= argc;
|
|
*defaults= *extra_defaults= *group_suffix= 0;
|
|
|
|
while (argc >= 2)
|
|
{
|
|
/* Skip program name or previously handled argument */
|
|
argv++;
|
|
if (!*defaults && is_prefix(*argv,"--defaults-file="))
|
|
{
|
|
*defaults= *argv + sizeof("--defaults-file=")-1;
|
|
argc--;
|
|
continue;
|
|
}
|
|
if (!*extra_defaults && is_prefix(*argv,"--defaults-extra-file="))
|
|
{
|
|
*extra_defaults= *argv + sizeof("--defaults-extra-file=")-1;
|
|
argc--;
|
|
continue;
|
|
}
|
|
if (!*group_suffix && is_prefix(*argv, "--defaults-group-suffix="))
|
|
{
|
|
*group_suffix= *argv + sizeof("--defaults-group-suffix=")-1;
|
|
argc--;
|
|
continue;
|
|
}
|
|
break;
|
|
}
|
|
return org_argc - argc;
|
|
}
|
|
|
|
/*
|
|
Wrapper around my_load_defaults() for interface compatibility.
|
|
|
|
SYNOPSIS
|
|
load_defaults()
|
|
conf_file Basename for configuration file to search for.
|
|
If this is a path, then only this file is read.
|
|
groups Which [group] entrys to read.
|
|
Points to an null terminated array of pointers
|
|
argc Pointer to argc of original program
|
|
argv Pointer to argv of original program
|
|
|
|
NOTES
|
|
|
|
This function is NOT thread-safe as it uses a global pointer internally.
|
|
See also notes for my_load_defaults().
|
|
|
|
RETURN
|
|
0 ok
|
|
1 The given conf_file didn't exists
|
|
*/
|
|
int load_defaults(const char *conf_file, const char **groups,
|
|
int *argc, char ***argv)
|
|
{
|
|
return my_load_defaults(conf_file, groups, argc, argv, &default_directories);
|
|
}
|
|
|
|
/*
|
|
Read options from configurations files
|
|
|
|
SYNOPSIS
|
|
my_load_defaults()
|
|
conf_file Basename for configuration file to search for.
|
|
If this is a path, then only this file is read.
|
|
groups Which [group] entrys to read.
|
|
Points to an null terminated array of pointers
|
|
argc Pointer to argc of original program
|
|
argv Pointer to argv of original program
|
|
default_directories Pointer to a location where a pointer to the list
|
|
of default directories will be stored
|
|
|
|
IMPLEMENTATION
|
|
|
|
Read options from configuration files and put them BEFORE the arguments
|
|
that are already in argc and argv. This way the calling program can
|
|
easily command line options override options in configuration files
|
|
|
|
NOTES
|
|
In case of fatal error, the function will print a warning and returns 2
|
|
|
|
To free used memory one should call free_defaults() with the argument
|
|
that was put in *argv
|
|
|
|
RETURN
|
|
- If successful, 0 is returned. If 'default_directories' is not NULL,
|
|
a pointer to the array of default directory paths is stored to a location
|
|
it points to. That stored value must be passed to my_search_option_files()
|
|
later.
|
|
|
|
- 1 is returned if the given conf_file didn't exist. In this case, the
|
|
value pointed to by default_directories is undefined.
|
|
*/
|
|
|
|
|
|
int my_load_defaults(const char *conf_file, const char **groups,
|
|
int *argc, char ***argv, const char ***default_directories)
|
|
{
|
|
DYNAMIC_ARRAY args;
|
|
TYPELIB group;
|
|
my_bool found_print_defaults= 0;
|
|
uint args_used= 0;
|
|
int error= 0;
|
|
MEM_ROOT alloc;
|
|
char *ptr,**res;
|
|
struct handle_option_ctx ctx;
|
|
const char **dirs;
|
|
uint args_sep= my_getopt_use_args_separator ? 1 : 0;
|
|
DBUG_ENTER("load_defaults");
|
|
|
|
init_alloc_root(&alloc, "my_load_defaults", 512, 0, MYF(0));
|
|
if ((dirs= init_default_directories(&alloc)) == NULL)
|
|
goto err;
|
|
/*
|
|
Check if the user doesn't want any default option processing
|
|
--no-defaults is always the first option
|
|
*/
|
|
if (*argc >= 2 && !strcmp(argv[0][1],"--no-defaults"))
|
|
{
|
|
/* remove the --no-defaults argument and return only the other arguments */
|
|
uint i, j;
|
|
if (!(ptr=(char*) alloc_root(&alloc,sizeof(alloc)+
|
|
(*argc + 1)*sizeof(char*))))
|
|
goto err;
|
|
res= (char**) (ptr+sizeof(alloc));
|
|
res[0]= **argv; /* Copy program name */
|
|
j= 1; /* Start from 1 for the reset result args */
|
|
if (my_getopt_use_args_separator)
|
|
{
|
|
/* set arguments separator */
|
|
set_args_separator(&res[1]);
|
|
j++;
|
|
}
|
|
for (i=2 ; i < (uint) *argc ; i++, j++)
|
|
res[j]=argv[0][i];
|
|
res[j]=0; /* End pointer */
|
|
/*
|
|
Update the argc, if have not added args separator, then we have
|
|
to decrease argc because we have removed the "--no-defaults".
|
|
*/
|
|
if (!my_getopt_use_args_separator)
|
|
(*argc)--;
|
|
*argv=res;
|
|
*(MEM_ROOT*) ptr= alloc; /* Save alloc root for free */
|
|
if (default_directories)
|
|
*default_directories= dirs;
|
|
DBUG_RETURN(0);
|
|
}
|
|
|
|
group.count=0;
|
|
group.name= "defaults";
|
|
group.type_names= groups;
|
|
|
|
for (; *groups ; groups++)
|
|
group.count++;
|
|
|
|
if (my_init_dynamic_array(&args, sizeof(char*), 128, 64, MYF(0)))
|
|
goto err;
|
|
|
|
ctx.alloc= &alloc;
|
|
ctx.args= &args;
|
|
ctx.group= &group;
|
|
|
|
if ((error= my_search_option_files(conf_file, argc, argv, &args_used,
|
|
handle_default_option, (void *) &ctx,
|
|
dirs)))
|
|
{
|
|
delete_dynamic(&args);
|
|
free_root(&alloc,MYF(0));
|
|
DBUG_RETURN(error);
|
|
}
|
|
/*
|
|
Here error contains <> 0 only if we have a fully specified conf_file
|
|
or a forced default file
|
|
*/
|
|
if (!(ptr=(char*) alloc_root(&alloc,sizeof(alloc)+
|
|
(args.elements + *argc + 1 + args_sep) *sizeof(char*))))
|
|
goto err;
|
|
res= (char**) (ptr+sizeof(alloc));
|
|
|
|
/* copy name + found arguments + command line arguments to new array */
|
|
res[0]= argv[0][0]; /* Name MUST be set, even by embedded library */
|
|
memcpy((uchar*) (res+1), args.buffer, args.elements*sizeof(char*));
|
|
/* Skip --defaults-xxx options */
|
|
(*argc)-= args_used;
|
|
(*argv)+= args_used;
|
|
|
|
/*
|
|
Check if we want to see the new argument list
|
|
This options must always be the last of the default options
|
|
*/
|
|
if (*argc >= 2 && !strcmp(argv[0][1],"--print-defaults"))
|
|
{
|
|
found_print_defaults=1;
|
|
--*argc; ++*argv; /* skip argument */
|
|
}
|
|
|
|
if (my_getopt_use_args_separator)
|
|
{
|
|
/* set arguments separator for arguments from config file and
|
|
command line */
|
|
set_args_separator(&res[args.elements+1]);
|
|
}
|
|
|
|
if (*argc)
|
|
memcpy((uchar*) (res+1+args.elements+args_sep), (char*) ((*argv)+1),
|
|
(*argc-1)*sizeof(char*));
|
|
res[args.elements+ *argc+args_sep]=0; /* last null */
|
|
|
|
(*argc)+=args.elements+args_sep;
|
|
*argv= (char**) res;
|
|
*(MEM_ROOT*) ptr= alloc; /* Save alloc root for free */
|
|
delete_dynamic(&args);
|
|
if (found_print_defaults)
|
|
{
|
|
int i;
|
|
printf("%s would have been started with the following arguments:\n",
|
|
**argv);
|
|
for (i=1 ; i < *argc ; i++)
|
|
if (!my_getopt_is_args_separator((*argv)[i])) /* skip arguments separator */
|
|
printf("%s ", (*argv)[i]);
|
|
puts("");
|
|
DBUG_RETURN(4);
|
|
}
|
|
|
|
if (default_directories)
|
|
*default_directories= dirs;
|
|
|
|
DBUG_RETURN(0);
|
|
|
|
err:
|
|
fprintf(stderr,"Fatal error in defaults handling. Program aborted\n");
|
|
DBUG_RETURN(2);
|
|
}
|
|
|
|
|
|
void free_defaults(char **argv)
|
|
{
|
|
MEM_ROOT ptr;
|
|
memcpy(&ptr, ((char *) argv) - sizeof(ptr), sizeof(ptr));
|
|
free_root(&ptr,MYF(0));
|
|
}
|
|
|
|
|
|
static int search_default_file(Process_option_func opt_handler,
|
|
void *handler_ctx,
|
|
const char *dir,
|
|
const char *config_file)
|
|
{
|
|
char **ext;
|
|
const char *empty_list[]= { "", 0 };
|
|
my_bool have_ext= fn_ext(config_file)[0] != 0;
|
|
const char **exts_to_use= have_ext ? empty_list : f_extensions;
|
|
|
|
for (ext= (char**) exts_to_use; *ext; ext++)
|
|
{
|
|
int error;
|
|
if ((error= search_default_file_with_ext(opt_handler, handler_ctx,
|
|
dir, *ext,
|
|
config_file, 0)) < 0)
|
|
return error;
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
|
|
/*
|
|
Skip over keyword and get argument after keyword
|
|
|
|
SYNOPSIS
|
|
get_argument()
|
|
keyword Include directive keyword
|
|
kwlen Length of keyword
|
|
ptr Pointer to the keword in the line under process
|
|
line line number
|
|
|
|
RETURN
|
|
0 error
|
|
# Returns pointer to the argument after the keyword.
|
|
*/
|
|
|
|
static char *get_argument(const char *keyword, size_t kwlen,
|
|
char *ptr, char *name, uint line)
|
|
{
|
|
char *end;
|
|
|
|
/* Skip over "include / includedir keyword" and following whitespace */
|
|
|
|
for (ptr+= kwlen - 1;
|
|
my_isspace(&my_charset_latin1, ptr[0]);
|
|
ptr++)
|
|
{}
|
|
|
|
/*
|
|
Trim trailing whitespace from directory name
|
|
The -1 below is for the newline added by fgets()
|
|
Note that my_isspace() is true for \r and \n
|
|
*/
|
|
for (end= ptr + strlen(ptr) - 1;
|
|
my_isspace(&my_charset_latin1, *(end - 1));
|
|
end--)
|
|
{}
|
|
end[0]= 0; /* Cut off end space */
|
|
|
|
/* Print error msg if there is nothing after !include* directive */
|
|
if (end <= ptr)
|
|
{
|
|
fprintf(stderr,
|
|
"error: Wrong '!%s' directive in config file: %s at line %d\n",
|
|
keyword, name, line);
|
|
return 0;
|
|
}
|
|
return ptr;
|
|
}
|
|
|
|
|
|
/*
|
|
Open a configuration file (if exists) and read given options from it
|
|
|
|
SYNOPSIS
|
|
search_default_file_with_ext()
|
|
opt_handler Option handler function. It is used to process
|
|
every separate option.
|
|
handler_ctx Pointer to the structure to store actual
|
|
parameters of the function.
|
|
dir directory to read
|
|
ext Extension for configuration file
|
|
config_file Name of configuration file
|
|
group groups to read
|
|
recursion_level the level of recursion, got while processing
|
|
"!include" or "!includedir"
|
|
|
|
RETURN
|
|
0 Success
|
|
-1 Fatal error, abort
|
|
1 File not found (Warning)
|
|
*/
|
|
|
|
static int search_default_file_with_ext(Process_option_func opt_handler,
|
|
void *handler_ctx,
|
|
const char *dir,
|
|
const char *ext,
|
|
const char *config_file,
|
|
int recursion_level)
|
|
{
|
|
char name[FN_REFLEN + 10], buff[4096], curr_gr[4096], *ptr, *end, **tmp_ext;
|
|
char *value, option[4096+2], tmp[FN_REFLEN];
|
|
static const char includedir_keyword[]= "includedir";
|
|
static const char include_keyword[]= "include";
|
|
const int max_recursion_level= 10;
|
|
MYSQL_FILE *fp;
|
|
uint line=0;
|
|
my_bool found_group=0;
|
|
uint i;
|
|
MY_DIR *search_dir;
|
|
FILEINFO *search_file;
|
|
|
|
if ((dir ? strlen(dir) : 0 )+strlen(config_file) >= FN_REFLEN-3)
|
|
return 0; /* Ignore wrong paths */
|
|
if (dir)
|
|
{
|
|
end=convert_dirname(name, dir, NullS);
|
|
if (dir[0] == FN_HOMELIB) /* Add . to filenames in home */
|
|
*end++='.';
|
|
strxmov(end,config_file,ext,NullS);
|
|
}
|
|
else
|
|
{
|
|
strmov(name,config_file);
|
|
}
|
|
fn_format(name,name,"","",4);
|
|
#if !defined(__WIN__)
|
|
{
|
|
MY_STAT stat_info;
|
|
if (!my_stat(name,&stat_info,MYF(0)))
|
|
return 1;
|
|
/*
|
|
Ignore world-writable regular files (exceptions apply).
|
|
This is mainly done to protect us to not read a file that may be
|
|
modified by anyone.
|
|
|
|
Also check access so that read only mounted (EROFS)
|
|
or immutable files (EPERM) that are suitable protections.
|
|
|
|
The main case we are allowing is a container readonly volume mount
|
|
from a filesystem that doesn't have unix permissions. This will
|
|
have a 0777 permission and access will set errno = EROFS.
|
|
|
|
Note if a ROFS has a file with permissions 04n6, access sets errno
|
|
EACCESS, rather the ROFS, so in this case we'll error, even though
|
|
the ROFS is protecting the file.
|
|
|
|
An ideal, race free, implementation would do fstat / fstatvfs / ioctl
|
|
for permission, read only filesystem, and immutability resprectively.
|
|
*/
|
|
if ((stat_info.st_mode & S_IWOTH) &&
|
|
(stat_info.st_mode & S_IFMT) == S_IFREG &&
|
|
(access(name, W_OK) == 0 || (errno != EROFS && errno != EPERM)))
|
|
{
|
|
fprintf(stderr, "Warning: World-writable config file '%s' is ignored\n",
|
|
name);
|
|
return 0;
|
|
}
|
|
}
|
|
#endif
|
|
if (!(fp= mysql_file_fopen(key_file_cnf, name, O_RDONLY, MYF(0))))
|
|
return 1; /* Ignore wrong files */
|
|
|
|
while (mysql_file_fgets(buff, sizeof(buff) - 1, fp))
|
|
{
|
|
line++;
|
|
/* Ignore comment and empty lines */
|
|
for (ptr= buff; my_isspace(&my_charset_latin1, *ptr); ptr++)
|
|
{}
|
|
|
|
if (*ptr == '#' || *ptr == ';' || !*ptr)
|
|
continue;
|
|
|
|
/* Configuration File Directives */
|
|
if (*ptr == '!')
|
|
{
|
|
if (recursion_level >= max_recursion_level)
|
|
{
|
|
for (end= ptr + strlen(ptr) - 1;
|
|
my_isspace(&my_charset_latin1, *(end - 1));
|
|
end--)
|
|
{}
|
|
end[0]= 0;
|
|
fprintf(stderr,
|
|
"Warning: skipping '%s' directive as maximum include"
|
|
"recursion level was reached in file %s at line %d\n",
|
|
ptr, name, line);
|
|
continue;
|
|
}
|
|
|
|
/* skip over `!' and following whitespace */
|
|
for (++ptr; my_isspace(&my_charset_latin1, ptr[0]); ptr++)
|
|
{}
|
|
|
|
if ((!strncmp(ptr, includedir_keyword,
|
|
sizeof(includedir_keyword) - 1)) &&
|
|
my_isspace(&my_charset_latin1, ptr[sizeof(includedir_keyword) - 1]))
|
|
{
|
|
if (!(ptr= get_argument(includedir_keyword,
|
|
sizeof(includedir_keyword),
|
|
ptr, name, line)))
|
|
goto err;
|
|
|
|
if (!(search_dir= my_dir(ptr, MYF(MY_WME | MY_WANT_SORT))))
|
|
goto err;
|
|
|
|
for (i= 0; i < (uint) search_dir->number_of_files; i++)
|
|
{
|
|
search_file= search_dir->dir_entry + i;
|
|
ext= fn_ext2(search_file->name);
|
|
|
|
/* check extension */
|
|
for (tmp_ext= (char**) f_extensions; *tmp_ext; tmp_ext++)
|
|
{
|
|
if (!strcmp(ext, *tmp_ext))
|
|
break;
|
|
}
|
|
|
|
if (*tmp_ext)
|
|
{
|
|
fn_format(tmp, search_file->name, ptr, "",
|
|
MY_UNPACK_FILENAME | MY_SAFE_PATH);
|
|
|
|
search_default_file_with_ext(opt_handler, handler_ctx, "", "", tmp,
|
|
recursion_level + 1);
|
|
}
|
|
}
|
|
|
|
my_dirend(search_dir);
|
|
}
|
|
else if ((!strncmp(ptr, include_keyword, sizeof(include_keyword) - 1)) &&
|
|
my_isspace(&my_charset_latin1, ptr[sizeof(include_keyword)-1]))
|
|
{
|
|
if (!(ptr= get_argument(include_keyword,
|
|
sizeof(include_keyword), ptr,
|
|
name, line)))
|
|
goto err;
|
|
|
|
search_default_file_with_ext(opt_handler, handler_ctx, "", "", ptr,
|
|
recursion_level + 1);
|
|
}
|
|
|
|
continue;
|
|
}
|
|
|
|
if (*ptr == '[') /* Group name */
|
|
{
|
|
found_group=1;
|
|
if (!(end=(char *) strchr(++ptr,']')))
|
|
{
|
|
fprintf(stderr,
|
|
"error: Wrong group definition in config file: %s at line %d\n",
|
|
name,line);
|
|
goto err;
|
|
}
|
|
/* Remove end space */
|
|
for ( ; my_isspace(&my_charset_latin1,end[-1]) ; end--) ;
|
|
end[0]=0;
|
|
|
|
strmake(curr_gr, ptr, MY_MIN((size_t) (end-ptr)+1, sizeof(curr_gr)-1));
|
|
|
|
/* signal that a new group is found */
|
|
opt_handler(handler_ctx, curr_gr, NULL);
|
|
|
|
continue;
|
|
}
|
|
if (!found_group)
|
|
{
|
|
fprintf(stderr,
|
|
"error: Found option without preceding group in config file: %s at line: %d\n",
|
|
name,line);
|
|
goto err;
|
|
}
|
|
|
|
|
|
end= remove_end_comment(ptr);
|
|
if ((value= strchr(ptr, '=')))
|
|
end= value;
|
|
for ( ; my_isspace(&my_charset_latin1,end[-1]) ; end--) ;
|
|
if (!value)
|
|
{
|
|
strmake(strmov(option,"--"),ptr, (size_t) (end-ptr));
|
|
if (opt_handler(handler_ctx, curr_gr, option))
|
|
goto err;
|
|
}
|
|
else
|
|
{
|
|
/* Remove pre- and end space */
|
|
char *value_end;
|
|
for (value++ ; my_isspace(&my_charset_latin1,*value); value++) ;
|
|
value_end=strend(value);
|
|
/*
|
|
We don't have to test for value_end >= value as we know there is
|
|
an '=' before
|
|
*/
|
|
for ( ; my_isspace(&my_charset_latin1,value_end[-1]) ; value_end--) ;
|
|
if (value_end < value) /* Empty string */
|
|
value_end=value;
|
|
|
|
/* remove quotes around argument */
|
|
if ((*value == '\"' || *value == '\'') && /* First char is quote */
|
|
(value + 1 < value_end ) && /* String is longer than 1 */
|
|
*value == value_end[-1] ) /* First char is equal to last char */
|
|
{
|
|
value++;
|
|
value_end--;
|
|
}
|
|
ptr=strnmov(strmov(option,"--"),ptr,(size_t) (end-ptr));
|
|
*ptr++= '=';
|
|
|
|
for ( ; value != value_end; value++)
|
|
{
|
|
if (*value == '\\' && value != value_end-1)
|
|
{
|
|
switch(*++value) {
|
|
case 'n':
|
|
*ptr++='\n';
|
|
break;
|
|
case 't':
|
|
*ptr++= '\t';
|
|
break;
|
|
case 'r':
|
|
*ptr++ = '\r';
|
|
break;
|
|
case 'b':
|
|
*ptr++ = '\b';
|
|
break;
|
|
case 's':
|
|
*ptr++= ' '; /* space */
|
|
break;
|
|
case '\"':
|
|
*ptr++= '\"';
|
|
break;
|
|
case '\'':
|
|
*ptr++= '\'';
|
|
break;
|
|
case '\\':
|
|
*ptr++= '\\';
|
|
break;
|
|
default: /* Unknown; Keep '\' */
|
|
*ptr++= '\\';
|
|
*ptr++= *value;
|
|
break;
|
|
}
|
|
}
|
|
else
|
|
*ptr++= *value;
|
|
}
|
|
*ptr=0;
|
|
if (opt_handler(handler_ctx, curr_gr, option))
|
|
goto err;
|
|
}
|
|
}
|
|
mysql_file_fclose(fp, MYF(0));
|
|
return(0);
|
|
|
|
err:
|
|
mysql_file_fclose(fp, MYF(0));
|
|
return -1; /* Fatal error */
|
|
}
|
|
|
|
|
|
static char *remove_end_comment(char *ptr)
|
|
{
|
|
char quote= 0; /* we are inside quote marks */
|
|
char escape= 0; /* symbol is protected by escape chagacter */
|
|
|
|
for (; *ptr; ptr++)
|
|
{
|
|
if ((*ptr == '\'' || *ptr == '\"') && !escape)
|
|
{
|
|
if (!quote)
|
|
quote= *ptr;
|
|
else if (quote == *ptr)
|
|
quote= 0;
|
|
}
|
|
/* We are not inside a string */
|
|
if (!quote && *ptr == '#')
|
|
{
|
|
*ptr= 0;
|
|
return ptr;
|
|
}
|
|
escape= (quote && *ptr == '\\' && !escape);
|
|
}
|
|
return ptr;
|
|
}
|
|
|
|
|
|
void my_print_default_files(const char *conf_file)
|
|
{
|
|
const char *empty_list[]= { "", 0 };
|
|
my_bool have_ext= fn_ext(conf_file)[0] != 0;
|
|
const char **exts_to_use= have_ext ? empty_list : f_extensions;
|
|
char name[FN_REFLEN], **ext;
|
|
|
|
puts("\nDefault options are read from the following files in the given order:");
|
|
if (my_defaults_file)
|
|
{
|
|
puts(my_defaults_file);
|
|
return;
|
|
}
|
|
|
|
if (dirname_length(conf_file))
|
|
fputs(conf_file,stdout);
|
|
else
|
|
{
|
|
const char **dirs;
|
|
MEM_ROOT alloc;
|
|
init_alloc_root(&alloc, "my_print_defaults", 512, 0, MYF(0));
|
|
|
|
if ((dirs= init_default_directories(&alloc)) == NULL)
|
|
{
|
|
fputs("Internal error initializing default directories list", stdout);
|
|
}
|
|
else
|
|
{
|
|
for ( ; *dirs; dirs++)
|
|
{
|
|
for (ext= (char**) exts_to_use; *ext; ext++)
|
|
{
|
|
const char *pos;
|
|
char *end;
|
|
if (**dirs)
|
|
pos= *dirs;
|
|
else if (my_defaults_extra_file)
|
|
{
|
|
pos= my_defaults_extra_file;
|
|
fputs(pos, stdout);
|
|
fputs(" ", stdout);
|
|
continue;
|
|
}
|
|
else
|
|
continue;
|
|
end= convert_dirname(name, pos, NullS);
|
|
if (name[0] == FN_HOMELIB) /* Add . to filenames in home */
|
|
*end++= '.';
|
|
strxmov(end, conf_file, *ext, " ", NullS);
|
|
fputs(name, stdout);
|
|
}
|
|
}
|
|
}
|
|
|
|
free_root(&alloc, MYF(0));
|
|
}
|
|
puts("");
|
|
}
|
|
|
|
void print_defaults(const char *conf_file, const char **groups)
|
|
{
|
|
const char **groups_save= groups;
|
|
my_print_default_files(conf_file);
|
|
|
|
fputs("The following groups are read:",stdout);
|
|
for ( ; *groups ; groups++)
|
|
{
|
|
fputc(' ',stdout);
|
|
fputs(*groups,stdout);
|
|
}
|
|
|
|
if (my_defaults_group_suffix)
|
|
{
|
|
groups= groups_save;
|
|
for ( ; *groups ; groups++)
|
|
{
|
|
fputc(' ',stdout);
|
|
fputs(*groups,stdout);
|
|
fputs(my_defaults_group_suffix,stdout);
|
|
}
|
|
}
|
|
puts("\nThe following options may be given as the first argument:\n\
|
|
--print-defaults Print the program argument list and exit.\n\
|
|
--no-defaults Don't read default options from any option file.\n\
|
|
The following specify which files/extra groups are read (specified before remaining options):\n\
|
|
--defaults-file=# Only read default options from the given file #.\n\
|
|
--defaults-extra-file=# Read this file after the global files are read.\n\
|
|
--defaults-group-suffix=# Additionally read default groups with # appended as a suffix.");
|
|
}
|
|
|
|
|
|
static int add_directory(MEM_ROOT *alloc, const char *dir, const char **dirs)
|
|
{
|
|
char buf[FN_REFLEN];
|
|
size_t len;
|
|
char *p;
|
|
my_bool err __attribute__((unused));
|
|
|
|
len= normalize_dirname(buf, dir);
|
|
if (!(p= strmake_root(alloc, buf, len)))
|
|
return 1; /* Failure */
|
|
/* Should never fail if DEFAULT_DIRS_SIZE is correct size */
|
|
err= array_append_string_unique(p, dirs, DEFAULT_DIRS_SIZE);
|
|
DBUG_ASSERT(err == FALSE);
|
|
|
|
return 0;
|
|
}
|
|
|
|
#ifdef __WIN__
|
|
static const char *my_get_module_parent(char *buf, size_t size)
|
|
{
|
|
char *last= NULL;
|
|
char *end;
|
|
if (!GetModuleFileName(NULL, buf, (DWORD) size))
|
|
return NULL;
|
|
end= strend(buf);
|
|
|
|
/*
|
|
Look for the second-to-last \ in the filename, but hang on
|
|
to a pointer after the last \ in case we're in the root of
|
|
a drive.
|
|
*/
|
|
for ( ; end > buf; end--)
|
|
{
|
|
if (*end == FN_LIBCHAR)
|
|
{
|
|
if (last)
|
|
{
|
|
/* Keep the last '\' as this works both with D:\ and a directory */
|
|
end[1]= 0;
|
|
break;
|
|
}
|
|
last= end;
|
|
}
|
|
}
|
|
|
|
return buf;
|
|
}
|
|
#endif /* __WIN__ */
|
|
|
|
|
|
static const char **init_default_directories(MEM_ROOT *alloc)
|
|
{
|
|
const char **dirs;
|
|
char *env;
|
|
int errors= 0;
|
|
DBUG_ENTER("init_default_directories");
|
|
|
|
dirs= (const char **)alloc_root(alloc, DEFAULT_DIRS_SIZE * sizeof(char *));
|
|
if (dirs == NULL)
|
|
DBUG_RETURN(NULL);
|
|
bzero((char *) dirs, DEFAULT_DIRS_SIZE * sizeof(char *));
|
|
|
|
#ifdef __WIN__
|
|
|
|
{
|
|
char fname_buffer[FN_REFLEN];
|
|
if (GetSystemWindowsDirectory(fname_buffer, sizeof(fname_buffer)))
|
|
errors += add_directory(alloc, fname_buffer, dirs);
|
|
|
|
if (GetWindowsDirectory(fname_buffer, sizeof(fname_buffer)))
|
|
errors += add_directory(alloc, fname_buffer, dirs);
|
|
|
|
errors += add_directory(alloc, "C:/", dirs);
|
|
|
|
if (my_get_module_parent(fname_buffer, sizeof(fname_buffer)) != NULL)
|
|
{
|
|
errors += add_directory(alloc, fname_buffer, dirs);
|
|
|
|
strcat_s(fname_buffer, sizeof(fname_buffer), "/data");
|
|
errors += add_directory(alloc, fname_buffer, dirs);
|
|
}
|
|
}
|
|
|
|
#else
|
|
|
|
#if defined(DEFAULT_SYSCONFDIR)
|
|
if (DEFAULT_SYSCONFDIR[0])
|
|
errors += add_directory(alloc, DEFAULT_SYSCONFDIR, dirs);
|
|
#else
|
|
errors += add_directory(alloc, "/etc/", dirs);
|
|
errors += add_directory(alloc, "/etc/mysql/", dirs);
|
|
#endif /* DEFAULT_SYSCONFDIR */
|
|
|
|
#endif
|
|
|
|
if ((env= getenv("MYSQL_HOME")))
|
|
errors += add_directory(alloc, env, dirs);
|
|
|
|
/* Placeholder for --defaults-extra-file=<path> */
|
|
errors += add_directory(alloc, "", dirs);
|
|
|
|
#if !defined(__WIN__)
|
|
errors += add_directory(alloc, "~/", dirs);
|
|
#endif
|
|
|
|
DBUG_RETURN(errors > 0 ? NULL : dirs);
|
|
}
|