mongo 1.12.5 → 2.0.0.beta

data/lib/mongo/auth/scram.rb

@@ -0,0 +1,53 @@
+# Copyright (C) 2014 MongoDB Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'mongo/auth/scram/conversation'
+
+module Mongo
+  module Auth
+
+    # Defines behaviour for SCRAM-SHA1 authentication.
+    #
+    # @since 2.0.0
+    class SCRAM
+      include Executable
+
+      # The authentication mechinism string.
+      #
+      # @since 2.0.0
+      MECHANISM = 'SCRAM-SHA-1'.freeze
+
+      # Log the user in on the given connection.
+      #
+      # @example Log the user in.
+      #   user.login(connection)
+      #
+      # @param [ Mongo::Connection ] connection The connection to log into.
+      #   on.
+      #
+      # @return [ Protocol::Reply ] The authentication response.
+      #
+      # @since 2.0.0
+      def login(connection)
+        conversation = Conversation.new(user)
+        reply = connection.dispatch([ conversation.start ])
+        reply = connection.dispatch([ conversation.continue(reply) ])
+        until reply.documents[0][Conversation::DONE]
+          reply = connection.dispatch([ conversation.finalize(reply) ])
+        end
+        reply
+      end
+    end
+  end
+end

data/lib/mongo/auth/scram/conversation.rb

@@ -0,0 +1,450 @@
+# Copyright (C) 2014 MongoDB Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'base64'
+
+module Mongo
+  module Auth
+    class SCRAM
+
+      # Defines behaviour around a single SCRAM-SHA-1 conversation between the
+      # client and server.
+      #
+      # @since 2.0.0
+      class Conversation
+
+        # The base client continue message.
+        #
+        # @since 2.0.0
+        CLIENT_CONTINUE_MESSAGE = { saslContinue: 1 }.freeze
+
+        # The base client first message.
+        #
+        # @since 2.0.0
+        CLIENT_FIRST_MESSAGE = { saslStart: 1, autoAuthorize: 1 }.freeze
+
+        # The client key string.
+        #
+        # @since 2.0.0
+        CLIENT_KEY = 'Client Key'.freeze
+
+        # The digest to use for encryption.
+        #
+        # @since 2.0.0
+        DIGEST = OpenSSL::Digest::SHA1.new.freeze
+
+        # The key for the done field in the responses.
+        #
+        # @since 2.0.0
+        DONE = 'done'.freeze
+
+        # The conversation id field.
+        #
+        # @since 2.0.0
+        ID = 'conversationId'.freeze
+
+        # The iterations key in the responses.
+        #
+        # @since 2.0.0
+        ITERATIONS = /i=(\d+)/.freeze
+
+        # The payload field.
+        #
+        # @since 2.0.0
+        PAYLOAD = 'payload'.freeze
+
+        # The rnonce key in the responses.
+        #
+        # @since 2.0.0
+        RNONCE = /r=([^,]*)/.freeze
+
+        # The salt key in the responses.
+        #
+        # @since 2.0.0
+        SALT = /s=([^,]*)/.freeze
+
+        # The server key string.
+        #
+        # @since 2.0.0
+        SERVER_KEY = 'Server Key'.freeze
+
+        # The server signature verifier in the response.
+        #
+        # @since 2.0.0
+        VERIFIER = /v=([^,]*)/.freeze
+
+        # @return [ String ] nonce The initial user nonce.
+        attr_reader :nonce
+
+        # @return [ Protocol::Reply ] reply The current reply in the
+        #   conversation.
+        attr_reader :reply
+
+        # @return [ User ] user The user for the conversation.
+        attr_reader :user
+
+        # Continue the SCRAM conversation. This sends the client final message
+        # to the server after setting the reply from the previous server
+        # communication.
+        #
+        # @example Continue the conversation.
+        #   conversation.continue(reply)
+        #
+        # @param [ Protocol::Reply ] reply The reply of the previous
+        #   message.
+        #
+        # @return [ Protocol::Query ] The next message to send.
+        #
+        # @since 2.0.0
+        def continue(reply)
+          validate_first_message!(reply)
+          Protocol::Query.new(
+            Database::ADMIN,
+            Database::COMMAND,
+            CLIENT_CONTINUE_MESSAGE.merge(payload: client_final_message, conversationId: id),
+            limit: -1
+          )
+        end
+
+        # Finalize the SCRAM conversation. This is meant to be iterated until
+        # the provided reply indicates the conversation is finished.
+        #
+        # @example Finalize the conversation.
+        #   conversation.finalize(reply)
+        #
+        # @param [ Protocol::Reply ] reply The reply of the previous
+        #   message.
+        #
+        # @return [ Protocol::Query ] The next message to send.
+        #
+        # @since 2.0.0
+        def finalize(reply)
+          validate_final_message!(reply)
+          Protocol::Query.new(
+            Database::ADMIN,
+            Database::COMMAND,
+            CLIENT_CONTINUE_MESSAGE.merge(payload: client_empty_message, conversationId: id),
+            limit: -1
+          )
+        end
+
+        # Start the SCRAM conversation. This returns the first message that
+        # needs to be send to the server.
+        #
+        # @example Start the conversation.
+        #   conversation.start
+        #
+        # @return [ Protocol::Query ] The first SCRAM conversation message.
+        #
+        # @since 2.0.0
+        def start
+          Protocol::Query.new(
+            Database::ADMIN,
+            Database::COMMAND,
+            CLIENT_FIRST_MESSAGE.merge(payload: client_first_message, mechanism: SCRAM::MECHANISM),
+            limit: -1
+          )
+        end
+
+        # Get the id of the conversation.
+        #
+        # @example Get the id of the conversation.
+        #   conversation.id
+        #
+        # @return [ Integer ] The conversation id.
+        #
+        # @since 2.0.0
+        def id
+          reply.documents[0][ID]
+        end
+
+        # Create the new conversation.
+        #
+        # @example Create the new coversation.
+        #   Conversation.new(user)
+        #
+        # @param [ Auth::User ] user The user to converse about.
+        #
+        # @since 2.0.0
+        def initialize(user)
+          @user = user
+          @nonce = SecureRandom.base64
+        end
+
+        private
+
+        # Auth message algorithm implementation.
+        #
+        # @api private
+        #
+        # @see http://tools.ietf.org/html/rfc5802#section-3
+        #
+        # @since 2.0.0
+        def auth_message
+          @auth_message ||= "#{first_bare},#{reply.documents[0][PAYLOAD].data},#{without_proof}"
+        end
+
+        # Get the empty client message.
+        #
+        # @api private
+        #
+        # @since 2.0.0
+        def client_empty_message
+          BSON::Binary.new('')
+        end
+
+        # Get the final client message.
+        #
+        # @api private
+        #
+        # @see http://tools.ietf.org/html/rfc5802#section-3
+        #
+        # @since 2.0.0
+        def client_final_message
+          BSON::Binary.new("#{without_proof},p=#{client_final}")
+        end
+
+        # Get the client first message
+        #
+        # @api private
+        #
+        # @see http://tools.ietf.org/html/rfc5802#section-3
+        #
+        # @since 2.0.0
+        def client_first_message
+          BSON::Binary.new("n,,#{first_bare}")
+        end
+
+        # Client final implementation.
+        #
+        # @api private
+        #
+        # @see http://tools.ietf.org/html/rfc5802#section-7
+        #
+        # @since 2.0.0
+        def client_final
+          @client_final ||= client_proof(client_key, client_signature(stored_key(client_key), auth_message))
+        end
+
+        # Client key algorithm implementation.
+        #
+        # @api private
+        #
+        # @see http://tools.ietf.org/html/rfc5802#section-3
+        #
+        # @since 2.0.0
+        def client_key
+          @client_key ||= hmac(salted_password, CLIENT_KEY)
+        end
+
+        # Client proof algorithm implementation.
+        #
+        # @api private
+        #
+        # @see http://tools.ietf.org/html/rfc5802#section-3
+        #
+        # @since 2.0.0
+        def client_proof(key, signature)
+          @client_proof ||= Base64.strict_encode64(xor(key, signature))
+        end
+
+        # Client signature algorithm implementation.
+        #
+        # @api private
+        #
+        # @see http://tools.ietf.org/html/rfc5802#section-3
+        #
+        # @since 2.0.0
+        def client_signature(key, message)
+          @client_signature ||= hmac(key, message)
+        end
+
+        # First bare implementation.
+        #
+        # @api private
+        #
+        # @see http://tools.ietf.org/html/rfc5802#section-7
+        #
+        # @since 2.0.0
+        def first_bare
+          @first_bare ||= "n=#{user.encoded_name},r=#{nonce}"
+        end
+
+        # H algorithm implementation.
+        #
+        # @api private
+        #
+        # @see http://tools.ietf.org/html/rfc5802#section-2.2
+        #
+        # @since 2.0.0
+        def h(string)
+          DIGEST.digest(string)
+        end
+
+        # HI algorithm implementation.
+        #
+        # @api private
+        #
+        # @see http://tools.ietf.org/html/rfc5802#section-2.2
+        #
+        # @since 2.0.0
+        def hi(data)
+          OpenSSL::PKCS5.pbkdf2_hmac_sha1(
+            data,
+            Base64.strict_decode64(salt),
+            iterations,
+            DIGEST.size
+          )
+        end
+
+        # HMAC algorithm implementation.
+        #
+        # @api private
+        #
+        # @see http://tools.ietf.org/html/rfc5802#section-2.2
+        #
+        # @since 2.0.0
+        def hmac(data, key)
+          OpenSSL::HMAC.digest(DIGEST, data, key)
+        end
+
+        # Get the iterations from the server response.
+        #
+        # @api private
+        #
+        # @since 2.0.0
+        def iterations
+          @iterations ||= payload_data.match(ITERATIONS)[1].to_i
+        end
+
+        # Get the data from the returned payload.
+        #
+        # @api private
+        #
+        # @since 2.0.0
+        def payload_data
+          reply.documents[0][PAYLOAD].data
+        end
+
+        # Get the server nonce from the payload.
+        #
+        # @api private
+        #
+        # @since 2.0.0
+        def rnonce
+          @rnonce ||= payload_data.match(RNONCE)[1]
+        end
+
+        # Gets the salt from the server response.
+        #
+        # @api private
+        #
+        # @since 2.0.0
+        def salt
+          @salt ||= payload_data.match(SALT)[1]
+        end
+
+        # Salted password algorithm implementation.
+        #
+        # @api private
+        #
+        # @see http://tools.ietf.org/html/rfc5802#section-3
+        #
+        # @since 2.0.0
+        def salted_password
+          @salted_password ||= hi(user.hashed_password)
+        end
+
+        # Server key algorithm implementation.
+        #
+        # @api private
+        #
+        # @see http://tools.ietf.org/html/rfc5802#section-3
+        #
+        # @since 2.0.0
+        def server_key
+          @server_key ||= hmac(salted_password, SERVER_KEY)
+        end
+
+        # Server signature algorithm implementation.
+        #
+        # @api private
+        #
+        # @see http://tools.ietf.org/html/rfc5802#section-3
+        #
+        # @since 2.0.0
+        def server_signature
+          @server_signature ||= Base64.strict_encode64(hmac(server_key, auth_message))
+        end
+
+        # Stored key algorithm implementation.
+        #
+        # @api private
+        #
+        # @see http://tools.ietf.org/html/rfc5802#section-3
+        #
+        # @since 2.0.0
+        def stored_key(key)
+          h(key)
+        end
+
+        # Get the verifier token from the server response.
+        #
+        # @api private
+        #
+        # @since 2.0.0
+        def verifier
+          @verifier ||= payload_data.match(VERIFIER)[1]
+        end
+
+        # Get the without proof message.
+        #
+        # @api private
+        #
+        # @see http://tools.ietf.org/html/rfc5802#section-7
+        #
+        # @since 2.0.0
+        def without_proof
+          @withoout_proof ||= "c=biws,r=#{rnonce}"
+        end
+
+        # XOR operation for two strings.
+        #
+        # @api private
+        #
+        # @since 2.0.0
+        def xor(first, second)
+          first.bytes.zip(second.bytes).map{ |(a,b)| (a ^ b).chr }.join('')
+        end
+
+        def validate_final_message!(reply)
+          validate!(reply)
+          unless verifier == server_signature
+            raise Error::InvalidSignature.new(verifier, server_signature)
+          end
+        end
+
+        def validate_first_message!(reply)
+          validate!(reply)
+          raise Error::InvalidNonce.new(nonce, rnonce) unless rnonce.start_with?(nonce)
+        end
+
+        def validate!(reply)
+          raise Unauthorized.new(user) unless reply.documents[0]['ok'] == 1
+          @reply = reply
+        end
+      end
+    end
+  end
+end