Merge pull request #576 from hurtonm/zmtp_curve

Implement ZMTP/3.0 CURVE handshake

CMakeLists.txt

@@ -291,6 +291,8 @@ set(cxx-sources
         address.cpp
         clock.cpp
         ctx.cpp
+        curve_client.cpp
+        curve_server.cpp
         dealer.cpp
         devpoll.cpp
         dist.cpp

src/Makefile.am

@@ -15,6 +15,8 @@ libzmq_la_SOURCES = \
     command.hpp \
     config.hpp \
     ctx.hpp \
+    curve_client.hpp \
+    curve_server.hpp \
     decoder.hpp \
     devpoll.hpp \
     dist.hpp \
@@ -89,6 +91,8 @@ libzmq_la_SOURCES = \
     address.cpp \
     clock.cpp \
     ctx.cpp \
+    curve_client.cpp \
+    curve_server.cpp \
     devpoll.cpp \
     dist.cpp \
     epoll.cpp \

src/curve_client.hpp

+/*
+    Copyright (c) 2007-2013 Contributors as noted in the AUTHORS file
+
+    This file is part of 0MQ.
+
+    0MQ is free software; you can redistribute it and/or modify it under
+    the terms of the GNU Lesser General Public License as published by
+    the Free Software Foundation; either version 3 of the License, or
+    (at your option) any later version.
+
+    0MQ is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+#ifndef __ZMQ_CURVE_CLIENT_HPP_INCLUDED__
+#define __ZMQ_CURVE_CLIENT_HPP_INCLUDED__
+
+#include "platform.hpp"
+
+#ifdef HAVE_LIBSODIUM
+#include <sodium.h>
+
+#if crypto_box_NONCEBYTES != 24 \
+||  crypto_box_PUBLICKEYBYTES != 32 \
+||  crypto_box_SECRETKEYBYTES != 32 \
+||  crypto_box_ZEROBYTES != 32 \
+||  crypto_box_BOXZEROBYTES != 16
+#error "libsodium not built properly"
+#endif
+
+#include "mechanism.hpp"
+#include "options.hpp"
+
+namespace zmq
+{
+
+    class msg_t;
+    class session_base_t;
+
+    class curve_client_t : public mechanism_t
+    {
+    public:
+
+        curve_client_t (const options_t &options_);
+        virtual ~curve_client_t ();
+
+        // mechanism implementation
+        virtual int next_handshake_message (msg_t *msg_);
+        virtual int process_handshake_message (msg_t *msg_);
+        virtual bool is_handshake_complete () const;
+
+    private:
+
+        enum state_t {
+            send_hello,
+            expect_welcome,
+            send_initiate,
+            expect_ready,
+            connected
+        };
+
+        //  Current FSM state
+        state_t state;
+
+        //  Our public key (C)
+        uint8_t public_key [crypto_box_PUBLICKEYBYTES];
+
+        //  Our secret key (c)
+        uint8_t secret_key [crypto_box_SECRETKEYBYTES];
+
+        //  Our short-term public key (C')
+        uint8_t cn_public [crypto_box_PUBLICKEYBYTES];
+
+        //  Our short-term secret key (c')
+        uint8_t cn_secret [crypto_box_SECRETKEYBYTES];
+
+        //  Server's public key (S)
+        uint8_t server_key [crypto_box_PUBLICKEYBYTES];
+
+        //  Server's short-term public key (S')
+        uint8_t cn_server [crypto_box_PUBLICKEYBYTES];
+
+        //  Cookie received from server
+        uint8_t cn_cookie [16 + 80];
+
+        //  Intermediary buffer used to seepd up boxing and unboxing.
+        uint8_t cn_precom [crypto_box_BEFORENMBYTES];
+
+        //  Nonce
+        uint64_t cn_nonce;
+
+        int hello_msg (msg_t *msg_);
+        int process_welcome (msg_t *msg_);
+        int initiate_msg (msg_t *msg_);
+        int process_ready (msg_t *msg_);
+
+        int parse_property_list (const uint8_t *ptr, size_t length);
+    };
+
+}
+
+#endif
+
+#endif

src/curve_server.hpp

+/*
+    Copyright (c) 2007-2013 Contributors as noted in the AUTHORS file
+
+    This file is part of 0MQ.
+
+    0MQ is free software; you can redistribute it and/or modify it under
+    the terms of the GNU Lesser General Public License as published by
+    the Free Software Foundation; either version 3 of the License, or
+    (at your option) any later version.
+
+    0MQ is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+#ifndef __ZMQ_CURVE_SERVER_HPP_INCLUDED__
+#define __ZMQ_CURVE_SERVER_HPP_INCLUDED__
+
+#include "platform.hpp"
+
+#ifdef HAVE_LIBSODIUM
+#include <sodium.h>
+
+#if crypto_box_NONCEBYTES != 24 \
+||  crypto_box_PUBLICKEYBYTES != 32 \
+||  crypto_box_SECRETKEYBYTES != 32 \
+||  crypto_box_ZEROBYTES != 32 \
+||  crypto_box_BOXZEROBYTES != 16 \
+||  crypto_secretbox_NONCEBYTES != 24 \
+||  crypto_secretbox_ZEROBYTES != 32 \
+||  crypto_secretbox_BOXZEROBYTES != 16
+#error "libsodium not built properly"
+#endif
+
+#include "mechanism.hpp"
+#include "options.hpp"
+
+namespace zmq
+{
+
+    class msg_t;
+    class session_base_t;
+
+    class curve_server_t : public mechanism_t
+    {
+    public:
+
+        curve_server_t (session_base_t *session_,
+                        const options_t &options_);
+        virtual ~curve_server_t ();
+
+        // mechanism implementation
+        virtual int next_handshake_message (msg_t *msg_);
+        virtual int process_handshake_message (msg_t *msg_);
+        virtual int zap_msg_available ();
+        virtual bool is_handshake_complete () const;
+
+    private:
+
+        enum state_t {
+            expect_hello,
+            send_welcome,
+            expect_initiate,
+            expect_zap_reply,
+            send_ready,
+            connected
+        };
+
+        session_base_t * const session;
+
+        //  Current FSM state
+        state_t state;
+
+        uint64_t cn_nonce;
+
+        //  Our secret key (s)
+        uint8_t secret_key [crypto_box_SECRETKEYBYTES];
+
+        //  Our short-term public key (S')
+        uint8_t cn_public [crypto_box_PUBLICKEYBYTES];
+
+        //  Our short-term secret key (s')
+        uint8_t cn_secret [crypto_box_SECRETKEYBYTES];
+
+        //  Client's short-term public key (C')
+        uint8_t cn_client [crypto_box_PUBLICKEYBYTES];
+
+        //  Key used to produce cookie
+        uint8_t cookie_key [crypto_secretbox_KEYBYTES];
+
+        //  Intermediary buffer used to speed up boxing and unboxing.
+        uint8_t cn_precom [crypto_box_BEFORENMBYTES];
+
+        int process_hello (msg_t *msg_);
+        int welcome_msg (msg_t *msg_);
+        int process_initiate (msg_t *msg_);
+        int ready_msg (msg_t *msg_);
+
+        int send_zap_request (const uint8_t *key);
+        int receive_and_process_zap_reply ();
+        int parse_property_list (const uint8_t *ptr, size_t length);
+    };
+
+}
+
+#endif
+
+#endif
+

src/options.hpp

@@ -132,6 +132,15 @@ namespace zmq
         std::string plain_username;
         std::string plain_password;
 
+        unsigned char public_key_size;
+        unsigned char public_key [32];
+
+        unsigned char secret_key_size;
+        unsigned char secret_key [32];
+
+        unsigned char server_key_size;
+        unsigned char server_key [32];
+
         //  ID of the socket.
         int socket_id;
     };