cisco_scrypt 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 754d755c61852c27030fd6bd224593b72d1545416e61ca780b7e374832491378
+  data.tar.gz: 076dd98fa98cb73024f75eb5eb3a9dc93600371a39a692cd6473c083a069bc65
+SHA512:
+  metadata.gz: c84c8fa19ad67e53fabf019148dd7284181fd8a830357b1192e32ec70eaf0090c12cdf9fe1afb1919f3ebff4cb4a56df7eab88e4bc631b504bde2307cf366f4e
+  data.tar.gz: a5ee8093b7c80f83cc39dcaaea7396447cf96a95ac47dacecedd0000ee88bfae9c1e64edac432994e6233e246356ebf2a64215b8231f25397f00346b3c22d89c

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,15 @@
+AllCops:
+  TargetRubyVersion: 2.5
+  NewCops: enable
+  SuggestExtensions: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in cisco_scrypt.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.7"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Marek Skrobacki
+
+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,41 @@
+# CiscoScrypt
+
+Generate Cisco Type 9 password hashes with Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cisco_scrypt'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install cisco_scrypt
+
+## Usage
+
+```ruby
+>> CiscoScrypt.generate('myversyecret password', 'saltsalt')
+=> "$9$saltsalt$lEiBF6Jbcf2.hTsVwdsgxku5qa3X3PqFq.z4ta.BBLI"
+>>
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/skrobul/cisco_scrypt.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require 'yard'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+YARD::Rake::YardocTask.new do |t|
+ t.files   = ['lib/**/*.rb']
+ # t.stats_options = ['--list-undoc']         # optional
+end
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "cisco_scrypt"
+
+# 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/cisco_scrypt.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "lib/cisco_scrypt/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "cisco_scrypt"
+  spec.version       = CiscoScrypt::VERSION
+  spec.authors       = ["Marek Skrobacki"]
+  spec.email         = ["skrobul@skrobul.com"]
+
+  spec.summary       = "Generate Cisco type 9 password hashes"
+  spec.description   = "Generate Cisco type 9 password hashes, optionally with fixed salt."
+  spec.homepage      = "https://github.com/skrobul/cisco_scrypt"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.5.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+   spec.add_development_dependency "yard", "~> 0.9"
+end

data/lib/cisco_scrypt/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CiscoScrypt
+  VERSION = "0.1.0"
+end

data/lib/cisco_scrypt.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require "openssl"
+require_relative "cisco_scrypt/version"
+
+# Generate Cisco type 9 password hashes
+module CiscoScrypt
+  class Error < StandardError; end
+  class << self
+    # Based on the John The Ripper
+    # https://github.com/openwall/john/blob/186c9ae1e421618962a7446fa22f9d678cd6b0a9/run/pass_gen.pl#L994
+    # https://github.com/videgro/cisco-password-hashes
+    # @!visibility private
+    def crypt_to64_wpa(value, number_of_iterations)
+      itoa64 = "./0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz"
+      result = +""
+      number_of_iterations.times do
+        position = (value & 0xFC0000) >> 18
+        result << itoa64[position]
+        value = value << 6
+      end
+      result
+    end
+
+    # Cisco uses non-standard base64 encoding, which happens to be the same
+    # implementation as used for WPA passwords.
+    #
+    # @!visibility private
+    # rubocop: disable Metrics/MethodLength
+    def base64_wpa(byte_string)
+      len = byte_string.size
+      mod = len % 3
+      cnt = (len - mod) / 3
+      out = +""
+
+      # iterate over "full" bytes, 3 bytes at a time
+      # encode every 3 sextets as 4 sextets
+      cnt.times do |idx|
+        out << full_bytes(byte_string, idx)
+      end
+
+      case mod
+      when 2 then out << two_bytes(byte_string, len)
+      when 1 then out << single_byte(byte_string, len)
+      end
+      out
+    end
+    # rubocop: enable Metrics/MethodLength
+
+    # @!visibility private
+    def full_bytes(byte_string, idx)
+      offset = idx * 3
+      c = byte_string[offset].ord
+      b = byte_string[offset + 1].ord
+      a = byte_string[offset + 2].ord
+      l = ((c << 16) | (b << 8) | a)
+      crypt_to64_wpa(l, 4)
+    end
+
+    # @!visibility private
+    def single_byte(byte_string, len)
+      c = byte_string[len - 1].ord
+      l = c << 16
+      crypt_to64_wpa(l, 2)
+    end
+
+    # @!visibility private
+    def two_bytes(byte_string, len)
+      c = byte_string[len - 2].ord
+      b = byte_string[len - 1].ord
+      l = ((c << 16) | (b << 8))
+      crypt_to64_wpa(l, 3)
+    end
+
+    # Generate Cisco Type 9 password hash
+    # @param password [String] cleartext password
+    # @param salt [String] static salt to be used
+    def generate(password, salt)
+      bytes = OpenSSL::KDF.scrypt(password, N: 2**14, r: 1, p: 1, salt: salt, length: 32)
+      password_hash = base64_wpa(bytes)
+
+      "$9$#{salt}$#{password_hash}"
+    end
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: cisco_scrypt
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marek Skrobacki
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-11-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Generate Cisco type 9 password hashes, optionally with fixed salt.
+email:
+- skrobul@skrobul.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cisco_scrypt.gemspec
+- lib/cisco_scrypt.rb
+- lib/cisco_scrypt/version.rb
+homepage: https://github.com/skrobul/cisco_scrypt
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/skrobul/cisco_scrypt
+  source_code_uri: https://github.com/skrobul/cisco_scrypt
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Generate Cisco type 9 password hashes
+test_files: []