Merge pull request #2295 from stephenprocter/zhttp_client-authentication

Problem: zhttp_client does not support authentication

api/python_cffi.slurp

@@ -4539,6 +4539,14 @@ void
 void
     zhttp_request_reset_content (zhttp_request_t *self);
 
+// Set the request username
+void
+    zhttp_request_set_username (zhttp_request_t *self, const char *username);
+
+// Set the request password
+void
+    zhttp_request_set_password (zhttp_request_t *self, const char *password);
+
 // Match the path of the request.
 // Support wildcards with '%s' symbol inside the match string.
 // Matching wildcards until the next '/', '?' or '\0'.

api/zhttp_request.api

@@ -112,6 +112,16 @@
         Set the content to NULL
     </method>
 
+    <method name = "set username">
+        Set the request username
+        <argument name = "username" type = "string" />
+    </method>
+
+    <method name = "set password">
+        Set the request password
+        <argument name = "password" type = "string" />
+    </method>
+
     <method name = "match">
         Match the path of the request.
         Support wildcards with '%s' symbol inside the match string.

bindings/jni/czmq-jni/src/main/c/org_zeromq_czmq_ZhttpRequest.c

@@ -132,6 +132,22 @@ Java_org_zeromq_czmq_ZhttpRequest__1_1resetContent (JNIEnv *env, jclass c, jlong
     zhttp_request_reset_content ((zhttp_request_t *) (intptr_t) self);
 }
 
+JNIEXPORT void JNICALL
+Java_org_zeromq_czmq_ZhttpRequest__1_1setUsername (JNIEnv *env, jclass c, jlong self, jstring username)
+{
+    char *username_ = (char *) (*env)->GetStringUTFChars (env, username, NULL);
+    zhttp_request_set_username ((zhttp_request_t *) (intptr_t) self, username_);
+    (*env)->ReleaseStringUTFChars (env, username, username_);
+}
+
+JNIEXPORT void JNICALL
+Java_org_zeromq_czmq_ZhttpRequest__1_1setPassword (JNIEnv *env, jclass c, jlong self, jstring password)
+{
+    char *password_ = (char *) (*env)->GetStringUTFChars (env, password, NULL);
+    zhttp_request_set_password ((zhttp_request_t *) (intptr_t) self, password_);
+    (*env)->ReleaseStringUTFChars (env, password, password_);
+}
+
 JNIEXPORT jboolean JNICALL
 Java_org_zeromq_czmq_ZhttpRequest__1_1match (JNIEnv *env, jclass c, jlong self, jstring method, jstring path)
 {

bindings/jni/czmq-jni/src/main/java/org/zeromq/czmq/ZhttpRequest.java

@@ -154,6 +154,20 @@ public void resetContent () {
         __resetContent (self);
     }
     /*
+    Set the request username
+    */
+    native static void __setUsername (long self, String username);
+    public void setUsername (String username) {
+        __setUsername (self, username);
+    }
+    /*
+    Set the request password
+    */
+    native static void __setPassword (long self, String password);
+    public void setPassword (String password) {
+        __setPassword (self, password);
+    }
+    /*
     Match the path of the request.
     Support wildcards with '%s' symbol inside the match string.
     Matching wildcards until the next '/', '?' or '\0'.

bindings/lua_ffi/czmq_ffi.lua

@@ -4534,6 +4534,14 @@ void
 void
     zhttp_request_reset_content (zhttp_request_t *self);
 
+// Set the request username
+void
+    zhttp_request_set_username (zhttp_request_t *self, const char *username);
+
+// Set the request password
+void
+    zhttp_request_set_password (zhttp_request_t *self, const char *password);
+
 // Match the path of the request.
 // Support wildcards with '%s' symbol inside the match string.
 // Matching wildcards until the next '/', '?' or '\0'.

bindings/nodejs/README.md

@@ -4952,6 +4952,18 @@ nothing my_zhttp_request.resetContent ()
 
 Set the content to NULL
 
+```
+nothing my_zhttp_request.setUsername (String)
+```
+
+Set the request username
+
+```
+nothing my_zhttp_request.setPassword (String)
+```
+
+Set the request password
+
 ```
 boolean my_zhttp_request.match (String, String)
 ```

bindings/nodejs/binding.cc

@@ -9249,6 +9249,8 @@ NAN_MODULE_INIT (ZhttpRequest::Init) {
     Nan::SetPrototypeMethod (tpl, "setContent", _set_content);
     Nan::SetPrototypeMethod (tpl, "setContentConst", _set_content_const);
     Nan::SetPrototypeMethod (tpl, "resetContent", _reset_content);
+    Nan::SetPrototypeMethod (tpl, "setUsername", _set_username);
+    Nan::SetPrototypeMethod (tpl, "setPassword", _set_password);
     Nan::SetPrototypeMethod (tpl, "match", _match);
     Nan::SetPrototypeMethod (tpl, "test", _test);
 
@@ -9416,6 +9418,36 @@ NAN_METHOD (ZhttpRequest::_reset_content) {
     zhttp_request_reset_content (zhttp_request->self);
 }
 
+NAN_METHOD (ZhttpRequest::_set_username) {
+    ZhttpRequest *zhttp_request = Nan::ObjectWrap::Unwrap <ZhttpRequest> (info.Holder ());
+    char *username;
+    if (info [0]->IsUndefined ())
+        return Nan::ThrowTypeError ("method requires a `username`");
+    else
+    if (!info [0]->IsString ())
+        return Nan::ThrowTypeError ("`username` must be a string");
+    //else { // bjornw: remove brackets to keep scope
+    Nan::Utf8String username_utf8 (info [0].As<String>());
+    username = *username_utf8;
+         //} //bjornw end
+    zhttp_request_set_username (zhttp_request->self, (const char *)username);
+}
+
+NAN_METHOD (ZhttpRequest::_set_password) {
+    ZhttpRequest *zhttp_request = Nan::ObjectWrap::Unwrap <ZhttpRequest> (info.Holder ());
+    char *password;
+    if (info [0]->IsUndefined ())
+        return Nan::ThrowTypeError ("method requires a `password`");
+    else
+    if (!info [0]->IsString ())
+        return Nan::ThrowTypeError ("`password` must be a string");
+    //else { // bjornw: remove brackets to keep scope
+    Nan::Utf8String password_utf8 (info [0].As<String>());
+    password = *password_utf8;
+         //} //bjornw end
+    zhttp_request_set_password (zhttp_request->self, (const char *)password);
+}
+
 NAN_METHOD (ZhttpRequest::_match) {
     ZhttpRequest *zhttp_request = Nan::ObjectWrap::Unwrap <ZhttpRequest> (info.Holder ());
     char *method;

bindings/nodejs/binding.h

@@ -1076,6 +1076,8 @@ class ZhttpRequest: public Nan::ObjectWrap {
     static NAN_METHOD (_set_content);
     static NAN_METHOD (_set_content_const);
     static NAN_METHOD (_reset_content);
+    static NAN_METHOD (_set_username);
+    static NAN_METHOD (_set_password);
     static NAN_METHOD (_match);
     static NAN_METHOD (_test);
 };

bindings/python/czmq/_czmq_ctypes.py

@@ -9190,6 +9190,10 @@ def test(verbose):
 lib.zhttp_request_set_content_const.argtypes = [zhttp_request_p, c_char_p]
 lib.zhttp_request_reset_content.restype = None
 lib.zhttp_request_reset_content.argtypes = [zhttp_request_p]
+lib.zhttp_request_set_username.restype = None
+lib.zhttp_request_set_username.argtypes = [zhttp_request_p, c_char_p]
+lib.zhttp_request_set_password.restype = None
+lib.zhttp_request_set_password.argtypes = [zhttp_request_p, c_char_p]
 lib.zhttp_request_match.restype = c_bool
 lib.zhttp_request_match.argtypes = [zhttp_request_p, c_char_p, c_char_p]
 lib.zhttp_request_test.restype = None
@@ -9346,6 +9350,18 @@ def reset_content(self):
         """
         return lib.zhttp_request_reset_content(self._as_parameter_)
 
+    def set_username(self, username):
+        """
+        Set the request username
+        """
+        return lib.zhttp_request_set_username(self._as_parameter_, username)
+
+    def set_password(self, password):
+        """
+        Set the request password
+        """
+        return lib.zhttp_request_set_password(self._as_parameter_, password)
+
     def match(self, method, path, *args):
         """
         Match the path of the request.

bindings/python_cffi/czmq_cffi/ZhttpRequest.py

@@ -127,6 +127,18 @@ def reset_content(self):
         """
         utils.lib.zhttp_request_reset_content(self._p)
 
+    def set_username(self, username):
+        """
+        Set the request username
+        """
+        utils.lib.zhttp_request_set_username(self._p, utils.to_bytes(username))
+
+    def set_password(self, password):
+        """
+        Set the request password
+        """
+        utils.lib.zhttp_request_set_password(self._p, utils.to_bytes(password))
+
     def match(self, method, path, *path_args):
         """
         Match the path of the request.

bindings/python_cffi/czmq_cffi/cdefs.py

@@ -4541,6 +4541,14 @@
 void
     zhttp_request_reset_content (zhttp_request_t *self);
 
+// Set the request username
+void
+    zhttp_request_set_username (zhttp_request_t *self, const char *username);
+
+// Set the request password
+void
+    zhttp_request_set_password (zhttp_request_t *self, const char *password);
+
 // Match the path of the request.
 // Support wildcards with '%s' symbol inside the match string.
 // Matching wildcards until the next '/', '?' or '\0'.

bindings/qml/src/QmlZhttpRequest.cpp

@@ -114,6 +114,18 @@ void QmlZhttpRequest::resetContent () {
     zhttp_request_reset_content (self);
 };
 
+///
+//  Set the request username
+void QmlZhttpRequest::setUsername (const QString &username) {
+    zhttp_request_set_username (self, username.toUtf8().data());
+};
+
+///
+//  Set the request password
+void QmlZhttpRequest::setPassword (const QString &password) {
+    zhttp_request_set_password (self, password.toUtf8().data());
+};
+
 ///
 //  Match the path of the request.
 //  Support wildcards with '%s' symbol inside the match string.

bindings/qml/src/QmlZhttpRequest.h

@@ -84,6 +84,12 @@ public slots:
     //  Set the content to NULL
     void resetContent ();
 
+    //  Set the request username
+    void setUsername (const QString &username);
+
+    //  Set the request password
+    void setPassword (const QString &password);
+
     //  Match the path of the request.
     //  Support wildcards with '%s' symbol inside the match string.
     //  Matching wildcards until the next '/', '?' or '\0'.

bindings/qt/src/qzhttprequest.cpp

@@ -152,6 +152,22 @@ void QZhttpRequest::resetContent ()
 
 }
 
+///
+//  Set the request username
+void QZhttpRequest::setUsername (const QString &username)
+{
+    zhttp_request_set_username (self, username.toUtf8().data());
+
+}
+
+///
+//  Set the request password
+void QZhttpRequest::setPassword (const QString &password)
+{
+    zhttp_request_set_password (self, password.toUtf8().data());
+
+}
+
 ///
 //  Self test of this class.
 void QZhttpRequest::test (bool verbose)

bindings/qt/src/qzhttprequest.h

@@ -74,6 +74,12 @@ class QT_CZMQ_EXPORT QZhttpRequest : public QObject
     //  Set the content to NULL
     void resetContent ();
 
+    //  Set the request username
+    void setUsername (const QString &username);
+
+    //  Set the request password
+    void setPassword (const QString &password);
+
     //  Self test of this class.
     static void test (bool verbose);
 

bindings/ruby/lib/czmq/ffi.rb

@@ -962,6 +962,8 @@ def self.attach_function(name, *rest)
       attach_function :zhttp_request_set_content, [:pointer, :pointer], :void, **opts
       attach_function :zhttp_request_set_content_const, [:pointer, :string], :void, **opts
       attach_function :zhttp_request_reset_content, [:pointer], :void, **opts
+      attach_function :zhttp_request_set_username, [:pointer, :string], :void, **opts
+      attach_function :zhttp_request_set_password, [:pointer, :string], :void, **opts
       attach_function :zhttp_request_match, [:pointer, :string, :string, :varargs], :bool, **opts
       attach_function :zhttp_request_test, [:bool], :void, **opts
 

bindings/ruby/lib/czmq/ffi/zhttp_request.rb

@@ -269,6 +269,28 @@ def reset_content()
         result
       end
 
+      # Set the request username
+      #
+      # @param username [String, #to_s, nil]
+      # @return [void]
+      def set_username(username)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zhttp_request_set_username(self_p, username)
+        result
+      end
+
+      # Set the request password
+      #
+      # @param password [String, #to_s, nil]
+      # @return [void]
+      def set_password(password)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zhttp_request_set_password(self_p, password)
+        result
+      end
+
       # Match the path of the request.
       # Support wildcards with '%s' symbol inside the match string.
       # Matching wildcards until the next '/', '?' or '\0'.

include/zhttp_request.h

@@ -124,6 +124,16 @@ CZMQ_EXPORT void
 CZMQ_EXPORT void
     zhttp_request_reset_content (zhttp_request_t *self);
 
+//  *** Draft method, for development use, may change without warning ***
+//  Set the request username
+CZMQ_EXPORT void
+    zhttp_request_set_username (zhttp_request_t *self, const char *username);
+
+//  *** Draft method, for development use, may change without warning ***
+//  Set the request password
+CZMQ_EXPORT void
+    zhttp_request_set_password (zhttp_request_t *self, const char *password);
+
 //  *** Draft method, for development use, may change without warning ***
 //  Match the path of the request.
 //  Support wildcards with '%s' symbol inside the match string.

src/zhttp_client.c

@@ -183,10 +183,12 @@ static void zhttp_client_actor (zsock_t *pipe, void *args) {
                 char *url;
                 zhash_t *headers;
                 byte free_content;
-                char* content;
+                char *content;
+                char *username;
+                char *password;
 
-                int rc = zsock_brecv (pipe, "4ppSp1p", &timeout, &arg, &arg2,
-                        &url, &headers, &free_content, &content);
+                int rc = zsock_brecv (pipe, "4ppSp1pss", &timeout, &arg, &arg2,
+                        &url, &headers, &free_content, &content, &username, &password);
                 assert (rc == 0);
 
                 struct curl_slist *curl_headers = zhash_to_slist (headers);
@@ -216,6 +218,12 @@ static void zhttp_client_actor (zsock_t *pipe, void *args) {
                 curl_easy_setopt (curl, CURLOPT_HEADERDATA, request);
                 curl_easy_setopt (curl, CURLOPT_PRIVATE, request);
 
+                if (*username)
+                    curl_easy_setopt (curl, CURLOPT_USERNAME, username);
+
+                if (*password)
+                    curl_easy_setopt (curl, CURLOPT_PASSWORD, password);
+
                 if (streq (command, "POST") || streq (command, "PUT") ||
                       streq (command, "PATCH")) {
                     curl_easy_setopt (curl, CURLOPT_POSTFIELDS, content);