hrr_rb_syscall_lookup 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 79de27a80b93e3d2410f59d74b896ea1c7605f22c94f3c3337796d7d7641953a
+  data.tar.gz: 4c7bd7408d13e1266abf287bddd6f7f6f09a8a7c618d2a116310ed6ebbdb8eea
+SHA512:
+  metadata.gz: 25dabbfcab5ae9c02544f85f710db4bc6776830e10939ab786cf1ef6ae12613545fa5aecff4cd250a1332a68d1eb743db5ba05bea4759febabf7b8e31bfef86a
+  data.tar.gz: f945a6c6bde0abe3433526d351cb3e7adf0e090eeda2cd9a879bc8ac525cfdd5c82a7b082bf9f6b391e45febff32b1858b98c10de77a509ff93c59c356483801

data/.gitignore

@@ -0,0 +1,20 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+# rspec failure tracking
+.rspec_status
+
+/.ruby-version
+/Gemfile.lock
+/vendor

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at TODO: Write your email address. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in hrr_rb_syscall_lookup.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rake-compiler"
+gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 TODO: Write your name
+
+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,105 @@
+# HrrRbSyscallLookup
+
+HrrRbSyscallLookup is a library to provice system call number and name look-up functions using libaudit.
+
+## Table of Contents
+
+- [Requirements](#requirements)
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Methods](#methods)
+    - [name_to_num(name)](#name_to_numname)
+    - [num_to_name(num)](#num_to_namenum)
+- [Development](#development)
+- [Contributing](#contributing)
+- [Code of Conduct](#code-of-conduct)
+- [License](#license)
+
+## Requirements
+
+HrrRbSyscallLookup requires the following is available on the system.
+
+- libaudit
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hrr_rb_syscall_lookup'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install hrr_rb_syscall_lookup
+
+## Usage
+
+The basic usage for the library is as follows.
+
+```ruby
+require "hrr_rb_syscall_lookup"
+
+hello = "hello\n"
+syscall HrrRbSyscallLookup.name_to_num("write"), $stdout.fileno, hello, hello.size
+# hello
+```
+
+### Methods
+
+#### name_to_num(name)
+
+The name_to_num(name) method translates a system call name into a number that the name indicates based on the running machine.
+
+```ruby
+HrrRbSyscallLookup.name_to_num("write")
+# => 1 # on my machine
+```
+
+The method takes an argument name that is an instance of String.
+
+When the machine has the system call, the method returns a number, which an instance of Integer, that the name indicates.
+
+When the machine does not have the system call, the method returns nil.
+
+When the argument is not an instance of String, the method raises TypeError.
+
+#### num_to_name(num)
+
+The num_to_name(num) method translates a system call number into a name that the number indicates based on the running machine.
+
+```ruby
+HrrRbSyscallLookup.num_to_name(1)
+# => write # on my machine
+```
+
+The method takes an argument num that is an instance of Integer.
+
+When the machine has the system call, the method returns a name, which an instance of String, that the num indicates.
+
+When the machine does not have the system call, the method returns nil.
+
+When the argument is not an instance of Integer, the method raises TypeError.
+
+## Development
+
+After checking out the repo, run `bin/setup` 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 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 tags, 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/hirura/hrr_rb_syscall_lookup. 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/hirura/hrr_rb_syscall_lookup/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 HrrRbSyscallLookup project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/hirura/hrr_rb_syscall_lookup/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rake/extensiontask"
+
+task :build => :compile
+
+Rake::ExtensionTask.new("hrr_rb_syscall_lookup") do |ext|
+  ext.lib_dir = "lib/hrr_rb_syscall_lookup"
+end
+
+task :default => [:clobber, :compile, :spec]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hrr_rb_syscall_lookup"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/demo/demo.rb

@@ -0,0 +1,15 @@
+require "hrr_rb_syscall_lookup"
+
+puts "System call number of write:"
+puts HrrRbSyscallLookup.name_to_num("write")
+
+puts
+
+puts "System call name of 1:"
+puts HrrRbSyscallLookup.num_to_name(1)
+
+puts
+
+hello = "hello\n"
+syscall HrrRbSyscallLookup.name_to_num("write"), $stdout.fileno, hello, hello.size
+# => hello

data/ext/hrr_rb_syscall_lookup/extconf.rb

@@ -0,0 +1,8 @@
+require "mkmf"
+
+if [
+  have_header("libaudit.h"),
+  have_library("audit"),
+].all?
+  create_makefile("hrr_rb_syscall_lookup/hrr_rb_syscall_lookup")
+end

data/ext/hrr_rb_syscall_lookup/hrr_rb_syscall_lookup.c

@@ -0,0 +1,39 @@
+#include <limits.h>
+#include <libaudit.h>
+#include "hrr_rb_syscall_lookup.h"
+
+VALUE rb_mHrrRbSyscallLookup;
+
+VALUE
+name_to_num(VALUE self, VALUE name)
+{
+  int rc;
+  Check_Type(name, T_STRING);
+  rc = audit_name_to_syscall(StringValueCStr(name), audit_detect_machine());
+  if (rc < 0)
+    return Qnil;
+  return INT2FIX(rc);
+}
+
+VALUE
+num_to_name(VALUE self, VALUE num)
+{
+  const char* name;
+  if (RB_TYPE_P(num, T_BIGNUM))
+    return Qnil;
+  Check_Type(num, T_FIXNUM);
+  if (FIX2LONG(num) < (long)INT_MIN || (long)INT_MAX < FIX2LONG(num))
+    return Qnil;
+  name = audit_syscall_to_name(FIX2INT(num), audit_detect_machine());
+  if (name == NULL)
+    return Qnil;
+  return rb_str_new_cstr(name);
+}
+
+void
+Init_hrr_rb_syscall_lookup(void)
+{
+  rb_mHrrRbSyscallLookup = rb_define_module("HrrRbSyscallLookup");
+  rb_define_singleton_method(rb_mHrrRbSyscallLookup, "name_to_num", name_to_num, 1);
+  rb_define_singleton_method(rb_mHrrRbSyscallLookup, "num_to_name", num_to_name, 1);
+}

data/ext/hrr_rb_syscall_lookup/hrr_rb_syscall_lookup.h

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

data/hrr_rb_syscall_lookup.gemspec

@@ -0,0 +1,22 @@
+require_relative 'lib/hrr_rb_syscall_lookup/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hrr_rb_syscall_lookup"
+  spec.version       = HrrRbSyscallLookup::VERSION
+  spec.authors       = ["hirura"]
+  spec.email         = ["hirura@gmail.com"]
+
+  spec.summary       = %q{Providing system call number and name look-up functions using libaudit.}
+  spec.description   = %q{Providing system call number and name look-up functions using libaudit.}
+  spec.homepage      = "https://github.com/hirura/hrr_rb_syscall_lookup"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.0.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+  spec.extensions    = ["ext/hrr_rb_syscall_lookup/extconf.rb"]
+end

data/lib/hrr_rb_syscall_lookup.rb

@@ -0,0 +1,5 @@
+require "hrr_rb_syscall_lookup/version"
+require "hrr_rb_syscall_lookup/hrr_rb_syscall_lookup"
+
+module HrrRbSyscallLookup
+end

data/lib/hrr_rb_syscall_lookup/version.rb

@@ -0,0 +1,3 @@
+module HrrRbSyscallLookup
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: hrr_rb_syscall_lookup
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- hirura
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-02-29 00:00:00.000000000 Z
+dependencies: []
+description: Providing system call number and name look-up functions using libaudit.
+email:
+- hirura@gmail.com
+executables: []
+extensions:
+- ext/hrr_rb_syscall_lookup/extconf.rb
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- demo/demo.rb
+- ext/hrr_rb_syscall_lookup/extconf.rb
+- ext/hrr_rb_syscall_lookup/hrr_rb_syscall_lookup.c
+- ext/hrr_rb_syscall_lookup/hrr_rb_syscall_lookup.h
+- hrr_rb_syscall_lookup.gemspec
+- lib/hrr_rb_syscall_lookup.rb
+- lib/hrr_rb_syscall_lookup/version.rb
+homepage: https://github.com/hirura/hrr_rb_syscall_lookup
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/hirura/hrr_rb_syscall_lookup
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Providing system call number and name look-up functions using libaudit.
+test_files: []