Sha256: 49318ff6f9bdda0099cdb924e344382b278c29a5fab364f3eba7dec2f19e3e0c

Contents?: true

Size: 1.9 KB

Versions: 33

Compression:

Stored size: 1.9 KB

Contents

# 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

      # The authentication mechinism string.
      #
      # @since 2.0.0
      MECHANISM = 'SCRAM-SHA-1'.freeze

      # @return [ Mongo::Auth::User ] The user to authenticate.
      attr_reader :user

      # Instantiate a new authenticator.
      #
      # @example Create the authenticator.
      #   Mongo::Auth::SCRAM.new(user)
      #
      # @param [ Mongo::Auth::User ] user The user to authenticate.
      #
      # @since 2.0.0
      def initialize(user)
        @user = user
      end

      # 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

Version data entries

33 entries across 30 versions & 3 rubygems

Version Path
mongo-2.4.3 lib/mongo/auth/scram.rb
tdiary-5.0.5 vendor/bundle/gems/mongo-2.4.2/lib/mongo/auth/scram.rb
tdiary-5.0.5 vendor/bundle/gems/tdiary-5.0.4/vendor/bundle/gems/mongo-2.4.1/lib/mongo/auth/scram.rb
tdiary-5.0.5 vendor/bundle/gems/mongo-2.4.1/lib/mongo/auth/scram.rb
mongo-2.4.2 lib/mongo/auth/scram.rb
tdiary-5.0.4 vendor/bundle/gems/mongo-2.4.1/lib/mongo/auth/scram.rb
mongo-2.4.1 lib/mongo/auth/scram.rb
mongo-2.4.0 lib/mongo/auth/scram.rb
mongo-2.3.1 lib/mongo/auth/scram.rb
mongo-2.4.0.rc1 lib/mongo/auth/scram.rb
mongo-2.4.0.rc0 lib/mongo/auth/scram.rb
mongo-2.3.0 lib/mongo/auth/scram.rb
mongo-2.2.7 lib/mongo/auth/scram.rb
mongo-2.2.6 lib/mongo/auth/scram.rb
ish_lib_manager-0.0.1 test/dummy/vendor/bundle/ruby/2.3.0/gems/mongo-2.2.5/lib/mongo/auth/scram.rb
mongo-2.2.5 lib/mongo/auth/scram.rb
mongo-2.2.4 lib/mongo/auth/scram.rb
mongo-2.2.3 lib/mongo/auth/scram.rb
mongo-2.2.2 lib/mongo/auth/scram.rb
tdiary-4.2.1 vendor/bundle/ruby/2.3.0/gems/mongo-2.2.1/lib/mongo/auth/scram.rb