memory_locker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1f3a6f1d81fcec94948578a19104e6465844402d3a58c2379b8c9a02e973fe8a
+  data.tar.gz: 0c5133932a48f4409961bc2fc6beeb53c28b183f754497166ff401eabecc7c03
+SHA512:
+  metadata.gz: 8f6c0e2f07e918f1971f7d0c7f1ddd5c8f82c42e438e796b5c829e46856371dbeaf7716c59f784541b7ee2f43e59648088ee7f65c4195d3df884fb192fe79f94
+  data.tar.gz: 76494e83446a77fdc49b45c4c6ba51a59a1aafb64f238052c053b3bfcf8c80cb025a7dfddaa0bc9a1513a7730b2c2b13a5c371877dee53d2680fc406325f474a

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## [0.1.0] - 2023-07-27
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Paweł Pokrywka
+
+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,69 @@
+# MemoryLocker
+
+Lock memory containing sensitive data (such as passwords or cryptographic keys) to prevent it from being swapped
+by the kernel, which allows the attacker with access to swap space to recover secrets.
+
+Ruby doesn't allow granular memory management, therefore the approach is to lock the entire memory of a program.
+
+## Requirements
+
+This gem requires `ffi` gem, which needs to be built on install.
+In case of build-related issues, make sure you have the compiler installed.
+
+In Debian-based Linux distributions, you can install it by executing:
+
+    $ sudo apt install --no-install-recommends build-essential
+
+Refer to [ffi gem documentation](https://github.com/ffi/ffi) for requirements on other systems.
+
+## Installation
+
+Install the gem and add it to the application's Gemfile by executing:
+
+    $ bundle add memory_locker
+
+If the bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install memory_locker
+
+## Usage
+
+To lock the memory of the current process use the following once, whenever you want,
+but before sensitive data processing:
+
+    MemoryLocker.new(:glibc).lock!
+
+The above example uses the `glibc` backend which should work on most Linux distributions.
+Currently, only this backend is implemented, however, it is trivial to add support for other c-libraries.
+
+The memory will stay locked until the process terminates. There is no way to unlock memory.
+The reason is Ruby doesn't support reliable removal of secrets from memory, therefore it is safer to just
+keep memory locked.
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rake spec` to run the tests.
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To implement the backend for a different c-library, use existing one as a template.
+Copy `lib/memory_locker/glibc.rb` to `lib/memory_locker/my_backend.rb`, and change it.
+Later use `:my_backend` as an argument to `MemoryLocker` initializer.
+
+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/phantom-node/memory_locker.
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to
+the [code of conduct](https://github.com/phantom-node/memory_locker/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the MemoryLocker project's codebases, issue trackers, chat rooms, and mailing lists
+is expected to follow the [code of conduct](https://github.com/phantom-node/memory_locker/blob/master/CODE_OF_CONDUCT.md).

data/lib/memory_locker/glibc.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+class MemoryLocker
+  # Low level interface to glibc
+  module Backend
+    extend FFI::Library
+    ffi_lib 'libc.so.6'
+
+    MCL_CURRENT = 1
+    MCL_FUTURE = 2
+
+    attach_function :mlockall, [:int], :int
+
+    def self.lock!
+      mlockall(MCL_CURRENT | MCL_FUTURE).zero?
+    end
+  end
+end

data/lib/memory_locker/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class MemoryLocker
+  VERSION = '0.1.0'
+end

data/lib/memory_locker.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative 'memory_locker/version'
+require 'ffi'
+
+# Lock process memory, so it won't be swapped by the kernel.
+# It is implemented as a one-way operation: there is no unlock.
+# That's because it's hard to properly clean memory in Ruby.
+class MemoryLocker
+  LockingError = Class.new StandardError
+
+  def lock!
+    Backend.lock! || raise(LockingError, "Failed to lock memory, errno #{FFI.errno}")
+  end
+
+  private
+
+  attr_reader :backend
+
+  def initialize(backend)
+    require_relative "memory_locker/#{backend}"
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: memory_locker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Paweł Pokrywka
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-07-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: 
+email:
+- pepawel@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/memory_locker.rb
+- lib/memory_locker/glibc.rb
+- lib/memory_locker/version.rb
+homepage: https://github.com/phantom-node/memory_locker
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/phantom-node/memory_locker
+  source_code_uri: https://github.com/phantom-node/memory_locker
+  changelog_uri: https://github.com/phantom-node/memory_locker/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Lock memory containing sensitive data to prevent it from being swapped by
+  the kernel
+test_files: []