Merge pull request #109 from yossigo/acl-auth-support

Add support for Redis 6.x ACL AUTH.

Author: yossigo

memtier_benchmark.1

@@ -1,5 +1,5 @@
-.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.3.
-.TH MEMTIER_BENCHMARK "1" "December 2016" "memtier_benchmark 1.2.7" "User Commands"
+.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.11.
+.TH MEMTIER_BENCHMARK "1" "January 2020" "memtier_benchmark 1.2.17" "User Commands"
 .SH NAME
 memtier_benchmark \- NoSQL benchmark tool
 .SH SYNOPSIS
@@ -23,6 +23,27 @@ Protocol to use (default: redis).  Other
 supported protocols are memcache_text,
 memcache_binary.
 .TP
+\fB\-a\fR, \fB\-\-authenticate\fR=\fI\,CREDENTIALS\/\fR Authenticate using specified credentials.
+A simple password is used for memcache_text
+and Redis <= 5.x. <USER>:<PASSWORD> can be
+specified for memcache_binary or Redis 6.x
+or newer with ACL user support.
+.TP
+\fB\-\-tls\fR
+Enable SSL/TLS transport security
+.TP
+\fB\-\-cert\fR=\fI\,FILE\/\fR
+Use specified client certificate for TLS
+.TP
+\fB\-\-key\fR=\fI\,FILE\/\fR
+Use specified private key for TLS
+.TP
+\fB\-\-cacert\fR=\fI\,FILE\/\fR
+Use specified CA certs bundle for TLS
+.TP
+\fB\-\-tls\-skip\-verify\fR
+Skip verification of server certificate
+.TP
 \fB\-x\fR, \fB\-\-run\-count\fR=\fI\,NUMBER\/\fR
 Number of full\-test iterations to perform
 .TP
@@ -35,12 +56,18 @@ Produce per\-client stats file
 \fB\-\-out\-file\fR=\fI\,FILE\/\fR
 Name of output file (default: stdout)
 .TP
+\fB\-\-json\-out\-file\fR=\fI\,FILE\/\fR
+Name of JSON output file, if not set, will not print to json
+.TP
 \fB\-\-show\-config\fR
 Print detailed configuration before running
 .TP
 \fB\-\-hide\-histogram\fR
 Don't print detailed latency histogram
 .TP
+\fB\-\-cluster\-mode\fR
+Run client in cluster mode
+.TP
 \fB\-\-help\fR
 Display this help
 .TP
@@ -73,9 +100,6 @@ Number of requests after which re\-connection is performed
 \fB\-\-multi\-key\-get\fR=\fI\,NUM\/\fR
 Enable multi\-key get commands, up to NUM keys (default: 0)
 .TP
-\fB\-a\fR, \fB\-\-authenticate\fR=\fI\,CREDENTIALS\/\fR Authenticate to redis using CREDENTIALS, which depending
-on the protocol can be PASSWORD or USER:PASSWORD.
-.TP
 \fB\-\-select\-db\fR=\fI\,DB\/\fR
 DB number to select, when testing a redis server
 .TP
@@ -84,6 +108,26 @@ Use a different random seed for each client
 .TP
 \fB\-\-randomize\fR
 random seed based on timestamp (default is constant value)
+.SS "Arbitrary command:"
+.TP
+\fB\-\-command\fR=\fI\,COMMAND\/\fR
+Specify a command to send in quotes.
+Each command that you specify is run with its ratio and key\-pattern options.
+For example: \fB\-\-command=\fR"set __key__ 5" \fB\-\-command\-ratio\fR=\fI\,2\/\fR \fB\-\-command\-key\-pattern\fR=\fI\,G\/\fR
+To use a generated key or object, enter:
+.TP
+__key__: Use key generated from Key Options.
+__data__: Use data generated from Object Options.
+.TP
+\fB\-\-command\-ratio\fR
+The number of times the command is sent in sequence.(default: 1)
+.TP
+\fB\-\-command\-key\-pattern\fR
+Key pattern for the command (default: R):
+G for Gaussian distribution.
+R for uniform Random.
+S for Sequential.
+P for Parallel (Sequential were each client has a subset of the key\-range).
 .SS "Object Options:"
 .TP
 \fB\-d\fR  \fB\-\-data\-size\fR=\fI\,SIZE\/\fR
@@ -163,7 +207,7 @@ WAIT for a random number of slaves in the specified range
 WAIT for a random number of milliseconds in the specified range (normal
 distribution with the center in the middle of the range)
 .SH COPYRIGHT
-Copyright \(co 2011\-2016 Redis Labs Ltd.
+Copyright \(co 2011\-2017 Redis Labs Ltd.
 .br
 This is free software.  You may redistribute copies of it under the terms of
 the GNU General Public License <http://www.gnu.org/licenses/gpl.html>.

memtier_benchmark.cpp

@@ -462,7 +462,7 @@ static int config_parse_args(int argc, char *argv[], struct benchmark_config *cf
                 case 'v':
                     puts(PACKAGE_STRING);
                 // FIXME!!
-                    puts("Copyright (C) 2011-2017 Redis Labs Ltd.");
+                    puts("Copyright (C) 2011-2020 Redis Labs Ltd.");
                     puts("This is free software.  You may redistribute copies of it under the terms of");
                     puts("the GNU General Public License <http://www.gnu.org/licenses/gpl.html>.");
                     puts("There is NO WARRANTY, to the extent permitted by law.");
@@ -840,7 +840,11 @@ void usage() {
             "  -P, --protocol=PROTOCOL        Protocol to use (default: redis).  Other\n"
             "                                 supported protocols are memcache_text,\n"
             "                                 memcache_binary.\n"
-            "  -a, --authenticate=CREDENTIALS Authenticate to redis using CREDENTIALS, which depending\n"
+            "  -a, --authenticate=CREDENTIALS Authenticate using specified credentials.\n"
+            "                                 A simple password is used for memcache_text\n"
+            "                                 and Redis <= 5.x. <USER>:<PASSWORD> can be\n"
+            "                                 specified for memcache_binary or Redis 6.x\n"
+            "                                 or newer with ACL user support.\n"
 #ifdef USE_TLS
             "      --tls                      Enable SSL/TLS transport security\n"
             "      --cert=FILE                Use specified client certificate for TLS\n"
@@ -849,7 +853,6 @@ void usage() {
             "      --tls-skip-verify          Skip verification of server certificate\n"
             "      --sni=STRING               Add an SNI header\n"
 #endif
-            "                                 on the protocol can be PASSWORD or USER:PASSWORD.\n"
             "  -x, --run-count=NUMBER         Number of full-test iterations to perform\n"
             "  -D, --debug                    Print debug output\n"
             "      --client-stats=FILE        Produce per-client stats file\n"

protocol.cpp

@@ -203,13 +203,53 @@ int redis_protocol::authenticate(const char *credentials)
     int size = 0;
     assert(credentials != NULL);
 
-    size = evbuffer_add_printf(m_write_buf,
-        "*2\r\n"
-        "$4\r\n"
-        "AUTH\r\n"
-        "$%u\r\n"
-        "%s\r\n",
-        (unsigned int)strlen(credentials), credentials);
+    /* Credentials may be one of:
+     * <PASSWORD>           For Redis <6.0 simple AUTH commands.
+     * <USER>:<PASSWORD>    For Redis 6.0+ AUTH with both username and password.
+     *
+     * A :<PASSWORD> will be handled as a special case of quoting a password that
+     * contains a colon.
+     */
+
+    const char *user = NULL;
+    const char *password;
+
+    if (credentials[0] == ':') {
+        password = credentials + 1;
+    } else {
+        password = strchr(credentials, ':');
+        if (!password) {
+            password = credentials;
+        } else {
+            user = credentials;
+            password++;
+        }
+    }
+
+    if (!user) {
+        size = evbuffer_add_printf(m_write_buf,
+            "*2\r\n"
+            "$4\r\n"
+            "AUTH\r\n"
+            "$%zu\r\n"
+            "%s\r\n",
+            strlen(password), password);
+    } else {
+        size_t user_len = password - user - 1;
+        size = evbuffer_add_printf(m_write_buf,
+            "*3\r\n"
+            "$4\r\n"
+            "AUTH\r\n"
+            "$%zu\r\n"
+            "%.*s\r\n"
+            "$%zu\r\n"
+            "%s\r\n",
+            user_len,
+            (int) user_len,
+            user,
+            strlen(password),
+            password);
+    }
     return size;
 }