aws-sdk-v1 1.52.0

data/lib/aws/iam/user_collection.rb

@@ -0,0 +1,133 @@
+# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file 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.
+
+module AWS
+  class IAM
+
+    # A collection that provides access to IAM users belonging to this
+    # account.
+    #
+    #     iam = AWS::IAM.new
+    #     users = iam.users
+    #
+    # ## Creating A User
+    #
+    # To create an IAM user you need only provide a user name.
+    #
+    #     user = users.create('username')
+    #
+    # You can also provide an optional `:path` that can be used to organize
+    # users.
+    #
+    #     user = users.create('johndoe', :path => '/staff/customer_support/')
+    #
+    # ## Getting a User by Name
+    #
+    # You can get a referene to a user by using array notation:
+    #
+    #     user = users['username']
+    #
+    # ## Enumerating Users
+    #
+    # A user collection can also be used to enumerate users:
+    #
+    #     users.each do |user|
+    #       puts user.name
+    #     end
+    #
+    # ## Path Prefixes
+    #
+    # You can also find/enumerate users who's path begins with a given prefix:
+    #
+    #     users.each(:path_prefix => '/staff/developers/ruby').each do |ruby_dev|
+    #       puts "#{ruby_dev.name} is awesome!"
+    #     end
+    #
+    class UserCollection
+
+      include Collection::WithPrefix
+
+      # @param [String] name Name of the user to create.
+      # @option options [String] :path ('/') The path for the user name.
+      #   For more information about paths, see
+      #   [Identifiers for IAM Entities](http://docs.amazonwebservices.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html)
+      # @return [User] Returns the newly created user.
+      def create name, options = {}
+        create_opts = {}
+        create_opts[:user_name] = name
+        create_opts[:path] = options[:path] if options[:path]
+        resp = client.create_user(create_opts)
+        User.new_from(:create_user, resp.user,
+          resp.user.user_name, :config => config)
+      end
+
+      # Returns a reference to the user with the given name:
+      #
+      #     user = iam.users['username']
+      #
+      # @param [String] name Name of the user to return a reference for.
+      # @return [User] Returns a reference to the named user.
+      def [] name
+        User.new(name.to_s, :config => config)
+      end
+
+      # Yields once for each user.
+      #
+      # You can limit the number of users yielded using `:limit` and
+      # `:path_prefix`.
+      #
+      # @param [Hash] options
+      #
+      # @option options [String] :path_prefix ('/') A path prefix that
+      #   filters according to the path of the user.
+      #
+      # @option options [Integer] :limit The maximum number of users to yield.
+      #
+      # @option options [Integer] :batch_size The maximum number of users
+      #   to retrieve with each service request.
+      #
+      # @yieldparam [User] user
+      # @return [nil]
+      def each options = {}, &block
+        super(options, &block)
+      end
+
+      # Returns an enumerable object for this collection.  This can be
+      # useful if you want to call an enumerable method that does
+      # not accept options (e.g. `collect`, `first`, etc).
+      #
+      #     users.enumerator(:path_prefix => '/admin').collect(&:name)
+      #
+      # @param (see #each)
+      # @option (see #each)
+      # @return [Enumerator]
+      def enumerator options = {}
+        super(options)
+      end
+
+      # @api private
+      protected
+      def each_item response, &block
+        response.users.each do |item|
+
+          user = User.new_from(:list_users, item,
+            item.user_name, :config => config)
+
+          yield(user)
+
+        end
+      end
+
+    end
+  end
+end

data/lib/aws/iam/user_group_collection.rb

@@ -0,0 +1,98 @@
+# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file 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.
+
+module AWS
+  class IAM
+
+    # A collection that provides access to IAM groups to which a
+    # particular user belongs.
+    #
+    #     user = AWS::IAM.new.users.first
+    #     groups = user.groups
+    #     groups.each { |g| puts g.name }
+    #
+    class UserGroupCollection
+
+      include Collection
+
+      # @attr_reader [User] The user.
+      attr_reader :user
+
+      # @api private
+      def initialize(user, opts = {})
+        @user = user
+        super
+      end
+
+      # Adds the user to a group.
+      #
+      # @param [Group] group The group to which the user should be added.
+      def add(group)
+        client.add_user_to_group(:group_name => group.name,
+                                 :user_name => user.name)
+        nil
+      end
+
+      # Removes the user from a group.
+      #
+      # @param [Group] group The group from which the user should be removed
+      def remove(group)
+        client.remove_user_from_group(:group_name => group.name,
+                                      :user_name => user.name)
+        nil
+      end
+
+      # Removes this user from all groups.
+      # @return [nil]
+      def clear
+        each do |group|
+          remove(group)
+        end
+      end
+
+      # Yields once for each group that the user is in.
+      #
+      # @param [Hash] options
+      #
+      # @option options [Integer] :limit Limits the number of groups
+      #   that are returned.
+      #
+      # @option options [Integer] :batch_size Controls how many groups
+      #   are requested from the service at once.
+      #
+      # @yieldparam [Group] group
+      #
+      # @return [nil]
+      def each(options = {}, &block)
+        super(options.merge(:user_name => user.name), &block)
+      end
+
+      # @api private
+      protected
+      def request_method
+        :list_groups_for_user
+      end
+
+      # @api private
+      protected
+      def each_item response
+        response.groups.each do |g|
+          group = Group.new_from(:list_groups_for_user, g, g.group_name, :config => config)
+          yield(group)
+        end
+      end
+
+    end
+
+  end
+end

data/lib/aws/iam/user_policy.rb

@@ -0,0 +1,90 @@
+# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file 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 'uri'
+require 'json'
+
+module AWS
+  class IAM
+
+    class UserPolicy < Resource
+
+      # @param [User] user The user this user policy belongs to.
+      # @param [String] name The name of this user policy.
+      # @param [Hash] options
+      def initialize user, name, options = {}
+        @user = user
+        @name = name
+        super
+      end
+
+      # @return [User] Returns the user this user policy belongs to.
+      attr_reader :user
+
+      # @return [String] Returns the name of this user policy.
+      attr_reader :name
+
+      # @api private
+      module PolicyProxy
+
+        attr_accessor :user_policy
+
+        def change
+          yield(self)
+          user_policy.policy = self
+        end
+
+      end
+
+      # @return [Policy] Returns the actual policy document for this
+      #   user policy.
+      def policy
+
+        response = client.get_user_policy(
+          :user_name => user.name,
+          :policy_name => name)
+
+        policy = Policy.from_json(URI.decode(response.policy_document))
+        policy.extend(PolicyProxy)
+        policy.user_policy = self
+        policy
+
+      end
+
+      # Replaces or updates the user policy with the given policy document.
+      # @param [Policy] policy
+      # @return [nil]
+      def policy= policy
+
+        policy_document = policy.is_a?(String) ? policy : policy.to_json
+
+        options = {}
+        options[:user_name] = user.name
+        options[:policy_name] = name
+        options[:policy_document] = policy_document
+
+        client.put_user_policy(options)
+
+        nil
+      end
+
+      # Deletes this user policy.
+      # @return [nil]
+      def delete
+        client.delete_user_policy(:user_name => user.name, :policy_name => name)
+        nil
+      end
+
+    end
+
+  end
+end

data/lib/aws/iam/user_policy_collection.rb

@@ -0,0 +1,45 @@
+# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file 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.
+
+module AWS
+  class IAM
+
+    # A collection that provides access to the policies associated
+    # with an IAM user.  The interface mimics a hash containing
+    # string keys and values that are instances of {Policy}.  For
+    # example:
+    #
+    #     # add or replace a policy named "ReadOnly"
+    #     policy = AWS::IAM::Policy.new do |p|
+    #       # ...
+    #     end
+    #     user.policies["ReadOnly"] = policy
+    #     user.policies.has_key?("ReadOnly")  # => true
+    #
+    # All of the methods for this class are defined in the
+    # {PolicyCollection} module.
+    class UserPolicyCollection
+
+      include PolicyCollection
+
+      # @param [User] user The user that owns this collection.
+      def initialize user, options = {}
+        @user = user
+        super
+      end
+
+      # @return [User] Returns the user that this collection belongs to.
+      attr_reader :user
+
+    end
+  end
+end

data/lib/aws/iam/virtual_mfa_device.rb

@@ -0,0 +1,139 @@
+# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file 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 AWS
+  class IAM
+
+    # @attr_reader [String] base_32_string_seed The Base32 seed defined as
+    #   specified in RFC3548.  Only accessible on newly created
+    #   devices. This value is Base64-encoded.
+    #
+    # @attr_reader [Blob] qr_code_png A QR code PNG image that encodes
+    #   otpauth://totp/$virtualMFADeviceName@$AccountName? secret=$Base32String
+    #   where $virtualMFADeviceName is one of the create call arguments,
+    #   AccountName is the user name if set (accountId otherwise), and
+    #   Base32String is the seed in Base32 format.  Only accessible on newly
+    #   created devices. This value is Base64-encoded.
+    #
+    # @attr_reader [DateTime] enable_date When this device was enabled.
+    #   Returns nil if this device has not been enabled.
+    #
+    class VirtualMfaDevice < Resource
+
+      # @api private
+      def initialize serial_number, options = {}
+        @serial_number = serial_number
+        super
+      end
+
+      # @return [String] Returns the virtual MFA device serial number (ARN).
+      attr_reader :serial_number
+
+      alias_method :arn, :serial_number
+
+      attribute :base_32_string_seed, :static => true
+
+      attribute :qr_code_png, :static => true
+
+      attribute :enable_date, :static => true
+
+      attribute :user_details, :from => :user
+
+      protected :user_details
+
+      # @return [User,nil] Returns the user this device was enabled
+      #   for, or nil if this device has not been enabled.
+      def user
+        if details = user_details
+          User.new(details.user_name, :config => config)
+        end
+      end
+
+      # Enables the MFA device and associates it with the specified user.
+      # When enabled, the MFA device is required for every subsequent login
+      # by the user name associated with the device.
+      # @param [User,String] user The user (or user name string) you want
+      #   to enable this device for.
+      # @param [String] code1 An authentication code emitted by the device.
+      # @param [String] code2 A subsequent authentication code emitted by
+      #   the device.
+      def enable user, code1, code2
+
+        user_name = user.is_a?(User) ? user.name : user
+
+        client.enable_mfa_device(
+          :user_name => user_name,
+          :serial_number => serial_number,
+          :authentication_code_1 => format_auth_code(code1),
+          :authentication_code_2 => format_auth_code(code2))
+
+        nil
+
+      end
+
+      # @return [Boolean] Returns true if this device has been enabled
+      #   for a user.
+      def enabled?
+        !!enable_date
+      end
+
+      # Deactivates the MFA device and removes it from association with
+      # the user for which it was originally enabled.
+      # @return [nil]
+      def deactivate
+        client_opts = {}
+        client_opts[:user_name] = user.name
+        client_opts[:serial_number] = serial_number
+        client.deactivate_mfa_device(client_opts)
+        nil
+      end
+      alias_method :disable, :deactivate
+
+      # Deletes this virtual MFA device.
+      # @return [nil]
+      def delete
+        client.delete_virtual_mfa_device(resource_options)
+        nil
+      end
+
+      populates_from :create_virtual_mfa_device do |resp|
+        if resp.virtual_mfa_device.serial_number == serial_number
+          resp.virtual_mfa_device
+        end
+      end
+
+      populates_from :list_virtual_mfa_devices do |resp|
+        resp.virtual_mfa_devices.find { |d| d.serial_number == serial_number }
+      end
+
+      protected
+      def format_auth_code(code)
+        code.is_a?(Integer) ? sprintf("%06d", code) : code
+      end
+
+      protected
+      def get_resource attr_name
+        client.list_virtual_mfa_devices
+      end
+
+      protected
+      def resource_identifiers
+        [[:serial_number, serial_number]]
+      end
+
+    end
+
+  end
+end