lex-audit 0.1.4 → 0.1.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.github/CODEOWNERS +7 -0
- data/.github/dependabot.yml +18 -0
- data/.github/workflows/ci.yml +3 -3
- data/.rubocop.yml +2 -53
- data/CHANGELOG.md +15 -0
- data/CLAUDE.md +33 -9
- data/Gemfile +2 -0
- data/LICENSE +201 -0
- data/lex-audit.gemspec +0 -1
- data/lib/legion/extensions/audit/errors.rb +13 -0
- data/lib/legion/extensions/audit/helpers/verified_write.rb +111 -0
- data/lib/legion/extensions/audit/runners/approval_queue.rb +1 -1
- data/lib/legion/extensions/audit/version.rb +1 -1
- data/lib/legion/extensions/audit.rb +4 -2
- metadata +6 -15
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 531cdf796a189cb155d128d61af3fd72128d859d780ca21cfe40f50336f08ce4
|
|
4
|
+
data.tar.gz: 9bfbf2fa44d6ccb8c864f5b348b0d8bbc9f5f237dafefb65e12752111a077f54
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 4b760a57e8ecd4462d38541552e486034b0fa0c39320a078a38e1d60cea940cc9ae3f5214dc661ba169a5b412ef0f8ad64fb044ef939bc48794aded44a548df1
|
|
7
|
+
data.tar.gz: 1ed526ca7d9fad3b2ff541e0fc791ecb50bfc3ca37452339ac699b730065dbb091ff9b19a6ce11c5dd85cb9b8e2e721219758dce2140988476c75653098e7d32
|
data/.github/CODEOWNERS
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
version: 2
|
|
2
|
+
updates:
|
|
3
|
+
- package-ecosystem: bundler
|
|
4
|
+
directory: /
|
|
5
|
+
schedule:
|
|
6
|
+
interval: weekly
|
|
7
|
+
day: monday
|
|
8
|
+
open-pull-requests-limit: 5
|
|
9
|
+
labels:
|
|
10
|
+
- "type:dependencies"
|
|
11
|
+
- package-ecosystem: github-actions
|
|
12
|
+
directory: /
|
|
13
|
+
schedule:
|
|
14
|
+
interval: weekly
|
|
15
|
+
day: monday
|
|
16
|
+
open-pull-requests-limit: 5
|
|
17
|
+
labels:
|
|
18
|
+
- "type:dependencies"
|
data/.github/workflows/ci.yml
CHANGED
|
@@ -10,8 +10,8 @@ jobs:
|
|
|
10
10
|
ci:
|
|
11
11
|
uses: LegionIO/.github/.github/workflows/ci.yml@main
|
|
12
12
|
|
|
13
|
-
|
|
14
|
-
uses: LegionIO/.github/.github/workflows/
|
|
13
|
+
excluded-files:
|
|
14
|
+
uses: LegionIO/.github/.github/workflows/excluded-files.yml@main
|
|
15
15
|
|
|
16
16
|
security:
|
|
17
17
|
uses: LegionIO/.github/.github/workflows/security-scan.yml@main
|
|
@@ -27,7 +27,7 @@ jobs:
|
|
|
27
27
|
uses: LegionIO/.github/.github/workflows/stale.yml@main
|
|
28
28
|
|
|
29
29
|
release:
|
|
30
|
-
needs: [ci,
|
|
30
|
+
needs: [ci, excluded-files]
|
|
31
31
|
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
|
|
32
32
|
uses: LegionIO/.github/.github/workflows/release.yml@main
|
|
33
33
|
secrets:
|
data/.rubocop.yml
CHANGED
|
@@ -1,53 +1,2 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
NewCops: enable
|
|
4
|
-
SuggestExtensions: false
|
|
5
|
-
|
|
6
|
-
Layout/LineLength:
|
|
7
|
-
Max: 160
|
|
8
|
-
|
|
9
|
-
Layout/SpaceAroundEqualsInParameterDefault:
|
|
10
|
-
EnforcedStyle: space
|
|
11
|
-
|
|
12
|
-
Layout/HashAlignment:
|
|
13
|
-
EnforcedHashRocketStyle: table
|
|
14
|
-
EnforcedColonStyle: table
|
|
15
|
-
|
|
16
|
-
Metrics/MethodLength:
|
|
17
|
-
Max: 50
|
|
18
|
-
|
|
19
|
-
Metrics/ClassLength:
|
|
20
|
-
Max: 1500
|
|
21
|
-
|
|
22
|
-
Metrics/ModuleLength:
|
|
23
|
-
Max: 1500
|
|
24
|
-
|
|
25
|
-
Metrics/BlockLength:
|
|
26
|
-
Max: 40
|
|
27
|
-
Exclude:
|
|
28
|
-
- 'spec/**/*'
|
|
29
|
-
|
|
30
|
-
Metrics/AbcSize:
|
|
31
|
-
Max: 60
|
|
32
|
-
|
|
33
|
-
Metrics/CyclomaticComplexity:
|
|
34
|
-
Max: 15
|
|
35
|
-
|
|
36
|
-
Metrics/PerceivedComplexity:
|
|
37
|
-
Max: 17
|
|
38
|
-
|
|
39
|
-
Style/Documentation:
|
|
40
|
-
Enabled: false
|
|
41
|
-
|
|
42
|
-
Style/SymbolArray:
|
|
43
|
-
Enabled: true
|
|
44
|
-
|
|
45
|
-
Style/FrozenStringLiteralComment:
|
|
46
|
-
Enabled: true
|
|
47
|
-
EnforcedStyle: always
|
|
48
|
-
|
|
49
|
-
Naming/FileName:
|
|
50
|
-
Enabled: false
|
|
51
|
-
|
|
52
|
-
Gemspec/DevelopmentDependencies:
|
|
53
|
-
Enabled: false
|
|
1
|
+
inherit_gem:
|
|
2
|
+
rubocop-legion: config/lex.yml
|
data/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,21 @@
|
|
|
2
2
|
|
|
3
3
|
## [Unreleased]
|
|
4
4
|
|
|
5
|
+
## [0.1.6] - 2026-03-31
|
|
6
|
+
|
|
7
|
+
### Added
|
|
8
|
+
- `Helpers::VerifiedWrite` module with `verified_write` and `verified_edit` methods
|
|
9
|
+
- Post-write SHA-256 verification catches silent write failures (disk full, permission, NFS stale)
|
|
10
|
+
- Stale edit detection catches external file modifications between read and write
|
|
11
|
+
- `WriteVerificationError` and `StaleEditError` error classes in `errors.rb`
|
|
12
|
+
- Audit trail recording via `Legion::Data::Model::AuditLog` when legion-data is available (best-effort, never breaks the write)
|
|
13
|
+
- Shared `spec/support/audit_log_db.rb` eliminates DB constant conflicts when all specs run together
|
|
14
|
+
|
|
15
|
+
## [0.1.5] - 2026-03-30
|
|
16
|
+
|
|
17
|
+
### Changed
|
|
18
|
+
- update to rubocop-legion 0.1.7, resolve all offenses
|
|
19
|
+
|
|
5
20
|
### Fixed
|
|
6
21
|
- Add explicit runner_class to AuditWriter actor to prevent runner resolution error at boot
|
|
7
22
|
|
data/CLAUDE.md
CHANGED
|
@@ -6,20 +6,22 @@
|
|
|
6
6
|
|
|
7
7
|
## Purpose
|
|
8
8
|
|
|
9
|
-
Legion Extension that provides immutable, tamper-evident audit logging with a SHA-256 hash chain. Records runner executions and lifecycle transitions via AMQP. Requires `legion-data` (`data_required? true`).
|
|
9
|
+
Legion Extension that provides immutable, tamper-evident audit logging with a SHA-256 hash chain. Records runner executions and lifecycle transitions via AMQP. Also provides an approval queue for human-in-the-loop review flows. Requires `legion-data` (`data_required? true`).
|
|
10
10
|
|
|
11
11
|
**GitHub**: https://github.com/LegionIO/lex-audit
|
|
12
12
|
**License**: MIT
|
|
13
|
-
**Version**: 0.1.
|
|
13
|
+
**Version**: 0.1.4
|
|
14
14
|
|
|
15
15
|
## Architecture
|
|
16
16
|
|
|
17
17
|
```
|
|
18
18
|
Legion::Extensions::Audit
|
|
19
|
-
├──
|
|
20
|
-
│ └── AuditWriter
|
|
19
|
+
├── Actor/ # Note: singular "Actor" per framework convention
|
|
20
|
+
│ └── AuditWriter # Subscription actor: explicit runner_class override to
|
|
21
|
+
│ # Legion::Extensions::Audit::Runners::Audit; calls write
|
|
21
22
|
├── Runners/
|
|
22
|
-
│
|
|
23
|
+
│ ├── Audit # write: hash-chained record insert; verify: chain integrity check
|
|
24
|
+
│ └── ApprovalQueue # submit, approve, reject, list_pending, show_approval
|
|
23
25
|
└── Transport/
|
|
24
26
|
├── Exchanges/Audit # Audit exchange
|
|
25
27
|
├── Queues/Audit # audit.log queue (x-single-active-consumer: true)
|
|
@@ -32,19 +34,36 @@ Legion::Extensions::Audit
|
|
|
32
34
|
|------|---------|
|
|
33
35
|
| `lib/legion/extensions/audit.rb` | Entry point, extension registration (`data_required? true`) |
|
|
34
36
|
| `lib/legion/extensions/audit/runners/audit.rb` | Hash chain write and verify logic |
|
|
35
|
-
| `lib/legion/extensions/audit/
|
|
37
|
+
| `lib/legion/extensions/audit/runners/approval_queue.rb` | Human-in-the-loop approval flow |
|
|
38
|
+
| `lib/legion/extensions/audit/actors/audit_writer.rb` | AMQP subscription actor with explicit runner_class |
|
|
36
39
|
| `lib/legion/extensions/audit/transport/messages/audit.rb` | Message class with validation and routing |
|
|
37
40
|
|
|
38
41
|
## Runner Details
|
|
39
42
|
|
|
40
|
-
|
|
43
|
+
### Audit (`Runners::Audit`)
|
|
44
|
+
|
|
45
|
+
**write**: Fetches the last record's hash (or genesis hash `"0"*64`), computes SHA-256 of `prev_hash|event_type|principal_id|action|resource|context_snapshot|created_at`, and inserts the record. Uses `.utc.iso8601` for timezone-safe hashing. The `context_snapshot` field captures working memory state and is included in the hash chain for tamper evidence; backward-compatible with records that have no snapshot.
|
|
41
46
|
|
|
42
47
|
**verify**: Iterates all records in order, recomputes each hash, and compares. Returns `{ valid:, records_checked:, break_at: }`.
|
|
43
48
|
|
|
49
|
+
### ApprovalQueue (`Runners::ApprovalQueue`)
|
|
50
|
+
|
|
51
|
+
Human-in-the-loop review. Uses a lazy-defined Sequel model (`approval_queue` table).
|
|
52
|
+
|
|
53
|
+
| Method | Returns |
|
|
54
|
+
|--------|---------|
|
|
55
|
+
| `submit(approval_type:, payload:, requester_id:, tenant_id: nil)` | `{ success:, approval_id:, status: 'pending' }` |
|
|
56
|
+
| `approve(id:, reviewer_id:)` | `{ success:, approval_id:, status: 'approved' }` |
|
|
57
|
+
| `reject(id:, reviewer_id:)` | `{ success:, approval_id:, status: 'rejected' }` |
|
|
58
|
+
| `list_pending(tenant_id: nil, limit: 50)` | `{ success:, approvals: [], count: }` |
|
|
59
|
+
| `show_approval(id:)` | `{ success:, approval: }` |
|
|
60
|
+
|
|
61
|
+
Each state transition publishes an `Audit` message (`approval_needed` or `approval_decided`) to the audit chain.
|
|
62
|
+
|
|
44
63
|
## Hash Chain Design
|
|
45
64
|
|
|
46
65
|
- Genesis hash: `"0" * 64` (64 zeros)
|
|
47
|
-
- Hash content: `"#{prev_hash}|#{event_type}|#{principal_id}|#{action}|#{resource}|#{created_at.utc.iso8601}"`
|
|
66
|
+
- Hash content: `"#{prev_hash}|#{event_type}|#{principal_id}|#{action}|#{resource}|#{context_snapshot}|#{created_at.utc.iso8601}"`
|
|
48
67
|
- Algorithm: SHA-256
|
|
49
68
|
- Single-active-consumer queue ensures ordering across cluster nodes
|
|
50
69
|
- `Sequel.default_timezone = :utc` required for consistent hash verification
|
|
@@ -57,11 +76,16 @@ Legion::Extensions::Audit
|
|
|
57
76
|
- `GET /api/audit` and `GET /api/audit/verify` query the audit log
|
|
58
77
|
- `legion audit list` and `legion audit verify` CLI commands
|
|
59
78
|
|
|
79
|
+
## Known Behaviour Notes
|
|
80
|
+
|
|
81
|
+
- `Actor::AuditWriter` uses `runner_class = Legion::Extensions::Audit::Runners::Audit` (class reference, not string) — this explicit override prevents the framework from attempting to resolve a non-existent `Runners::AuditWriter` constant
|
|
82
|
+
- Actor module is `module Actor` (singular) per framework convention
|
|
83
|
+
|
|
60
84
|
## Testing
|
|
61
85
|
|
|
62
86
|
```bash
|
|
63
87
|
bundle install
|
|
64
|
-
bundle exec rspec # 26 examples, 0 failures
|
|
88
|
+
bundle exec rspec # 26+ examples, 0 failures
|
|
65
89
|
bundle exec rubocop # 0 offenses
|
|
66
90
|
```
|
|
67
91
|
|
data/Gemfile
CHANGED
data/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2021 Esity
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
data/lex-audit.gemspec
CHANGED
|
@@ -36,7 +36,6 @@ Gem::Specification.new do |spec|
|
|
|
36
36
|
spec.add_dependency 'legion-settings', '>= 1.3.14'
|
|
37
37
|
spec.add_dependency 'legion-transport', '>= 1.3.9'
|
|
38
38
|
|
|
39
|
-
spec.add_development_dependency 'rake'
|
|
40
39
|
spec.add_development_dependency 'rspec'
|
|
41
40
|
spec.add_development_dependency 'rubocop'
|
|
42
41
|
spec.add_development_dependency 'rubocop-rspec'
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Legion
|
|
4
|
+
module Extensions
|
|
5
|
+
module Audit
|
|
6
|
+
# Raised when post-write SHA-256 verification fails.
|
|
7
|
+
class WriteVerificationError < StandardError; end
|
|
8
|
+
|
|
9
|
+
# Raised when the file on disk has been modified since the caller read it.
|
|
10
|
+
class StaleEditError < StandardError; end
|
|
11
|
+
end
|
|
12
|
+
end
|
|
13
|
+
end
|
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
require 'digest'
|
|
4
|
+
require 'legion/extensions/audit/errors'
|
|
5
|
+
|
|
6
|
+
module Legion
|
|
7
|
+
module Extensions
|
|
8
|
+
module Audit
|
|
9
|
+
module Helpers
|
|
10
|
+
# Combines file write/edit operations with post-write SHA-256 verification
|
|
11
|
+
# and optional audit trail recording via AuditRecord.
|
|
12
|
+
#
|
|
13
|
+
# Include this module in any class or extension that modifies files and
|
|
14
|
+
# needs tamper-evident confirmation that the write succeeded.
|
|
15
|
+
module VerifiedWrite
|
|
16
|
+
include Legion::Extensions::Helpers::Lex if defined?(Legion::Extensions::Helpers::Lex)
|
|
17
|
+
|
|
18
|
+
# Write +content+ to +path+, then re-read and compare SHA-256 digests.
|
|
19
|
+
#
|
|
20
|
+
# @param path [String] absolute or relative filesystem path
|
|
21
|
+
# @param content [String] content to write
|
|
22
|
+
# @param agent_id [String, nil] identity recorded in the audit trail
|
|
23
|
+
# @param chain_id [String] audit chain identifier
|
|
24
|
+
#
|
|
25
|
+
# @return [Hash] { path:, before_hash:, after_hash:, verified: true }
|
|
26
|
+
# @raise [WriteVerificationError] when re-read digest does not match written digest
|
|
27
|
+
def verified_write(path, content, agent_id: nil, chain_id: 'file_edits')
|
|
28
|
+
before_hash = ::File.exist?(path) ? sha256_file(path) : nil
|
|
29
|
+
expected = sha256_string(content)
|
|
30
|
+
|
|
31
|
+
::File.write(path, content)
|
|
32
|
+
|
|
33
|
+
actual = sha256_file(path)
|
|
34
|
+
unless actual == expected
|
|
35
|
+
raise WriteVerificationError,
|
|
36
|
+
"write verification failed for #{path}: expected #{expected}, got #{actual}"
|
|
37
|
+
end
|
|
38
|
+
|
|
39
|
+
record_audit(
|
|
40
|
+
path: path,
|
|
41
|
+
action: 'verified_write',
|
|
42
|
+
agent_id: agent_id,
|
|
43
|
+
chain_id: chain_id,
|
|
44
|
+
before_hash: before_hash,
|
|
45
|
+
after_hash: actual
|
|
46
|
+
)
|
|
47
|
+
|
|
48
|
+
{ path: path, before_hash: before_hash, after_hash: actual, verified: true }
|
|
49
|
+
end
|
|
50
|
+
|
|
51
|
+
# Apply a string-replacement edit to +path+, with a staleness check before writing
|
|
52
|
+
# and SHA-256 verification after writing.
|
|
53
|
+
#
|
|
54
|
+
# @param path [String] absolute or relative filesystem path
|
|
55
|
+
# @param old_content [String] expected current file content (used for staleness check)
|
|
56
|
+
# @param new_content [String] desired file content after edit
|
|
57
|
+
# @param agent_id [String, nil] identity recorded in the audit trail
|
|
58
|
+
# @param chain_id [String] audit chain identifier
|
|
59
|
+
#
|
|
60
|
+
# @return [Hash] { path:, before_hash:, after_hash:, verified: true }
|
|
61
|
+
# @raise [StaleEditError] when the file has been modified since +old_content+ was read
|
|
62
|
+
# @raise [WriteVerificationError] when re-read digest does not match written digest
|
|
63
|
+
def verified_edit(path, old_content, new_content, agent_id: nil, chain_id: 'file_edits')
|
|
64
|
+
before_hash = sha256_string(old_content)
|
|
65
|
+
on_disk_hash = sha256_file(path)
|
|
66
|
+
|
|
67
|
+
unless on_disk_hash == before_hash
|
|
68
|
+
raise StaleEditError,
|
|
69
|
+
"stale edit detected for #{path}: disk content has changed since old_content was read"
|
|
70
|
+
end
|
|
71
|
+
|
|
72
|
+
verified_write(path, new_content, agent_id: agent_id, chain_id: chain_id)
|
|
73
|
+
end
|
|
74
|
+
|
|
75
|
+
private
|
|
76
|
+
|
|
77
|
+
def sha256_string(str)
|
|
78
|
+
::Digest::SHA256.hexdigest(str)
|
|
79
|
+
end
|
|
80
|
+
|
|
81
|
+
def sha256_file(path)
|
|
82
|
+
::Digest::SHA256.file(path).hexdigest
|
|
83
|
+
end
|
|
84
|
+
|
|
85
|
+
def record_audit(path:, action:, agent_id:, chain_id:, before_hash:, after_hash:)
|
|
86
|
+
return unless defined?(Legion::Data::Model::AuditLog)
|
|
87
|
+
|
|
88
|
+
Legion::Data::Model::AuditLog.create(
|
|
89
|
+
event_type: 'file_operation',
|
|
90
|
+
principal_id: agent_id || 'system',
|
|
91
|
+
principal_type: 'system',
|
|
92
|
+
action: action,
|
|
93
|
+
resource: path,
|
|
94
|
+
source: chain_id,
|
|
95
|
+
node: 'local',
|
|
96
|
+
status: 'success',
|
|
97
|
+
detail: ::JSON.generate({ before_hash: before_hash, after_hash: after_hash }),
|
|
98
|
+
record_hash: ::Digest::SHA256.hexdigest("#{before_hash}|#{after_hash}|#{path}"),
|
|
99
|
+
prev_hash: before_hash || ('0' * 64),
|
|
100
|
+
created_at: ::Time.now.utc
|
|
101
|
+
)
|
|
102
|
+
rescue StandardError => e
|
|
103
|
+
# audit recording is best-effort; never let it break the write
|
|
104
|
+
log.warn("[lex-audit] verified_write audit record failed: #{e.message}")
|
|
105
|
+
nil
|
|
106
|
+
end
|
|
107
|
+
end
|
|
108
|
+
end
|
|
109
|
+
end
|
|
110
|
+
end
|
|
111
|
+
end
|
|
@@ -67,7 +67,7 @@ module Legion
|
|
|
67
67
|
def define_approval_queue_model
|
|
68
68
|
return if Legion::Extensions::Audit::Runners::ApprovalQueue.const_defined?(:ApprovalQueue, false)
|
|
69
69
|
|
|
70
|
-
db =
|
|
70
|
+
db = data_connection
|
|
71
71
|
return unless db&.table_exists?(:approval_queue)
|
|
72
72
|
|
|
73
73
|
Legion::Extensions::Audit::Runners::ApprovalQueue.const_set(
|
|
@@ -1,14 +1,16 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
3
|
require 'legion/extensions/audit/version'
|
|
4
|
+
require 'legion/extensions/audit/errors'
|
|
5
|
+
require 'legion/extensions/audit/helpers/verified_write'
|
|
4
6
|
require 'legion/extensions/audit/runners/approval_queue'
|
|
5
7
|
|
|
6
8
|
module Legion
|
|
7
9
|
module Extensions
|
|
8
10
|
module Audit
|
|
9
|
-
extend Legion::Extensions::Core if Legion::Extensions.const_defined? :Core
|
|
11
|
+
extend Legion::Extensions::Core if Legion::Extensions.const_defined? :Core, false
|
|
10
12
|
|
|
11
|
-
def self.data_required?
|
|
13
|
+
def self.data_required? # rubocop:disable Legion/Extension/DataRequiredWithoutMigrations
|
|
12
14
|
true
|
|
13
15
|
end
|
|
14
16
|
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: lex-audit
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.1.
|
|
4
|
+
version: 0.1.6
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Esity
|
|
@@ -107,20 +107,6 @@ dependencies:
|
|
|
107
107
|
- - ">="
|
|
108
108
|
- !ruby/object:Gem::Version
|
|
109
109
|
version: 1.3.9
|
|
110
|
-
- !ruby/object:Gem::Dependency
|
|
111
|
-
name: rake
|
|
112
|
-
requirement: !ruby/object:Gem::Requirement
|
|
113
|
-
requirements:
|
|
114
|
-
- - ">="
|
|
115
|
-
- !ruby/object:Gem::Version
|
|
116
|
-
version: '0'
|
|
117
|
-
type: :development
|
|
118
|
-
prerelease: false
|
|
119
|
-
version_requirements: !ruby/object:Gem::Requirement
|
|
120
|
-
requirements:
|
|
121
|
-
- - ">="
|
|
122
|
-
- !ruby/object:Gem::Version
|
|
123
|
-
version: '0'
|
|
124
110
|
- !ruby/object:Gem::Dependency
|
|
125
111
|
name: rspec
|
|
126
112
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -199,6 +185,8 @@ executables: []
|
|
|
199
185
|
extensions: []
|
|
200
186
|
extra_rdoc_files: []
|
|
201
187
|
files:
|
|
188
|
+
- ".github/CODEOWNERS"
|
|
189
|
+
- ".github/dependabot.yml"
|
|
202
190
|
- ".github/workflows/ci.yml"
|
|
203
191
|
- ".gitignore"
|
|
204
192
|
- ".rspec"
|
|
@@ -206,10 +194,13 @@ files:
|
|
|
206
194
|
- CHANGELOG.md
|
|
207
195
|
- CLAUDE.md
|
|
208
196
|
- Gemfile
|
|
197
|
+
- LICENSE
|
|
209
198
|
- README.md
|
|
210
199
|
- lex-audit.gemspec
|
|
211
200
|
- lib/legion/extensions/audit.rb
|
|
212
201
|
- lib/legion/extensions/audit/actors/audit_writer.rb
|
|
202
|
+
- lib/legion/extensions/audit/errors.rb
|
|
203
|
+
- lib/legion/extensions/audit/helpers/verified_write.rb
|
|
213
204
|
- lib/legion/extensions/audit/runners/approval_queue.rb
|
|
214
205
|
- lib/legion/extensions/audit/runners/audit.rb
|
|
215
206
|
- lib/legion/extensions/audit/transport/exchanges/audit.rb
|