card-mod-api_key 0.11.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1fcb9c135c5326571c3b819a9ec738cb8eee20df645d43b5d168c3ba65d18b32
+  data.tar.gz: f1ecbaa490b2f226b82ffe8c515b863320cc11e9232c6d6bce6c43c71e1ea05a
+SHA512:
+  metadata.gz: 0c3b0c73e799123380e7fd8af851d87a60e0e248e1bacf4acbead02404914faffdace23eaedd518f13720e98fea7df055f61d8e81a90bec1990ad411c3cf8dd7
+  data.tar.gz: 60d90897d2282a579262490346489f41421b13527a6c2b183114a766e1e6f039219f1322c6c5662965565dc3df5a2dbe9cf455c8f88df06f5bb827a78b83442b

data/config/initializers/api_key.rb

@@ -0,0 +1 @@
+Card::Auth.extend Card::Auth::ApiKey

data/lib/card/auth/api_key.rb

@@ -0,0 +1,35 @@
+require "jwt"
+
+class Card
+  module Auth
+    # methods for setting current account
+    module ApiKey
+      def signin_with opts={}
+        if opts[:token]
+          signin_with_token opts[:token]
+        elsif opts[:api_key]
+          signin_with_api_key opts[:api_key]
+        else
+          signin_with_session
+        end
+      end
+
+      # set the current user based on api_key
+      def signin_with_api_key api_key
+        account = find_account_by_api_key api_key
+        unless account&.authenticate_api_key api_key
+          raise Card::Error::PermissionDenied, "API key authentication failed"
+        end
+
+        signin account.left_id
+      end
+
+      # find +\*account card by +\*api card
+      # @param api_key [String]
+      # @return [+*account card, nil]
+      def find_account_by_api_key api_key
+        find_account_by :api_key, api_key.strip
+      end
+    end
+  end
+end

data/set/right/account.rb

@@ -0,0 +1,9 @@
+card_accessor :api_key
+
+delegate :authenticate_api_key, to: :api_key_card
+
+format :html do
+  view :api_key do
+    field_nest :api_key
+  end
+end

data/set/right/api_key.rb

@@ -0,0 +1,85 @@
+include_set Abstract::AccountField
+
+event :generate_api_key, :prepare_to_validate, trigger: :required do
+  generate
+end
+
+event :validate_api_key, :validate do
+  errors.add :content, t(:api_key_invalid) unless content.match?(/^\w{20,}$/)
+  errors.add :content, t(:api_key_taken) if api_key_taken?
+end
+
+def api_key_taken?
+  return false unless (acct = Card::Auth.find_account_by_api_key content)
+  acct.id == left_id
+end
+
+def history?
+  false
+end
+
+def ok_to_read
+  own_account? || super
+end
+
+def ok_to_create
+  own_account? || super
+end
+
+def authenticate_api_key api_key
+  return true unless (error = api_key_validation_error api_key)
+
+  errors.add error, t(error)
+  false
+end
+
+def generate
+  self.content = SecureRandom.base64.tr "+/=", "Qrt"
+end
+
+def generate!
+  generate.tap { save! }
+end
+
+def simple_token
+  Card::Auth::Token.encode accounted.id
+end
+
+private
+
+def api_key_validation_error api_key
+  case
+  when !real?
+    :api_key_not_found
+  when content != api_key
+    :api_key_incorrect
+  end
+end
+
+format :json do
+  view :token do
+    { token: card.simple_token }
+  end
+end
+
+format :html do
+  view :core, unknown: true, template: :haml
+
+  %i[titled titled_content].each do |viewname|
+    view(viewname, unknown: true) { super() }
+  end
+
+  view :token_link do
+    link_to t(:api_key_get_jwt_token), path: { format: :json, view: :token }
+  end
+
+  view :generate_button, perms: :update, unknown: true do
+    text = card.content.present? ? t(:api_key_regenerate) : t(:api_key_generate)
+    card_form :update do
+      [
+        hidden_tags(card: { trigger: :generate_api_key }),
+        submit_button(text: text, disable_with: t(:api_key_generating))
+      ]
+    end
+  end
+end

data/set/right/api_key/core.haml

@@ -0,0 +1,11 @@
+.api-key-core
+  .current-api-key
+    - if card.content.present?
+      %label{ for: :current_api_key }
+        = t :api_key_label
+
+      = text_field_tag :current_api_key, card.content, readonly: true
+    - else
+      %em No key.
+  .api-key-generate-button
+    = render_generate_button

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: card-mod-api_key
+version: !ruby/object:Gem::Version
+  version: 0.11.4
+platform: ruby
+authors:
+- Ethan McCutchen
+- Philipp Kühl
+- Gerry Gleason
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-05-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: card
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.101.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.101.4
+- !ruby/object:Gem::Dependency
+  name: card-mod-account
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.11.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.11.4
+description: ''
+email:
+- info@decko.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- config/initializers/api_key.rb
+- lib/card/auth/api_key.rb
+- set/right/account.rb
+- set/right/api_key.rb
+- set/right/api_key/core.haml
+homepage: https://decko.org
+licenses:
+- GPL-3.0
+metadata:
+  source_code_uri: https://github.com/decko-commons/decko
+  homepage_uri: https://decko.org
+  bug_tracker_uri: https://github.com/decko-commons/decko/issues
+  wiki_uri: https://decko.org
+  documentation_url: http://docs.decko.org/
+  card-mod: api_key
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: API Keys and JWT Tokens for Decko
+test_files: []