closeyourit-ruby 0.11.0 → 0.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d77ef65ad83c3890320e2c3c3a002a6708ef52d223204da4b553ac75ec58c4b9
-  data.tar.gz: 4bc0274665e54f19fe33d6e379270f31802a71317075ceae65fecdd4b8a6d66c
+  metadata.gz: e8e0fc4eed9289e8fbb3ac2b93e6bcf71c950200b24483be93ca9b03cbb5edf5
+  data.tar.gz: bec0fc92de3a19b85caa500e41953726a1693ca8f757cd98022b8b5287e83f76
 SHA512:
-  metadata.gz: cc89f3b0f20d8781b5a963b9fda04935b735500612db5883b29f86abc92bc560a452abc133db66859b919cdfcd8994ff6c4891fdcafe39a6c7878a960c74b627
-  data.tar.gz: 5b55acc5e39e78e9fc875e6cbfd32dfce56bbb9e27d600ec30f86a6d27d12660c1c61195a28c32f32ac22b418c78ac9d41e83af8bbdbd26f96781d740bd6f1cd
+  metadata.gz: f39ecd3584260bf7257fb8efc7fcf12222a2adec2fa2d1ba7ff3a59e368ae6c6e52921d5c83dda516c588946d718c4407aa934d6f495cfd9269621226fd58555
+  data.tar.gz: a634e8af76d32b12d1ffe210e73d3070c8059d15a55953caed9406d2c8db7fbeaac0f34bf800ee049bf9b4cdcb737d0239f3968978b970bb1175f42dfca3f0c5

data/README.md

@@ -52,7 +52,7 @@ In CloseYourIt, area **Member → Project → tokens**, crea un token: ottieni i
 ```ruby
 # config/initializers/closeyourit.rb
 CloseYourIt.init do |c|
-  c.endpoint_url = ENV["CLOSEYOURIT_ENDPOINT_URL"]   # es. https://www.closeyour.it (host canonico)
+  c.endpoint_url = ENV["CLOSEYOURIT_ENDPOINT_URL"]   # es. https://app.closeyour.it (host canonico)
   c.token        = ENV["CLOSEYOURIT_TOKEN"]          # Bearer secret del Projects::Token
   c.project_id   = ENV["CLOSEYOURIT_PROJECT_ID"]     # UUID del progetto su CloseYourIt
   c.environment  = Rails.env
@@ -62,9 +62,8 @@ end
 **Senza `endpoint_url` / `token` / `project_id` la gemma è no-op** (nessun invio, nessun overhead). In
 `production` un `endpoint_url` `http://` viene rifiutato (no-op + warning): il token viaggerebbe in chiaro.
 
-> **Endpoint:** usa l'host canonico **`https://www.closeyour.it`**. La gemma segue fino a 2 redirect su POST
-> (preservando metodo e body), quindi anche l'apex `https://closeyour.it` (301 → www) funziona — ma puntare
-> direttamente a www risparmia un hop per ogni evento.
+> **Endpoint:** usa l'host canonico **`https://app.closeyour.it`**. Le installazioni già configurate su
+> `https://www.closeyour.it` continuano a funzionare: l'ingest su `www` resta inoltrato all'app.
 
 ### Opzioni
 
@@ -84,7 +83,9 @@ end
 | `slow_query_threshold_ms` | `100` | Soglia query lente |
 | `excluded_query_patterns` | `solid_queue_`, `solid_cache_`, `solid_cable_` | Query da NON misurare come rallentamento — **Regexp** (pattern) o **String** (testo letterale). Vale solo per la misura: breadcrumb e profiling N+1 vedono tutto |
 | `slow_method_threshold_ms` | `200` | Soglia metodi lenti |
+| `capture_method_arguments` | `false` | Allega gli argomenti di `measure`/`monitor` ai `slow_method`. **Attenzione**: gli argomenti sono spesso dati personali; la gemma redige chiavi sensibili, credenziali e `scrub_message_patterns`, non il resto |
 | `capture_request` | `true` | Cattura il contesto HTTP della richiesta (method/url/header allowlist) |
+| `capture_request_body` | `true` | Allega i parametri del body (`request.data`) all'errore, scrubbati. Vale **solo con `send_pii = true`**: con la privacy spenta il body non parte mai |
 | `request_header_allowlist` | `Accept`, `Content-Type`, `User-Agent`, `Referer` | Header inviati (mai Authorization/Cookie) |
 | `breadcrumbs_enabled` | `true` | Cronologia (query offuscate + `add_breadcrumb`) allegata all'errore |
 | `max_breadcrumbs` | `100` | Dimensione max del ring buffer breadcrumbs |
@@ -92,7 +93,7 @@ end
 | `report_active_job_errors` | `true` | Cattura gli errori dei job ActiveJob/Solid Queue/Sidekiq |
 | `send_pii` | `false` | Master switch PII |
 | `obfuscate_sql` | `true` | Maschera i literal nello SQL |
-| `filter_parameters` | `[]` | Chiavi extra da redarre (mergiate con quelle di Rails) |
+| `filter_parameters` | `[]` | Chiavi extra da redarre, in aggiunta a `Rails.application.config.filter_parameters` (unite automaticamente dalla Railtie) |
 | `scrub_message_patterns` | `[]` | Regexp **aggiuntive** da redarre da messaggi d'eccezione **e da `message` dei log**; le credenziali `Bearer`/`Basic`/`Token` sono già redatte di serie |
 | `logs_enabled` | `true` | Master switch dello stream di log strutturato |
 | `logs_min_level` | `:info` | Soglia minima: i log sotto (es. `debug`) non vengono inviati |
@@ -155,7 +156,9 @@ end
 
 Un Rack middleware allega a ogni evento il contesto HTTP della richiesta: **method**, **url** (senza
 query string) e gli **header dell'allowlist** (`request_header_allowlist`, mai Authorization/Cookie).
-Query string e IP solo con `send_pii`. Lo scope è resettato a fine richiesta (niente bleed tra request).
+Query string, IP e **parametri del body** (`request.data`, scrubbati, estratti solo quando scoppia
+l'errore; `capture_request_body` li spegne) solo con `send_pii`. Lo scope è resettato a fine richiesta
+(niente bleed tra request).
 
 ### Background job + errori handled (automatico, con Rails)
 
@@ -312,7 +315,10 @@ end
 ```
 
 Viene inviato un `slow_method` solo se la durata supera `slow_method_threshold_ms`. **Gli argomenti
-del metodo non vengono mai inviati** (solo label, durata, file:riga).
+del metodo non vengono inviati** (solo label, durata, file:riga) salvo `capture_method_arguments = true`:
+in quel caso partono con `inspect` troncato, redatti per chiave sensibile (kwargs), credenziali
+`Bearer`/`Basic`/`Token` e `scrub_message_patterns`. Tutto il resto arriva in chiaro: accendilo solo
+su metodi che non ricevono dati personali.
 
 ## Performance issues (opt-in)
 
@@ -406,8 +412,10 @@ Privacy-by-default (`send_pii = false`). In sintesi:
   (`Authorization: Bearer …`, `Basic …`, `Token …`) sono redatte **di serie**, senza configurazione:
   chiave e schema restano leggibili, sparisce il valore → `Authorization: Bearer [FILTERED]`. Il resto
   è redigibile con `scrub_message_patterns` / `before_send`.
-- **Mai inviati**: variabili locali dei frame, argomenti dei metodi, IP/cookie/Authorization, token (che
-  viaggia solo nell'header su HTTPS).
+- **Solo con `send_pii`**: query string, IP, email/username dell'utente e parametri del body
+  (`capture_request_body`). Con la privacy spenta non partono, qualunque sia il resto della configurazione.
+- **Mai inviati**: variabili locali dei frame, cookie/Authorization, token (che viaggia solo nell'header
+  su HTTPS). Gli argomenti dei metodi solo con `capture_method_arguments` (opt-in, vedi sopra).
 
 > Rischio residuo: `exception.value` e i nomi tabella/colonna nello SQL possono contenere dati di
 > dominio. Usa `before_send`/`scrub_message_patterns` per azzerarli. Dettaglio in [`PDR.md` §9](PDR.md).

data/lib/closeyourit/configuration.rb

@@ -94,7 +94,8 @@ module CloseYourIt
 
       # Request body params in the event (`request.data`), extracted LAZILY only when the error
       # happens, sanitized and scrubbed (denylist + filter_parameters). The backend scrubs again
-      # defensively. Uploads → placeholder, 64 KB cap.
+      # defensively. Uploads → placeholder, 64 KB cap. Gated by send_pii: with it OFF the body
+      # is never sent, whatever this flag says (CYRB-28).
       @capture_request_body = true
 
       # Breadcrumbs: history (obfuscated queries, custom events) attached to the error.
@@ -200,6 +201,13 @@ module CloseYourIt
       @filter_parameters = Array(list)
     end
 
+    # Adds the host app's `Rails.application.config.filter_parameters` (strings/symbols/regexps) to the
+    # gem list, without duplicates. Rails filter procs are dropped: they mutate values in place, while
+    # the Scrubber matches keys only (CYRB-28).
+    def merge_filter_parameters(list)
+      @filter_parameters |= Array(list).reject { |item| item.respond_to?(:call) }
+    end
+
     # Destinations allowed to receive the W3C trace headers. String = exact host (case-insensitive
     # match), Regexp = pattern (for subdomains/host families). Empty list = none.
     def trace_propagation_allowlist=(list)

data/lib/closeyourit/events/slow_method_event.rb

@@ -42,7 +42,9 @@ module CloseYourIt
     private
 
     # Arguments — ONLY with capture_method_arguments (opt-in). Positional by index; kwargs by name with
-    # sensitive key scrubbing (denylist password/token/…). Value = truncated inspect (JSON-safe).
+    # sensitive key scrubbing (denylist password/token/…). Value = truncated inspect (JSON-safe),
+    # passed through the message scrubber (auth schemes + scrub_message_patterns) like exception
+    # messages, so a token inside a positional argument never leaves the app (CYRB-28).
     def arguments
       return nil unless @configuration.capture_method_arguments
 
@@ -54,7 +56,7 @@ module CloseYourIt
     end
 
     def safe_value(value)
-      inspected = value.inspect.to_s
+      inspected = @scrubber.scrub_message(value.inspect.to_s)
       inspected.length > 120 ? "#{inspected[0, 117]}…" : inspected
     end
   end

data/lib/closeyourit/rails/railtie.rb

@@ -100,6 +100,13 @@ module CloseYourIt
         end
       end
 
+      # Keys the app declared sensitive via config.filter_parameters are scrubbed by the gem too.
+      # `after: :load_config_initializers`: CloseYourIt.init (config/initializers/closeyourit.rb)
+      # replaces the configuration, so an earlier merge would be lost (CYRB-28).
+      initializer "closeyourit.merge_rails_filter_parameters", after: :load_config_initializers do |app|
+        CloseYourIt.configuration.merge_filter_parameters(app.config.filter_parameters)
+      end
+
       # Captures Sidekiq job errors + measures duration/wait via server middleware (only when Sidekiq
       # is present). The middleware is effectively a no-op when monitor_jobs is OFF (the decision
       # lives in JobPerformance#record).

data/lib/closeyourit/scope.rb

@@ -139,8 +139,10 @@ module CloseYourIt
       data ? @request.merge("data" => data) : @request
     end
 
+    # Body params are user input (PII): sent only with send_pii AND capture_request_body (CYRB-28).
     def request_body_data
-      return nil unless CloseYourIt.configuration.capture_request_body
+      config = CloseYourIt.configuration
+      return nil unless config.send_pii && config.capture_request_body
       return nil if @rack_env.nil?
 
       Rails::RequestBody.extract(@rack_env)

data/lib/closeyourit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CloseYourIt
-  VERSION = "0.11.0"
+  VERSION = "0.12.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: closeyourit-ruby
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.1
 platform: ruby
 authors:
 - Alessio Bussolari
@@ -90,12 +90,12 @@ files:
 - lib/closeyourit/transport.rb
 - lib/closeyourit/usage_registry.rb
 - lib/closeyourit/version.rb
-homepage: https://github.com/bussolabs/closeyourit-ruby
+homepage: https://github.com/bussolabs/closeyourit-ruby-community
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/bussolabs/closeyourit-ruby
-  source_code_uri: https://github.com/bussolabs/closeyourit-ruby
+  homepage_uri: https://github.com/bussolabs/closeyourit-ruby-community
+  source_code_uri: https://github.com/bussolabs/closeyourit-ruby-community
 rdoc_options: []
 require_paths:
 - lib