cyberark/conjur-api-ruby

#
# Copyright 2013-2017 Conjur Inc
#
# Permission is hereby granted, free of charge, to any person obtaining a copy of
# this software and associated documentation files (the "Software"), to deal in
# the Software without restriction, including without limitation the rights to
# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
# the Software, and to permit persons to whom the Software is furnished to do so,
# subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
#
module Conjur
  # This module provides methods for things that are like users (specifically, those that have
  # api keys).
  module ActsAsUser
    # @api private
    def self.included(base)
      base.include ActsAsRolsource
    end

    # Returns a newly created user's api_key.
    #
    # @note The API key is not returned by {API#resource}. It is only available
    # via {API#login}, when the object is newly created, and when the API key is rotated.
    #
    # @return [String] the api key
    # @raise [Exception] when the object isn't newly created.
    def api_key
      attributes['api_key'] or raise "api_key is only available on a newly created #{kind}"
    end

    # Create an api logged in as this user-like thing.
    #
    # @note As with {#api_key}, this method only works on newly created instances.
    # @see #api_key
    # @return [Conjur::API] an api logged in as this user-like thing.
    def api
      Conjur::API.new_from_key login, api_key, account: account
    end

    # Rotate this role's API key. You must have `update` permission on the user to do so.
    #
    # @note You will not be able to access the API key returned by this method later, so you should
    #   probably hang onto it it.
    #
    # @note You cannot rotate your own API key with this method. To do so, use `Conjur::API.rotate_api_key`.
    #
    # @note This feature requires a Conjur appliance running version 4.6 or higher.
    #
    # @return [String] the new API key for this user.
    def rotate_api_key
      if login == username
        raise 'You cannot rotate your own API key via this method. To do so, use `Conjur::API.rotate_api_key`'
      end

      url_for(:authn_rotate_api_key, credentials, account, id).put("").body
    end
  end
end