utils.sh 18.9 KB
Newer Older
Michał 'rysiek' Woźniak's avatar
Michał 'rysiek' Woźniak committed
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 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502
#!/bin/bash

#
# database utility scripts
#

#
# "we've been properly sourced" flag function
function sc_properly_sourced() {
  return 0
}
export -f sc_properly_sourced

#
# display a general error message
# $1 -- additional error msg to display
function display_error {
  echo
  echo "########################################"
  echo "###   AN ERROR OCCURED, ABORTING!    ###"
  echo "###   ---------------------------    ###"
  echo "### inspect the log output carefully ###"
  echo "########################################"
  echo
  # if we have an additional error msg set, use it
  [ -z ${1+x} ] || {
    echo "$1"
    echo
  }
}
export -f display_error


#
# rudimentary error handling -- exit the script
function display_error_and_quit {
  if [ -z ${1+x} ]; then
    display_error
  else
    display_error "$1"
  fi
  read
  exit 1
}
export -f display_error_and_quit


#
# rudimentary error handling -- continue with next iteration of a loop
function display_error_and_continue {
  if [ -z ${1+x} ]; then
    display_error
  else
    display_error "$1"
  fi
  read
  continue
}
export -f display_error_and_continue


#
# rudimentary error handling -- break the loop
function display_error_and_break {
  if [ -z ${1+x} ]; then
    display_error
  else
    display_error "$1"
  fi
  read
  break
}
export -f display_error_and_break


#
# utility -- clean the variables used in the dump_*_scripts
function clean_db_vars {
    unset DATABASES
    unset DBUSERS
    unset DBGRANTS
}


#
# create a read-only user for a mysql database (or databases)
# $1             - database host to connect to
# $2             - user to connect as
# $3             - password for that user
# $4             - username to be created
# $5             - optional; hostname of the user to be created
#                  (if unset or an empty string, '%' will be used)
# $6             - optional; password for the user to be created
#                  (if unset or an empty string, random password will be generated and printed on-screen)
#
# the user gets SELECT, SHOW DATABASES, LOCK TABLES, EXECUTE, SHOW VIEW privileges on *all databases*
function create_readonly_mysql_user() {
    
    echo
    echo "creating a read-only user..."
    echo "+-- connection details:"
    echo "    +-- db host to connect to: $1"
    echo "    +-- db user to connect as: $2"
    
    echo "+-- read-only user details:"
    # the read-only user name -- simple enough
    RUSER_NAME="$4"
    echo "    +-- username: $RUSER_NAME"
    
    # read-only user hostname
    RUSER_HOST="%"
    if [ ! -z ${5+x} ]; then
        RUSER_HOST="$5"
    fi
    echo "    +-- hostname: $RUSER_HOST"
    
    # read-only user password
    # if supplied, use it
    if [ ! -z ${6+x} ]; then
        RUSER_PW="$6"
        echo "    +-- password: (provided on the command line)"
    # otherwise, create a random one
    else
        RUSER_PW="$( pwgen -s 24 1 )" || display_error_and_quit "Error generating password; is pwgen installed and in \$PATH?"
        echo "    +-- password: $RUSER_PW"
    fi
    
    # do the magic
    mysql -h "$1" -u "$2" --password="$3" --batch -e "GRANT SELECT, SHOW DATABASES, LOCK TABLES, EXECUTE, SHOW VIEW ON *.* TO '$RUSER_NAME'@'$RUSER_HOST' IDENTIFIED BY '$RUSER_PW';" \
        || display_error_and_quit "Error creating a read-only user."
}
export -f create_readonly_mysql_user

#
# this assumes we have *at least* read-only access to databases we want to dump
# $1             - targed directory; the directory and structure within ($1/, $1/schemas/, $1/dumps/) will be made sure to exist
# $2             - database host to connect to
# $3             - user to connect as
# $4             - password for that user
# $5 and further - optional, the databases to dump (dumping all if empty)
#
# relevant: https://dev.mysql.com/doc/refman/5.6/en/mysqldump.html
# 
# databases are dumped as schema (containing grants related to the database and CREATE statements) and data dump spearately,
# put in $1/schemas/$database_name.schema.sql and $1/dumps/$database_name.dump.sql respectively
# 
# this does *not* dump internal MySQL information_schema and performance_schema databases.
function dump_mysql_dbs {
    
    # clean the vars
    clean_db_vars
    
    # create the directory structure
    mkdir -p "$1"
    mkdir -p "$1/schemas"
    mkdir -p "$1/dumps"
    
    #
    # - if we have no additional arguments (5th and onwards), we need to dump all the databases (well, apart from information_schema and performance_schema)
    # - if we have such arguments, we can use WHERE `Database` IN ('$5', ...)
    DATABASES_WHERE=""
    if [ ! -z ${5+x} ]; then
        DATABASES_WHERE="WHERE \`Database\` IN ( '` echo "${@:5}" | sed -r -e "s/ /', '/g" ` )"
    fi
    
    # get the list of databases
    DATABASES="$( mysql -h "$2" -u "$3" --password="$4" --batch -e "SHOW DATABASES $DATABASES_WHERE;" | egrep -v '(Database|information_schema|performance_schema)' )"
    
    # either the code is 0, or the command failed; act accordingly.
    [ $? -eq 0 ] || display_error_and_quit
    
    # did we find anything?
    if [[ "$DATABASES" == "" ]]; then
        echo "        +-- no databases found."
        return 0
    fi
    
    #
    # if we had a list of databases, did we find all of them?
    # rationale: if we have a specific list of databases, we *expect* them to be dumped
    #            if we cannot find some of them, that should be clearly signalled
    if [ ! -z ${5+x} ]; then
        DATABASES_MISSING="$( echo "${@:5} $DATABASES" | tr ' ' '\n' | sort | uniq -u )"
        if [[ "$DATABASES_MISSING" != "" ]]; then
            # if not, complain and exit
            display_error_and_quit "Not all databases found; missing: $DATABASES_MISSING"
        fi
    fi
    
    # whoo hoo, found *something*
    echo "        +-- found `echo "$DATABASES" | wc -l` databases..."
    
    # is the db using authentication_string, or password for user passwords?
    if [[ "$( mysql -h "$2" -u "$3" --password="$4" --batch --skip-column-names -e "SELECT COUNT(*) FROM information_schema.COLUMNS WHERE TABLE_SCHEMA = 'mysql' AND TABLE_NAME = 'user' AND COLUMN_NAME = 'password';" )" == "0" ]]; then
        PWCOL="authentication_string"
    else
        PWCOL="password"
    fi
    echo "        +-- password column: $PWCOL"
    
    # get the list of users
    DBUSERS="$( mysql -h "$2" -u "$3" --password="$4" --batch --skip-column-names -e "SELECT CONCAT('',QUOTE(user),'@',QUOTE(host),':',$PWCOL) FROM mysql.user WHERE user<>'';")"
    
    [ $? -eq 0 ] || display_error_and_quit
    echo "        +-- found `echo "$DBUSERS" | wc -l` users..."
    
    # get all grants for said users
    DBGRANTS=""
    for user_host_pass in ${DBUSERS}; do
        # ignore root
        if echo "$user_host_pass" | grep "'root'@" >/dev/null; then
            continue
        fi
        DBUSER="$( echo "$user_host_pass" | cut -d ':' -f 1 )"
        DBUSERPW="$( echo "$user_host_pass" | cut -d ':' -f 2 )"
        # get the grants                                                                                                                                  # add IDENTIFIED BY <password>, but only when there was no IDENTIFIED BY there already
        DBGRANTS=`echo -ne "$DBGRANTS\n$( mysql -h "$2" -u "$3" --password="$4" --batch --skip-column-names -e "SHOW GRANTS FOR $DBUSER;" | sed -r -e "s/(IDENTIFIED BY.*)$/ IDENTIFIED BY PASSWORD '$DBUSERPW'/g" )"`
        [ $? -eq 0 ] || display_error_and_quit
    done
    
    # iterate through databases
    for db in ${DATABASES}; do
        echo "        +-- working on db: $db"
        
        # files
        SCHEMA_FILE="$1/schemas/$db.schema.sql"
        DUMP_FILE="$1/dumps/$db.dump.sql"
        echo "        +-- schema file : $SCHEMA_FILE"
        echo "        +-- dump file   : $DUMP_FILE"
    
        # schema
        echo "            +-- schema..."
        mysqldump -h "$2" -u "$3" --password="$4" --add-drop-database --no-data --databases "$db" > "$SCHEMA_FILE"
        [ $? -eq 0 ] || display_error_and_quit
        
        # grants
        echo "            +-- grants..."
        echo '-- ------ --' >> "$SCHEMA_FILE"
        echo '-- GRANTS --' >> "$SCHEMA_FILE"
        echo '-- ------ --' >> "$SCHEMA_FILE"
        
        # TODO FIXME lacking password information...
        # SET PASSWORD FOR ... = HASH_STRING
        
        echo "${DBGRANTS}" | grep "ON \*." | sed -r -e 's/$/;/' >> "$SCHEMA_FILE"
        [ $? -lt 2 ] || display_error_and_quit # less than 2 here, because 0 on "found", 1 on "not found", 2 and above on "error"
        echo "${DBGRANTS}" | grep "ON \`${db}\`" | sed -r -e 's/$/;/' >> "$SCHEMA_FILE"
        [ $? -lt 2 ] || display_error_and_quit # less than 2 here, because 0 on "found", 1 on "not found", 2 and above on "error"
        # we need this for the privs to work after restore
        echo "FLUSH PRIVILEGES;" >> "$SCHEMA_FILE"
        
        # dump
        echo "            +-- dump..."
        mysqldump -h "$2" -u "$3" --password="$4" --no-create-info --no-create-db --databases "$db" >> "$DUMP_FILE"
        [ $? -eq 0 ] || display_error_and_quit
        
        echo "            +-- done."
    done
    
    # set the permissions so that 
    # this will not stop a root user from using these, but should make them stand out well enough
    echo "        +-- setting permissions on mysql.*"
    chmod a= "$1"/*/mysql.*.sql
    
    # we're done
    echo "        +-- done."
}
export -f dump_mysql_dbs


#
# create a read-only user for a postgresql database (or databases)
# $1             - database host to connect to
# $2             - user to connect as
# $3             - password for that user
# $4             - username to be created
# $5             - optional; hostname of the user to be created
#                  (if unset or an empty string, '%' will be used)
# $6             - optional; password for the user to be created
#                  (if unset or an empty string, random password will be generated and printed on-screen)
#
# not as simple as the mysql version; we need to make sure that:
# a). given role is created...
# b). ...and granted CONNECT on all databases...
# c). ...and granted SELECT on pg_authid...
# d). ...and granted USAGE on all schemas in all databases...
# e). ...and granted SELECT on all tables and sequences in all schemas in all databases...
# f). ...and granted EXECUTE on all functions in all schemas in all databases...
# g). ...and that the default privileges for all roles in all schemas in all databases grant
#     the new read-only role SELECT on tables and sequences, and EXECUTE on functions
#     created in the future.
#
# ref. https://wiki.postgresql.org/images/d/d1/Managing_rights_in_postgresql.pdf
#
# granting the readonly user access to all tables in a database:
#  CREATE ROLE readonly NOSUPERUSER NOCREATEDB NOCREATEROLE LOGIN NOREPLICATION PASSWORD '$DUMP_PASS';
#  GRANT SELECT ON pg_authid TO readonly;
# and for each database:
#  GRANT CONNECT ON DATABASE a_database TO readonly;
#  \c a_database
#  GRANT USAGE ON SCHEMA a_schema TO readonly;
#  GRANT SELECT ON ALL TABLES IN SCHEMA a_schema TO readonly;
#  GRANT SELECT ON ALL SEQUENCES IN SCHEMA a_schema TO readonly;
#  ALTER DEFAULT PRIVILEGES IN SCHEMA a_schema GRANT SELECT ON TABLES TO readonly;
#  ALTER DEFAULT PRIVILEGES IN SCHEMA a_schema GRANT SELECT ON SEQUENCES TO readonly;
# a_schema is usually "public"
# 
# CREATE ROLE readonly LOGIN PASSWORD 'some_pass';
# -- Existing objects
# GRANT CONNECT ON DATABASE the_db TO readonly;
# GRANT USAGE ON SCHEMA public TO readonly;
# GRANT SELECT ON ALL TABLES IN SCHEMA public TO readonly;
# GRANT SELECT ON ALL SEQUENCES IN SCHEMA public TO readonly;
# GRANT EXECUTE ON ALL FUNCTIONS IN SCHEMA public TO readonly;
# -- New objects
# ALTER DEFAULT PRIVILEGES FOR ROLE ddl_user IN SCHEMA public GRANT SELECT ON TABLES TO readonly;
# ALTER DEFAULT PRIVILEGES FOR ROLE ddl_user IN SCHEMA public GRANT SELECT ON SEQUENCES TO readonly;
# ALTER DEFAULT PRIVILEGES FOR ROLE ddl_user IN SCHEMA public GRANT EXECUTE ON FUNCTIONS TO readonly;
# https://wiki.postgresql.org/images/d/d1/Managing_rights_in_postgresql.pdf
function create_readonly_postgres_user() {

    DATABASES="$( PGPASSWORD="$4" psql -h "$2" -U "$3" -lAqt | grep '|' | cut -d '|' -f 1 | egrep -v "template[0-9]" )"

}
export -f create_readonly_postgres_user


#
# this assumes we have *at least* read-only access to databases we want to dump
# $1             - targed directory; the directory and structure within ($1/, $1/schemas/, $1/dumps/) will be made sure to exist
# $2             - database host
# $3             - user to connect as
# $4             - password for that user
# $5 and further - optional, the databases to dump (dumping all if empty)
#
# relevant: http://www.postgresql.org/docs/current/static/app-pgdump.html
#
# databases are dumped as schema (containing grants related to the database and CREATE statements) and data dump spearately,
# put in $1/schemas/$database_name.schema.sql and $1/dumps/$database_name.dump.sql respectively
function dump_postgres_dbs {

    # clean the vars
    clean_db_vars

    # create the directory
    mkdir -p "$1"
    mkdir -p "$1/schemas"
    mkdir -p "$1/dumps"
    
    # get the list of databases
    # -l/--list         List all available databases,then exit. Other non-connection
    # -A/--no-align     Switches to unaligned output mode.
    # -q/--quiet        Specifies that psql should do its work quietly.
    # -t/--tuples-only  Turn off printing of column names and result row count footers, etc.
    # ref. http://linuxcommand.org/man_pages/psql1.html
    DATABASES="$( PGPASSWORD="$4" psql -h "$2" -U "$3" -lAqt | grep '|' | cut -d '|' -f 1 | egrep -v "template[0-9]" )"
    
    # either the code is 0, or the command failed; act accordingly.
    [ $? -eq 0 ] || display_error_and_quit

    # do we have any databases?
    if [[ "$DATABASES" == "" ]]; then
        echo "        +-- no databases found."
        return 0
    fi
    
    #
    # if we had a list of databases, did we find all of them?
    # rationale: if we have a specific list of databases, we *expect* them to be dumped
    #            if we cannot find some of them, that should be clearly signalled
    if [ ! -z ${5+x} ]; then
        DATABASES_MISSING="$( echo "${@:5} $DATABASES" | tr ' ' '\n' | sort | uniq -u )"
        if [[ "$DATABASES_MISSING" != "" ]]; then
            # if not, complain and exit
            display_error_and_quit "Not all databases found; missing: $DATABASES_MISSING"
        fi
    fi
    
    # list of users
    DBUSERS="$( PGPASSWORD="$4" pg_dumpall -h "$2" --globals-only -U "$3" | egrep '(CREATE|ALTER) ROLE' )"
    [ $? -eq 0 ] || display_error_and_quit
    echo "        +-- found `echo "$DBUSERS" | egrep "^CREATE" | wc -l` users..."
    
    
    # iterate through databases
    for db in ${DATABASES}; do
        echo "        +-- working on db: $db"
        
        # files
        SCHEMA_FILE="$1/schemas/$db.schema.sql"
        DUMP_FILE="$1/dumps/$db.dump.sql"
        echo "        +-- schema file : $SCHEMA_FILE"
        echo "        +-- dump file   : $DUMP_FILE"
        
        # schema
        echo "            +-- schema..."
        PGPASSWORD="$4" pg_dump -h "$2" --create --clean --schema-only -U "$3" "$db" > "$SCHEMA_FILE"
        [ $? -eq 0 ] || display_error_and_quit
        
        # grants
        echo "            +-- grants..."
        echo '-- ------ --' >> "$SCHEMA_FILE"
        echo '-- GRANTS --' >> "$SCHEMA_FILE"
        echo '-- ------ --' >> "$SCHEMA_FILE"
        
        USERS_GREP="$( cat "$SCHEMA_FILE" | grep 'GRANT' | sed -r -e 's/^GRANT.+TO ([^;]+);/\1/' | sort | uniq )"
        USERS_GREP="$( echo $USERS_GREP | tr ' ' '|' )"
        echo "$DBUSERS" | egrep " ($USERS_GREP)[; ]" >> "$SCHEMA_FILE"
        
        # dump
        echo "            +-- dump..."
        PGPASSWORD="$4" pg_dump -h "$2" --create --data-only --format custom -U "$3" "$db" >> "$DUMP_FILE"
        [ $? -eq 0 ] || display_error_and_quit
        
        echo "            +-- done."
    done
    
    # we're done
    echo "        +-- done."
}
export -f dump_postgres_dbs


#
# elasticsearch
# 
# info:
#  https://www.elastic.co/guide/en/elasticsearch/guide/master/backing-up-your-cluster.html
# restoring:
#  https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html#_restoring_to_a_different_cluster
#
# $1             - targed directory
# $2             - database host
# $3             - optional; location where the temporary backup directory will be created;
#                  if not set, /tmp will be used
#
# we're cheating here a bit:
#  - create a new backup repository
#  - make a snapshot
#  - copy the snapshot data to the right location, outside the repository directory
#  - remove the snapshot
#  - remove the backup repository
#
# NOTICE: this will *ONLY* work on a single-node cluster, or on a cluster where all the nodes
#         have access to the tmp snapshot directory!
#         
# NOTICE: the temporary dump directory has to be accessible both to the elasticsearch server, and to this script
#         (for instance, if they're running in separate docker containers,
#          this directory has to be volume-mounted in both)
function dump_elasticsearch_dbs {
    
    # name of the backup
    BACKUP_NAME="temp_backup_$( date +%F )"
    
    # the temporary backup location
    # this location has to be accessible to the elasticsearch server, and to this script
    # (for instance, if they're running in separate docker containers, this directory has to be volume-mounted in both)
    if [ -z ${3+x} ]; then
        BACKUP_TEMP_DIR="$( mktemp -d --tmpdir="/tmp" )"
    else
        BACKUP_TEMP_DIR="$( mktemp -d --tmpdir="$3" )"
    fi
    
    # let's make sure we have the right perms to create the snapshot
    chmod a+rwX "$BACKUP_TEMP_DIR"
    
    # clean the vars
    clean_db_vars

    # create the directory
    echo "        +-- setup..."
    echo "            +-- directory: $1"
    mkdir -p "$1"
                               
    # create the temporary backup repository
    echo "            +-- ES snapshot repository in: $BACKUP_TEMP_DIR"
    curl -X PUT -H "Content-Type: application/json" "http://$2:9200/_snapshot/$BACKUP_NAME" -d "{
        \"type\": \"fs\", 
        \"settings\": {
            \"location\": \"$BACKUP_TEMP_DIR\" 
        }
    }"
    echo
    
    # create a snapshot, blocking until it's done
    echo "        +-- dump..."
    curl -X PUT "http://$2:9200/_snapshot/$BACKUP_NAME/snapshot?wait_for_completion=true" || display_error_and_quit 'Error while generating the snapshot!'
    echo
    
    # copy the backup to a less temporary location
    cp -a "$BACKUP_TEMP_DIR"/* "$1/"  || display_error_and_quit 'Error while copying the snapshot data to the target directory!'
    
    # cleanup
    echo "        +-- cleanup..."
    curl -X DELETE "http://$2:9200/_snapshot/$BACKUP_NAME/snapshot" || display_error_and_quit 'Error while cleaning up the snapshot!'
    echo
    curl -X DELETE "http://$2:9200/_snapshot/$BACKUP_NAME/" || display_error_and_quit 'Error while cleaning up the backup repository!'
    echo
    rm -rf "$BACKUP_TEMP_DIR/*"
    echo "        +-- done..."
}
export -f dump_elasticsearch_dbs