fastlane-plugin-bitwarden 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 280fa5fbc7ea8740435a3562cfd2958ce0407c026df86ce299195db0a17018fb
+  data.tar.gz: a30953014a5468f52dc0f59a66a9ff952cb09c5b039727ff5e82210ee5532817
+SHA512:
+  metadata.gz: 4bb95ddedacdbfe81b58b75ed307dfca925c5df4b550b260e70e1a91d52e5742ac81bd778f79ea7b397a9e30b5f23d02d7a1bb8ad3953261d952ca6109155eab
+  data.tar.gz: 54a8541ff7de99b197f9da192defd330a5b5ac393b2d59649e89ca3774e9ef2f12b5034c3f01a6de1184055e77d0bf608949042a20dd93562099570b6908a1e5

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Ilija Boshkov <ilija@codechem.com>
+
+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.

data/README.md

@@ -0,0 +1,63 @@
+# bitwarden plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-bitwarden)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-bitwarden`, add it to your project by running:
+
+```bash
+fastlane add_plugin bitwarden
+```
+
+## About
+
+Bitwarden CLI warpper plugin
+
+This plugin is a wrapper around the Bitwarden CLI, it provides very basic functionality to enable quick and easy access to your Bitwarden vault.
+
+One nice use-case for a plugin like this is to automate and safely keep app deployment/build secrets like for example Android keystores and such.
+
+It needs the [Bitwarden CLI](https://help.bitwarden.com/article/cli/) installed and available somewhere in `$PATH`. This can be overridden by using the `:cli_path` variable in all actions, or the analogous `BW_CLI_PATH` environment variable. 
+
+By default it uses https://bitwarden.com as the Server URL, can be overriden with `BW_SERVER_URL` for a self-hosted instance.
+
+Documentation is **TODO**, see the actions' source and the example `Fastfile` for now.
+
+**This plugin is in an early stage of development, any contributions are welcome.**
+
+## Example
+Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`.
+
+Make sure to setup the necessary variables or edit the `Fastfile` in order to be able to test everything out.
+
+## Run tests for this plugin
+
+Note: The tests are still not done so - **TODO**.
+
+To run both the tests, and code style validation, run
+
+```
+rake
+```
+
+To automatically fix many of the styling issues, use
+```
+rubocop -a
+```
+
+## Issues and Feedback
+
+For any other issues and feedback about this plugin, please submit it to this repository.
+
+## Troubleshooting
+
+If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.
+
+## Using _fastlane_ Plugins
+
+For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).
+
+## About _fastlane_
+
+_fastlane_ is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).

data/lib/fastlane/plugin/bitwarden.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/bitwarden/version'
+
+module Fastlane
+  module Bitwarden
+    # Return all .rb files inside the "actions" and "helper" directory
+    def self.all_classes
+      Dir[File.expand_path('**/{actions,helper}/*.rb', File.dirname(__FILE__))]
+    end
+  end
+end
+
+# By default we want to import all available actions and helpers
+# A plugin can contain any number of actions and plugins
+Fastlane::Bitwarden.all_classes.each do |current|
+  require current
+end

data/lib/fastlane/plugin/bitwarden/actions/bitwarden_download_attachment.rb

@@ -0,0 +1,74 @@
+require_relative '../helper/bitwarden_helper'
+
+module Fastlane
+  module Actions
+    class BitwardenDownloadAttachmentAction < Action
+      def self.run(params)
+        @helper = Helper::BitwardenHelper.new(params[:cli_path])
+        item_id = params[:item_id]
+        attachment_id = params[:attachment_id]
+        output_path = params[:output_path]
+        args = ['get', 'attachment', '--itemid', item_id, attachment_id, '--raw']
+        if output_path
+          args += ['--output', output_path]
+        end
+
+        @helper.exec(*args)
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "You can use this action to download an item's attachment from BitWarden."
+      end
+
+      def self.details
+        "You can use this action to download an item's attachment from BitWarden."
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :cli_path,
+                                       env_name: "BW_CLI_PATH",
+                                       optional: true,
+                                       description: "Override path to the Bitwarden CLI"),
+          FastlaneCore::ConfigItem.new(key: :item_id,
+                                       env_name: "BW_ITEM_ID",
+                                       description: "ID of the item the Attachment belongs to",
+                                       verify_block: proc do |value|
+                                          UI.user_error!("No Item ID provided to the Bitwarden Download Attachment Action, pass it like so: `item_id: '<...item_id...>'`") unless value and not value.empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :attachment_id,
+                                       env_name: "BW_ATTACHMENT_ID",
+                                       description: "ID of the Attachment to be downloaded",
+                                       verify_block: proc do |value|
+                                          UI.user_error!("No Attachment ID provided to the Bitwarden Download Attachment Action `email: '<...attachment_id...>'`") unless value and not value.empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :output_path,
+                                       env_name: "BW_ATTACHMENT_OUTPUT",
+                                       description: "Output path of the Attachment to be downloaded",
+                                       optional: true),
+        ]
+      end
+
+      def self.output
+        [
+        ]
+      end
+
+      def self.return_value
+        "The resulting file path"
+      end
+
+      def self.authors
+        ["ilija@codechem.com"]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/bitwarden/actions/bitwarden_get_object.rb

@@ -0,0 +1,81 @@
+require_relative '../helper/bitwarden_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      BW_SESSION = :BW_SESSION
+    end
+
+    class BitwardenGetObjectAction < Action
+      def self.run(params)
+        @helper = Helper::BitwardenHelper.new(params[:cli_path])
+        object_type = params[:object_type]
+        other_args = params[:args] || {}
+        str_args = params[:str_args] || ""
+
+        args = ['get', object_type]
+
+        args.push(str_args)
+
+        other_args.each do |key, value|
+          args.push(key.to_s)
+          args.push(value)
+        end
+
+        args.push('--raw')
+
+        @helper.exec(*args)
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "You can use this action to download an item's attachment from BitWarden."
+      end
+
+      def self.details
+        "You can use this action to download an item's attachment from BitWarden."
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :cli_path,
+                                       env_name: "BW_CLI_PATH",
+                                       optional: true,
+                                       description: "Override path to the Bitwarden CLI"),
+          FastlaneCore::ConfigItem.new(key: :object_type,
+                                       description: "Type of the object to get (collection, item, etc.)",
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No object type provided to the Bitwarden Get Object Action`") unless value && !value.empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :args,
+                                       description: "Other arguments (hash)",
+                                       type: Hash,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :str_args,
+                                       description: "Other arguments (string)",
+                                       optional: true)
+        ]
+      end
+
+      def self.output
+        [
+        ]
+      end
+
+      def self.return_value
+        "The resulting object"
+      end
+
+      def self.authors
+        ["ilija@codechem.com"]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/bitwarden/actions/bitwarden_login.rb

@@ -0,0 +1,86 @@
+module Fastlane
+  module Actions
+    class BitwardenLoginAction < Action
+      def self.ensure_login
+        UI.message("Logging in to " + @server_url)
+        @helper.exec('config', 'server', @server_url)
+        UI.message("Checking login")
+        @helper.exec('login', '--check', error_callback: method(:bw_login))
+        Actions::BitwardenUnlockVaultAction.run(cli_path: @cli_path, password: @password)
+      end
+
+      def self.bw_login(result)
+        session = @helper.exec('login', @email, @password, '--raw')
+        Actions.lane_context[SharedValues::BW_SESSION] = session
+      end
+
+      def self.run(params)
+        @cli_path = params[:cli_path]
+        @server_url = params[:server_url]
+        @email = params[:email]
+        @password = params[:password]
+        @helper = Helper::BitwardenHelper.new(@cli_path)
+        self.ensure_login
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "You can use this action to login to BitWarden and unlock the vault."
+      end
+
+      def self.details
+        "You can use this action to login to BitWarden and unlock the vault."
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :cli_path,
+                                       env_name: "BW_CLI_PATH",
+                                       optional: true,
+                                       description: "Override path to the Bitwarden CLI"),
+
+          FastlaneCore::ConfigItem.new(key: :server_url,
+                                       env_name: "BW_SERVER_URL",
+                                       description: "Server URL use when signing in to Bitwarden",
+                                       default_value: "https://bitwarden.com",
+                                       verify_block: proc do |value|
+                                          UI.user_error!("No Server URL provided to the Bitwarden Login Action, pass it like so: `server_url: '<...server_url...>'`") unless value && !value.empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :email,
+                                       env_name: "BW_EMAIL",
+                                       description: "Email to use when signing in to Bitwarden",
+                                       verify_block: proc do |value|
+                                          UI.user_error!("No Email provided to the Bitwarden Login Action, pass it like so: `email: '<...email...>'`") unless value && !value.empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :password,
+                                       env_name: "BW_PASSWORD",
+                                       description: "Master Password to use when signing in to Bitwarden",
+                                       verify_block: proc do |value|
+                                          UI.user_error!("No Password provided to the Bitwarden Login Action `email: '<...email...>'`") unless value && !value.empty?
+                                       end)
+        ]
+      end
+
+      def self.output
+        [
+          ['BW_SESSION', 'The session token that Bitwarden returns']
+        ]
+      end
+
+      def self.return_value
+        "The BW_SESSION token"
+      end
+
+      def self.authors
+        ["ilija@codechem.com"]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/bitwarden/actions/bitwarden_unlock_vault.rb

@@ -0,0 +1,60 @@
+module Fastlane
+  module Actions
+    class BitwardenUnlockVaultAction < Action
+      def self.run(params)
+        @helper = Helper::BitwardenHelper.new(params[:cli_path])
+        password = params[:password]
+
+        UI.message("Unlocking vault...")
+
+        session = @helper.exec('unlock', password, '--raw')
+        Actions.lane_context[SharedValues::BW_SESSION] = session
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "You can use this action to download an item's attachment from BitWarden."
+      end
+
+      def self.details
+        "You can use this action to download an item's attachment from BitWarden."
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :cli_path,
+                                       env_name: "BW_CLI_PATH",
+                                       optional: true,
+                                       description: "Override path to the Bitwarden CLI"),
+          FastlaneCore::ConfigItem.new(key: :password,
+                                       env_name: "BW_PASSWORD",
+                                       description: "Master Password to use when signing in to Bitwarden",
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No Password provided to the Bitwarden Login Action `email: '<...email...>'`") unless value && !value.empty?
+                                       end)
+        ]
+      end
+
+      def self.output
+        [
+          ['BW_SESSION', 'The session token that Bitwarden returns']
+        ]
+      end
+
+      def self.return_value
+        "The BW_SESSION token"
+      end
+
+      def self.authors
+        ["ilija@codechem.com"]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/bitwarden/helper/bitwarden_helper.rb

@@ -0,0 +1,21 @@
+require 'fastlane_core/ui/ui'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+
+  module Helper
+    class BitwardenHelper
+      def initialize(cli_path)
+        @cli_path = cli_path || "bw"
+      end
+
+      def exec(*command, log: false, error_callback: nil)
+        ENV['BW_SESSION'] = Actions.lane_context[Actions::SharedValues::BW_SESSION]
+        command.insert(0, @cli_path)
+        res = Fastlane::Actions::sh(*command, log: log, error_callback: error_callback)
+        ENV.delete('BW_SESSION')
+        res
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/bitwarden/version.rb

@@ -0,0 +1,5 @@
+module Fastlane
+  module Bitwarden
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-bitwarden
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ilija Boshkov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-12-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-require_tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.137.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.137.0
+description: 
+email: ilija@codechem.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/bitwarden.rb
+- lib/fastlane/plugin/bitwarden/actions/bitwarden_download_attachment.rb
+- lib/fastlane/plugin/bitwarden/actions/bitwarden_get_object.rb
+- lib/fastlane/plugin/bitwarden/actions/bitwarden_login.rb
+- lib/fastlane/plugin/bitwarden/actions/bitwarden_unlock_vault.rb
+- lib/fastlane/plugin/bitwarden/helper/bitwarden_helper.rb
+- lib/fastlane/plugin/bitwarden/version.rb
+homepage: https://github.com/codechem/fastlane-plugin-bitwarden
+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.0.6
+signing_key: 
+specification_version: 4
+summary: Bitwarden CLI warpper plugin
+test_files: []