olyx-guardrails 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '069f552d05ca4f0ee61bf1496b27da5961477bb75eb422424b1cd19b31e1ac61'
+  data.tar.gz: 9189f069fc540a3ecab429ebec194cb9c870917966837fb4c7fff428d705ed78
+SHA512:
+  metadata.gz: 264d94b6a842c268cd30430ecf1cb6f2d49557d12266f331e594160e7100d8539b1c35351e4dbab58dd0525c97760c738a4f139270aefcb8d2f251835bd04e5c
+  data.tar.gz: 75bd129939354ed2333d622cc215cc4a34b0967e39fcb482345719ddd312f9637ceb6a13beddfd27cbfa242f6057bd82178590e8ab98e63e10d79a461fe99b6d

data/CHANGELOG.md

@@ -0,0 +1,117 @@
+# Changelog
+
+All notable changes to olyx-guardrails are documented here.
+Format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
+
+## [1.0.0] - 2026-07-21
+
+Initial public release.
+
+### Decision and transformation
+
+- `Olyx::Guardrails.check` — makes an allow/block decision against PII,
+  prompt-injection, secret, and restricted-policy findings without
+  transforming the input. Returns `allowed`, per-category detection flags,
+  `risk_score`, and a `checks` array with one entry per category. The
+  `length` check runs first; content and AI checks are skipped (not just
+  failed) when it does, so an oversized payload never pays their cost.
+- `Olyx::Guardrails.redact` — transforms text by removing every
+  regex-detected PII, secret, and restricted-policy match, without making an
+  allow/block decision. Findings expose a masked value, a short SHA-256
+  fingerprint, and source offsets — never plaintext credentials. Raises
+  `ArgumentError` on oversized input rather than running an unbounded
+  transformation.
+- `check_messages` adds adjacent `user` → `assistant` multi-turn injection
+  detection over structured chat messages. `check_output`/`redact_output`
+  are explicit aliases for the completed-output boundary, distinct from
+  input checks so applications can instrument both without implying
+  streaming-token enforcement.
+
+### Policy
+
+- Immutable `Policy` and `PolicyRule` configuration: named blocking or
+  monitoring-only restricted-content rules, `substring`/`whole_word`/`regexp`
+  term matching, case-aware regex support, configurable safe replacements,
+  and `Policy.from_h` for YAML/JSON-style Hash loading.
+- `ai_failure_mode:` controls how an analyzer failure is handled: `:allow`
+  (default, keeps the deterministic result), `:block` (adds a failed `ai`
+  check and rejects), or `:raise` (`AiAnalyzerError`).
+- Invalid configuration — duplicate rule names, empty-matching or invalid
+  patterns, malformed message arrays, invalid custom regexes — raises
+  `ArgumentError` at construction time rather than silently degrading into a
+  permissive policy.
+
+### Detection
+
+- `PiiScrubber` recognizes email, formatted/international phone,
+  structurally valid U.S. SSN, Luhn-valid Canadian SIN, Luhn-valid payment
+  card, valid IPv4/IPv6, token prefixes, contextualized passports,
+  formatted/checksum-valid IBAN, and calendar-valid contextualized dates of
+  birth.
+- `InjectionDetector` matches structural tags, jailbreak phrases, and
+  adjacent-turn split attacks against bounded variants produced by NFKC
+  normalization, common Greek/Cyrillic homoglyph folding, zero-width
+  removal, and one decoding layer each for URL, HTML-entity, Unicode-escape,
+  and Base64 encoding.
+- `SecretScanner` detects common cloud/SaaS tokens, JWTs, PEM private keys,
+  credential-bearing database URLs, confidentiality markers, and private
+  network endpoints via explicit `scan` (detect), `redact` (transform), and
+  `scan!` (raise `Blocked`) operations. A confidentiality marker redacts the
+  complete input, since the marker alone doesn't identify the sensitive
+  span. Custom patterns extend detection and are classified as secrets; use
+  `PolicyRule` for named business restrictions instead.
+
+### AI analyzer hook
+
+- Optional `ai_analyzer:` callable receives `(text, context)` and returns a
+  Hash or a schema-model object implementing `deep_to_h`/`to_h`. Findings
+  can add a violation but cannot clear a deterministic one. Boolean fields
+  must be actual `true`/`false` values; non-finite risk scores are ignored
+  rather than crashing. Exceptions and malformed responses are bounded under
+  `result[:ai_analysis][:error]` and handled per `ai_failure_mode`.
+- Optional `Integrations::OpenAIAnalyzer` connector for the official OpenAI
+  Ruby SDK: sends a strict `OpenAI::BaseModel` schema through the Responses
+  API, consumes the parsed schema-model result, defaults to `store: false`,
+  and has no model allowlist — it forwards any String/Symbol model
+  identifier and relies on Structured Outputs support as the compatibility
+  check. Refusals, API failures, and missing parsed output degrade into the
+  same `result[:ai_analysis][:error]` path. The `openai` gem is optional and
+  loaded lazily.
+
+### Notifications
+
+- Vendor-neutral `Notifier` dispatches one sanitized, deeply frozen,
+  versioned event to named callable handlers. Handlers run synchronously and
+  independently — one failure doesn't stop the others, and errors are
+  returned per handler rather than raised. Input previews, AI reasons,
+  metadata keys/values, and handler errors are bounded and redacted with the
+  policy's restricted-content rules and the built-in PII/secret detectors.
+
+### Rails integration
+
+- Optional first-class Rails adapter, absent from the core runtime
+  dependency set: a Railtie with boot-finalized configuration, safe
+  environment-keyed YAML policy loading (`YAML.safe_load`, no ERB/aliases/
+  arbitrary classes), an install generator, and explicit opt-in boundary
+  adapters for controllers, GraphQL, Action Cable, Active Job arguments,
+  Active Model validation, caller-extracted uploads, and service objects
+  (`Rails::Enforcer`).
+- Content-free Active Support instrumentation (`check`, `violation`,
+  `redact`, `notification` events) carries bounded decision/delivery fields
+  and duration only — never raw input, redacted output, metadata, or
+  analyzer prose. Subscriber failures are isolated from enforcement.
+- `Rails::ActiveJobHandler` enqueues sanitized notification events through
+  any Active Job backend, resolving a reload-safe String/Symbol job
+  constant at delivery time.
+
+### Quality and security posture
+
+- No runtime dependencies for the core checks; Rails and the OpenAI SDK are
+  both optional and loaded only when used.
+- CI enforces RuboCop, a Flog structural-complexity gate (max 10 per
+  ordinary method, 60 per class/module, with documented DSL exemptions
+  only), and a RubyCritic maintainability gate, alongside the Appraisal
+  matrix across Rails 7.2, 8.0, and 8.1.
+- Least-privilege, SHA-pinned CI actions; CodeQL and OpenSSF Scorecard
+  scanning; a private vulnerability-reporting process (see
+  [SECURITY.md](SECURITY.md)).

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,28 @@
+# Code of Conduct
+
+## Our commitment
+
+We are committed to a welcoming, professional, and harassment-free community
+for everyone, regardless of background, identity, experience, or ability.
+
+## Expected behavior
+
+- Be respectful, constructive, and specific.
+- Assume good intent while addressing harmful impact.
+- Accept technical feedback without personal attacks.
+- Respect privacy and confidentiality.
+- Focus disagreement on ideas, evidence, and project outcomes.
+
+Harassment, discrimination, threats, sexualized conduct, sustained disruption,
+doxing, or publication of another person's private information are not
+acceptable.
+
+## Enforcement
+
+Report conduct concerns privately to `conduct@olyxai.io`. Maintainers may edit
+or remove contributions, issue warnings, temporarily restrict participation, or
+permanently ban participants when necessary. Reports will be handled as
+confidentially as reasonably possible, with conflicts of interest recused.
+
+This policy applies in project spaces and when someone is publicly representing
+the project.

data/CONTRIBUTING.md

@@ -0,0 +1,63 @@
+# Contributing
+
+Thank you for improving Olyx Guardrails.
+
+## Development setup
+
+```bash
+rbenv install
+bundle install
+bundle exec rake test
+COVERAGE=true bundle exec rake test
+bundle exec rubocop --cache false
+bundle exec ruby script/flog_gate.rb
+bundle exec rubycritic -f console -f json -p tmp/rubycritic
+ruby script/rubycritic_gate.rb tmp/rubycritic/report.json
+bundle exec appraisal install
+bundle exec appraisal rake test
+```
+
+Ruby 3.4 or newer is supported. Changes must remain compatible with the oldest
+supported Ruby unless the same pull request deliberately changes the gem's
+requirement.
+
+RubyCritic is a blocking regression gate configured in `.rubycritic.yml`.
+Do not lower its baseline to merge a change. Refactor new hot spots and ratchet
+the minimum upward when sustained improvements raise the measured score.
+The minimum score is 95; new files must remain focused on one reason to change,
+and every production file must remain A-rated. RubyCritic smells, duplication,
+and per-file complexity are review signals, not automatic design instructions:
+address genuine responsibility or clarity problems, but do not introduce proxy
+methods, unnecessary indirection, or metaprogramming merely to silence a
+heuristic.
+
+Flog is also a blocking structural gate: ordinary methods must score at most
+10, and each class or module must total at most 60. Do not split cohesive code,
+hide behavior behind dynamic dispatch, or weaken a public API merely to improve
+a score. A public DSL or metaprogramming macro may be listed in
+`.flog_exemptions.yml` only when it is the clearest design; the entry must use
+Flog's fully-qualified method name and contain an explicit DSL/metaprogramming
+reason. Stale or unexplained exemptions fail CI.
+
+The Appraisal matrix covers Rails 7.2, 8.0, and 8.1. Rails integration changes
+must pass every configured Rails line while the standalone core remains free of
+Rails runtime dependencies.
+
+## Pull requests
+
+1. Open an issue first for substantial API or policy changes.
+2. Keep each pull request focused and include tests for behavior changes.
+3. Add adversarial regression tests for security-sensitive fixes.
+4. Update README, API reference, examples, and changelog when public behavior
+   changes.
+5. Confirm tests, RuboCop, Flog, RubyCritic, syntax checks, and gem packaging
+   pass locally.
+
+Never include real credentials, personal data, production endpoints, or
+customer content in fixtures. Use clearly synthetic values.
+
+By submitting a contribution, you agree that it is licensed under the
+Apache-2.0 license used by this project.
+
+Security vulnerabilities must follow [SECURITY.md](SECURITY.md), not the public
+issue tracker.

data/LICENSE

@@ -0,0 +1,134 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship made available under
+      the License, as indicated by a copyright notice that is included in
+      or attached to the work (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other transformations
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean, as submitted to the Licensor for inclusion
+      in the Work by the copyright owner or by an individual or Legal Entity
+      authorized to submit on behalf to the copyright owner.
+
+      "Contributor" shall mean Licensor and any Legal Entity on behalf of
+      whom a Contribution has been received by the Licensor and included
+      within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by the combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative
+          Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file, you must include a
+          readable copy of the attribution notices contained within such
+          NOTICE file.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      shall be under the terms and conditions of this License, without
+      any additional terms or conditions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or agreed
+      to in writing, Licensor provides the Work on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any conditions of TITLE,
+      NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR
+      PURPOSE.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      shall any Contributor be liable to You for damages, including any
+      direct, indirect, special, incidental, or exemplary damages of any
+      character arising as a result of this License or out of the use or
+      inability to use the Work.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer, and
+      charge a fee for, acceptance of support, warranty, indemnity, or
+      other liability obligations consistent with this License. However,
+      in accepting such obligations, You may offer such obligations only
+      on Your own behalf and on Your sole responsibility.
+
+   Copyright 2026 Moses Njoroge / Olyx Labs
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied. See the License for the specific language governing
+   permissions and limitations under the License.