Package org.mariadb.jdbc.internal.util
Class Utils
java.lang.Object
org.mariadb.jdbc.internal.util.Utils
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final char[]
private static final Pattern
private static final Pattern
private static final Pattern
private static final SocketHandlerFunction
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic String
byteArrayToHexString
(byte[] bytes) static byte[]
copyRange
(byte[] orig, int from, int to) Copies from original byte array to a new byte array.static byte[]
copyWithLength
(byte[] orig, int length) Copies the original byte array content to a new byte array.static Socket
createSocket
(Options options, String host) Create socket accordingly to options.static byte[]
encryptPassword
(String password, byte[] seed, String passwordCharacterEncoding) Encrypts a password.static String
escapeString
(String value, boolean noBackslashEscapes) Escape String.private static String
getHex
(byte[] raw) private static Protocol
getProxyLoggingIfNeeded
(UrlParser urlParser, Protocol protocol) static TimeZone
getTimeZone
(String id) Get timezone from Id.static String
hexdump
(byte[]... bytes) Hexdump.static String
hexdump
(int maxQuerySizeToLog, int offset, int length, byte[]... byteArr) Hexdump.static boolean
static boolean
static String
Escape sql String.static String
parseSessionVariables
(String sessionVariable) Parse the option "sessionVariable" to ensure having no injection.private static String
replaceFunctionParameter
(String functionString, Protocol protocol) Helper function to replace function parameters in escaped string.private static String
resolveEscapes
(String escaped, Protocol protocol) static Protocol
retrieveProxy
(UrlParser urlParser, GlobalStateInfo globalInfo) Retrieve protocol corresponding to the failover options.static Socket
standardSocket
(Options options, String host) Use standard socket implementation.static int
transactionFromString
(String txIsolation) Traduce a String value of transaction isolation to corresponding java value.static boolean
validateFileName
(String sql, ParameterHolder[] parameters, String fileName) Validate that file name correspond to send query.private static void
writeHex
(byte[] bytes, int offset, int dataLength, StringBuilder outputBuilder) Write bytes/hexadecimal value of a byte array to a StringBuilder.
-
Field Details
-
hexArray
private static final char[] hexArray -
IP_V4
-
IP_V6
-
IP_V6_COMPRESSED
-
socketHandler
-
-
Constructor Details
-
Utils
public Utils()
-
-
Method Details
-
standardSocket
Use standard socket implementation.- Parameters:
options
- url optionshost
- host to connect- Returns:
- socket
- Throws:
IOException
- in case of error establishing socket.
-
escapeString
Escape String.- Parameters:
value
- value to escapenoBackslashEscapes
- must backslash be escaped- Returns:
- escaped string.
-
encryptPassword
public static byte[] encryptPassword(String password, byte[] seed, String passwordCharacterEncoding) throws NoSuchAlgorithmException, UnsupportedEncodingException Encrypts a password.protocol for authentication is like this: 1. Server sends a random array of bytes (the seed) 2. client makes a sha1 digest of the password 3. client hashes the output of 2 4. client digests the seed 5. client updates the digest with the output from 3 6. an xor of the output of 5 and 2 is sent to server 7. server does the same thing and verifies that the scrambled passwords match
- Parameters:
password
- the password to encryptseed
- the seed to usepasswordCharacterEncoding
- password character encoding- Returns:
- a scrambled password
- Throws:
NoSuchAlgorithmException
- if SHA1 is not available on the platform we are usingUnsupportedEncodingException
- if passwordCharacterEncoding is not a valid charset name
-
copyWithLength
public static byte[] copyWithLength(byte[] orig, int length) Copies the original byte array content to a new byte array. The resulting byte array is always "length" size. If length is smaller than the original byte array, the resulting byte array is truncated. If length is bigger than the original byte array, the resulting byte array is filled with zero bytes.- Parameters:
orig
- the original byte arraylength
- how big the resulting byte array will be- Returns:
- the copied byte array
-
copyRange
public static byte[] copyRange(byte[] orig, int from, int to) Copies from original byte array to a new byte array. The resulting byte array is always "to-from" size.- Parameters:
orig
- the original byte arrayfrom
- index of first byte in original byte array which will be copiedto
- index of last byte in original byte array which will be copied. This can be outside of the original byte array- Returns:
- resulting array
-
replaceFunctionParameter
Helper function to replace function parameters in escaped string. 3 functions are handles :- CONVERT(value, type): replacing SQL_XXX types to convertible type, i.e SQL_BIGINT to INTEGER
- TIMESTAMPDIFF(type, ...): replacing type SQL_TSI_XXX in type with XXX, i.e SQL_TSI_HOUR with HOUR
- TIMESTAMPADD(type, ...): replacing type SQL_TSI_XXX in type with XXX, i.e SQL_TSI_HOUR with HOUR
caution: this use MariaDB server conversion: 'SELECT CONVERT('2147483648', INTEGER)' will return a BIGINT. MySQL will throw a syntax error.
- Parameters:
functionString
- input stringprotocol
- protocol- Returns:
- unescaped string
-
resolveEscapes
- Throws:
SQLException
-
nativeSql
Escape sql String.- Parameters:
sql
- initial sqlprotocol
- protocol- Returns:
- escaped sql string
- Throws:
SQLException
- if escape sequence is incorrect.
-
retrieveProxy
public static Protocol retrieveProxy(UrlParser urlParser, GlobalStateInfo globalInfo) throws SQLException Retrieve protocol corresponding to the failover options. if no failover option, protocol will not be proxied. if a failover option is precised, protocol will be proxied so that any connection error will be handle directly.- Parameters:
urlParser
- urlParser corresponding to connection url string.globalInfo
- global variable information- Returns:
- protocol
- Throws:
SQLException
- if any error occur during connection
-
getProxyLoggingIfNeeded
-
getTimeZone
Get timezone from Id. This differ from java implementation : by default, if timezone Id is unknown, java return GMT timezone. GMT will be return only if explicitly asked.- Parameters:
id
- timezone id- Returns:
- timezone.
- Throws:
SQLException
- if no timezone is found for this Id
-
createSocket
Create socket accordingly to options.- Parameters:
options
- Url optionshost
- hostName ( mandatory only for named pipe)- Returns:
- a nex socket
- Throws:
IOException
- if connection error occur
-
hexdump
Hexdump.- Parameters:
bytes
- byte arrays- Returns:
- String
-
hexdump
Hexdump. Multiple byte arrays will be combinedString output example :
+--------------------------------------------------+ | 0 1 2 3 4 5 6 7 8 9 a b c d e f | +--------------------------------------------------+------------------+ | 11 00 00 02 00 00 00 02 40 00 00 00 08 01 06 05 | ........@....... | | 74 65 73 74 6A | testj | +--------------------------------------------------+------------------+
- Parameters:
maxQuerySizeToLog
- max log sizeoffset
- offset of last byte arraylength
- length of last byte arraybyteArr
- byte arrays. if many, only the last may have offset and size limitation others will be displayed completely.- Returns:
- String
-
writeHex
Write bytes/hexadecimal value of a byte array to a StringBuilder.String output example :
+--------------------------------------------------+ | 0 1 2 3 4 5 6 7 8 9 a b c d e f | +--------------------------------------------------+------------------+ | 5F 00 00 00 03 73 65 74 20 61 75 74 6F 63 6F 6D | _....set autocom | | 6D 69 74 3D 31 2C 20 73 65 73 73 69 6F 6E 5F 74 | mit=1, session_t | | 72 61 63 6B 5F 73 63 68 65 6D 61 3D 31 2C 20 73 | rack_schema=1, s | | 71 6C 5F 6D 6F 64 65 20 3D 20 63 6F 6E 63 61 74 | ql_mode = concat | | 28 40 40 73 71 6C 5F 6D 6F 64 65 2C 27 2C 53 54 | (@@sql_mode,',ST | | 52 49 43 54 5F 54 52 41 4E 53 5F 54 41 42 4C 45 | RICT_TRANS_TABLE | | 53 27 29 | S') | +--------------------------------------------------+------------------+
- Parameters:
bytes
- byte arrayoffset
- offsetdataLength
- byte length to writeoutputBuilder
- string builder
-
getHex
-
byteArrayToHexString
-
parseSessionVariables
Parse the option "sessionVariable" to ensure having no injection. semi-column not in string will be replaced by comma.- Parameters:
sessionVariable
- option value- Returns:
- parsed String
-
isIPv4
-
isIPv6
-
transactionFromString
Traduce a String value of transaction isolation to corresponding java value.- Parameters:
txIsolation
- String value- Returns:
- java corresponding value (Connection.TRANSACTION_READ_UNCOMMITTED, Connection.TRANSACTION_READ_COMMITTED, Connection.TRANSACTION_REPEATABLE_READ or Connection.TRANSACTION_SERIALIZABLE)
- Throws:
SQLException
- if String value doesn't correspond to @@tx_isolation/@@transaction_isolation possible value
-
validateFileName
Validate that file name correspond to send query.- Parameters:
sql
- sql commandparameters
- sql parameterfileName
- server file name- Returns:
- true if correspond
-