netlink 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ca60658b31b777fad08d777e1fcd306ae116f4a41451f5ecac10c9f559dc2cc0
+  data.tar.gz: 14cd35e02048ed8ccfcbf9be64090d4ba63628259bd05c4e82206788cc3bc009
+SHA512:
+  metadata.gz: 5c8e244f5ba3575d92f44b0713a4000d82699bdd920afbbdbd1b39b7a1aa102853bc59c9466cd90b5432235c567a8484082e2edb4fa6aa1d34fc8fd2d6ff10e8
+  data.tar.gz: f018b7f5ffff6773d3947497bc2c1c49141b198ac5702e4e4b77168b1a60a523b9141abdb591ae6da99e9db06376b721ecb24aca9fe250129ae5c66e706b83c6

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,54 @@
+require:
+  - rubocop-performance
+AllCops:
+  TargetRubyVersion: '2.7'
+  NewCops: enable
+  Exclude:
+    - .git/**/*
+    - spec/**/*
+    - vendor/**/*
+Gemspec/RequireMFA:
+  Enabled: false
+Layout/LineLength:
+  Enabled: false
+Layout/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: no_space
+Lint/AmbiguousOperatorPrecedence:
+  Enabled: false
+Lint/EmptyWhen:
+  Enabled: false
+Lint/Void:
+  Enabled: false
+Metrics/AbcSize:
+    Max: 20
+Metrics/ClassLength:
+    Max: 200
+Metrics/MethodLength:
+    Max: 20
+Metrics/ParameterLists:
+  MaxOptionalParameters: 4
+Style/AccessModifierDeclarations:
+  Enabled: false
+Style/AsciiComments:
+  Enabled: false
+Style/Documentation:
+  # Too many false positives!
+  Enabled: false
+Style/Encoding:
+  Enabled: false
+Style/EvalWithLocation:
+  Enabled: false
+Style/FormatString:
+  EnforcedStyle: percent
+Style/FormatStringToken:
+  MaxUnannotatedPlaceholdersAllowed: 3
+Style/PerlBackrefs:
+  Enabled: false
+Style/RedundantSelf:
+  Enabled: false
+Style/StructInheritance:
+  Enabled: false
+Style/TrailingCommaInArrayLiteral:
+  Enabled: false
+Style/TrailingCommaInHashLiteral:
+  Enabled: false

data/.solargraph.yml

@@ -0,0 +1,23 @@
+---
+include:
+- "**/*.rb"
+exclude:
+- spec/**/*
+- test/**/*
+- vendor/**/*
+- ".bundle/**/*"
+require: []
+domains: []
+reporters:
+- rubocop
+- require_not_found
+- typecheck: strict
+formatter:
+  rubocop:
+    cops: safe
+    except: []
+    only: []
+    extra_args: []
+require_paths: []
+plugins: []
+max_files: 5000

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-02-02
+
+- Initial release

data/Gemfile

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in netlink.gemspec
+gemspec
+
+group :development do
+  gem 'debase', '~>0.2'
+  gem 'ruby-debug-ide', '~> 0.7'
+  gem 'solargraph', '~>0.22', require: false
+  gem 'yard', '~>0.9', require: false
+end
+
+group :test do
+  gem 'rspec', '~> 3.0'
+  gem 'simplecov', require: false
+end
+
+group :development, :test do
+  gem 'rake'
+end
+
+group :rubocop do
+  gem 'rubocop', '~> 1.0', require: false
+  gem 'rubocop-performance', '~> 1.0', require: false
+  gem 'rubocop-rake', '~> 0.6', require: false
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Sylvain Daubert
+
+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,37 @@
+# Netlink
+
+Ruby library to use Netlink sockets on Linux
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'netlink'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install netlink
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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 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/[USERNAME]/netlink.
+
+## 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,29 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = '-t ~sudo'
+end
+RSpec::Core::RakeTask.new('spec:sudo') do |t|
+  t.rspec_opts = '-t sudo'
+end
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]
+
+# rubocop:disable Lint/SuppressedException
+begin
+  require 'yard'
+
+  YARD::Rake::YardocTask.new do |t|
+    t.files = ['lib/**/*.rb', '-', 'README.md', 'LICENSE.txt']
+    t.options = %w[--no-private]
+  end
+rescue LoadError
+end
+# rubocop:enable Lint/SuppressedException

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'netlink'
+
+# 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/lib/netlink/addrinfo.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'socket'
+require 'forwardable'
+
+module Netlink
+  # AddrInfo for {Socket}.
+  class Addrinfo
+    attr_reader :afamily, :pid, :groups
+
+    # @param [Array(String, Integer, Integer),Array(Integer, Integer, Integer),String] sockaddr array form should be compatible to the value of
+    #   {Socket#addr}. The string should be struct sockaddr as generated by {{Socket.sockaddr_nl}}.
+    def initialize(sockaddr)
+      case sockaddr
+      when Array
+        init_from_array(sockaddr)
+      when String
+        init_from_string(sockaddr)
+      else
+        raise TypeError, 'sockaddr must be a String or an Array'
+      end
+    end
+
+    # returns the socket address as packed struct sockaddr string
+    # @return [String]
+    def to_sockaddr
+      Socket.sockaddr_nl(@pid, @groups)
+    end
+    alias to_s to_sockaddr
+    alias to_str to_sockaddr
+
+    def ==(other)
+      other.is_a?(Addrinfo) && (other.pid == @pid) && (other.groups == @groups)
+    end
+
+    private
+
+    def init_from_array(ary)
+      check_family(ary[0])
+      check_u32(ary[1])
+      check_u32(ary[2])
+      @afamily = Socket::AF_NETLINK
+      @pid = ary[1]
+      @groups = ary[2]
+    end
+
+    def init_from_string(str)
+      ary = str.unpack('SSLL')
+      ary.delete_at(1)
+      init_from_array(ary)
+    end
+
+    def check_family(family)
+      golden = case family
+               when String
+                 'AF_NETLINK'
+               when Integer
+                 Socket::AF_NETLINK
+               else
+                 raise TypeError, "no implicit conversion of #{family.class} to Integer/String"
+               end
+      raise SocketError, "unknown address family: #{family}" unless family == golden
+    end
+
+    def check_u32(value)
+      raise TypeError, "no implicit conversion of #{value.class} to Integer" unless value.is_a?(Integer)
+    end
+  end
+end

data/lib/netlink/nlmsghdr.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Netlink
+  class NlMsgHdr
+    attr_accessor :length
+    attr_reader :type, :flags, :seq, :pid
+
+    # Size of a nlmsgheader
+    SIZE = 16
+    # nlmsghdr pack string
+    PACK_STR = 'LSSLL'
+
+    # Create a +nlmsghdr+ from a pack string
+    # @param [String] str
+    # @return [NlMsgHdr]
+    def self.from_string(str)
+      ary = str.unpack(PACK_STR)
+      new(*ary)
+    end
+
+    # @param [Integer] length message length
+    # @param [Integer] type message type
+    # @param [Integer] flags message flags
+    # @param [Integer] seq message sequence number
+    # @param [Integer] pid message port id
+    def initialize(length, type, flags, seq, pid)
+      @length = length
+      @type = type
+      @flags = flags
+      @seq = seq
+      @pid = pid
+    end
+
+    # @return [String]
+    def to_s
+      [@length, @type, @flags, @seq, @pid].pack(PACK_STR)
+    end
+
+    # Compute +length+ field from +mesg+
+    # @param [String] mesg
+    # @return [Integer]
+    def compute_length(mesg)
+      @length = SIZE + mesg.size
+    end
+  end
+
+  class NlMsgError
+    attr_reader :error_code, :orig_header
+
+    def self.from_string(msg)
+      error_code = msg[0, 4].unpack1('L')
+      orig_header = NlMsgHdr.from_string(msg[4, NlMsgHdr::SIZE])
+      new(error_code, orig_header)
+    end
+
+    def initialize(error_code, orig_header)
+      @error_code = error_code
+      @orig_header = orig_header
+    end
+
+    def to_s
+      [@error_code].pack('L') << @orig_header.to_s
+    end
+
+    def ack?
+      @error_code.zero?
+    end
+  end
+end

data/lib/netlink/socket.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+require 'socket'
+require 'forwardable'
+
+module Netlink
+  # Handle a netlink socket
+  class Socket
+    extend Forwardable
+
+    # Netlink domain socket
+    AF_NETLINK = 16
+    # Default buffer size
+    DEFAULT_BUFFER_SIZE = 32 * 1024
+
+    def_delegators :@socket, :bind, :close, :fileno, :getsockopt, :setsockopt
+
+    class << self
+      # Generate a Port Id from Process Id (on 22 bits) and a counter (on 10 bits)
+      # @return [Integer]
+      def generate_pid
+        @next_pid = Process.pid << 10 unless defined? @next_pid
+
+        pid = @next_pid
+        @next_pid += 1
+        pid
+      end
+
+      alias old_new new
+
+      def new(family)
+        sock = old_new(family)
+        if block_given?
+          begin
+            yield sock
+          ensure
+            sock.close
+          end
+        else
+          sock
+        end
+      end
+      alias open new
+
+      # Pack +pid+ and +groups+ as a {AF_NETLINK} sockaddr string.
+      # @param [Integer] pid
+      # @param [Integer] groups
+      def sockaddr_nl(pid, groups)
+        [AF_NETLINK, 0, pid, groups].pack('SSLL')
+      end
+    end
+
+    # @param [Integer] family Netlink family
+    def initialize(family)
+      @family = family
+      @pid = self.class.generate_pid
+      @socket = ::Socket.new(AF_NETLINK, ::Socket::SOCK_RAW, family)
+      @seqnum = 1
+      @default_buffer_size = DEFAULT_BUFFER_SIZE
+      @groups = 0
+    end
+
+    # @return [Array(String, Integer, Integer)] First element is the socket family name, second is the socket's pid and the third, the groups
+    def addr
+      ['AF_NETLINK', @pid, @groups]
+    end
+
+    # @return [String]
+    def inspect
+      "#<#{self.class}:fd #{@socket.fileno}, AF_NETLINK, #{@family}, #{@pid}>"
+    end
+
+    # Binds a socket to its pid and to given groups
+    # @param [Integer] groups
+    # @return [0]
+    # @raise [Errno]
+    def bind(groups)
+      @groups = groups
+      sockaddr = self.class.sockaddr_nl(@pid, groups)
+      @socket.bind(sockaddr)
+    end
+
+    # Send +mesg+ via socket
+    # @param [String] mesg message to send
+    # @param [Integer] nlm_type Message Type
+    # @param [Integer] nlm_flags Netlink message flags. Should be a bitwise OR of {Netlink}::NLM_F_* constants
+    # @param [Integer] flags +flags+ Socket flags. Should be a bitwise OR of {::Socket}::MSG_* constants
+    # @param [String,Addrinfo,nil] dest_sockaddr
+    # @return [Integer] number of bytes sent
+    def sendmsg(mesg, nlm_type, nlm_flags=0, flags=0, dest_sockaddr=nil)
+      nlmsg = create_nlmsg(mesg, nlm_type, nlm_flags)
+      @socket.sendmsg(nlmsg, flags, dest_sockaddr.to_s)
+    end
+
+    # Receive a message
+    # @param [Integer] maxmesglen maximum number of bytes to receive as message
+    # @param [Integer] flags +flags+ should be a bitwise OR of {::Socket}::MSG_* constants
+    # @return [Array(String, Addrinfo, Integer, NlMsgHdr)] +[mesg, sender_addrinfo, rflags, controls]+ where:
+    #   * +mesg+ is the message as a String or a {NlMsgError},
+    #   * +sender_addrinfo+ is a {Addrinfo} about sender,
+    #   + +controls+ is the ancillary data, here the header of message as a {NlMsgHdr}.
+    # @raise [NlmsgError]
+    def recvmsg(maxmesglen=nil, flags=0)
+      maxmesglen ||= @default_buffer_size
+      maxlen = maxmesglen + NlMsgHdr::SIZE
+      mesg, sender_ai, = @socket.recvmsg(maxlen, flags)
+      hdr = NlMsgHdr.from_string(mesg.slice!(0, NlMsgHdr::SIZE))
+      if hdr.type == NLMSG_ERROR
+        mesg = NlMsgError.from_string(mesg)
+        raise Error, "Error #{mesg.error_code} for message with seq #{mesg.orig_header.seq} from pid #{mesg.orig_header.pid}" unless mesg.ack?
+      end
+
+      mesg = mesg[0, maxmesglen] if mesg.is_a?(String)
+      [mesg, Addrinfo.new(sender_ai.to_sockaddr), hdr]
+    end
+
+    private
+
+    # Create a NlMsg from +mesg+ by adding header and padding
+    # @param [String] mesg
+    # @param [Integer] type message type
+    # @param [Integer] flags +flags+ should be a bitwise OR of {Netlink}::NETLINK_F_* constants
+    # @return [String]
+    def create_nlmsg(mesg, type, flags)
+      hdr = NlMsgHdr.new(0, type, flags, seqnum, @pid)
+      hdr.compute_length(mesg)
+      hdr.to_s << mesg
+    end
+
+    # Return sequence number to use
+    # @return [Integer]
+    def seqnum
+      current_seqnum = @seqnum
+      @seqnum += 1
+      current_seqnum
+    end
+  end
+end

data/lib/netlink/version.rb

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

data/lib/netlink.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require_relative 'netlink/version'
+
+# Pure ruby netlink library
+module Netlink
+  # Base class for Netlink errors
+  class Error < StandardError; end
+  # Error when using {Socket}
+  class SocketError < Error; end
+
+  # Routing/device hook
+  NETLINK_ROUTE	=	0
+  # Reserved for user mode socket protocols
+  NETLINK_USERSOCK = 2
+  # socket monitoring
+  NETLINK_SOCK_DIAG = 4
+  NETLINK_INET_DIAG =	NETLINK_SOCK_DIAG
+  # netfilter/iptables ULOG
+  NETLINK_NFLOG	=	5
+  # ipsec
+  NETLINK_XFRM	=	6
+  # SELinux event notifications
+  NETLINK_SELINUX	=	7
+  # Open-iSCSI
+  NETLINK_ISCSI	=	8
+  # auditing
+  NETLINK_AUDIT	=	9
+  NETLINK_FIB_LOOKUP = 10
+  NETLINK_CONNECTOR = 11
+  # netfilter subsystem
+  NETLINK_NETFILTER = 12
+  NETLINK_IP6_FW	=	13
+  # DECnet routing messages
+  NETLINK_DNRTMSG	=	14
+  # Kernel messages to userspace
+  NETLINK_KOBJECT_UEVENT	= 15
+  NETLINK_GENERIC	=	16
+  # SCSI Transports
+  NETLINK_SCSITRANSPORT	= 18
+  NETLINK_ECRYPTFS = 19
+  NETLINK_RDMA = 20
+  # Crypto layer
+  NETLINK_CRYPTO = 21
+  # SMC monitoring
+  NETLINK_SMC = 22
+
+  # Must be set on all request messages.
+  NLM_F_REQUEST = 0x01
+  # The message is part of a multipart message terminated by NLMSG_DONE.
+  NLM_F_MULTI = 0x02
+  # Request for an acknowlegement on succes.
+  NLM_F_ACK = 0x04
+  # Echo this request.
+  NLM_F_ECHO = 0x08
+
+  NLMSG_NOOP = 1
+  NLMSG_ERROR = 2
+  NLMSG_DONE = 3
+end
+
+require_relative 'netlink/addrinfo'
+require_relative 'netlink/nlmsghdr'
+require_relative 'netlink/socket'

data/netlink.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative 'lib/netlink/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'netlink'
+  spec.version = Netlink::VERSION
+  spec.authors = ['Sylvain Daubert']
+  spec.email = ['sylvain.daubert@laposte.net']
+
+  spec.summary = 'Ruby library to use Netlink sockets on Linux'
+  spec.homepage = 'https://github.com/sdaubert/netlink'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.7.0'
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = 'https://github.com/sdaubert/netlink/CHANGELOG.md'
+
+  # 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(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  # spec.bindir = "exe"
+  # spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # 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
+end

data/sig/netlink.rbs

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

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: netlink
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sylvain Daubert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-02-07 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- sylvain.daubert@laposte.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".solargraph.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/netlink.rb
+- lib/netlink/addrinfo.rb
+- lib/netlink/nlmsghdr.rb
+- lib/netlink/socket.rb
+- lib/netlink/version.rb
+- netlink.gemspec
+- sig/netlink.rbs
+homepage: https://github.com/sdaubert/netlink
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/sdaubert/netlink
+  source_code_uri: https://github.com/sdaubert/netlink
+  changelog_uri: https://github.com/sdaubert/netlink/CHANGELOG.md
+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.2.5
+signing_key: 
+specification_version: 4
+summary: Ruby library to use Netlink sockets on Linux
+test_files: []