kwalletd5-wrapper 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c803e2108e1ffe1d78230bd0f7a3d3184a552150123c0d2c0fb0078bcf13577b
+  data.tar.gz: f46d867ad0a9bd900ccdb8f644be93dca6c6c58fbc27d82d129ae830fd95f334
+SHA512:
+  metadata.gz: 449d64ef73077aa8669bff7e4d041216869fad6b701f7b72c48d47600696679b35611c65ddb2c594ae47302a3cf4828eb54ebf398ec65697f3ef6b427d01effc
+  data.tar.gz: 4af62b72313eb951cac0f83e5eaf626375febd38d48d736c33db90d848916d6206575883dd850911332bea7753be2dd7d29582cc944fe7b98c13a1d7fe3ddc5d

data/lib/kwalletd5-wrapper.rb

@@ -0,0 +1,166 @@
+#!/snap/bin/ruby
+#
+# Author: Eric Power
+#
+# Description:
+#     A module that provides an interface for communicating with the KDE wallet
+#     provided in Plasma 5.
+#
+#     The interface is split into two categories:
+#         1. A KwalletConnection
+#             initializing a KwalletConnection Object will ensure that the wallet
+#             is open (KWallet will prompt the user if required), and make reading
+#             and writing from that wallet easy.
+#         2. Direct functions
+#             These functions provide tools to interact with KDE Wallet outside
+#             of a particular wallet. This includes things like checking which
+#             wallets exist, creating new wallets, pinging the Kwallet daemon,
+#             setting priorities, and more.
+#
+#     This module will raise StandardErrors if qdbus or kwalletd5 is not available
+#     on the local machine.
+#
+#     All calls to this module will raise StandardErrors if the call to qdbus
+#     fails. Check the associated error message for information on why the call
+#     failed.
+#
+#     Released under the MIT License.
+#     Full license at https://github.com/epwr/kwalletd5-ruby-interface/LICENSE
+
+# Dependencies
+require 'open3'
+
+if `which kwalletd5 2>&1` == ""
+  raise "Kwalletd5 Ruby Interface requires `kwalletd5` be installed on your system."
+elsif `which qdbus 2>&1` == ""
+  raise "Kwalletd5 Ruby Interface requires `qdbus` be installed on your system."
+end
+
+
+module KWalletd5
+
+  # KWalletConnection
+  #     Used to either open or create a wallet. The user will be prompted if KDE
+  #     Wallet requires their authorization. The prompt will include app_name,
+  #     so make sure that the user will recognize your app_name.
+  class KWalletConnection
+
+    def initialize(wallet_name, app_name, window_id: "0")
+      # TODO: explain window_id here.
+      @app_name  = app_name
+      @wallet_id = message_kwd5("open", wallet_name, window_id, app_name)
+      @wallet_name = wallet_name
+    end
+
+    def replace_key(folder, old_key, new_key)
+      message_kwd5("renameEntry", @wallet_id, folder, old_key, new_key, @app_name)
+    end
+
+    def list_keys(folder)
+      message_kwd5("entryList", @wallet_id, folder, @app_name).split("\n")
+    end
+
+    def does_key_exist(folder, key)
+      message_kwd5("entryList", @wallet_id, folder, @app_name).split("\n").include?(key)
+    end
+
+    def write_entry(folder, key, value)
+      message_kwd5("writeEntry", @wallet_id, folder, key, value, @app_name)
+    end
+
+    def lookup_entry(folder, key)
+      message_kwd5("readEntry", @wallet_id, folder, key, @app_name)
+    end
+
+    def delete_entry(folder, key)
+      message_kwd5("removeEntry", @wallet_id, folder, key, @app_name)
+    end
+
+    def write_password(folder, key, value)
+      message_kwd5("writePassword", @wallet_id, folder, key, value, @app_name)
+    end
+
+    def lookup_password(folder, key)
+      message_kwd5("readPassword", @wallet_id, folder, key, @app_name)
+    end
+
+    def write_map(folder, key, value)
+      message_kwd5("writeMap", @wallet_id, folder, key, value, @app_name)
+    end
+
+    def lookup_map(folder, key)
+      message_kwd5("readMap", @wallet_id, folder, key, @app_name)
+    end
+
+    def create_folder(folder)
+      message_kwd5("createFolder", @wallet_id, folder, @app_name)
+    end
+
+    def delete_folder(folder)
+      message_kwd5("removeFolder", @wallet_id, folder, @app_name)
+    end
+
+    def list_folders
+      message_kwd5("folderList", @wallet_id, @app_name)
+    end
+
+    def does_folder_exist(folder)
+      message_kwd5("hasFolder", @wallet_id, folder, @app_name) == "true"
+    end
+
+    def is_open
+      msg = message_kwd5("isOpen", @wallet_name) == "true"
+    end
+
+    def close!
+      message_kwd5("close", @wallet_id, true, @app_name)
+    end
+  end
+
+  # Direct Functions
+
+  def change_wallet_password(wallet_name, app_name, window_id: "0")
+    # Kwalletd5 returns "-1" if the prompt opens properly. No way of telling if
+    # the password was actually changed (at least not via qdbus).
+    message_kwd5("changePassword", wallet_name, app_name, window_id) == "-1"
+  end
+
+  def list_wallets
+    message_kwd5("wallets")
+  end
+
+  def list_users(wallet_name)
+    message_kwd5("users", wallet_name)
+  end
+
+  def delete_wallet(wallet_name)
+    message_kwd5("deleteWallet", wallet_name)
+  end
+
+  def is_wallet_open(wallet_name)
+    message_kwd5("isOpen", wallet_name) == "true"
+  end
+
+  def does_wallet_exist(wallet_name)
+    message_kwd5("wallets").split("\n").include?(wallet_name)
+  end
+
+  # Private helper functions
+
+  private
+  def message_kwd5(method, *args, path: "/modules/kwalletd5")
+    # TODO: Test if capture3 handles escaping characters.
+    # TODO: handle the case where a string contains "\;" already (escape both?)
+    #         args.each{ |arg| arg.split(";").join("\;") }
+    stdout, stderr, status = Open3.capture3("qdbus org.kde.kwalletd5 #{path} #{method} #{args.join(" ")}")
+    unless stderr == ""
+      raise stderr + " -- ran: qdbus org.kde.kwalletd5 #{path} #{method} #{args.join(" ")}"
+    end
+    unless status == 0
+      raise "Method call returned error code: #{status}. stdout = '#{stdout}', stderr = '#{stderr}'" +
+        " -- ran: qdbus org.kde.kwalletd5 #{path} #{method} #{args.join(" ")}"
+    end
+    stdout.strip()
+  end
+
+end

metadata

@@ -0,0 +1,44 @@
+--- !ruby/object:Gem::Specification
+name: kwalletd5-wrapper
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Eric Power
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-09-09 00:00:00.000000000 Z
+dependencies: []
+description: A gem that provides access to as much of the kwalletd5 api as could be
+  useful.
+email: ericpower@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/kwalletd5-wrapper.rb
+homepage: https://github.com/epwr/kwalletd5-ruby-wrapper
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key: 
+specification_version: 4
+summary: A gem that provides access to the kwalletd5 dbus api.
+test_files: []