ukey 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0cc8ccca613fa0069aad8d071537553552fbf374
+  data.tar.gz: da530f9ac472f7e801463943f800fc8dcd5dc433
+SHA512:
+  metadata.gz: acdd332c34bf871f631c8571798978d7e2ff27e159280950f32f03e98c39e7134d25efba85009a31beab20cf0aa7343640efb306b6f379700e1f553b74b1602c
+  data.tar.gz: fa1876a912009ec91bbadbfd94d0123fcdc7e4b40a55b951ff8b4c72f149d58440640afa1f0bb685811a428a7b3ed91ea00a136f79698c8a2414e3ed9a95ac8b

data/.gitignore

@@ -0,0 +1,15 @@
+/vendor/
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+*.gem
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.15.4

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in ukey.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Dorian Karter
+
+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,28 @@
+## UKey
+
+Automatically lock mac when a USB device is removed
+
+## Installation
+
+Install the gem globally:
+
+```bash
+gem install ukey
+```
+
+## Usage
+
+Select the device by plugging it in and running:
+
+```bash
+ukey select-device
+```
+
+I use a YubiKey, which I prefer because you do not have to eject it, 
+but this script will work with almost any USB device.
+
+Then to run the program
+
+```bash
+ukey watch
+```

data/Rakefile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'ukey'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/ukey

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'ukey'
+
+Ukey::CLI.start(ARGV)

data/lib/ukey.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'ukey/version'
+require 'ukey/config'
+require 'ukey/cli'
+require 'ukey/usb_watcher'
+
+# Locks screen on USB device removal
+module Ukey
+end

data/lib/ukey/cli.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'thor'
+require 'highline/import'
+
+module Ukey
+  # Command line interface for ukey
+  class CLI < Thor
+    desc 'watch', 'Watches for USB device - locks screen if removed'
+    def watch
+      puts 'Watching...'
+      watcher = UsbWatcher.new(device_name: Config.device)
+      watcher.watch
+    end
+
+    desc 'select_device', 'Show all connected devices and allows selecting one'
+    def select_device
+      watcher = UsbWatcher.new
+      devices = watcher.list_devices
+      choose do |menu|
+        menu.prompt = "Select a device (1-#{devices.count}):"
+        devices.each do |dev|
+          menu.choice(dev, &method(:device_selected))
+        end
+      end
+    end
+
+    private
+
+    def device_selected(device)
+      Config.device = device
+      say("#{device} selected. Config written.")
+    end
+  end
+end

data/lib/ukey/config.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module Ukey
+  # reads and writes the configuration for ukey
+  module Config
+    class << self
+      def load_config
+        return {} unless File.exist?(config_path)
+        YAML.load_file(config_path) || {}
+      end
+
+      def device=(device_name)
+        config = load_config.merge(device: device_name)
+        write_config(config)
+      end
+
+      def device
+        load_config[:device] || raise('Device not set.')
+      end
+
+      def write_config(config)
+        FileUtils.mkdir_p(config_directory)
+        File.open(config_path, 'w') { |f| YAML.dump(config, f) }
+      end
+
+      def config_path
+        File.join(config_directory, 'ukey.yml')
+      end
+
+      def config_directory
+        File.expand_path('~/.config/ukey')
+      end
+    end
+  end
+end

data/lib/ukey/usb_watcher.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'libusb'
+
+module Ukey
+  # Watches usb devices and locks screen if removed
+  class UsbWatcher
+    def initialize(device_name: '', interval: 5)
+      @device_name = device_name
+      @interval = interval
+      @usb = LIBUSB::Context.new
+    end
+
+    def watch
+      loop do
+        sleep(interval * 2) if screen_locked?
+        lock_screen if device_removed?
+        sleep(interval)
+      end
+    rescue SystemExit, Interrupt, KeyboardInterrupt
+      puts "\nWatcher terminated."
+    end
+
+    def list_devices
+      usb.devices.map(&:product)
+    end
+
+    private
+
+    attr_reader :interval, :device_name, :usb
+
+    def device_removed?
+      list_devices.none? { |p| p == device_name }
+    end
+
+    def screen_locked?
+      cmd = 'import sys,Quartz; d=Quartz.CGSessionCopyCurrentDictionary(); sys.exit(d and d.get("CGSSessionScreenIsLocked", 0) == 0 and d.get("kCGSSessionOnConsoleKey", 0) == 1)' # rubocop:disable Metrics/LineLength
+      system("python -c '#{cmd}'")
+    end
+
+    def lock_screen
+      cmd = '/System/Library/CoreServices/Menu\ Extras/User.menu/Contents/Resources/CGSession -suspend' # rubocop:disable Metrics/LineLength
+      system(cmd)
+    end
+  end
+end

data/lib/ukey/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module Ukey
+  VERSION = '0.1.0'
+end

data/ukey.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ukey/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ukey"
+  spec.version       = Ukey::VERSION
+  spec.authors       = ["Dorian Karter"]
+  spec.email         = ["jobs@doriankarter.com"]
+
+  spec.summary       = 'Watches for USB devices - when removed locks macOS'
+  spec.description   = 'A CLI for detecting a USB device removal and locking macOS'
+  spec.homepage      = 'https://doriankarter.com'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'libusb', '~> 0.6'
+  spec.add_dependency 'thor', '~> 0.20'
+  spec.add_dependency 'highline', '~> 1.7'
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'rubocop', '~> 0.49'
+  spec.add_development_dependency 'pry', '~> 0.10'
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: ukey
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dorian Karter
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: libusb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: A CLI for detecting a USB device removal and locking macOS
+email:
+- jobs@doriankarter.com
+executables:
+- ukey
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/ukey
+- lib/ukey.rb
+- lib/ukey/cli.rb
+- lib/ukey/config.rb
+- lib/ukey/usb_watcher.rb
+- lib/ukey/version.rb
+- ukey.gemspec
+homepage: https://doriankarter.com
+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.8
+signing_key: 
+specification_version: 4
+summary: Watches for USB devices - when removed locks macOS
+test_files: []