ruby_clang_fpe 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3115aa40a5c4002b75f0c8019ffeed1bb14c34b6fc2a977feff25e8d0651fcf4
+  data.tar.gz: d7c11ef5ba9837c4e5e8bc1ba799dfbaa7388b1f20ed98ab7e28c09ebffadd3f
+SHA512:
+  metadata.gz: bdf47ab3683a21cee73005bdddc1fcabacdde7e5cc5d1498422deaff3c09586f738f237be396ab00133d5b839fea801893f54ff8027c6377b5254f78db5952ab
+  data.tar.gz: 35fffea86cff3d243ff9976fd5bcacc8f941eedb6ee10a4ac31aebcb195c5342109e8a9faf7ead663f7b29a7024b6a0fd5f3eecbd0669724ac149a25c86410e2

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/.ruby-version

@@ -0,0 +1 @@
+2.7.3

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ruby_clang_fpe.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rake-compiler"
+
+gem "minitest", "~> 5.0"
+
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,78 @@
+PATH
+  remote: .
+  specs:
+    ruby_clang_fpe (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    base64 (0.1.1)
+    binding_of_caller (1.0.0)
+      debug_inspector (>= 0.0.1)
+    coderay (1.1.3)
+    debug_inspector (1.1.0)
+    interception (0.5)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    method_source (1.0.0)
+    minitest (5.20.0)
+    parallel (1.23.0)
+    parser (3.2.2.4)
+      ast (~> 2.4.1)
+      racc
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-doc (1.2.0)
+      pry (~> 0.11)
+      yard (~> 0.9.11)
+    pry-rescue (1.5.2)
+      interception (>= 0.5)
+      pry (>= 0.12.0)
+    pry-stack_explorer (0.6.1)
+      binding_of_caller (~> 1.0)
+      pry (~> 0.13)
+    racc (1.7.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rake-compiler (1.2.5)
+      rake
+    regexp_parser (2.8.2)
+    rexml (3.2.6)
+    rubocop (1.57.1)
+      base64 (~> 0.1.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.4)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.5.0)
+    webrick (1.7.0)
+    yard (0.9.27)
+      webrick (~> 1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  pry
+  pry-doc
+  pry-rescue
+  pry-stack_explorer
+  rake (~> 13.0)
+  rake-compiler
+  rubocop (~> 1.21)
+  ruby_clang_fpe!
+
+BUNDLED WITH
+   2.2.32

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Daniel Luna
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Daniel Luna
+
+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,32 @@
+# RubyClangFpe
+
+Format-preserving encryption for Ruby, based on https://github.com/mysto/clang-fpe.
+
+## Installation
+
+Add the following to the application's Gemfile:
+
+    gem 'ruby_clang_fpe', github: 'dcluna/ruby-clang-fpe', submodules: true
+
+## Usage
+
+```ruby
+fpe3_key = RubyClangFpe::FpeKey.generate_key(:ff3, "EF4359D8D580AA4F7F036D6F04FC6A942B7E151628AED2A6ABF7158809CF4F3C", "9A768A92F60E12D8", 26)
+
+fpe3_key.encrypt("89012123456789000000789000000") # => "30859239999374053872365555822"
+fpe3_key.decrypt("30859239999374053872365555822") # => "89012123456789000000789000000"
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/dcluna/ruby-clang-fpe.
+
+## 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,24 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+require "rake/extensiontask"
+
+task build: :compile
+
+Rake::ExtensionTask.new("ruby_clang_fpe") do |ext|
+  ext.lib_dir = "lib/ruby_clang_fpe"
+end
+
+task default: %i[clobber compile test rubocop]

data/ext/ruby_clang_fpe/extconf.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: TRUE
+
+require "mkmf"
+
+openssl_include_dir, openssl_lib_dir = dir_config("openssl", "include", "lib")
+
+openssl_dir = File.dirname openssl_include_dir
+
+find_header "string.h"
+find_header "openssl/bn.h"
+find_header "openssl/aes.h"
+
+clang_fpe_include_dir, clang_fpe_lib_dir = dir_config("clang-fpe", "src", "./")
+
+clang_fpe_dir = File.dirname clang_fpe_include_dir
+
+if clang_fpe_dir == "."
+  clang_fpe_dir = (File.expand_path File.dirname(__FILE__) + "/../../vendor/clang-fpe" )
+  clang_fpe_lib_dir = clang_fpe_dir
+  clang_fpe_include_dir = clang_fpe_dir + "/src"
+end
+
+Dir.chdir clang_fpe_dir do
+  system "CFLAGS='-I#{openssl_include_dir}' LDFLAGS='-L#{openssl_lib_dir}' make" if Dir["**/libfpe.a"].empty?
+end
+
+libfpe = Dir[clang_fpe_dir + "/**/libfpe.a"].first
+
+$LOCAL_LIBS << "'#{libfpe}'"
+
+find_header "fpe.h", clang_fpe_include_dir
+find_header "fpe_locl.h", clang_fpe_include_dir
+
+create_makefile("ruby_clang_fpe/ruby_clang_fpe")

data/ext/ruby_clang_fpe/ruby_clang_fpe.c

@@ -0,0 +1,134 @@
+#include "ruby_clang_fpe.h"
+#include "fpe.h"
+#include "fpe_locl.h"
+
+VALUE rb_mRubyClangFpe;
+
+size_t
+fpe_get_size (const void *dsize){ return sizeof(dsize); };
+
+static const rb_data_type_t fpe_type = {
+  "fpe",
+  { 0, RUBY_DEFAULT_FREE, fpe_get_size, },
+  0, 0,
+  RUBY_TYPED_FREE_IMMEDIATELY,
+};
+
+static VALUE ffpe_alloc(VALUE);
+
+static VALUE rb_cFpe; // RubyClangFpe::FpeKey class
+static VALUE rb_cFpe3; // RubyClangFpe::Fpe3Key class
+static VALUE rb_cFpe3_1; // RubyClangFpe::Fpe31Key class
+static VALUE rb_cFpe1; // RubyClangFpe::Fpe1Key class
+
+static VALUE t_gen_ff3_key(VALUE self, VALUE key, VALUE tweak, VALUE radix)
+{
+  FPE_KEY *fpe_key;
+  fpe_key = FPE_ff3_create_key(StringValuePtr(key), StringValuePtr(tweak), NUM2UINT(radix));
+  if (fpe_key != NULL) {
+    return TypedData_Wrap_Struct(rb_cFpe3, &fpe_type, fpe_key);
+  } else {
+    return Qnil;
+  }
+};
+
+static VALUE t_gen_ff3_1_key(VALUE self, VALUE key, VALUE tweak, VALUE radix)
+{
+  FPE_KEY *fpe_key;
+  fpe_key = FPE_ff3_1_create_key(StringValuePtr(key), StringValuePtr(tweak), NUM2UINT(radix));
+  if (fpe_key != NULL) {
+    return TypedData_Wrap_Struct(rb_cFpe3_1, &fpe_type, fpe_key);
+  } else {
+    return Qnil;
+  }
+};
+
+static VALUE t_gen_ff1_key(VALUE self, VALUE key, VALUE tweak, VALUE radix)
+{
+  FPE_KEY *fpe_key;
+  fpe_key = FPE_ff1_create_key(StringValuePtr(key), StringValuePtr(tweak), NUM2UINT(radix));
+  if (fpe_key != NULL) {
+    return TypedData_Wrap_Struct(rb_cFpe1, &fpe_type, fpe_key);
+  } else {
+    return Qnil;
+  }
+};
+
+static VALUE t_ff3_encrypt(VALUE self, VALUE plaintext)
+{
+  FPE_KEY *fpe_key_ptr;
+  TypedData_Get_Struct(self, FPE_KEY, &fpe_type, fpe_key_ptr);
+  char *plaintext_str = StringValueCStr(plaintext);
+  char ciphertext[strlen(plaintext_str)];
+  FPE_ff3_encrypt(plaintext_str, ciphertext, fpe_key_ptr);
+  return rb_str_new_cstr(ciphertext);
+};
+
+static VALUE t_ff3_decrypt(VALUE self, VALUE ciphertext)
+{
+  FPE_KEY *fpe_key_ptr;
+  TypedData_Get_Struct(self, FPE_KEY, &fpe_type, fpe_key_ptr);
+  char plaintext[strlen(StringValueCStr(ciphertext))];
+  FPE_ff3_decrypt(StringValuePtr(ciphertext), plaintext, fpe_key_ptr);
+  return rb_str_new_cstr(plaintext);
+};
+
+static VALUE t_ff1_encrypt(VALUE self, VALUE plaintext)
+{
+  FPE_KEY *fpe_key_ptr;
+  TypedData_Get_Struct(self, FPE_KEY, &fpe_type, fpe_key_ptr);
+  char ciphertext[strlen(StringValueCStr(plaintext))];
+  FPE_ff1_encrypt(StringValuePtr(plaintext), ciphertext, fpe_key_ptr);
+  return rb_str_new_cstr(ciphertext);
+};
+
+static VALUE t_ff1_decrypt(VALUE self, VALUE ciphertext)
+{
+  FPE_KEY *fpe_key_ptr;
+  TypedData_Get_Struct(self, FPE_KEY, &fpe_type, fpe_key_ptr);
+  char plaintext[strlen(StringValueCStr(ciphertext))];
+  FPE_ff1_decrypt(StringValueCStr(ciphertext), plaintext, fpe_key_ptr);
+  return rb_str_new_cstr(plaintext);
+};
+
+/*
+ * call-seq:
+ *  FpeKey.radix -> Integer
+ *
+ * Returns the integer value of the radix used to generate the key.
+ *
+ */
+static VALUE t_radix(VALUE self)
+{
+  FPE_KEY *fpe_key_ptr;
+  TypedData_Get_Struct(self, FPE_KEY, &fpe_type, fpe_key_ptr);
+  return UINT2NUM(fpe_key_ptr->radix);
+};
+
+static VALUE t_tweak(VALUE self)
+{
+  FPE_KEY *fpe_key_ptr;
+  TypedData_Get_Struct(self, FPE_KEY, &fpe_type, fpe_key_ptr);
+  return rb_str_new_cstr(fpe_key_ptr->tweak);
+};
+
+void
+Init_ruby_clang_fpe(void)
+{
+  rb_mRubyClangFpe = rb_define_module("RubyClangFpe");
+  rb_cFpe = rb_define_class_under(rb_mRubyClangFpe, "FpeKey", rb_cObject);
+  rb_cFpe3 = rb_define_class_under(rb_mRubyClangFpe, "Fpe3Key", rb_cFpe);
+  rb_cFpe3_1 = rb_define_class_under(rb_mRubyClangFpe, "Fpe31Key", rb_cFpe);
+  rb_cFpe1 = rb_define_class_under(rb_mRubyClangFpe, "Fpe1Key", rb_cFpe);
+  rb_define_singleton_method(rb_cFpe, "generate_ff3_key", t_gen_ff3_key, 3);
+  rb_define_singleton_method(rb_cFpe, "generate_ff3_1_key", t_gen_ff3_1_key, 3);
+  rb_define_singleton_method(rb_cFpe, "generate_ff1_key", t_gen_ff1_key, 3);
+  rb_define_method(rb_cFpe, "radix", t_radix, 0);
+  rb_define_method(rb_cFpe, "tweak", t_tweak, 0);
+  rb_define_method(rb_cFpe3, "encrypt", t_ff3_encrypt, 1);
+  rb_define_method(rb_cFpe3_1, "encrypt", t_ff3_encrypt, 1);
+  rb_define_method(rb_cFpe1, "encrypt", t_ff1_encrypt, 1);
+  rb_define_method(rb_cFpe3, "decrypt", t_ff3_decrypt, 1);
+  rb_define_method(rb_cFpe3_1, "decrypt", t_ff3_decrypt, 1);
+  rb_define_method(rb_cFpe1, "decrypt", t_ff1_decrypt, 1);
+}

data/ext/ruby_clang_fpe/ruby_clang_fpe.h

@@ -0,0 +1,6 @@
+#ifndef RUBY_CLANG_FPE_H
+#define RUBY_CLANG_FPE_H 1
+
+#include "ruby.h"
+
+#endif /* RUBY_CLANG_FPE_H */

data/lib/ruby_clang_fpe/fpe_key.rb

@@ -0,0 +1,20 @@
+module RubyClangFpe
+  class FpeKey
+    def self.generate_key(type, key, tweak, radix)
+      new_key = case type
+                when :ff3
+                  if (tweak.size / 2) == 7
+                    generate_ff3_1_key(key, tweak, radix)
+                  else
+                    generate_ff3_key(key, tweak, radix)
+                  end
+                when :ff1
+                  generate_ff1_key(key, tweak, radix)
+                end
+
+      new_key
+    end
+
+    private_class_method :generate_ff3_key, :generate_ff1_key, :generate_ff3_1_key
+  end
+end

data/lib/ruby_clang_fpe/version.rb

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

data/lib/ruby_clang_fpe.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "ruby_clang_fpe/version"
+require_relative "ruby_clang_fpe/ruby_clang_fpe"
+require_relative "ruby_clang_fpe/fpe_key"
+
+module RubyClangFpe
+  class Error < StandardError; end
+end

data/ruby_clang_fpe.gemspec

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative "lib/ruby_clang_fpe/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "ruby_clang_fpe"
+  spec.version = RubyClangFpe::VERSION
+  spec.authors = ["Daniel Luna"]
+  spec.email = ["dancluna@gmail.com"]
+
+  spec.summary = "Ruby bindings for the Clang FPE library."
+  spec.description = "Format-preserving encryption for Ruby, based on https://github.com/mysto/clang-fpe."
+  spec.homepage = "https://github.com/dcluna/ruby_clang_fpe"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/dcluna/ruby_clang_fpe"
+  spec.metadata["changelog_uri"] = "https://github.com/dcluna/ruby_clang_fpe"
+
+  # 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(__dir__) do
+    `git ls-files -z --recurse-submodules`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.extensions = ["ext/ruby_clang_fpe/extconf.rb"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-doc"
+  spec.add_development_dependency "pry-rescue"
+  spec.add_development_dependency "pry-stack_explorer"
+end

data/sig/ruby_clang_fpe.rbs

@@ -0,0 +1,4 @@
+module RubyClangFpe
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/vendor/clang-fpe/.github/workflows/c-cpp.yml

@@ -0,0 +1,22 @@
+name: C/C++ CI
+
+on:
+  push:
+    branches: [ "master", "git-actions" ]
+  pull_request:
+    branches: [ "master", "git-actions" ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: configure
+      run: ./configure
+    - name: make
+      run: make
+    - name: make test
+      run: make test
+

data/vendor/clang-fpe/.gitignore

@@ -0,0 +1,3 @@
+*.a
+*.dylib
+src/*.o

data/vendor/clang-fpe/.travis.yml

@@ -0,0 +1,2 @@
+os: freebsd
+language: c

data/vendor/clang-fpe/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 
+
+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/vendor/clang-fpe/Makefile

@@ -0,0 +1,60 @@
+CFLAGS := $(shell printenv CFLAGS) -O2 -Wall -fPIC -Wno-deprecated-declarations
+SO_LINKS = $(shell printenv LDFLAGS) -lm -lcrypto
+
+UNAME := $(shell uname -s)
+ifeq ($(UNAME),Darwin)
+LIB = libfpe.a libfpe.dylib
+else
+LIB = libfpe.a libfpe.so
+endif
+
+EXAMPLE_SRC = example.c
+EXAMPLE_EXE = example
+OBJS = src/ff1.o src/ff3.o src/fpe_locl.o
+
+
+all: $(LIB) $(EXAMPLE_EXE)
+
+libfpe.a: $(OBJS)
+	ar rcs $@ $(OBJS)
+
+ifeq ($(UNAME),Darwin)
+libfpe.dylib: $(OBJS)
+	gcc -shared -fPIC -Wl,-install_name,libfpe.dylib $(OBJS) $(SO_LINKS) -o $@
+else
+libfpe.so: $(OBJS)
+	gcc -shared -fPIC -Wl,-soname,libfpe.so $(OBJS) $(SO_LINKS) -o $@
+endif
+
+.PHONY = all clean install
+
+src/ff1.o: src/ff1.c
+	gcc $(CFLAGS) -c src/ff1.c -o $@
+
+src/ff3.o: src/ff3.c
+	gcc $(CFLAGS) -c src/ff3.c -o $@
+
+src/fpe_locl.o: src/fpe_locl.c
+	gcc $(CFLAGS) -c src/fpe_locl.c -o $@
+
+$(EXAMPLE_EXE): $(EXAMPLE_SRC) $(LIB)
+ifeq ($(UNAME),Darwin)
+	gcc $(CFLAGS) -Wl, $(EXAMPLE_SRC) -L. -lfpe $(SO_LINKS) -Isrc -o $@
+else
+	gcc $(CFLAGS) -Wl,-rpath=\$$ORIGIN $(EXAMPLE_SRC) -L. -lfpe $(SO_LINKS) -Isrc -o $@
+endif
+
+test:
+	python test.py
+
+# MacOS
+leaks:
+	leaks -atExit --  ./example EF4359D8D580AA4F7F036D6F04FC6A94 D8E7920AFA330A73 10 890121234567890000
+
+clean:
+	rm $(OBJS) $(EXAMPLE_EXE) $(LIB)
+
+install:
+	cp libfpe.so /usr/local/lib
+	cp src/*.h /usr/local/include
+