fastlane-plugin-secret_keeper 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a063ea2c1222ba379c38c0a602f8c981f5f81fb5
+  data.tar.gz: 0aa4e7d4640cbab0bc853d9d9dcca38796ba7c26
+SHA512:
+  metadata.gz: 523991a02c0eed7c4d64a36bb100b3a6f9d40c1c66178c0e9c7672710ea2df9b8297bade571e7d947f7decac1eaddbc1d29eef3f8106690797173ec30895154c
+  data.tar.gz: 472ecdc17e679b3dcdda87e7b1e6da5b084bc032961de6870b538d07875eebd5cde215209d95da6d643b1d31562d1567972a6297a1e10122ab7bd910369a9aa2

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Daniel Jankowski <daniell.jankowskii@gmail.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,108 @@
+# secret_keeper plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-secret_keeper)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-secret_keeper`, add it to your project by running:
+
+```bash
+fastlane add_plugin secret_keeper
+```
+
+## About secret_keeper
+
+You should keep your secret keys, tokens and passwords secure and private. Never store keys in a code repository, in client-side code. 
+One of the recommend way of storing sensitive data is the [keychain](https://support.apple.com/guide/keychain-access/what-is-keychain-access-kyca1083/mac).
+secret_keeper allows you to store, remove and read the items from the keychain on macOS system. 
+
+## Actions
+
+### ➕ add_item_to_keychain
+
+``` ruby
+add_item_to_keychain	# Adds the credentials to the keychain on behalf of the user
+```
+
+``` ruby
+add_item_to_keychain(
+      item_name: "personal-access-token", # Item name to be stored in the keychain
+      account_name: "username", # An account name associated with the keychain item
+      password: ENV["PERSONAL_ACCESS_TOKEN"] # Password to be stored in the keychain
+    )
+```
+
+It returns password as a plain text.
+
+⚠️ If an item you are trying to add already exists, the lane fails. 
+
+### ➖ remove_item_from_keychain
+
+``` ruby
+remove_item_from_keychain	# Removes the credentials from the keychain on behalf of the user
+```
+
+``` ruby
+remove_item_from_keychain(
+      item_name: "personal-access-token", # Item name to be removed from the keychain
+    )
+```
+
+⚠️ If an item you are trying to remove does not exist, the lane fails.
+
+### 👓 read_item_from_keychain
+
+``` ruby
+read_item_from_keychain	# Reads the password from the keychain for a given item
+```
+
+``` ruby
+read_item_from_keychain(
+      item_name: "personal-access-token", # Item name for a given password stored in the keychain
+    )
+```
+
+It returns password as a plain text if the item has been found, nil otherwise.
+
+## Example
+
+One of the common usage of a secret_keeper plugin is storing and reading API tokens for a 3rd party services you need to communicate with.
+
+```ruby
+lane :request_3rd_party_API do
+    password = read_item_from_keychain(
+        item_name: PERSONAL_ACCESS_TOKEN
+    )
+
+    if password
+        # You can use your password here
+    else
+        # The password for a given item has not been found in the keychain. Request a user to provide the password. 
+        UI.message 'Falstlane will talk to the 3rd party service on your behalf. In order to do so, it needs a personal access token. It will ask about it only once and store it in the keychain. Please provide your token 🙏🏻'
+
+        # Since `password` field is non-optional, Fastlane will ask to provide it via a user input. 
+        password = add_item_to_keychain(
+            item_name: PERSONAL_ACCESS_TOKEN,
+            account_name: ENV["USER"]
+        )
+
+        # Now you can read a password successfully. 
+    end
+end
+```
+
+## 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/secret_keeper.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/secret_keeper/version'
+
+module Fastlane
+  module SecretKeeper
+    # 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::SecretKeeper.all_classes.each do |current|
+  require current
+end

data/lib/fastlane/plugin/secret_keeper/actions/add_item_to_keychain_action.rb

@@ -0,0 +1,59 @@
+require 'security'
+
+module Fastlane
+  module Actions
+    class AddItemToKeychainAction < Action
+      def self.run(params)
+        item_name = params[:item_name]
+        account_name = params[:account_name]
+        password = params[:password]
+
+        success = Security::InternetPassword.add(item_name, account_name, password)
+        if success 
+          UI.success("Sucessfully added new item to the keychain 🎉")
+          return password
+        else
+          UI.error("Could not store password in keychain ❌")
+          UI.user_error!("Could not store password in the keychain. This can happen if the item you are trying to store already exists in the keychain.")
+        end
+      end
+
+      def self.description
+        "Adds the credentials to the keychain on behalf of the user"
+      end
+
+      def self.return_value
+        "Returns password as a plain text"
+      end
+
+      def self.authors
+        ["Daniel Jankowski"]
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :item_name,
+                                  env_name: "SECRET_KEEPER_ITEM_NAME",
+                               description: "Item name to be stored in the keychain",
+                                  optional: false,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :account_name,
+                                    env_name: "SECRET_KEEPER_ACCOUNT_NAME",
+                                description: "An account name associated with the keychain item",
+                                    optional: false,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :password,
+                                    env_name: "SECRET_KEEPER_PASSWORD",
+                                description: "Password to be stored in the keychain",
+                                    optional: false,
+                                    sensitive: true,
+                                      type: String)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/secret_keeper/actions/read_item_from_keychain_action.rb

@@ -0,0 +1,46 @@
+require 'security'
+
+module Fastlane
+  module Actions
+    class ReadItemFromKeychainAction < Action
+      def self.run(params)
+        item_name = params[:item_name]
+
+        item = Security::InternetPassword.find(server: item_name)
+        if item 
+          UI.success("Sucessfully read an item from the keychain 🎉")
+          return item.password 
+        else
+          UI.error("Could not read an item from the keychain. Please make sure '#{item_name}' item exists in the keychain ❌")
+          return nil
+        end
+      end
+
+      def self.description
+        "Reads the password from the keychain for a given item"
+      end
+
+      def self.authors
+        ["Daniel Jankowski"]
+      end
+
+      def self.return_value
+        "Returns password as a plain text"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :item_name,
+                                  env_name: "SECRET_KEEPER_ITEM_NAME",
+                               description: "Item name for a given password stored in the keychain",
+                                  optional: false,
+                                      type: String)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/secret_keeper/actions/remove_item_from_keychain_action.rb

@@ -0,0 +1,41 @@
+require 'security'
+
+module Fastlane
+  module Actions
+    class RemoveItemFromKeychainAction < Action
+      def self.run(params)
+        item_name = params[:item_name]
+
+        success = Security::InternetPassword.delete(server: item_name)
+        if success 
+          UI.success("Sucessfully removed an item from the keychain 🎉")
+        else
+          UI.error("Could not remove an item from the keychain ❌")
+          UI.user_error!("Could not remove an item from the keychain. This can happen if an item you are trying to remove could not be found in the keychain.")
+        end
+      end
+
+      def self.description
+        "Removes the credentials from the keychain on behalf of the user"
+      end
+
+      def self.authors
+        ["Daniel Jankowski"]
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :item_name,
+                                  env_name: "SECRET_KEEPER_ITEM_NAME",
+                               description: "Item name to be removed from the keychain",
+                                  optional: false,
+                                      type: String)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/secret_keeper/helper/secret_keeper_helper.rb

@@ -0,0 +1,12 @@
+module Fastlane
+  module Helper
+    class SecretKeeperHelper
+      # class methods that you define here become available in your action
+      # as `Helper::SecretKeeperHelper.your_method`
+      #
+      def self.show_message
+        UI.message("Hello from the secret_keeper plugin helper!")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module SecretKeeper
+    VERSION = "1.0.0"
+  end
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-secret_keeper
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Daniel Jankowski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-22 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: 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'
+  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.62.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.62.0
+description: 
+email: daniell.jankowskii@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/secret_keeper.rb
+- lib/fastlane/plugin/secret_keeper/actions/add_item_to_keychain_action.rb
+- lib/fastlane/plugin/secret_keeper/actions/read_item_from_keychain_action.rb
+- lib/fastlane/plugin/secret_keeper/actions/remove_item_from_keychain_action.rb
+- lib/fastlane/plugin/secret_keeper/helper/secret_keeper_helper.rb
+- lib/fastlane/plugin/secret_keeper/version.rb
+homepage: https://github.com/mollyIV/fastlane-plugin-secret_keeper
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: secret_keeper is a wrapped on keychain access.
+test_files: []