vaas 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d825f4cbd3edbbdf6d391ad3dcc1257b30c3df7c9a2e53f1caae99bc57036bf3
+  data.tar.gz: 29ef4d52405ef1381b63a9f68e014446f9fadc58bc16bd810bbea2f75066ccc6
+SHA512:
+  metadata.gz: fed95ea1cf2622afabbd5d85b9fa884e02a8a4b009f8f04711d70c7a23248fb7598b433341e8f7f997ddecdbdecdbf4802c17eb88bfac27728843e443702a0bd
+  data.tar.gz: 9a796c1a3c49e384db42d727370caca6fcd8b72f16b5f64fe667fa409f2833695d622949e8c816ce1731e50812116379d14c7c542c29d4be890108eb9ab6b805

data/.devcontainer/Dockerfile

@@ -0,0 +1,26 @@
+# [Choice] Ruby version (use -bullseye variants on local arm64/Apple Silicon): 3, 3.1, 3.0, 2, 2.7, 2.6, 3-bullseye, 3.1-bullseye, 3.0-bullseye, 2-bullseye, 2.7-bullseye, 2.6-bullseye, 3-buster, 3.1-buster, 3.0-buster, 2-buster, 2.7-buster, 2.6-buster
+ARG VARIANT=3
+FROM mcr.microsoft.com/devcontainers/ruby:${VARIANT}
+
+# Install Rails
+RUN gem install rails webdrivers
+
+# Default value to allow debug server to serve content over GitHub Codespace's port forwarding service
+# The value is a comma-separated list of allowed domains 
+ENV RAILS_DEVELOPMENT_HOSTS=".githubpreview.dev,.app.github.dev"
+
+# [Choice] Node.js version: lts/*, 16, 14, 12, 10
+ARG NODE_VERSION="lts/*"
+RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"
+
+ENV BUNDLE_PATH="~/.gems"
+
+# [Optional] Uncomment this section to install additional OS packages.
+# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+#     && apt-get -y install --no-install-recommends <your-package-list-here>
+
+# [Optional] Uncomment this line to install additional gems.
+# RUN gem install <your-gem-names-here>
+
+# [Optional] Uncomment this line to install global node packages.
+# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g <your-package-here>" 2>&1

data/.devcontainer/devcontainer.json

@@ -0,0 +1,26 @@
+{
+	"name": "Ruby on Rails (Community)",
+	"build": {
+		"dockerfile": "Dockerfile"
+	},
+
+	// Configure tool-specific properties.
+	"customizations": {
+		// Configure properties specific to VS Code.
+		"vscode": {
+			// Add the IDs of extensions you want installed when the container is created.
+			"extensions": [
+				"rebornix.Ruby"
+			]
+		}
+	},
+	
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	// "postCreateCommand": "ruby --version",
+
+	// Set `remoteUser` to `root` to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
+	"remoteUser": "vscode"
+}

data/.vscode/launch.json

@@ -0,0 +1,21 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Rails App",
+            "type": "Ruby",
+            "request": "launch",
+            // Current dir using env variable input in tasks.json
+            "cwd": "${workspaceRoot}/test-project", 
+            // run bundle install before rails server
+            "preLaunchTask": "Create test-project",
+            "program": "bin/rails",
+            "postDebugTask": "Delete test-project",
+            // Setup debug binding IP and port.
+            "args": ["s", "-b", "0.0.0.0", "-p", "3000"], 
+        }
+    ]
+}

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,97 @@
+# vaas
+
+An SDK to easily utilize G DATA VaaS.
+
+_Verdict-as-a-Service_ (VaaS) is a service that provides a platform for scanning files for malware and other threats. It allows easy integration in your application. With a few lines of code, you can start scanning files for malware.
+
+## What does the SDK do?
+
+It gives you as a developer a functions to talk to G DATA VaaS. It wraps away the complexity of the API into 3 basic functions.
+
+### for_sha256
+
+If you calculate the sha256 for a file, you can request that sha256 against G DATA VaaS. It's the fastest way to get a verdict from our service.
+
+### for_url
+
+If you want to request if a file behind a URL is safe, you can specify the URL as well. Depending on the file size, the duration for the analysis can vary.
+
+### for_file
+
+You can also ask for a file itself. You will still get the benefit of a fast verdict via Sha256 because the SDK will do that for you first. But additionally, if we don't know the file, the file will get uploaded and (automatically) analyzed by us.
+
+## How to use
+
+### Installation
+
+This gem works only on a Linux distribution!
+```bash
+gem install vaas
+```
+
+### Require
+
+```ruby
+require 'async'
+require 'vaas/client_credentials_grant_authenticator'
+require 'vaas/vaas_main'
+```
+
+### Request a verdict
+
+Authentication & Initializing:
+```ruby
+authenticator = VAAS::ClientCredentialsGrantAuthenticator.new(
+  CLIENT_ID,
+  CLIENT_SECRET,
+  TOKEN_URL,
+  SSL_VERIFICATION
+)
+vaas = VAAS::VaasMain.new
+token = authenticator.get_token
+```
+
+Verdict Request for SHA256:
+```ruby
+Async do
+  Async { vaas.connect(token) }.wait
+  sha256 = "275a021bbfb6489e54d471899f7db9d1663fc695ec2fe2a2c4538aabf651fd0f"
+  verdict = vaas.for_sha256(sha256)
+ensure
+  vaas.close
+end
+```
+
+Verdict Request for a file:
+```ruby
+Async do
+  Async { vaas.connect(token) }.wait
+  path = "/path/to/file"
+  verdict = vaas.for_file(path)
+ensure
+  vaas.close
+end
+```
+
+Verdict Request for a URL:
+```ruby
+Async do
+  Async { vaas.connect(token) }.wait
+  url = "https://www.gdatasoftware.com/oem/verdict-as-a-service"
+  verdict = vaas.for_url(url)
+ensure
+  vaas.close
+end
+```
+
+Verdict Object:
+```ruby
+# A verdict object has a sha256, verdict and guid
+sha256 = verdict.sha256
+detection = verdict.verdict
+guid = verdict.guid
+```
+
+## <a name="interested"></a>I'm interested in VaaS
+
+You need credentials to use the service in your application. If you are interested in using VaaS, please [contact us](mailto:oem@gdata.de).

data/examples/example_with_lists.rb

@@ -0,0 +1,37 @@
+require 'async'
+require 'vaas/client_credentials_grant_authenticator'
+require 'vaas/vaas_main'
+
+CLIENT_ID = ENV.fetch('CLIENT_ID')
+CLIENT_SECRET = ENV.fetch('CLIENT_SECRET')
+PATHS = ENV.fetch('PATHS')
+
+def main
+  authenticator = VAAS::ClientCredentialsGrantAuthenticator.new(
+    CLIENT_ID,
+    CLIENT_SECRET,
+    "https://keycloak-vaas.gdatasecurity.de/realms/vaas/protocol/openid-connect/token"
+  )
+
+  # create a vaas object and get a token to authenticate
+  vaas = VAAS::VaasMain.new
+  token = authenticator.get_token
+
+  Async do
+    # wait to connect and authenticate
+    Async { vaas.connect(token) }.wait
+
+    # simple loop to get the verdict of a list of files
+    PATHS.each do |file|
+      verdict = vaas.for_file(file)
+      puts "Verdict #{verdict.sha256} is detected as #{verdict.verdict}"
+    end
+
+  ensure
+    vaas.close
+  end
+end
+
+if __FILE__  == $0
+  main
+end

data/examples/example_with_reconnect.rb

@@ -0,0 +1,42 @@
+require 'async'
+require 'vaas/client_credentials_grant_authenticator'
+require 'vaas/vaas_main'
+
+CLIENT_ID = ENV.fetch('CLIENT_ID')
+CLIENT_SECRET = ENV.fetch('CLIENT_SECRET')
+PATH = ENV.fetch('PATH')
+
+def main
+  authenticator = VAAS::ClientCredentialsGrantAuthenticator.new(
+    CLIENT_ID,
+    CLIENT_SECRET,
+    "https://keycloak-vaas.gdatasecurity.de/realms/vaas/protocol/openid-connect/token"
+  )
+
+  # create a vaas object and get a token to authenticate
+  vaas = VAAS::VaasMain.new
+  token = authenticator.get_token
+
+  Async do
+    # wait to connect and authenticate
+    Async { vaas.connect(token) }.wait
+
+    # reconnect if connection closed
+    begin
+      verdict = vaas.for_file(PATH)
+    rescue VAAS::VaasConnectionClosedError
+      token = authenticator.get_token
+      Async { vaas.connect(token) }.wait
+      retry
+    end
+
+    puts "Verdict #{verdict.sha256} is detected as #{verdict.verdict}"
+
+  ensure
+    vaas.close
+  end
+end
+
+if __FILE__  == $0
+  main
+end

data/examples/simple_example.rb

@@ -0,0 +1,36 @@
+require 'async'
+require 'vaas/client_credentials_grant_authenticator'
+require 'vaas/vaas_main'
+
+CLIENT_ID = ENV.fetch('CLIENT_ID')
+CLIENT_SECRET = ENV.fetch('CLIENT_SECRET')
+PATH = ENV.fetch('PATH')
+
+def main
+  authenticator = VAAS::ClientCredentialsGrantAuthenticator.new(
+    CLIENT_ID,
+    CLIENT_SECRET,
+    "https://keycloak-vaas.gdatasecurity.de/realms/vaas/protocol/openid-connect/token"
+  )
+
+  # create a vaas object and get a token to authenticate
+  vaas = VAAS::VaasMain.new
+  token = authenticator.get_token
+
+  Async do
+    # wait to connect and authenticate
+    Async { vaas.connect(token) }.wait
+
+    # simple method to get the verdict of a file
+    verdict = vaas.for_file(PATH)
+
+    puts "Verdict #{verdict.sha256} is detected as #{verdict.verdict}"
+
+  ensure
+    vaas.close
+  end
+end
+
+if __FILE__  == $0
+  main
+end

data/lib/vaas/client_credentials_grant_authenticator.rb

@@ -0,0 +1,33 @@
+require 'json'
+require 'async'
+require 'async/http/internet'
+
+module VAAS
+  class ClientCredentialsGrantAuthenticator
+
+    attr_accessor :client_id, :client_secret, :token_endpoint, :token
+
+    def initialize(client_id, client_secret, token_endpoint)
+      @client_id = client_id
+      @client_secret = client_secret
+      @token_endpoint = token_endpoint
+    end
+
+    def get_token
+      Async do
+        client = Async::HTTP::Internet.new
+
+        header = [['content-type', 'application/x-www-form-urlencoded']]
+        body = ["grant_type=client_credentials&client_id=#{client_id}&client_secret=#{client_secret}"]
+
+        response = client.post(token_endpoint, header, body)
+        self.token = JSON.parse(response.read)['access_token']
+      rescue => e
+        raise VaasAuthenticationError, e
+      ensure
+        client&.close
+      end
+      token
+    end
+  end
+end

data/lib/vaas/vaas_errors.rb

@@ -0,0 +1,31 @@
+module VAAS
+  class VaasAuthenticationError < StandardError
+    def initialize(msg = "authentication failed")
+      super
+    end
+  end
+
+  class VaasTimeoutError < StandardError
+    def initialize(msg = "connection has timed out")
+      super
+    end
+  end
+
+  class VaasInvalidStateError < StandardError
+    def initialize(msg = "connect() was not called")
+      super
+    end
+  end
+
+  class VaasConnectionClosedError < StandardError
+    def initialize(msg = "connection closed")
+      super
+    end
+  end
+
+  class VaasUploadError < StandardError
+    def initialize(msg = "upload failed")
+      super
+    end
+  end
+end

data/lib/vaas/vaas_main.rb

@@ -0,0 +1,139 @@
+require 'async'
+require 'async/http/endpoint'
+require 'async/websocket/client'
+require 'async/http/internet'
+require 'json'
+require 'securerandom'
+require 'digest'
+require 'protocol/http/body/file'
+require 'uri'
+
+require_relative 'vaas_verdict'
+require_relative 'vaas_errors'
+
+module VAAS
+  class VaasMain
+
+    attr_accessor :session_id, :websocket, :url
+
+    def initialize(url="wss://gateway-vaas.gdatasecurity.de")
+      @url = url
+    end
+
+    def connect(token)
+      # connect to endpoint
+      endpoint = Async::HTTP::Endpoint.parse(url, alpn_protocols: Async::HTTP::Protocol::HTTP1.names)
+      self.websocket = Async::WebSocket::Client.connect(endpoint)
+
+      # send authentication request
+      auth_request = JSON.generate({:kind => "AuthRequest", :token => token})
+      websocket.write(auth_request)
+
+      # receive authentication message
+      while message = websocket.read
+        message = JSON.parse(message)
+        if message['success'] == true
+          self.session_id = message['session_id']
+          break
+        else
+          raise VaasAuthenticationError
+        end
+      end
+    end
+
+    def get_authenticated_websocket
+      raise VaasInvalidStateError unless websocket
+      raise VaasInvalidStateError, "connect() was not awaited" unless session_id
+      raise VaasConnectionClosedError if websocket.closed?
+      websocket
+    end
+
+    def close
+        websocket&.close
+    end
+
+    def __for_sha256(sha256, guid)
+      # send verdict request with sha256
+      websocket = get_authenticated_websocket
+      guid = guid || SecureRandom.uuid.to_s
+      verdict_request =  JSON.generate({:kind => "VerdictRequest",
+                                        :session_id => session_id,
+                                        :sha256 => sha256,
+                                        :guid => guid})
+      websocket.write(verdict_request)
+
+      # receive verdict message
+      while message = websocket.read
+        message = JSON.parse(message)
+        if message['kind'] == "VerdictResponse"
+          return message
+        end
+      end
+    end
+
+    def for_sha256(sha256, guid = nil)
+      response = __for_sha256(sha256, guid)
+      VaasVerdict.new(response)
+    end
+
+    def for_file(path, guid = nil)
+      # get sha256 of file and send verdict request
+      sha256 = Digest::SHA256.file(path).hexdigest
+      response = __for_sha256(sha256, guid)
+
+      # upload file if verdict is unknown
+      if response['verdict'] == 'Unknown'
+        upload(response, path)
+      else
+        return VaasVerdict.new(response)
+      end
+
+      # receive verdict message of uploaded file
+      while message = websocket.read
+        message = JSON.parse(message)
+        if message['kind'] == "VerdictResponse" && message['verdict'] != "Unknown"
+          return VaasVerdict.new(message)
+        end
+      end
+    end
+
+    def for_url(url, guid = nil)
+      #send verdict request with url
+      websocket = get_authenticated_websocket
+      guid = guid || SecureRandom.uuid.to_s
+      url = URI(url).to_s
+      verdict_request =  JSON.generate({:kind => "VerdictRequestForUrl",
+                                        :session_id => session_id,
+                                        :guid => guid,
+                                        :url => url})
+      websocket.write(verdict_request)
+
+      # receive verdict message
+      while message = websocket.read
+        message = JSON.parse(message)
+        if message['kind'] == "VerdictResponse"
+          return VaasVerdict.new(message)
+        end
+      end
+    end
+
+    def upload (message, path)
+      token = message['upload_token']
+      url = message['url']
+
+      Async do
+        client = Async::HTTP::Internet.new
+
+        header = [['authorization', token]]
+        body = Protocol::HTTP::Body::File.open(File.join(path))
+
+        client.put(url, header, body).read
+
+      rescue => e
+        raise VaasUploadError, e
+      ensure
+        client&.close
+      end
+    end
+  end
+end

data/lib/vaas/vaas_verdict.rb

@@ -0,0 +1,13 @@
+module VAAS
+  class VaasVerdict
+
+    attr_reader :sha256, :verdict, :guid
+
+    def initialize(response)
+      @sha256 = response['sha256']
+      @verdict = response['verdict']
+      @guid = response['guid']
+    end
+
+  end
+end

data/lib/vaas/version.rb

@@ -0,0 +1,3 @@
+module VAAS
+  VERSION = '1.0.1'
+end

data/lib/vaas.rb

@@ -0,0 +1 @@
+require 'vaas/version'

data/vaas.gemspec

@@ -0,0 +1,23 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vaas/version'
+Gem::Specification.new do |s|
+  s.name        = "vaas"
+  s.version     = VAAS::VERSION
+  s.summary     = "Verdict as a Service by G Data"
+  s.description = "Simple gem to get the verdict of files from G Data"
+  s.authors     = ["Allie Weitenkamp"]
+  s.email       = "opensource@gdata.de"
+  s.files       = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  s.homepage    = "https://github.com/GDATASoftwareAG/vaas"
+  s.license     = "MIT"
+  s.require_paths = ["lib"]
+  s.metadata = { "documentation_uri" => "https://github.com/GDATASoftwareAG/vaas/blob/main/ruby/README.md" }
+
+  s.add_dependency 'async', '~> 2.3.1'
+  s.add_dependency 'async-http', '~> 0.59.4'
+  s.add_dependency 'async-websocket', '~> 0.22.1'
+
+  s.add_development_dependency "minitest", '~> 5.17.0'
+  s.add_development_dependency 'dotenv', '~> 2.8.1'
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: vaas
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Allie Weitenkamp
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-01-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: async
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.1
+- !ruby/object:Gem::Dependency
+  name: async-http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.59.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.59.4
+- !ruby/object:Gem::Dependency
+  name: async-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.1
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.17.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.17.0
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.1
+description: Simple gem to get the verdict of files from G Data
+email: opensource@gdata.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".devcontainer/Dockerfile"
+- ".devcontainer/devcontainer.json"
+- ".vscode/launch.json"
+- Gemfile
+- README.md
+- examples/example_with_lists.rb
+- examples/example_with_reconnect.rb
+- examples/simple_example.rb
+- lib/vaas.rb
+- lib/vaas/client_credentials_grant_authenticator.rb
+- lib/vaas/vaas_errors.rb
+- lib/vaas/vaas_main.rb
+- lib/vaas/vaas_verdict.rb
+- lib/vaas/version.rb
+- vaas.gemspec
+homepage: https://github.com/GDATASoftwareAG/vaas
+licenses:
+- MIT
+metadata:
+  documentation_uri: https://github.com/GDATASoftwareAG/vaas/blob/main/ruby/README.md
+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: []
+rubygems_version: 3.3.26
+signing_key: 
+specification_version: 4
+summary: Verdict as a Service by G Data
+test_files: []