windows-cng 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 81743d0ede2937d8627b6f830d807462eb580083
+  data.tar.gz: 62dcf2ea25fa18cba23315f6ebacbde279d44413
+SHA512:
+  metadata.gz: c35b7b5dba655aeea93616b8d05072e7319d60cb72441a819a733b8f6cadc97da4bf25466e71f73c24ab37068df78fd2ddd54020460384017aea2967a2d5739f
+  data.tar.gz: 9df2e81e27a3a2d8870113da5cc355ebc8f235758a314b78064cd70548e9460e274855dfc29aebd9c7c4f7d1ed112fb3e28c1452fe263bfe97a6f7dcdb197105

data/CHANGES

@@ -0,0 +1,2 @@
+= 0.0.1 - 28-Nov-2014
+* Initial release.

data/MANIFEST

@@ -0,0 +1,8 @@
+* CHANGES
+* Rakefile
+* README
+* windows-cng.gemspec
+* lib/windows/cng.rb
+* lib/windows/cng/constants.rb
+* lib/windows/cng/functions.rb
+* lib/windows/cng/structs.rb

data/README

@@ -0,0 +1,32 @@
+= Description
+  An interface for the Windows Next Generation Cryptography library.
+
+= Installation
+  gem install windows-cng
+
+= Synopsis
+  require 'windows/cng'
+
+  cng = Windows::CNG.new
+  cng.hash('some string')
+  cng.close
+
+= License
+  Artistic 2.0
+
+= Contributions
+  Although this library is free, please consider having your company
+  setup a gittip if used by your company professionally.
+
+  http://www.gittip.com/djberg96/
+    
+= Copyright
+  (C) 2014 Daniel J. Berger, All Rights Reserved
+    
+= Warranty
+  This package is provided "as is" and without any express or
+  implied warranties, including, without limitation, the implied
+  warranties of merchantability and fitness for a particular purpose.
+    
+= Author
+  Daniel J. Berger

data/Rakefile

@@ -0,0 +1,38 @@
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+
+CLEAN.include('**/*.gem', '**/*.log')
+
+namespace 'gem' do
+  desc "Create the windows-cng gem"
+  task :create => [:clean] do
+    Dir["*.gem"].each{ |f| File.delete(f) }
+    spec = eval(IO.read('windows-cng.gemspec'))
+
+    if Gem::VERSION < "2.0"
+      Gem::Builder.new(spec).build
+    else
+      require 'rubygems/package'
+      Gem::Package.build(spec)
+    end
+  end
+  
+  desc "Install the windows-cng gem"
+  task :install => [:create] do
+    file = Dir["*.gem"].first
+    sh "gem install -l #{file}"
+  end
+end
+
+desc "Run the example program"
+task :example do
+  sh "ruby -Ilib examples/dir_example.rb"
+end
+
+Rake::TestTask.new do |t|
+  t.warning = true
+  t.verbose = true
+end
+
+task :default => :test

data/lib/windows/cng.rb

@@ -0,0 +1,168 @@
+require_relative 'cng/constants'
+require_relative 'cng/functions'
+require_relative 'cng/structs'
+require_relative 'cng/helper'
+
+module Windows
+  class CNG
+    include Windows::CNGConstants
+    include Windows::CNGFunctions
+    include Windows::MiscFunctions
+    include Windows::CNGStructs
+    include Windows::CNGHelper
+
+    # The version of the windows-cng library.
+    VERSION = '0.0.1'
+
+    # Creates and returns a new Windows::CNG object.
+    #
+    # The +algorithm+ argument specifies the type of algorithm to use for the
+    # various crypto methods. The default is SHA256.
+    #
+    # The +implementation+ identifies the specific provider to load. This is
+    # the registered alias of the cryptographic primitive provider. By default
+    # this is nil.
+    #
+    # The flags argument can be one or more of the following values:
+    #
+    # * BCRYPT_ALG_HANDLE_HMAC_FLAG
+    # * BCRYPT_PROV_DISPATCH
+    # * BCRYPT_HASH_REUSABLE_FLAG
+    #
+    # See the MSDN documentation for details of what each flag does.
+    #
+    def initialize(algorithm = BCRYPT_SHA256_ALGORITHM, implementation = nil, flags = 0)
+      @algorithm = algorithm.wincode
+      @implementation = implementation ? implementation.wincode : implementation
+      @flags = flags
+
+      ptr = FFI::MemoryPointer.new(:pointer)
+
+      status = BCryptOpenAlgorithmProvider(
+        ptr,
+        @algorithm,
+        @implementation,
+        @flags
+      )
+
+      if status != 0
+        raise SystemCallError.new('BCryptOpenAlgorithmProvider', status)
+      end
+
+      @handle = ptr.read_pointer
+
+      ObjectSpace.define_finalizer(self, self.class.finalize(@handle))
+    end
+
+    # Returns a hash of +data+ using the algorithm used in the constructor.
+    #
+    def hash(data)
+      cbhash_object = FFI::MemoryPointer.new(:ulong)
+      cbdata = FFI::MemoryPointer.new(:ulong)
+
+      status = BCryptGetProperty(
+        @handle,
+        BCRYPT_OBJECT_LENGTH.wincode,
+        cbhash_object,
+        cbhash_object.size,
+        cbdata,
+        0
+      )
+
+      if status != 0
+        raise SystemCallError.new('BCryptGetProperty', status)
+      end
+
+      begin
+        pbhash_object = HeapAlloc(GetProcessHeap(), 0, cbhash_object.read_ulong)
+
+        if pbhash_object.null?
+          raise SystemCallError.new('HeapAlloc', FFI.errno)
+        end
+
+        cbhash = FFI::MemoryPointer.new(:ulong)
+        cbdata.clear
+
+        status = BCryptGetProperty(
+          @handle,
+          BCRYPT_HASH_LENGTH.wincode,
+          cbhash,
+          cbhash.size,
+          cbdata,
+          0
+        )
+
+        if status != 0
+          raise SystemCallError.new('BCryptGetProperty', status)
+        end
+
+        cbhash = cbhash.read_ulong
+        pbhash = HeapAlloc(GetProcessHeap(), 0, cbhash)
+
+        if pbhash.null?
+          raise SystemCallError.new('HeapAlloc', FFI.errno)
+        end
+
+        ptr = FFI::MemoryPointer.new(:pointer)
+
+        status = BCryptCreateHash(
+          @handle,
+          ptr,
+          pbhash_object,
+          cbhash_object.read_ulong,
+          nil,
+          0,
+          0
+        )
+
+        if status != 0
+          raise SystemCallError.new('BCryptCreateHash', status)
+        end
+
+        hhash = ptr.read_pointer
+
+        status = BCryptHashData(hhash, data, data.size, 0)
+
+        if status != 0
+          raise SystemCallError.new('BCryptHashData', status)
+        end
+
+        status = BCryptFinishHash(hhash, pbhash, cbhash, 0)
+
+        if status != 0
+          raise SystemCallError.new('BCryptFinishHash', status)
+        end
+
+        pbhash.read_bytes(cbhash)
+      ensure
+        if pbhash_object && !pbhash_object.null?
+          HeapFree(GetProcessHeap(), 0, pbhash_object)
+        end
+
+        if pbhash && !pbhash.null?
+          HeapFree(GetProcessHeap(), 0, pbhash)
+        end
+      end
+    end
+
+    # Closes the windows-cng object. This is not explicitly required, since
+    # it will automatically be called once your object goes out of scope, but
+    # it is good form.
+    #
+    def close
+      status = BCryptCloseAlgorithmProvider(@handle, 0)
+
+      if status != 0
+        raise SystemCallError.new('BCryptCloseAlgorithmProvider', status)
+      end
+    end
+
+    private
+
+    # Automatically close crypto object when it goes out of scope.
+    #
+    def self.finalize(handle)
+      proc{ BCryptCloseAlgorithmProvider(handle, 0) }
+    end
+  end
+end

data/lib/windows/cng/constants.rb

@@ -0,0 +1,55 @@
+module Windows
+  module CNGConstants
+    # NTSTATUS values
+    STATUS_SUCCESS                = 0x00000000
+    STATUS_SEVERITY_SUCCESS       = 0x00000000
+    STATUS_SEVERITY_INFORMATIONAL = 0x00000001
+    STATUS_SEVERITY_WARNING       = 0x00000002
+    STATUS_SEVERITY_ERROR         = 0x00000003
+
+    # CNG Algorithm Identifiers
+    BCRYPT_3DES_ALGORITHM               = "3DES"
+    BCRYPT_3DES_112_ALGORITHM           = "3DES_112"
+    BCRYPT_AES_ALGORITHM                = "AES"
+    BCRYPT_AES_CMAC_ALGORITHM           = "AES-CMAC"
+    BCRYPT_AES_GMAC_ALGORITHM           = "AES-GMAC"
+    BCRYPT_CAPI_KDF_ALGORITHM           = "CAPI_KDF"
+    BCRYPT_DES_ALGORITHM                = "DES"
+    BCRYPT_DESX_ALGORITHM               = "DESX"
+    BCRYPT_DH_ALGORITHM                 = "DH"
+    BCRYPT_DSA_ALGORITHM                = "DSA"
+    BCRYPT_ECDH_P256_ALGORITHM          = "ECDH_P256"
+    BCRYPT_ECDH_P384_ALGORITHM          = "ECDH_P384"
+    BCRYPT_ECDH_P521_ALGORITHM          = "ECDH_P521"
+    BCRYPT_ECDSA_P256_ALGORITHM         = "ECDSA_P256"
+    BCRYPT_ECDSA_P384_ALGORITHM         = "ECDSA_P384"
+    BCRYPT_ECDSA_P521_ALGORITHM         = "ECDSA_P521"
+    BCRYPT_MD2_ALGORITHM                = "MD2"
+    BCRYPT_MD4_ALGORITHM                = "MD4"
+    BCRYPT_MD5_ALGORITHM                = "MD5"
+    BCRYPT_RC2_ALGORITHM                = "RC2"
+    BCRYPT_RC4_ALGORITHM                = "RC4"
+    BCRYPT_RNG_ALGORITHM                = "RNG"
+    BCRYPT_RNG_DUAL_EC_ALGORITHM        = "DUALECRNG"
+    BCRYPT_RNG_FIPS186_DSA_ALGORITHM    = "FIPS186DSARNG"
+    BCRYPT_RSA_ALGORITHM                = "RSA"
+    BCRYPT_RSA_SIGN_ALGORITHM           = "RSA_SIGN"
+    BCRYPT_SHA1_ALGORITHM               = "SHA1"
+    BCRYPT_SHA256_ALGORITHM             = "SHA256"
+    BCRYPT_SHA384_ALGORITHM             = "SHA384"
+    BCRYPT_SHA512_ALGORITHM             = "SHA512"
+    BCRYPT_SP800108_CTR_HMAC_ALGORITHM  = "SP800_108_CTR_HMAC"
+    BCRYPT_SP80056A_CONCAT_ALGORITHM    = "SP800_56A_CONCAT"
+    BCRYPT_PBKDF2_ALGORITHM             = "PBKDF2"
+
+    # Primitive Property Identifiers. Encode as necessary.
+    BCRYPT_ALGORITHM_NAME     = "AlgorithmName"
+    BCRYPT_AUTH_TAG_LENGTH    = "AuthTagLength"
+    BCRYPT_BLOCK_LENGTH       = "BlockLength"
+    BCRYPT_OBJECT_LENGTH      = "ObjectLength"
+    BCRYPT_BLOCK_SIZE_LIST    = "BlockSizeList"
+    BCRYPT_CHAINING_MODE      = "ChainingMode"
+    BCRYPT_HASH_BLOCK_LENGTH  = "HashBlockLength"
+    BCRYPT_HASH_LENGTH        = "HashDigestLength"
+  end
+end

data/lib/windows/cng/functions.rb

@@ -0,0 +1,146 @@
+require 'ffi'
+
+module Windows
+  module MiscFunctions
+    extend FFI::Library
+    ffi_lib :kernel32
+
+    typedef :uintptr_t, :handle
+    typedef :ulong, :dword
+
+    attach_function :HeapAlloc, [:handle, :dword, :size_t], :pointer
+    attach_function :HeapFree, [:handle, :dword, :pointer], :bool
+    attach_function :GetProcessHeap, [], :handle
+  end
+
+  module SSLProviderFunctions
+  end
+
+  module KeyStorageFunctions
+  end
+
+  module HelperFunctions
+  end
+
+  module DPAPIFunctions
+    extend FFI::Library
+    ffi_lib :ncrypt
+
+    typedef :uintptr_t, :handle
+    typedef :ulong, :ntstatus
+    typedef :ulong, :dword
+
+    # CNG Data Protection API Functions - Windows 8 or later
+
+    #attach_function :NCryptCreateProtectionDescriptor, [:buffer_in, :dword, :pointer], :ntstatus
+    #attach_function :NCryptCloseProtectionDescriptor
+    #attach_function :NCryptGetProtectionDescriptorInfo
+    #attach_function :NCryptProtectSecret
+    #attach_function :NCryptQueryProtectionDescriptorName
+    #attach_function :NCryptRegisterProtectionDescriptorName
+    #attach_function :NCryptStreamClose
+    #attach_function :NCryptStreamOpenToProtect
+    #attach_function :NCryptStreamOpenToUnProtect
+    #attach_function :NCryptStreamUpdate
+    #attach_function :NCryptUnprotectSecret
+    #attach_function :PFNCryptStreamOutputCallback
+  end
+
+  module CNGFunctions
+    extend FFI::Library
+    ffi_lib :bcrypt
+
+    typedef :long, :ntstatus
+
+    ## CNG Cryptographic Primitive Functions
+
+    attach_function :BCryptCloseAlgorithmProvider,
+      [:pointer, :ulong],
+      :ntstatus
+
+    attach_function :BCryptCreateHash,
+      [:pointer, :pointer, :pointer, :ulong, :pointer, :ulong, :ulong],
+      :ntstatus
+
+    attach_function :BCryptDecrypt,
+      [:pointer, :pointer, :ulong, :pointer, :pointer, :ulong, :pointer, :ulong, :ulong, :ulong],
+      :ntstatus
+
+    attach_function :BCryptDeriveKey,
+      [:pointer, :string, :pointer, :pointer, :ulong, :ulong, :ulong],
+      :ntstatus
+
+    attach_function :BCryptDestroyHash, [:pointer], :ntstatus
+    attach_function :BCryptDestroyKey, [:pointer], :ntstatus
+    attach_function :BCryptDestroySecret, [:pointer], :ntstatus
+
+    attach_function :BCryptDuplicateHash,
+      [:pointer, :pointer, :pointer, :ulong, :ulong],
+      :ntstatus
+
+    attach_function :BCryptDuplicateKey,
+      [:pointer, :pointer, :pointer, :ulong, :ulong],
+      :ntstatus
+
+    attach_function :BCryptEncrypt,
+      [:pointer, :pointer, :ulong, :pointer, :pointer, :ulong, :pointer, :ulong, :ulong, :ulong],
+      :ntstatus
+
+    attach_function :BCryptExportKey,
+      [:pointer, :pointer, :string, :pointer, :ulong, :ulong, :ulong],
+      :ntstatus
+
+    attach_function :BCryptFinalizeKeyPair, [:pointer, :ulong], :ntstatus
+    attach_function :BCryptFinishHash, [:pointer, :pointer, :ulong, :ulong], :ntstatus
+    attach_function :BCryptFreeBuffer, [:pointer], :void
+    attach_function :BCryptGenerateKeyPair, [:pointer, :pointer, :ulong, :ulong], :ntstatus
+
+    attach_function :BCryptGenerateSymmetricKey,
+      [:pointer, :pointer, :pointer, :ulong, :pointer, :ulong, :ulong],
+      :ntstatus
+
+    attach_function :BCryptGenRandom, [:pointer, :pointer, :ulong, :ulong], :ntstatus
+
+    attach_function :BCryptGetProperty,
+      [:pointer, :buffer_in, :pointer, :ulong, :pointer, :ulong],
+      :ntstatus
+
+    attach_function :BCryptHashData, [:pointer, :pointer, :ulong, :ulong], :ntstatus
+
+    attach_function :BCryptImportKey,
+      [:pointer, :pointer, :string, :pointer, :pointer, :ulong, :pointer, :ulong, :ulong],
+      :ntstatus
+
+    attach_function :BCryptImportKeyPair,
+      [:pointer, :pointer, :string, :pointer, :pointer, :ulong, :ulong],
+      :ntstatus
+
+    attach_function :BCryptOpenAlgorithmProvider,
+      [:pointer, :buffer_in, :buffer_in, :ulong],
+      :ntstatus
+
+    attach_function :BCryptSecretAgreement,
+      [:pointer, :pointer, :pointer, :ulong],
+      :ntstatus
+
+    attach_function :BCryptSetProperty,
+      [:pointer, :string, :pointer, :ulong, :ulong],
+      :ntstatus
+
+    attach_function :BCryptSignHash,
+      [:pointer, :pointer, :pointer, :ulong, :pointer, :ulong, :pointer, :ulong],
+      :ntstatus
+
+    attach_function :BCryptVerifySignature,
+      [:pointer, :pointer, :pointer, :ulong, :pointer, :ulong, :ulong],
+      :ntstatus
+
+    begin
+      attach_function :BCryptKeyDerivation,
+        [:pointer, :pointer, :pointer, :ulong, :pointer, :ulong],
+        :ntstatus
+    rescue FFI::NotFoundError
+      # Windows 8 or later
+    end
+  end
+end

data/lib/windows/cng/helper.rb

@@ -0,0 +1,14 @@
+module Windows
+  module CNGHelper
+  end
+end
+
+class String
+  unless instance_methods.include?(:wincode)
+    # Convenience method for converting strings to UTF-16LE for wide character
+    # functions that require it.
+    def wincode
+      (self.tr(File::SEPARATOR, File::ALT_SEPARATOR) + 0.chr).encode('UTF-16LE')
+    end
+  end
+end

data/lib/windows/cng/structs.rb

@@ -0,0 +1,4 @@
+module Windows
+  module CNGStructs
+  end
+end

data/test/test_windows_cng.rb

@@ -0,0 +1,16 @@
+require 'test-unit'
+require 'windows/cng'
+
+class TC_Windows_CNG < Test::Unit::TestCase
+  def setup
+    @cng = Windows::CNG.new
+  end
+
+  test "version number is set to correct value" do
+    assert_equal("0.0.1", Windows::CNG::VERSION)
+  end
+
+  def teardown
+    @cng.close
+  end
+end

data/windows-cng.gemspec

@@ -0,0 +1,25 @@
+require 'rubygems'
+
+Gem::Specification.new do |spec|
+  spec.name      = 'windows-cng'
+  spec.version   = '0.0.1'
+  spec.author    = 'Daniel J. Berger'
+  spec.license   = 'Artistic 2.0'
+  spec.email     = 'djberg96@gmail.com'
+  spec.homepage  = 'http://github.com/djberg96/windows-cng'
+  spec.summary   = 'A Ruby interface to the next gen Windows crypto library'
+  spec.test_file = 'test/test_windows_cng.rb'
+  spec.files     = Dir['**/*'].reject{ |f| f.include?('git') }
+
+  spec.extra_rdoc_files  = ['README', 'CHANGES', 'MANIFEST']
+
+  spec.add_dependency('ffi')
+
+  spec.add_development_dependency('rake')
+  spec.add_development_dependency('test-unit')
+
+  spec.description = <<-EOF
+    The windows-cng library is a wrapper for the next generation Windows
+    cryptography API.
+  EOF
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: windows-cng
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Daniel J. Berger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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: test-unit
+  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'
+description: |2
+      The windows-cng library is a wrapper for the next generation Windows
+      cryptography API.
+email: djberg96@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README
+- CHANGES
+- MANIFEST
+files:
+- CHANGES
+- MANIFEST
+- README
+- Rakefile
+- lib/windows/cng.rb
+- lib/windows/cng/constants.rb
+- lib/windows/cng/functions.rb
+- lib/windows/cng/helper.rb
+- lib/windows/cng/structs.rb
+- test/test_windows_cng.rb
+- windows-cng.gemspec
+homepage: http://github.com/djberg96/windows-cng
+licenses:
+- Artistic 2.0
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A Ruby interface to the next gen Windows crypto library
+test_files:
+- test/test_windows_cng.rb