licensekit-ruby 0.1.0.alpha.0

data/lib/licensekit/generated/operation_scopes.rb

@@ -0,0 +1,314 @@
+# Generated by scripts/generate_from_openapi.rb. Do not edit manually.
+
+module LicenseKit
+  module Generated
+    OPERATION_SCOPES = {
+      "assignLicenseFeature" => {
+        method: "POST",
+        path: "/api/v1/licenses/{id}/features",
+        scopes: ["license:write"].freeze
+      },
+      "blacklistLicenseDevice" => {
+        method: "POST",
+        path: "/api/v1/licenses/{id}/devices/{device_id}/blacklist",
+        scopes: ["device:write"].freeze
+      },
+      "createAPIKey" => {
+        method: "POST",
+        path: "/api/v1/api-keys",
+        scopes: ["admin"].freeze
+      },
+      "createCustomer" => {
+        method: "POST",
+        path: "/api/v1/customers",
+        scopes: ["admin"].freeze
+      },
+      "createFeature" => {
+        method: "POST",
+        path: "/api/v1/products/{id}/features",
+        scopes: ["product:write"].freeze
+      },
+      "createLicense" => {
+        method: "POST",
+        path: "/api/v1/licenses",
+        scopes: ["license:write"].freeze
+      },
+      "createOrder" => {
+        method: "POST",
+        path: "/api/v1/products/{id}/orders",
+        scopes: ["product:write"].freeze
+      },
+      "createPolicy" => {
+        method: "POST",
+        path: "/api/v1/products/{id}/policies",
+        scopes: ["product:write"].freeze
+      },
+      "createProduct" => {
+        method: "POST",
+        path: "/api/v1/products",
+        scopes: ["product:write"].freeze
+      },
+      "createProductCustomFieldDefinition" => {
+        method: "POST",
+        path: "/api/v1/products/{id}/custom-fields",
+        scopes: ["product:write"].freeze
+      },
+      "createProductVersion" => {
+        method: "POST",
+        path: "/api/v1/products/{id}/versions",
+        scopes: ["product:write"].freeze
+      },
+      "createSubscription" => {
+        method: "POST",
+        path: "/api/v1/products/{id}/subscriptions",
+        scopes: ["product:write"].freeze
+      },
+      "createWebhookEndpoint" => {
+        method: "POST",
+        path: "/api/v1/webhooks",
+        scopes: ["webhook:write"].freeze
+      },
+      "deleteCustomer" => {
+        method: "DELETE",
+        path: "/api/v1/customers/{id}",
+        scopes: ["admin"].freeze
+      },
+      "deletePolicy" => {
+        method: "DELETE",
+        path: "/api/v1/policies/{id}",
+        scopes: ["product:write"].freeze
+      },
+      "deleteProduct" => {
+        method: "DELETE",
+        path: "/api/v1/products/{id}",
+        scopes: ["product:write"].freeze
+      },
+      "deleteProductCustomFieldDefinition" => {
+        method: "DELETE",
+        path: "/api/v1/products/{id}/custom-fields/{field_id}",
+        scopes: ["product:write"].freeze
+      },
+      "deleteWebhookEndpoint" => {
+        method: "DELETE",
+        path: "/api/v1/webhooks/{id}",
+        scopes: ["webhook:write"].freeze
+      },
+      "getCustomer" => {
+        method: "GET",
+        path: "/api/v1/customers/{id}",
+        scopes: ["admin"].freeze
+      },
+      "getFeature" => {
+        method: "GET",
+        path: "/api/v1/features/{id}",
+        scopes: ["product:read"].freeze
+      },
+      "getLicense" => {
+        method: "GET",
+        path: "/api/v1/licenses/{id}",
+        scopes: ["license:read"].freeze
+      },
+      "getLicenseDevice" => {
+        method: "GET",
+        path: "/api/v1/licenses/{id}/devices/{device_id}",
+        scopes: ["license:read"].freeze
+      },
+      "getOrder" => {
+        method: "GET",
+        path: "/api/v1/orders/{id}",
+        scopes: ["product:read"].freeze
+      },
+      "getPolicy" => {
+        method: "GET",
+        path: "/api/v1/policies/{id}",
+        scopes: ["product:read"].freeze
+      },
+      "getProduct" => {
+        method: "GET",
+        path: "/api/v1/products/{id}",
+        scopes: ["product:read"].freeze
+      },
+      "getProductCustomFieldDefinition" => {
+        method: "GET",
+        path: "/api/v1/products/{id}/custom-fields/{field_id}",
+        scopes: ["product:read"].freeze
+      },
+      "getSubscription" => {
+        method: "GET",
+        path: "/api/v1/subscriptions/{id}",
+        scopes: ["product:read"].freeze
+      },
+      "getWebhookEndpoint" => {
+        method: "GET",
+        path: "/api/v1/webhooks/{id}",
+        scopes: ["webhook:write"].freeze
+      },
+      "listAPIKeys" => {
+        method: "GET",
+        path: "/api/v1/api-keys",
+        scopes: ["admin"].freeze
+      },
+      "listCustomerCustomFieldValues" => {
+        method: "GET",
+        path: "/api/v1/customers/{id}/custom-fields",
+        scopes: ["admin"].freeze
+      },
+      "listCustomers" => {
+        method: "GET",
+        path: "/api/v1/customers",
+        scopes: ["admin"].freeze
+      },
+      "listEvents" => {
+        method: "GET",
+        path: "/api/v1/events",
+        scopes: ["event:read"].freeze
+      },
+      "listFeaturesByProduct" => {
+        method: "GET",
+        path: "/api/v1/products/{id}/features",
+        scopes: ["product:read"].freeze
+      },
+      "listLicenseCustomFieldValues" => {
+        method: "GET",
+        path: "/api/v1/licenses/{id}/custom-fields",
+        scopes: ["license:read"].freeze
+      },
+      "listLicenseDevices" => {
+        method: "GET",
+        path: "/api/v1/licenses/{id}/devices",
+        scopes: ["license:read"].freeze
+      },
+      "listLicenseFeatures" => {
+        method: "GET",
+        path: "/api/v1/licenses/{id}/features",
+        scopes: ["license:read"].freeze
+      },
+      "listLicenses" => {
+        method: "GET",
+        path: "/api/v1/licenses",
+        scopes: ["license:read"].freeze
+      },
+      "listPoliciesByProduct" => {
+        method: "GET",
+        path: "/api/v1/products/{id}/policies",
+        scopes: ["product:read"].freeze
+      },
+      "listProductCustomFieldDefinitions" => {
+        method: "GET",
+        path: "/api/v1/products/{id}/custom-fields",
+        scopes: ["product:read"].freeze
+      },
+      "listProductOrders" => {
+        method: "GET",
+        path: "/api/v1/products/{id}/orders",
+        scopes: ["product:read"].freeze
+      },
+      "listProductSubscriptions" => {
+        method: "GET",
+        path: "/api/v1/products/{id}/subscriptions",
+        scopes: ["product:read"].freeze
+      },
+      "listProductVersions" => {
+        method: "GET",
+        path: "/api/v1/products/{id}/versions",
+        scopes: ["product:read"].freeze
+      },
+      "listProducts" => {
+        method: "GET",
+        path: "/api/v1/products",
+        scopes: ["product:read"].freeze
+      },
+      "listWebhookEndpoints" => {
+        method: "GET",
+        path: "/api/v1/webhooks",
+        scopes: ["webhook:write"].freeze
+      },
+      "reinstateLicense" => {
+        method: "POST",
+        path: "/api/v1/licenses/{id}/reinstate",
+        scopes: ["license:write"].freeze
+      },
+      "removeLicenseFeature" => {
+        method: "DELETE",
+        path: "/api/v1/licenses/{id}/features/{feature_id}",
+        scopes: ["license:write"].freeze
+      },
+      "renewLicense" => {
+        method: "POST",
+        path: "/api/v1/licenses/{id}/renew",
+        scopes: ["license:write"].freeze
+      },
+      "resetLicenseDevice" => {
+        method: "POST",
+        path: "/api/v1/licenses/{id}/devices/{device_id}/reset",
+        scopes: ["device:write"].freeze
+      },
+      "resetLicenseUsage" => {
+        method: "POST",
+        path: "/api/v1/licenses/{id}/usage/reset",
+        scopes: ["license:write"].freeze
+      },
+      "revokeLicense" => {
+        method: "POST",
+        path: "/api/v1/licenses/{id}/revoke",
+        scopes: ["license:write"].freeze
+      },
+      "suspendLicense" => {
+        method: "POST",
+        path: "/api/v1/licenses/{id}/suspend",
+        scopes: ["license:write"].freeze
+      },
+      "transferLicense" => {
+        method: "POST",
+        path: "/api/v1/licenses/{id}/transfer",
+        scopes: ["license:write"].freeze
+      },
+      "updateCustomer" => {
+        method: "PATCH",
+        path: "/api/v1/customers/{id}",
+        scopes: ["admin"].freeze
+      },
+      "updateOrder" => {
+        method: "PATCH",
+        path: "/api/v1/orders/{id}",
+        scopes: ["product:write"].freeze
+      },
+      "updatePolicy" => {
+        method: "PATCH",
+        path: "/api/v1/policies/{id}",
+        scopes: ["product:write"].freeze
+      },
+      "updateProduct" => {
+        method: "PATCH",
+        path: "/api/v1/products/{id}",
+        scopes: ["product:write"].freeze
+      },
+      "updateProductCustomFieldDefinition" => {
+        method: "PATCH",
+        path: "/api/v1/products/{id}/custom-fields/{field_id}",
+        scopes: ["product:write"].freeze
+      },
+      "updateSubscription" => {
+        method: "PATCH",
+        path: "/api/v1/subscriptions/{id}",
+        scopes: ["product:write"].freeze
+      },
+      "updateWebhookEndpoint" => {
+        method: "PATCH",
+        path: "/api/v1/webhooks/{id}",
+        scopes: ["webhook:write"].freeze
+      },
+      "upsertCustomerCustomFieldValue" => {
+        method: "PUT",
+        path: "/api/v1/customers/{id}/custom-fields/{field_id}",
+        scopes: ["admin"].freeze
+      },
+      "upsertLicenseCustomFieldValue" => {
+        method: "PUT",
+        path: "/api/v1/licenses/{id}/custom-fields/{field_id}",
+        scopes: ["license:write"].freeze
+      },
+    }.freeze
+    MANAGEMENT_SCOPES = ["admin", "device:write", "event:read", "license:read", "license:write", "product:read", "product:write", "webhook:write"].freeze
+  end
+end

data/lib/licensekit/scopes.rb

@@ -0,0 +1,16 @@
+module LicenseKit
+  MANAGEMENT_SCOPES = Generated::MANAGEMENT_SCOPES
+  OPERATION_SCOPES = Generated::OPERATION_SCOPES
+
+  def self.get_required_scopes(operation_id)
+    entry = OPERATION_SCOPES.fetch(operation_id)
+    entry[:scopes]
+  end
+
+  def self.has_required_scopes(operation_id, scopes)
+    granted = Array(scopes).map(&:to_s)
+    return true if granted.include?("admin")
+
+    get_required_scopes(operation_id).all? { |scope| granted.include?(scope) }
+  end
+end

data/lib/licensekit/types.rb

@@ -0,0 +1,53 @@
+module LicenseKit
+  class RetryOptions
+    attr_reader :retries, :retryable_methods
+
+    def initialize(retries: 0, retryable_methods: ["GET"])
+      @retries = retries
+      @retryable_methods = Array(retryable_methods).map(&:to_s).map(&:upcase).freeze
+    end
+  end
+
+  class RequestOptions
+    attr_reader :headers, :timeout
+
+    def initialize(headers: nil, timeout: nil)
+      @headers = headers
+      @timeout = timeout
+    end
+  end
+
+  class RawResponse
+    attr_reader :status, :headers, :data, :response, :body
+
+    def initialize(status:, headers:, data:, response:, body:)
+      @status = status
+      @headers = headers
+      @data = data
+      @response = response
+      @body = body
+    end
+  end
+
+  class TransportRequest
+    attr_reader :method, :url, :headers, :body, :timeout
+
+    def initialize(method:, url:, headers:, body:, timeout:)
+      @method = method
+      @url = url
+      @headers = headers
+      @body = body
+      @timeout = timeout
+    end
+  end
+
+  class TransportResponse
+    attr_reader :status, :headers, :body
+
+    def initialize(status:, headers:, body:)
+      @status = Integer(status)
+      @headers = headers
+      @body = body
+    end
+  end
+end

data/lib/licensekit/verification.rb

@@ -0,0 +1,94 @@
+require "base64"
+require "ed25519"
+require "json"
+
+module LicenseKit
+  class VerificationResult
+    attr_reader :key
+
+    def initialize(ok:, key:)
+      @ok = ok
+      @key = key
+    end
+
+    def ok
+      @ok
+    end
+  end
+
+  class PublicKeyStore
+    def initialize(keys = nil)
+      @keys = {}
+      @verify_keys = {}
+      Array(keys).each { |key| add(key) }
+    end
+
+    def add(key)
+      @keys[key.fetch("kid")] = key
+      @verify_keys.delete(key.fetch("kid"))
+    end
+
+    def add_all(keys)
+      Array(keys).each { |key| add(key) }
+    end
+
+    def get(kid)
+      @keys[kid]
+    end
+
+    def values
+      @keys.values
+    end
+
+    def verify_key(kid)
+      key = get(kid)
+      raise TypeError, "Unknown public key kid: #{kid}" if key.nil?
+
+      @verify_keys[kid] ||= Ed25519::VerifyKey.new(LicenseKit.send(:decode_base64, key.fetch("public_key")))
+    end
+  end
+
+  def self.find_public_key(keys, kid)
+    if keys.is_a?(PublicKeyStore)
+      keys.get(kid)
+    else
+      Array(keys).find { |key| key["kid"] == kid }
+    end
+  end
+
+  def self.verify_runtime_payload(data, signature, keys)
+    public_key = find_public_key(keys, signature.fetch("kid"))
+    raise TypeError, "Unknown public key kid: #{signature.fetch('kid')}" if public_key.nil?
+
+    if public_key.fetch("algorithm") != "Ed25519" || signature.fetch("alg") != "Ed25519"
+      raise TypeError, "Unsupported signature algorithm: expected Ed25519, received key=#{public_key.fetch('algorithm')}, signature=#{signature.fetch('alg')}"
+    end
+
+    verify_key = keys.is_a?(PublicKeyStore) ? keys.verify_key(public_key.fetch("kid")) : Ed25519::VerifyKey.new(LicenseKit.send(:decode_base64, public_key.fetch("public_key")))
+    payload = stable_json_bytes(data)
+    signature_bytes = LicenseKit.send(:decode_base64, signature.fetch("value"))
+
+    begin
+      verify_key.verify(signature_bytes, payload)
+      VerificationResult.new(ok: true, key: public_key)
+    rescue Ed25519::VerifyError
+      VerificationResult.new(ok: false, key: public_key)
+    end
+  end
+
+  def self.verify_runtime_result(result, keys)
+    verify_runtime_payload(result.fetch("data"), result.fetch("signature"), keys)
+  end
+
+  def self.stable_json_bytes(data)
+    JSON.generate(data).encode("UTF-8")
+  end
+
+  def self.decode_base64(value)
+    Base64.strict_decode64(value.to_s)
+  rescue ArgumentError => e
+    raise TypeError, "Malformed base64 input: #{e.message}"
+  end
+
+  private_class_method :stable_json_bytes, :decode_base64
+end

data/lib/licensekit/version.rb

@@ -0,0 +1,3 @@
+module LicenseKit
+  VERSION = "0.1.0.alpha.0".freeze
+end

data/lib/licensekit.rb

@@ -0,0 +1,9 @@
+require_relative "licensekit/version"
+require_relative "licensekit/types"
+require_relative "licensekit/errors"
+require_relative "licensekit/generated/metadata"
+require_relative "licensekit/generated/operation_scopes"
+require_relative "licensekit/client"
+require_relative "licensekit/generated/clients"
+require_relative "licensekit/scopes"
+require_relative "licensekit/verification"