synacrb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4964063b1ca35c7063231c1c10f1d86c088493f0
+  data.tar.gz: a0358c631c43e032dc73ef99785d479bf392d93b
+SHA512:
+  metadata.gz: f4e7277192867a5e82655c3f586a40a8ad4e9da8cb4bd0e43d4580deb256dc93f7123b7639752712c7364a9681e754744609a895fb2a29cdcfd422f33048dc58
+  data.tar.gz: 0ddd97c3a7dbbae5f8070fbd55ba33350fd1055b432a305ec1e9e15ef95e728982ead47ab614f26bd92d52a9b7f28988617adae7c25773b5f13c2b27c8e78079

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+synacrb-*.gem

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gem "msgpack"
+gem "openssl"
+
+# Specify your gem's dependencies in synacrb.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    synacrb (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    msgpack (1.1.0)
+    openssl (2.0.6)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  msgpack
+  openssl
+  rake (~> 10.0)
+  synacrb!
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 jD91mZM2
+
+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,55 @@
+# synacrb
+
+This is a Ruby library for synac.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'synacrb'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install synacrb
+
+## Usage
+
+Example:  
+```Ruby
+session = Synacrb::Session.new "<address>", "<certificate hash>"
+session.login_with_token true, "<username>", "<token>" # true indicates bot account
+
+# First message should be LoginSuccess or an error
+result = session.read
+# TODO: Use result
+
+# Initiate state
+state = Synacrb::State.new
+
+# Main loop
+loop do
+    packet = session.read
+    state.update packet
+    # TODO: Use packet
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/jD91mZM2/synacrb.
+
+## 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,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "synacrb"
+
+# 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/packets.rb

@@ -0,0 +1,203 @@
+module Synacrb
+    module Common
+        DEFAULT_PORT = 8439
+        TYPING_TIMEOUT = 10
+
+        LIMIT_USER_NAME = 128
+        LIMIT_CHANNEL_NAME = 128
+        LIMIT_GROUP_NAME = 128
+        LIMIT_GROUP_AMOUNT = 2048
+        LIMIT_MESSAGE = 16384
+
+        LIMIT_BULK = 64
+
+        ERR_GROUP_INVALID_POS = 1
+        ERR_GROUP_LOCKED_NAME = 2
+        ERR_LIMIT_REACHED = 3
+        ERR_LOGIN_BANNED = 4
+        ERR_LOGIN_BOT = 5
+        ERR_LOGIN_INVALID = 6
+        ERR_MAX_CONN_PER_IP = 7
+        ERR_MISSING_FIELD = 8
+        ERR_MISSING_PERMISSION = 9
+        ERR_NAME_TAKEN = 10
+        ERR_UNKNOWN_BOT = 11
+        ERR_UNKNOWN_CHANNEL = 12
+        ERR_UNKNOWN_GROUP = 13
+        ERR_UNKNOWN_MESSAGE = 14
+        ERR_UNKNOWN_USER = 15
+
+        PERM_READ = 1
+        PERM_WRITE = 1 << 1
+
+        PERM_ASSIGN_GROUPS = 1 << 2
+        PERM_BAN = 1 << 3
+        PERM_MANAGE_CHANNELS = 1 << 4
+        PERM_MANAGE_GROUPS = 1 << 5
+        PERM_MANAGE_MESSAGES = 1 << 6
+
+        Channel = Struct.new(:id, :name, :overrides)
+        Group = Struct.new(:allow, :deny, :id, :name, :pos, :unassignable)
+        Message = Struct.new(:author, :channel, :id, :text, :timestamp, :timestamp_edit)
+        User = Struct.new(:ban, :bot, :groups, :id, :name)
+
+        # CLIENT PACKETS
+        PACKET_CLOSE_ID = 0;              Close = Class.new
+        PACKET_ERR_ID = 1;
+        PACKET_RATELIMIT_ID = 2;
+        PACKET_CHANNELCREATE_ID = 3;      ChannelCreate = Struct.new(:name, :overrides)
+        PACKET_CHANNELDELETE_ID = 4;      ChannelDelete = Struct.new(:id)
+        PACKET_CHANNELUPDATE_ID = 5;      ChannelUpdate = Struct.new(:inner, :keep_overrides)
+        PACKET_COMMAND_ID = 6;            Command = Struct.new(:args, :recipient)
+        PACKET_GROUPCREATE_ID = 7;        GroupCreate = Struct.new(:allow, :deny, :name, :pos, :unassignable)
+        PACKET_GROUPDELETE_ID = 8;        GroupDelete = Struct.new(:id)
+        PACKET_GROUPUPDATE_ID = 9;        GroupUpdate = Struct.new(:inner)
+        PACKET_LOGIN_ID = 10;             Login = Struct.new(:bot, :name, :password, :token)
+        PACKET_LOGINUPDATE_ID = 11;       LoginUpdate = Struct.new(:name, :password_current, :password_new, :reset_token)
+        PACKET_MESSAGECREATE_ID = 12;     MessageCreate = Struct.new(:channel, :text)
+        PACKET_MESSAGEDELETE_ID = 13;     MessageDelete = Struct.new(:id)
+        PACKET_MESSAGEDELETEBULK_ID = 14; MessageDeleteBulk = Struct.new(:channel, :ids)
+        PACKET_MESSAGELIST_ID = 15;       MessageList = Struct.new(:after, :before, :channel, :limit)
+        PACKET_MESSAGEUPDATE_ID = 16;     MessageUpdate = Struct.new(:id, :text)
+        PACKET_PRIVATEMESSAGE_ID = 17;    PrivateMessage = Struct.new(:text, :recipient)
+        PACKET_TYPING_ID = 18;            Typing = Struct.new(:channel)
+        PACKET_USERUPDATE_ID = 19;        UserUpdate = Struct.new(:ban, :groups, :id)
+
+        # SERVER PACKETS
+        PACKET_CHANNELDELETERECEIVE_ID = 20; ChannelDeleteReceive = Struct.new(:inner)
+        PACKET_CHANNELRECEIVE_ID = 21;       ChannelReceive = Struct.new(:inner)
+        PACKET_COMMANDRECEIVE_ID = 22;       CommandReceive = Struct.new(:args, :author)
+        PACKET_GROUPDELETERECEIVE_ID = 23;   GroupDeleteReceive = Struct.new(:inner)
+        PACKET_GROUPRECEIVE_ID = 24;         GroupReceive = Struct.new(:inner, :new)
+        PACKET_LOGINSUCCESS_ID = 25;         LoginSuccess = Struct.new(:created, :id, :token)
+        PACKET_MESSAGEDELETERECEIVE_ID = 26; MessageDeleteReceive = Struct.new(:id)
+        PACKET_MESSAGERECEIVE_ID = 27;       MessageReceive = Struct.new(:inner, :new)
+        PACKET_PMRECEIVE_ID = 28;            PMReceive = Struct.new(:author, :text)
+        PACKET_TYPINGRECEIVE_ID = 29;        TypingReceive = Struct.new(:author, :channel)
+        PACKET_USERRECEIVE_ID = 30;          UserReceive = Struct.new(:inner)
+
+        def self.packet_from_id(id)
+            case id
+            when PACKET_CLOSE_ID
+                Close
+            when PACKET_CHANNELCREATE_ID
+                ChannelCreate
+            when PACKET_CHANNELDELETE_ID
+                ChannelDelete
+            when PACKET_CHANNELUPDATE_ID
+                ChannelUpdate
+            when PACKET_COMMAND_ID
+                Command
+            when PACKET_GROUPCREATE_ID
+                GroupCreate
+            when PACKET_GROUPDELETE_ID
+                GroupDelete
+            when PACKET_GROUPUPDATE_ID
+                GroupUpdate
+            when PACKET_LOGIN_ID
+                Login
+            when PACKET_LOGINUPDATE_ID
+                LoginUpdate
+            when PACKET_MESSAGECREATE_ID
+                MessageCreate
+            when PACKET_MESSAGEDELETE_ID
+                MessageDelete
+            when PACKET_MESSAGEDELETEBULK_ID
+                MessageDeleteBulk
+            when PACKET_MESSAGELIST_ID
+                MessageList
+            when PACKET_MESSAGEUPDATE_ID
+                MessageUpdate
+            when PACKET_PRIVATEMESSAGE_ID
+                PrivateMessage
+            when PACKET_TYPING_ID
+                Typing
+            when PACKET_USERUPDATE_ID
+                UserUpdate
+            when PACKET_CHANNELDELETERECEIVE_ID
+                ChannelDeleteReceive
+            when PACKET_CHANNELRECEIVE_ID
+                ChannelReceive
+            when PACKET_COMMANDRECEIVE_ID
+                CommandReceive
+            when PACKET_GROUPDELETERECEIVE_ID
+                GroupDeleteReceive
+            when PACKET_GROUPRECEIVE_ID
+                GroupReceive
+            when PACKET_LOGINSUCCESS_ID
+                LoginSuccess
+            when PACKET_MESSAGEDELETERECEIVE_ID
+                MessageDeleteReceive
+            when PACKET_MESSAGERECEIVE_ID
+                MessageReceive
+            when PACKET_PMRECEIVE_ID
+                PMReceive
+            when PACKET_TYPINGRECEIVE_ID
+                TypingReceive
+            when PACKET_USERRECEIVE_ID
+                UserReceive
+            end
+        end
+        def self.packet_to_id(packet)
+            if packet.instance_of? Close
+                PACKET_CLOSE_ID
+            elsif packet.instance_of? ChannelCreate
+                PACKET_CHANNELCREATE_ID
+            elsif packet.instance_of? ChannelDelete
+                PACKET_CHANNELDELETE_ID
+            elsif packet.instance_of? ChannelUpdate
+                PACKET_CHANNELUPDATE_ID
+            elsif packet.instance_of? Command
+                PACKET_COMMAND_ID
+            elsif packet.instance_of? GroupCreate
+                PACKET_GROUPCREATE_ID
+            elsif packet.instance_of? GroupDelete
+                PACKET_GROUPDELETE_ID
+            elsif packet.instance_of? GroupUpdate
+                PACKET_GROUPUPDATE_ID
+            elsif packet.instance_of? Login
+                PACKET_LOGIN_ID
+            elsif packet.instance_of? LoginUpdate
+                PACKET_LOGINUPDATE_ID
+            elsif packet.instance_of? MessageCreate
+                PACKET_MESSAGECREATE_ID
+            elsif packet.instance_of? MessageDelete
+                PACKET_MESSAGEDELETE_ID
+            elsif packet.instance_of? MessageDeleteBulk
+                PACKET_MESSAGEDELETEBULK_ID
+            elsif packet.instance_of? MessageList
+                PACKET_MESSAGELIST_ID
+            elsif packet.instance_of? MessageUpdate
+                PACKET_MESSAGEUPDATE_ID
+            elsif packet.instance_of? PrivateMessage
+                PACKET_PRIVATEMESSAGE_ID
+            elsif packet.instance_of? Typing
+                PACKET_TYPING_ID
+            elsif packet.instance_of? UserUpdate
+                PACKET_USERUPDATE_ID
+            elsif packet.instance_of? ChannelDeleteReceive
+                PACKET_CHANNELDELETERECEIVE_ID
+            elsif packet.instance_of? ChannelReceive
+                PACKET_CHANNELRECEIVE_ID
+            elsif packet.instance_of? CommandReceive
+                PACKET_COMMANDRECEIVE_ID
+            elsif packet.instance_of? GroupDeleteReceive
+                PACKET_GROUPDELETERECEIVE_ID
+            elsif packet.instance_of? GroupReceive
+                PACKET_GROUPRECEIVE_ID
+            elsif packet.instance_of? LoginSuccess
+                PACKET_LOGINSUCCESS_ID
+            elsif packet.instance_of? MessageDeleteReceive
+                PACKET_MESSAGEDELETERECEIVE_ID
+            elsif packet.instance_of? MessageReceive
+                PACKET_MESSAGERECEIVE_ID
+            elsif packet.instance_of? PMReceive
+                PACKET_PMRECEIVE_ID
+            elsif packet.instance_of? TypingReceive
+                PACKET_TYPINGRECEIVE_ID
+            elsif packet.instance_of? UserReceive
+                PACKET_USERRECEIVE_ID
+            end
+        end
+    end
+end

data/lib/state.rb

@@ -0,0 +1,71 @@
+module Synacrb
+    class State
+        def initialize
+            @channels = {}
+            @groups   = {}
+            @users    = {}
+        end
+        def channels
+            @channels
+        end
+        def groups
+            @groups
+        end
+        def users
+            @users
+        end
+        def update(packet)
+            if packet.instance_of? Common::ChannelDeleteReceive
+                unless packet.inner.instance_of? Common::Channel
+                    packet.inner = Common::Channel.new(*packet.inner)
+                end
+                @channels.delete packet.inner.id
+            elsif packet.instance_of? Common::ChannelReceive
+                unless packet.inner.instance_of? Common::Channel
+                    packet.inner = Common::Channel.new(*packet.inner)
+                end
+                @channels[packet.inner.id] = packet.inner
+            elsif packet.instance_of? Common::GroupDeleteReceive
+                unless packet.inner.instance_of? Common::Group
+                    packet.inner = Common::Group.new(*packet.inner)
+                end
+                for id in @groups.each_key
+                    if @groups[id].pos > packet.inner.pos
+                        @groups[id].pos -= 1
+                    end
+                end
+                @groups.delete packet.inner.id
+            elsif packet.instance_of? Common::GroupReceive
+                unless packet.inner.instance_of? Common::Group
+                    packet.inner = Common::Group.new(*packet.inner)
+                end
+                if packet.new
+                    unless @groups[packet.inner.id].nil?
+                        pos = @groups[packet.inner.id].pos
+
+                        if packet.inner.pos > pos
+                            for id in @groups.each_key
+                                if @groups[id].pos > pos && @groups[id].pos <= packet.inner.pos
+                                    @groups[id].pos -= 1
+                                end
+                            end
+                        elsif packet.inner.pos < pos
+                            for group in @groups.each_key
+                                if @groups[id].pos >= packet.inner.pos && @groups[id].pos < pos
+                                    @groups[id].pos += 1
+                                end
+                            end
+                        end
+                    else
+                        for group in @groups.each_key
+                            if @groups[id].pos >= packet.inner.pos
+                                @groups[id].pos += 1
+                            end
+                        end
+                    end
+                end
+                @groups[packet.inner.id] = packet.inner
+            end
+        end
+    end
+end

data/lib/synacrb/version.rb

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

data/lib/synacrb.rb

@@ -0,0 +1,82 @@
+require "state.rb"
+require "packets.rb"
+
+require "msgpack"
+require "openssl"
+require "socket"
+require "synacrb/version"
+
+module Synacrb
+    class Session
+        # Connect to the server
+        def initialize(addr, hash, &callback)
+            tcp = TCPSocket.new addr, 8439
+
+            @hash = hash
+
+            context = OpenSSL::SSL::SSLContext.new
+            if callback.nil?
+                callback = method(:verify_callback)
+            end
+            context.verify_callback = callback
+            context.verify_mode = OpenSSL::SSL::VERIFY_PEER
+
+            @stream = OpenSSL::SSL::SSLSocket.new tcp, context
+            @stream.connect
+        end
+        # OpenSSL verify callback used by initialize when optional callback argument isn't set.
+        def verify_callback(_, cert)
+            pem = cert.current_cert.public_key.to_pem
+            sha256 = OpenSSL::Digest::SHA256.new
+            hash = sha256.digest(pem).unpack("H*")
+
+            hash[0].casecmp(@hash).zero?
+        end
+
+        # Returns inner connection
+        def inner_stream()
+            @stream
+        end
+
+        # Sends the login packet with specific password.
+        # Read the result with `read`.
+        # Warning: Strongly disencouraged. Use tokens instead, when possible.
+        def login_with_password(bot, name, password)
+            send Common::Login.new(bot, name, password, nil)
+        end
+
+        # Sends the login packet with specific token.
+        # Read the result with `read`.
+        def login_with_token(bot, name, token)
+            send Common::Login.new(bot, name, nil, token)
+        end
+
+        # Transmit a packet over the connection
+        def send(packet)
+            id = Common.packet_to_id(packet)
+            data = [id, [packet.to_a]].to_msgpack
+            size1 = data.length >> 8
+            size2 = data.length % 256
+
+            @stream.write [size1, size2].pack("U*")
+            @stream.write data
+        end
+
+        # Read a packet from the connection
+        def read()
+            size_a = @stream.read 2
+            size = (size_a[0].ord << 8) + size_a[1].ord
+            data = @stream.read size
+
+            data = MessagePack.unpack data
+            class_ = Common.packet_from_id data[0]
+            class_.new *data[1][0]
+        end
+
+        # Close the connection
+        def close()
+            send(Common::Close)
+            @stream.close
+        end
+    end
+end

data/synacrb.gemspec

@@ -0,0 +1,33 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "synacrb/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "synacrb"
+  spec.version       = Synacrb::VERSION
+  spec.authors       = ["jD91mZM2"]
+  spec.email         = ["me@krake.one"]
+
+  spec.summary       = %q{synac library for ruby.}
+  spec.homepage      = "https://github.com/jD91mZM2/synacrb"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: synacrb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- jD91mZM2
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- me@krake.one
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/packets.rb
+- lib/state.rb
+- lib/synacrb.rb
+- lib/synacrb/version.rb
+- synacrb.gemspec
+homepage: https://github.com/jD91mZM2/synacrb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: synac library for ruby.
+test_files: []