README.md

# Credential Obfuscator

This is a small library OTP application that acts as a help. It encrypts and decrypts sensitive data
typically stored in processes state with a one-off key (key material is generated on node start).
One example of such sensitive data is credentials used to access remote services.

This is necessary to avoid the sensitive values logged when process state is dumped by
the Erlang runtime (`error_logger`).

Note that this application **cannot protect against heap dumping attacks** and only helps
avoid sensitive data appearing in log files.

## Required OTP Version

This library requires Erlang/OTP 20.3 or later.

## License and Copyright

(c) 2019 Pivotal Software, Inc.