czmq-ffi-gen 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a13b3283c23574dcb273bb0cceb1e1dea053a3ae
-  data.tar.gz: 5f53828a3de118cbccdaad5c48158f919b1a7767
+  metadata.gz: d73add1339edd404b96de5b47ff0e7513dff7fe2
+  data.tar.gz: 3b973b9f975f49eadc315eab5c7ac0b24e25e3f9
 SHA512:
-  metadata.gz: 1722efb1d34de52a034f0395b6dfefca180e6106d91c9cb7d498500a20141f3fae8e3e4793690a751acc68da2a354be976202cf2b0699ac37e2a0d27843ce9a7
-  data.tar.gz: 988aab153814bf5d9cdf9c511eee3bb134456df30f8951778c66933ff5c20ba721d28bddbf3be93a9efe28d186b5f6d7c4b9ef230d14400bfdec1efc8e86ac10
+  metadata.gz: 3bfddad065f3a2359bffe941773e4d7c24a36faac3f212d8fa9ac0ef2054fa0ceb41acbc9bd01e87b865af954d999ad087188ac61253c6d74aa90ac5d8f05cd5
+  data.tar.gz: 724a03ba6f49474f9080ce6ccae8b8d6da4d6966d7b41758b6c93f2cdfbdfa2cb739fa39a13c496d8b78a6d5015e224f89c3d3dcd7d5c27e0dc98d343c968e35

data/CHANGES.md

@@ -1,3 +1,10 @@
+0.2.0 (12/10/2015)
+-----
+* using new CZMQ version which
+  - fixes some security issues
+  - adds Zcert and Zcertstore
+* basic specs for each Zclass added
+
 0.1.1 (12/09/2015)
 -----
 * include some auxiliary files like CHANGES.md, LICENSE, and README.md into gem

data/lib/czmq-ffi-gen/czmq/ffi/zcert.rb

@@ -0,0 +1,296 @@
+################################################################################
+#  THIS FILE IS 100% GENERATED BY ZPROJECT; DO NOT EDIT EXCEPT EXPERIMENTALLY  #
+#  Please refer to the README for information about making permanent changes.  #
+################################################################################
+
+module CZMQ
+  module FFI
+
+    # zcert - work with CURVE security certificates
+    # @note This class is 100% generated using zproject.
+    class Zcert
+      # Raised when one tries to use an instance of {Zcert} after
+      # the internal pointer to the native object has been nullified.
+      class DestroyedError < RuntimeError; end
+
+      # Boilerplate for self pointer, initializer, and finalizer
+      class << self
+        alias :__new :new
+      end
+      # Attaches the pointer _ptr_ to this instance and defines a finalizer for
+      # it if necessary.
+      # @param ptr [::FFI::Pointer]
+      # @param finalize [Boolean]
+      def initialize(ptr, finalize = true)
+        @ptr = ptr
+        if @ptr.null?
+          @ptr = nil # Remove null pointers so we don't have to test for them.
+        elsif finalize
+          @finalizer = self.class.create_finalizer_for @ptr
+          ObjectSpace.define_finalizer self, @finalizer
+        end
+      end
+      # @param ptr [::FFI::Pointer]
+      # @return [Proc]
+      def self.create_finalizer_for(ptr)
+        Proc.new do
+          ptr_ptr = ::FFI::MemoryPointer.new :pointer
+          ptr_ptr.write_pointer ptr
+          ::CZMQ::FFI.zcert_destroy ptr_ptr
+        end
+      end
+      # @return [Boolean]
+      def null?
+        !@ptr or @ptr.null?
+      end
+      # Return internal pointer
+      # @return [::FFI::Pointer]
+      def __ptr
+        raise DestroyedError unless @ptr
+        @ptr
+      end
+      # So external Libraries can just pass the Object to a FFI function which expects a :pointer
+      alias_method :to_ptr, :__ptr
+      # Nullify internal pointer and return pointer pointer.
+      # @note This detaches the current instance from the native object
+      #   and thus makes it unusable.
+      # @return [::FFI::MemoryPointer] the pointer pointing to a pointer
+      #   pointing to the native object
+      def __ptr_give_ref
+        raise DestroyedError unless @ptr
+        ptr_ptr = ::FFI::MemoryPointer.new :pointer
+        ptr_ptr.write_pointer @ptr
+        ObjectSpace.undefine_finalizer self if @finalizer
+        @finalizer = nil
+        @ptr = nil
+        ptr_ptr
+      end
+
+      # Create and initialize a new certificate in memory
+      # @return [CZMQ::Zcert]
+      def self.new()
+        ptr = ::CZMQ::FFI.zcert_new()
+        __new ptr
+      end
+
+      # Accepts public/secret key pair from caller
+      # @param public_key [::FFI::Pointer, #to_ptr]
+      # @param secret_key [::FFI::Pointer, #to_ptr]
+      # @return [CZMQ::Zcert]
+      def self.new_from(public_key, secret_key)
+        ptr = ::CZMQ::FFI.zcert_new_from(public_key, secret_key)
+        __new ptr
+      end
+
+      # Load certificate from file
+      # @param filename [String, #to_str, #to_s]
+      # @return [CZMQ::Zcert]
+      def self.load(filename)
+        filename = String(filename)
+        ptr = ::CZMQ::FFI.zcert_load(filename)
+        __new ptr
+      end
+
+      # Destroy a certificate in memory
+      #
+      # @return [void]
+      def destroy()
+        return unless @ptr
+        self_p = __ptr_give_ref
+        result = ::CZMQ::FFI.zcert_destroy(self_p)
+        result
+      end
+
+      # Return public part of key pair as 32-byte binary string
+      #
+      # @return [::FFI::Pointer]
+      def public_key()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zcert_public_key(self_p)
+        result
+      end
+
+      # Return secret part of key pair as 32-byte binary string
+      #
+      # @return [::FFI::Pointer]
+      def secret_key()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zcert_secret_key(self_p)
+        result
+      end
+
+      # Return public part of key pair as Z85 armored string
+      #
+      # @return [::FFI::Pointer]
+      def public_txt()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zcert_public_txt(self_p)
+        result
+      end
+
+      # Return secret part of key pair as Z85 armored string
+      #
+      # @return [::FFI::Pointer]
+      def secret_txt()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zcert_secret_txt(self_p)
+        result
+      end
+
+      # Set certificate metadata from formatted string.
+      #
+      # @param name [String, #to_str, #to_s]
+      # @param format [String, #to_str, #to_s]
+      # @param args [Array<Object>] see https://github.com/ffi/ffi/wiki/examples#using-varargs
+      # @return [void]
+      def set_meta(name, format, *args)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        name = String(name)
+        format = String(format)
+        result = ::CZMQ::FFI.zcert_set_meta(self_p, name, format, *args)
+        result
+      end
+
+      # Get metadata value from certificate; if the metadata value doesn't
+      # exist, returns NULL.                                              
+      #
+      # @param name [String, #to_str, #to_s]
+      # @return [::FFI::Pointer]
+      def meta(name)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        name = String(name)
+        result = ::CZMQ::FFI.zcert_meta(self_p, name)
+        result
+      end
+
+      # Get list of metadata fields from certificate. Caller is responsible for
+      # destroying list. Caller should not modify the values of list items.    
+      #
+      # @return [Zlist]
+      def meta_keys()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zcert_meta_keys(self_p)
+        result = Zlist.__new result, false
+        result
+      end
+
+      # Save full certificate (public + secret) to file for persistent storage  
+      # This creates one public file and one secret file (filename + "_secret").
+      #
+      # @param filename [String, #to_str, #to_s]
+      # @return [Integer]
+      def save(filename)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        filename = String(filename)
+        result = ::CZMQ::FFI.zcert_save(self_p, filename)
+        result
+      end
+
+      # Save public certificate only to file for persistent storage
+      #
+      # @param filename [String, #to_str, #to_s]
+      # @return [Integer]
+      def save_public(filename)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        filename = String(filename)
+        result = ::CZMQ::FFI.zcert_save_public(self_p, filename)
+        result
+      end
+
+      # Save secret certificate only to file for persistent storage
+      #
+      # @param filename [String, #to_str, #to_s]
+      # @return [Integer]
+      def save_secret(filename)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        filename = String(filename)
+        result = ::CZMQ::FFI.zcert_save_secret(self_p, filename)
+        result
+      end
+
+      # Apply certificate to socket, i.e. use for CURVE security on socket.
+      # If certificate was loaded from public file, the secret key will be 
+      # undefined, and this certificate will not work successfully.        
+      #
+      # @param zocket [::FFI::Pointer, #to_ptr]
+      # @return [void]
+      def apply(zocket)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zcert_apply(self_p, zocket)
+        result
+      end
+
+      # Return copy of certificate; if certificate is NULL or we exhausted
+      # heap memory, returns NULL.                                        
+      #
+      # @return [Zcert]
+      def dup()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zcert_dup(self_p)
+        result = Zcert.__new result, true
+        result
+      end
+
+      # Return true if two certificates have the same keys
+      #
+      # @param compare [Zcert, #__ptr]
+      # @return [Boolean]
+      def eq(compare)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        compare = compare.__ptr if compare
+        result = ::CZMQ::FFI.zcert_eq(self_p, compare)
+        result
+      end
+
+      # Print certificate contents to stdout
+      #
+      # @return [void]
+      def print()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zcert_print(self_p)
+        result
+      end
+
+      # DEPRECATED as incompatible with centralized logging
+      # Print certificate contents to open stream          
+      #
+      # @param file [::FFI::Pointer, #to_ptr]
+      # @return [void]
+      def fprint(file)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zcert_fprint(self_p, file)
+        result
+      end
+
+      # Self test of this class
+      #
+      # @param verbose [Boolean]
+      # @return [void]
+      def self.test(verbose)
+        verbose = !(0==verbose||!verbose) # boolean
+        result = ::CZMQ::FFI.zcert_test(verbose)
+        result
+      end
+    end
+  end
+end
+
+################################################################################
+#  THIS FILE IS 100% GENERATED BY ZPROJECT; DO NOT EDIT EXCEPT EXPERIMENTALLY  #
+#  Please refer to the README for information about making permanent changes.  #
+################################################################################

data/lib/czmq-ffi-gen/czmq/ffi/zcertstore.rb

@@ -0,0 +1,160 @@
+################################################################################
+#  THIS FILE IS 100% GENERATED BY ZPROJECT; DO NOT EDIT EXCEPT EXPERIMENTALLY  #
+#  Please refer to the README for information about making permanent changes.  #
+################################################################################
+
+module CZMQ
+  module FFI
+
+    # zcertstore - work with CURVE security certificate stores
+    # @note This class is 100% generated using zproject.
+    class Zcertstore
+      # Raised when one tries to use an instance of {Zcertstore} after
+      # the internal pointer to the native object has been nullified.
+      class DestroyedError < RuntimeError; end
+
+      # Boilerplate for self pointer, initializer, and finalizer
+      class << self
+        alias :__new :new
+      end
+      # Attaches the pointer _ptr_ to this instance and defines a finalizer for
+      # it if necessary.
+      # @param ptr [::FFI::Pointer]
+      # @param finalize [Boolean]
+      def initialize(ptr, finalize = true)
+        @ptr = ptr
+        if @ptr.null?
+          @ptr = nil # Remove null pointers so we don't have to test for them.
+        elsif finalize
+          @finalizer = self.class.create_finalizer_for @ptr
+          ObjectSpace.define_finalizer self, @finalizer
+        end
+      end
+      # @param ptr [::FFI::Pointer]
+      # @return [Proc]
+      def self.create_finalizer_for(ptr)
+        Proc.new do
+          ptr_ptr = ::FFI::MemoryPointer.new :pointer
+          ptr_ptr.write_pointer ptr
+          ::CZMQ::FFI.zcertstore_destroy ptr_ptr
+        end
+      end
+      # @return [Boolean]
+      def null?
+        !@ptr or @ptr.null?
+      end
+      # Return internal pointer
+      # @return [::FFI::Pointer]
+      def __ptr
+        raise DestroyedError unless @ptr
+        @ptr
+      end
+      # So external Libraries can just pass the Object to a FFI function which expects a :pointer
+      alias_method :to_ptr, :__ptr
+      # Nullify internal pointer and return pointer pointer.
+      # @note This detaches the current instance from the native object
+      #   and thus makes it unusable.
+      # @return [::FFI::MemoryPointer] the pointer pointing to a pointer
+      #   pointing to the native object
+      def __ptr_give_ref
+        raise DestroyedError unless @ptr
+        ptr_ptr = ::FFI::MemoryPointer.new :pointer
+        ptr_ptr.write_pointer @ptr
+        ObjectSpace.undefine_finalizer self if @finalizer
+        @finalizer = nil
+        @ptr = nil
+        ptr_ptr
+      end
+
+      # Create a new certificate store from a disk directory, loading and        
+      # indexing all certificates in that location. The directory itself may be  
+      # absent, and created later, or modified at any time. The certificate store
+      # is automatically refreshed on any zcertstore_lookup() call. If the       
+      # location is specified as NULL, creates a pure-memory store, which you    
+      # can work with by inserting certificates at runtime.                      
+      # @param location [String, #to_str, #to_s]
+      # @return [CZMQ::Zcertstore]
+      def self.new(location)
+        location = String(location)
+        ptr = ::CZMQ::FFI.zcertstore_new(location)
+        __new ptr
+      end
+
+      # Destroy a certificate store object in memory. Does not affect anything
+      # stored on disk.                                                       
+      #
+      # @return [void]
+      def destroy()
+        return unless @ptr
+        self_p = __ptr_give_ref
+        result = ::CZMQ::FFI.zcertstore_destroy(self_p)
+        result
+      end
+
+      # Look up certificate by public key, returns zcert_t object if found,
+      # else returns NULL. The public key is provided in Z85 text format.  
+      #
+      # @param public_key [String, #to_str, #to_s]
+      # @return [Zcert]
+      def lookup(public_key)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        public_key = String(public_key)
+        result = ::CZMQ::FFI.zcertstore_lookup(self_p, public_key)
+        result = Zcert.__new result, false
+        result
+      end
+
+      # Insert certificate into certificate store in memory. Note that this
+      # does not save the certificate to disk. To do that, use zcert_save()
+      # directly on the certificate. Takes ownership of zcert_t object.    
+      #
+      # @param cert_p [#__ptr_give_ref]
+      # @return [void]
+      def insert(cert_p)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        cert_p = cert_p.__ptr_give_ref
+        result = ::CZMQ::FFI.zcertstore_insert(self_p, cert_p)
+        result
+      end
+
+      # Print list of certificates in store to logging facility
+      #
+      # @return [void]
+      def print()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zcertstore_print(self_p)
+        result
+      end
+
+      # DEPRECATED as incompatible with centralized logging
+      # Print list of certificates in store to open stream 
+      #
+      # @param file [::FFI::Pointer, #to_ptr]
+      # @return [void]
+      def fprint(file)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zcertstore_fprint(self_p, file)
+        result
+      end
+
+      # Self test of this class
+      #
+      # @param verbose [Boolean]
+      # @return [void]
+      def self.test(verbose)
+        verbose = !(0==verbose||!verbose) # boolean
+        result = ::CZMQ::FFI.zcertstore_test(verbose)
+        result
+      end
+    end
+  end
+end
+
+################################################################################
+#  THIS FILE IS 100% GENERATED BY ZPROJECT; DO NOT EDIT EXCEPT EXPERIMENTALLY  #
+#  Please refer to the README for information about making permanent changes.  #
+################################################################################

data/lib/czmq-ffi-gen/czmq/ffi.rb

@@ -78,6 +78,39 @@ module CZMQ
 
       require_relative 'ffi/zarmour'
 
+      attach_function :zcert_new, [], :pointer, **opts
+      attach_function :zcert_new_from, [:pointer, :pointer], :pointer, **opts
+      attach_function :zcert_load, [:string], :pointer, **opts
+      attach_function :zcert_destroy, [:pointer], :void, **opts
+      attach_function :zcert_public_key, [:pointer], :pointer, **opts
+      attach_function :zcert_secret_key, [:pointer], :pointer, **opts
+      attach_function :zcert_public_txt, [:pointer], :pointer, **opts
+      attach_function :zcert_secret_txt, [:pointer], :pointer, **opts
+      attach_function :zcert_set_meta, [:pointer, :string, :string, :varargs], :void, **opts
+      attach_function :zcert_meta, [:pointer, :string], :pointer, **opts
+      attach_function :zcert_meta_keys, [:pointer], :pointer, **opts
+      attach_function :zcert_save, [:pointer, :string], :int, **opts
+      attach_function :zcert_save_public, [:pointer, :string], :int, **opts
+      attach_function :zcert_save_secret, [:pointer, :string], :int, **opts
+      attach_function :zcert_apply, [:pointer, :pointer], :void, **opts
+      attach_function :zcert_dup, [:pointer], :pointer, **opts
+      attach_function :zcert_eq, [:pointer, :pointer], :bool, **opts
+      attach_function :zcert_print, [:pointer], :void, **opts
+      attach_function :zcert_fprint, [:pointer, :pointer], :void, **opts
+      attach_function :zcert_test, [:bool], :void, **opts
+
+      require_relative 'ffi/zcert'
+
+      attach_function :zcertstore_new, [:string], :pointer, **opts
+      attach_function :zcertstore_destroy, [:pointer], :void, **opts
+      attach_function :zcertstore_lookup, [:pointer, :string], :pointer, **opts
+      attach_function :zcertstore_insert, [:pointer, :pointer], :void, **opts
+      attach_function :zcertstore_print, [:pointer], :void, **opts
+      attach_function :zcertstore_fprint, [:pointer, :pointer], :void, **opts
+      attach_function :zcertstore_test, [:bool], :void, **opts
+
+      require_relative 'ffi/zcertstore'
+
       attach_function :zconfig_new, [:string, :pointer], :pointer, **opts
       attach_function :zconfig_load, [:string], :pointer, **opts
       attach_function :zconfig_loadf, [:string, :varargs], :pointer, **opts

data/lib/czmq-ffi-gen/gem_version.rb

@@ -1,5 +1,5 @@
 module CZMQ
   module FFI
-    GEM_VERSION = "0.1.1"
+    GEM_VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: czmq-ffi-gen
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Patrik Wenger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-12-09 00:00:00.000000000 Z
+date: 2015-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -97,6 +97,8 @@ files:
 - lib/czmq-ffi-gen/czmq/ffi/version.rb
 - lib/czmq-ffi-gen/czmq/ffi/zactor.rb
 - lib/czmq-ffi-gen/czmq/ffi/zarmour.rb
+- lib/czmq-ffi-gen/czmq/ffi/zcert.rb
+- lib/czmq-ffi-gen/czmq/ffi/zcertstore.rb
 - lib/czmq-ffi-gen/czmq/ffi/zconfig.rb
 - lib/czmq-ffi-gen/czmq/ffi/zdir.rb
 - lib/czmq-ffi-gen/czmq/ffi/zdir_patch.rb