passwordstate 0.0.4 → 0.1.0

data/lib/passwordstate/resources/password.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Passwordstate
   module Resources
     class Password < Passwordstate::Resource
@@ -5,6 +7,7 @@ module Passwordstate
 
       index_field :password_id
 
+      # rubocop:disable Naming/VariableNumber
       accessor_fields :title,
                       :domain,
                       :host_name,
@@ -20,6 +23,7 @@ module Passwordstate
                       :generic_field_8, { name: 'GenericField8' },
                       :generic_field_9, { name: 'GenericField9' },
                       :generic_field_10, { name: 'GenericField10' },
+                      :generic_field_info,
                       :account_type_id, { name: 'AccountTypeID' },
                       :notes,
                       :url,
@@ -28,11 +32,17 @@ module Passwordstate
                       :allow_export,
                       :web_user_id, { name: 'WebUser_ID' },
                       :web_password_id, { name: 'WebPassword_ID' },
-                      :password_list_id, { name: 'PasswordListID' } # Note: POST only  # rubocop:disable Style/BracesAroundHashParameters
+                      :password_list_id, { name: 'PasswordListID' } # NB: POST only
+      # rubocop:enable Naming/VariableNumber
 
       read_fields :account_type,
                   :password_id, { name: 'PasswordID' },
-                  :password_list
+                  :password_list,
+                  :otp,
+                  # For 'Managed' passwords
+                  :status,
+                  :current_password,
+                  :new_password
 
       # Things that can be set in a POST/PUT request
       # TODO: Do this properly
@@ -47,18 +57,41 @@ module Passwordstate
                    :heartbeat_enabled,
                    :heartbeat_schedule,
                    :validation_script_id, { name: 'ValidationScriptID' },
-                   :host_name,
                    :ad_domain_netbios, { name: 'ADDomainNetBIOS' },
                    :validate_with_priv_account
 
+      def otp!
+        client.request(:get, "onetimepassword/#{password_id}").first['OTP']
+      end
+
       def check_in
-        client.request :get, "passwords/#{password_id}", query: passwordstatify_hash(check_in: nil)
+        client.request :get, "passwords/#{password_id}", query: self.class.passwordstateify_hash(check_in: nil)
+      end
+
+      def send_selfdestruct(email, expires_at:, view_count:, reason: nil, **params)
+        data = {
+          password_id: password_id,
+          to_email_address: email,
+          expires_at: expires_at,
+          no_views: view_count
+        }
+        data[:message] = params[:message] if params.key? :message
+        data[:prefix_message_content] = params[:prefix_message] if params.key? :prefix_message
+        data[:append_message_content] = params[:suffix_message] if params.key? :suffix_message
+        data[:to_first_name] = params[:name] if params.key? :name
+        data[:email_subject] = params[:subject] if params.key? :subject
+        data[:email_body] = params[:body] if params.key? :body
+        data[:passphrase] = params[:passphrase] if params.key? :passphrase
+        data[:reason] = reason if reason
+
+        client.request :post, 'selfdestruct', data: data
       end
 
       def history
         raise 'Password history only available on stored passwords' unless stored?
 
-        Passwordstate::ResourceList.new client, PasswordHistory,
+        Passwordstate::ResourceList.new PasswordHistory,
+                                        client: client,
                                         all_path: "passwordhistory/#{password_id}",
                                         only: :all
       end
@@ -68,25 +101,25 @@ module Passwordstate
         PasswordPermission.new(_client: client, password_id: password_id)
       end
 
-      def delete(recycle = false, query = {})
-        super query.merge(move_to_recycle_bin: recycle)
+      def delete(recycle: false, **query)
+        super(**query.merge(move_to_recycle_bin: recycle))
       end
 
-      def add_dependency(data = {})
+      def add_dependency(**data)
         raise 'Password dependency creation only available for stored passwords' unless stored?
 
         client.request :post, 'dependencies', body: self.class.passwordstatify_hash(data.merge(password_id: password_id))
       end
 
-      def self.all(client, query = {})
-        super client, { query_all: true }.merge(query)
+      def self.all(client, **query)
+        super client, **{ query_all: true }.merge(query)
       end
 
-      def self.search(client, query = {})
-        super client, { _api_path: 'searchpasswords' }.merge(query)
+      def self.search(client, **query)
+        super client, **{ _api_path: 'searchpasswords' }.merge(query)
       end
 
-      def self.generate(client, options = {})
+      def self.generate(client, **options)
         results = client.request(:get, 'generatepassword', query: options).map { |r| r['Password'] }
         return results.first if results.count == 1
 
@@ -109,6 +142,7 @@ module Passwordstate
                   :surname
 
       # Password object fields
+      # rubocop:disable Naming/VariableNumber
       read_fields :title,
                   :domain,
                   :host_name,
@@ -133,7 +167,8 @@ module Passwordstate
                   :expiry_date, { is: Time },
                   :allow_export,
                   :web_user_id, { name: 'WebUser_ID' },
-                  :web_password_id, { name: 'WebPassword_ID' } # rubocop:disable Style/BracesAroundHashParameters
+                  :web_password_id, { name: 'WebPassword_ID' }
+      # rubocop:enable Naming/VariableNumber
 
       def get
         raise 'Not applicable'
@@ -145,7 +180,7 @@ module Passwordstate
 
       index_field :password_id
 
-      read_fields :password_id, { name: 'PasswordID' } # rubocop:disable Style/BracesAroundHashParameters
+      read_fields :password_id, { name: 'PasswordID' }
     end
   end
 end

data/lib/passwordstate/resources/password_list.rb

@@ -1,7 +1,22 @@
+# frozen_string_literal: true
+
 module Passwordstate
   module Resources
     class PasswordList < Passwordstate::Resource
+      HideConfig = Struct.new(:view, :modify, :admin) do
+        def self.parse(str)
+          view, modify, admin = str.split(':').map { |b| b.to_s.downcase == 'true' }
+
+          new view, modify, admin
+        end
+
+        def to_s
+          "#{view}:#{modify}:#{admin}"
+        end
+      end
+
       api_path 'passwordlists'
+      acceptable_methods :CR
 
       index_field :password_list_id
 
@@ -26,11 +41,13 @@ module Passwordstate
                       :provide_access_reason,
                       :password_reset_enabled,
                       :force_password_generator,
-                      :hide_passwords,
+                      :hide_passwords, { is: HideConfig },
                       :show_guide,
                       :enable_password_reset_schedule,
                       :password_reset_schedule,
-                      :add_days_to_expiry_date
+                      :add_to_expiry_date,
+                      :add_to_expiry_date_interval,
+                      :one_time_passwords
 
       read_fields :password_list_id, { name: 'PasswordListID' },
                   :tree_path,
@@ -38,14 +55,27 @@ module Passwordstate
                   :generator_name,
                   :policy_name
 
+      write_fields :copy_settings_from_password_list_id, { name: 'CopySettinsgFromPasswordListID' },
+                   :copy_settings_from_template_id, { name: 'CopySettingsFromTemplateID' },
+                   :link_to_template,
+                   :copy_permissions_from_password_list_id, { name: 'CopyPermissionsFromPasswordListID' },
+                   :copy_permissions_from_template_id, { name: 'CopyPermissionsFromTemplateID' },
+                   :nest_under_folder_id, { name: 'NestUnderFolderID' },
+                   :apply_permissions_for_user_id, { name: 'ApplyPermissionsForUserID' },
+                   :apply_permissions_for_security_group_id, { name: 'ApplyPermissionsForSecurityGroupID' },
+                   :apply_permissions_for_security_group_name,
+                   :permission,
+                   :site_id, { name: 'SiteID' }
+
       alias title password_list
 
-      def self.search(client, query = {})
-        super client, query.merge(_api_path: 'searchpasswordlists')
+      def self.search(client, **query)
+        super client, **query.merge(_api_path: 'searchpasswordlists')
       end
 
       def passwords
-        Passwordstate::ResourceList.new client, Passwordstate::Resources::Password,
+        Passwordstate::ResourceList.new Passwordstate::Resources::Password,
+                                        client: client,
                                         all_path: "passwords/#{password_list_id}",
                                         all_query: { query_all: nil },
                                         search_path: "searchpasswords/#{password_list_id}",
@@ -57,8 +87,11 @@ module Passwordstate
         PasswordListPermission.new(_client: client, password_list_id: password_list_id)
       end
 
-      def full_path(unix = false)
-        [tree_path, password_list].compact.join('\\').tap do |full|
+      def full_path(unix: false)
+        path = [tree_path]
+        path << password_list unless tree_path.end_with? password_list
+
+        path.compact.join('\\').tap do |full|
           full.tr!('\\', '/') if unix
         end
       end
@@ -69,7 +102,7 @@ module Passwordstate
 
       index_field :password_list_id
 
-      read_fields :password_list_id, { name: 'PasswordListID' } # rubocop:disable Style/BracesAroundHashParameters
+      read_fields :password_list_id, { name: 'PasswordListID' }
     end
   end
 end

data/lib/passwordstate/resources/permission.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Passwordstate
   module Resources
     class Permission < Passwordstate::Resource

data/lib/passwordstate/resources/privileged_account.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Passwordstate
+  module Resources
+    class PrivilegedAccount < Passwordstate::Resource
+      api_path 'privaccount'
+
+      index_field :privileged_account_id
+
+      accessor_fields :description,
+                      :user_name,
+                      :password,
+                      :password_id, { name: 'PasswordID' },
+                      :key_type,
+                      :pass_phrase,
+                      :private_key,
+                      :site_id, { name: 'SiteID' },
+                      :account_type,
+                      :enable_password
+
+      read_fields :privileged_account_id
+    end
+
+    class PrivilegedAccountPermission < Permission
+      api_path 'privaccountpermissions'
+
+      index_field :privileged_account_id
+
+      read_fields :privileged_account_id, { name: 'PrivilegedAccountID' }
+    end
+  end
+end

data/lib/passwordstate/resources/remote_site.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Passwordstate
+  module Resources
+    class RemoteSite < Passwordstate::Resource
+      api_path 'remotesitelocations'
+
+      index_field :site_id
+
+      accessor_fields :site_location,
+                      :poll_frequency,
+                      :maintenance_start,
+                      :maintenance_end,
+                      :gateway_url, { name: 'GatewayURL' },
+                      :purge_session_recordings,
+                      :discovery_threads,
+                      :allowed_ip_ranges, { name: 'AllowedIPRanges' }
+
+      read_fields :site_id, { name: 'SiteID' }
+
+      def self.installer_instructions
+        client.request :get, "#{api_path}/exportinstallerinstructions"
+      end
+    end
+  end
+end

data/lib/passwordstate/resources/report.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Passwordstate
   module Resources
     class Report < Passwordstate::Resource

data/lib/passwordstate/util.rb

@@ -1,7 +1,14 @@
+# frozen_string_literal: true
+
 require 'net/http'
 require 'net/ntlm'
 
 module Net
+  # NTLM header extension
+  #
+  # @example Setting NTLM auth
+  #   req = Net::HTTP::Get.new URI('https://example.com')
+  #   req.ntlm_auth 'username', 'password'
   module HTTPHeader
     attr_reader :ntlm_auth_information, :ntlm_auth_options
 
@@ -20,10 +27,12 @@ module Net
 end
 
 class String
+  # Convert a snake_case string to CamelCase
   def camel_case
     split('_').collect(&:capitalize).join
   end
 
+  # Convert a CamelCase string to snake_case
   def snake_case
     gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
       .gsub(/([a-z\d])([A-Z])/, '\1_\2')
@@ -31,6 +40,7 @@ class String
       .downcase
   end
 
+  # Find a specific line in a block of text
   def find_line(&_block)
     raise ArgumentError, 'No block given' unless block_given?
 
@@ -41,6 +51,16 @@ class String
 end
 
 module Passwordstate
+  # Extensions on Net::HTTP to allow NTLM digest auth
+  #
+  # @example Using NTLM auth
+  #   uri = URI('https://example.com/some_object')
+  #   Net::HTTP.start uri.host, uri.port { |http|
+  #     req = Net::HTTP::Get.new uri
+  #     req.ntlm_auth 'username', 'password'
+  #
+  #     http.request req
+  #   }
   module NetHTTPExtensions
     def request(req, body = nil, &block)
       return super(req, body, &block) if req.ntlm_auth_information.nil?
@@ -55,7 +75,7 @@ module Passwordstate
       end
 
       type1 = Net::NTLM::Message::Type1.new
-      req['authorization'] = 'NTLM ' + type1.encode64
+      req['authorization'] = "NTLM #{type1.encode64}"
       res = super(req, body)
 
       challenge = res['www-authenticate'][/(?:NTLM|Negotiate) (.+)/, 1]
@@ -64,7 +84,7 @@ module Passwordstate
         type2 = Net::NTLM::Message.decode64 challenge
         type3 = type2.response(req.ntlm_auth_information, req.ntlm_auth_options.dup)
 
-        req['authorization'] = 'NTLM ' + type3.encode64
+        req['authorization'] = "NTLM #{type3.encode64}"
         req.body_stream.rewind if req.body_stream
         req.body = @last_body if @last_body
 

data/lib/passwordstate/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Passwordstate
-  VERSION = '0.0.4'.freeze
+  VERSION = '0.1.0'
 end

data/lib/passwordstate.rb

@@ -1,10 +1,13 @@
+# frozen_string_literal: true
+
 require 'logging'
+require 'pp'
+require 'passwordstate/version'
 require 'passwordstate/client'
 require 'passwordstate/errors'
 require 'passwordstate/resource'
 require 'passwordstate/resource_list'
 require 'passwordstate/util'
-require 'passwordstate/version'
 
 module Passwordstate
   def self.debug!

data/passwordstate.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require File.join File.expand_path('lib', __dir__), 'passwordstate/version'
 
 Gem::Specification.new do |spec|
@@ -11,15 +13,19 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/ananace/ruby-passwordstate'
   spec.license       = 'MIT'
 
+  spec.required_ruby_version = '>= 2.7'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
   spec.files         = `git ls-files -z`.split("\x0")
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'logging', '~> 2.2'
-  spec.add_dependency 'rubyntlm', '~> 0.6'
+  spec.add_dependency 'logging', '~> 2'
+  spec.add_dependency 'rubyntlm', '~> 0'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'minitest-reporters'
+  spec.add_development_dependency 'mocha'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rubocop'
 end

data/test/client_test.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class ClientTest < Minitest::Test
+  def setup
+    Net::HTTP.any_instance.expects(:start).never
+
+    @client = Passwordstate::Client.new 'http://passwordstate.example.com'
+  end
+
+  def test_version
+    @client.expects(:request).with(:get, '', allow_html: true).returns <<~HTML
+    <html>
+    Lorem ipsum
+    <div><span>V</span>9.3 (Build 9200)</div>
+    </html>
+    HTML
+
+    assert_equal '9.3.9200', @client.version
+    assert @client.version? '~> 9.3'
+  end
+
+  # Passwordstate version 9.6 has started doing stupid things.
+  # There are no longer any available method to see the version.
+  def test_broken_version
+    @client.stubs(:request).with(:get, '', allow_html: true).returns <<~HTML
+
+
+
+     <script>
+         window.location.href = '/help/manuals/api/index.html';
+    </script>
+    HTML
+
+    assert_nil @client.version
+    assert @client.version? '~> 9.3'
+  end
+end

data/test/fixtures/get_password.json

@@ -0,0 +1,31 @@
+[
+    {
+        "PasswordListID": "100",
+        "PasswordList": "Managed Passwords",
+        "PasswordID": 18075,
+        "Title": "borgdrone-4673615 @ Unimatrix Zero",
+        "Domain": "",
+        "HostName": "",
+        "UserName": "borgdrone-4673615",
+        "Description": "Unimatrix Zero access key for borgdrone-4673615",
+        "GenericField1": "",
+        "GenericField2": "",
+        "GenericField3": "",
+        "GenericField4": "",
+        "GenericField5": "",
+        "GenericField6": "",
+        "GenericField7": "",
+        "GenericField8": "",
+        "GenericField9": "",
+        "GenericField10": "",
+        "GenericFieldInfo": [],
+        "AccountTypeID": 0,
+        "Notes": "",
+        "URL": "",
+        "Password": "weishe4uChee0woh4ahquineibahpheiquaiy2yuRohjohChee6eet6rahbaiceetucoothooph8ooKahwoh5Teepah3ieLohwahkeigh4eefeivoohee8quee5oohoe",
+        "ExpiryDate": "",
+        "AllowExport": true,
+        "AccountType": "",
+        "OTP": null
+    }
+]

data/test/fixtures/get_password_list.json

@@ -0,0 +1,42 @@
+[
+    {
+        "PasswordListID": 100,
+        "PasswordList": "Managed Passwords",
+        "Description": "Someone's managed passwords",
+        "ImageFileName": "system.png",
+        "Guide": "",
+        "AllowExport": false,
+        "PrivatePasswordList": false,
+        "NoApprovers": "1",
+        "DisableNotifications": false,
+        "TimeBasedAccessRequired": false,
+        "PasswordStrengthPolicyID": 1,
+        "PasswordGeneratorID": 1,
+        "CodePage": "Using Passwordstate Default Code Page",
+        "PreventPasswordReuse": 0,
+        "AuthenticationType": "Use RADIUS Authentication",
+        "AuthenticationPerSession": false,
+        "PreventExpiryDateModification": true,
+        "SetExpiryDate": 0,
+        "ResetExpiryDate": 0,
+        "PreventDragDrop": true,
+        "PreventBadPasswordUse": false,
+        "ProvideAccessReason": true,
+        "TreePath": "\\Shared\\Somewhere\\Managed Passwords",
+        "TotalPasswords": 656,
+        "GeneratorName": "Corporate Password Generator",
+        "PolicyName": "Corporate Password Strength Policy",
+        "PasswordResetEnabled": false,
+        "ForcePasswordGenerator": false,
+        "HidePasswords": "False:True:False",
+        "ShowGuide": false,
+        "EnablePasswordResetSchedule": false,
+        "PasswordResetSchedule": "00:00:00:00",
+        "AddToExpiryDate": 90,
+        "AddToExpiryDateInterval": "Days",
+        "SiteID": 0,
+        "SiteLocation": "Internal",
+        "OneTimePasswords": false,
+        "DisableInheritance": true
+    }
+]

data/test/fixtures/get_password_otp.json

@@ -0,0 +1,5 @@
+[
+    {
+        "OTP": "123456"
+    }
+]

data/test/fixtures/password_list_search_passwords.json

@@ -0,0 +1,60 @@
+[
+    {
+        "PasswordListID": "100",
+        "PasswordList": "Managed Passwords",
+        "PasswordID": 18075,
+        "Title": "borgdrone-4673615 @ Unimatrix Zero",
+        "Domain": "",
+        "HostName": "",
+        "UserName": "borgdrone-4673615",
+        "Description": "Unimatrix Zero access key for borgdrone-4673615",
+        "GenericField1": "",
+        "GenericField2": "",
+        "GenericField3": "",
+        "GenericField4": "",
+        "GenericField5": "",
+        "GenericField6": "",
+        "GenericField7": "",
+        "GenericField8": "",
+        "GenericField9": "",
+        "GenericField10": "",
+        "GenericFieldInfo": [],
+        "AccountTypeID": 0,
+        "Notes": "",
+        "URL": "",
+        "Password": "weishe4uChee0woh4ahquineibahpheiquaiy2yuRohjohChee6eet6rahbaiceetucoothooph8ooKahwoh5Teepah3ieLohwahkeigh4eefeivoohee8quee5oohoe",
+        "ExpiryDate": "",
+        "AllowExport": true,
+        "AccountType": "",
+        "OTP": null
+    },
+    {
+        "PasswordListID": "100",
+        "PasswordList": "Managed Passwords",
+        "PasswordID": 29467,
+        "Title": "borgdrone-9342756 @ Unimatrix Zero",
+        "Domain": "",
+        "HostName": "",
+        "UserName": "borgdrone-9342756",
+        "Description": "Unimatrix Zero access key for borgdrone-9342756",
+        "GenericField1": "",
+        "GenericField2": "",
+        "GenericField3": "",
+        "GenericField4": "",
+        "GenericField5": "",
+        "GenericField6": "",
+        "GenericField7": "",
+        "GenericField8": "",
+        "GenericField9": "",
+        "GenericField10": "",
+        "GenericFieldInfo": [],
+        "AccountTypeID": 0,
+        "Notes": "",
+        "URL": "",
+        "Password": "chaihohd6aemeitivaefei0zahjee0IN7aevaisoGohrae5ileeHaquaik7lo1aicoo3lohchae2nujohRu2oofiizieth6aezahng8ohp9siesaemahKaifah8Ooyoo",
+        "ExpiryDate": "",
+        "AllowExport": true,
+        "AccountType": "",
+        "OTP": null
+    }
+]

data/test/fixtures/update_password.json

@@ -0,0 +1,31 @@
+[
+    {
+        "PasswordListID": "100",
+        "PasswordList": "Managed Passwords",
+        "PasswordID": 18075,
+        "Title": "borgdrone-4673615 @ Unimatrix Zero",
+        "Domain": "1c0389a1-6e63-4276-8500-1e595f0288e9.cube.collective",
+        "HostName": "",
+        "UserName": "borgdrone-4673615",
+        "Description": "Unimatrix Zero access key for borgdrone-4673615",
+        "GenericField1": "",
+        "GenericField2": "",
+        "GenericField3": "",
+        "GenericField4": "",
+        "GenericField5": "",
+        "GenericField6": "",
+        "GenericField7": "",
+        "GenericField8": "",
+        "GenericField9": "",
+        "GenericField10": "",
+        "GenericFieldInfo": [],
+        "AccountTypeID": 0,
+        "Notes": "",
+        "URL": "",
+        "Password": "weishe4uChee0woh4ahquineibahpheiquaiy2yuRohjohChee6eet6rahbaiceetucoothooph8ooKahwoh5Teepah3ieLohwahkeigh4eefeivoohee8quee5oohoe",
+        "ExpiryDate": "",
+        "AllowExport": true,
+        "AccountType": "",
+        "OTP": null
+    }
+]

data/test/fixtures/update_password_managed.json

@@ -0,0 +1,8 @@
+[
+    {
+        "PasswordID": 18075,
+        "Status": "Password Queued for Reset(s). Check auditing data, or UI for results.",
+        "CurrentPassword": "weishe4uChee0woh4ahquineibahpheiquaiy2yuRohjohChee6eet6rahbaiceetucoothooph8ooKahwoh5Teepah3ieLohwahkeigh4eefeivoohee8quee5oohoe",
+        "NewPassword": "<redacted>"
+    }
+]