Skip to content

Commit 5d31825

Browse files
committed
docs: add project status
1 parent 6781905 commit 5d31825

File tree

1 file changed

+24
-20
lines changed

1 file changed

+24
-20
lines changed

README.md

Lines changed: 24 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@ A Go library implementing the TR-31 (ANSI X9.143) key block standard for secure
2020

2121
TR-31 is a method defined by ASC X9.143 for secure cryptographic key exchange between devices and systems, particularly in the financial industry. This format provides a structured way to protect sensitive key material while maintaining essential metadata about key usage, algorithms, and other attributes.
2222

23+
## Project Status
24+
25+
moov-io/tr31 is undergoing active development and testing within Moov. Please star the project and share feedback, bugs, questions, etc in the [`tr31` channel in slack](https://slack.moov.io/). If you find security vulnerabilities reach out to `[email protected]`.
26+
2327
## Features
2428

2529
- Supports all major TR-31 key block versions:
@@ -74,7 +78,7 @@ func main() {
7478
KeyLength: 32,
7579
}
7680
kbpk, _ := GenerateKBPK(kbpkopts)
77-
// Create a new KeyBlock
81+
// Create a new KeyBlock
7882
keyBlock, err := encryption.NewKeyBlock(kbpk, header)
7983
if err != nil {
8084
panic(err)
@@ -165,9 +169,9 @@ The library provides detailed error messages through two custom error types:
165169
- `HeaderError`: For issues related to TR-31 header processing
166170
- `KeyBlockError`: For issues related to key block processing
167171

168-
## Benchmarks
172+
## Benchmarks
169173

170-
Unwraps a TR-31 formatted key block to retrieve the original key.
174+
Unwraps a TR-31 formatted key block to retrieve the original key.
171175

172176
```bash
173177
Running tool: /opt/homebrew/bin/go test -benchmem -run=^$ -bench ^BenchmarkUnwrap_D_32_WithSetup$ github.com/moov-io/tr31/pkg/tr31
@@ -183,29 +187,29 @@ BenchmarkUnwrap_D_32_WithSetup-10 301116 3619 ns/op 8608 B/op
183187

184188
tr31 is a tool for managing both 3DES and AES-derived unique keys per transaction (TR-31) key management.
185189

186-
### USAGE
190+
### USAGE
187191
tr31 [-v] [-algorithm] [-e] [-d]
188192

189193
### EXAMPLES
190-
tr31 -v
191-
Print the version of tr31 (Example: v1.0.0)
192-
tr31 -e
193-
Encrypt a card data block using the TR-31 transaction key
194-
tr31 -d
194+
tr31 -v
195+
Print the version of tr31 (Example: v1.0.0)
196+
tr31 -e
197+
Encrypt a card data block using the TR-31 transaction key
198+
tr31 -d
195199
Decrypt a card data block using the TR-31 transaction key
196200

197201
### FLAGS
198-
-vault_address string
199-
Vault address where the encryption/decryption key is stored
200-
-vault_token string
201-
Vault token for authentication
202-
-key_path string
203-
Path to the encryption/decryption key in the vault
204-
-key_name string
205-
Name of the encryption/decryption key in the vault
206-
-wrapper_key string
202+
-vault_address string
203+
Vault address where the encryption/decryption key is stored
204+
-vault_token string
205+
Vault token for authentication
206+
-key_path string
207+
Path to the encryption/decryption key in the vault
208+
-key_name string
209+
Name of the encryption/decryption key in the vault
210+
-wrapper_key string
207211
Symmetric key
208-
-key_block string
212+
-key_block string
209213
Wrapped key block for decryption
210214

211215
### EXAMPLES
@@ -220,7 +224,7 @@ TR31 library provided web server. Please check following http endpoints
220224
| Method | Request Body | Route | Action |
221225
|--------|--------------|--------------------|----------------|
222226
| POST | JSON | /encrypt_data | Encrypt Data |
223-
| POST | JSON | /decrypt_data | Decrypt Data |
227+
| POST | JSON | /decrypt_data | Decrypt Data |
224228

225229

226230
## Contributing

0 commit comments

Comments
 (0)