Redact

Redact sensitive strings from your logs with [obj redactedDescription], similar to Rails filter_parameters.

By default redacts the password property for dictionaries and basic key value styled logs.

Redact a dictionary

[@{@"password": "secret",@"username": @"user01"} redactedDescription]
-> {
     password: [REDACTED];
     username: "user01";
   }

Redact a string

[@"password = secret; username = user01" redactedDescription]
-> password = [REDACTED]; username = user01

Usage

#import "Redact.h"

Then use [obj redactedDescription];

or use RedactedLog() instead of NSLog() by adding one of the following macro sinto your .pch file

#define NSLog RedactedLogF // if you would like filename and function name
// or
#define NSLog RedactedLog // cleaner log and without any extra meta info

By default password is a redacted key, but it's easy to add more.

[NCRedact addRedactedKey:@"secret_key"];

or use redact to trim your logs down

NSString *path = [[NSBundle mainBundle] bundlePath];
[NCRedact addRedactedString:path with:@"[BUNDLE]"];

Tests

To run the test cases; clone the repo, and run pod install from the Example directory. Then open the workspace and run the tests.

Installation

Redact is available through CocoaPods, to install it simply add the following line to your Podfile:

pod "Redact"

Author

Daniel Brooker, dan@nocturnalcode.com, @DraconisNZ

License

Redact is available under the MIT license. See the LICENSE file for more info.

DanBrooker / Redact