Movatterモバイル変換

Table 12.18 Encryption Functions

Exploits for the MD5 and SHA-1 algorithms have become known. You may wish to consider using another one-way encryption function described in this section instead, such asSHA2().

Passwords or other sensitive values supplied as arguments to encryption functions are sent as cleartext to the MySQL server unless an SSL connection is used. Also, such values appear in any MySQL logs to which they are written. To avoid these types of exposure, applications can encrypt sensitive values on the client side before sending them to the server. The same considerations apply to encryption keys. To avoid exposing these, applications can use stored procedures to encrypt and decrypt values on the server side.

• AES_DECRYPT(crypt_str,key_str[,init_vector][,kdf_name][,salt][,info | iterations])

  This function decrypts data using the official AES (Advanced Encryption Standard) algorithm. For more information, see the description ofAES_ENCRYPT().

  Statements that useAES_DECRYPT() are unsafe for statement-based replication.

• AES_ENCRYPT(str,key_str[,init_vector][,kdf_name][,salt][,info | iterations])

  AES_ENCRYPT() andAES_DECRYPT() implement encryption and decryption of data using the official AES (Advanced Encryption Standard) algorithm, previously known as“Rijndael.” The AES standard permits various key lengths. By default these functions implement AES with a 128-bit key length. Key lengths of 196 or 256 bits can be used, as described later. The key length is a trade off between performance and security.

  AES_ENCRYPT() encrypts the stringstr using the key stringkey_str, and returns a binary string containing the encrypted output.AES_DECRYPT() decrypts the encrypted stringcrypt_str using the key stringkey_str, and returns the original plaintext string. If either function argument isNULL, the function returnsNULL. IfAES_DECRYPT() detects invalid data or incorrect padding, it returnsNULL. However, it is possible forAES_DECRYPT() to return a non-NULL value (possibly garbage) if the input data or the key is invalid.

  As of MySQL 5.7.40, these functions support the use of a key derivation function (KDF) to create a cryptographically strong secret key from the information passed inkey_str. The derived key is used to encrypt and decrypt the data, and it remains in the MySQL Server instance and is not accessible to users. Using a KDF is highly recommended, as it provides better security than specifying your own premade key or deriving it by a simpler method as you use the function. The functions support HKDF (available from OpenSSL 1.1.0), for which you can specify an optional salt and context-specific information to include in the keying material, and PBKDF2 (available from OpenSSL 1.0.2), for which you can specify an optional salt and set the number of iterations used to produce the key.

  AES_ENCRYPT() andAES_DECRYPT() permit control of the block encryption mode. Theblock_encryption_mode system variable controls the mode for block-based encryption algorithms. Its default value isaes-128-ecb, which signifies encryption using a key length of 128 bits and ECB mode. For a description of the permitted values of this variable, seeSection 5.1.7, “Server System Variables”. The optionalinit_vector argument is used to provide an initialization vector for block encryption modes that require it.

  Statements that useAES_ENCRYPT() orAES_DECRYPT() are unsafe for statement-based replication.

  IfAES_ENCRYPT() is invoked from within themysql client, binary strings display using hexadecimal notation, depending on the value of the--binary-as-hex. For more information about that option, seeSection 4.5.1, “mysql — The MySQL Command-Line Client”.

  The arguments for theAES_ENCRYPT() andAES_DECRYPT() functions are as follows:

  str

  The string forAES_ENCRYPT() to encrypt using the key stringkey_str, or (as of MySQL 5.7.40) the key derived from it by the specified KDF. The string can be any length. Padding is automatically added tostr so it is a multiple of a block as required by block-based algorithms such as AES. This padding is automatically removed by theAES_DECRYPT() function.

  crypt_str

  The encrypted string forAES_DECRYPT() to decrypt using the key stringkey_str, or (from MySQL 5.7.40) the key derived from it by the specified KDF. The string can be any length. The length ofcrypt_str can be calculated from the length of the original string using this formula:

  16 * (trunc(string_length / 16) + 1)

  key_str

  The encryption key, or the input keying material that is used as the basis for deriving a key using a key derivation function (KDF). For the same instance of data, use the same value ofkey_str for encryption withAES_ENCRYPT() and decryption withAES_DECRYPT().

  If you are using a KDF, which you can from MySQL 5.7.40,key_str can be any arbitrary information such as a password or passphrase. In the further arguments for the function, you specify the KDF name, then add further options to increase the security as appropriate for the KDF.

  When you use a KDF, the function creates a cryptographically strong secret key from the information passed inkey_str and any salt or additional information that you provide in the other arguments. The derived key is used to encrypt and decrypt the data, and it remains in the MySQL Server instance and is not accessible to users. Using a KDF is highly recommended, as it provides better security than specifying your own premade key or deriving it by a simpler method as you use the function.

  If you are not using a KDF, for a key length of 128 bits, the most secure way to pass a key to thekey_str argument is to create a truly random 128-bit value and pass it as a binary value. For example:

  INSERT INTO tVALUES (1,AES_ENCRYPT('text',UNHEX('F3229A0B371ED2D9441B830D21A390C3')));

  A passphrase can be used to generate an AES key by hashing the passphrase. For example:

  INSERT INTO tVALUES (1,AES_ENCRYPT('text', UNHEX(SHA2('My secret passphrase',512))));

  If you exceed the maximum key length of 128 bits, a warning is returned. If you are not using a KDF, do not pass a password or passphrase directly tokey_str, hash it first. Previous versions of this documentation suggested the former approach, but it is no longer recommended as the examples shown here are more secure.

  init_vector

  An initialization vector, for block encryption modes that require it. Theblock_encryption_mode system variable controls the mode. For the same instance of data, use the same value ofinit_vector for encryption withAES_ENCRYPT() and decryption withAES_DECRYPT().

  Note

  If you are using a KDF, you must specify an initialization vector or a null string for this argument, in order to access the later arguments to define the KDF.

  For modes that require an initialization vector, it must be 16 bytes or longer (bytes in excess of 16 are ignored). An error occurs ifinit_vector is missing. For modes that do not require an initialization vector, it is ignored and a warning is generated ifinit_vector is specified, unless you are using a KDF.

  The default value for theblock_encryption_mode system variable isaes-128-ecb, or ECB mode, which does not require an initialization vector. The alternative permitted block encryption modes CBC, CFB1, CFB8, CFB128, and OFB all require an initialization vector.

  A random string of bytes to use for the initialization vector can be produced by callingRANDOM_BYTES(16).

  kdf_name

  The name of the key derivation function (KDF) to create a key from the input keying material passed inkey_str, and other arguments as appropriate for the KDF. This optional argument is available from MySQL 5.7.40.

  For the same instance of data, use the same value ofkdf_name for encryption withAES_ENCRYPT() and decryption withAES_DECRYPT(). When you specifykdf_name, you must specifyinit_vector, using either a valid initialization vector, or a null string if the encryption mode does not require an initialization vector.

  The following values are supported:

  hkdf

  HKDF, which is available from OpenSSL 1.1.0. HKDF extracts a pseudorandom key from the keying material then expands it into additional keys. With HKDF, you can specify an optional salt (salt) and context-specific information such as application details (info) to include in the keying material.

  pbkdf2_hmac

  PBKDF2, which is available from OpenSSL 1.0.2. PBKDF2 applies a pseudorandom function to the keying material, and repeats this process a large number of times to produce the key. With PBKDF2, you can specify an optional salt (salt) to include in the keying material, and set the number of iterations used to produce the key (iterations).

  In this example, HKDF is specified as the key derivation function, and a salt and context information are provided. The argument for the initialization vector is included but is the empty string:

  SELECT AES_ENCRYPT('mytext','mykeystring', '', 'hkdf', 'salt', 'info');

  In this example, PBKDF2 is specified as the key derivation function, a salt is provided, and the number of iterations is doubled from the recommended minimum:

  SELECT AES_ENCRYPT('mytext','mykeystring', '', 'pbkdf2_hmac','salt', '2000');

  salt

  A salt to be passed to the key derivation function (KDF). This optional argument is available from MySQL 5.7.40. Both HKDF and PBKDF2 can use salts, and their use is recommended to help prevent attacks based on dictionaries of common passwords or rainbow tables.

  A salt consists of random data, which for security must be different for each encryption operation. A random string of bytes to use for the salt can be produced by callingRANDOM_BYTES(). This example produces a 64-bit salt:

  SET @salt = RANDOM_BYTES(8);

  For the same instance of data, use the same value ofsalt for encryption withAES_ENCRYPT() and decryption withAES_DECRYPT(). The salt can safely be stored along with the encrypted data.

  info

  Context-specific information for HKDF to include in the keying material, such as information about the application. This optional argument is available from MySQL 5.7.40 when you specifyhkdf as the KDF name. HKDF adds this information to the keying material specified inkey_str and the salt specified insalt to produce the key.

  For the same instance of data, use the same value ofinfo for encryption withAES_ENCRYPT() and decryption withAES_DECRYPT().

  iterations

  The iteration count for PBKDF2 to use when producing the key. This optional argument is available from MySQL 5.7.40 when you specifypbkdf2_hmac as the KDF name. A higher count gives greater resistance to brute-force attacks because it has a greater computational cost for the attacker, but the same is necessarily true for the key derivation process. The default if you do not specify this argument is 1000, which is the minimum recommended by the OpenSSL standard.

  For the same instance of data, use the same value ofiterations for encryption withAES_ENCRYPT() and decryption withAES_DECRYPT().

  mysql> SET block_encryption_mode = 'aes-256-cbc';mysql> SET @key_str = SHA2('My secret passphrase',512);mysql> SET @init_vector = RANDOM_BYTES(16);mysql> SET @crypt_str = AES_ENCRYPT('text',@key_str,@init_vector);mysql> SELECT AES_DECRYPT(@crypt_str,@key_str,@init_vector);+-----------------------------------------------+| AES_DECRYPT(@crypt_str,@key_str,@init_vector) |+-----------------------------------------------+| text                                          |+-----------------------------------------------+

• COMPRESS(string_to_compress)

  Compresses a string and returns the result as a binary string. This function requires MySQL to have been compiled with a compression library such aszlib. Otherwise, the return value is alwaysNULL. The compressed string can be uncompressed withUNCOMPRESS().

  mysql> SELECT LENGTH(COMPRESS(REPEAT('a',1000)));        -> 21mysql> SELECT LENGTH(COMPRESS(''));        -> 0mysql> SELECT LENGTH(COMPRESS('a'));        -> 13mysql> SELECT LENGTH(COMPRESS(REPEAT('a',16)));        -> 15

  The compressed string contents are stored the following way:

  • Empty strings are stored as empty strings.

  • Nonempty strings are stored as a 4-byte length of the uncompressed string (low byte first), followed by the compressed string. If the string ends with space, an extra. character is added to avoid problems with endspace trimming should the result be stored in aCHAR orVARCHAR column. (However, use of nonbinary string data types such asCHAR orVARCHAR to store compressed strings is not recommended anyway because character set conversion may occur. Use aVARBINARY orBLOB binary string column instead.)

  IfCOMPRESS() is invoked from within themysql client, binary strings display using hexadecimal notation, depending on the value of the--binary-as-hex. For more information about that option, seeSection 4.5.1, “mysql — The MySQL Command-Line Client”.

• DECODE(crypt_str,pass_str)

  DECODE() decrypts the encrypted stringcrypt_str usingpass_str as the password.crypt_str should be a string returned fromENCODE().

  Note

  TheENCODE() andDECODE() functions are deprecated in MySQL 5.7, and should no longer be used. Expect them to be removed in a future MySQL release. Consider usingAES_ENCRYPT() andAES_DECRYPT() instead.

• DES_DECRYPT(crypt_str[,key_str])

  Decrypts a string encrypted withDES_ENCRYPT(). If an error occurs, this function returnsNULL.

  This function works only if MySQL has been configured with SSL support. SeeSection 6.3, “Using Encrypted Connections”.

  If nokey_str argument is given,DES_DECRYPT() examines the first byte of the encrypted string to determine the DES key number that was used to encrypt the original string, and then reads the key from the DES key file to decrypt the message. For this to work, the user must have theSUPER privilege. The key file can be specified with the--des-key-file server option.

  If you pass this function akey_str argument, that string is used as the key for decrypting the message.

  If thecrypt_str argument does not appear to be an encrypted string, MySQL returns the givencrypt_str.

  Note

  TheDES_ENCRYPT() andDES_DECRYPT() functions are deprecated in MySQL 5.7, are removed in MySQL 8.0, and should no longer be used. Consider usingAES_ENCRYPT() andAES_DECRYPT() instead.

• DES_ENCRYPT(str[,{key_num|key_str}])

  Encrypts the string with the given key using the Triple-DES algorithm.

  This function works only if MySQL has been configured with SSL support. SeeSection 6.3, “Using Encrypted Connections”.

  The encryption key to use is chosen based on the second argument toDES_ENCRYPT(), if one was given. With no argument, the first key from the DES key file is used. With akey_num argument, the given key number (0 to 9) from the DES key file is used. With akey_str argument, the given key string is used to encryptstr.

  The key file can be specified with the--des-key-file server option.

  The return string is a binary string where the first character isCHAR(128 |key_num). If an error occurs,DES_ENCRYPT() returnsNULL.

  The 128 is added to make it easier to recognize an encrypted key. If you use a string key,key_num is 127.

  The string length for the result is given by this formula:

  new_len =orig_len + (8 - (orig_len % 8)) + 1

  Each line in the DES key file has the following format:

  key_numdes_key_str

  Eachkey_num value must be a number in the range from0 to9. Lines in the file may be in any order.des_key_str is the string that is used to encrypt the message. There should be at least one space between the number and the key. The first key is the default key that is used if you do not specify any key argument toDES_ENCRYPT().

  You can tell MySQL to read new key values from the key file with theFLUSH DES_KEY_FILE statement. This requires theRELOAD privilege.

  One benefit of having a set of default keys is that it gives applications a way to check for the existence of encrypted column values, without giving the end user the right to decrypt those values.

  Note

  TheDES_ENCRYPT() andDES_DECRYPT() functions are deprecated in MySQL 5.7, are removed in MySQL 8.0, and should no longer be used. Consider usingAES_ENCRYPT() andAES_DECRYPT() instead.

  mysql> SELECT customer_address FROM customer_table      > WHERE crypted_credit_card = DES_ENCRYPT('credit_card_number');

  IfDES_ENCRYPT() is invoked from within themysql client, binary strings display using hexadecimal notation, depending on the value of the--binary-as-hex. For more information about that option, seeSection 4.5.1, “mysql — The MySQL Command-Line Client”.

• ENCODE(str,pass_str)

  ENCODE() encryptsstr usingpass_str as the password. The result is a binary string of the same length asstr. To decrypt the result, useDECODE().

  Note

  TheENCODE() andDECODE() functions are deprecated in MySQL 5.7, and should no longer be used. Expect them to be removed in a future MySQL release.

  If you still need to useENCODE(), a salt value must be used with it to reduce risk. For example:

  ENCODE('cleartext', CONCAT('my_random_salt','my_secret_password'))

  A new random salt value must be used whenever a password is updated.

  IfENCODE() is invoked from within themysql client, binary strings display using hexadecimal notation, depending on the value of the--binary-as-hex. For more information about that option, seeSection 4.5.1, “mysql — The MySQL Command-Line Client”.

• ENCRYPT(str[,salt])

  Encryptsstr using the Unixcrypt() system call and returns a binary string. Thesalt argument must be a string with at least two characters or else the result isNULL. If nosalt argument is given, a random value is used.

  Note

  TheENCRYPT() function is deprecated in MySQL 5.7, are removed in MySQL 8.0, and should no longer be used. For one-way hashing, consider usingSHA2() instead.

  mysql> SELECT ENCRYPT('hello');        -> 'VxuFAJXVARROc'

  ENCRYPT() ignores all but the first eight characters ofstr, at least on some systems. This behavior is determined by the implementation of the underlyingcrypt() system call.

  The use ofENCRYPT() with theucs2,utf16,utf16le, orutf32 multibyte character sets is not recommended because the system call expects a string terminated by a zero byte.

  Ifcrypt() is not available on your system (as is the case with Windows),ENCRYPT() always returnsNULL.

  IfENCRYPT() is invoked from within themysql client, binary strings display using hexadecimal notation, depending on the value of the--binary-as-hex. For more information about that option, seeSection 4.5.1, “mysql — The MySQL Command-Line Client”.

• MD5(str)

  Calculates an MD5 128-bit checksum for the string. The value is returned as a string of 32 hexadecimal digits, orNULL if the argument wasNULL. The return value can, for example, be used as a hash key. See the notes at the beginning of this section about storing hash values efficiently.

  The return value is a string in the connection character set.

  mysql> SELECT MD5('testing');        -> 'ae2b1fca515949e5d54fb22b8ed95575'

  This is the“RSA Data Security, Inc. MD5 Message-Digest Algorithm.”

  See the note regarding the MD5 algorithm at the beginning this section.

• PASSWORD(str)

  Note

  This function is deprecated in MySQL 5.7 and is removed in MySQL 8.0.

  Returns a hashed password string calculated from the cleartext passwordstr. The return value is a string in the connection character set, orNULL if the argument isNULL. This function is the SQL interface to the algorithm used by the server to encrypt MySQL passwords for storage in themysql.user grant table.

  Theold_passwords system variable controls the password hashing method used by thePASSWORD() function. It also influences password hashing performed byCREATE USER andGRANT statements that specify a password using anIDENTIFIED BY clause.

  The following table shows, for each password hashing method, the permitted value ofold_passwords and which authentication plugins use the hashing method.

  Password Hashing Method	old_passwords Value	Associated Authentication Plugin
  MySQL 4.1 native hashing	0	mysql_native_password
  SHA-256 hashing	2	sha256_password

  SHA-256 password hashing (old_passwords=2) uses a random salt value, which makes the result fromPASSWORD() nondeterministic. Consequently, statements that use this function are not safe for statement-based replication and cannot be stored in the query cache.

  Encryption performed byPASSWORD() is one-way (not reversible), but it is not the same type of encryption used for Unix passwords.

  Note

  PASSWORD() is used by the authentication system in MySQL Server; you shouldnot use it in your own applications. For that purpose, consider a more secure function such asSHA2() instead. Also seeRFC 2195, section 2 (Challenge-Response Authentication Mechanism (CRAM)), for more information about handling passwords and authentication securely in your applications.

  Caution

  Under some circumstances, statements that invokePASSWORD() may be recorded in server logs or on the client side in a history file such as~/.mysql_history, which means that cleartext passwords may be read by anyone having read access to that information. For information about the conditions under which this occurs for the server logs and how to control it, seeSection 6.1.2.3, “Passwords and Logging”. For similar information about client-side logging, seeSection 4.5.1.3, “mysql Client Logging”.

• RANDOM_BYTES(len)

  This function returns a binary string oflen random bytes generated using the random number generator of the SSL library. Permitted values oflen range from 1 to 1024. For values outside that range, an error occurs.

  RANDOM_BYTES() can be used to provide the initialization vector for theAES_DECRYPT() andAES_ENCRYPT() functions. For use in that context,len must be at least 16. Larger values are permitted, but bytes in excess of 16 are ignored.

  RANDOM_BYTES() generates a random value, which makes its result nondeterministic. Consequently, statements that use this function are unsafe for statement-based replication and cannot be stored in the query cache.

  IfRANDOM_BYTES() is invoked from within themysql client, binary strings display using hexadecimal notation, depending on the value of the--binary-as-hex. For more information about that option, seeSection 4.5.1, “mysql — The MySQL Command-Line Client”.

• SHA1(str),SHA(str)

  Calculates an SHA-1 160-bit checksum for the string, as described in RFC 3174 (Secure Hash Algorithm). The value is returned as a string of 40 hexadecimal digits, orNULL if the argument wasNULL. One of the possible uses for this function is as a hash key. See the notes at the beginning of this section about storing hash values efficiently.SHA() is synonymous withSHA1().

  The return value is a string in the connection character set.

  mysql> SELECT SHA1('abc');        -> 'a9993e364706816aba3e25717850c26c9cd0d89d'

  SHA1() can be considered a cryptographically more secure equivalent ofMD5(). However, see the note regarding the MD5 and SHA-1 algorithms at the beginning this section.

• SHA2(str,hash_length)

  Calculates the SHA-2 family of hash functions (SHA-224, SHA-256, SHA-384, and SHA-512). The first argument is the plaintext string to be hashed. The second argument indicates the desired bit length of the result, which must have a value of 224, 256, 384, 512, or 0 (which is equivalent to 256). If either argument isNULL or the hash length is not one of the permitted values, the return value isNULL. Otherwise, the function result is a hash value containing the desired number of bits. See the notes at the beginning of this section about storing hash values efficiently.

  The return value is a string in the connection character set.

  mysql> SELECT SHA2('abc', 224);        -> '23097d223405d8228642a477bda255b32aadbce4bda0b3f7e36c9da7'

  This function works only if MySQL has been configured with SSL support. SeeSection 6.3, “Using Encrypted Connections”.

  SHA2() can be considered cryptographically more secure thanMD5() orSHA1().

• UNCOMPRESS(string_to_uncompress)

  Uncompresses a string compressed by theCOMPRESS() function. If the argument is not a compressed value, the result isNULL. This function requires MySQL to have been compiled with a compression library such aszlib. Otherwise, the return value is alwaysNULL.

  mysql> SELECT UNCOMPRESS(COMPRESS('any string'));        -> 'any string'mysql> SELECT UNCOMPRESS('any string');        -> NULL

• UNCOMPRESSED_LENGTH(compressed_string)

  Returns the length that the compressed string had before being compressed.

  mysql> SELECT UNCOMPRESSED_LENGTH(COMPRESS(REPEAT('a',30)));        -> 30

• VALIDATE_PASSWORD_STRENGTH(str)

  Given an argument representing a plaintext password, this function returns an integer to indicate how strong the password is. The return value ranges from 0 (weak) to 100 (strong).

  Password assessment byVALIDATE_PASSWORD_STRENGTH() is done by thevalidate_password plugin. If that plugin is not installed, the function always returns 0. For information about installingvalidate_password, seeSection 6.4.3, “The Password Validation Plugin”. To examine or configure the parameters that affect password testing, check or set the system variables implemented byvalidate_password. SeeSection 6.4.3.2, “Password Validation Plugin Options and Variables”.

  The password is subjected to increasingly strict tests and the return value reflects which tests were satisfied, as shown in the following table. In addition, if thevalidate_password_check_user_name system variable is enabled and the password matches the user name,VALIDATE_PASSWORD_STRENGTH() returns 0 regardless of how othervalidate_password system variables are set.

  Password Test	Return Value
  Length < 4	0
  Length ≥ 4 and <validate_password_length	25
  Satisfies policy 1 (LOW)	50
  Satisfies policy 2 (MEDIUM)	75
  Satisfies policy 3 (STRONG)	100