https://github.com/dpb587/axe

log redaction and encryption
https://github.com/dpb587/axe

Last synced: 5 days ago
JSON representation

log redaction and encryption

• Host: GitHub
• URL: https://github.com/dpb587/axe
• Owner: dpb587
• Created: 2016-11-13T21:35:06.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2016-11-17T04:43:32.000Z (about 8 years ago)
• Last Synced: 2024-10-30T18:13:34.495Z (about 2 months ago)
• Language: Rust
• Homepage:
• Size: 9.77 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# axe

> log redaction and encryption

## about

Logs should never contain secrets. Unfortunately sometimes mistakes are made

and they sneak in. This program can be placed between your application and

logging system as a final attempt to stop them going any further.

## usage

### detection

The command `axe detect` reads from standard input and exits with failure if

any credentials are detected.

### redaction

The command `axe filter` reads from standard input and will redact any lines

containing credentials. Regular lines are output unchanged.

#### encryption

An encryption key may be passed to `axe filter` using the `-k` argument. If

this is set then lines containing credentials will be encrypted rather than

redacted. This is useful for debugging a problem which requires viewing

sensitive information that should not enter your logging system.

## installation

Not yet.

## benchmarks

These are some are some empirical performance figures from my 4 year old

Macbook Air (Rust 1.13.0):

| Task                                      | Lines processed/second |

|-------------------------------------------|-----------------------:|

| Re-outputting when there are no passwords |                297,000 |

| Redacting when every line is a password   |                435,000 |

| Encrypting when evey line is a password   |                113,000 |

You can run these bencharks for yourself by using the `benchmark/check.sh`

script. Make sure to compile the binary in release mode with `cargo build

--release`.