veil's Introduction

A derive macro that implements std::fmt::Debug for a struct or enum variant, with certain fields redacted.

The purpose of this macro is to allow for easy, configurable and efficient redaction of sensitive data in structs and enum variants. This can be used to hide sensitive data in logs or anywhere where personal data should not be exposed or stored.

Usage

Add to your Cargo.toml:

[dependencies]
veil = "0.1.7"

Usage documentation can be found here.

Example

The example is explained in detail here.

#[derive(Redact)]
struct CreditCard {
    #[redact(partial)]
    number: String,

    #[redact]
    expiry: String,

    #[redact(fixed = 3)]
    cvv: String,

    #[redact(partial)]
    cardholder_name: String,
}

#[derive(Redact)]
#[redact(all, variant)]
enum CreditCardIssuer {
    MasterCard,
    Visa,
    AmericanExpress,
}

#[derive(Redact)]
#[redact(all, partial)]
struct Vehicle {
    license_plate: String,
    make: String,
    model: String,
    color: String,
}

#[derive(Debug)]
struct Policy {
    id: Uuid,
    name: String,
    description: String,
}

#[derive(Redact)]
enum InsuranceStatus {
    #[redact(all, partial)]
    Insured {
        #[redact(fixed = 12)]
        policy: Policy,

        policy_started: String,
        policy_expires: String,

        #[redact(skip)]
        payment_card: CreditCard,

        #[redact(skip)]
        vehicles: Vec<Vehicle>,
    },

    Uninsured {
        policies_available: Vec<Policy>,
    },
}

Environmental Awareness

In testing environments it may be useful to disable redaction entirely. You can globally disable Veil's redaction behavior at runtime by enabling the non-default feature flag toggle and:

Setting the VEIL_DISABLE_REDACTION environment variable to "1", "true" or "on" (case insensitive).

Calling the veil::disable function. See this example.

These are only checked ONCE for security purposes.

veil's People

Contributors

Stargazers

Watchers

veil's Issues

extending #[redact(with = 'X')] to support Strings

currently the #[redact(with = 'X')] attribute is limited in that you can only specify one single character that the string will be redacted with.

What do we think about enhancing this attribute so that it can support Strings instead of just chars?

Here is an example of what I am proposing:

#[derive(Redact)]
struct Foo {
    #[redact(with = "[REDACTED]")]
    redact_me: String,
}

fn main() {
    println!(
        "{:#?}",
        Foo {
            redact_me: "Super Secret String".to_string(),
        }
    );
}

// Running main would print the following:
Foo {
    redact_me: "[REDACTED]",
}

Now I am not sure how this would play nicely with the partial or fixed attributes, so perhaps reusing the with attribute to support a String or Char isn't the way to go.
One thought I had was to add another attribute, perhaps #[redact(with_string = "[REDACTED]")] that would be mutually exclusive with partial or fixed

Would love to hear what others think about this sort of thing

Recommend Projects

primait / veil Goto Github PK

veil's Introduction

Usage

Example

Environmental Awareness

veil's People

Contributors

Stargazers

Watchers

Forkers

veil's Issues

extending #[redact(with = 'X')] to support Strings

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent