Skip to content

Commit 9d3f9e0

Browse files
jahvonjahvon
committed
cleanup code
1 parent 2329617 commit 9d3f9e0

File tree

15 files changed

+476
-321
lines changed

15 files changed

+476
-321
lines changed

‎LICENSE‎

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -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 [yyyy] [name of copyright owner]
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.

‎README.md‎

Lines changed: 6 additions & 156 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,6 @@
11
# Vault
22

3-
A Go package for secure secret storage with multiple encryption backends.
4-
5-
## Overview
6-
7-
The vault package provides a unified interface for storing and retrieving encrypted secrets. It supports multiple encryption providers with different security models and use cases.
8-
9-
## Installation
10-
11-
```bash
12-
go get github.com/jahvon/vault
13-
```
3+
A Go package for secure secret storage with multiple encryption backends. Made for [flow](https://github.com/jahvon/flow) but can be used independently.
144

155
## Quick Start
166

@@ -54,23 +44,7 @@ func main() {
5444

5545
### AES256 Provider
5646

57-
Symmetric encryption using AES-256. Best for single-user scenarios or when all users can share the same key.
58-
59-
**Features:**
60-
- Single shared encryption key
61-
- Fast encryption/decryption
62-
- Smaller encrypted files
63-
- Simple key management
64-
65-
**Configuration:**
66-
```go
67-
v, err := vault.New("my-vault",
68-
vault.WithProvider(vault.ProviderTypeAES256),
69-
vault.WithAESPath("/path/to/storage"),
70-
vault.WithAESKeyFromEnv("VAULT_ENCRYPTION_KEY"),
71-
// or vault.WithAESKeyFromFile("~/.vault/key"),
72-
)
73-
```
47+
Symmetric encryption using AES-256. Best for when you want a single encryption key shared across users / systems.
7448

7549
**Key Generation:**
7650
```go
@@ -83,143 +57,19 @@ if err != nil {
8357

8458
### Age Provider
8559

86-
Modern asymmetric encryption using the [age encryption format](https://age-encryption.org/). Best for multi-user scenarios or when you need to add/remove recipients.
87-
88-
**Features:**
89-
- Multiple recipients with separate keys
90-
- No shared secrets to distribute
91-
- Add/remove users without re-encrypting
92-
- Modern cryptographic primitives
93-
94-
**Configuration:**
95-
```go
96-
v, err := vault.New("my-vault",
97-
vault.WithProvider(vault.ProviderTypeAge),
98-
vault.WithAgePath("/path/to/storage"),
99-
vault.WithAgeIdentityFromEnv("AGE_PRIVATE_KEY"),
100-
vault.WithRecipients("age1ql3blv6a5y..."), // public keys
101-
)
102-
```
60+
Asymmetric encryption using the [age encryption format](https://github.com/FiloSottile/age). Best for when you may have multiple users or need the ability to add/remove recipients.
10361

10462
**Key Generation:**
10563
```bash
106-
# Generate age key pair
64+
# Generate age key pair - see https://github.com/FiloSottile/age for details
10765
age-keygen -o key.txt
10866
# Public key: age1ql3blv6a5y...
10967
# Private key in key.txt
11068
```
11169

112-
## Key Differences: AES vs Age
113-
114-
| Feature | AES256 | Age |
115-
|---------|--------|-----|
116-
| **Encryption Type** | Symmetric (shared key) | Asymmetric (public/private keys) |
117-
| **Key Sharing** | Single key shared by all users | Each user has their own private key |
118-
| **Adding Users** | Share the same key | Add their public key as recipient |
119-
| **Removing Users** | Change key + re-encrypt all data | Remove from recipients, re-encrypt vault |
120-
| **Performance** | Faster | Slightly slower |
121-
| **File Size** | Smaller | Slightly larger |
122-
| **Use Case** | Single user or trusted team | Multiple users, dynamic access |
123-
| **Key Storage** | Keep one key very secure | Private keys stored separately |
124-
125-
## Configuration Options
126-
127-
### Common Options
128-
```go
129-
// Set provider type
130-
vault.WithProvider(vault.ProviderTypeAES256) // or ProviderTypeAge
131-
132-
// Set storage path (works for both providers)
133-
vault.WithLocalPath("/path/to/vault/storage")
134-
```
135-
136-
### AES-Specific Options
137-
```go
138-
// Set AES-specific storage path
139-
vault.WithAESPath("/path/to/storage")
140-
141-
// Key sources (tries in order until one works)
142-
vault.WithAESKeyFromEnv("VAULT_KEY")
143-
vault.WithAESKeyFromFile("~/.vault/key")
144-
```
145-
146-
### Age-Specific Options
147-
```go
148-
// Set age-specific storage path
149-
vault.WithAgePath("/path/to/storage")
70+
## Encrypted Files
15071

151-
// Identity sources (private keys for decryption)
152-
vault.WithAgeIdentityFromEnv("AGE_PRIVATE_KEY")
153-
vault.WithAgeIdentityFromFile("~/.age/key.txt")
154-
155-
// Recipients (public keys for encryption)
156-
vault.WithRecipients("age1ql3blv6a5y...", "age1...")
157-
```
158-
159-
## Vault Operations
160-
161-
```go
162-
// Store a secret
163-
secret := vault.NewSecretValue([]byte("secret-value"))
164-
err := v.SetSecret("key-name", secret)
165-
166-
// Retrieve a secret
167-
secret, err := v.GetSecret("key-name")
168-
if err == vault.ErrSecretNotFound {
169-
// Handle missing secret
170-
}
171-
172-
// List all secret keys
173-
keys, err := v.ListSecrets()
174-
175-
// Check if secret exists
176-
exists, err := v.HasSecret("key-name")
177-
178-
// Delete a secret
179-
err := v.DeleteSecret("key-name")
180-
181-
// Clean up
182-
err := v.Close()
183-
```
184-
185-
## Repository Integration
186-
187-
Both vault types create a single encrypted file that can be safely committed to version control:
72+
Both vault types create a single encrypted file at the specified path:
18873

18974
- **AES256**: `vault-{id}.enc`
19075
- **Age**: `vault-{id}.age`
191-
192-
The encrypted files contain no readable information and are safe to store in public repositories.
193-
194-
## Key Management Best Practices
195-
196-
### For AES256 Vaults
197-
- Generate keys using `vault.GenerateEncryptionKey()`
198-
- Store the key in a secure location (env var, key management service, etc.)
199-
- Never commit the key to version control
200-
- Rotate keys periodically by re-encrypting with a new key
201-
202-
### For Age Vaults
203-
- Generate key pairs using `age-keygen`
204-
- Store private keys securely (separate from the repository)
205-
- Share public keys freely (they can be committed)
206-
- Add/remove recipients by updating the vault configuration
207-
208-
## Error Handling
209-
210-
```go
211-
import "errors"
212-
213-
secret, err := v.GetSecret("key")
214-
if err != nil {
215-
if errors.Is(err, vault.ErrSecretNotFound) {
216-
// Handle missing secret
217-
} else {
218-
// Handle other errors
219-
}
220-
}
221-
```
222-
223-
## Thread Safety
224-
225-
All vault operations are thread-safe and can be used concurrently from multiple goroutines.

0 commit comments

Comments
 (0)