botan 0.1.0

data/lib/botan/rng.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+# (c) 2017 Ribose Inc.
+
+require 'ffi'
+
+require 'botan/error'
+require 'botan/ffi/libbotan'
+require 'botan/utils'
+
+module Botan
+  # Random Number Generator
+  class RNG
+    # @api private
+    attr_reader :ptr
+    # @param rng_type [String] the type of RNG to create
+    def initialize(rng_type = nil)
+      ptr = FFI::MemoryPointer.new(:pointer)
+      Botan.call_ffi(:botan_rng_init, ptr, rng_type)
+      ptr = ptr.read_pointer
+      raise Botan::Error, 'botan_rng_init returned NULL' if ptr.null?
+      @ptr = FFI::AutoPointer.new(ptr, self.class.method(:destroy))
+    end
+
+    # @api private
+    def self.destroy(ptr)
+      LibBotan.botan_rng_destroy(ptr)
+    end
+
+    # Retrieves some data from the default RNG.
+    #
+    # @param length [Integer] the number of bytes to retrieve
+    # @return [String]
+    def self.get(length)
+      RNG.new.get(length)
+    end
+
+    # Reseeds the RNG from the system RNG.
+    #
+    # @param bits [Integer] the number of bits to reseed with
+    # @return [self]
+    def reseed(bits = 256)
+      Botan.call_ffi(:botan_rng_reseed, @ptr, bits)
+      self
+    end
+
+    # Retrieves some data from the RNG.
+    #
+    # @param length [Integer] the number of bytes to retrieve
+    # @return [String]
+    def get(length)
+      out_buf = FFI::MemoryPointer.new(:uint8, length)
+      Botan.call_ffi(:botan_rng_get, @ptr, out_buf, length)
+      out_buf.read_bytes(length)
+    end
+
+    def inspect
+      Botan.inspect_ptr(self)
+    end
+  end # class
+end # module
+

data/lib/botan/utils.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+# (c) 2017 Ribose Inc.
+
+require 'ffi'
+
+require 'botan/error'
+require 'botan/ffi/libbotan'
+
+module Botan
+  # Encodes the provided data as a hexadecimal string.
+  #
+  # @param data [String] the data to encode
+  # @return [String] the data as a hexadecimal string
+  def self.hex_encode(data)
+    data.unpack('H*')[0]
+  end
+
+  # Decodes the provided hexadecimal string to a byte string.
+  #
+  # @param hexs [String] the hexadecimal string
+  # @return [String] the decoded data
+  def self.hex_decode(hexs)
+    [hexs].pack('H*')
+  end
+
+  # @api private
+  #
+  # Calls the LibBotan FFI function indicated and returns the return code.
+  # If the return code is <0, an error will be raised.
+  #
+  # @param fn [Symbol] the name of the function to call
+  # @param args the arguments to pass to the FFI function
+  # @return [Integer] the return code
+  def self.call_ffi_rc(fn, *args)
+    rc = LibBotan.method(fn).call(*args)
+    raise Botan::Error, "FFI call to #{fn} failed (rc: #{rc})" if rc.negative?
+    rc
+  end
+
+  # @api private
+  #
+  # Calls the LibBotan FFI function indicated.
+  # If the return code is <0, an error will be raised.
+  #
+  # @param fn [Symbol] the name of the function to call
+  # @param args the arguments to pass to the FFI function
+  # @return [void]
+  def self.call_ffi(fn, *args)
+    call_ffi_rc(fn, *args)
+    nil
+  end
+
+  # @api private
+  #
+  # Calls the LibBotan FFI function indicated
+  # If the return code is <0, an error will be raised.
+  #
+  # @param fn [#call] a proc/lambda taking two parameters.
+  # @param guess [Integer] an initial guess for the buffer size
+  # @param string [Boolean] true if the returned buffer is expected
+  #   to be a NULL-terminated string.
+  # @return [String] the data
+  def self.call_ffi_with_buffer(fn, guess: 4096, string: false)
+    buf = FFI::MemoryPointer.new(:uint8, guess)
+    buf_len_ptr = FFI::MemoryPointer.new(:size_t)
+    buf_len_ptr.write(:size_t, buf.size)
+
+    rc = fn.call(buf, buf_len_ptr)
+    buf_len = buf_len_ptr.read(:size_t)
+    # Call should only fail if buffer was inadequate, and should
+    # only succeed if buffer was adequate.
+    if (rc.negative? && buf_len <= buf.size) || (rc >= 0 && buf_len > buf.size)
+      raise Botan::Error, 'FFI call unexpectedly failed'
+    end
+
+    if rc.negative?
+      return call_ffi_with_buffer(fn, guess: buf_len, string: string)
+    else
+      string ? buf.read_string : buf.read_bytes(buf_len)
+    end
+  end
+
+  # @api private
+  def self.inspect_ptr(myself)
+    ptr_format = "0x%0#{FFI::Pointer.size * 2}x"
+    ptr_s = format(ptr_format, myself.instance_variable_get(:@ptr).address)
+    class_name = myself.class.to_s
+    "#<#{class_name}:#{ptr_s}>"
+  end
+
+  # TODO: Upstream this.
+  unless FFI::MemoryPointer.respond_to?(:from_data)
+    # @api private
+    class << FFI::MemoryPointer
+      def from_data(data)
+        buf = FFI::MemoryPointer.new(:uint8, data.bytesize)
+        buf.write_bytes(data)
+        buf
+      end
+    end
+  end
+end # module
+

data/lib/botan/version.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# (c) 2017 Ribose Inc.
+
+module Botan
+  VERSION = '0.1.0'
+end # module
+

data/lib/botan/x509/certificate.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+# (c) 2017 Ribose Inc.
+
+require 'date'
+require 'ffi'
+
+require 'botan/error'
+require 'botan/ffi/libbotan'
+require 'botan/pk/publickey'
+require 'botan/utils'
+
+module Botan
+  module X509
+    class Certificate
+      def initialize(ptr)
+        if ptr.null?
+          raise Botan::Error, 'X509::Certificate received a NULL pointer'
+        end
+        @ptr = FFI::AutoPointer.new(ptr, self.class.method(:destroy))
+      end
+
+      def self.destroy(ptr)
+        LibBotan.botan_x509_cert_destroy(ptr)
+      end
+
+      def self.from_file(filename)
+        ptr = FFI::MemoryPointer.new(:pointer)
+        Botan.call_ffi(:botan_x509_cert_load_file, ptr, filename)
+        Certificate.new(ptr.read_pointer)
+      end
+
+      def self.from_data(data)
+        ptr = FFI::MemoryPointer.new(:pointer)
+        buf = FFI::MemoryPointer.from_data(data)
+        Botan.call_ffi(:botan_x509_cert_load, ptr, buf, buf.size)
+        Certificate.new(ptr.read_pointer)
+      end
+
+      def time_starts
+        time = Botan.call_ffi_with_buffer(lambda { |b, bl|
+          LibBotan.botan_x509_cert_get_time_starts(@ptr, b, bl)
+        }, guess: 16, string: true)
+        case time.size
+        when 13
+          ::DateTime.strptime(time, '%y%m%d%H%M%SZ')
+        when 15
+          ::DateTime.strptime(time, '%Y%m%d%H%M%SZ')
+        else
+          raise Botan::Error, 'X509::Certificate time_starts invalid format'
+        end
+      end
+
+      def time_expires
+        time = Botan.call_ffi_with_buffer(lambda { |b, bl|
+          LibBotan.botan_x509_cert_get_time_expires(@ptr, b, bl)
+        }, guess: 16, string: true)
+        case time.size
+        when 13
+          ::DateTime.strptime(time, '%y%m%d%H%M%SZ')
+        when 15
+          ::DateTime.strptime(time, '%Y%m%d%H%M%SZ')
+        else
+          raise Botan::Error, 'X509::Certificate time_expires invalid format'
+        end
+      end
+
+      def to_s
+        Botan.call_ffi_with_buffer(lambda { |b, bl|
+          LibBotan.botan_x509_cert_to_string(@ptr, b, bl)
+        }, string: true)
+      end
+
+      def fingerprint(hash_algo = 'SHA-256')
+        n = Botan::Digest.new(hash_algo).length * 3
+        Botan.call_ffi_with_buffer(lambda { |b, bl|
+          LibBotan.botan_x509_cert_get_fingerprint(@ptr, hash_algo, b, bl)
+        }, guess: n, string: true)
+      end
+
+      def serial_number
+        Botan.call_ffi_with_buffer(lambda { |b, bl|
+          LibBotan.botan_x509_cert_get_serial_number(@ptr, b, bl)
+        })
+      end
+
+      def authority_key_id
+        Botan.call_ffi_with_buffer(lambda { |b, bl|
+          LibBotan.botan_x509_cert_get_authority_key_id(@ptr, b, bl)
+        })
+      end
+
+      def subject_key_id
+        Botan.call_ffi_with_buffer(lambda { |b, bl|
+          LibBotan.botan_x509_cert_get_subject_key_id(@ptr, b, bl)
+        })
+      end
+
+      def subject_public_key_bits
+        Botan.call_ffi_with_buffer(lambda { |b, bl|
+          LibBotan.botan_x509_cert_get_public_key_bits(@ptr, b, bl)
+        })
+      end
+
+      def subject_public_key
+        ptr = FFI::MemoryPointer.new(:pointer)
+        Botan.call_ffi(:botan_x509_cert_get_public_key, @ptr, ptr)
+        pub = ptr.read_pointer
+        if pub.null?
+          raise Botan::Error, 'botan_x509_cert_get_public_key returned NULL'
+        end
+        Botan::PK::PublicKey.new(pub)
+      end
+
+      def issuer_info(key, index = 0)
+        Botan.call_ffi_with_buffer(lambda { |b, bl|
+          LibBotan.botan_x509_cert_get_issuer_dn(@ptr, key, index, b, bl)
+        }, string: true)
+      end
+
+      def subject_info(key, index = 0)
+        Botan.call_ffi_with_buffer(lambda { |b, bl|
+          LibBotan.botan_x509_cert_get_subject_dn(@ptr, key, index, b, bl)
+        }, string: true)
+      end
+
+      def allowed_usage?(usage)
+        rc = Botan.call_ffi_rc(:botan_x509_cert_allowed_usage,
+                               @ptr, usage)
+        rc.zero?
+      end
+
+      def inspect
+        Botan.inspect_ptr(self)
+      end
+    end # class
+  end # module
+end # module
+

data/lib/botan/x509/constraints.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# (c) 2017 Ribose Inc.
+
+module Botan
+  module X509
+    module Constraints
+      DECIPHER_ONLY      = 1 << 7
+      ENCIPHER_ONLY      = 1 << 8
+      CRL_SIGN           = 1 << 9
+      KEY_CERT_SIGN      = 1 << 10
+      KEY_AGREEMENT      = 1 << 11
+      DATA_ENCIPHERMENT  = 1 << 12
+      KEY_ENCIPHERMENT   = 1 << 13
+      NON_REPUDIATION    = 1 << 14
+      DIGITAL_SIGNATURE  = 1 << 15
+    end
+  end # module
+end # module
+

metadata

@@ -0,0 +1,197 @@
+--- !ruby/object:Gem::Specification
+name: botan
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ribose Inc.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !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: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+description: 
+email:
+- packaging@ribose.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE.txt
+files:
+- LICENSE.txt
+- README.md
+- lib/botan.rb
+- lib/botan/bcrypt.rb
+- lib/botan/cipher.rb
+- lib/botan/defaults.rb
+- lib/botan/digest.rb
+- lib/botan/error.rb
+- lib/botan/ffi/libbotan.rb
+- lib/botan/kdf.rb
+- lib/botan/mac.rb
+- lib/botan/pk/mceies.rb
+- lib/botan/pk/op/decrypt.rb
+- lib/botan/pk/op/encrypt.rb
+- lib/botan/pk/op/keyagreement.rb
+- lib/botan/pk/op/sign.rb
+- lib/botan/pk/op/verify.rb
+- lib/botan/pk/privatekey.rb
+- lib/botan/pk/publickey.rb
+- lib/botan/rng.rb
+- lib/botan/utils.rb
+- lib/botan/version.rb
+- lib/botan/x509/certificate.rb
+- lib/botan/x509/constraints.rb
+homepage: https://www.ribose.com
+licenses:
+- MIT
+metadata:
+  yard.run: yard
+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.5.2
+signing_key: 
+specification_version: 4
+summary: The Ruby interface for Botan.
+test_files: []