ffi-libsodium 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 613f14c043ff696627ef5d0009113367982a57a7
+  data.tar.gz: cc4459674fa3bc66f33e1868726ab63699b9f30e
+SHA512:
+  metadata.gz: 0aec4788173e268528120fac6a2504a3fdf2a0a2c721f4b809edb9aaef4da6e59191e851ad829e86573010845a7a45764f0a1fb3884b3945374f1f1e302ee0ac
+  data.tar.gz: 00ac3a7187a277456a03f2db49f4896ebd952a2d29c9d5014a4a17cad51c222cccb12a78543fc822acd43ca36c8423919e58b8a1c1860a797b8d493c87f3c4d2

data/LICENSE

@@ -0,0 +1,191 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2014 Hendrik Beskow
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/README.md

@@ -0,0 +1,21 @@
+ruby-ffi-libsodium
+===============
+
+Secret Key derivation and user authentication: Store the salt and the mac and you can verify a user and give him a Secret Key without storing the password or key in a database.
+
+```bash
+bundle update
+```
+
+```ruby
+require 'bundler/setup'
+require 'libsodium'
+
+password = 'test123'
+
+salt = Crypto::PwHash::ScryptSalsa208SHA256.salt
+key = Crypto::PwHash.scryptsalsa208sha256(password, Crypto::Auth::KEYBYTES, salt)
+mac = Crypto.auth(password, key)
+
+puts Crypto::Auth.verify(mac, password, key)
+```

data/lib/crypto/aead/chacha20_poly1305.rb

@@ -0,0 +1,75 @@
+require_relative '../../sodium'
+require_relative '../../sodium/utils'
+require_relative '../../sodium/secret_buffer'
+require_relative '../../random_bytes'
+
+module Crypto
+  module AEAD
+    module Chacha20Poly1305
+      PRIMITIVE = 'chacha20poly1305'.freeze
+
+      extend FFI::Library
+      extend Sodium::Utils
+
+      ffi_lib :libsodium
+
+      class << self
+        def crypto_aead_chacha20poly1305_primitive
+          PRIMITIVE
+        end
+
+        alias_method :primitive, :crypto_aead_chacha20poly1305_primitive
+      end
+
+      attach_function :keybytes,  :crypto_aead_chacha20poly1305_keybytes,   [], :size_t
+      attach_function :npubbytes, :crypto_aead_chacha20poly1305_npubbytes,  [], :size_t
+      attach_function :abytes,    :crypto_aead_chacha20poly1305_abytes,     [], :size_t
+
+      KEYBYTES  = keybytes.freeze
+      NPUBBYTES = npubbytes.freeze
+      ABYTES    = abytes.freeze
+
+      attach_function :crypto_aead_chacha20poly1305_encrypt,  [:buffer_out, :buffer_out, :buffer_in, :ulong_long, :buffer_in, :ulong_long, :pointer, :buffer_in, :buffer_in], :int
+      attach_function :crypto_aead_chacha20poly1305_decrypt,  [:buffer_out, :buffer_out, :pointer, :buffer_in, :ulong_long, :buffer_in, :ulong_long, :buffer_in, :buffer_in], :int
+
+      module_function
+
+      def nonce
+        RandomBytes.buf(NPUBBYTES)
+      end
+
+      def encrypt(message, additional_data, nonce, key)
+        message_len = get_size(message)
+        additional_data_len = get_size(additional_data)
+        check_length(nonce, NPUBBYTES, :Nonce)
+        check_length(key, KEYBYTES, :SecretKey)
+
+        ciphertext = FFI::MemoryPointer.new(:uchar, message_len + ABYTES)
+        ciphertext_len = FFI::MemoryPointer.new(:ulong_long)
+        key.readonly if key.is_a?(Sodium::SecretBuffer)
+        crypto_aead_chacha20poly1305_encrypt(ciphertext, ciphertext_len, message, message_len, additional_data, additional_data_len, nil, nonce, key)
+        key.noaccess if key.is_a?(Sodium::SecretBuffer)
+
+        [ciphertext, ciphertext_len.read_ulong_long]
+      end
+
+      def decrypt(ciphertext, clen, additional_data, nonce, key)
+        ciphertext_len = get_int(clen)
+        additional_data_len = get_size(additional_data)
+        check_length(nonce, NPUBBYTES, :Nonce)
+        check_length(key, KEYBYTES, :SecretKey)
+
+        decrypted = FFI::MemoryPointer.new(:uchar, ciphertext_len)
+        decrypted_len = FFI::MemoryPointer.new(:ulong_long)
+        key.readonly if key.is_a?(Sodium::SecretBuffer)
+        rc = crypto_aead_chacha20poly1305_decrypt(decrypted, decrypted_len, nil, ciphertext, ciphertext_len, additional_data, additional_data_len, nonce, key)
+        key.noaccess if key.is_a?(Sodium::SecretBuffer)
+        if rc == -1
+          raise Sodium::CryptoError, "Message forged", caller
+        end
+
+        [decrypted, decrypted_len.read_ulong_long]
+      end
+    end
+  end
+end

data/lib/crypto/auth.rb

@@ -0,0 +1,54 @@
+require_relative '../sodium'
+require_relative '../sodium/utils'
+require_relative '../sodium/buffer'
+require_relative '../sodium/secret_buffer'
+
+module Crypto
+  module Auth
+    extend FFI::Library
+    extend Sodium::Utils
+
+    ffi_lib :libsodium
+
+    attach_function :primitive, :crypto_auth_primitive, [], :string
+    attach_function :bytes,     :crypto_auth_bytes,     [], :size_t
+    attach_function :keybytes,  :crypto_auth_keybytes,  [], :size_t
+
+    PRIMITIVE = primitive.freeze
+    BYTES     = bytes.freeze
+    KEYBYTES  = keybytes.freeze
+
+    attach_function :crypto_auth,         [:buffer_out, :buffer_in, :ulong_long, :buffer_in], :int, blocking: true
+    attach_function :crypto_auth_verify,  [:buffer_in, :buffer_in, :ulong_long, :buffer_in],  :int, blocking: true
+
+    module_function
+
+    def auth(message, key)
+      message_len = get_size(message)
+      check_length(key, KEYBYTES, :SecretKey)
+
+      mac = Sodium::Buffer.new(:uchar, BYTES)
+      key.readonly if key.is_a?(Sodium::SecretBuffer)
+      crypto_auth(mac, message, message_len, key)
+      key.noaccess if key.is_a?(Sodium::SecretBuffer)
+
+      mac
+    end
+
+    def verify(mac, message, key)
+      check_length(mac, BYTES, :Mac)
+      message_len = get_size(message)
+      check_length(key, KEYBYTES, :SecretKey)
+
+      key.readonly if key.is_a?(Sodium::SecretBuffer)
+      rc = crypto_auth_verify(mac, message, message_len, key)
+      key.noaccess if key.is_a?(Sodium::SecretBuffer)
+
+      rc == 0
+    end
+  end
+
+  def self.auth(*args)
+    Auth.auth(*args)
+  end
+end

data/lib/crypto/box.rb

@@ -0,0 +1,150 @@
+require_relative '../sodium'
+require_relative '../sodium/utils'
+require_relative '../sodium/buffer'
+require_relative '../sodium/secret_buffer'
+require_relative '../random_bytes'
+
+module Crypto
+  module Box
+    extend FFI::Library
+    extend Sodium::Utils
+
+    ffi_lib :libsodium
+
+    attach_function :primitive,       :crypto_box_primitive,      [], :string
+    attach_function :seedbytes,       :crypto_box_seedbytes,      [], :size_t
+    attach_function :publickeybytes,  :crypto_box_publickeybytes, [], :size_t
+    attach_function :secretkeybytes,  :crypto_box_secretkeybytes, [], :size_t
+    attach_function :noncebytes,      :crypto_box_noncebytes,     [], :size_t
+    attach_function :macbytes,        :crypto_box_macbytes,       [], :size_t
+
+    PRIMITIVE       = primitive.freeze
+    SEEDBYTES       = seedbytes.freeze
+    PUBLICKEYBYTES  = publickeybytes.freeze
+    SECRETKEYBYTES  = secretkeybytes.freeze
+    NONCEBYTES      = noncebytes.freeze
+    MACBYTES        = macbytes.freeze
+
+    attach_function :crypto_box_keypair,      [:buffer_out, :buffer_out],             :int, blocking: true
+    attach_function :crypto_box_seed_keypair, [:buffer_out, :buffer_out, :buffer_in], :int, blocking: true
+
+    attach_function :crypto_box_easy,       [:buffer_out, :buffer_in, :ulong_long, :buffer_in, :buffer_in, :buffer_in], :int, blocking: true
+    attach_function :crypto_box_open_easy,  [:buffer_out, :buffer_in, :ulong_long, :buffer_in, :buffer_in, :buffer_in], :int, blocking: true
+
+    module_function
+
+    def nonce
+      RandomBytes.buf(NONCEBYTES)
+    end
+
+    def keypair
+      public_key = Sodium::Buffer.new(:uchar, PUBLICKEYBYTES)
+      secret_key = Sodium::Buffer.new(:uchar, SECRETKEYBYTES)
+      crypto_box_keypair(public_key, secret_key)
+
+      [public_key, secret_key]
+    end
+
+    def seed_keypair(seed)
+      check_length(seed, SEEDBYTES, :Seed)
+
+      public_key = Sodium::Buffer.new(:uchar, PUBLICKEYBYTES)
+      secret_key = Sodium::Buffer.new(:uchar, SECRETKEYBYTES)
+      crypto_box_seed_keypair(public_key, secret_key, seed)
+
+      [public_key, secret_key]
+    end
+
+    def memory_locked_keypair
+      public_key = Sodium::Buffer.new(:uchar, PUBLICKEYBYTES)
+      secret_key = Sodium::SecretBuffer.new(SECRETKEYBYTES)
+      crypto_box_keypair(public_key, secret_key)
+      secret_key.noaccess
+
+      [public_key, secret_key]
+    end
+
+    def memory_locked_seed_keypair(seed)
+      check_length(seed, SEEDBYTES, :Seed)
+
+      public_key = Sodium::Buffer.new(:uchar, PUBLICKEYBYTES)
+      secret_key = Sodium::SecretBuffer.new(:uchar, SECRETKEYBYTES)
+      crypto_box_seed_keypair(public_key, secret_key, seed)
+      secret_key.noaccess
+
+      [public_key, secret_key]
+    end
+
+    def easy(message, nonce, public_key, secret_key)
+      message_len = get_size(message)
+      check_length(nonce, NONCEBYTES, :Nonce)
+      check_length(public_key, PUBLICKEYBYTES, :PublicKey)
+      check_length(secret_key, SECRETKEYBYTES, :SecretKey)
+
+      ciphertext = Sodium::Buffer.new(:uchar, MACBYTES + message_len)
+      secret_key.readonly if secret_key.is_a?(Sodium::SecretBuffer)
+      crypto_box_easy(ciphertext, message, message_len, nonce, public_key, secret_key)
+      secret_key.noaccess if secret_key.is_a?(Sodium::SecretBuffer)
+
+      ciphertext
+    end
+
+    def open_easy(ciphertext, nonce, public_key, secret_key)
+      ciphertext_len = get_size(ciphertext)
+      check_length(nonce, NONCEBYTES, :Nonce)
+      check_length(public_key, PUBLICKEYBYTES, :PublicKey)
+      check_length(secret_key, SECRETKEYBYTES, :SecretKey)
+
+      decrypted = Sodium::Buffer.new(:uchar, ciphertext_len - MACBYTES)
+      secret_key.readonly if secret_key.is_a?(Sodium::SecretBuffer)
+      rc = crypto_box_open_easy(decrypted, ciphertext, ciphertext_len, nonce, public_key, secret_key)
+      secret_key.noaccess if secret_key.is_a?(Sodium::SecretBuffer)
+      if rc == -1
+        raise Sodium::CryptoError, "Message forged", caller
+      end
+
+      decrypted
+    end
+
+    def easy_in_place(data, nonce, public_key, secret_key)
+      message = get_string(data)
+      check_length(nonce, NONCEBYTES, :Nonce)
+      check_length(public_key, PUBLICKEYBYTES, :PublicKey)
+      check_length(secret_key, SECRETKEYBYTES, :SecretKey)
+
+      message_len = message.bytesize
+      message << zeros(MACBYTES)
+      secret_key.readonly if secret_key.is_a?(Sodium::SecretBuffer)
+      crypto_box_easy(message, message, message_len, nonce, public_key, secret_key)
+      secret_key.noaccess if secret_key.is_a?(Sodium::SecretBuffer)
+
+      message
+    end
+
+    def open_easy_in_place(data, nonce, public_key, secret_key, utf8 = false)
+      ciphertext = get_string(data)
+      unless (message_len = ciphertext.bytesize - MACBYTES) > 0
+        fail Sodium::LengthError, "Ciphertext is too short", caller
+      end
+
+      check_length(nonce, NONCEBYTES, :Nonce)
+      check_length(public_key, PUBLICKEYBYTES, :PublicKey)
+      check_length(secret_key, SECRETKEYBYTES, :SecretKey)
+
+      secret_key.readonly if secret_key.is_a?(Sodium::SecretBuffer)
+      rc = crypto_box_open_easy(ciphertext, ciphertext, ciphertext.bytesize, nonce, public_key, secret_key)
+      secret_key.noaccess if secret_key.is_a?(Sodium::SecretBuffer)
+      if rc == -1
+        raise Sodium::CryptoError, "Message forged", caller
+      end
+
+      if utf8
+        ciphertext.slice!(message_len..-1).force_encoding(Encoding::UTF_8)
+      else
+        ciphertext.slice!(message_len..-1)
+      end
+
+      ciphertext
+    end
+  end
+end