telnet-server 1.0.2-java

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1aa85e38d62df8e71c261548b56316fc9ce61a43182cabea836639dcb13732ab
+  data.tar.gz: 6b44b58a27cc8c596f2f681bfdb9ba2d9f4584c7d81f624708c88b2715078e2a
+SHA512:
+  metadata.gz: 471724158c29c74810f0a867c5ad1a795724a6f022ec7b3f5371bc725618b946e2e13bdcec6245d783a497aeb7460f52ca1b5f4daabafa47942d8ae444d865ba
+  data.tar.gz: 507fa086485838d9a6b2404986b89d233d797f030d116cd548685ac3dc2301e613542b0466b21e1e50af36d6dd7d1f61c05d91e8a4423380c5bc746770dbf4f9

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Nels Nelson
+
+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,189 @@
+# telnet-server-jruby
+
+[![License](https://img.shields.io/badge/license-MIT--2.0-blue.svg?style=flat)][license]
+
+This is a small telnet server for [JRuby].
+
+It is based on the [Netty project].  Netty is written in java, but I wanted to write ruby.
+
+
+## Quick-start
+
+Follow these instructions to get a telnet server echo program running.
+
+
+### Container
+
+You may run the telnet server in a container.
+
+```sh
+colima start
+docker-compose up --detach
+nc localhost 21
+docker-compose down
+```
+
+
+Building the image or running the container:
+
+```sh
+docker build --squash --tag telnet-server-jruby .
+docker run --detach --publish 21:21 --name telnet-server-jruby telnet-server-jruby
+```
+
+
+## Manually
+
+Run directly with the required dependencies installed.
+
+### Install asdf
+
+The [asdf] CLI tool used to manage multiple runtime versions.
+
+```sh
+git clone https://github.com/asdf-vm/asdf.git "${HOME}/.asdf" --branch v0.8.1
+pushd "${HOME}/.asdf"; git fetch origin; popd
+source "${HOME}/.asdf/asdf.sh"; source "${HOME}/.asdf/completions/asdf.bash"
+```
+
+### Install required runtime software
+
+Download and install the latest version of the [Java JDK].
+
+```sh
+asdf plugin add java
+asdf install java openjdk-17.0.2
+```
+
+
+Download and install the latest version of [JRuby].
+
+```sh
+asdf plugin add ruby
+asdf plugin update --all
+asdf list all ruby
+asdf install
+```
+
+
+Install the project dependencies.
+
+```sh
+bundle install
+```
+
+
+## Run
+
+The entrypoint for the web application service may now be invoked from a command line interface terminal shell.
+
+```sh
+bundle exec ./telnet.rb &
+nc localhost 21
+```
+
+
+## Build the gem
+
+To clean the project, run unit tests, build the gem file, and verify that the built artifact works, execute:
+
+```sh
+bundle exec rake
+```
+
+
+## Publish the gem
+
+To publish the gem, execute:
+
+```sh
+bundle exec rake publish
+```
+
+
+## Project file tree
+
+Here is a bird's-eye view of the project layout.
+
+```sh
+# date && tree
+Wed Apr  6 23:05:28 CDT 2022
+.
+├── Dockerfile
+├── Gemfile
+├── Gemfile.lock
+├── LICENSE
+├── README.md
+├── Rakefile
+├── docker-compose.yaml
+├── exe
+│   └── telnet
+├── lib
+│   ├── log.rb
+│   ├── server
+│   │   ├── mime_types.rb
+│   │   └── server.rb
+│   ├── telnet
+│   │   ├── config.rb
+│   │   ├── server.rb
+│   │   └── version.rb
+│   ├── telnet_client.rb
+│   └── telnet_server.rb
+├── logs
+│   └── server.log
+├── spec
+│   ├── spec_helper.rb
+│   ├── test_spec.rb
+│   └── verify
+│       └── verify_spec.rb
+├── telnet-server-jruby.gemspec
+└── telnet.rb
+
+13 directories, 52 files
+```
+
+
+## CI linting
+
+Use the GitLab CI Linting API to validate the syntax of a CI definition file.
+
+```sh
+jq --null-input --arg yaml "$(<.gitlab/ci/gem.gitlab-ci.yml)" '.content=$yaml' | curl --silent --location https://gitlab.com/api/v4/ci/lint --header "PRIVATE-TOKEN: ${GITLAB_COM_API_PRIVATE_TOKEN}" --header "Content-Type: application/json" --data @- | jq --raw-output '.errors[0]'
+```
+
+
+## CI configuration
+
+Generate a deploy key.
+
+```sh
+ssh-keygen -t ed25519 -P '' -C deploy_key -f deploy_key_ed25519
+```
+
+Use the GitLab Project-level Variables API to add the deploy key as a ssh private key variable.
+
+```sh
+project_path="nelsnelson/$(basename $(pwd))"
+
+# Test auth token validity
+curl --silent --show-error --location "https://gitlab.com/api/v4/projects" --header "PRIVATE-TOKEN: ${GITLAB_COM_API_PRIVATE_TOKEN}" | jq '.[0]["id"]'
+
+project=$(curl --silent --show-error --location "https://gitlab.com/api/v4/search?scope=projects&search=${project_path}" --header "PRIVATE-TOKEN: ${GITLAB_COM_API_PRIVATE_TOKEN}" | jq --arg project_path "${project_path}" '.[] | select(.path_with_namespace == $project_path)')
+
+project_id=$(curl --silent --show-error --location "https://gitlab.com/api/v4/search?scope=projects&search=${project_path}" --header "PRIVATE-TOKEN: ${GITLAB_COM_API_PRIVATE_TOKEN}" | jq --arg project_path "${project_path}" '.[] | select(.path_with_namespace == $project_path) | .id')
+
+# Add the deploy_token as a CI variable:
+curl --silent --show-error --location --request POST "https://gitlab.com/api/v4/projects/${project_id}/variables" --header "PRIVATE-TOKEN: ${GITLAB_COM_API_PRIVATE_TOKEN}" --form "key=SSH_PRIVATE_KEY" --form "value=$(cat ./deploy_key_ed25519)" --form "protected=true" | jq
+```
+
+Use the Deploy keys API to add a the public deploy key as a deploy key for the project.
+
+```sh
+curl --silent --show-error --location --request POST "https://gitlab.com/api/v4/projects/${project_id}/deploy_keys" --header "PRIVATE-TOKEN: ${GITLAB_COM_API_PRIVATE_TOKEN}" --form "title=deploy_key"  --form "key=$(cat ./deploy_key_ed25519.pub)" --form "can_push=true" | jq
+```
+
+[license]: https://gitlab.com/nelsnelson/telnet-server-jruby/blob/master/LICENSE
+[asdf]: https://asdf-vm.com/
+[Netty project]: https://github.com/netty/netty
+[Java JDK]: https://www.java.com/en/download/
+[JRuby]: https://jruby.org/download

data/Rakefile

@@ -0,0 +1,56 @@
+# encoding: utf-8
+# frozen_string_literal: false
+
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+require 'rake'
+require 'rake/clean'
+
+PROJECT = File.basename(__dir__) unless defined?(PROJECT)
+
+load "#{PROJECT}.gemspec"
+
+CLEAN.add File.join('tmp', '**', '*'), 'tmp'
+CLOBBER.add '*.gem', 'pkg'
+
+task default: %i[package]
+
+desc 'Run the rubocop linter'
+task :lint do
+  system('bundle', 'exec', 'rubocop') or abort
+end
+
+desc 'Run the spec tests'
+task :test do
+  system('bundle', 'exec', 'rspec', '--exclude-pattern', 'spec/verify/**/*_spec.rb') or abort
+end
+task test: :lint
+
+desc 'Explode the gem'
+task :explode do
+  system('jgem', 'install', '--no-document', '--install-dir=tmp', '*.gem')
+end
+task explode: :clean
+
+desc 'Package the gem'
+task :package do
+  system('jgem', 'build')
+end
+task package: %i[clean clobber test]
+
+desc 'Verify the gem'
+task :verify do
+  system('bundle', 'exec', 'rspec', 'spec/verify') or abort
+end
+task verify: :explode
+
+desc 'Publish the gem'
+task :publish do
+  system('jgem', 'push', latest_gem)
+end
+task publish: :verify
+
+def latest_gem
+  `ls -t #{PROJECT}*.gem`.strip.split("\n").first
+end

data/exe/telnet

@@ -0,0 +1,17 @@
+#! /usr/bin/env jruby
+
+# encoding: utf-8
+# frozen_string_literal: false
+
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+# =begin
+#
+# Copyright Nels Nelson 2016-2022 but freely usable (see license)
+#
+# =end
+
+require_relative '../lib/telnet_server'
+
+Object.new.extend(Telnet).main

data/lib/log.rb

@@ -0,0 +1,241 @@
+# encoding: utf-8
+# frozen_string_literal: false
+
+# =begin
+
+# Copyright Nels Nelson 2016-2019 but freely usable (see license)
+
+# =end
+
+require 'java'
+require 'logger'
+
+require 'log4j-2'
+
+require 'fileutils'
+
+# The Logging module
+module Logging
+  module_function
+
+  # rubocop: disable Metrics/MethodLength
+  def config
+    @config ||= begin
+      lib_dir_path = File.expand_path(__dir__)
+      project_dir_path = File.expand_path(File.dirname(lib_dir_path))
+      logs_dir_path = File.expand_path(File.join(project_dir_path, 'logs'))
+      server_log_file = File.expand_path(File.join(logs_dir_path, 'server.log'))
+      {
+        level: :info,
+        name: 'telnet',
+        logs_dir_path: logs_dir_path,
+        server_log_file: server_log_file,
+        rolling_log_file_name_template: 'server-%d{yyyy-MM-dd}.log.gz',
+        logger_pattern_template: '%d{ABSOLUTE} %-5p [%c{1}] %m%n',
+        schedule: '0 0 0 * * ?',
+        size: '100M'
+      }
+    end
+  end
+  # rubocop: enable Metrics/MethodLength
+end
+
+# The LogInitialization module
+module LogInitialization
+  module_function
+
+  def init
+    init_log_file
+    init_log4j if defined? Java
+  end
+
+  def init_log_file
+    FileUtils.mkdir_p(Logging.config[:logs_dir_path])
+    return if File.file?(Logging.config[:server_log_file])
+
+    File.write(Logging.config[:server_log_file], '')
+  end
+
+  # rubocop: disable Metrics/AbcSize
+  # rubocop: disable Metrics/MethodLength
+  def init_log4j(log_level = org.apache.logging.log4j.Level::INFO)
+    server_log_file = Logging.config[:server_log_file]
+    logs_dir_path = Logging.config[:logs_dir_path]
+    rolling_log_file_name_template = Logging.config[:rolling_log_file_name_template]
+    rolling_log_file_path = File.join(logs_dir_path, rolling_log_file_name_template)
+
+    java.lang::System.setProperty('log4j.shutdownHookEnabled', java.lang::Boolean.toString(false))
+    factory = org.apache.logging.log4j.core.config.builder.api::ConfigurationBuilderFactory
+    config = factory.newConfigurationBuilder()
+
+    if log_level.is_a?(Symbol)
+      log_level = org.apache.logging.log4j.Level.to_level(
+        log_level.to_s.upcase
+      )
+    end
+    config.setStatusLevel(log_level)
+    config.setConfigurationName(Logging.config['name'])
+
+    # Create a console appender
+    target = org.apache.logging.log4j.core.appender::ConsoleAppender::Target::SYSTEM_OUT
+    layout = config.newLayout('PatternLayout')
+    layout = layout.addAttribute('pattern', Logging.config[:logger_pattern_template])
+    appender = config.newAppender('stdout', 'CONSOLE')
+    appender = appender.addAttribute('target', target)
+    appender = appender.add(layout)
+    config.add(appender)
+
+    # Create a root logger
+    root_logger = config.newRootLogger(log_level)
+    root_logger = root_logger.add(config.newAppenderRef('stdout'))
+
+    # Create a rolling file appender
+    cron = config.newComponent('CronTriggeringPolicy')
+    cron = cron.addAttribute('schedule', Logging.config[:schedule])
+
+    size = config.newComponent('SizeBasedTriggeringPolicy')
+    size = size.addAttribute('size', Logging.config[:size])
+
+    policies = config.newComponent('Policies')
+    policies = policies.addComponent(cron)
+    policies = policies.addComponent(size)
+
+    appender = config.newAppender('rolling_file', 'RollingFile')
+    appender = appender.addAttribute('fileName', server_log_file)
+    appender = appender.addAttribute('filePattern', rolling_log_file_path)
+    appender = appender.add(layout)
+    appender = appender.addComponent(policies)
+    config.add(appender)
+
+    root_logger = root_logger.addAttribute('additivity', false)
+    root_logger = root_logger.add(config.newAppenderRef('rolling_file'))
+    config.add(root_logger)
+
+    logging_configuration = config.build()
+    ctx = org.apache.logging.log4j.core.config::Configurator.initialize(logging_configuration)
+    ctx.updateLoggers()
+  end
+  # rubocop: enable Metrics/AbcSize
+  # rubocop: enable Metrics/MethodLength
+  # def init_log4j
+end
+# module LogInitialization
+
+::LogInitialization.init
+
+# The Apache log4j Logger class
+# rubocop: disable Style/ClassAndModuleChildren
+class org.apache.logging.log4j.core::Logger
+  alias log4j_error error
+  def error(error_or_message, error = nil)
+    return extract_backtrace(error_or_message) if error.nil?
+    log4j_error(generate_message(error_or_message, error))
+    extract_backtrace(error)
+  end
+
+  def generate_message(error_or_message, error)
+    error_message = "#{error_or_message}: #{error.class.name}"
+    error_message << ": #{error.message}" if error.respond_to?(:message)
+    error_message
+  end
+
+  def extract_backtrace(error, default_result = nil)
+    log4j_error(error)
+    if error.respond_to?(:backtrace)
+      error.backtrace.each { |trace| log4j_error(trace) unless trace.nil? }
+    elsif error.respond_to?(:getStackTrace)
+      error.getStackTrace().each { |trace| log4j_error(trace) unless trace.nil? }
+    else
+      default_result
+    end
+  end
+end
+# rubocop: enable Style/ClassAndModuleChildren
+
+# The Logging module
+module Logging
+  def init_logger(level = :all, logger_name = nil)
+    return init_java_logger(level, logger_name, caller[2]) if defined?(Java)
+    init_ruby_logger(level)
+  end
+
+  def init_ruby_logger(level)
+    logger_instance = Logger.new
+    logger_instance.level = Logging::Level.to_level(level.to_s.upcase)
+    logger_instance
+  end
+
+  # rubocop: disable Metrics/AbcSize
+  def init_java_logger(level, logger_name = nil, source_location = nil)
+    logger_name = get_formatted_logger_name(logger_name)
+    logger_name = source_location.split(/\//).last if logger_name.empty?
+    logger_instance = org.apache.logging.log4j.LogManager.getLogger(logger_name)
+    logger_instance.level = org.apache.logging.log4j.Level.to_level(level.to_s.upcase)
+    logger_instance
+  end
+  # rubocop: enable Metrics/AbcSize
+
+  def get_formatted_logger_name(logger_name = nil)
+    return logger_name.to_s[/\w+$/] unless logger_name.nil?
+    return name[/\w+$/] if is_a?(Class) || is_a?(Module)
+    self.class.name[/\w+$/]
+  end
+
+  def log(level = Logging.log_level, log_name = nil)
+    @log ||= init_logger(level, log_name)
+  end
+  alias logger log
+
+  module_function
+
+  # rubocop: disable Metrics/CyclomaticComplexity
+  # OFF: 0
+  # FATAL: 100
+  # ERROR: 200
+  # WARN: 300
+  # INFO: 400
+  # DEBUG: 500
+  # TRACE: 600
+  # ALL: 2147483647
+  # See: https://logging.apache.org/log4j/2.x/log4j-api/apidocs/org/apache/logging/log4j/Level.html
+  def symbolize_numeric_log_level(level)
+    case level
+    when 5..Float::INFINITY then :off
+    when 4 then :fatal
+    when 3 then :error
+    when 2 then :warn
+    when 1 then :info
+    when 0 then :debug
+    when -1 then :trace
+    when -2..-Float::INFINITY then :all
+    end
+  end
+  # rubocop: enable Metrics/CyclomaticComplexity
+
+  def log_level=(log_level)
+    Logging.config[:level] = symbolize_numeric_log_level(log_level)
+  end
+
+  def log_level
+    Logging.config[:level]
+  end
+end
+# module Logging
+
+# The Module class
+class Module
+  # Universally include Logging
+  include ::Logging
+end
+
+# The Class class
+class Class
+  # Universally include Logging
+  include ::Logging
+end
+
+# The Object class
+class Object
+  # Universally include Logging
+  include ::Logging
+end

data/lib/telnet/argument_parser.rb

@@ -0,0 +1,97 @@
+# encoding: utf-8
+# frozen_string_literal: false
+
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+# =begin
+#
+# Copyright Nels Nelson 2016-2022 but freely usable (see license)
+#
+# =end
+
+require 'optparse'
+
+require_relative 'config'
+require_relative 'version'
+
+# The Telnet module
+module Telnet
+  # The ArgumentsParser class
+  class ArgumentsParser
+    attr_reader :parser, :options
+
+    def initialize(option_parser = OptionParser.new)
+      @parser = option_parser
+      @options = ::Telnet.server_config.dup
+      @flags = %i[banner port idle_reading idle_writing log_requests log_level help version]
+      @flags.each { |method_name| method(method_name).call }
+    end
+
+    def banner
+      @parser.banner = "Usage: #{File.basename($PROGRAM_NAME)} [port] [options]"
+      @parser.separator ''
+      @parser.separator 'Options:'
+    end
+
+    def validated_port(val, integer_pattern = /^\d+$/)
+      raise "Invalid port: #{v}" unless integer_pattern.match?(val.to_s) && val.positive? && val < 65_536
+      val
+    end
+
+    def port
+      description = "Port on which to listen for connections; default: #{@options[:port]}"
+      @parser.on('-p', '--port=<port>', Integer, description) do |v|
+        @options[:port] = validated_port(v).to_i
+      end
+    end
+
+    def idle_reading
+      @parser.on('--idle-reading=seconds', 'Amount of time channel can idle without incoming data') do |v|
+        @options[:idle_reading] = v.to_i
+      end
+    end
+
+    def idle_writing
+      @parser.on('--idle-writing=seconds', 'Amount of time channel can idle without outgoing data') do |v|
+        @options[:idle_writing] = v.to_i
+      end
+    end
+
+    def log_requests
+      @parser.on('-r', '--log-requests', 'Include individual request info in log output') do
+        @options[:log_requests] = true
+      end
+    end
+
+    def log_level
+      @parser.on_tail('-v', '--verbose', 'Increase verbosity') do
+        @options[:log_level] ||= 1
+        @options[:log_level] -= 1
+      end
+    end
+
+    def help
+      @parser.on_tail('-?', '--help', 'Show this message') do
+        puts @parser
+        exit
+      end
+    end
+
+    def version
+      @parser.on_tail('--version', 'Show version') do
+        puts "#{File.basename($PROGRAM_NAME)} version #{::Telnet::VERSION}"
+        exit
+      end
+    end
+  end
+  # class ArgumentsParser
+
+  def parse_arguments(arguments_parser = ::Telnet::ArgumentsParser.new)
+    arguments_parser.parser.parse!(ARGV)
+    arguments_parser.options
+  rescue OptionParser::InvalidOption, OptionParser::AmbiguousOption => e
+    abort e.message
+  end
+end
+# module Telnet

data/lib/telnet/config.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+# frozen_string_literal: false
+
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+# =begin
+#
+# Copyright Nels Nelson 2016-2022 but freely usable (see license)
+#
+# =end
+
+require 'netty'
+
+require 'logger'
+
+# The Telnet module
+module Telnet
+  # rubocop: disable Metrics/MethodLength
+  def server_config
+    @server_config ||= {
+      host: '0.0.0.0',
+      port: 21,
+      ssl: false,
+      idle_reading: 5 * 60, # seconds
+      idle_writing: 30, # seconds
+      log_requests: false,
+      log_level: Logger::INFO,
+      quit_commands: %i[bye cease desist exit leave quit stop terminate],
+      prompt: '>',
+      max_frame_length: 8192,
+      delimiter: Java::io.netty.handler.codec.Delimiters.lineDelimiter
+    }
+  end
+  module_function :server_config
+  # rubocop: enable Metrics/MethodLength
+end