ssport 0.1.9 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d93c3b4dcefc0328486247025c567371c15c34640430974bb271bd61a781051
-  data.tar.gz: 771ad0d1d6bc99dd9b2f2b180f79b2f5e3127c7b72a84c64dfb82483c9f494b9
+  metadata.gz: 858bc1dec0c69355534c02d5a8637fd2644ba6a29176af078815b5d6d30eaf53
+  data.tar.gz: 1cca30caf55e621e3daa37d1ffb9bafce82fc26845436471faa1681275f1ed13
 SHA512:
-  metadata.gz: '022218f878bfb895de06ffc27ec4de4f7f4ef26740a87dbcb21e060321c9e032ea436964ec79f5c4e9d5ea38b206bd648a99d16b1e4a5f22f08cf773bb7e7a62'
-  data.tar.gz: f50cc46040b765a7b1200dbcce41bb1959afa79c3460f2651578605477ed1ec427c2b1037f2fb947af9bee2e0409fa6f1edfe521f5ace238e496ffdcff604a9a
+  metadata.gz: aee8f274d207456a7b61b8003c0610b6249533fe9862693e116dd23405b0900671145c79b19fdc8e299a5a4b238d76cbcade6660303d141b491d6913dc8d5905
+  data.tar.gz: 2e94ad21c11606ce691fe917697db9352d53c24980f81cf0ed8b6416442e2629cc01456f4945cd9fb5ea263f1c9a0c4336ebfa166bb082ecc3c49186746f174d

data/README.md

@@ -1,34 +1,82 @@
 # Ssport
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ssport`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+由于Shadowsocket时不时端口就被墙了。每次都要经过一下步骤`登录服务器` -> `修改配置文件` -> `重启SS服务` 来换端口号或者加密方式。虽然步骤不多，每次及密码修改重启这些命令和密码记忆起来也麻烦，毕竟都是不常用的命令。为节省大家时间，于是写了一个命令行工具，可以一个命令行解决所有，省去繁杂操作。
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'ssport'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
     $ gem install ssport
 
 ## Usage
 
-TODO: Write usage instructions here
-
-## 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+由于该工具使用ruby写的，请确保服务器上安装了`ruby`环境和`gems`。
+
+##### 帮助： `ssport -h` 查看。
+
+    Usage: change shadowsocket port
+    -S host                          ssh server host
+    -A, --server aliasName           ssh server alia name, eg: ssport -a ramnode -b 724
+    -L, --list                       list available server alia name
+    -U, --username username          ssh server username
+    -P, --pass password              ssh server password
+    -b, --bind port                  shadowsocket server bind port
+    -p, --password password          shadowsocket password
+    -m, --method method              shadowsocket encry method
+    -c, --config filepath            shadowsocket config file path
+
+
+* S 服务器地址 
+* A 服务器别名，记录之后下次直接用别名不用每次都输入`服务器地址`,`服务器用户名`和`服务器密码`。例如： `ssport -S 119.44.97.96:9090 -U root -P 123456 -A bandwagon`。 下次直接用`ssport -A bandwagon -b 8970` 就可以修改端口号了。
+* L 显示所有的服务器别名
+* U 服务器SSH登录的用户名，因为需要读写权限，请确保用户有权限。或者直接用root更方便。
+* P SSH登录的密码
+* b 设置SS需要绑定的端口号
+* p 设置SS需要修改的新密码
+* m 设置SS需要修改的加密方法
+* c 指定SS服务的配置文件位置
+
+如果您遇到需要修改SS配置的情况，可以尝试使用该命令行来解决您的问题。
+
+##### 查看配置
+
+如何只查看SS的配置呢。 很简单，只要不加修改的选项就可以了。例如：`ssport -A bandwagon`, 显示内容如下：
+
+    ---------Bengin Deal /etc/shadowsocks.json ------------
+    -------------Old Config---------------
+    {
+    "server": "47.192.99.110",
+    "server_port": "8081",
+    "local_address": "127.0.0.1",
+    "local_port": 1080,
+    "password": "ssport",
+    "timeout": 300,
+    "method": "rc4-md5",
+    "fast_open": false,
+    "workers": 1
+    }
+    -------------New Config---------------
+    {
+    "server": "47.192.99.110",
+    "server_port": "8081",
+    "local_address": "127.0.0.1",
+    "local_port": 1080,
+    "password": "ssport",
+    "timeout": 300,
+    "method": "rc4-md5",
+    "fast_open": false,
+    "workers": 1
+    }
+
+原本的配置和新的配置一模一样，也就是任何内容都未曾改变。用于方便的查看SS配置。
+
+
+###### 修改配置
+
+* 修改端口号并添加主机别名为ramnode： `ssport -S 47.192.99.110 -P 123456 -U root -c /etc/shadowsocks.json -b 805 -A ramnode`
+* 修改端口号: `ssport -A ramnode -b 903`
+* 修改加密方法: `ssport -A ramnode -m rc4-md5`
+* 修改端口号、加密方法、密码：`ssport -A ramnode -b 900 -m rc4-md5 -p 123456`
+
+以上内容都是虚构的地址和用户名密码，请替换成你自己的进行操作。
 
 ## Contributing
 

data/lib/ssport/config.rb

@@ -21,11 +21,11 @@ class Config
     end
 
     def parseConfig
-        puts "---------bengin parse #{@config_file} ------------".colorize(:yellow)
+        puts "---------Bengin Deal #{@config_file} ------------".colorize(:yellow)
         if File.exist? @config_file 
             file_content = File.read @config_file
             @config_json = JSON.parse file_content
-            puts "-------------old config---------------".colorize(:yellow)
+            puts "-------------Old Config---------------".colorize(:yellow)
             puts JSON.pretty_generate(@config_json)
         else 
             puts "Config 文件不存在".colorize(:red)
@@ -44,7 +44,7 @@ class Config
         changeField @@PASSWORD , :password
         changeField @@METHOD , :method
         final_config = JSON.pretty_generate(@config_json)
-        puts "-------------new config---------------".colorize(:yellow)
+        puts "-------------New Config---------------".colorize(:yellow)
         puts final_config
         File.write @config_file , final_config 
     end

data/lib/ssport/profile.rb

@@ -0,0 +1,59 @@
+require 'json'
+require 'colorize'
+
+class Profile
+
+    def initialize(options)
+        @options = options
+        @alias_name = @options[:alias]
+    end
+
+    def genrc(alias_name) 
+        if !File.directory?(File.expand_path("~/.ssport"))
+            `mkdir ~/.ssport`
+        end
+        File.expand_path "~/.ssport/#{alias_name}.rc"
+    end
+
+    def list
+         alias_names = Dir[File.expand_path "~/.ssport/*"].select{ |f| File.file? f }.map{ |f| File.basename f, ".rc"}.join "\n"
+         puts '----------Alias Name----------'.colorize(:yellow)
+         puts alias_names.colorize(:green)
+    end
+   
+    def dealrc
+        if @alias_name 
+            server = @options[:server]
+            username = @options[:username]
+            pass = @options[:pass]
+            if server || username || pass
+                return saverc
+            else 
+                return loadrc
+            end
+        end 
+        return nil
+    end
+
+    def saverc
+        if @alias_name 
+            rc = JSON.pretty_generate(@options)
+            File.write genrc(@alias_name), rc  
+            return @options
+        end
+        return nil
+    end
+
+    def loadrc
+        if @alias_name 
+            rc_content = File.read genrc(@alias_name)
+            rc = JSON.parse(rc_content)
+            final_rc = rc.collect{|k,v| [k.to_sym, v]}.to_h
+            return final_rc
+        else
+            puts "Don't find server alias name profile.".colorize(:red)
+        end
+        return nil
+    end
+
+end

data/lib/ssport/remote.rb

@@ -0,0 +1,73 @@
+require 'json'
+require 'colorize'
+require 'net/ssh'
+require 'ssport/version'
+
+class Remote
+    
+    def initialize(options)
+        @options = options
+    end
+    
+    def check?(keys) 
+        keys.each do |key| 
+          if !@options[key]
+            puts "#! Please set :server".colorize(:red)
+            return false
+          end
+        end
+        return true
+    end
+
+    def genCommand(keys) 
+        command = "ssport -c #{@options[:config]}"
+        keys.each do |key|
+            if @options[key] 
+                if key == :port
+                    command += " -b #{@options[key]}"
+                else 
+                    command += " --#{key} #{@options[key]}"
+                end
+            end
+        end
+        return command
+    end
+
+    def genScript
+        command = genCommand [:password , :method, :port, :config]
+        script = %Q{
+          if ! [ -x "$(command -v ssport)" ]; then
+            gem install ssport
+          else 
+            if [ `ssport -v` != "#{Ssport::VERSION}" ]; then 
+                gem update ssport
+            fi
+          fi
+          #{command}
+          ssserver -c #{@options[:config]} -d restart
+          }
+        script
+    end
+    
+    def ssh
+        if !check?([:server, :username, :pass, :config])
+          return 
+        end
+    
+        puts "Begin Connect #{@options[:server]}".colorize(:yellow)
+    
+        output = ""
+        script = genScript
+    
+        Net::SSH.start(@options[:server], @options[:username], :password => @options[:pass]) do |ssh|
+          # capture all stderr and stdout output from a remote process
+          output = ssh.exec!(script)
+        end
+    
+        puts '----------------Remote---------------'.colorize(:yellow)
+        puts output
+        puts '------------------End------------------'.colorize(:yellow)
+    
+    end
+
+end

data/lib/ssport/version.rb

@@ -1,3 +1,3 @@
 module Ssport
-  VERSION = "0.1.9"
+  VERSION = "0.2.0"
 end

data/lib/ssport.rb

@@ -1,16 +1,41 @@
 require "ssport/version"
 require "ssport/config"
+require "ssport/profile"
+require "ssport/remote"
 require "colorize"
 require 'fileutils'
 require 'optparse'
-require 'net/ssh'
+require 'json'
 
 module Ssport
 
   def self.run 
 
+    methods_des = %Q{
+                                    Sodium:
+                                        chacha20-poly1305, chacha20-ietf-poly1305,
+                                        xchacha20-ietf-poly1305,
+                                        sodium:aes-256-gcm,
+                                        salsa20, chacha20, chacha20-ietf.
+                                    Sodium 1.0.12:
+                                        xchacha20
+                                    OpenSSL:
+                                        aes-{128|192|256}-gcm, aes-{128|192|256}-cfb,
+                                        aes-{128|192|256}-ofb, aes-{128|192|256}-ctr,
+                                        camellia-{128|192|256}-cfb,
+                                        bf-cfb, cast5-cfb, des-cfb, idea-cfb,
+                                        rc2-cfb, seed-cfb,
+                                        rc4, rc4-md5, table.
+                                    OpenSSL 1.1:
+                                        aes-{128|192|256}-ocb
+                                    mbedTLS:
+                                        mbedtls:aes-{128|192|256}-cfb128,
+                                        mbedtls:aes-{128|192|256}-ctr,
+                                        mbedtls:camellia-{128|192|256}-cfb128,
+                                        mbedtls:aes-{128|192|256}-gcm
+    }
+
     options = {}
-    options[:config] = "shadowsocks.json"
     OptionParser.new do |opts|
       opts.banner = "Usage: change shadowsocket port"
 
@@ -18,6 +43,14 @@ module Ssport
         options[:server] = v
       end
 
+      opts.on("-A", "--server aliasName", "ssh server alia name, eg: ssport -a ramnode -b 724") do |v|
+        options[:alias] = v
+      end
+
+      opts.on("-L", "--list", "list available server alia name") do |v|
+        options[:list] = true
+      end
+
       opts.on("-U", "--username username", "ssh server username") do |v|
         options[:username] = v
       end
@@ -34,7 +67,7 @@ module Ssport
         options[:password] = v 
       end
 
-      opts.on("-m", "--method method","shadowsocket encry method") do |v|
+      opts.on("-m", "--method method","shadowsocket encry method. methods: \n #{methods_des}") do |v|
         options[:method] = v 
       end
 
@@ -42,10 +75,38 @@ module Ssport
         options[:config] = v 
       end
 
+      opts.on("-v", "--version","ssport version") do |v|
+        options[:version] = true 
+      end
+
     end.parse!
 
+    if options[:version] 
+      puts Ssport::VERSION
+      return 
+    end
+
+    if options[:list] 
+      profile = Profile.new(options) 
+      profile.list 
+      return 
+    end
+
+    alias_name = options[:alias]
+    if alias_name 
+      profile = Profile.new(options) 
+      rc = profile.dealrc
+      if rc
+        changeOption options, rc, :server
+        changeOption options, rc, :username
+        changeOption options, rc, :pass
+        changeOption options, rc, :config
+      end
+    end
+
     if options[:server] 
-      ssh options
+      remote = Remote.new(options)
+      remote.ssh
     elsif options[:config]
       config = Config.new(options)
       config.run
@@ -53,26 +114,12 @@ module Ssport
 
   end
 
-  def self.ssh(options) 
-
-    output = ""
-
-    Net::SSH.start(options[:server], options[:username], :password => options[:pass]) do |ssh|
-      # capture all stderr and stdout output from a remote process
-      script = %Q{
-      if ! [ -x "$(command -v ssport)" ]; then
-        gem install ssport
-      fi
-      ssport -b #{options[:port]} -c #{options[:config]}
-      ssserver -c #{options[:config]} 
-      }
-      output = ssh.exec!(script)
+  def self.changeOption(options, rc, key) 
+    opt_value = options[key]
+    rc_value = rc[key]
+    if !opt_value && rc_value 
+      options[key] = rc_value 
     end
-
-    puts '----------------Remote---------------'.colorize(:yellow)
-    puts output
-    puts '------------------End------------------'.colorize(:yellow)
-
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ssport
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.2.0
 platform: ruby
 authors:
 - kaich
@@ -97,6 +97,8 @@ files:
 - bin/ssport
 - lib/ssport.rb
 - lib/ssport/config.rb
+- lib/ssport/profile.rb
+- lib/ssport/remote.rb
 - lib/ssport/version.rb
 - ssport.gemspec
 homepage: ''