adsedare_mattermost 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a92050cd6e8dd6610198027bf17ba4e479bc40752985ca4cf34b4d32a102f372
-  data.tar.gz: 7207561a73e6f0f28b95d174945dc5ea49bd118340af32708d1a9cc1db01714f
+  metadata.gz: 910c2116de9894ffb0f2d69ee48c003248d52365d0116c14a20728ad13998098
+  data.tar.gz: 25d14bdd3d61ef71cfedfe2d5a9224b344e523c7f9151712fadbd1e1e618441a
 SHA512:
-  metadata.gz: c1e1e6acdee7d71ceb6e6559b2edd4771c1450861c2e712d14c06186f0aad9fb9067d8e014517f19fe9b6c25f8aeadb715e96b70af3598167682dc95266d442b
-  data.tar.gz: 151289e26448f8786150a2a35bfd5a14fc37ca61d1c92f78c356a3979670ab5df9f3125d79611ec1a912d94a8fcd6bed81e66d097c205c78e13dca9c42d8f735
+  metadata.gz: 73aae8a481990d322b960edc67cc1df6788107d2bc46850ea2e39d8ca1eae671db9c186e5c971de49336da0fe0ceece5d7415724273d8c1f1a765ce00c47e981
+  data.tar.gz: d7ad2c2e732bb15c1db8b50532b3a149261ab1be3b9cb272598a24f4d5e923bbbaeec04e004cb8c8f5704a141f7ffb226bc45a716a1e21f4a6413dbc16ee72cb

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 alexstrnik
+
+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,33 @@
+# AdSedareMattermost
+
+AdSedareMattermost is a two-factor authentication provider for Adsedare that uses Mattermost to receive the 2FA code. It expects a lambda function that will extract the 2FA code from the array fo latest messages. This way it can be used with any SMS relay bots. It will wait for the 2FA code for a specified amount of time and retry if lambda function does not return a value.
+
+## Configuration
+
+```bash
+export ADSEDARE_MM_TOKEN="mrm_your_bot_token"
+export ADSEDARE_MM_HOST="https://your_mattermost_instance.com"
+
+export ADSEDARE_MM_TEAM_ID="your_team_id"
+# or
+export ADSEDARE_MM_TEAM_NAME="Your Team Name"
+
+export ADSEDARE_MM_CHANNEL_ID="your_channel_id"
+# or
+export ADSEDARE_MM_CHANNEL_NAME="Your Channel Name"
+
+export ADSEDARE_MM_TIMEOUT_SECONDS="5" # How many seconds to wait for the 2FA code
+export ADSEDARE_MM_RETRY_LIMIT="5" # How many times to retry
+```
+
+## Usage
+
+```ruby
+# TODO: Update after Adsedare release
+provider = AdsedareMattermost::Provider.new(
+    lambda do |messages|
+        messages.last.match(/\d{6}/).to_s
+    end
+)
+Starship::set_provider(provider)
+```

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/adsedare_mattermost.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "lib/adsedare_mattermost/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "adsedare_mattermost"
+  spec.version = AdsedareMattermost::VERSION
+  spec.authors = ["alexstrnik"]
+  spec.email = ["alex.str.nik@gmail.com"]
+
+  spec.summary = "AdSedare 2FA Provider via Mattermost bot"
+  spec.description = "AdSedare 2FA Provider via Mattermost bot"
+  spec.homepage = "https://github.com/AlexStrNik/AdsedareMattermost"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/AlexStrNik/AdsedareMattermost"
+
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
+    end
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "adsedare", "~> 0.0.6"
+  spec.add_dependency "faraday", "~> 2.7"
+end

data/lib/adsedare_mattermost/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module AdsedareMattermost
+  VERSION = "0.0.3"
+end

data/lib/adsedare_mattermost.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+require "adsedare"
+require "faraday"
+
+require_relative "adsedare_mattermost/version"
+
+module AdsedareMattermost
+  class Error < StandardError; end
+
+  class Provider < Starship::TwoFactorProvider
+    include Logging
+
+    def initialize(
+      extract_2fa_code = nil
+    )
+      @extract_2fa_code = extract_2fa_code
+      unless @extract_2fa_code
+        raise Error, "Pass extract_2fa_code block"
+      end
+
+      @token = ENV["ADSEDARE_MM_TOKEN"]
+      @mm_host = ENV["ADSEDARE_MM_HOST"]
+
+      @team_id = ENV["ADSEDARE_MM_TEAM_ID"]
+      team_name = ENV["ADSEDARE_MM_TEAM_NAME"]
+
+      @channel_id = ENV["ADSEDARE_MM_CHANNEL_ID"]
+      channel_name = ENV["ADSEDARE_MM_CHANNEL_NAME"]
+
+      unless @token
+        raise Error, "ADSEDARE_MM_TOKEN is not set"
+      end
+
+      unless @mm_host
+        raise Error, "ADSEDARE_MM_HOST is not set"
+      end
+
+      unless team_name || @team_id
+        raise Error, "ADSEDARE_MM_TEAM_NAME and ADSEDARE_MM_TEAM_ID is not set"
+      end
+
+      unless @team_id
+        logger.warn "ADSEDARE_MM_TEAM_ID is not set, will find by name: #{team_name}"
+        @team_id = my_teams.find { |team| team["display_name"] == team_name }["id"]
+        raise Error, "Team #{team_name} not found" unless @team_id
+        logger.info "Using team: #{@team_id}"
+      end
+
+      unless channel_name || @channel_id
+        raise Error, "ADSEDARE_MM_CHANNEL_NAME and ADSEDARE_MM_CHANNEL_ID is not set"
+      end
+
+      unless @channel_id
+        logger.warn "ADSEDARE_MM_CHANNEL_ID is not set, will find by name: #{channel_name}"
+        @channel_id = my_channels.find { |channel| channel["display_name"] == channel_name }["id"]
+        raise Error, "Channel #{channel_name} not found" unless @channel_id
+        logger.info "Using channel: #{@channel_id}"
+      end
+
+      @timeout_seconds = ENV["ADSEDARE_MM_TIMEOUT_SECONDS"] || 5
+      @retry_limit = ENV["ADSEDARE_MM_RETRY_LIMIT"] || 5
+      @since = Time.now
+
+      @retry_counter = 0
+    end
+
+    def my_teams
+      response = Faraday.get("#{@mm_host}/api/v4/users/me/teams") do |req|
+        req.headers["Authorization"] = "Bearer #{@token}"
+      end
+      raise Error, "Failed to get teams" unless response.success?
+
+      JSON.parse(response.body)
+    end
+
+    def my_channels
+      response = Faraday.get("#{@mm_host}/api/v4/users/me/teams/#{@team_id}/channels") do |req|
+        req.headers["Authorization"] = "Bearer #{@token}"
+      end
+      raise Error, "Failed to get channels" unless response.success?
+
+      JSON.parse(response.body)
+    end
+
+    def latest_posts
+      response = Faraday.get("#{@mm_host}/api/v4/channels/#{@channel_id}/posts?since=#{@since.to_i}") do |req|
+        req.headers["Authorization"] = "Bearer #{@token}"
+      end
+      raise Error, "Failed to get messages" unless response.success?
+
+      JSON.parse(response.body)["posts"]
+    end
+
+    def retry_get_code
+      if @retry_counter > @retry_limit
+        return nil
+      end
+
+      logger.info "Retry #{@retry_counter} of #{@retry_limit}"
+      logger.info "Waiting for #{@timeout_seconds} seconds for 2FA code..."
+
+      sleep(@timeout_seconds)
+  
+      # Update before request, since we dont want to miss messages due to any network delays
+      new_since = (Time.now.to_f * 1000).to_i
+
+      latest_messages = latest_posts.values.map { |post| post["message"] }
+      code = @extract_2fa_code.call(latest_messages)
+
+      @since = new_since
+      @retry_counter += 1
+
+      return code if code
+
+      retry_get_code
+    end
+
+    def get_code(session_id, scnt)      
+      @retry_counter = 1
+      # Just to be sure we dont miss messages because Apple sends it before we got there
+      @since = (Time.now.to_f * 1000).to_i - 3000
+      
+      code = retry_get_code
+
+      return code if code
+      raise Error, "2FA code not found"
+    end
+
+    def can_handle?(type)
+      true
+    end
+  end
+end

metadata

@@ -1,28 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: adsedare_mattermost
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - alexstrnik
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-05-08 00:00:00.000000000 Z
+date: 2025-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: adsedare
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.6
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -43,13 +44,20 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- adsedare_mattermost.gemspec
+- lib/adsedare_mattermost.rb
+- lib/adsedare_mattermost/version.rb
 homepage: https://github.com/AlexStrNik/AdsedareMattermost
 licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/AlexStrNik/AdsedareMattermost
   source_code_uri: https://github.com/AlexStrNik/AdsedareMattermost
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -64,7 +72,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.3
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: AdSedare 2FA Provider via Mattermost bot
 test_files: []