active_cipher_storage 1.0.0
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 +7 -0
- data/CHANGELOG.md +24 -0
- data/CONTRIBUTING.md +46 -0
- data/LICENSE +21 -0
- data/README.md +644 -0
- data/SECURITY.md +35 -0
- data/active_cipher_storage.gemspec +55 -0
- data/lib/active_cipher_storage/adapters/active_storage_service.rb +129 -0
- data/lib/active_cipher_storage/adapters/s3_adapter.rb +252 -0
- data/lib/active_cipher_storage/blob_metadata.rb +84 -0
- data/lib/active_cipher_storage/cipher.rb +97 -0
- data/lib/active_cipher_storage/configuration.rb +57 -0
- data/lib/active_cipher_storage/engine.rb +29 -0
- data/lib/active_cipher_storage/errors.rb +31 -0
- data/lib/active_cipher_storage/format.rb +126 -0
- data/lib/active_cipher_storage/key_rotation.rb +121 -0
- data/lib/active_cipher_storage/key_utils.rb +12 -0
- data/lib/active_cipher_storage/multipart_upload.rb +190 -0
- data/lib/active_cipher_storage/providers/aws_kms_provider.rb +90 -0
- data/lib/active_cipher_storage/providers/base.rb +38 -0
- data/lib/active_cipher_storage/providers/env_provider.rb +122 -0
- data/lib/active_cipher_storage/stream_cipher.rb +102 -0
- data/lib/active_cipher_storage/version.rb +3 -0
- data/lib/active_cipher_storage.rb +43 -0
- data/lib/active_storage/service/active_cipher_storage_service.rb +10 -0
- metadata +224 -0
checksums.yaml
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
---
|
|
2
|
+
SHA256:
|
|
3
|
+
metadata.gz: 561cba3b474dd5c35b19324c325216fe452e2670e1d1bea42f719f368331672a
|
|
4
|
+
data.tar.gz: 9e776a018104013b07e2da60e18eeb7ead76d2fa37d0bce929f0fe3b0cfab11f
|
|
5
|
+
SHA512:
|
|
6
|
+
metadata.gz: a9da8b50775c261cd00047bc1af09f57aad8523e672e4c70e544ca49ce3166294778c53fdbd55a9c89fb2ff16aeb6d8b3cdb8bce5403261701c685f8895be74e
|
|
7
|
+
data.tar.gz: 23f93a25b27f7a6bad2a233ffebe0134b0a513426931cbaf2f70beec923b8152d2beff878017403da5305c1119cf3707281f22699d03d459a0c476912e197366
|
data/CHANGELOG.md
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to this project will be documented in this file.
|
|
4
|
+
|
|
5
|
+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
|
|
6
|
+
and this project follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
|
+
|
|
8
|
+
## [Unreleased]
|
|
9
|
+
|
|
10
|
+
## [1.0.0] - 2026-04-25
|
|
11
|
+
|
|
12
|
+
### Added
|
|
13
|
+
|
|
14
|
+
- Initial public ActiveCipherStorage gem release.
|
|
15
|
+
- Transparent Rails Active Storage encryption service.
|
|
16
|
+
- Direct S3 encrypted upload, download, streaming, and multipart support.
|
|
17
|
+
- Backend-managed encrypted multipart uploads for frontend chunk upload flows.
|
|
18
|
+
- AES-256-GCM envelope encryption with self-describing payload headers.
|
|
19
|
+
- Environment-variable and AWS KMS providers, plus a custom provider interface.
|
|
20
|
+
- Header-only key rotation for re-wrapping encrypted DEKs.
|
|
21
|
+
- Unit and integration coverage for crypto, providers, Active Storage, S3, multipart upload, streaming, metadata, and key rotation.
|
|
22
|
+
|
|
23
|
+
[Unreleased]: https://github.com/codebyjass/active-cipher-storage/compare/v1.0.0...HEAD
|
|
24
|
+
[1.0.0]: https://github.com/codebyjass/active-cipher-storage/releases/tag/v1.0.0
|
data/CONTRIBUTING.md
ADDED
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# Contributing
|
|
2
|
+
|
|
3
|
+
Thanks for your interest in contributing to ActiveCipherStorage.
|
|
4
|
+
|
|
5
|
+
This gem handles encryption and storage, so changes should be small, well-tested, and conservative. Prefer clear behavior and strong tests over clever abstractions.
|
|
6
|
+
|
|
7
|
+
## Development Setup
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
git clone https://github.com/codebyjass/active-cipher-storage.git
|
|
11
|
+
cd active-cipher-storage
|
|
12
|
+
bundle install
|
|
13
|
+
bundle exec rspec
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
The test suite uses in-memory fakes for Active Storage and S3. You do not need AWS credentials to run the tests.
|
|
17
|
+
|
|
18
|
+
## Before Opening a Pull Request
|
|
19
|
+
|
|
20
|
+
- Run `bundle exec rspec`.
|
|
21
|
+
- Add or update specs for behavior changes.
|
|
22
|
+
- Keep public APIs backward-compatible unless the change is clearly marked as breaking.
|
|
23
|
+
- Do not commit secrets, credentials, `.env` files, local coverage output, or generated gems.
|
|
24
|
+
- Update `README.md` and `CHANGELOG.md` when user-facing behavior changes.
|
|
25
|
+
|
|
26
|
+
## Testing Expectations
|
|
27
|
+
|
|
28
|
+
Use focused tests for:
|
|
29
|
+
|
|
30
|
+
- Encryption format compatibility.
|
|
31
|
+
- Authentication and tamper failures.
|
|
32
|
+
- Large-file chunk boundaries.
|
|
33
|
+
- Active Storage legacy plaintext fallback.
|
|
34
|
+
- S3 multipart and streaming behavior.
|
|
35
|
+
- Provider error handling.
|
|
36
|
+
- Key rotation behavior.
|
|
37
|
+
|
|
38
|
+
Security-sensitive fixes should include a regression test that fails without the fix.
|
|
39
|
+
|
|
40
|
+
## Security Changes
|
|
41
|
+
|
|
42
|
+
Please do not open public issues for vulnerabilities. Follow `SECURITY.md` instead.
|
|
43
|
+
|
|
44
|
+
## Code of Conduct
|
|
45
|
+
|
|
46
|
+
Be respectful and constructive. Assume good intent, keep feedback specific, and help keep the project welcoming for maintainers and contributors.
|
data/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Jaspreet Singh
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|